diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 8368998c..4c3466af 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -54,6 +54,8 @@ env: MAILCHIMP_DATACENTER: ${{ fromJson(secrets.TEST_VARIABLES).MAILCHIMP_DATACENTER }} INTERCOM_TOKEN: ${{ fromJson(secrets.TEST_VARIABLES).INTERCOM_TOKEN }} ATTIO_TOKEN: ${{ fromJson(secrets.TEST_VARIABLES).ATTIO_TOKEN }} + CONTENTFUL_ACCESS_TOKEN: ${{ fromJson(secrets.TEST_VARIABLES).CONTENTFUL_ACCESS_TOKEN }} + CONTENTFUL_SPACE_ID: ${{ fromJson(secrets.TEST_VARIABLES).CONTENTFUL_SPACE_ID }} GOOGLE_SHEETS_REFRESH_TOKEN: ${{ fromJson(secrets.TEST_VARIABLES).GOOGLE_SHEETS_REFRESH_TOKEN }} GOOGLE_SHEETS_CLIENT_ID: ${{ fromJson(secrets.TEST_VARIABLES).GOOGLE_SHEETS_CLIENT_ID }} GOOGLE_SHEETS_CLIENT_SECRET: ${{ fromJson(secrets.TEST_VARIABLES).GOOGLE_SHEETS_CLIENT_SECRET }} @@ -355,6 +357,7 @@ jobs: uuid-dev \ libeigen3-dev \ libprotobuf-dev \ + libprotoc-dev \ protobuf-compiler # Install OpenSSL 3.5+ with native QUIC support (SSL_set_quic_tls_cbs) diff --git a/ts/package.json b/ts/package.json index e221ca91..317e0261 100644 --- a/ts/package.json +++ b/ts/package.json @@ -72,6 +72,7 @@ "axios": "^1.12.0", "azure-devops-node-api": "^15.1.1", "brace-expansion": "^4.0.1", + "contentful-management": "^11.74.0", "dayjs": "^1.11.18", "dotenv": "^17.2.2", "facebook-nodejs-business-sdk": "^24.0.0", diff --git a/ts/src/ActionsCatalogue/index.ts b/ts/src/ActionsCatalogue/index.ts index 178d0dd0..bce8ab5a 100644 --- a/ts/src/ActionsCatalogue/index.ts +++ b/ts/src/ActionsCatalogue/index.ts @@ -38,6 +38,7 @@ import canva from '../apps/canva'; import claude from '../apps/claude'; import clickup from '../apps/clickup'; import confluence from '../apps/confluence'; +import contentful from '../apps/contentful'; import coppercrm from '../apps/coppercrm'; import craft from '../apps/craft'; import dropbox from '../apps/dropbox'; @@ -153,6 +154,7 @@ const NEW_APPS = { claude, clickup, confluence, + contentful, coppercrm, craft, dropbox, diff --git a/ts/src/apps/contentful/actions/assets/archive-asset.action.ts b/ts/src/apps/contentful/actions/assets/archive-asset.action.ts new file mode 100644 index 00000000..f852ef98 --- /dev/null +++ b/ts/src/apps/contentful/actions/assets/archive-asset.action.ts @@ -0,0 +1,63 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { getContentfulAssetAllowedValues } from '../../helpers/get-asset-allowed-values'; + +const action = 'archive_asset'; + +const options = { + ...contentfulBaseOptions, + asset_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulAssetAllowedValues, + }, + archive: { + type: 'bool', + required: true, + default_value: true, + }, +} satisfies TQoreOptions; + +const ArchiveAsset = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Asset ID' }, + archived: { type: 'bool', short_desc: 'Whether the asset is archived' }, + }, + }, + api_function: async (obj, _opts, context) => { + const { space_id, asset_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'asset_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + const shouldArchive = obj?.archive !== false; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + + if (shouldArchive) { + await client.asset.archive({ assetId: asset_id }); + } else { + await client.asset.unarchive({ assetId: asset_id }); + } + + return { id: asset_id, archived: shouldArchive }; + } catch (error) { + const operation = shouldArchive ? 'archive' : 'unarchive'; + throw new ContentfulError(`Failed to ${operation} asset: ${error}`); + } + }, +}); + +export default ArchiveAsset; diff --git a/ts/src/apps/contentful/actions/assets/create-asset.action.ts b/ts/src/apps/contentful/actions/assets/create-asset.action.ts new file mode 100644 index 00000000..240fb330 --- /dev/null +++ b/ts/src/apps/contentful/actions/assets/create-asset.action.ts @@ -0,0 +1,120 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { flattenAsset, getDefaultLocale } from '../../helpers/contentful-type-mapping'; +import { ContentfulAssetResponseType } from '../../response-types'; + +const action = 'create_asset'; + +const options = { + ...contentfulBaseOptions, + title: { + type: 'string', + required: true, + }, + description: { + type: 'string', + required: false, + }, + file_name: { + type: 'string', + required: true, + }, + file_url: { + type: 'string', + required: true, + }, + content_type: { + type: 'string', + required: true, + allowed_values: [ + { value: 'image/jpeg', display_name: 'JPEG Image' }, + { value: 'image/png', display_name: 'PNG Image' }, + { value: 'image/gif', display_name: 'GIF Image' }, + { value: 'image/svg+xml', display_name: 'SVG Image' }, + { value: 'image/webp', display_name: 'WebP Image' }, + { value: 'application/pdf', display_name: 'PDF Document' }, + { value: 'video/mp4', display_name: 'MP4 Video' }, + { value: 'audio/mpeg', display_name: 'MP3 Audio' }, + { value: 'application/json', display_name: 'JSON' }, + { value: 'text/plain', display_name: 'Plain Text' }, + { value: 'text/html', display_name: 'HTML' }, + { value: 'text/csv', display_name: 'CSV' }, + ], + allowed_values_creatable: true, + }, + publish: { + type: 'bool', + required: false, + default_value: false, + }, +} satisfies TQoreOptions; + +const CreateAsset = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulAssetResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, title, file_name, file_url, content_type } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'title', 'file_name', 'file_url', 'content_type'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + const description = obj?.description as string | undefined; + const shouldPublish = obj?.publish === true; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + + let asset = await client.asset.create( + {}, + { + fields: { + title: { [defaultLocale]: title }, + description: description ? { [defaultLocale]: description } : undefined, + file: { + [defaultLocale]: { + contentType: content_type, + fileName: file_name, + upload: file_url, + }, + }, + } as any, + } + ); + + // Trigger asset processing and poll until complete + try { + await client.asset.processForLocale( + {} as any, asset, defaultLocale, + { processingCheckWait: 3000, processingCheckRetries: 10 } + ); + } catch { + // Processing may time out but still succeed — check below + } + + // Fetch the asset to check if processing completed + asset = await client.asset.get({ assetId: asset.sys.id }); + + if (shouldPublish) { + asset = await client.asset.publish( + { assetId: asset.sys.id }, + { sys: { version: asset.sys.version } } as any + ) as any; + } + + return flattenAsset(asset, defaultLocale); + } catch (error) { + throw new ContentfulError(`Failed to create asset: ${error}`); + } + }, +}); + +export default CreateAsset; diff --git a/ts/src/apps/contentful/actions/assets/delete-asset.action.ts b/ts/src/apps/contentful/actions/assets/delete-asset.action.ts new file mode 100644 index 00000000..3e75b751 --- /dev/null +++ b/ts/src/apps/contentful/actions/assets/delete-asset.action.ts @@ -0,0 +1,62 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { getContentfulAssetAllowedValues } from '../../helpers/get-asset-allowed-values'; + +const action = 'delete_asset'; + +const options = { + ...contentfulBaseOptions, + asset_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulAssetAllowedValues, + }, +} satisfies TQoreOptions; + +const DeleteAsset = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Deleted asset ID' }, + deleted: { type: 'bool', short_desc: 'Whether the asset was successfully deleted' }, + }, + }, + api_function: async (obj, _opts, context) => { + const { space_id, asset_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'asset_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + + // Unpublish if published before deleting + try { + const asset = await client.asset.get({ assetId: asset_id }); + if ((asset.sys as any).publishedVersion) { + await client.asset.unpublish({ assetId: asset_id }); + } + } catch { + // Asset may already be unpublished + } + + await client.asset.delete({ assetId: asset_id }); + + return { id: asset_id, deleted: true }; + } catch (error) { + throw new ContentfulError(`Failed to delete asset: ${error}`); + } + }, +}); + +export default DeleteAsset; diff --git a/ts/src/apps/contentful/actions/assets/get-asset.action.ts b/ts/src/apps/contentful/actions/assets/get-asset.action.ts new file mode 100644 index 00000000..8f43d19f --- /dev/null +++ b/ts/src/apps/contentful/actions/assets/get-asset.action.ts @@ -0,0 +1,48 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { getContentfulAssetAllowedValues } from '../../helpers/get-asset-allowed-values'; +import { flattenAsset, getDefaultLocale } from '../../helpers/contentful-type-mapping'; +import { ContentfulAssetResponseType } from '../../response-types'; + +const action = 'get_asset'; + +const options = { + ...contentfulBaseOptions, + asset_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulAssetAllowedValues, + }, +} satisfies TQoreOptions; + +const GetAsset = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulAssetResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, asset_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'asset_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + const asset = await client.asset.get({ assetId: asset_id }); + + return flattenAsset(asset, defaultLocale); + } catch (error) { + throw new ContentfulError(`Failed to get asset: ${error}`); + } + }, +}); + +export default GetAsset; diff --git a/ts/src/apps/contentful/actions/assets/publish-asset.action.ts b/ts/src/apps/contentful/actions/assets/publish-asset.action.ts new file mode 100644 index 00000000..b3fe7387 --- /dev/null +++ b/ts/src/apps/contentful/actions/assets/publish-asset.action.ts @@ -0,0 +1,55 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { getContentfulAssetAllowedValues } from '../../helpers/get-asset-allowed-values'; +import { ContentfulPublishResponseType } from '../../response-types'; + +const action = 'publish_asset'; + +const options = { + ...contentfulBaseOptions, + asset_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulAssetAllowedValues, + }, +} satisfies TQoreOptions; + +const PublishAsset = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulPublishResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, asset_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'asset_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const asset = await client.asset.get({ assetId: asset_id }); + + const published = await client.asset.publish( + { assetId: asset_id }, + { sys: { version: asset.sys.version } } as any + ); + + return { + id: published.sys.id, + version: published.sys.version, + published_at: (published.sys as any).publishedAt, + }; + } catch (error) { + throw new ContentfulError(`Failed to publish asset: ${error}`); + } + }, +}); + +export default PublishAsset; diff --git a/ts/src/apps/contentful/actions/assets/search-assets.action.ts b/ts/src/apps/contentful/actions/assets/search-assets.action.ts new file mode 100644 index 00000000..3ba85113 --- /dev/null +++ b/ts/src/apps/contentful/actions/assets/search-assets.action.ts @@ -0,0 +1,87 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { flattenAsset, getDefaultLocale } from '../../helpers/contentful-type-mapping'; +import { ContentfulAssetListResponseType } from '../../response-types'; + +const action = 'search_assets'; + +const options = { + ...contentfulBaseOptions, + query: { + type: 'string', + required: false, + }, + mime_type_group: { + type: 'string', + required: false, + allowed_values: [ + { value: 'image', display_name: 'Image' }, + { value: 'video', display_name: 'Video' }, + { value: 'audio', display_name: 'Audio' }, + { value: 'richtext', display_name: 'Rich Text' }, + { value: 'presentation', display_name: 'Presentation' }, + { value: 'spreadsheet', display_name: 'Spreadsheet' }, + { value: 'pdfdocument', display_name: 'PDF Document' }, + { value: 'archive', display_name: 'Archive' }, + { value: 'plaintext', display_name: 'Plain Text' }, + { value: 'code', display_name: 'Code' }, + { value: 'markup', display_name: 'Markup' }, + ], + }, + limit: { + type: 'int', + required: false, + default_value: 100, + }, + skip: { + type: 'int', + required: false, + default_value: 0, + }, +} satisfies TQoreOptions; + +const SearchAssets = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulAssetListResponseType, + api_function: async (obj, _opts, context) => { + const { space_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + const limit = (obj?.limit as number) || 100; + const skip = (obj?.skip as number) || 0; + const queryText = obj?.query as string | undefined; + const mimeTypeGroup = obj?.mime_type_group as string | undefined; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + + const query: Record = { limit, skip }; + + if (queryText) { + query.query = queryText; + } + if (mimeTypeGroup) { + query.mimetype_group = mimeTypeGroup; + } + + const assets = await client.asset.getMany({ query }); + + return assets.items.map((asset) => flattenAsset(asset, defaultLocale)); + } catch (error) { + throw new ContentfulError(`Failed to search assets: ${error}`); + } + }, +}); + +export default SearchAssets; diff --git a/ts/src/apps/contentful/actions/assets/unpublish-asset.action.ts b/ts/src/apps/contentful/actions/assets/unpublish-asset.action.ts new file mode 100644 index 00000000..481db674 --- /dev/null +++ b/ts/src/apps/contentful/actions/assets/unpublish-asset.action.ts @@ -0,0 +1,54 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { getContentfulAssetAllowedValues } from '../../helpers/get-asset-allowed-values'; + +const action = 'unpublish_asset'; + +const options = { + ...contentfulBaseOptions, + asset_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulAssetAllowedValues, + }, +} satisfies TQoreOptions; + +const UnpublishAsset = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Asset ID' }, + version: { type: 'int', short_desc: 'Current version number' }, + }, + }, + api_function: async (obj, _opts, context) => { + const { space_id, asset_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'asset_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const unpublished = await client.asset.unpublish({ assetId: asset_id }); + + return { + id: unpublished.sys.id, + version: unpublished.sys.version, + }; + } catch (error) { + throw new ContentfulError(`Failed to unpublish asset: ${error}`); + } + }, +}); + +export default UnpublishAsset; diff --git a/ts/src/apps/contentful/actions/assets/update-asset.action.ts b/ts/src/apps/contentful/actions/assets/update-asset.action.ts new file mode 100644 index 00000000..16b08e99 --- /dev/null +++ b/ts/src/apps/contentful/actions/assets/update-asset.action.ts @@ -0,0 +1,75 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { getContentfulAssetAllowedValues } from '../../helpers/get-asset-allowed-values'; +import { flattenAsset, getDefaultLocale } from '../../helpers/contentful-type-mapping'; +import { ContentfulAssetResponseType } from '../../response-types'; + +const action = 'update_asset'; + +const options = { + ...contentfulBaseOptions, + asset_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulAssetAllowedValues, + }, + title: { + type: 'string', + required: false, + required_groups: ['update_field'], + }, + description: { + type: 'string', + required: false, + required_groups: ['update_field'], + }, +} satisfies TQoreOptions; + +const UpdateAsset = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulAssetResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, asset_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'asset_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + + const currentAsset = await client.asset.get({ assetId: asset_id }); + const fields = { ...(currentAsset.fields as Record>) }; + + if (obj?.title !== undefined) { + fields.title = { [defaultLocale]: obj.title }; + } + if (obj?.description !== undefined) { + fields.description = { [defaultLocale]: obj.description }; + } + + const updatedAsset = await client.asset.update( + { assetId: asset_id }, + { + sys: { version: currentAsset.sys.version }, + fields, + } as any + ); + + return flattenAsset(updatedAsset, defaultLocale); + } catch (error) { + throw new ContentfulError(`Failed to update asset: ${error}`); + } + }, +}); + +export default UpdateAsset; diff --git a/ts/src/apps/contentful/actions/content-types/activate-content-type.action.ts b/ts/src/apps/contentful/actions/content-types/activate-content-type.action.ts new file mode 100644 index 00000000..58901ba5 --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/activate-content-type.action.ts @@ -0,0 +1,57 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeResponseType } from '../../response-types'; + +const action = 'activate_content_type'; + +const options = { + ...contentfulBaseWithContentTypeOptions, +} satisfies TQoreOptions; + +const ActivateContentType = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const ct = await client.contentType.get({ contentTypeId: content_type_id }); + + const published = await client.contentType.publish( + { contentTypeId: content_type_id }, + { sys: { version: ct.sys.version } } as any + ); + + return { + id: published.sys.id, + name: published.name, + description: published.description, + display_field: published.displayField, + fields: published.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + }; + } catch (error) { + throw new ContentfulError(`Failed to activate content type: ${error}`); + } + }, +}); + +export default ActivateContentType; diff --git a/ts/src/apps/contentful/actions/content-types/add-field.action.ts b/ts/src/apps/contentful/actions/content-types/add-field.action.ts new file mode 100644 index 00000000..b5472796 --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/add-field.action.ts @@ -0,0 +1,106 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeResponseType } from '../../response-types'; + +const action = 'add_field_to_content_type'; + +const FIELD_TYPE_ALLOWED_VALUES = [ + { value: 'Symbol', display_name: 'Short Text' }, + { value: 'Text', display_name: 'Long Text' }, + { value: 'Integer', display_name: 'Integer' }, + { value: 'Number', display_name: 'Decimal Number' }, + { value: 'Date', display_name: 'Date and Time' }, + { value: 'Boolean', display_name: 'Boolean' }, + { value: 'RichText', display_name: 'Rich Text' }, + { value: 'Link', display_name: 'Link (Reference)' }, + { value: 'Array', display_name: 'Array (List)' }, + { value: 'Object', display_name: 'JSON Object' }, + { value: 'Location', display_name: 'Location' }, +]; + +const options = { + ...contentfulBaseWithContentTypeOptions, + field_id: { + type: 'string', + required: true, + }, + field_name: { + type: 'string', + required: true, + }, + field_type: { + type: 'string', + required: true, + allowed_values: FIELD_TYPE_ALLOWED_VALUES, + }, + required: { + type: 'bool', + required: false, + default_value: false, + }, + localized: { + type: 'bool', + required: false, + default_value: false, + }, +} satisfies TQoreOptions; + +const AddField = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id, field_id, field_name, field_type } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id', 'field_id', 'field_name', 'field_type'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const current = await client.contentType.get({ contentTypeId: content_type_id }); + + const newField = { + id: field_id, + name: field_name, + type: field_type, + required: obj?.required === true, + localized: obj?.localized === true, + }; + + const updated = await client.contentType.update( + { contentTypeId: content_type_id }, + { + ...current, + fields: [...current.fields, newField], + sys: current.sys as any, + } + ); + + return { + id: updated.sys.id, + name: updated.name, + description: updated.description, + display_field: updated.displayField, + fields: updated.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + }; + } catch (error) { + throw new ContentfulError(`Failed to add field to content type: ${error}`); + } + }, +}); + +export default AddField; diff --git a/ts/src/apps/contentful/actions/content-types/create-content-type.action.ts b/ts/src/apps/contentful/actions/content-types/create-content-type.action.ts new file mode 100644 index 00000000..f3066f38 --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/create-content-type.action.ts @@ -0,0 +1,99 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeResponseType } from '../../response-types'; + +const action = 'create_content_type'; + +const options = { + ...contentfulBaseOptions, + name: { + type: 'string', + required: true, + }, + description: { + type: 'string', + required: false, + }, + fields: { + type: { + type: 'list', + element_type: { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Field ID (unique identifier)' }, + name: { type: 'string', short_desc: 'Field display name' }, + type: { type: 'string', short_desc: 'Field type (Symbol, Text, Integer, Number, Date, Boolean, RichText, Link, Array, Object, Location)' }, + required: { type: 'bool', short_desc: 'Whether the field is required' }, + localized: { type: 'bool', short_desc: 'Whether the field supports localization' }, + }, + }, + }, + required: true, + }, +} satisfies TQoreOptions; + +const CreateContentType = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, name, fields } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'name', 'fields'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + const description = obj?.description as string | undefined; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const fieldList = fields as Array<{ + id: string; + name: string; + type: string; + required?: boolean; + localized?: boolean; + }>; + + const ct = await client.contentType.create( + {}, + { + name, + description: description || '', + displayField: fieldList[0]?.id, + fields: fieldList.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required || false, + localized: f.localized || false, + })), + } + ); + + return { + id: ct.sys.id, + name: ct.name, + description: ct.description, + display_field: ct.displayField, + fields: ct.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + }; + } catch (error) { + throw new ContentfulError(`Failed to create content type: ${error}`); + } + }, +}); + +export default CreateContentType; diff --git a/ts/src/apps/contentful/actions/content-types/deactivate-content-type.action.ts b/ts/src/apps/contentful/actions/content-types/deactivate-content-type.action.ts new file mode 100644 index 00000000..63d196a5 --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/deactivate-content-type.action.ts @@ -0,0 +1,52 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeResponseType } from '../../response-types'; + +const action = 'deactivate_content_type'; + +const options = { + ...contentfulBaseWithContentTypeOptions, +} satisfies TQoreOptions; + +const DeactivateContentType = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const unpublished = await client.contentType.unpublish({ contentTypeId: content_type_id }); + + return { + id: unpublished.sys.id, + name: unpublished.name, + description: unpublished.description, + display_field: unpublished.displayField, + fields: unpublished.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + }; + } catch (error) { + throw new ContentfulError(`Failed to deactivate content type: ${error}`); + } + }, +}); + +export default DeactivateContentType; diff --git a/ts/src/apps/contentful/actions/content-types/delete-content-type.action.ts b/ts/src/apps/contentful/actions/content-types/delete-content-type.action.ts new file mode 100644 index 00000000..48c97865 --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/delete-content-type.action.ts @@ -0,0 +1,45 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; + +const action = 'delete_content_type'; + +const options = { + ...contentfulBaseWithContentTypeOptions, +} satisfies TQoreOptions; + +const DeleteContentType = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Deleted content type ID' }, + deleted: { type: 'bool', short_desc: 'Whether the content type was successfully deleted' }, + }, + }, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + await client.contentType.delete({ contentTypeId: content_type_id }); + + return { id: content_type_id, deleted: true }; + } catch (error) { + throw new ContentfulError(`Failed to delete content type: ${error}`); + } + }, +}); + +export default DeleteContentType; diff --git a/ts/src/apps/contentful/actions/content-types/delete-field.action.ts b/ts/src/apps/contentful/actions/content-types/delete-field.action.ts new file mode 100644 index 00000000..3e5918af --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/delete-field.action.ts @@ -0,0 +1,88 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulFieldAllowedValues } from '../../helpers/get-field-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeResponseType } from '../../response-types'; + +const action = 'delete_field_from_content_type'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + field_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulFieldAllowedValues, + depends_on: ['content_type_id'], + }, +} satisfies TQoreOptions; + +const DeleteField = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id, field_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id', 'field_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const current = await client.contentType.get({ contentTypeId: content_type_id }); + + // First, mark the field as omitted (Contentful requires this before removal) + const fieldsWithOmitted = current.fields.map((f) => { + if (f.id === field_id) { + return { ...f, omitted: true }; + } + return f; + }); + + const withOmitted = await client.contentType.update( + { contentTypeId: content_type_id }, + { + ...current, + fields: fieldsWithOmitted, + sys: current.sys as any, + } + ); + + // Then, remove the field entirely + const fieldsWithoutField = withOmitted.fields.filter((f) => f.id !== field_id); + + const updated = await client.contentType.update( + { contentTypeId: content_type_id }, + { + ...withOmitted, + fields: fieldsWithoutField, + sys: withOmitted.sys as any, + } + ); + + return { + id: updated.sys.id, + name: updated.name, + description: updated.description, + display_field: updated.displayField, + fields: updated.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + }; + } catch (error) { + throw new ContentfulError(`Failed to delete field from content type: ${error}`); + } + }, +}); + +export default DeleteField; diff --git a/ts/src/apps/contentful/actions/content-types/get-content-type.action.ts b/ts/src/apps/contentful/actions/content-types/get-content-type.action.ts new file mode 100644 index 00000000..e271dd8f --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/get-content-type.action.ts @@ -0,0 +1,52 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeResponseType } from '../../response-types'; + +const action = 'get_content_type'; + +const options = { + ...contentfulBaseWithContentTypeOptions, +} satisfies TQoreOptions; + +const GetContentType = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const ct = await client.contentType.get({ contentTypeId: content_type_id }); + + return { + id: ct.sys.id, + name: ct.name, + description: ct.description, + display_field: ct.displayField, + fields: ct.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + }; + } catch (error) { + throw new ContentfulError(`Failed to get content type: ${error}`); + } + }, +}); + +export default GetContentType; diff --git a/ts/src/apps/contentful/actions/content-types/search-content-types.action.ts b/ts/src/apps/contentful/actions/content-types/search-content-types.action.ts new file mode 100644 index 00000000..d51246a6 --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/search-content-types.action.ts @@ -0,0 +1,75 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeListResponseType } from '../../response-types'; + +const action = 'search_content_types'; + +const options = { + ...contentfulBaseOptions, + query: { + type: 'string', + required: false, + }, + limit: { + type: 'int', + required: false, + default_value: 100, + }, + skip: { + type: 'int', + required: false, + default_value: 0, + }, +} satisfies TQoreOptions; + +const SearchContentTypes = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeListResponseType, + api_function: async (obj, _opts, context) => { + const { space_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + const limit = (obj?.limit as number) || 100; + const skip = (obj?.skip as number) || 0; + const queryText = obj?.query as string | undefined; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + + const query: Record = { limit, skip }; + if (queryText) { + query.query = queryText; + } + + const contentTypes = await client.contentType.getMany({ query }); + + return contentTypes.items.map((ct) => ({ + id: ct.sys.id, + name: ct.name, + description: ct.description, + display_field: ct.displayField, + fields: ct.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + })); + } catch (error) { + throw new ContentfulError(`Failed to search content types: ${error}`); + } + }, +}); + +export default SearchContentTypes; diff --git a/ts/src/apps/contentful/actions/content-types/update-content-type.action.ts b/ts/src/apps/contentful/actions/content-types/update-content-type.action.ts new file mode 100644 index 00000000..12ed598f --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/update-content-type.action.ts @@ -0,0 +1,72 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeResponseType } from '../../response-types'; + +const action = 'update_content_type'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + name: { + type: 'string', + required: false, + required_groups: ['update_field'], + }, + description: { + type: 'string', + required: false, + required_groups: ['update_field'], + }, +} satisfies TQoreOptions; + +const UpdateContentType = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const current = await client.contentType.get({ contentTypeId: content_type_id }); + + const updated = await client.contentType.update( + { contentTypeId: content_type_id }, + { + ...current, + name: (obj?.name as string) || current.name, + description: obj?.description !== undefined ? (obj.description as string) : current.description, + sys: current.sys as any, + } + ); + + return { + id: updated.sys.id, + name: updated.name, + description: updated.description, + display_field: updated.displayField, + fields: updated.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + }; + } catch (error) { + throw new ContentfulError(`Failed to update content type: ${error}`); + } + }, +}); + +export default UpdateContentType; diff --git a/ts/src/apps/contentful/actions/content-types/update-field.action.ts b/ts/src/apps/contentful/actions/content-types/update-field.action.ts new file mode 100644 index 00000000..78d63b95 --- /dev/null +++ b/ts/src/apps/contentful/actions/content-types/update-field.action.ts @@ -0,0 +1,96 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulFieldAllowedValues } from '../../helpers/get-field-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { ContentfulContentTypeResponseType } from '../../response-types'; + +const action = 'update_field_of_content_type'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + field_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulFieldAllowedValues, + depends_on: ['content_type_id'], + }, + field_name: { + type: 'string', + required: false, + required_groups: ['update_field'], + }, + required: { + type: 'bool', + required: false, + required_groups: ['update_field'], + }, + localized: { + type: 'bool', + required: false, + required_groups: ['update_field'], + }, +} satisfies TQoreOptions; + +const UpdateField = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulContentTypeResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id, field_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id', 'field_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const current = await client.contentType.get({ contentTypeId: content_type_id }); + + const updatedFields = current.fields.map((f) => { + if (f.id !== field_id) { + return f; + } + + return { + ...f, + name: (obj?.field_name as string) || f.name, + required: obj?.required !== undefined ? obj.required === true : f.required, + localized: obj?.localized !== undefined ? obj.localized === true : f.localized, + }; + }); + + const updated = await client.contentType.update( + { contentTypeId: content_type_id }, + { + ...current, + fields: updatedFields, + sys: current.sys as any, + } + ); + + return { + id: updated.sys.id, + name: updated.name, + description: updated.description, + display_field: updated.displayField, + fields: updated.fields.map((f) => ({ + id: f.id, + name: f.name, + type: f.type, + required: f.required, + localized: f.localized, + })), + }; + } catch (error) { + throw new ContentfulError(`Failed to update field: ${error}`); + } + }, +}); + +export default UpdateField; diff --git a/ts/src/apps/contentful/actions/entries/archive-entry.action.ts b/ts/src/apps/contentful/actions/entries/archive-entry.action.ts new file mode 100644 index 00000000..8961f98c --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/archive-entry.action.ts @@ -0,0 +1,63 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulEntryAllowedValues } from '../../helpers/get-entry-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; + +const action = 'archive_entry'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + entry_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulEntryAllowedValues, + }, + archive: { + type: 'bool', + required: true, + default_value: true, + }, +} satisfies TQoreOptions; + +const ArchiveEntry = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Entry ID' }, + archived: { type: 'bool', short_desc: 'Whether the entry is archived' }, + }, + }, + api_function: async (obj, _opts, context) => { + const { space_id, entry_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'entry_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + const shouldArchive = obj?.archive !== false; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + + if (shouldArchive) { + await client.entry.archive({ entryId: entry_id }); + } else { + await client.entry.unarchive({ entryId: entry_id }); + } + + return { id: entry_id, archived: shouldArchive }; + } catch (error) { + const operation = shouldArchive ? 'archive' : 'unarchive'; + throw new ContentfulError(`Failed to ${operation} entry: ${error}`); + } + }, +}); + +export default ArchiveEntry; diff --git a/ts/src/apps/contentful/actions/entries/create-entry.action.ts b/ts/src/apps/contentful/actions/entries/create-entry.action.ts new file mode 100644 index 00000000..6ec2966c --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/create-entry.action.ts @@ -0,0 +1,68 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { flattenEntry, getDefaultLocale, wrapFieldsWithLocale } from '../../helpers/contentful-type-mapping'; +import { getContentfulEntryFieldOptions, getContentfulEntryDynamicResponseType } from '../../helpers/get-dynamic-entry-type'; +import { ContentfulEntryResponseType } from '../../response-types'; + +const action = 'create_entry'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + fields: { + type: 'hash', + required: true, + get_dynamic_type: getContentfulEntryFieldOptions, + depends_on: ['content_type_id'], + }, + publish: { + type: 'bool', + required: false, + default_value: false, + }, +} satisfies TQoreOptions; + +const CreateEntry = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulEntryResponseType, + get_dynamic_response_type: getContentfulEntryDynamicResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id, fields } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id', 'fields'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + const shouldPublish = obj?.publish === true; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + const wrappedFields = wrapFieldsWithLocale(fields as Record, defaultLocale); + + let entry = await client.entry.create( + { contentTypeId: content_type_id }, + { fields: wrappedFields } + ); + + if (shouldPublish) { + entry = await client.entry.publish( + { entryId: entry.sys.id }, + { sys: { version: entry.sys.version } } as any + ) as any; + } + + return flattenEntry(entry, defaultLocale); + } catch (error) { + throw new ContentfulError(`Failed to create entry: ${error}`); + } + }, +}); + +export default CreateEntry; diff --git a/ts/src/apps/contentful/actions/entries/delete-entry.action.ts b/ts/src/apps/contentful/actions/entries/delete-entry.action.ts new file mode 100644 index 00000000..66d52f9e --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/delete-entry.action.ts @@ -0,0 +1,63 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulEntryAllowedValues } from '../../helpers/get-entry-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; + +const action = 'delete_entry'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + entry_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulEntryAllowedValues, + depends_on: ['content_type_id'], + }, +} satisfies TQoreOptions; + +const DeleteEntry = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Deleted entry ID' }, + deleted: { type: 'bool', short_desc: 'Whether the entry was successfully deleted' }, + }, + }, + api_function: async (obj, _opts, context) => { + const { space_id, entry_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'entry_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + + // Unpublish if published before deleting + try { + const entry = await client.entry.get({ entryId: entry_id }); + if ((entry.sys as any).publishedVersion) { + await client.entry.unpublish({ entryId: entry_id }); + } + } catch { + // Entry may already be unpublished + } + + await client.entry.delete({ entryId: entry_id }); + + return { id: entry_id, deleted: true }; + } catch (error) { + throw new ContentfulError(`Failed to delete entry: ${error}`); + } + }, +}); + +export default DeleteEntry; diff --git a/ts/src/apps/contentful/actions/entries/get-entry-with-replacement.action.ts b/ts/src/apps/contentful/actions/entries/get-entry-with-replacement.action.ts new file mode 100644 index 00000000..bfadae19 --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/get-entry-with-replacement.action.ts @@ -0,0 +1,78 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulEntryAllowedValues } from '../../helpers/get-entry-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { flattenEntry, getDefaultLocale } from '../../helpers/contentful-type-mapping'; +import { getContentfulEntryDynamicResponseType } from '../../helpers/get-dynamic-entry-type'; +import { ContentfulEntryResponseType } from '../../response-types'; + +const action = 'get_entry_with_replacement'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + entry_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulEntryAllowedValues, + depends_on: ['content_type_id'], + }, + replacements: { + type: { + type: 'list', + element_type: { + type: 'hash', + fields: { + tag: { type: 'string', short_desc: 'The tag/placeholder to search for in text fields' }, + value: { type: 'string', short_desc: 'The replacement value' }, + }, + }, + }, + required: true, + }, +} satisfies TQoreOptions; + +const GetEntryWithReplacement = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulEntryResponseType, + get_dynamic_response_type: getContentfulEntryDynamicResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, entry_id, replacements } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'entry_id', 'replacements'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + const entry = await client.entry.get({ entryId: entry_id }); + const flattened = flattenEntry(entry, defaultLocale); + + const replacementList = replacements as Array<{ tag: string; value: string }>; + + for (const key of Object.keys(flattened)) { + const val = flattened[key]; + if (typeof val === 'string') { + let replaced = val; + for (const { tag, value } of replacementList) { + replaced = replaced.split(tag).join(value); + } + flattened[key] = replaced; + } + } + + return flattened; + } catch (error) { + throw new ContentfulError(`Failed to get entry with replacement: ${error}`); + } + }, +}); + +export default GetEntryWithReplacement; diff --git a/ts/src/apps/contentful/actions/entries/get-entry.action.ts b/ts/src/apps/contentful/actions/entries/get-entry.action.ts new file mode 100644 index 00000000..7e88883f --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/get-entry.action.ts @@ -0,0 +1,51 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulEntryAllowedValues } from '../../helpers/get-entry-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { flattenEntry, getDefaultLocale } from '../../helpers/contentful-type-mapping'; +import { getContentfulEntryDynamicResponseType } from '../../helpers/get-dynamic-entry-type'; +import { ContentfulEntryResponseType } from '../../response-types'; + +const action = 'get_entry'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + entry_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulEntryAllowedValues, + depends_on: ['content_type_id'], + }, +} satisfies TQoreOptions; + +const GetEntry = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulEntryResponseType, + get_dynamic_response_type: getContentfulEntryDynamicResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, entry_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'entry_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + const entry = await client.entry.get({ entryId: entry_id }); + + return flattenEntry(entry, defaultLocale); + } catch (error) { + throw new ContentfulError(`Failed to get entry: ${error}`); + } + }, +}); + +export default GetEntry; diff --git a/ts/src/apps/contentful/actions/entries/publish-entry.action.ts b/ts/src/apps/contentful/actions/entries/publish-entry.action.ts new file mode 100644 index 00000000..d451504a --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/publish-entry.action.ts @@ -0,0 +1,55 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulEntryAllowedValues } from '../../helpers/get-entry-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { ContentfulPublishResponseType } from '../../response-types'; + +const action = 'publish_entry'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + entry_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulEntryAllowedValues, + }, +} satisfies TQoreOptions; + +const PublishEntry = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulPublishResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, entry_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'entry_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const entry = await client.entry.get({ entryId: entry_id }); + + const published = await client.entry.publish( + { entryId: entry_id }, + { sys: { version: entry.sys.version } } as any + ); + + return { + id: published.sys.id, + version: published.sys.version, + published_at: (published.sys as any).publishedAt, + }; + } catch (error) { + throw new ContentfulError(`Failed to publish entry: ${error}`); + } + }, +}); + +export default PublishEntry; diff --git a/ts/src/apps/contentful/actions/entries/search-entries.action.ts b/ts/src/apps/contentful/actions/entries/search-entries.action.ts new file mode 100644 index 00000000..529386d6 --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/search-entries.action.ts @@ -0,0 +1,72 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { flattenEntry, getDefaultLocale } from '../../helpers/contentful-type-mapping'; +import { getContentfulEntryDynamicResponseType } from '../../helpers/get-dynamic-entry-type'; +import { ContentfulEntryListResponseType } from '../../response-types'; + +const action = 'search_entries'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + query: { + type: 'string', + required: false, + }, + limit: { + type: 'int', + required: false, + default_value: 100, + }, + skip: { + type: 'int', + required: false, + default_value: 0, + }, +} satisfies TQoreOptions; + +const SearchEntries = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulEntryListResponseType, + get_dynamic_response_type: getContentfulEntryDynamicResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, content_type_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'content_type_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + const limit = (obj?.limit as number) || 100; + const skip = (obj?.skip as number) || 0; + const queryText = obj?.query as string | undefined; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + + const query: Record = { + content_type: content_type_id, + limit, + skip, + }; + + if (queryText) { + query.query = queryText; + } + + const entries = await client.entry.getMany({ query }); + + return entries.items.map((entry) => flattenEntry(entry, defaultLocale)); + } catch (error) { + throw new ContentfulError(`Failed to search entries: ${error}`); + } + }, +}); + +export default SearchEntries; diff --git a/ts/src/apps/contentful/actions/entries/unpublish-entry.action.ts b/ts/src/apps/contentful/actions/entries/unpublish-entry.action.ts new file mode 100644 index 00000000..37d31f80 --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/unpublish-entry.action.ts @@ -0,0 +1,54 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulEntryAllowedValues } from '../../helpers/get-entry-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; + +const action = 'unpublish_entry'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + entry_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulEntryAllowedValues, + }, +} satisfies TQoreOptions; + +const UnpublishEntry = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Entry ID' }, + version: { type: 'int', short_desc: 'Current version number' }, + }, + }, + api_function: async (obj, _opts, context) => { + const { space_id, entry_id } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'entry_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const unpublished = await client.entry.unpublish({ entryId: entry_id }); + + return { + id: unpublished.sys.id, + version: unpublished.sys.version, + }; + } catch (error) { + throw new ContentfulError(`Failed to unpublish entry: ${error}`); + } + }, +}); + +export default UnpublishEntry; diff --git a/ts/src/apps/contentful/actions/entries/update-entry.action.ts b/ts/src/apps/contentful/actions/entries/update-entry.action.ts new file mode 100644 index 00000000..12446ea3 --- /dev/null +++ b/ts/src/apps/contentful/actions/entries/update-entry.action.ts @@ -0,0 +1,73 @@ +import { EQoreAppActionCode, QoreAppCreator, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../../global/helpers'; +import { getContentfulScopedClient } from '../../client'; +import { CONTENTFUL_APP_NAME, ContentfulError } from '../../constants'; +import { getContentfulEntryAllowedValues } from '../../helpers/get-entry-allowed-values'; +import { contentfulBaseWithContentTypeOptions } from '../../helpers/shared-options'; +import { flattenEntry, getDefaultLocale, wrapFieldsWithLocale } from '../../helpers/contentful-type-mapping'; +import { getContentfulEntryFieldOptions, getContentfulEntryDynamicResponseType } from '../../helpers/get-dynamic-entry-type'; +import { ContentfulEntryResponseType } from '../../response-types'; + +const action = 'update_entry'; + +const options = { + ...contentfulBaseWithContentTypeOptions, + entry_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulEntryAllowedValues, + depends_on: ['content_type_id'], + }, + fields: { + type: 'hash', + required: true, + required_groups: ['update_field'], + get_dynamic_type: getContentfulEntryFieldOptions, + depends_on: ['content_type_id'], + }, +} satisfies TQoreOptions; + +const UpdateEntry = QoreAppCreator.createLocalizedAction({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.ACTION, + options, + response_type: ContentfulEntryResponseType, + get_dynamic_response_type: getContentfulEntryDynamicResponseType, + api_function: async (obj, _opts, context) => { + const { space_id, entry_id, fields } = getQoreContextRequiredValues({ + context: { ...context, opts: obj }, + optionFields: ['space_id', 'entry_id', 'fields'], + ErrorClass: ContentfulError, + }); + + const environmentId = obj?.environment_id || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const defaultLocale = await getDefaultLocale(client, space_id); + + const currentEntry = await client.entry.get({ entryId: entry_id }); + const updatedFields = wrapFieldsWithLocale(fields as Record, defaultLocale); + + const mergedFields = { + ...(currentEntry.fields as Record>), + ...updatedFields, + }; + + const updatedEntry = await client.entry.update( + { entryId: entry_id }, + { + sys: { version: currentEntry.sys.version } as any, + fields: mergedFields, + } + ); + + return flattenEntry(updatedEntry, defaultLocale); + } catch (error) { + throw new ContentfulError(`Failed to update entry: ${error}`); + } + }, +}); + +export default UpdateEntry; diff --git a/ts/src/apps/contentful/actions/index.ts b/ts/src/apps/contentful/actions/index.ts new file mode 100644 index 00000000..f0e701d4 --- /dev/null +++ b/ts/src/apps/contentful/actions/index.ts @@ -0,0 +1,32 @@ +// Entry actions +export { default as get_entry } from './entries/get-entry.action'; +export { default as get_entry_with_replacement } from './entries/get-entry-with-replacement.action'; +export { default as create_entry } from './entries/create-entry.action'; +export { default as update_entry } from './entries/update-entry.action'; +export { default as delete_entry } from './entries/delete-entry.action'; +export { default as publish_entry } from './entries/publish-entry.action'; +export { default as unpublish_entry } from './entries/unpublish-entry.action'; +export { default as archive_entry } from './entries/archive-entry.action'; +export { default as search_entries } from './entries/search-entries.action'; + +// Asset actions +export { default as get_asset } from './assets/get-asset.action'; +export { default as create_asset } from './assets/create-asset.action'; +export { default as update_asset } from './assets/update-asset.action'; +export { default as delete_asset } from './assets/delete-asset.action'; +export { default as publish_asset } from './assets/publish-asset.action'; +export { default as unpublish_asset } from './assets/unpublish-asset.action'; +export { default as archive_asset } from './assets/archive-asset.action'; +export { default as search_assets } from './assets/search-assets.action'; + +// Content type actions +export { default as get_content_type } from './content-types/get-content-type.action'; +export { default as create_content_type } from './content-types/create-content-type.action'; +export { default as update_content_type } from './content-types/update-content-type.action'; +export { default as delete_content_type } from './content-types/delete-content-type.action'; +export { default as activate_content_type } from './content-types/activate-content-type.action'; +export { default as deactivate_content_type } from './content-types/deactivate-content-type.action'; +export { default as add_field_to_content_type } from './content-types/add-field.action'; +export { default as update_field_of_content_type } from './content-types/update-field.action'; +export { default as delete_field_from_content_type } from './content-types/delete-field.action'; +export { default as search_content_types } from './content-types/search-content-types.action'; diff --git a/ts/src/apps/contentful/client.ts b/ts/src/apps/contentful/client.ts new file mode 100644 index 00000000..bf0cf471 --- /dev/null +++ b/ts/src/apps/contentful/client.ts @@ -0,0 +1,50 @@ +import * as contentfulModule from 'contentful-management'; + +// Handle both ESM default import and CJS require +const contentful = (contentfulModule as unknown as { default?: typeof contentfulModule }).default || contentfulModule; +import { getQoreContextRequiredValues } from '../../global/helpers'; +import { ContentfulError } from './constants'; + +/** + * Creates a plain Contentful Management client with just the access token. + * Use for operations that don't need a specific space (e.g., listing spaces). + */ +export const getContentfulClient = (context: Record | undefined) => { + const { token } = getQoreContextRequiredValues({ + context, + connectionFields: ['token'], + ErrorClass: ContentfulError, + }); + + return contentful.createClient( + { accessToken: token }, + { type: 'plain' } + ); +}; + +/** + * Creates a plain Contentful Management client scoped to a specific space and environment. + * Use for operations on entries, assets, content types, etc. + */ +export const getContentfulScopedClient = ( + context: Record | undefined, + spaceId: string, + environmentId?: string +) => { + const { token } = getQoreContextRequiredValues({ + context, + connectionFields: ['token'], + ErrorClass: ContentfulError, + }); + + return contentful.createClient( + { accessToken: token }, + { + type: 'plain', + defaults: { + spaceId, + environmentId: environmentId || 'master', + }, + } + ); +}; diff --git a/ts/src/apps/contentful/constants.ts b/ts/src/apps/contentful/constants.ts new file mode 100644 index 00000000..43439038 --- /dev/null +++ b/ts/src/apps/contentful/constants.ts @@ -0,0 +1,44 @@ +import { TCustomConnOptions } from '@qoretechnologies/ts-toolkit'; + +export class ContentfulError extends Error { + constructor(message: string) { + super(message); + this.name = 'ContentfulError'; + } +} + +export const CONTENTFUL_APP_NAME = 'Contentful'; + +export const CONTENTFUL_APP_LOGO = + 'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTIgMjg5Ij48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImEiIHgxPSIuNSIgeDI9Ii41IiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjZTViNGExIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjZTY4YTFhIi8+PC9saW5lYXJHcmFkaWVudD48bGluZWFyR3JhZGllbnQgaWQ9ImIiIHgxPSIuNSIgeDI9Ii41IiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjZWZkOGNlIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjZTZhNTZlIi8+PC9saW5lYXJHcmFkaWVudD48L2RlZnM+PHBhdGggZmlsbD0idXJsKCNhKSIgZD0iTTAgMjg5TDEyNS41IDE3MCAxNjIgMjA0LjUgMzYuNSAyODl6Ii8+PHBhdGggZmlsbD0iI2U4NjgyNSIgZD0iTTAgMEwxMjUuNSAxMTkgMTYyIDg0LjUgMzYuNSAwegoiLz48cGF0aCBmaWxsPSIjZTY4YTFhIiBkPSJNMzYuNSAwTDE2MiA4NC41IDE2MiAyMDQuNSAzNi41IDI4OXpNMjE1LjUgMEwyNTIgMjQuNSAyNTIgMjY0LjUgMjE1LjUgMjg5eiIvPjxwYXRoIGZpbGw9InVybCgjYikiIGQ9Ik0yMTUuNSAwTDg5LjUgMTE5IDg5LjUgMTcwIDIxNS41IDI4OXoiLz48L3N2Zz4='; + +export const CONTENTFUL_API_URL = 'https://api.contentful.com'; + +export const CONTENTFUL_CONN_OPTIONS = { + token: { + type: 'string', + display_name: 'Content Management API Token', + short_desc: 'Your Contentful Content Management API access token.', + desc: 'A personal access token for the Contentful Content Management API. Can be created in Settings > CMA tokens in your Contentful dashboard.', + }, +} satisfies TCustomConnOptions; + +export const extractContentfulErrorMessage = (error: unknown): string => { + if (error instanceof ContentfulError) { + return error.message; + } + + if (error instanceof Error) { + try { + const parsed = JSON.parse(error.message); + if (parsed?.message) { + return parsed.message; + } + } catch { + // not JSON + } + return error.message; + } + + return String(error); +}; diff --git a/ts/src/apps/contentful/helpers/contentful-type-mapping.ts b/ts/src/apps/contentful/helpers/contentful-type-mapping.ts new file mode 100644 index 00000000..1caf5f64 --- /dev/null +++ b/ts/src/apps/contentful/helpers/contentful-type-mapping.ts @@ -0,0 +1,155 @@ +import { ContentfulError } from '../constants'; + +const localeCache = new Map(); + +/** + * Fetches and caches the default locale for a space. + */ +export const getDefaultLocale = async ( + client: { locale: { getMany: (params: Record) => Promise<{ items: Array<{ default: boolean; code: string }> }> } }, + spaceId: string +): Promise => { + const cached = localeCache.get(spaceId); + if (cached) { + return cached; + } + + try { + const locales = await client.locale.getMany({ query: { limit: 100 } }); + const defaultLocale = locales.items.find((l) => l.default); + const code = defaultLocale?.code || 'en-US'; + localeCache.set(spaceId, code); + return code; + } catch (error) { + throw new ContentfulError(`Failed to fetch locales: ${error}`); + } +}; + +/** + * Flattens Contentful locale-wrapped fields to a simple key-value object. + * { title: { 'en-US': 'Hello' } } → { title: 'Hello' } + */ +export const flattenEntryFields = ( + fields: Record>, + defaultLocale: string +): Record => { + const result: Record = {}; + + for (const [key, localeValues] of Object.entries(fields)) { + if (localeValues && typeof localeValues === 'object') { + result[key] = localeValues[defaultLocale] ?? Object.values(localeValues)[0]; + } else { + result[key] = localeValues; + } + } + + return result; +}; + +/** + * Wraps simple key-value fields with the locale structure. + * { title: 'Hello' } → { title: { 'en-US': 'Hello' } } + */ +export const wrapFieldsWithLocale = ( + fields: Record, + defaultLocale: string +): Record> => { + const result: Record> = {}; + + for (const [key, value] of Object.entries(fields)) { + if (value !== undefined && value !== null) { + result[key] = { [defaultLocale]: value }; + } + } + + return result; +}; + +/** + * Flattens a full Contentful entry into a flat object with sys metadata. + */ +export const flattenEntry = < + T extends { + sys: { id: string; createdAt: string; updatedAt: string; version: number; contentType?: { sys: { id: string } } }; + fields: Record>; + }, +>( + entry: T, + defaultLocale: string +): Record => { + return { + id: entry.sys.id, + content_type: entry.sys.contentType?.sys?.id, + created_at: entry.sys.createdAt, + updated_at: entry.sys.updatedAt, + version: entry.sys.version, + ...flattenEntryFields(entry.fields, defaultLocale), + }; +}; + +/** + * Flattens a full Contentful asset into a flat object. + */ +export const flattenAsset = < + T extends { + sys: { id: string; createdAt: string; updatedAt: string; version: number }; + fields: Record>; + }, +>( + asset: T, + defaultLocale: string +): Record => { + const fields = flattenEntryFields(asset.fields, defaultLocale); + const file = fields.file as Record | undefined; + + return { + id: asset.sys.id, + created_at: asset.sys.createdAt, + updated_at: asset.sys.updatedAt, + version: asset.sys.version, + title: fields.title, + description: fields.description, + file_name: file?.fileName, + content_type: file?.contentType, + url: file?.url ? `https:${file.url}` : undefined, + size: (file?.details as Record)?.size, + }; +}; + +/** + * Maps Contentful field types to Qore types. + */ +export const mapContentfulFieldTypeToQoreType = ( + fieldType: string +): { type: string; fields?: Record } => { + switch (fieldType) { + case 'Symbol': + case 'Text': + case 'RichText': + return { type: 'string' }; + case 'Integer': + return { type: 'int' }; + case 'Number': + return { type: 'float' }; + case 'Date': + return { type: 'date' }; + case 'Boolean': + return { type: 'bool' }; + case 'Location': + return { + type: 'hash', + fields: { + lat: { type: 'float', short_desc: 'Latitude' }, + lon: { type: 'float', short_desc: 'Longitude' }, + }, + }; + case 'Object': + return { type: 'hash' }; + case 'Link': + return { type: 'string' }; + case 'Array': + return { type: 'list' }; + default: + return { type: 'string' }; + } +}; diff --git a/ts/src/apps/contentful/helpers/get-asset-allowed-values.ts b/ts/src/apps/contentful/helpers/get-asset-allowed-values.ts new file mode 100644 index 00000000..048fde82 --- /dev/null +++ b/ts/src/apps/contentful/helpers/get-asset-allowed-values.ts @@ -0,0 +1,34 @@ +import { TCustomConnOptions, TQoreGetAllowedValuesFunction } from '@qoretechnologies/ts-toolkit'; +import { getContentfulScopedClient } from '../client'; +import { getDefaultLocale } from './contentful-type-mapping'; + +export const getContentfulAssetAllowedValues: TQoreGetAllowedValuesFunction< + TCustomConnOptions, + string +> = async (context) => { + const spaceId = context?.opts?.space_id; + const environmentId = context?.opts?.environment_id || 'master'; + + if (!context?.conn_opts?.token || !spaceId) { + return []; + } + + try { + const client = getContentfulScopedClient(context, spaceId, environmentId); + const defaultLocale = await getDefaultLocale(client, spaceId); + + const assets = await client.asset.getMany({ query: { limit: 100 } }); + + return assets.items.map((asset) => { + const fields = asset.fields as Record>; + const title = fields.title?.[defaultLocale] || fields.title?.[Object.keys(fields.title || {})[0]]; + + return { + value: asset.sys.id, + display_name: title ? String(title) : asset.sys.id, + }; + }); + } catch { + return []; + } +}; diff --git a/ts/src/apps/contentful/helpers/get-content-type-allowed-values.ts b/ts/src/apps/contentful/helpers/get-content-type-allowed-values.ts new file mode 100644 index 00000000..123d9ea5 --- /dev/null +++ b/ts/src/apps/contentful/helpers/get-content-type-allowed-values.ts @@ -0,0 +1,28 @@ +import { TCustomConnOptions, TQoreGetAllowedValuesFunction } from '@qoretechnologies/ts-toolkit'; +import { getContentfulScopedClient } from '../client'; + +export const getContentfulContentTypeAllowedValues: TQoreGetAllowedValuesFunction< + TCustomConnOptions, + string +> = async (context) => { + const spaceId = context?.opts?.space_id; + const environmentId = context?.opts?.environment_id || 'master'; + + if (!context?.conn_opts?.token || !spaceId) { + return []; + } + + try { + const client = getContentfulScopedClient(context, spaceId, environmentId); + const contentTypes = await client.contentType.getMany({ + query: { limit: 1000 }, + }); + + return contentTypes.items.map((ct) => ({ + value: ct.sys.id, + display_name: ct.name, + })); + } catch { + return []; + } +}; diff --git a/ts/src/apps/contentful/helpers/get-dynamic-entry-type.ts b/ts/src/apps/contentful/helpers/get-dynamic-entry-type.ts new file mode 100644 index 00000000..ee31cf86 --- /dev/null +++ b/ts/src/apps/contentful/helpers/get-dynamic-entry-type.ts @@ -0,0 +1,111 @@ +import { TQoreGetDynamicTypeFunction, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../global/helpers'; +import { ContentfulError } from '../constants'; +import { getContentfulScopedClient } from '../client'; +import { mapContentfulFieldTypeToQoreType } from './contentful-type-mapping'; + +/** + * Returns dynamic option types for entry fields based on the selected content type. + * Used as `get_dynamic_type` on the `fields` option. + */ +export const getContentfulEntryFieldOptions: TQoreGetDynamicTypeFunction = async (context) => { + const { space_id, content_type_id } = getQoreContextRequiredValues({ + context, + optionFields: ['space_id', 'content_type_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = (context?.opts?.environment_id as string) || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const contentType = await client.contentType.get({ contentTypeId: content_type_id }); + + const qoreOptions: TQoreOptions = {}; + + for (const field of contentType.fields) { + if (field.disabled || field.omitted) { + continue; + } + + const qoreType = mapContentfulFieldTypeToQoreType(field.type); + + qoreOptions[field.id] = { + ...qoreType, + display_name: field.name, + required: field.required || false, + ...(field.type === 'Array' && field.items?.type === 'Symbol' + ? { type: { type: 'list', element_type: 'string' } } + : {}), + ...(field.type === 'Array' && field.items?.type === 'Link' + ? { type: { type: 'list', element_type: 'string' } } + : {}), + } as TQoreOptions[string]; + } + + return { + type: 'hash', + fields: qoreOptions, + }; + } catch { + return { type: 'hash' }; + } +}; + +/** + * Returns dynamic response type for entries based on the selected content type. + * Includes system fields plus content type-specific fields. + */ +export const getContentfulEntryDynamicResponseType: TQoreGetDynamicTypeFunction = async (context) => { + const { space_id, content_type_id } = getQoreContextRequiredValues({ + context, + optionFields: ['space_id', 'content_type_id'], + ErrorClass: ContentfulError, + }); + + const environmentId = (context?.opts?.environment_id as string) || 'master'; + + try { + const client = getContentfulScopedClient(context, space_id, environmentId); + const contentType = await client.contentType.get({ contentTypeId: content_type_id }); + + const fields: TQoreOptions = { + id: { type: 'string', short_desc: 'Entry ID' }, + content_type: { type: 'string', short_desc: 'Content type ID' }, + created_at: { type: 'date', short_desc: 'Creation timestamp' }, + updated_at: { type: 'date', short_desc: 'Last update timestamp' }, + version: { type: 'int', short_desc: 'Current version number' }, + }; + + for (const field of contentType.fields) { + const qoreType = mapContentfulFieldTypeToQoreType(field.type); + + fields[field.id] = { + ...qoreType, + display_name: field.name, + ...(field.type === 'Array' && field.items?.type === 'Symbol' + ? { type: { type: 'list', element_type: 'string' } } + : {}), + ...(field.type === 'Array' && field.items?.type === 'Link' + ? { type: { type: 'list', element_type: 'string' } } + : {}), + } as TQoreOptions[string]; + } + + return { + type: 'hash', + fields, + }; + } catch { + return { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Entry ID' }, + content_type: { type: 'string', short_desc: 'Content type ID' }, + created_at: { type: 'date', short_desc: 'Creation timestamp' }, + updated_at: { type: 'date', short_desc: 'Last update timestamp' }, + version: { type: 'int', short_desc: 'Current version number' }, + }, + }; + } +}; diff --git a/ts/src/apps/contentful/helpers/get-entry-allowed-values.ts b/ts/src/apps/contentful/helpers/get-entry-allowed-values.ts new file mode 100644 index 00000000..90b7e0a0 --- /dev/null +++ b/ts/src/apps/contentful/helpers/get-entry-allowed-values.ts @@ -0,0 +1,43 @@ +import { TCustomConnOptions, TQoreGetAllowedValuesFunction } from '@qoretechnologies/ts-toolkit'; +import { getContentfulScopedClient } from '../client'; +import { getDefaultLocale } from './contentful-type-mapping'; + +export const getContentfulEntryAllowedValues: TQoreGetAllowedValuesFunction< + TCustomConnOptions, + string +> = async (context) => { + const spaceId = context?.opts?.space_id; + const environmentId = context?.opts?.environment_id || 'master'; + const contentTypeId = context?.opts?.content_type_id; + + if (!context?.conn_opts?.token || !spaceId) { + return []; + } + + try { + const client = getContentfulScopedClient(context, spaceId, environmentId); + const defaultLocale = await getDefaultLocale(client, spaceId); + + const query: Record = { limit: 100 }; + if (contentTypeId) { + query.content_type = contentTypeId; + } + + const entries = await client.entry.getMany({ query }); + + return entries.items.map((entry) => { + const fields = entry.fields as Record>; + const displayField = Object.keys(fields)[0]; + const displayValue = displayField + ? String(fields[displayField]?.[defaultLocale] || entry.sys.id) + : entry.sys.id; + + return { + value: entry.sys.id, + display_name: displayValue, + }; + }); + } catch { + return []; + } +}; diff --git a/ts/src/apps/contentful/helpers/get-environment-allowed-values.ts b/ts/src/apps/contentful/helpers/get-environment-allowed-values.ts new file mode 100644 index 00000000..466a4538 --- /dev/null +++ b/ts/src/apps/contentful/helpers/get-environment-allowed-values.ts @@ -0,0 +1,28 @@ +import { TCustomConnOptions, TQoreGetAllowedValuesFunction } from '@qoretechnologies/ts-toolkit'; +import { getContentfulClient } from '../client'; + +export const getContentfulEnvironmentAllowedValues: TQoreGetAllowedValuesFunction< + TCustomConnOptions, + string +> = async (context) => { + const spaceId = context?.opts?.space_id; + + if (!context?.conn_opts?.token || !spaceId) { + return []; + } + + try { + const client = getContentfulClient(context); + const environments = await client.environment.getMany({ + spaceId, + query: { limit: 100 }, + }); + + return environments.items.map((env) => ({ + value: env.sys.id, + display_name: env.name, + })); + } catch { + return []; + } +}; diff --git a/ts/src/apps/contentful/helpers/get-field-allowed-values.ts b/ts/src/apps/contentful/helpers/get-field-allowed-values.ts new file mode 100644 index 00000000..8f84bf88 --- /dev/null +++ b/ts/src/apps/contentful/helpers/get-field-allowed-values.ts @@ -0,0 +1,27 @@ +import { TCustomConnOptions, TQoreGetAllowedValuesFunction } from '@qoretechnologies/ts-toolkit'; +import { getContentfulScopedClient } from '../client'; + +export const getContentfulFieldAllowedValues: TQoreGetAllowedValuesFunction< + TCustomConnOptions, + string +> = async (context) => { + const spaceId = context?.opts?.space_id; + const environmentId = context?.opts?.environment_id || 'master'; + const contentTypeId = context?.opts?.content_type_id; + + if (!context?.conn_opts?.token || !spaceId || !contentTypeId) { + return []; + } + + try { + const client = getContentfulScopedClient(context, spaceId, environmentId); + const contentType = await client.contentType.get({ contentTypeId }); + + return contentType.fields.map((field) => ({ + value: field.id, + display_name: field.name, + })); + } catch { + return []; + } +}; diff --git a/ts/src/apps/contentful/helpers/get-space-allowed-values.ts b/ts/src/apps/contentful/helpers/get-space-allowed-values.ts new file mode 100644 index 00000000..cc4495e5 --- /dev/null +++ b/ts/src/apps/contentful/helpers/get-space-allowed-values.ts @@ -0,0 +1,45 @@ +import { IQoreAllowedValue, TCustomConnOptions, TQoreGetAllowedValuesFunction } from '@qoretechnologies/ts-toolkit'; +import { getContentfulClient } from '../client'; + +export const getContentfulSpaceAllowedValues: TQoreGetAllowedValuesFunction< + TCustomConnOptions, + string +> = async (context) => { + if (!context?.conn_opts?.token) { + return []; + } + + try { + const client = getContentfulClient(context); + + // First try the direct /spaces endpoint + const spaces = await client.space.getMany({ query: { limit: 100 } }); + if (spaces.items.length > 0) { + return spaces.items.map((space) => ({ + value: space.sys.id, + display_name: space.name, + })); + } + + // If no spaces found, try via organizations (org-scoped tokens) + const orgs = await client.organization.getAll({}); + const results: IQoreAllowedValue[] = []; + + for (const org of orgs.items) { + const orgSpaces = await client.space.getManyForOrganization({ + organizationId: org.sys.id, + query: { limit: 100 }, + }); + for (const space of orgSpaces.items) { + results.push({ + value: space.sys.id, + display_name: space.name, + }); + } + } + + return results; + } catch { + return []; + } +}; diff --git a/ts/src/apps/contentful/helpers/shared-options.ts b/ts/src/apps/contentful/helpers/shared-options.ts new file mode 100644 index 00000000..429b6d4c --- /dev/null +++ b/ts/src/apps/contentful/helpers/shared-options.ts @@ -0,0 +1,43 @@ +import { TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getContentfulSpaceAllowedValues } from './get-space-allowed-values'; +import { getContentfulEnvironmentAllowedValues } from './get-environment-allowed-values'; +import { getContentfulContentTypeAllowedValues } from './get-content-type-allowed-values'; + +export const contentfulSpaceOption = { + space_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulSpaceAllowedValues, + on_change: ['refetch'], + }, +} satisfies TQoreOptions; + +export const contentfulEnvironmentOption = { + environment_id: { + type: 'string', + required: false, + get_allowed_values: getContentfulEnvironmentAllowedValues, + depends_on: ['space_id'], + default_value: 'master', + }, +} satisfies TQoreOptions; + +export const contentfulContentTypeOption = { + content_type_id: { + type: 'string', + required: true, + get_allowed_values: getContentfulContentTypeAllowedValues, + depends_on: ['space_id'], + on_change: ['refetch'], + }, +} satisfies TQoreOptions; + +export const contentfulBaseOptions = { + ...contentfulSpaceOption, + ...contentfulEnvironmentOption, +} satisfies TQoreOptions; + +export const contentfulBaseWithContentTypeOptions = { + ...contentfulBaseOptions, + ...contentfulContentTypeOption, +} satisfies TQoreOptions; diff --git a/ts/src/apps/contentful/index.ts b/ts/src/apps/contentful/index.ts new file mode 100644 index 00000000..b6b74a96 --- /dev/null +++ b/ts/src/apps/contentful/index.ts @@ -0,0 +1,35 @@ +import { TQoreAppWithActions } from '@qoretechnologies/ts-toolkit'; +import { mapActionsToApp, mapTriggersToApp } from '../../global/helpers/index'; +import L from '../../i18n/i18n-node'; +import { Locales } from '../../i18n/i18n-types'; +import { CONTENTFUL_APP_LOGO, CONTENTFUL_APP_NAME, CONTENTFUL_API_URL, CONTENTFUL_CONN_OPTIONS } from './constants'; + +import * as CONTENTFUL_ACTIONS from './actions'; +import * as CONTENTFUL_TRIGGERS from './triggers'; + +export default (locale: Locales) => + ({ + name: CONTENTFUL_APP_NAME, + display_name: L[locale].apps[CONTENTFUL_APP_NAME].displayName(), + short_desc: L[locale].apps[CONTENTFUL_APP_NAME].shortDesc(), + desc: L[locale].apps[CONTENTFUL_APP_NAME].longDesc(), + actions: [ + ...mapActionsToApp(CONTENTFUL_APP_NAME, CONTENTFUL_ACTIONS, locale), + ...mapTriggersToApp(CONTENTFUL_APP_NAME, CONTENTFUL_TRIGGERS, locale), + ], + logo: CONTENTFUL_APP_LOGO, + logo_file_name: 'contentful-logo.svg', + logo_mime_type: 'image/svg+xml', + rest: { + url: CONTENTFUL_API_URL, + data: 'json', + oauth2_grant_type: 'none', + ping_method: 'GET', + ping_path: '/spaces', + token_type: 'Bearer', + }, + rest_modifiers: { + options: CONTENTFUL_CONN_OPTIONS, + required_options: 'token', + }, + }) satisfies TQoreAppWithActions; diff --git a/ts/src/apps/contentful/response-types/asset.ts b/ts/src/apps/contentful/response-types/asset.ts new file mode 100644 index 00000000..34f5aae9 --- /dev/null +++ b/ts/src/apps/contentful/response-types/asset.ts @@ -0,0 +1,22 @@ +import { TQoreResponseType } from '@qoretechnologies/ts-toolkit'; + +export const ContentfulAssetResponseType = { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Asset ID' }, + created_at: { type: 'date', short_desc: 'Creation timestamp' }, + updated_at: { type: 'date', short_desc: 'Last update timestamp' }, + version: { type: 'int', short_desc: 'Current version number' }, + title: { type: 'string', short_desc: 'Asset title' }, + description: { type: 'string', short_desc: 'Asset description' }, + file_name: { type: 'string', short_desc: 'File name' }, + content_type: { type: 'string', short_desc: 'MIME type' }, + url: { type: 'string', short_desc: 'File URL' }, + size: { type: 'int', short_desc: 'File size in bytes' }, + }, +} satisfies TQoreResponseType; + +export const ContentfulAssetListResponseType = { + type: 'list', + element_type: ContentfulAssetResponseType, +} satisfies TQoreResponseType; diff --git a/ts/src/apps/contentful/response-types/content-type.ts b/ts/src/apps/contentful/response-types/content-type.ts new file mode 100644 index 00000000..1b0fd0e6 --- /dev/null +++ b/ts/src/apps/contentful/response-types/content-type.ts @@ -0,0 +1,28 @@ +import { TQoreResponseType } from '@qoretechnologies/ts-toolkit'; + +export const ContentfulFieldResponseType = { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Field ID' }, + name: { type: 'string', short_desc: 'Field name' }, + type: { type: 'string', short_desc: 'Field type (Symbol, Text, Integer, Number, Date, Boolean, etc.)' }, + required: { type: 'bool', short_desc: 'Whether the field is required' }, + localized: { type: 'bool', short_desc: 'Whether the field supports localization' }, + }, +} satisfies TQoreResponseType; + +export const ContentfulContentTypeResponseType = { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Content type ID' }, + name: { type: 'string', short_desc: 'Content type name' }, + description: { type: 'string', short_desc: 'Content type description' }, + display_field: { type: 'string', short_desc: 'ID of the field used as display title' }, + fields: { type: { type: 'list', element_type: ContentfulFieldResponseType } }, + }, +} satisfies TQoreResponseType; + +export const ContentfulContentTypeListResponseType = { + type: 'list', + element_type: ContentfulContentTypeResponseType, +} satisfies TQoreResponseType; diff --git a/ts/src/apps/contentful/response-types/entry.ts b/ts/src/apps/contentful/response-types/entry.ts new file mode 100644 index 00000000..d8824d8f --- /dev/null +++ b/ts/src/apps/contentful/response-types/entry.ts @@ -0,0 +1,26 @@ +import { TQoreResponseType } from '@qoretechnologies/ts-toolkit'; + +export const ContentfulEntryResponseType = { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Entry ID' }, + content_type: { type: 'string', short_desc: 'Content type ID' }, + created_at: { type: 'date', short_desc: 'Creation timestamp' }, + updated_at: { type: 'date', short_desc: 'Last update timestamp' }, + version: { type: 'int', short_desc: 'Current version number' }, + }, +} satisfies TQoreResponseType; + +export const ContentfulEntryListResponseType = { + type: 'list', + element_type: ContentfulEntryResponseType, +} satisfies TQoreResponseType; + +export const ContentfulPublishResponseType = { + type: 'hash', + fields: { + id: { type: 'string', short_desc: 'Entry ID' }, + version: { type: 'int', short_desc: 'Published version number' }, + published_at: { type: 'date', short_desc: 'Publish timestamp' }, + }, +} satisfies TQoreResponseType; diff --git a/ts/src/apps/contentful/response-types/index.ts b/ts/src/apps/contentful/response-types/index.ts new file mode 100644 index 00000000..4d5f09e5 --- /dev/null +++ b/ts/src/apps/contentful/response-types/index.ts @@ -0,0 +1,3 @@ +export * from './entry'; +export * from './asset'; +export * from './content-type'; diff --git a/ts/src/apps/contentful/triggers/index.ts b/ts/src/apps/contentful/triggers/index.ts new file mode 100644 index 00000000..e89b8cc2 --- /dev/null +++ b/ts/src/apps/contentful/triggers/index.ts @@ -0,0 +1 @@ +export { default as watch_event } from './watch-event.trigger'; diff --git a/ts/src/apps/contentful/triggers/watch-event.trigger.ts b/ts/src/apps/contentful/triggers/watch-event.trigger.ts new file mode 100644 index 00000000..8e3bbbd2 --- /dev/null +++ b/ts/src/apps/contentful/triggers/watch-event.trigger.ts @@ -0,0 +1,151 @@ +import { EQoreAppActionCode, QoreAppCreator, QorusRequest, TQoreOptions } from '@qoretechnologies/ts-toolkit'; +import { getQoreContextRequiredValues } from '../../../global/helpers'; +import { CONTENTFUL_APP_NAME, CONTENTFUL_API_URL, ContentfulError } from '../constants'; +import { contentfulBaseOptions } from '../helpers/shared-options'; + +const action = 'watch_event'; + +const EVENT_TYPE_ALLOWED_VALUES = [ + { value: 'Entry.create', display_name: 'Entry Created' }, + { value: 'Entry.save', display_name: 'Entry Saved' }, + { value: 'Entry.auto_save', display_name: 'Entry Auto-Saved' }, + { value: 'Entry.archive', display_name: 'Entry Archived' }, + { value: 'Entry.unarchive', display_name: 'Entry Unarchived' }, + { value: 'Entry.publish', display_name: 'Entry Published' }, + { value: 'Entry.unpublish', display_name: 'Entry Unpublished' }, + { value: 'Entry.delete', display_name: 'Entry Deleted' }, + { value: 'Asset.create', display_name: 'Asset Created' }, + { value: 'Asset.save', display_name: 'Asset Saved' }, + { value: 'Asset.auto_save', display_name: 'Asset Auto-Saved' }, + { value: 'Asset.archive', display_name: 'Asset Archived' }, + { value: 'Asset.unarchive', display_name: 'Asset Unarchived' }, + { value: 'Asset.publish', display_name: 'Asset Published' }, + { value: 'Asset.unpublish', display_name: 'Asset Unpublished' }, + { value: 'Asset.delete', display_name: 'Asset Deleted' }, + { value: 'ContentType.create', display_name: 'Content Type Created' }, + { value: 'ContentType.save', display_name: 'Content Type Saved' }, + { value: 'ContentType.publish', display_name: 'Content Type Published' }, + { value: 'ContentType.unpublish', display_name: 'Content Type Unpublished' }, + { value: 'ContentType.delete', display_name: 'Content Type Deleted' }, +]; + +const options = { + ...contentfulBaseOptions, + event_types: { + type: { type: 'list', element_type: 'string' }, + required: true, + element_allowed_values: EVENT_TYPE_ALLOWED_VALUES, + }, +} satisfies TQoreOptions; + +const WatchEvent = QoreAppCreator.createLocalizedTrigger({ + app: CONTENTFUL_APP_NAME, + action, + action_code: EQoreAppActionCode.EVENT, + options, + webhook_method: 'POST', + + webhook_register: async (context, url) => { + const { token, space_id } = getQoreContextRequiredValues({ + context, + connectionFields: ['token'], + optionFields: ['space_id'], + ErrorClass: ContentfulError, + }); + + const eventTypes = (context.opts?.event_types as string[]) || ['Entry.create']; + + try { + const response = await QorusRequest.post<{ data: { sys: { id: string } } }>( + { + headers: { + Authorization: `Bearer ${token}`, + 'Content-Type': 'application/json', + }, + data: { + name: `Qore Webhook - ${eventTypes.join(', ')}`, + url, + topics: eventTypes.map((t) => `${t}.*`), + filters: [], + }, + path: `/spaces/${space_id}/webhook_definitions`, + }, + { url: CONTENTFUL_API_URL, endpointId: CONTENTFUL_APP_NAME } + ); + + const webhookId = response?.data?.sys?.id; + if (!webhookId) { + throw new Error('No webhook ID returned'); + } + + return { webhook: { id: webhookId } }; + } catch (error) { + throw new ContentfulError(`Failed to register webhook: ${error}`); + } + }, + + webhook_deregister: async (context, _url, regInfo: { webhook: { id: string } }) => { + const { token, space_id } = getQoreContextRequiredValues({ + context, + connectionFields: ['token'], + optionFields: ['space_id'], + ErrorClass: ContentfulError, + }); + + const webhookId = regInfo?.webhook?.id; + if (!webhookId) { + throw new ContentfulError('Invalid webhook information for deregistration'); + } + + try { + await QorusRequest.deleteReq( + { + headers: { + Authorization: `Bearer ${token}`, + }, + path: `/spaces/${space_id}/webhook_definitions/${webhookId}`, + }, + { url: CONTENTFUL_API_URL, endpointId: CONTENTFUL_APP_NAME } + ); + } catch (error) { + throw new ContentfulError(`Failed to deregister webhook: ${error}`); + } + }, + + get_example_event_data: async () => { + return { + sys: { + type: 'Entry', + id: 'example-entry-id', + space: { sys: { id: 'example-space-id' } }, + environment: { sys: { id: 'master' } }, + contentType: { sys: { id: 'blogPost' } }, + createdAt: '2026-01-01T00:00:00.000Z', + updatedAt: '2026-01-01T00:00:00.000Z', + }, + fields: { + title: { 'en-US': 'Example Entry' }, + body: { 'en-US': 'This is an example entry body.' }, + }, + }; + }, + + event_info: { + desc: 'Contentful Webhook Event Info', + type: { + type: 'hash', + fields: { + sys: { + type: 'hash', + short_desc: 'System metadata of the affected resource', + }, + fields: { + type: 'hash', + short_desc: 'Resource fields (locale-wrapped)', + }, + }, + }, + }, +}); + +export default WatchEvent; diff --git a/ts/src/apps/notion/helpers/get-discussion-allowed-values.ts b/ts/src/apps/notion/helpers/get-discussion-allowed-values.ts index ad64f3ab..1625d647 100644 --- a/ts/src/apps/notion/helpers/get-discussion-allowed-values.ts +++ b/ts/src/apps/notion/helpers/get-discussion-allowed-values.ts @@ -23,6 +23,9 @@ export const getNotionDiscussionsAllowedValues: TQoreGetAllowedValuesFunction< const notion = createNotionClient(token); const allDiscussions: IQoreAllowedValue[] = []; + const TIMEOUT_MS = 10_000; + const startTime = Date.now(); + const pagesResponse = await notion.search({ filter: { property: 'object', @@ -36,6 +39,11 @@ export const getNotionDiscussionsAllowedValues: TQoreGetAllowedValuesFunction< }); for (const page of pagesResponse.results as PageObjectResponse[]) { + if (allDiscussions.length > 0 && Date.now() - startTime >= TIMEOUT_MS) { + Debugger.log('Discussion fetch timed out after 10s, returning partial results'); + break; + } + try { const commentsResponse = await notion.comments.list({ block_id: page.id, diff --git a/ts/src/i18n/en/apps/Contentful/index.ts b/ts/src/i18n/en/apps/Contentful/index.ts new file mode 100644 index 00000000..0266fc71 --- /dev/null +++ b/ts/src/i18n/en/apps/Contentful/index.ts @@ -0,0 +1,1012 @@ +const ContentfulAppEn = { + displayName: 'Contentful', + groups: ['Documents & Documentation'], + shortDesc: 'Connect to Contentful to manage your content, assets, and content models', + longDesc: + 'Integrate with Contentful to automate content management workflows. Create, update, publish, and manage entries, assets, and content types. Monitor content changes with real-time webhook triggers. This integration provides full access to the Contentful Content Management API for comprehensive headless CMS automation.', + connectionMessage: { + title: 'Connect to Contentful', + content: `To connect to Contentful, you will need a **Content Management API (CMA) Token**. + +## Getting Your CMA Token + +1. Log in to your [Contentful](https://app.contentful.com) account +2. Go to **Settings** (gear icon in the top navigation) +3. Select **CMA tokens** from the left sidebar +4. Click **Create personal access token** +5. Give your token a descriptive name (e.g., "Qore Integration") +6. Click **Generate** and copy the generated token + +**Important:** The token is only shown once. Make sure to copy and save it securely. + +## Authorizing Your Token for an Organization + +If your Contentful account belongs to an organization, you must **authorize your token** for that organization before it can access spaces: + +1. Go to your [Personal Access Tokens](https://app.contentful.com/account/profile/cma_tokens) page +2. Find your token in the list +3. Click **Authorize** next to the organization you want the token to access + +Without this step, API requests will fail with an \`OrganizationAccessGrantRequired\` error, even though the token is valid. + +## Permissions + +The CMA token inherits the permissions of the user who created it. Ensure the user has appropriate access to the spaces and environments you want to manage.`, + }, + actions: { + // Entry actions + get_entry: { + displayName: 'Get an Entry', + shortDesc: 'Returns attributes of a specific entry', + longDesc: + 'Retrieves a single entry by its ID from the specified space and environment. Returns all entry fields with their values in the default locale.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the entry.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type of the entry', + longDesc: 'Select the content type to filter entries by type.', + }, + entry_id: { + displayName: 'Entry', + shortDesc: 'The entry to retrieve', + longDesc: 'Select or enter the ID of the entry to retrieve.', + }, + }, + }, + get_entry_with_replacement: { + displayName: 'Get an Entry with Replacement', + shortDesc: 'Replaces text fields with new values using specific tags; returns new values as output', + longDesc: + 'Retrieves an entry and performs text replacements on all string fields. For each replacement pair, all occurrences of the tag are replaced with the specified value. Useful for template-based content.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the entry.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type of the entry', + longDesc: 'Select the content type to filter entries by type.', + }, + entry_id: { + displayName: 'Entry', + shortDesc: 'The entry to retrieve and apply replacements to', + longDesc: 'Select or enter the ID of the entry to retrieve.', + }, + replacements: { + displayName: 'Replacements', + shortDesc: 'List of tag/value pairs for text replacement', + longDesc: + 'Provide a list of replacement pairs. Each pair has a "tag" (placeholder to find) and a "value" (text to replace it with). All string fields in the entry will be processed.', + type: { + element_type: { + fields: { + tag: { + displayName: 'Tag', + shortDesc: 'The tag/placeholder to search for in text fields', + longDesc: 'The tag or placeholder text to search for within all string fields of the entry.', + }, + value: { + displayName: 'Value', + shortDesc: 'The replacement value', + longDesc: 'The text that will replace all occurrences of the tag.', + }, + }, + }, + }, + }, + }, + }, + create_entry: { + displayName: 'Create an Entry', + shortDesc: 'Creates a new entry', + longDesc: + 'Creates a new entry of the specified content type in the given space and environment. Optionally publishes the entry immediately after creation.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space where the entry will be created.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type for the new entry', + longDesc: 'Select the content type that defines the schema for the new entry.', + }, + fields: { + displayName: 'Fields', + shortDesc: 'The field values for the new entry', + longDesc: + 'Provide the field values as a key-value object. Keys should match the field IDs of the content type.', + }, + publish: { + displayName: 'Publish', + shortDesc: 'Whether to publish the entry after creation', + longDesc: + 'If enabled, the entry will be published immediately after creation. Otherwise, it will be saved as a draft.', + }, + }, + }, + update_entry: { + displayName: 'Update an Entry', + shortDesc: 'Updates a specific entry by its ID', + longDesc: + 'Updates an existing entry with new field values. Only the specified fields are updated; other fields remain unchanged.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the entry.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type of the entry', + longDesc: 'Select the content type to filter entries by type.', + }, + entry_id: { + displayName: 'Entry', + shortDesc: 'The entry to update', + longDesc: 'Select or enter the ID of the entry to update.', + }, + fields: { + displayName: 'Fields', + shortDesc: 'The field values to update', + longDesc: + 'Provide the field values to update as a key-value object. Only the specified fields will be changed.', + }, + }, + }, + delete_entry: { + displayName: 'Delete an Entry', + shortDesc: 'Permanently removes a specific entry', + longDesc: + 'Permanently deletes an entry from the space. If the entry is published, it will be unpublished first. This action is irreversible.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the entry.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type of the entry', + longDesc: 'Select the content type to filter entries by type.', + }, + entry_id: { + displayName: 'Entry', + shortDesc: 'The entry to delete', + longDesc: 'Select or enter the ID of the entry to permanently remove.', + }, + }, + }, + publish_entry: { + displayName: 'Publish an Entry', + shortDesc: 'Changes entry status to "published"', + longDesc: + 'Publishes a draft entry, making it available through the Content Delivery API.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the entry.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to filter entries', + longDesc: 'Select the content type to filter the entry dropdown.', + }, + entry_id: { + displayName: 'Entry', + shortDesc: 'The entry to publish', + longDesc: 'Select or enter the ID of the entry to publish.', + }, + }, + }, + unpublish_entry: { + displayName: 'Unpublish an Entry', + shortDesc: 'Puts an entry back into "draft" state', + longDesc: + 'Unpublishes an entry, removing it from the Content Delivery API and reverting it to draft state.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the entry.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to filter entries', + longDesc: 'Select the content type to filter the entry dropdown.', + }, + entry_id: { + displayName: 'Entry', + shortDesc: 'The entry to unpublish', + longDesc: 'Select or enter the ID of the entry to unpublish.', + }, + }, + }, + archive_entry: { + displayName: 'Archive/Unarchive an Entry', + shortDesc: 'Archives/Unarchives an unpublished entry', + longDesc: + 'Archives or unarchives an entry. The entry must be unpublished before it can be archived. Archived entries are hidden from the default entry list.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the entry.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to filter entries', + longDesc: 'Select the content type to filter the entry dropdown.', + }, + entry_id: { + displayName: 'Entry', + shortDesc: 'The entry to archive or unarchive', + longDesc: 'Select or enter the ID of the entry.', + }, + archive: { + displayName: 'Archive', + shortDesc: 'Set to true to archive, false to unarchive', + longDesc: + 'When enabled, the entry will be archived. When disabled, the entry will be unarchived.', + }, + }, + }, + search_entries: { + displayName: 'Search Entries', + shortDesc: 'Searches for entries', + longDesc: + 'Searches for entries of a specific content type with optional full-text search. Returns a paginated list of entries.', + groups: ['Entries'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to search', + longDesc: 'Select the Contentful space to search in.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to search', + longDesc: 'Select the content type to filter results by.', + }, + query: { + displayName: 'Search Query', + shortDesc: 'Full-text search query', + longDesc: 'Optional text to search across all text fields of the entries.', + }, + limit: { + displayName: 'Limit', + shortDesc: 'Maximum number of entries to return', + longDesc: 'The maximum number of entries to return. Default is 100, maximum is 1000.', + }, + skip: { + displayName: 'Skip', + shortDesc: 'Number of entries to skip', + longDesc: 'The number of entries to skip for pagination. Default is 0.', + }, + }, + }, + + // Asset actions + get_asset: { + displayName: 'Get an Asset', + shortDesc: 'Returns attributes of a specific asset', + longDesc: + 'Retrieves a single asset by its ID, returning metadata including title, description, file URL, MIME type, and size.', + groups: ['Assets'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the asset.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + asset_id: { + displayName: 'Asset', + shortDesc: 'The asset to retrieve', + longDesc: 'Select or enter the ID of the asset to retrieve.', + }, + }, + }, + create_asset: { + displayName: 'Create an Asset', + shortDesc: 'Creates a new asset', + longDesc: + 'Creates a new asset from a URL. The asset will be processed (downloaded and stored) automatically. Optionally publishes the asset after creation.', + groups: ['Assets'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space where the asset will be created.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + title: { + displayName: 'Title', + shortDesc: 'The asset title', + longDesc: 'A descriptive title for the asset.', + }, + description: { + displayName: 'Description', + shortDesc: 'The asset description', + longDesc: 'An optional description for the asset.', + }, + file_name: { + displayName: 'File Name', + shortDesc: 'The file name for the asset', + longDesc: 'The file name including extension (e.g., "photo.jpg").', + }, + file_url: { + displayName: 'File URL', + shortDesc: 'The URL of the file to upload', + longDesc: 'The publicly accessible URL from which Contentful will download the file.', + }, + content_type: { + displayName: 'Content Type', + shortDesc: 'The MIME type of the file', + longDesc: 'The MIME type of the file (e.g., "image/jpeg", "application/pdf").', + }, + publish: { + displayName: 'Publish', + shortDesc: 'Whether to publish the asset after creation', + longDesc: + 'If enabled, the asset will be published immediately after processing.', + }, + }, + }, + update_asset: { + displayName: 'Update an Asset', + shortDesc: 'Updates an asset by its ID', + longDesc: 'Updates the title and/or description of an existing asset.', + groups: ['Assets'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the asset.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + asset_id: { + displayName: 'Asset', + shortDesc: 'The asset to update', + longDesc: 'Select or enter the ID of the asset to update.', + }, + title: { + displayName: 'Title', + shortDesc: 'New title for the asset', + longDesc: 'The updated title for the asset.', + }, + description: { + displayName: 'Description', + shortDesc: 'New description for the asset', + longDesc: 'The updated description for the asset.', + }, + }, + }, + delete_asset: { + displayName: 'Delete an Asset', + shortDesc: 'Permanently removes an unpublished asset', + longDesc: + 'Permanently deletes an asset. If the asset is published, it will be unpublished first. This action is irreversible.', + groups: ['Assets'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the asset.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + asset_id: { + displayName: 'Asset', + shortDesc: 'The asset to delete', + longDesc: 'Select or enter the ID of the asset to permanently remove.', + }, + }, + }, + publish_asset: { + displayName: 'Publish an Asset', + shortDesc: 'Changes asset status to "published"', + longDesc: 'Publishes a draft asset, making it available through the Content Delivery API.', + groups: ['Assets'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the asset.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + asset_id: { + displayName: 'Asset', + shortDesc: 'The asset to publish', + longDesc: 'Select or enter the ID of the asset to publish.', + }, + }, + }, + unpublish_asset: { + displayName: 'Unpublish an Asset', + shortDesc: 'Puts an asset back into "draft" state', + longDesc: + 'Unpublishes an asset, removing it from the Content Delivery API and reverting it to draft state.', + groups: ['Assets'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the asset.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + asset_id: { + displayName: 'Asset', + shortDesc: 'The asset to unpublish', + longDesc: 'Select or enter the ID of the asset to unpublish.', + }, + }, + }, + archive_asset: { + displayName: 'Archive/Unarchive an Asset', + shortDesc: 'Archives/Unarchives an unpublished asset', + longDesc: + 'Archives or unarchives an asset. The asset must be unpublished before it can be archived.', + groups: ['Assets'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the asset.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + asset_id: { + displayName: 'Asset', + shortDesc: 'The asset to archive or unarchive', + longDesc: 'Select or enter the ID of the asset.', + }, + archive: { + displayName: 'Archive', + shortDesc: 'Set to true to archive, false to unarchive', + longDesc: + 'When enabled, the asset will be archived. When disabled, the asset will be unarchived.', + }, + }, + }, + search_assets: { + displayName: 'Search Assets', + shortDesc: 'Searches for assets', + longDesc: + 'Searches for assets with optional full-text search and MIME type filtering. Returns a paginated list of assets.', + groups: ['Assets'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to search', + longDesc: 'Select the Contentful space to search in.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + query: { + displayName: 'Search Query', + shortDesc: 'Full-text search query', + longDesc: 'Optional text to search across asset titles and descriptions.', + }, + mime_type_group: { + displayName: 'MIME Type Group', + shortDesc: 'Filter by file type group', + longDesc: + 'Optionally filter assets by MIME type group (e.g., image, video, audio, pdfdocument).', + }, + limit: { + displayName: 'Limit', + shortDesc: 'Maximum number of assets to return', + longDesc: 'The maximum number of assets to return. Default is 100, maximum is 1000.', + }, + skip: { + displayName: 'Skip', + shortDesc: 'Number of assets to skip', + longDesc: 'The number of assets to skip for pagination. Default is 0.', + }, + }, + }, + + // Content Type actions + get_content_type: { + displayName: 'Get a Content Type', + shortDesc: 'Returns attributes of a specific content type', + longDesc: + 'Retrieves a content type by its ID, including its name, description, and field definitions.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the content type.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to retrieve', + longDesc: 'Select the content type to retrieve details for.', + }, + }, + }, + create_content_type: { + displayName: 'Create a Content Type', + shortDesc: 'Creates a new content type', + longDesc: + 'Creates a new content type with the specified name, description, and field definitions. The content type will be created in draft state.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space where the content type will be created.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + name: { + displayName: 'Name', + shortDesc: 'The content type name', + longDesc: 'A descriptive name for the content type (e.g., "Blog Post", "Product").', + }, + description: { + displayName: 'Description', + shortDesc: 'The content type description', + longDesc: 'An optional description explaining the purpose of this content type.', + }, + fields: { + displayName: 'Fields', + shortDesc: 'The field definitions for the content type', + longDesc: + 'A list of field definitions. Each field requires an ID, name, and type. Supported types: Symbol, Text, Integer, Number, Date, Boolean, RichText, Link, Array, Object, Location.', + type: { + element_type: { + fields: { + id: { + displayName: 'Field ID', + shortDesc: 'Unique identifier for the field', + longDesc: 'A unique ID for the field (e.g., "heroImage", "publishDate"). Must be unique within the content type.', + }, + name: { + displayName: 'Field Name', + shortDesc: 'Display name for the field', + longDesc: 'A human-readable name for the field (e.g., "Hero Image", "Publish Date").', + }, + type: { + displayName: 'Field Type', + shortDesc: 'Data type (Symbol, Text, Integer, Number, Date, Boolean, RichText, Link, Array, Object, Location)', + longDesc: 'The data type for the field. Supported types: Symbol (short text), Text (long text), Integer, Number, Date, Boolean, RichText, Link, Array, Object, Location.', + }, + required: { + displayName: 'Required', + shortDesc: 'Whether the field is required', + longDesc: 'If enabled, entries must provide a value for this field.', + }, + localized: { + displayName: 'Localized', + shortDesc: 'Whether the field supports localization', + longDesc: 'If enabled, the field can have different values for different locales.', + }, + }, + }, + }, + }, + }, + }, + update_content_type: { + displayName: 'Update a Content Type', + shortDesc: 'Updates a specific content type by its ID', + longDesc: 'Updates the name and/or description of an existing content type.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the content type.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to update', + longDesc: 'Select the content type to update.', + }, + name: { + displayName: 'Name', + shortDesc: 'New name for the content type', + longDesc: 'The updated name for the content type.', + }, + description: { + displayName: 'Description', + shortDesc: 'New description for the content type', + longDesc: 'The updated description for the content type.', + }, + }, + }, + delete_content_type: { + displayName: 'Delete a Content Type', + shortDesc: 'Permanently removes a deactivated content type', + longDesc: + 'Permanently deletes a content type. The content type must be deactivated (unpublished) first. This action is irreversible.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the content type.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to delete', + longDesc: 'Select the content type to permanently remove.', + }, + }, + }, + activate_content_type: { + displayName: 'Activate a Content Type', + shortDesc: 'Activates a content type by its ID', + longDesc: + 'Publishes (activates) a content type, making it available for creating entries.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the content type.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to activate', + longDesc: 'Select the content type to activate (publish).', + }, + }, + }, + deactivate_content_type: { + displayName: 'Deactivate a Content Type', + shortDesc: 'Changes a content type status to "draft"', + longDesc: + 'Unpublishes (deactivates) a content type, reverting it to draft state. No new entries can be created for a deactivated content type.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the content type.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to deactivate', + longDesc: 'Select the content type to deactivate (unpublish).', + }, + }, + }, + add_field_to_content_type: { + displayName: 'Add a Field to a Content Type', + shortDesc: 'Adds a new field to a specific content type', + longDesc: + 'Adds a new field definition to an existing content type. The content type will need to be re-activated after adding the field.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the content type.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type to add the field to', + longDesc: 'Select the content type to modify.', + }, + field_id: { + displayName: 'Field ID', + shortDesc: 'Unique identifier for the new field', + longDesc: + 'A unique ID for the field (e.g., "heroImage", "publishDate"). Must be unique within the content type.', + }, + field_name: { + displayName: 'Field Name', + shortDesc: 'Display name for the new field', + longDesc: 'A human-readable name for the field (e.g., "Hero Image", "Publish Date").', + }, + field_type: { + displayName: 'Field Type', + shortDesc: 'The data type for the field', + longDesc: + 'Select the data type: Symbol (short text), Text (long text), Integer, Number, Date, Boolean, RichText, Link, Array, Object, or Location.', + }, + required: { + displayName: 'Required', + shortDesc: 'Whether the field is required', + longDesc: 'If enabled, entries must provide a value for this field.', + }, + localized: { + displayName: 'Localized', + shortDesc: 'Whether the field supports localization', + longDesc: 'If enabled, the field can have different values for different locales.', + }, + }, + }, + update_field_of_content_type: { + displayName: 'Update a Field of a Content Type', + shortDesc: 'Updates a field inside a specific content type', + longDesc: 'Updates the properties of an existing field in a content type.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the content type.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type containing the field', + longDesc: 'Select the content type to modify.', + }, + field_id: { + displayName: 'Field', + shortDesc: 'The field to update', + longDesc: 'Select the field to update.', + }, + field_name: { + displayName: 'Field Name', + shortDesc: 'New display name for the field', + longDesc: 'The updated display name for the field.', + }, + required: { + displayName: 'Required', + shortDesc: 'Whether the field is required', + longDesc: 'Update whether entries must provide a value for this field.', + }, + localized: { + displayName: 'Localized', + shortDesc: 'Whether the field supports localization', + longDesc: 'Update whether the field can have different values for different locales.', + }, + }, + }, + delete_field_from_content_type: { + displayName: 'Delete a Field from a Content Type', + shortDesc: 'Removes a field from a specific content type', + longDesc: + 'Removes a field from a content type. The field is first marked as omitted, then removed entirely. Existing entry data for this field will be lost.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to use', + longDesc: 'Select the Contentful space containing the content type.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + content_type_id: { + displayName: 'Content Type', + shortDesc: 'The content type containing the field', + longDesc: 'Select the content type to modify.', + }, + field_id: { + displayName: 'Field', + shortDesc: 'The field to remove', + longDesc: 'Select the field to permanently remove from the content type.', + }, + }, + }, + search_content_types: { + displayName: 'Search Content Types', + shortDesc: 'Searches for content types', + longDesc: + 'Searches for content types with optional text filtering. Returns a paginated list of content types with their field definitions.', + groups: ['Content Types'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to search', + longDesc: 'Select the Contentful space to search in.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + query: { + displayName: 'Search Query', + shortDesc: 'Text search query', + longDesc: 'Optional text to search across content type names and descriptions.', + }, + limit: { + displayName: 'Limit', + shortDesc: 'Maximum number of results to return', + longDesc: 'The maximum number of content types to return. Default is 100.', + }, + skip: { + displayName: 'Skip', + shortDesc: 'Number of results to skip', + longDesc: 'The number of content types to skip for pagination. Default is 0.', + }, + }, + }, + }, + triggers: { + watch_event: { + displayName: 'Watch an Event', + shortDesc: 'Triggers when a new event occurs', + longDesc: + 'Creates a webhook in Contentful that triggers when selected events occur. Supports entry, asset, and content type events such as creation, updates, publishing, and deletion.', + groups: ['Events'], + options: { + space_id: { + displayName: 'Space', + shortDesc: 'The Contentful space to monitor', + longDesc: 'Select the Contentful space to monitor for events.', + }, + environment_id: { + displayName: 'Environment', + shortDesc: 'The environment to use (default: master)', + longDesc: + 'Select the environment within the space. Defaults to "master" if not specified.', + }, + event_types: { + displayName: 'Event Types', + shortDesc: 'The types of events to watch for', + longDesc: + 'Select one or more event types to trigger on. Events include entry, asset, and content type lifecycle events.', + }, + }, + }, + }, +}; + +export default ContentfulAppEn; diff --git a/ts/src/i18n/en/index.ts b/ts/src/i18n/en/index.ts index e15fcb94..73b58089 100644 --- a/ts/src/i18n/en/index.ts +++ b/ts/src/i18n/en/index.ts @@ -25,6 +25,7 @@ import Canva from './apps/Canva'; import Claude from './apps/Claude'; import ClickUp from './apps/ClickUp'; import Confluence from './apps/Confluence'; +import Contentful from './apps/Contentful'; import CopperCrm from './apps/CopperCrm'; import Craft from './apps/Craft'; import DocusignESignature from './apps/DocusignESignature'; @@ -181,6 +182,7 @@ const en = { Shopify, Zoom, Confluence, + Contentful, Bitbucket, FacebookPages, Paddle, diff --git a/ts/src/i18n/i18n-types.ts b/ts/src/i18n/i18n-types.ts index 2798973f..442432a0 100644 --- a/ts/src/i18n/i18n-types.ts +++ b/ts/src/i18n/i18n-types.ts @@ -106374,4430 +106374,3709 @@ type RootTranslation = { } } } - Bitbucket: { + Contentful: { /** - * B​i​t​b​u​c​k​e​t + * C​o​n​t​e​n​t​f​u​l */ displayName: string groups: { /** - * V​e​r​s​i​o​n​ ​C​o​n​t​r​o​l​ ​&​ ​C​o​d​e​ ​R​e​p​o​s​i​t​o​r​i​e​s + * D​o​c​u​m​e​n​t​s​ ​&​ ​D​o​c​u​m​e​n​t​a​t​i​o​n */ '0': string } /** - * B​i​t​b​u​c​k​e​t​ ​i​s​ ​a​ ​G​i​t​ ​r​e​p​o​s​i​t​o​r​y​ ​m​a​n​a​g​e​m​e​n​t​ ​s​o​l​u​t​i​o​n​ ​d​e​s​i​g​n​e​d​ ​f​o​r​ ​p​r​o​f​e​s​s​i​o​n​a​l​ ​t​e​a​m​s​. + * C​o​n​n​e​c​t​ ​t​o​ ​C​o​n​t​e​n​t​f​u​l​ ​t​o​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​c​o​n​t​e​n​t​,​ ​a​s​s​e​t​s​,​ ​a​n​d​ ​c​o​n​t​e​n​t​ ​m​o​d​e​l​s */ shortDesc: string /** - * B​i​t​b​u​c​k​e​t​ ​i​s​ ​a​ ​G​i​t​ ​r​e​p​o​s​i​t​o​r​y​ ​m​a​n​a​g​e​m​e​n​t​ ​s​o​l​u​t​i​o​n​ ​d​e​s​i​g​n​e​d​ ​f​o​r​ ​p​r​o​f​e​s​s​i​o​n​a​l​ ​t​e​a​m​s​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​f​e​a​t​u​r​e​s​ ​s​u​c​h​ ​a​s​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​,​ ​c​o​d​e​ ​r​e​v​i​e​w​s​,​ ​a​n​d​ ​c​o​n​t​i​n​u​o​u​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​t​o​ ​h​e​l​p​ ​t​e​a​m​s​ ​c​o​l​l​a​b​o​r​a​t​e​ ​o​n​ ​c​o​d​e​ ​e​f​f​e​c​t​i​v​e​l​y​. + * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​C​o​n​t​e​n​t​f​u​l​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​c​o​n​t​e​n​t​ ​m​a​n​a​g​e​m​e​n​t​ ​w​o​r​k​f​l​o​w​s​.​ ​C​r​e​a​t​e​,​ ​u​p​d​a​t​e​,​ ​p​u​b​l​i​s​h​,​ ​a​n​d​ ​m​a​n​a​g​e​ ​e​n​t​r​i​e​s​,​ ​a​s​s​e​t​s​,​ ​a​n​d​ ​c​o​n​t​e​n​t​ ​t​y​p​e​s​.​ ​M​o​n​i​t​o​r​ ​c​o​n​t​e​n​t​ ​c​h​a​n​g​e​s​ ​w​i​t​h​ ​r​e​a​l​-​t​i​m​e​ ​w​e​b​h​o​o​k​ ​t​r​i​g​g​e​r​s​.​ ​T​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​p​r​o​v​i​d​e​s​ ​f​u​l​l​ ​a​c​c​e​s​s​ ​t​o​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​C​o​n​t​e​n​t​ ​M​a​n​a​g​e​m​e​n​t​ ​A​P​I​ ​f​o​r​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​h​e​a​d​l​e​s​s​ ​C​M​S​ ​a​u​t​o​m​a​t​i​o​n​. */ longDesc: string - triggers: { - new_commit: { + connectionMessage: { + /** + * C​o​n​n​e​c​t​ ​t​o​ ​C​o​n​t​e​n​t​f​u​l + */ + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​C​o​n​t​e​n​t​f​u​l​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​a​ ​*​*​C​o​n​t​e​n​t​ ​M​a​n​a​g​e​m​e​n​t​ ​A​P​I​ ​(​C​M​A​)​ ​T​o​k​e​n​*​*​.​ + ​ + ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​C​M​A​ ​T​o​k​e​n​ + ​ + ​1​.​ ​L​o​g​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​C​o​n​t​e​n​t​f​u​l​]​(​h​t​t​p​s​:​/​/​a​p​p​.​c​o​n​t​e​n​t​f​u​l​.​c​o​m​)​ ​a​c​c​o​u​n​t​ + ​2​.​ ​G​o​ ​t​o​ ​*​*​S​e​t​t​i​n​g​s​*​*​ ​(​g​e​a​r​ ​i​c​o​n​ ​i​n​ ​t​h​e​ ​t​o​p​ ​n​a​v​i​g​a​t​i​o​n​)​ + ​3​.​ ​S​e​l​e​c​t​ ​*​*​C​M​A​ ​t​o​k​e​n​s​*​*​ ​f​r​o​m​ ​t​h​e​ ​l​e​f​t​ ​s​i​d​e​b​a​r​ + ​4​.​ ​C​l​i​c​k​ ​*​*​C​r​e​a​t​e​ ​p​e​r​s​o​n​a​l​ ​a​c​c​e​s​s​ ​t​o​k​e​n​*​*​ + ​5​.​ ​G​i​v​e​ ​y​o​u​r​ ​t​o​k​e​n​ ​a​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​(​e​.​g​.​,​ ​"​Q​o​r​e​ ​I​n​t​e​g​r​a​t​i​o​n​"​)​ + ​6​.​ ​C​l​i​c​k​ ​*​*​G​e​n​e​r​a​t​e​*​*​ ​a​n​d​ ​c​o​p​y​ ​t​h​e​ ​g​e​n​e​r​a​t​e​d​ ​t​o​k​e​n​ + ​ + ​*​*​I​m​p​o​r​t​a​n​t​:​*​*​ ​T​h​e​ ​t​o​k​e​n​ ​i​s​ ​o​n​l​y​ ​s​h​o​w​n​ ​o​n​c​e​.​ ​M​a​k​e​ ​s​u​r​e​ ​t​o​ ​c​o​p​y​ ​a​n​d​ ​s​a​v​e​ ​i​t​ ​s​e​c​u​r​e​l​y​.​ + ​ + ​#​#​ ​A​u​t​h​o​r​i​z​i​n​g​ ​Y​o​u​r​ ​T​o​k​e​n​ ​f​o​r​ ​a​n​ ​O​r​g​a​n​i​z​a​t​i​o​n​ + ​ + ​I​f​ ​y​o​u​r​ ​C​o​n​t​e​n​t​f​u​l​ ​a​c​c​o​u​n​t​ ​b​e​l​o​n​g​s​ ​t​o​ ​a​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​,​ ​y​o​u​ ​m​u​s​t​ ​*​*​a​u​t​h​o​r​i​z​e​ ​y​o​u​r​ ​t​o​k​e​n​*​*​ ​f​o​r​ ​t​h​a​t​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​b​e​f​o​r​e​ ​i​t​ ​c​a​n​ ​a​c​c​e​s​s​ ​s​p​a​c​e​s​:​ + ​ + ​1​.​ ​G​o​ ​t​o​ ​y​o​u​r​ ​[​P​e​r​s​o​n​a​l​ ​A​c​c​e​s​s​ ​T​o​k​e​n​s​]​(​h​t​t​p​s​:​/​/​a​p​p​.​c​o​n​t​e​n​t​f​u​l​.​c​o​m​/​a​c​c​o​u​n​t​/​p​r​o​f​i​l​e​/​c​m​a​_​t​o​k​e​n​s​)​ ​p​a​g​e​ + ​2​.​ ​F​i​n​d​ ​y​o​u​r​ ​t​o​k​e​n​ ​i​n​ ​t​h​e​ ​l​i​s​t​ + ​3​.​ ​C​l​i​c​k​ ​*​*​A​u​t​h​o​r​i​z​e​*​*​ ​n​e​x​t​ ​t​o​ ​t​h​e​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​h​e​ ​t​o​k​e​n​ ​t​o​ ​a​c​c​e​s​s​ + ​ + ​W​i​t​h​o​u​t​ ​t​h​i​s​ ​s​t​e​p​,​ ​A​P​I​ ​r​e​q​u​e​s​t​s​ ​w​i​l​l​ ​f​a​i​l​ ​w​i​t​h​ ​a​n​ ​`​O​r​g​a​n​i​z​a​t​i​o​n​A​c​c​e​s​s​G​r​a​n​t​R​e​q​u​i​r​e​d​`​ ​e​r​r​o​r​,​ ​e​v​e​n​ ​t​h​o​u​g​h​ ​t​h​e​ ​t​o​k​e​n​ ​i​s​ ​v​a​l​i​d​.​ + ​ + ​#​#​ ​P​e​r​m​i​s​s​i​o​n​s​ + ​ + ​T​h​e​ ​C​M​A​ ​t​o​k​e​n​ ​i​n​h​e​r​i​t​s​ ​t​h​e​ ​p​e​r​m​i​s​s​i​o​n​s​ ​o​f​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​c​r​e​a​t​e​d​ ​i​t​.​ ​E​n​s​u​r​e​ ​t​h​e​ ​u​s​e​r​ ​h​a​s​ ​a​p​p​r​o​p​r​i​a​t​e​ ​a​c​c​e​s​s​ ​t​o​ ​t​h​e​ ​s​p​a​c​e​s​ ​a​n​d​ ​e​n​v​i​r​o​n​m​e​n​t​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​a​n​a​g​e​. + */ + content: string + } + actions: { + get_entry: { /** - * N​e​w​ ​C​o​m​m​i​t + * G​e​t​ ​a​n​ ​E​n​t​r​y */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​i​t​ ​i​s​ ​p​u​s​h​e​d​ ​t​o​ ​a​ ​r​e​p​o​s​i​t​o​r​y​. + * R​e​t​u​r​n​s​ ​a​t​t​r​i​b​u​t​e​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​e​n​t​r​y */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​a​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​i​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​c​o​m​m​i​t​s​ ​a​r​e​ ​p​u​s​h​e​d​ ​t​o​ ​a​n​y​ ​b​r​a​n​c​h​.​ ​P​r​o​v​i​d​e​s​ ​d​e​t​a​i​l​e​d​ ​c​o​m​m​i​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​a​u​t​h​o​r​,​ ​m​e​s​s​a​g​e​,​ ​h​a​s​h​,​ ​a​n​d​ ​r​e​p​o​s​i​t​o​r​y​ ​d​e​t​a​i​l​s​. + * R​e​t​r​i​e​v​e​s​ ​a​ ​s​i​n​g​l​e​ ​e​n​t​r​y​ ​b​y​ ​i​t​s​ ​I​D​ ​f​r​o​m​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​p​a​c​e​ ​a​n​d​ ​e​n​v​i​r​o​n​m​e​n​t​.​ ​R​e​t​u​r​n​s​ ​a​l​l​ ​e​n​t​r​y​ ​f​i​e​l​d​s​ ​w​i​t​h​ ​t​h​e​i​r​ ​v​a​l​u​e​s​ ​i​n​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​l​o​c​a​l​e​. */ longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } options: { - workspace: { + space_id: { /** - * W​o​r​k​s​p​a​c​e + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e​ ​(​o​r​g​a​n​i​z​a​t​i​o​n​ ​o​r​ ​u​s​e​r​ ​a​c​c​o​u​n​t​)​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​e​n​t​r​y​. */ longDesc: string } - repo_slug: { + environment_id: { /** - * R​e​p​o​s​i​t​o​r​y + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​s​l​u​g​ ​(​n​a​m​e​)​ ​o​f​ ​t​h​e​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​i​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - } - } - new_deployment: { - /** - * N​e​w​ ​D​e​p​l​o​y​m​e​n​t - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​p​l​o​y​m​e​n​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​f​o​r​ ​a​ ​r​e​p​o​s​i​t​o​r​y​. - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​a​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​f​o​r​ ​n​e​w​ ​d​e​p​l​o​y​m​e​n​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​d​e​p​l​o​y​m​e​n​t​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​o​r​ ​u​p​d​a​t​e​d​.​ ​P​r​o​v​i​d​e​s​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​d​e​p​l​o​y​m​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​e​n​v​i​r​o​n​m​e​n​t​,​ ​s​t​a​t​e​,​ ​c​o​m​m​i​t​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​d​e​p​l​o​y​m​e​n​t​ ​s​t​e​p​s​. - */ - longDesc: string - options: { - workspace: { + content_type_id: { /** - * W​o​r​k​s​p​a​c​e + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​o​f​ ​t​h​e​ ​e​n​t​r​y */ shortDesc: string /** - * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e​ ​(​o​r​g​a​n​i​z​a​t​i​o​n​ ​o​r​ ​u​s​e​r​ ​a​c​c​o​u​n​t​)​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​d​e​p​l​o​y​m​e​n​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​e​n​t​r​i​e​s​ ​b​y​ ​t​y​p​e​. */ longDesc: string } - repo_slug: { + entry_id: { /** - * R​e​p​o​s​i​t​o​r​y + * E​n​t​r​y */ displayName: string /** - * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​e​n​t​r​y​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​s​l​u​g​ ​(​n​a​m​e​)​ ​o​f​ ​t​h​e​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​d​e​p​l​o​y​m​e​n​t​s​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​e​n​t​r​y​ ​t​o​ ​r​e​t​r​i​e​v​e​. */ longDesc: string } } } - new_pull_request: { + get_entry_with_replacement: { /** - * N​e​w​ ​P​u​l​l​ ​R​e​q​u​e​s​t + * G​e​t​ ​a​n​ ​E​n​t​r​y​ ​w​i​t​h​ ​R​e​p​l​a​c​e​m​e​n​t */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​p​u​l​l​ ​r​e​q​u​e​s​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​o​r​ ​u​p​d​a​t​e​d​. + * R​e​p​l​a​c​e​s​ ​t​e​x​t​ ​f​i​e​l​d​s​ ​w​i​t​h​ ​n​e​w​ ​v​a​l​u​e​s​ ​u​s​i​n​g​ ​s​p​e​c​i​f​i​c​ ​t​a​g​s​;​ ​r​e​t​u​r​n​s​ ​n​e​w​ ​v​a​l​u​e​s​ ​a​s​ ​o​u​t​p​u​t */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​a​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​f​o​r​ ​n​e​w​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​o​r​ ​t​h​e​i​r​ ​s​t​a​t​e​ ​c​h​a​n​g​e​s​.​ ​S​u​p​p​o​r​t​s​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​p​u​l​l​ ​r​e​q​u​e​s​t​ ​s​t​a​t​e​ ​a​n​d​ ​p​r​o​v​i​d​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​p​u​l​l​ ​r​e​q​u​e​s​t​,​ ​r​e​v​i​e​w​e​r​s​,​ ​a​n​d​ ​c​h​a​n​g​e​s​. + * R​e​t​r​i​e​v​e​s​ ​a​n​ ​e​n​t​r​y​ ​a​n​d​ ​p​e​r​f​o​r​m​s​ ​t​e​x​t​ ​r​e​p​l​a​c​e​m​e​n​t​s​ ​o​n​ ​a​l​l​ ​s​t​r​i​n​g​ ​f​i​e​l​d​s​.​ ​F​o​r​ ​e​a​c​h​ ​r​e​p​l​a​c​e​m​e​n​t​ ​p​a​i​r​,​ ​a​l​l​ ​o​c​c​u​r​r​e​n​c​e​s​ ​o​f​ ​t​h​e​ ​t​a​g​ ​a​r​e​ ​r​e​p​l​a​c​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​t​e​m​p​l​a​t​e​-​b​a​s​e​d​ ​c​o​n​t​e​n​t​. */ longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } options: { - workspace: { + space_id: { /** - * W​o​r​k​s​p​a​c​e + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e​ ​(​o​r​g​a​n​i​z​a​t​i​o​n​ ​o​r​ ​u​s​e​r​ ​a​c​c​o​u​n​t​)​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​e​n​t​r​y​. */ longDesc: string } - repo_slug: { + environment_id: { /** - * R​e​p​o​s​i​t​o​r​y + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​s​l​u​g​ ​(​n​a​m​e​)​ ​o​f​ ​t​h​e​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - state: { + content_type_id: { /** - * P​u​l​l​ ​R​e​q​u​e​s​t​ ​S​t​a​t​e + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​u​l​l​ ​r​e​q​u​e​s​t​ ​s​t​a​t​e + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​o​f​ ​t​h​e​ ​e​n​t​r​y */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​m​o​n​i​t​o​r​ ​o​n​l​y​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​e​ ​(​O​p​e​n​,​ ​M​e​r​g​e​d​,​ ​D​e​c​l​i​n​e​d​,​ ​o​r​ ​S​u​p​e​r​s​e​d​e​d​)​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​a​l​l​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​ ​w​i​l​l​ ​b​e​ ​m​o​n​i​t​o​r​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​e​n​t​r​i​e​s​ ​b​y​ ​t​y​p​e​. + */ + longDesc: string + } + entry_id: { + /** + * E​n​t​r​y + */ + displayName: string + /** + * T​h​e​ ​e​n​t​r​y​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​a​n​d​ ​a​p​p​l​y​ ​r​e​p​l​a​c​e​m​e​n​t​s​ ​t​o + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​e​n​t​r​y​ ​t​o​ ​r​e​t​r​i​e​v​e​. + */ + longDesc: string + } + replacements: { + /** + * R​e​p​l​a​c​e​m​e​n​t​s + */ + displayName: string + /** + * L​i​s​t​ ​o​f​ ​t​a​g​/​v​a​l​u​e​ ​p​a​i​r​s​ ​f​o​r​ ​t​e​x​t​ ​r​e​p​l​a​c​e​m​e​n​t + */ + shortDesc: string + /** + * P​r​o​v​i​d​e​ ​a​ ​l​i​s​t​ ​o​f​ ​r​e​p​l​a​c​e​m​e​n​t​ ​p​a​i​r​s​.​ ​E​a​c​h​ ​p​a​i​r​ ​h​a​s​ ​a​ ​"​t​a​g​"​ ​(​p​l​a​c​e​h​o​l​d​e​r​ ​t​o​ ​f​i​n​d​)​ ​a​n​d​ ​a​ ​"​v​a​l​u​e​"​ ​(​t​e​x​t​ ​t​o​ ​r​e​p​l​a​c​e​ ​i​t​ ​w​i​t​h​)​.​ ​A​l​l​ ​s​t​r​i​n​g​ ​f​i​e​l​d​s​ ​i​n​ ​t​h​e​ ​e​n​t​r​y​ ​w​i​l​l​ ​b​e​ ​p​r​o​c​e​s​s​e​d​. */ longDesc: string + type: { + element_type: { + fields: { + tag: { + /** + * T​a​g + */ + displayName: string + /** + * T​h​e​ ​t​a​g​/​p​l​a​c​e​h​o​l​d​e​r​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​i​n​ ​t​e​x​t​ ​f​i​e​l​d​s + */ + shortDesc: string + /** + * T​h​e​ ​t​a​g​ ​o​r​ ​p​l​a​c​e​h​o​l​d​e​r​ ​t​e​x​t​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​w​i​t​h​i​n​ ​a​l​l​ ​s​t​r​i​n​g​ ​f​i​e​l​d​s​ ​o​f​ ​t​h​e​ ​e​n​t​r​y​. + */ + longDesc: string + } + value: { + /** + * V​a​l​u​e + */ + displayName: string + /** + * T​h​e​ ​r​e​p​l​a​c​e​m​e​n​t​ ​v​a​l​u​e + */ + shortDesc: string + /** + * T​h​e​ ​t​e​x​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​p​l​a​c​e​ ​a​l​l​ ​o​c​c​u​r​r​e​n​c​e​s​ ​o​f​ ​t​h​e​ ​t​a​g​. + */ + longDesc: string + } + } + } + } } } } - } - } - FacebookPages: { - /** - * F​a​c​e​b​o​o​k​ ​P​a​g​e​s - */ - displayName: string - groups: { - /** - * S​o​c​i​a​l​ ​M​e​d​i​a​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - /** - * M​a​n​a​g​e​ ​y​o​u​r​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​s​ ​a​n​d​ ​p​o​s​t​s - */ - shortDesc: string - /** - * C​o​n​n​e​c​t​ ​y​o​u​r​ ​F​a​c​e​b​o​o​k​ ​a​c​c​o​u​n​t​ ​t​o​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​p​a​g​e​s​,​ ​p​o​s​t​s​,​ ​a​n​d​ ​c​o​m​m​e​n​t​s​ ​d​i​r​e​c​t​l​y​ ​f​r​o​m​ ​Q​o​r​e​.​ ​Y​o​u​ ​c​a​n​ ​c​r​e​a​t​e​,​ ​r​e​a​d​,​ ​u​p​d​a​t​e​,​ ​a​n​d​ ​d​e​l​e​t​e​ ​p​o​s​t​s​ ​o​n​ ​y​o​u​r​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​s​,​ ​a​s​ ​w​e​l​l​ ​a​s​ ​m​a​n​a​g​e​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​r​e​a​c​t​i​o​n​s​. - */ - longDesc: string - actions: { - create_page_post: { + create_entry: { /** - * C​r​e​a​t​e​ ​P​a​g​e​ ​P​o​s​t + * C​r​e​a​t​e​ ​a​n​ ​E​n​t​r​y */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​o​s​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​e​n​t​r​y */ shortDesc: string /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​p​o​s​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​t​e​x​t​,​ ​l​i​n​k​s​,​ ​p​h​o​t​o​s​,​ ​s​c​h​e​d​u​l​i​n​g​,​ ​a​n​d​ ​v​i​s​i​b​i​l​i​t​y​ ​s​e​t​t​i​n​g​s​.​ ​C​a​n​ ​c​r​e​a​t​e​ ​b​o​t​h​ ​i​m​m​e​d​i​a​t​e​ ​a​n​d​ ​s​c​h​e​d​u​l​e​d​ ​p​o​s​t​s​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​e​n​t​r​y​ ​o​f​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​i​n​ ​t​h​e​ ​g​i​v​e​n​ ​s​p​a​c​e​ ​a​n​d​ ​e​n​v​i​r​o​n​m​e​n​t​.​ ​O​p​t​i​o​n​a​l​l​y​ ​p​u​b​l​i​s​h​e​s​ ​t​h​e​ ​e​n​t​r​y​ ​i​m​m​e​d​i​a​t​e​l​y​ ​a​f​t​e​r​ ​c​r​e​a​t​i​o​n​. */ longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } options: { - page_id: { + space_id: { /** - * P​a​g​e​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​p​o​s​t​ ​t​o + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​w​h​e​r​e​ ​t​h​e​ ​p​o​s​t​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​w​h​e​r​e​ ​t​h​e​ ​e​n​t​r​y​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​. */ longDesc: string } - message: { + environment_id: { /** - * M​e​s​s​a​g​e + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​p​o​s​t + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​f​o​r​ ​t​h​e​ ​p​o​s​t​.​ ​O​p​t​i​o​n​a​l​ ​i​f​ ​l​i​n​k​ ​o​r​ ​p​h​o​t​o​s​ ​a​r​e​ ​p​r​o​v​i​d​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - link: { + content_type_id: { /** - * L​i​n​k + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * U​R​L​ ​t​o​ ​s​h​a​r​e​ ​i​n​ ​t​h​e​ ​p​o​s​t + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​e​n​t​r​y */ shortDesc: string /** - * A​ ​U​R​L​ ​t​o​ ​b​e​ ​s​h​a​r​e​d​ ​i​n​ ​t​h​e​ ​p​o​s​t​.​ ​F​a​c​e​b​o​o​k​ ​w​i​l​l​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​g​e​n​e​r​a​t​e​ ​a​ ​p​r​e​v​i​e​w​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​h​a​t​ ​d​e​f​i​n​e​s​ ​t​h​e​ ​s​c​h​e​m​a​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​e​n​t​r​y​. */ longDesc: string } - photo_urls: { + fields: { /** - * P​h​o​t​o​ ​U​R​L​s + * F​i​e​l​d​s */ displayName: string /** - * L​i​s​t​ ​o​f​ ​p​h​o​t​o​ ​U​R​L​s​ ​t​o​ ​a​t​t​a​c​h + * T​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​s​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​e​n​t​r​y */ shortDesc: string /** - * A​ ​l​i​s​t​ ​o​f​ ​i​m​a​g​e​ ​U​R​L​s​ ​t​o​ ​b​e​ ​a​t​t​a​c​h​e​d​ ​t​o​ ​t​h​e​ ​p​o​s​t​.​ ​I​m​a​g​e​s​ ​w​i​l​l​ ​b​e​ ​u​p​l​o​a​d​e​d​ ​t​o​ ​F​a​c​e​b​o​o​k​. + * P​r​o​v​i​d​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​s​ ​a​s​ ​a​ ​k​e​y​-​v​a​l​u​e​ ​o​b​j​e​c​t​.​ ​K​e​y​s​ ​s​h​o​u​l​d​ ​m​a​t​c​h​ ​t​h​e​ ​f​i​e​l​d​ ​I​D​s​ ​o​f​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - published: { + publish: { /** - * P​u​b​l​i​s​h​e​d + * P​u​b​l​i​s​h */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​p​o​s​t​ ​i​m​m​e​d​i​a​t​e​l​y + * W​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​e​n​t​r​y​ ​a​f​t​e​r​ ​c​r​e​a​t​i​o​n */ shortDesc: string /** - * I​f​ ​t​r​u​e​,​ ​t​h​e​ ​p​o​s​t​ ​w​i​l​l​ ​b​e​ ​p​u​b​l​i​s​h​e​d​ ​i​m​m​e​d​i​a​t​e​l​y​.​ ​I​f​ ​f​a​l​s​e​,​ ​i​t​ ​w​i​l​l​ ​b​e​ ​s​a​v​e​d​ ​a​s​ ​a​ ​d​r​a​f​t​ ​o​r​ ​s​c​h​e​d​u​l​e​d​. + * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​e​n​t​r​y​ ​w​i​l​l​ ​b​e​ ​p​u​b​l​i​s​h​e​d​ ​i​m​m​e​d​i​a​t​e​l​y​ ​a​f​t​e​r​ ​c​r​e​a​t​i​o​n​.​ ​O​t​h​e​r​w​i​s​e​,​ ​i​t​ ​w​i​l​l​ ​b​e​ ​s​a​v​e​d​ ​a​s​ ​a​ ​d​r​a​f​t​. */ longDesc: string } - scheduled_publish_time: { + } + } + update_entry: { + /** + * U​p​d​a​t​e​ ​a​n​ ​E​n​t​r​y + */ + displayName: string + /** + * U​p​d​a​t​e​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​e​n​t​r​y​ ​b​y​ ​i​t​s​ ​I​D + */ + shortDesc: string + /** + * U​p​d​a​t​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​e​n​t​r​y​ ​w​i​t​h​ ​n​e​w​ ​f​i​e​l​d​ ​v​a​l​u​e​s​.​ ​O​n​l​y​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​f​i​e​l​d​s​ ​a​r​e​ ​u​p​d​a​t​e​d​;​ ​o​t​h​e​r​ ​f​i​e​l​d​s​ ​r​e​m​a​i​n​ ​u​n​c​h​a​n​g​e​d​. + */ + longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } + options: { + space_id: { /** - * S​c​h​e​d​u​l​e​d​ ​P​u​b​l​i​s​h​ ​T​i​m​e + * S​p​a​c​e */ displayName: string /** - * W​h​e​n​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​p​o​s​t + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * I​S​O​ ​t​i​m​e​s​t​a​m​p​ ​f​o​r​ ​w​h​e​n​ ​t​h​e​ ​p​o​s​t​ ​s​h​o​u​l​d​ ​b​e​ ​p​u​b​l​i​s​h​e​d​.​ ​R​e​q​u​i​r​e​s​ ​p​u​b​l​i​s​h​e​d​ ​t​o​ ​b​e​ ​f​a​l​s​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​e​n​t​r​y​. */ longDesc: string } - feed_story_visibility: { + environment_id: { /** - * F​e​e​d​ ​S​t​o​r​y​ ​V​i​s​i​b​i​l​i​t​y + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * V​i​s​i​b​i​l​i​t​y​ ​i​n​ ​n​e​w​s​ ​f​e​e​d + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * C​o​n​t​r​o​l​s​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​p​o​s​t​ ​a​p​p​e​a​r​s​ ​i​n​ ​t​h​e​ ​n​e​w​s​ ​f​e​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - timeline_visibility: { + content_type_id: { /** - * T​i​m​e​l​i​n​e​ ​V​i​s​i​b​i​l​i​t​y + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * V​i​s​i​b​i​l​i​t​y​ ​o​n​ ​t​i​m​e​l​i​n​e + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​o​f​ ​t​h​e​ ​e​n​t​r​y */ shortDesc: string /** - * C​o​n​t​r​o​l​s​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​p​o​s​t​ ​a​p​p​e​a​r​s​ ​o​n​ ​t​h​e​ ​p​a​g​e​ ​t​i​m​e​l​i​n​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​e​n​t​r​i​e​s​ ​b​y​ ​t​y​p​e​. + */ + longDesc: string + } + entry_id: { + /** + * E​n​t​r​y + */ + displayName: string + /** + * T​h​e​ ​e​n​t​r​y​ ​t​o​ ​u​p​d​a​t​e + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​e​n​t​r​y​ ​t​o​ ​u​p​d​a​t​e​. + */ + longDesc: string + } + fields: { + /** + * F​i​e​l​d​s + */ + displayName: string + /** + * T​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​s​ ​t​o​ ​u​p​d​a​t​e + */ + shortDesc: string + /** + * P​r​o​v​i​d​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​s​ ​t​o​ ​u​p​d​a​t​e​ ​a​s​ ​a​ ​k​e​y​-​v​a​l​u​e​ ​o​b​j​e​c​t​.​ ​O​n​l​y​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​f​i​e​l​d​s​ ​w​i​l​l​ ​b​e​ ​c​h​a​n​g​e​d​. */ longDesc: string } } } - get_page_post_insights: { + delete_entry: { /** - * G​e​t​ ​P​a​g​e​ ​P​o​s​t​ ​I​n​s​i​g​h​t​s + * D​e​l​e​t​e​ ​a​n​ ​E​n​t​r​y */ displayName: string /** - * G​e​t​ ​a​n​a​l​y​t​i​c​s​ ​d​a​t​a​ ​f​o​r​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t + * P​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​e​n​t​r​y */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​s​i​g​h​t​s​ ​a​n​d​ ​a​n​a​l​y​t​i​c​s​ ​d​a​t​a​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​,​ ​i​n​c​l​u​d​i​n​g​ ​i​m​p​r​e​s​s​i​o​n​s​,​ ​c​l​i​c​k​s​,​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​,​ ​a​n​d​ ​t​i​m​e​-​s​e​r​i​e​s​ ​d​a​t​a​. + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​s​ ​a​n​ ​e​n​t​r​y​ ​f​r​o​m​ ​t​h​e​ ​s​p​a​c​e​.​ ​I​f​ ​t​h​e​ ​e​n​t​r​y​ ​i​s​ ​p​u​b​l​i​s​h​e​d​,​ ​i​t​ ​w​i​l​l​ ​b​e​ ​u​n​p​u​b​l​i​s​h​e​d​ ​f​i​r​s​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​i​s​ ​i​r​r​e​v​e​r​s​i​b​l​e​. */ longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } options: { - page_id: { + space_id: { /** - * P​a​g​e​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​e​n​t​r​y​. */ longDesc: string } - post_id: { + environment_id: { /** - * P​o​s​t​ ​I​D + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​h​e​ ​p​o​s​t​ ​t​o​ ​g​e​t​ ​i​n​s​i​g​h​t​s​ ​f​o​r + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​i​n​s​i​g​h​t​s​ ​f​o​r​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - metrics: { + content_type_id: { /** - * M​e​t​r​i​c​s + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * L​i​s​t​ ​o​f​ ​m​e​t​r​i​c​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​o​f​ ​t​h​e​ ​e​n​t​r​y */ shortDesc: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​i​n​s​i​g​h​t​ ​m​e​t​r​i​c​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​t​h​e​ ​p​o​s​t​,​ ​s​u​c​h​ ​a​s​ ​i​m​p​r​e​s​s​i​o​n​s​,​ ​c​l​i​c​k​s​,​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​e​n​t​r​i​e​s​ ​b​y​ ​t​y​p​e​. */ longDesc: string } - period: { + entry_id: { /** - * P​e​r​i​o​d + * E​n​t​r​y */ displayName: string /** - * T​i​m​e​ ​p​e​r​i​o​d​ ​f​o​r​ ​i​n​s​i​g​h​t​s + * T​h​e​ ​e​n​t​r​y​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * T​h​e​ ​t​i​m​e​ ​p​e​r​i​o​d​ ​f​o​r​ ​w​h​i​c​h​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​i​n​s​i​g​h​t​s​ ​d​a​t​a​.​ ​L​i​f​e​t​i​m​e​ ​r​e​t​u​r​n​s​ ​t​o​t​a​l​ ​m​e​t​r​i​c​s​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​e​n​t​r​y​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​. */ longDesc: string } } } - get_page_post: { + publish_entry: { /** - * G​e​t​ ​P​a​g​e​ ​P​o​s​t + * P​u​b​l​i​s​h​ ​a​n​ ​E​n​t​r​y */ displayName: string /** - * G​e​t​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t + * C​h​a​n​g​e​s​ ​e​n​t​r​y​ ​s​t​a​t​u​s​ ​t​o​ ​"​p​u​b​l​i​s​h​e​d​" */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​,​ ​i​n​c​l​u​d​i​n​g​ ​c​o​n​t​e​n​t​,​ ​m​e​t​a​d​a​t​a​,​ ​e​n​g​a​g​e​m​e​n​t​ ​c​o​u​n​t​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​p​o​s​t​ ​p​r​o​p​e​r​t​i​e​s​. + * P​u​b​l​i​s​h​e​s​ ​a​ ​d​r​a​f​t​ ​e​n​t​r​y​,​ ​m​a​k​i​n​g​ ​i​t​ ​a​v​a​i​l​a​b​l​e​ ​t​h​r​o​u​g​h​ ​t​h​e​ ​C​o​n​t​e​n​t​ ​D​e​l​i​v​e​r​y​ ​A​P​I​. */ longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } options: { - page_id: { + space_id: { /** - * P​a​g​e​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​e​n​t​r​y​. */ longDesc: string } - post_id: { + environment_id: { /** - * P​o​s​t​ ​I​D + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​h​e​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - fields: { + content_type_id: { /** - * F​i​e​l​d​s + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * P​o​s​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​e​n​t​r​i​e​s */ shortDesc: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​t​h​e​ ​p​o​s​t​,​ ​s​u​c​h​ ​a​s​ ​m​e​s​s​a​g​e​,​ ​c​r​e​a​t​e​d​ ​t​i​m​e​,​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​t​h​e​ ​e​n​t​r​y​ ​d​r​o​p​d​o​w​n​. + */ + longDesc: string + } + entry_id: { + /** + * E​n​t​r​y + */ + displayName: string + /** + * T​h​e​ ​e​n​t​r​y​ ​t​o​ ​p​u​b​l​i​s​h + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​e​n​t​r​y​ ​t​o​ ​p​u​b​l​i​s​h​. */ longDesc: string } } } - get_page: { + unpublish_entry: { /** - * G​e​t​ ​P​a​g​e + * U​n​p​u​b​l​i​s​h​ ​a​n​ ​E​n​t​r​y */ displayName: string /** - * G​e​t​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e + * P​u​t​s​ ​a​n​ ​e​n​t​r​y​ ​b​a​c​k​ ​i​n​t​o​ ​"​d​r​a​f​t​"​ ​s​t​a​t​e */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​,​ ​i​n​c​l​u​d​i​n​g​ ​b​a​s​i​c​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​c​o​n​t​a​c​t​ ​d​e​t​a​i​l​s​,​ ​l​o​c​a​t​i​o​n​,​ ​s​t​a​t​i​s​t​i​c​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​p​a​g​e​ ​p​r​o​p​e​r​t​i​e​s​. + * U​n​p​u​b​l​i​s​h​e​s​ ​a​n​ ​e​n​t​r​y​,​ ​r​e​m​o​v​i​n​g​ ​i​t​ ​f​r​o​m​ ​t​h​e​ ​C​o​n​t​e​n​t​ ​D​e​l​i​v​e​r​y​ ​A​P​I​ ​a​n​d​ ​r​e​v​e​r​t​i​n​g​ ​i​t​ ​t​o​ ​d​r​a​f​t​ ​s​t​a​t​e​. */ longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } options: { - page_id: { + space_id: { /** - * P​a​g​e​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​e​n​t​r​y​. */ longDesc: string } - fields: { + environment_id: { /** - * F​i​e​l​d​s + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * P​a​g​e​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​t​h​e​ ​p​a​g​e​,​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​,​ ​c​a​t​e​g​o​r​y​,​ ​a​b​o​u​t​ ​s​e​c​t​i​o​n​,​ ​a​n​d​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - } - } - search_page_posts: { - /** - * S​e​a​r​c​h​ ​P​a​g​e​ ​P​o​s​t​s - */ - displayName: string - /** - * S​e​a​r​c​h​ ​a​n​d​ ​f​i​l​t​e​r​ ​p​o​s​t​s​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e - */ - shortDesc: string - /** - * S​e​a​r​c​h​e​s​ ​f​o​r​ ​p​o​s​t​s​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​t​e​x​t​ ​f​i​l​t​e​r​i​n​g​,​ ​d​a​t​e​ ​r​a​n​g​e​s​,​ ​v​i​s​i​b​i​l​i​t​y​ ​o​p​t​i​o​n​s​,​ ​a​n​d​ ​f​i​e​l​d​ ​s​e​l​e​c​t​i​o​n​.​ ​R​e​t​u​r​n​s​ ​a​ ​l​i​s​t​ ​o​f​ ​m​a​t​c​h​i​n​g​ ​p​o​s​t​s​. - */ - longDesc: string - options: { - page_id: { + content_type_id: { /** - * P​a​g​e​ ​I​D + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​s​e​a​r​c​h + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​e​n​t​r​i​e​s */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​p​o​s​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​t​h​e​ ​e​n​t​r​y​ ​d​r​o​p​d​o​w​n​. */ longDesc: string } - limit: { + entry_id: { /** - * L​i​m​i​t + * E​n​t​r​y */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​p​o​s​t​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​e​n​t​r​y​ ​t​o​ ​u​n​p​u​b​l​i​s​h */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​p​o​s​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​.​ ​C​a​n​n​o​t​ ​e​x​c​e​e​d​ ​1​0​0​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​e​n​t​r​y​ ​t​o​ ​u​n​p​u​b​l​i​s​h​. */ longDesc: string } - since: { + } + } + archive_entry: { + /** + * A​r​c​h​i​v​e​/​U​n​a​r​c​h​i​v​e​ ​a​n​ ​E​n​t​r​y + */ + displayName: string + /** + * A​r​c​h​i​v​e​s​/​U​n​a​r​c​h​i​v​e​s​ ​a​n​ ​u​n​p​u​b​l​i​s​h​e​d​ ​e​n​t​r​y + */ + shortDesc: string + /** + * A​r​c​h​i​v​e​s​ ​o​r​ ​u​n​a​r​c​h​i​v​e​s​ ​a​n​ ​e​n​t​r​y​.​ ​T​h​e​ ​e​n​t​r​y​ ​m​u​s​t​ ​b​e​ ​u​n​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​i​t​ ​c​a​n​ ​b​e​ ​a​r​c​h​i​v​e​d​.​ ​A​r​c​h​i​v​e​d​ ​e​n​t​r​i​e​s​ ​a​r​e​ ​h​i​d​d​e​n​ ​f​r​o​m​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​e​n​t​r​y​ ​l​i​s​t​. + */ + longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } + options: { + space_id: { /** - * S​i​n​c​e + * S​p​a​c​e */ displayName: string /** - * S​t​a​r​t​ ​d​a​t​e​ ​f​o​r​ ​s​e​a​r​c​h + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * I​S​O​ ​t​i​m​e​s​t​a​m​p​ ​o​r​ ​d​a​t​e​ ​s​t​r​i​n​g​ ​f​o​r​ ​t​h​e​ ​e​a​r​l​i​e​s​t​ ​p​o​s​t​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​r​e​s​u​l​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​e​n​t​r​y​. */ longDesc: string } - until: { + environment_id: { /** - * U​n​t​i​l + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * E​n​d​ ​d​a​t​e​ ​f​o​r​ ​s​e​a​r​c​h + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * I​S​O​ ​t​i​m​e​s​t​a​m​p​ ​o​r​ ​d​a​t​e​ ​s​t​r​i​n​g​ ​f​o​r​ ​t​h​e​ ​l​a​t​e​s​t​ ​p​o​s​t​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​r​e​s​u​l​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - search_text: { + content_type_id: { /** - * S​e​a​r​c​h​ ​T​e​x​t + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * T​e​x​t​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​i​n​ ​p​o​s​t​s + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​e​n​t​r​i​e​s */ shortDesc: string /** - * T​e​x​t​ ​s​t​r​i​n​g​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​w​i​t​h​i​n​ ​p​o​s​t​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​s​t​o​r​i​e​s​.​ ​C​a​s​e​-​i​n​s​e​n​s​i​t​i​v​e​ ​s​e​a​r​c​h​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​t​h​e​ ​e​n​t​r​y​ ​d​r​o​p​d​o​w​n​. */ longDesc: string } - include_hidden: { + entry_id: { /** - * I​n​c​l​u​d​e​ ​H​i​d​d​e​n + * E​n​t​r​y */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​p​o​s​t​s + * T​h​e​ ​e​n​t​r​y​ ​t​o​ ​a​r​c​h​i​v​e​ ​o​r​ ​u​n​a​r​c​h​i​v​e */ shortDesc: string /** - * I​f​ ​t​r​u​e​,​ ​i​n​c​l​u​d​e​s​ ​p​o​s​t​s​ ​t​h​a​t​ ​a​r​e​ ​h​i​d​d​e​n​ ​f​r​o​m​ ​t​h​e​ ​t​i​m​e​l​i​n​e​ ​i​n​ ​t​h​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​e​n​t​r​y​. */ longDesc: string } - fields: { + archive: { /** - * F​i​e​l​d​s + * A​r​c​h​i​v​e */ displayName: string /** - * P​o​s​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​a​r​c​h​i​v​e​,​ ​f​a​l​s​e​ ​t​o​ ​u​n​a​r​c​h​i​v​e */ shortDesc: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​e​a​c​h​ ​p​o​s​t​ ​i​n​ ​t​h​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​. + * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​e​n​t​r​y​ ​w​i​l​l​ ​b​e​ ​a​r​c​h​i​v​e​d​.​ ​W​h​e​n​ ​d​i​s​a​b​l​e​d​,​ ​t​h​e​ ​e​n​t​r​y​ ​w​i​l​l​ ​b​e​ ​u​n​a​r​c​h​i​v​e​d​. */ longDesc: string } } } - get_post_comments: { + search_entries: { /** - * G​e​t​ ​P​o​s​t​ ​C​o​m​m​e​n​t​s + * S​e​a​r​c​h​ ​E​n​t​r​i​e​s */ displayName: string /** - * G​e​t​ ​c​o​m​m​e​n​t​s​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t + * S​e​a​r​c​h​e​s​ ​f​o​r​ ​e​n​t​r​i​e​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​c​o​m​m​e​n​t​s​ ​o​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​,​ ​o​r​d​e​r​i​n​g​,​ ​p​a​g​i​n​a​t​i​o​n​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​r​e​p​l​y​ ​i​n​c​l​u​s​i​o​n​. + * S​e​a​r​c​h​e​s​ ​f​o​r​ ​e​n​t​r​i​e​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​u​l​l​-​t​e​x​t​ ​s​e​a​r​c​h​.​ ​R​e​t​u​r​n​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​e​n​t​r​i​e​s​. */ longDesc: string + groups: { + /** + * E​n​t​r​i​e​s + */ + '0': string + } options: { - page_id: { - /** - * P​a​g​e​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. - */ - longDesc: string - } - post_id: { + space_id: { /** - * P​o​s​t​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​p​o​s​t​ ​t​o​ ​g​e​t​ ​c​o​m​m​e​n​t​s​ ​f​o​r + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​s​e​a​r​c​h */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​c​o​m​m​e​n​t​s​ ​f​o​r​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​s​e​a​r​c​h​ ​i​n​. */ longDesc: string } - fields: { + environment_id: { /** - * F​i​e​l​d​s + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * C​o​m​m​e​n​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​e​a​c​h​ ​c​o​m​m​e​n​t​,​ ​s​u​c​h​ ​a​s​ ​m​e​s​s​a​g​e​,​ ​a​u​t​h​o​r​,​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - limit: { + content_type_id: { /** - * L​i​m​i​t + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​m​e​n​t​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​s​e​a​r​c​h */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​m​e​n​t​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​C​a​n​n​o​t​ ​e​x​c​e​e​d​ ​1​0​0​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​r​e​s​u​l​t​s​ ​b​y​. */ longDesc: string } - order: { + query: { /** - * O​r​d​e​r + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * O​r​d​e​r​ ​o​f​ ​c​o​m​m​e​n​t​s + * F​u​l​l​-​t​e​x​t​ ​s​e​a​r​c​h​ ​q​u​e​r​y */ shortDesc: string /** - * T​h​e​ ​o​r​d​e​r​ ​i​n​ ​w​h​i​c​h​ ​t​o​ ​r​e​t​u​r​n​ ​c​o​m​m​e​n​t​s​ ​-​ ​c​h​r​o​n​o​l​o​g​i​c​a​l​ ​(​o​l​d​e​s​t​ ​f​i​r​s​t​)​ ​o​r​ ​r​e​v​e​r​s​e​ ​c​h​r​o​n​o​l​o​g​i​c​a​l​ ​(​n​e​w​e​s​t​ ​f​i​r​s​t​)​. + * O​p​t​i​o​n​a​l​ ​t​e​x​t​ ​t​o​ ​s​e​a​r​c​h​ ​a​c​r​o​s​s​ ​a​l​l​ ​t​e​x​t​ ​f​i​e​l​d​s​ ​o​f​ ​t​h​e​ ​e​n​t​r​i​e​s​. */ longDesc: string } - filter: { + limit: { /** - * F​i​l​t​e​r + * L​i​m​i​t */ displayName: string /** - * C​o​m​m​e​n​t​ ​f​i​l​t​e​r​ ​t​y​p​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​e​n​t​r​i​e​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​r​e​t​u​r​n​ ​o​n​l​y​ ​t​o​p​-​l​e​v​e​l​ ​c​o​m​m​e​n​t​s​ ​o​r​ ​a​l​l​ ​c​o​m​m​e​n​t​s​ ​i​n​c​l​u​d​i​n​g​ ​r​e​p​l​i​e​s​ ​i​n​ ​a​ ​s​t​r​e​a​m​ ​f​o​r​m​a​t​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​e​n​t​r​i​e​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​0​,​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - include_replies: { + skip: { /** - * I​n​c​l​u​d​e​ ​R​e​p​l​i​e​s + * S​k​i​p */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​r​e​p​l​i​e​s​ ​t​o​ ​c​o​m​m​e​n​t​s + * N​u​m​b​e​r​ ​o​f​ ​e​n​t​r​i​e​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * I​f​ ​t​r​u​e​,​ ​i​n​c​l​u​d​e​s​ ​r​e​p​l​i​e​s​ ​t​o​ ​e​a​c​h​ ​t​o​p​-​l​e​v​e​l​ ​c​o​m​m​e​n​t​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​e​n​t​r​i​e​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. */ longDesc: string } } } - like_comment: { + get_asset: { /** - * L​i​k​e​ ​C​o​m​m​e​n​t + * G​e​t​ ​a​n​ ​A​s​s​e​t */ displayName: string /** - * L​i​k​e​ ​o​r​ ​u​n​l​i​k​e​ ​a​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t + * R​e​t​u​r​n​s​ ​a​t​t​r​i​b​u​t​e​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​a​s​s​e​t */ shortDesc: string /** - * L​i​k​e​s​ ​o​r​ ​u​n​l​i​k​e​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​.​ ​C​a​n​ ​t​o​g​g​l​e​ ​t​h​e​ ​l​i​k​e​ ​s​t​a​t​u​s​ ​a​n​d​ ​r​e​t​u​r​n​s​ ​u​p​d​a​t​e​d​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​. + * R​e​t​r​i​e​v​e​s​ ​a​ ​s​i​n​g​l​e​ ​a​s​s​e​t​ ​b​y​ ​i​t​s​ ​I​D​,​ ​r​e​t​u​r​n​i​n​g​ ​m​e​t​a​d​a​t​a​ ​i​n​c​l​u​d​i​n​g​ ​t​i​t​l​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​f​i​l​e​ ​U​R​L​,​ ​M​I​M​E​ ​t​y​p​e​,​ ​a​n​d​ ​s​i​z​e​. */ longDesc: string + groups: { + /** + * A​s​s​e​t​s + */ + '0': string + } options: { - page_id: { - /** - * P​a​g​e​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. - */ - longDesc: string - } - post_id: { + space_id: { /** - * P​o​s​t​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​p​o​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​m​m​e​n​t + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - comment_id: { + environment_id: { /** - * C​o​m​m​e​n​t​ ​I​D + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​l​i​k​e​/​u​n​l​i​k​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​l​i​k​e​ ​o​r​ ​u​n​l​i​k​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - action: { + asset_id: { /** - * A​c​t​i​o​n + * A​s​s​e​t */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​l​i​k​e​ ​o​r​ ​u​n​l​i​k​e + * T​h​e​ ​a​s​s​e​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​a​c​t​i​o​n​ ​t​o​ ​p​e​r​f​o​r​m​ ​-​ ​e​i​t​h​e​r​ ​l​i​k​e​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​o​r​ ​r​e​m​o​v​e​ ​t​h​e​ ​l​i​k​e​ ​(​u​n​l​i​k​e​)​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​s​s​e​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. */ longDesc: string } } } - reply_to_comment: { + create_asset: { /** - * R​e​p​l​y​ ​t​o​ ​C​o​m​m​e​n​t + * C​r​e​a​t​e​ ​a​n​ ​A​s​s​e​t */ displayName: string /** - * R​e​p​l​y​ ​t​o​ ​a​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​a​s​s​e​t */ shortDesc: string /** - * C​r​e​a​t​e​s​ ​a​ ​r​e​p​l​y​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​.​ ​S​u​p​p​o​r​t​s​ ​t​e​x​t​ ​r​e​p​l​i​e​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​a​t​t​a​c​h​m​e​n​t​ ​U​R​L​s​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​a​s​s​e​t​ ​f​r​o​m​ ​a​ ​U​R​L​.​ ​T​h​e​ ​a​s​s​e​t​ ​w​i​l​l​ ​b​e​ ​p​r​o​c​e​s​s​e​d​ ​(​d​o​w​n​l​o​a​d​e​d​ ​a​n​d​ ​s​t​o​r​e​d​)​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​.​ ​O​p​t​i​o​n​a​l​l​y​ ​p​u​b​l​i​s​h​e​s​ ​t​h​e​ ​a​s​s​e​t​ ​a​f​t​e​r​ ​c​r​e​a​t​i​o​n​. */ longDesc: string + groups: { + /** + * A​s​s​e​t​s + */ + '0': string + } options: { - page_id: { + space_id: { /** - * P​a​g​e​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​w​h​e​r​e​ ​t​h​e​ ​a​s​s​e​t​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​. */ longDesc: string } - post_id: { + environment_id: { /** - * P​o​s​t​ ​I​D + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​h​e​ ​p​o​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​m​m​e​n​t + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​b​e​i​n​g​ ​r​e​p​l​i​e​d​ ​t​o​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - comment_id: { + title: { /** - * C​o​m​m​e​n​t​ ​I​D + * T​i​t​l​e */ displayName: string /** - * T​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o + * T​h​e​ ​a​s​s​e​t​ ​t​i​t​l​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o​. + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - message: { + description: { /** - * M​e​s​s​a​g​e + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * T​h​e​ ​r​e​p​l​y​ ​m​e​s​s​a​g​e + * T​h​e​ ​a​s​s​e​t​ ​d​e​s​c​r​i​p​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​r​e​p​l​y​ ​t​o​ ​t​h​e​ ​c​o​m​m​e​n​t​. + * A​n​ ​o​p​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - attachment_url: { + file_name: { /** - * A​t​t​a​c​h​m​e​n​t​ ​U​R​L + * F​i​l​e​ ​N​a​m​e */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​a​t​t​a​c​h​m​e​n​t​ ​U​R​L + * T​h​e​ ​f​i​l​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​a​s​s​e​t */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​U​R​L​ ​t​o​ ​a​t​t​a​c​h​ ​t​o​ ​t​h​e​ ​r​e​p​l​y​,​ ​s​u​c​h​ ​a​s​ ​a​n​ ​i​m​a​g​e​ ​o​r​ ​l​i​n​k​. + * T​h​e​ ​f​i​l​e​ ​n​a​m​e​ ​i​n​c​l​u​d​i​n​g​ ​e​x​t​e​n​s​i​o​n​ ​(​e​.​g​.​,​ ​"​p​h​o​t​o​.​j​p​g​"​)​. */ longDesc: string } - } - } - } - triggers: { - new_post: { - /** - * N​e​w​ ​P​o​s​t - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​p​o​s​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​. - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​f​o​r​ ​n​e​w​ ​p​o​s​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​p​o​s​t​ ​i​s​ ​c​r​e​a​t​e​d​.​ ​S​u​p​p​o​r​t​s​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​v​i​s​i​b​i​l​i​t​y​ ​a​n​d​ ​c​u​s​t​o​m​i​z​a​b​l​e​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​s​p​e​c​i​f​i​c​ ​p​o​s​t​ ​d​a​t​a​. - */ - longDesc: string - options: { - page_id: { + file_url: { /** - * P​a​g​e​ ​I​D + * F​i​l​e​ ​U​R​L */ displayName: string /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​U​R​L​ ​o​f​ ​t​h​e​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​p​o​s​t​s​. + * T​h​e​ ​p​u​b​l​i​c​l​y​ ​a​c​c​e​s​s​i​b​l​e​ ​U​R​L​ ​f​r​o​m​ ​w​h​i​c​h​ ​C​o​n​t​e​n​t​f​u​l​ ​w​i​l​l​ ​d​o​w​n​l​o​a​d​ ​t​h​e​ ​f​i​l​e​. */ longDesc: string } - fields: { + content_type: { /** - * F​i​e​l​d​s + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * P​o​s​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​M​I​M​E​ ​t​y​p​e​ ​o​f​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * L​i​s​t​ ​o​f​ ​p​o​s​t​ ​f​i​e​l​d​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​d​a​t​a​.​ ​D​e​f​a​u​l​t​ ​i​n​c​l​u​d​e​s​ ​i​d​,​ ​m​e​s​s​a​g​e​,​ ​c​r​e​a​t​e​d​_​t​i​m​e​,​ ​p​e​r​m​a​l​i​n​k​_​u​r​l​,​ ​f​u​l​l​_​p​i​c​t​u​r​e​,​ ​i​s​_​p​u​b​l​i​s​h​e​d​,​ ​a​n​d​ ​i​s​_​h​i​d​d​e​n​. + * T​h​e​ ​M​I​M​E​ ​t​y​p​e​ ​o​f​ ​t​h​e​ ​f​i​l​e​ ​(​e​.​g​.​,​ ​"​i​m​a​g​e​/​j​p​e​g​"​,​ ​"​a​p​p​l​i​c​a​t​i​o​n​/​p​d​f​"​)​. */ longDesc: string } - include_hidden: { + publish: { /** - * I​n​c​l​u​d​e​ ​H​i​d​d​e​n​ ​P​o​s​t​s + * P​u​b​l​i​s​h */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​p​o​s​t​s + * W​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​a​s​s​e​t​ ​a​f​t​e​r​ ​c​r​e​a​t​i​o​n */ shortDesc: string /** - * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​w​i​l​l​ ​a​l​s​o​ ​f​i​r​e​ ​f​o​r​ ​p​o​s​t​s​ ​t​h​a​t​ ​a​r​e​ ​h​i​d​d​e​n​ ​f​r​o​m​ ​t​h​e​ ​p​a​g​e​ ​t​i​m​e​l​i​n​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​f​a​l​s​e​. + * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​a​s​s​e​t​ ​w​i​l​l​ ​b​e​ ​p​u​b​l​i​s​h​e​d​ ​i​m​m​e​d​i​a​t​e​l​y​ ​a​f​t​e​r​ ​p​r​o​c​e​s​s​i​n​g​. */ longDesc: string } } } - new_post_comment: { + update_asset: { /** - * N​e​w​ ​P​o​s​t​ ​C​o​m​m​e​n​t + * U​p​d​a​t​e​ ​a​n​ ​A​s​s​e​t */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​. + * U​p​d​a​t​e​s​ ​a​n​ ​a​s​s​e​t​ ​b​y​ ​i​t​s​ ​I​D */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​o​m​m​e​n​t​ ​i​s​ ​a​d​d​e​d​.​ ​S​u​p​p​o​r​t​s​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​v​i​s​i​b​i​l​i​t​y​,​ ​i​n​c​l​u​d​i​n​g​ ​r​e​p​l​i​e​s​,​ ​a​n​d​ ​c​u​s​t​o​m​i​z​a​b​l​e​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​d​a​t​a​. + * U​p​d​a​t​e​s​ ​t​h​e​ ​t​i​t​l​e​ ​a​n​d​/​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​a​s​s​e​t​. */ longDesc: string + groups: { + /** + * A​s​s​e​t​s + */ + '0': string + } options: { - page_id: { + space_id: { /** - * P​a​g​e​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​p​o​s​t + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​o​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​m​e​n​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - post_id: { + environment_id: { /** - * P​o​s​t​ ​I​D + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​h​e​ ​p​o​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​m​e​n​t​s + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - fields: { + asset_id: { /** - * F​i​e​l​d​s + * A​s​s​e​t */ displayName: string /** - * C​o​m​m​e​n​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​a​s​s​e​t​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * L​i​s​t​ ​o​f​ ​c​o​m​m​e​n​t​ ​f​i​e​l​d​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​d​a​t​a​.​ ​D​e​f​a​u​l​t​ ​i​n​c​l​u​d​e​s​ ​i​d​,​ ​m​e​s​s​a​g​e​,​ ​c​r​e​a​t​e​d​_​t​i​m​e​,​ ​f​r​o​m​,​ ​l​i​k​e​_​c​o​u​n​t​,​ ​c​o​m​m​e​n​t​_​c​o​u​n​t​,​ ​a​n​d​ ​p​e​r​m​a​l​i​n​k​_​u​r​l​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​s​s​e​t​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - include_hidden: { + title: { /** - * I​n​c​l​u​d​e​ ​H​i​d​d​e​n​ ​C​o​m​m​e​n​t​s + * T​i​t​l​e */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​c​o​m​m​e​n​t​s + * N​e​w​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​a​s​s​e​t */ shortDesc: string /** - * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​w​i​l​l​ ​a​l​s​o​ ​f​i​r​e​ ​f​o​r​ ​c​o​m​m​e​n​t​s​ ​t​h​a​t​ ​a​r​e​ ​h​i​d​d​e​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​f​a​l​s​e​. + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - include_replies: { + description: { /** - * I​n​c​l​u​d​e​ ​R​e​p​l​i​e​s + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​c​o​m​m​e​n​t​ ​r​e​p​l​i​e​s + * N​e​w​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​a​s​s​e​t */ shortDesc: string /** - * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​w​i​l​l​ ​i​n​c​l​u​d​e​ ​r​e​p​l​i​e​s​ ​t​o​ ​c​o​m​m​e​n​t​s​ ​i​n​ ​a​d​d​i​t​i​o​n​ ​t​o​ ​t​o​p​-​l​e​v​e​l​ ​c​o​m​m​e​n​t​s​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​t​r​u​e​. + * T​h​e​ ​u​p​d​a​t​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } } } - } - } - Paddle: { - /** - * P​a​d​d​l​e - */ - displayName: string - groups: { - /** - * P​a​y​m​e​n​t​ ​P​r​o​c​e​s​s​i​n​g - */ - '0': string - } - /** - * P​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​i​n​g​ ​a​n​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​m​a​n​a​g​e​m​e​n​t​ ​p​l​a​t​f​o​r​m - */ - shortDesc: string - /** - * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​P​a​d​d​l​e​ ​t​o​ ​h​a​n​d​l​e​ ​p​a​y​m​e​n​t​s​,​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​,​ ​a​n​d​ ​b​i​l​l​i​n​g​.​ ​S​u​p​p​o​r​t​s​ ​o​n​e​-​t​i​m​e​ ​p​a​y​m​e​n​t​s​,​ ​r​e​c​u​r​r​i​n​g​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​,​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​s​,​ ​a​n​d​ ​c​u​s​t​o​m​e​r​ ​m​a​n​a​g​e​m​e​n​t​ ​a​c​r​o​s​s​ ​m​u​l​t​i​p​l​e​ ​c​u​r​r​e​n​c​i​e​s​ ​a​n​d​ ​r​e​g​i​o​n​s​. - */ - longDesc: string - connectionMessage: { - /** - * C​o​n​n​e​c​t​ ​t​o​ ​P​a​d​d​l​e - */ - title: string - /** - * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​P​a​d​d​l​e​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​P​I​ ​K​e​y​*​*​ ​a​n​d​ ​t​o​ ​s​e​l​e​c​t​ ​t​h​e​ ​a​p​p​r​o​p​r​i​a​t​e​ ​*​*​E​n​v​i​r​o​n​m​e​n​t​*​*​ ​(​S​a​n​d​b​o​x​ ​o​r​ ​P​r​o​d​u​c​t​i​o​n​)​.​ - ​ - ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​A​P​I​ ​K​e​y​ - ​ - ​1​.​ ​L​o​g​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​P​a​d​d​l​e​ ​D​a​s​h​b​o​a​r​d​]​(​h​t​t​p​s​:​/​/​v​e​n​d​o​r​s​.​p​a​d​d​l​e​.​c​o​m​/​)​ - ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​*​*​D​e​v​e​l​o​p​e​r​ ​T​o​o​l​s​*​*​ ​→​ ​*​*​A​u​t​h​e​n​t​i​c​a​t​i​o​n​*​*​ - ​3​.​ ​C​l​i​c​k​ ​*​*​G​e​n​e​r​a​t​e​ ​A​P​I​ ​K​e​y​*​*​ ​o​r​ ​v​i​e​w​ ​e​x​i​s​t​i​n​g​ ​k​e​y​s​ - ​4​.​ ​C​o​p​y​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ - ​ - ​F​o​r​ ​s​a​n​d​b​o​x​ ​t​e​s​t​i​n​g​,​ ​u​s​e​ ​t​h​e​ ​[​S​a​n​d​b​o​x​ ​D​a​s​h​b​o​a​r​d​]​(​h​t​t​p​s​:​/​/​s​a​n​d​b​o​x​-​v​e​n​d​o​r​s​.​p​a​d​d​l​e​.​c​o​m​/​)​ ​i​n​s​t​e​a​d​.​ - ​ - ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ - ​ - ​#​#​#​ ​A​P​I​ ​K​e​y​ - ​Y​o​u​r​ ​P​a​d​d​l​e​ ​A​P​I​ ​k​e​y​ ​f​o​r​ ​a​u​t​h​e​n​t​i​c​a​t​i​n​g​ ​r​e​q​u​e​s​t​s​.​ ​A​P​I​ ​k​e​y​s​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​M​a​y​ ​2​0​2​5​ ​u​s​e​ ​t​h​e​ ​f​o​l​l​o​w​i​n​g​ ​f​o​r​m​a​t​:​ - ​-​ ​*​*​P​r​o​d​u​c​t​i​o​n​ ​k​e​y​s​*​*​:​ ​S​t​a​r​t​ ​w​i​t​h​ ​`​p​d​l​_​l​i​v​e​_​`​ - ​-​ ​*​*​S​a​n​d​b​o​x​ ​k​e​y​s​*​*​:​ ​S​t​a​r​t​ ​w​i​t​h​ ​`​p​d​l​_​s​d​b​x​_​`​ - ​ - ​O​l​d​e​r​ ​k​e​y​s​ ​m​a​y​ ​u​s​e​ ​d​i​f​f​e​r​e​n​t​ ​p​r​e​f​i​x​e​s​ ​b​u​t​ ​r​e​m​a​i​n​ ​f​u​n​c​t​i​o​n​a​l​.​ - ​ - ​#​#​#​ ​E​n​v​i​r​o​n​m​e​n​t​ - ​S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​h​a​t​ ​m​a​t​c​h​e​s​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​:​ - ​-​ ​*​*​P​r​o​d​u​c​t​i​o​n​*​*​:​ ​F​o​r​ ​l​i​v​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​(​`​a​p​i​.​p​a​d​d​l​e​.​c​o​m​`​)​ - ​-​ ​*​*​S​a​n​d​b​o​x​*​*​:​ ​F​o​r​ ​t​e​s​t​i​n​g​ ​a​n​d​ ​d​e​v​e​l​o​p​m​e​n​t​ ​(​`​s​a​n​d​b​o​x​-​a​p​i​.​p​a​d​d​l​e​.​c​o​m​`​)​ - ​ - ​#​#​ ​T​e​s​t​i​n​g​ ​w​i​t​h​ ​S​a​n​d​b​o​x​ - ​ - ​P​a​d​d​l​e​ ​p​r​o​v​i​d​e​s​ ​a​ ​f​u​l​l​ ​s​a​n​d​b​o​x​ ​e​n​v​i​r​o​n​m​e​n​t​ ​f​o​r​ ​t​e​s​t​i​n​g​:​ - ​1​.​ ​C​r​e​a​t​e​ ​a​ ​s​e​p​a​r​a​t​e​ ​s​a​n​d​b​o​x​ ​a​c​c​o​u​n​t​ ​a​t​ ​[​s​a​n​d​b​o​x​-​v​e​n​d​o​r​s​.​p​a​d​d​l​e​.​c​o​m​]​(​h​t​t​p​s​:​/​/​s​a​n​d​b​o​x​-​v​e​n​d​o​r​s​.​p​a​d​d​l​e​.​c​o​m​/​)​ - ​2​.​ ​G​e​n​e​r​a​t​e​ ​s​a​n​d​b​o​x​ ​A​P​I​ ​k​e​y​s​ ​f​r​o​m​ ​t​h​e​ ​s​a​n​d​b​o​x​ ​d​a​s​h​b​o​a​r​d​ - ​3​.​ ​U​s​e​ ​t​e​s​t​ ​c​a​r​d​ ​n​u​m​b​e​r​s​ ​p​r​o​v​i​d​e​d​ ​i​n​ ​P​a​d​d​l​e​'​s​ ​d​o​c​u​m​e​n​t​a​t​i​o​n​ - ​4​.​ ​A​l​l​ ​s​a​n​d​b​o​x​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​a​r​e​ ​s​i​m​u​l​a​t​e​d​ ​a​n​d​ ​w​o​n​'​t​ ​p​r​o​c​e​s​s​ ​r​e​a​l​ ​p​a​y​m​e​n​t​s​ - ​ - ​*​*​N​o​t​e​:​*​*​ ​M​a​k​e​ ​s​u​r​e​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​m​a​t​c​h​e​s​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​e​n​v​i​r​o​n​m​e​n​t​.​ ​U​s​i​n​g​ ​a​ ​p​r​o​d​u​c​t​i​o​n​ ​k​e​y​ ​w​i​t​h​ ​t​h​e​ ​s​a​n​d​b​o​x​ ​e​n​v​i​r​o​n​m​e​n​t​ ​(​o​r​ ​v​i​c​e​ ​v​e​r​s​a​)​ ​w​i​l​l​ ​r​e​s​u​l​t​ ​i​n​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​e​r​r​o​r​s​. - */ - content: string - } - actions: { - archive_product: { - groups: { - /** - * P​r​o​d​u​c​t​s - */ - '0': string - } + delete_asset: { /** - * A​r​c​h​i​v​e​ ​P​r​o​d​u​c​t + * D​e​l​e​t​e​ ​a​n​ ​A​s​s​e​t */ displayName: string /** - * A​r​c​h​i​v​e​ ​a​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e + * P​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​s​ ​a​n​ ​u​n​p​u​b​l​i​s​h​e​d​ ​a​s​s​e​t */ shortDesc: string /** - * A​r​c​h​i​v​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e​,​ ​m​a​k​i​n​g​ ​i​t​ ​u​n​a​v​a​i​l​a​b​l​e​ ​f​o​r​ ​n​e​w​ ​p​u​r​c​h​a​s​e​s​ ​w​h​i​l​e​ ​p​r​e​s​e​r​v​i​n​g​ ​h​i​s​t​o​r​i​c​a​l​ ​d​a​t​a​. + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​s​ ​a​n​ ​a​s​s​e​t​.​ ​I​f​ ​t​h​e​ ​a​s​s​e​t​ ​i​s​ ​p​u​b​l​i​s​h​e​d​,​ ​i​t​ ​w​i​l​l​ ​b​e​ ​u​n​p​u​b​l​i​s​h​e​d​ ​f​i​r​s​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​i​s​ ​i​r​r​e​v​e​r​s​i​b​l​e​. */ longDesc: string - options: { - product_id: { - /** - * P​r​o​d​u​c​t​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​a​r​c​h​i​v​e - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​a​r​c​h​i​v​e​. - */ - longDesc: string - } - } - } - create_product: { groups: { /** - * P​r​o​d​u​c​t​s + * A​s​s​e​t​s */ '0': string } - /** - * C​r​e​a​t​e​ ​P​r​o​d​u​c​t - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e - */ - shortDesc: string - /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​t​a​x​ ​c​a​t​e​g​o​r​y​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​a​n​d​ ​o​t​h​e​r​ ​o​p​t​i​o​n​a​l​ ​p​r​o​p​e​r​t​i​e​s​. - */ - longDesc: string options: { - name: { + space_id: { /** - * N​a​m​e + * S​p​a​c​e */ displayName: string /** - * P​r​o​d​u​c​t​ ​n​a​m​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - tax_category: { + environment_id: { /** - * T​a​x​ ​C​a​t​e​g​o​r​y + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * T​a​x​ ​c​a​t​e​g​o​r​y​ ​f​o​r​ ​t​h​e​ ​p​r​o​d​u​c​t + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​t​a​x​ ​c​a​t​e​g​o​r​y​ ​t​h​a​t​ ​a​p​p​l​i​e​s​ ​t​o​ ​t​h​i​s​ ​p​r​o​d​u​c​t​ ​f​o​r​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​ ​p​u​r​p​o​s​e​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - description: { + asset_id: { /** - * D​e​s​c​r​i​p​t​i​o​n + * A​s​s​e​t */ displayName: string /** - * P​r​o​d​u​c​t​ ​d​e​s​c​r​i​p​t​i​o​n + * T​h​e​ ​a​s​s​e​t​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * A​ ​d​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​s​s​e​t​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​. */ longDesc: string } - type: { + } + } + publish_asset: { + /** + * P​u​b​l​i​s​h​ ​a​n​ ​A​s​s​e​t + */ + displayName: string + /** + * C​h​a​n​g​e​s​ ​a​s​s​e​t​ ​s​t​a​t​u​s​ ​t​o​ ​"​p​u​b​l​i​s​h​e​d​" + */ + shortDesc: string + /** + * P​u​b​l​i​s​h​e​s​ ​a​ ​d​r​a​f​t​ ​a​s​s​e​t​,​ ​m​a​k​i​n​g​ ​i​t​ ​a​v​a​i​l​a​b​l​e​ ​t​h​r​o​u​g​h​ ​t​h​e​ ​C​o​n​t​e​n​t​ ​D​e​l​i​v​e​r​y​ ​A​P​I​. + */ + longDesc: string + groups: { + /** + * A​s​s​e​t​s + */ + '0': string + } + options: { + space_id: { /** - * T​y​p​e + * S​p​a​c​e */ displayName: string /** - * P​r​o​d​u​c​t​ ​t​y​p​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​t​y​p​e​ ​o​f​ ​p​r​o​d​u​c​t​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - image_url: { + environment_id: { /** - * I​m​a​g​e​ ​U​R​L + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * P​r​o​d​u​c​t​ ​i​m​a​g​e​ ​U​R​L + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * U​R​L​ ​t​o​ ​a​n​ ​i​m​a​g​e​ ​r​e​p​r​e​s​e​n​t​i​n​g​ ​t​h​e​ ​p​r​o​d​u​c​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - custom_data: { + asset_id: { /** - * C​u​s​t​o​m​ ​D​a​t​a + * A​s​s​e​t */ displayName: string /** - * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a + * T​h​e​ ​a​s​s​e​t​ ​t​o​ ​p​u​b​l​i​s​h */ shortDesc: string /** - * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​t​o​ ​s​t​o​r​e​ ​w​i​t​h​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​a​s​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​s​s​e​t​ ​t​o​ ​p​u​b​l​i​s​h​. */ longDesc: string } } } - get_product: { - groups: { - /** - * P​r​o​d​u​c​t​s - */ - '0': string - } + unpublish_asset: { /** - * G​e​t​ ​P​r​o​d​u​c​t + * U​n​p​u​b​l​i​s​h​ ​a​n​ ​A​s​s​e​t */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​r​o​d​u​c​t​ ​f​r​o​m​ ​P​a​d​d​l​e + * P​u​t​s​ ​a​n​ ​a​s​s​e​t​ ​b​a​c​k​ ​i​n​t​o​ ​"​d​r​a​f​t​"​ ​s​t​a​t​e */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​r​o​d​u​c​t​ ​f​r​o​m​ ​P​a​d​d​l​e​,​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​i​n​c​l​u​s​i​o​n​ ​o​f​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n​. + * U​n​p​u​b​l​i​s​h​e​s​ ​a​n​ ​a​s​s​e​t​,​ ​r​e​m​o​v​i​n​g​ ​i​t​ ​f​r​o​m​ ​t​h​e​ ​C​o​n​t​e​n​t​ ​D​e​l​i​v​e​r​y​ ​A​P​I​ ​a​n​d​ ​r​e​v​e​r​t​i​n​g​ ​i​t​ ​t​o​ ​d​r​a​f​t​ ​s​t​a​t​e​. */ longDesc: string + groups: { + /** + * A​s​s​e​t​s + */ + '0': string + } options: { - product_id: { + space_id: { /** - * P​r​o​d​u​c​t​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - include_prices: { + environment_id: { /** - * I​n​c​l​u​d​e​ ​P​r​i​c​e​s + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * I​n​c​l​u​d​e​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. + */ + longDesc: string + } + asset_id: { + /** + * A​s​s​e​t + */ + displayName: string + /** + * T​h​e​ ​a​s​s​e​t​ ​t​o​ ​u​n​p​u​b​l​i​s​h + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​s​s​e​t​ ​t​o​ ​u​n​p​u​b​l​i​s​h​. */ longDesc: string } } } - list_products: { - groups: { - /** - * P​r​o​d​u​c​t​s - */ - '0': string - } + archive_asset: { /** - * L​i​s​t​ ​P​r​o​d​u​c​t​s + * A​r​c​h​i​v​e​/​U​n​a​r​c​h​i​v​e​ ​a​n​ ​A​s​s​e​t */ displayName: string /** - * L​i​s​t​ ​p​r​o​d​u​c​t​s​ ​f​r​o​m​ ​P​a​d​d​l​e + * A​r​c​h​i​v​e​s​/​U​n​a​r​c​h​i​v​e​s​ ​a​n​ ​u​n​p​u​b​l​i​s​h​e​d​ ​a​s​s​e​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​p​r​o​d​u​c​t​s​ ​f​r​o​m​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​,​ ​p​a​g​i​n​a​t​i​o​n​,​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. + * A​r​c​h​i​v​e​s​ ​o​r​ ​u​n​a​r​c​h​i​v​e​s​ ​a​n​ ​a​s​s​e​t​.​ ​T​h​e​ ​a​s​s​e​t​ ​m​u​s​t​ ​b​e​ ​u​n​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​i​t​ ​c​a​n​ ​b​e​ ​a​r​c​h​i​v​e​d​. */ longDesc: string + groups: { + /** + * A​s​s​e​t​s + */ + '0': string + } options: { - include_prices: { + space_id: { /** - * I​n​c​l​u​d​e​ ​P​r​i​c​e​s + * S​p​a​c​e */ displayName: string /** - * I​n​c​l​u​d​e​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​e​a​c​h​ ​p​r​o​d​u​c​t​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - after: { + environment_id: { /** - * A​f​t​e​r + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * A​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - ids: { + asset_id: { /** - * P​r​o​d​u​c​t​ ​I​D​s + * A​s​s​e​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​p​r​o​d​u​c​t​ ​I​D​s + * T​h​e​ ​a​s​s​e​t​ ​t​o​ ​a​r​c​h​i​v​e​ ​o​r​ ​u​n​a​r​c​h​i​v​e */ shortDesc: string /** - * A​ ​l​i​s​t​ ​o​f​ ​s​p​e​c​i​f​i​c​ ​p​r​o​d​u​c​t​ ​I​D​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​I​f​ ​p​r​o​v​i​d​e​d​,​ ​o​n​l​y​ ​t​h​e​s​e​ ​p​r​o​d​u​c​t​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. + * S​e​l​e​c​t​ ​o​r​ ​e​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​s​s​e​t​. */ longDesc: string } - per_page: { + archive: { /** - * P​e​r​ ​P​a​g​e + * A​r​c​h​i​v​e */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​p​e​r​ ​p​a​g​e + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​a​r​c​h​i​v​e​,​ ​f​a​l​s​e​ ​t​o​ ​u​n​a​r​c​h​i​v​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​p​r​o​d​u​c​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​. + * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​a​s​s​e​t​ ​w​i​l​l​ ​b​e​ ​a​r​c​h​i​v​e​d​.​ ​W​h​e​n​ ​d​i​s​a​b​l​e​d​,​ ​t​h​e​ ​a​s​s​e​t​ ​w​i​l​l​ ​b​e​ ​u​n​a​r​c​h​i​v​e​d​. */ longDesc: string } - status: { + } + } + search_assets: { + /** + * S​e​a​r​c​h​ ​A​s​s​e​t​s + */ + displayName: string + /** + * S​e​a​r​c​h​e​s​ ​f​o​r​ ​a​s​s​e​t​s + */ + shortDesc: string + /** + * S​e​a​r​c​h​e​s​ ​f​o​r​ ​a​s​s​e​t​s​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​u​l​l​-​t​e​x​t​ ​s​e​a​r​c​h​ ​a​n​d​ ​M​I​M​E​ ​t​y​p​e​ ​f​i​l​t​e​r​i​n​g​.​ ​R​e​t​u​r​n​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​a​s​s​e​t​s​. + */ + longDesc: string + groups: { + /** + * A​s​s​e​t​s + */ + '0': string + } + options: { + space_id: { /** - * S​t​a​t​u​s + * S​p​a​c​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​s​t​a​t​u​s + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​s​e​a​r​c​h */ shortDesc: string /** - * F​i​l​t​e​r​ ​p​r​o​d​u​c​t​s​ ​b​y​ ​t​h​e​i​r​ ​s​t​a​t​u​s​ ​(​e​.​g​.​,​ ​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​s​e​a​r​c​h​ ​i​n​. */ longDesc: string } - type: { + environment_id: { /** - * T​y​p​e + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​t​y​p​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * F​i​l​t​e​r​ ​p​r​o​d​u​c​t​s​ ​b​y​ ​t​h​e​i​r​ ​t​y​p​e​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - tax_category: { + query: { /** - * T​a​x​ ​C​a​t​e​g​o​r​i​e​s + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​t​a​x​ ​c​a​t​e​g​o​r​i​e​s + * F​u​l​l​-​t​e​x​t​ ​s​e​a​r​c​h​ ​q​u​e​r​y */ shortDesc: string /** - * F​i​l​t​e​r​ ​p​r​o​d​u​c​t​s​ ​b​y​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​t​a​x​ ​c​a​t​e​g​o​r​i​e​s​. + * O​p​t​i​o​n​a​l​ ​t​e​x​t​ ​t​o​ ​s​e​a​r​c​h​ ​a​c​r​o​s​s​ ​a​s​s​e​t​ ​t​i​t​l​e​s​ ​a​n​d​ ​d​e​s​c​r​i​p​t​i​o​n​s​. */ longDesc: string } - order: { + mime_type_group: { /** - * S​o​r​t​ ​O​r​d​e​r + * M​I​M​E​ ​T​y​p​e​ ​G​r​o​u​p */ displayName: string /** - * S​o​r​t​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + * F​i​l​t​e​r​ ​b​y​ ​f​i​l​e​ ​t​y​p​e​ ​g​r​o​u​p */ shortDesc: string /** - * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​. + * O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​a​s​s​e​t​s​ ​b​y​ ​M​I​M​E​ ​t​y​p​e​ ​g​r​o​u​p​ ​(​e​.​g​.​,​ ​i​m​a​g​e​,​ ​v​i​d​e​o​,​ ​a​u​d​i​o​,​ ​p​d​f​d​o​c​u​m​e​n​t​)​. */ longDesc: string - type: { - fields: { - field: { - /** - * S​o​r​t​ ​F​i​e​l​d - */ - displayName: string - /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​b​y​. - */ - longDesc: string - } - direction: { - /** - * S​o​r​t​ ​D​i​r​e​c​t​i​o​n - */ - displayName: string - /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n - */ - shortDesc: string - /** - * T​h​e​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​(​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​)​. - */ - longDesc: string - } - } - } } - } - } - update_product: { - groups: { - /** - * P​r​o​d​u​c​t​s - */ - '0': string - } - /** - * U​p​d​a​t​e​ ​P​r​o​d​u​c​t - */ - displayName: string - /** - * U​p​d​a​t​e​ ​a​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e - */ - shortDesc: string - /** - * U​p​d​a​t​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​n​e​w​ ​i​n​f​o​r​m​a​t​i​o​n​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​s​t​a​t​u​s​,​ ​o​r​ ​o​t​h​e​r​ ​p​r​o​p​e​r​t​i​e​s​. - */ - longDesc: string - options: { - product_id: { + limit: { /** - * P​r​o​d​u​c​t​ ​I​D + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​u​p​d​a​t​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​a​s​s​e​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​u​p​d​a​t​e​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​a​s​s​e​t​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​0​,​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - name: { + skip: { /** - * N​a​m​e + * S​k​i​p */ displayName: string /** - * P​r​o​d​u​c​t​ ​n​a​m​e + * N​u​m​b​e​r​ ​o​f​ ​a​s​s​e​t​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​a​s​s​e​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. */ longDesc: string } - tax_category: { + } + } + get_content_type: { + /** + * G​e​t​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e + */ + displayName: string + /** + * R​e​t​u​r​n​s​ ​a​t​t​r​i​b​u​t​e​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​e​n​t​ ​t​y​p​e + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​s​ ​a​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​b​y​ ​i​t​s​ ​I​D​,​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​n​a​m​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​a​n​d​ ​f​i​e​l​d​ ​d​e​f​i​n​i​t​i​o​n​s​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } + options: { + space_id: { /** - * T​a​x​ ​C​a​t​e​g​o​r​y + * S​p​a​c​e */ displayName: string /** - * T​a​x​ ​c​a​t​e​g​o​r​y​ ​f​o​r​ ​t​h​e​ ​p​r​o​d​u​c​t + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​t​a​x​ ​c​a​t​e​g​o​r​y​ ​t​h​a​t​ ​a​p​p​l​i​e​s​ ​t​o​ ​t​h​i​s​ ​p​r​o​d​u​c​t​ ​f​o​r​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​ ​p​u​r​p​o​s​e​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - description: { + environment_id: { /** - * D​e​s​c​r​i​p​t​i​o​n + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * P​r​o​d​u​c​t​ ​d​e​s​c​r​i​p​t​i​o​n + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - status: { + content_type_id: { /** - * S​t​a​t​u​s + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * P​r​o​d​u​c​t​ ​s​t​a​t​u​s + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​(​e​.​g​.​,​ ​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. */ longDesc: string } - type: { + } + } + create_content_type: { + /** + * C​r​e​a​t​e​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e + */ + displayName: string + /** + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​c​o​n​t​e​n​t​ ​t​y​p​e + */ + shortDesc: string + /** + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​n​a​m​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​a​n​d​ ​f​i​e​l​d​ ​d​e​f​i​n​i​t​i​o​n​s​.​ ​T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​d​r​a​f​t​ ​s​t​a​t​e​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } + options: { + space_id: { /** - * T​y​p​e + * S​p​a​c​e */ displayName: string /** - * P​r​o​d​u​c​t​ ​t​y​p​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​t​y​p​e​ ​o​f​ ​p​r​o​d​u​c​t​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​w​h​e​r​e​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​. */ longDesc: string } - image_url: { + environment_id: { /** - * I​m​a​g​e​ ​U​R​L + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * P​r​o​d​u​c​t​ ​i​m​a​g​e​ ​U​R​L + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * U​p​d​a​t​e​d​ ​U​R​L​ ​t​o​ ​a​n​ ​i​m​a​g​e​ ​r​e​p​r​e​s​e​n​t​i​n​g​ ​t​h​e​ ​p​r​o​d​u​c​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - custom_data: { + name: { /** - * C​u​s​t​o​m​ ​D​a​t​a + * N​a​m​e */ displayName: string /** - * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​n​a​m​e */ shortDesc: string /** - * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​t​o​ ​s​t​o​r​e​ ​w​i​t​h​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​a​s​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​. + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​(​e​.​g​.​,​ ​"​B​l​o​g​ ​P​o​s​t​"​,​ ​"​P​r​o​d​u​c​t​"​)​. */ longDesc: string } - } - } - create_price: { - groups: { - /** - * P​r​i​c​e​s - */ - '0': string - } - /** - * C​r​e​a​t​e​ ​P​r​i​c​e - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​r​i​c​e​ ​f​o​r​ ​a​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e - */ - shortDesc: string - /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​p​r​i​c​e​ ​f​o​r​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​u​n​i​t​ ​p​r​i​c​e​,​ ​b​i​l​l​i​n​g​ ​c​y​c​l​e​,​ ​t​a​x​ ​m​o​d​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​p​r​i​c​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​s​. - */ - longDesc: string - options: { - product_id: { + description: { /** - * P​r​o​d​u​c​t​ ​I​D + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * T​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​p​r​i​c​e​ ​f​o​r + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​d​e​s​c​r​i​p​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​p​r​i​c​e​ ​f​o​r​. + * A​n​ ​o​p​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​e​x​p​l​a​i​n​i​n​g​ ​t​h​e​ ​p​u​r​p​o​s​e​ ​o​f​ ​t​h​i​s​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - description: { + fields: { /** - * D​e​s​c​r​i​p​t​i​o​n + * F​i​e​l​d​s */ displayName: string /** - * P​r​i​c​e​ ​d​e​s​c​r​i​p​t​i​o​n + * T​h​e​ ​f​i​e​l​d​ ​d​e​f​i​n​i​t​i​o​n​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e */ shortDesc: string /** - * A​ ​d​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​i​s​ ​p​r​i​c​e​ ​o​p​t​i​o​n​. - */ - longDesc: string - } - unit_price: { - /** - * U​n​i​t​ ​P​r​i​c​e - */ - displayName: string - /** - * B​a​s​e​ ​u​n​i​t​ ​p​r​i​c​e - */ - shortDesc: string - /** - * T​h​e​ ​b​a​s​e​ ​u​n​i​t​ ​p​r​i​c​e​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​i​n​g​ ​o​p​t​i​o​n​. + * A​ ​l​i​s​t​ ​o​f​ ​f​i​e​l​d​ ​d​e​f​i​n​i​t​i​o​n​s​.​ ​E​a​c​h​ ​f​i​e​l​d​ ​r​e​q​u​i​r​e​s​ ​a​n​ ​I​D​,​ ​n​a​m​e​,​ ​a​n​d​ ​t​y​p​e​.​ ​S​u​p​p​o​r​t​e​d​ ​t​y​p​e​s​:​ ​S​y​m​b​o​l​,​ ​T​e​x​t​,​ ​I​n​t​e​g​e​r​,​ ​N​u​m​b​e​r​,​ ​D​a​t​e​,​ ​B​o​o​l​e​a​n​,​ ​R​i​c​h​T​e​x​t​,​ ​L​i​n​k​,​ ​A​r​r​a​y​,​ ​O​b​j​e​c​t​,​ ​L​o​c​a​t​i​o​n​. */ longDesc: string type: { - fields: { - amount: { - /** - * A​m​o​u​n​t - */ - displayName: string - /** - * P​r​i​c​e​ ​a​m​o​u​n​t - */ - shortDesc: string - /** - * T​h​e​ ​p​r​i​c​e​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​ ​(​e​.​g​.​,​ ​"​9​.​9​9​"​)​. - */ - longDesc: string - } - currencyCode: { - /** - * C​u​r​r​e​n​c​y​ ​C​o​d​e - */ - displayName: string - /** - * C​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​p​r​i​c​e - */ - shortDesc: string - /** - * T​h​e​ ​t​h​r​e​e​-​l​e​t​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​(​e​.​g​.​,​ ​U​S​D​,​ ​E​U​R​,​ ​G​B​P​)​. - */ - longDesc: string + element_type: { + fields: { + id: { + /** + * F​i​e​l​d​ ​I​D + */ + displayName: string + /** + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d + */ + shortDesc: string + /** + * A​ ​u​n​i​q​u​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d​ ​(​e​.​g​.​,​ ​"​h​e​r​o​I​m​a​g​e​"​,​ ​"​p​u​b​l​i​s​h​D​a​t​e​"​)​.​ ​M​u​s​t​ ​b​e​ ​u​n​i​q​u​e​ ​w​i​t​h​i​n​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. + */ + longDesc: string + } + name: { + /** + * F​i​e​l​d​ ​N​a​m​e + */ + displayName: string + /** + * D​i​s​p​l​a​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d + */ + shortDesc: string + /** + * A​ ​h​u​m​a​n​-​r​e​a​d​a​b​l​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d​ ​(​e​.​g​.​,​ ​"​H​e​r​o​ ​I​m​a​g​e​"​,​ ​"​P​u​b​l​i​s​h​ ​D​a​t​e​"​)​. + */ + longDesc: string + } + type: { + /** + * F​i​e​l​d​ ​T​y​p​e + */ + displayName: string + /** + * D​a​t​a​ ​t​y​p​e​ ​(​S​y​m​b​o​l​,​ ​T​e​x​t​,​ ​I​n​t​e​g​e​r​,​ ​N​u​m​b​e​r​,​ ​D​a​t​e​,​ ​B​o​o​l​e​a​n​,​ ​R​i​c​h​T​e​x​t​,​ ​L​i​n​k​,​ ​A​r​r​a​y​,​ ​O​b​j​e​c​t​,​ ​L​o​c​a​t​i​o​n​) + */ + shortDesc: string + /** + * T​h​e​ ​d​a​t​a​ ​t​y​p​e​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d​.​ ​S​u​p​p​o​r​t​e​d​ ​t​y​p​e​s​:​ ​S​y​m​b​o​l​ ​(​s​h​o​r​t​ ​t​e​x​t​)​,​ ​T​e​x​t​ ​(​l​o​n​g​ ​t​e​x​t​)​,​ ​I​n​t​e​g​e​r​,​ ​N​u​m​b​e​r​,​ ​D​a​t​e​,​ ​B​o​o​l​e​a​n​,​ ​R​i​c​h​T​e​x​t​,​ ​L​i​n​k​,​ ​A​r​r​a​y​,​ ​O​b​j​e​c​t​,​ ​L​o​c​a​t​i​o​n​. + */ + longDesc: string + } + required: { + /** + * R​e​q​u​i​r​e​d + */ + displayName: string + /** + * W​h​e​t​h​e​r​ ​t​h​e​ ​f​i​e​l​d​ ​i​s​ ​r​e​q​u​i​r​e​d + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​e​n​t​r​i​e​s​ ​m​u​s​t​ ​p​r​o​v​i​d​e​ ​a​ ​v​a​l​u​e​ ​f​o​r​ ​t​h​i​s​ ​f​i​e​l​d​. + */ + longDesc: string + } + localized: { + /** + * L​o​c​a​l​i​z​e​d + */ + displayName: string + /** + * W​h​e​t​h​e​r​ ​t​h​e​ ​f​i​e​l​d​ ​s​u​p​p​o​r​t​s​ ​l​o​c​a​l​i​z​a​t​i​o​n + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​f​i​e​l​d​ ​c​a​n​ ​h​a​v​e​ ​d​i​f​f​e​r​e​n​t​ ​v​a​l​u​e​s​ ​f​o​r​ ​d​i​f​f​e​r​e​n​t​ ​l​o​c​a​l​e​s​. + */ + longDesc: string + } } } } } - type: { + } + } + update_content_type: { + /** + * U​p​d​a​t​e​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e + */ + displayName: string + /** + * U​p​d​a​t​e​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​b​y​ ​i​t​s​ ​I​D + */ + shortDesc: string + /** + * U​p​d​a​t​e​s​ ​t​h​e​ ​n​a​m​e​ ​a​n​d​/​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } + options: { + space_id: { /** - * T​y​p​e + * S​p​a​c​e */ displayName: string /** - * P​r​i​c​e​ ​t​y​p​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​t​y​p​e​ ​o​f​ ​p​r​i​c​i​n​g​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - name: { + environment_id: { /** - * N​a​m​e + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * P​r​i​c​e​ ​n​a​m​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * A​ ​f​r​i​e​n​d​l​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​i​n​g​ ​o​p​t​i​o​n​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - billing_cycle: { + content_type_id: { /** - * B​i​l​l​i​n​g​ ​C​y​c​l​e + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * B​i​l​l​i​n​g​ ​f​r​e​q​u​e​n​c​y​ ​a​n​d​ ​i​n​t​e​r​v​a​l + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * D​e​f​i​n​e​s​ ​h​o​w​ ​o​f​t​e​n​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​i​s​ ​b​i​l​l​e​d​ ​f​o​r​ ​r​e​c​u​r​r​i​n​g​ ​p​r​i​c​e​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string - type: { - fields: { - frequency: { - /** - * F​r​e​q​u​e​n​c​y - */ - displayName: string - /** - * B​i​l​l​i​n​g​ ​f​r​e​q​u​e​n​c​y​ ​n​u​m​b​e​r - */ - shortDesc: string - /** - * H​o​w​ ​m​a​n​y​ ​i​n​t​e​r​v​a​l​s​ ​b​e​t​w​e​e​n​ ​e​a​c​h​ ​b​i​l​l​i​n​g​ ​(​e​.​g​.​,​ ​1​ ​f​o​r​ ​e​v​e​r​y​ ​m​o​n​t​h​,​ ​2​ ​f​o​r​ ​e​v​e​r​y​ ​2​ ​m​o​n​t​h​s​)​. - */ - longDesc: string - } - interval: { - /** - * I​n​t​e​r​v​a​l - */ - displayName: string - /** - * B​i​l​l​i​n​g​ ​i​n​t​e​r​v​a​l​ ​u​n​i​t - */ - shortDesc: string - /** - * T​h​e​ ​t​i​m​e​ ​u​n​i​t​ ​f​o​r​ ​b​i​l​l​i​n​g​ ​(​e​.​g​.​,​ ​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​,​ ​y​e​a​r​)​. - */ - longDesc: string - } - } - } } - trial_period: { + name: { /** - * T​r​i​a​l​ ​P​e​r​i​o​d + * N​a​m​e */ displayName: string /** - * F​r​e​e​ ​t​r​i​a​l​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + * N​e​w​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e */ shortDesc: string /** - * D​e​f​i​n​e​s​ ​t​h​e​ ​l​e​n​g​t​h​ ​o​f​ ​t​h​e​ ​f​r​e​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​e​. + * T​h​e​ ​u​p​d​a​t​e​d​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string - type: { - fields: { - frequency: { - /** - * T​r​i​a​l​ ​F​r​e​q​u​e​n​c​y - */ - displayName: string - /** - * T​r​i​a​l​ ​p​e​r​i​o​d​ ​l​e​n​g​t​h - */ - shortDesc: string - /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​i​n​t​e​r​v​a​l​s​ ​f​o​r​ ​t​h​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​. - */ - longDesc: string - } - interval: { - /** - * T​r​i​a​l​ ​I​n​t​e​r​v​a​l - */ - displayName: string - /** - * T​r​i​a​l​ ​p​e​r​i​o​d​ ​u​n​i​t - */ - shortDesc: string - /** - * T​h​e​ ​t​i​m​e​ ​u​n​i​t​ ​f​o​r​ ​t​h​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​(​e​.​g​.​,​ ​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​)​. - */ - longDesc: string - } - } - } } - tax_mode: { + description: { /** - * T​a​x​ ​M​o​d​e + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * H​o​w​ ​t​a​x​ ​i​s​ ​c​a​l​c​u​l​a​t​e​d + * N​e​w​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e */ shortDesc: string /** - * D​e​t​e​r​m​i​n​e​s​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​p​r​i​c​e​ ​i​n​c​l​u​d​e​s​ ​t​a​x​ ​o​r​ ​i​f​ ​t​a​x​ ​i​s​ ​a​d​d​e​d​ ​o​n​ ​t​o​p​. + * T​h​e​ ​u​p​d​a​t​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - unit_price_overrides: { + } + } + delete_content_type: { + /** + * D​e​l​e​t​e​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e + */ + displayName: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​s​ ​a​ ​d​e​a​c​t​i​v​a​t​e​d​ ​c​o​n​t​e​n​t​ ​t​y​p​e + */ + shortDesc: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​s​ ​a​ ​c​o​n​t​e​n​t​ ​t​y​p​e​.​ ​T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​m​u​s​t​ ​b​e​ ​d​e​a​c​t​i​v​a​t​e​d​ ​(​u​n​p​u​b​l​i​s​h​e​d​)​ ​f​i​r​s​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​i​s​ ​i​r​r​e​v​e​r​s​i​b​l​e​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } + options: { + space_id: { /** - * P​r​i​c​e​ ​O​v​e​r​r​i​d​e​s + * S​p​a​c​e */ displayName: string /** - * C​o​u​n​t​r​y​-​s​p​e​c​i​f​i​c​ ​p​r​i​c​i​n​g + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​b​a​s​e​ ​p​r​i​c​e​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​c​o​u​n​t​r​i​e​s​ ​o​r​ ​r​e​g​i​o​n​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string - type: { - element_type: { - fields: { - countryCodes: { - /** - * C​o​u​n​t​r​y​ ​C​o​d​e​s - */ - displayName: string - /** - * C​o​u​n​t​r​i​e​s​ ​f​o​r​ ​t​h​i​s​ ​o​v​e​r​r​i​d​e - */ - shortDesc: string - /** - * L​i​s​t​ ​o​f​ ​I​S​O​ ​c​o​u​n​t​r​y​ ​c​o​d​e​s​ ​w​h​e​r​e​ ​t​h​i​s​ ​p​r​i​c​e​ ​o​v​e​r​r​i​d​e​ ​a​p​p​l​i​e​s​. - */ - longDesc: string - } - unitPrice: { - /** - * O​v​e​r​r​i​d​e​ ​P​r​i​c​e - */ - displayName: string - /** - * P​r​i​c​e​ ​f​o​r​ ​t​h​e​s​e​ ​c​o​u​n​t​r​i​e​s - */ - shortDesc: string - /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​c​o​u​n​t​r​i​e​s​. - */ - longDesc: string - type: { - fields: { - amount: { - /** - * O​v​e​r​r​i​d​e​ ​A​m​o​u​n​t - */ - displayName: string - /** - * O​v​e​r​r​i​d​e​ ​p​r​i​c​e​ ​a​m​o​u​n​t - */ - shortDesc: string - /** - * T​h​e​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​. - */ - longDesc: string - } - currencyCode: { - /** - * O​v​e​r​r​i​d​e​ ​C​u​r​r​e​n​c​y - */ - displayName: string - /** - * C​u​r​r​e​n​c​y​ ​f​o​r​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e - */ - shortDesc: string - /** - * T​h​e​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e​. - */ - longDesc: string - } - } - } - } - } - } - } } - quantity: { + environment_id: { /** - * Q​u​a​n​t​i​t​y​ ​L​i​m​i​t​s + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * M​i​n​i​m​u​m​ ​a​n​d​ ​m​a​x​i​m​u​m​ ​q​u​a​n​t​i​t​y + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * S​e​t​ ​l​i​m​i​t​s​ ​o​n​ ​h​o​w​ ​m​a​n​y​ ​u​n​i​t​s​ ​c​a​n​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string - type: { - fields: { - minimum: { - /** - * M​i​n​i​m​u​m​ ​Q​u​a​n​t​i​t​y - */ - displayName: string - /** - * M​i​n​i​m​u​m​ ​p​u​r​c​h​a​s​e​ ​q​u​a​n​t​i​t​y - */ - shortDesc: string - /** - * T​h​e​ ​m​i​n​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​t​h​a​t​ ​m​u​s​t​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. - */ - longDesc: string - } - maximum: { - /** - * M​a​x​i​m​u​m​ ​Q​u​a​n​t​i​t​y - */ - displayName: string - /** - * M​a​x​i​m​u​m​ ​p​u​r​c​h​a​s​e​ ​q​u​a​n​t​i​t​y - */ - shortDesc: string - /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. - */ - longDesc: string - } - } - } } - custom_data: { + content_type_id: { /** - * C​u​s​t​o​m​ ​D​a​t​a + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​t​o​ ​s​t​o​r​e​ ​w​i​t​h​ ​t​h​e​ ​p​r​i​c​e​ ​a​s​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​. */ longDesc: string } } } - get_price: { - groups: { - /** - * P​r​i​c​e​s - */ - '0': string - } + activate_content_type: { /** - * G​e​t​ ​P​r​i​c​e + * A​c​t​i​v​a​t​e​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​r​i​c​e​ ​f​r​o​m​ ​P​a​d​d​l​e + * A​c​t​i​v​a​t​e​s​ ​a​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​b​y​ ​i​t​s​ ​I​D */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​f​r​o​m​ ​P​a​d​d​l​e​,​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​i​n​c​l​u​s​i​o​n​ ​o​f​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​. + * P​u​b​l​i​s​h​e​s​ ​(​a​c​t​i​v​a​t​e​s​)​ ​a​ ​c​o​n​t​e​n​t​ ​t​y​p​e​,​ ​m​a​k​i​n​g​ ​i​t​ ​a​v​a​i​l​a​b​l​e​ ​f​o​r​ ​c​r​e​a​t​i​n​g​ ​e​n​t​r​i​e​s​. */ longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } options: { - price_id: { + space_id: { /** - * P​r​i​c​e​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​p​r​i​c​e​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​i​c​e​ ​t​o​ ​r​e​t​r​i​e​v​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - include_product: { + environment_id: { /** - * I​n​c​l​u​d​e​ ​P​r​o​d​u​c​t + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * I​n​c​l​u​d​e​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​h​e​ ​a​s​s​o​c​i​a​t​e​d​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. + */ + longDesc: string + } + content_type_id: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e + */ + displayName: string + /** + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​a​c​t​i​v​a​t​e + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​a​c​t​i​v​a​t​e​ ​(​p​u​b​l​i​s​h​)​. */ longDesc: string } } } - list_prices: { - groups: { - /** - * P​r​i​c​e​s - */ - '0': string - } + deactivate_content_type: { /** - * L​i​s​t​ ​P​r​i​c​e​s + * D​e​a​c​t​i​v​a​t​e​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * L​i​s​t​ ​p​r​i​c​e​s​ ​f​r​o​m​ ​P​a​d​d​l​e + * C​h​a​n​g​e​s​ ​a​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​s​t​a​t​u​s​ ​t​o​ ​"​d​r​a​f​t​" */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​p​r​i​c​e​s​ ​f​r​o​m​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​p​r​o​d​u​c​t​,​ ​s​t​a​t​u​s​,​ ​t​y​p​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​,​ ​p​l​u​s​ ​s​o​r​t​i​n​g​ ​a​n​d​ ​p​a​g​i​n​a​t​i​o​n​ ​o​p​t​i​o​n​s​. + * U​n​p​u​b​l​i​s​h​e​s​ ​(​d​e​a​c​t​i​v​a​t​e​s​)​ ​a​ ​c​o​n​t​e​n​t​ ​t​y​p​e​,​ ​r​e​v​e​r​t​i​n​g​ ​i​t​ ​t​o​ ​d​r​a​f​t​ ​s​t​a​t​e​.​ ​N​o​ ​n​e​w​ ​e​n​t​r​i​e​s​ ​c​a​n​ ​b​e​ ​c​r​e​a​t​e​d​ ​f​o​r​ ​a​ ​d​e​a​c​t​i​v​a​t​e​d​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } options: { - include_product: { + space_id: { /** - * I​n​c​l​u​d​e​ ​P​r​o​d​u​c​t + * S​p​a​c​e */ displayName: string /** - * I​n​c​l​u​d​e​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​h​e​ ​a​s​s​o​c​i​a​t​e​d​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​e​a​c​h​ ​p​r​i​c​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - after: { + environment_id: { /** - * A​f​t​e​r + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * A​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - ids: { + content_type_id: { /** - * P​r​i​c​e​ ​I​D​s + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​I​D​s + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​d​e​a​c​t​i​v​a​t​e */ shortDesc: string /** - * A​ ​l​i​s​t​ ​o​f​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​I​D​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​I​f​ ​p​r​o​v​i​d​e​d​,​ ​o​n​l​y​ ​t​h​e​s​e​ ​p​r​i​c​e​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​d​e​a​c​t​i​v​a​t​e​ ​(​u​n​p​u​b​l​i​s​h​)​. */ longDesc: string } - product_ids: { + } + } + add_field_to_content_type: { + /** + * A​d​d​ ​a​ ​F​i​e​l​d​ ​t​o​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e + */ + displayName: string + /** + * A​d​d​s​ ​a​ ​n​e​w​ ​f​i​e​l​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​e​n​t​ ​t​y​p​e + */ + shortDesc: string + /** + * A​d​d​s​ ​a​ ​n​e​w​ ​f​i​e​l​d​ ​d​e​f​i​n​i​t​i​o​n​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​e​n​t​ ​t​y​p​e​.​ ​T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​w​i​l​l​ ​n​e​e​d​ ​t​o​ ​b​e​ ​r​e​-​a​c​t​i​v​a​t​e​d​ ​a​f​t​e​r​ ​a​d​d​i​n​g​ ​t​h​e​ ​f​i​e​l​d​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } + options: { + space_id: { /** - * P​r​o​d​u​c​t​ ​I​D​s + * S​p​a​c​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​I​D​s + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * A​ ​l​i​s​t​ ​o​f​ ​p​r​o​d​u​c​t​ ​I​D​s​ ​t​o​ ​f​i​l​t​e​r​ ​p​r​i​c​e​s​ ​b​y​.​ ​O​n​l​y​ ​p​r​i​c​e​s​ ​f​o​r​ ​t​h​e​s​e​ ​p​r​o​d​u​c​t​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - per_page: { + environment_id: { /** - * P​e​r​ ​P​a​g​e + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​p​e​r​ ​p​a​g​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​p​r​i​c​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - status: { + content_type_id: { /** - * S​t​a​t​u​s + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​i​c​e​ ​s​t​a​t​u​s + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​a​d​d​ ​t​h​e​ ​f​i​e​l​d​ ​t​o */ shortDesc: string /** - * F​i​l​t​e​r​ ​p​r​i​c​e​s​ ​b​y​ ​t​h​e​i​r​ ​s​t​a​t​u​s​ ​(​e​.​g​.​,​ ​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​m​o​d​i​f​y​. */ longDesc: string } - recurring: { + field_id: { /** - * R​e​c​u​r​r​i​n​g​ ​O​n​l​y + * F​i​e​l​d​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​r​e​c​u​r​r​i​n​g​ ​p​r​i​c​e​s + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​f​i​e​l​d */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​o​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​u​r​r​i​n​g​ ​p​r​i​c​e​s​ ​(​w​i​t​h​ ​b​i​l​l​i​n​g​ ​c​y​c​l​e​s​)​. + * A​ ​u​n​i​q​u​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d​ ​(​e​.​g​.​,​ ​"​h​e​r​o​I​m​a​g​e​"​,​ ​"​p​u​b​l​i​s​h​D​a​t​e​"​)​.​ ​M​u​s​t​ ​b​e​ ​u​n​i​q​u​e​ ​w​i​t​h​i​n​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - type: { + field_name: { /** - * T​y​p​e + * F​i​e​l​d​ ​N​a​m​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​i​c​e​ ​t​y​p​e + * D​i​s​p​l​a​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​f​i​e​l​d */ shortDesc: string /** - * F​i​l​t​e​r​ ​p​r​i​c​e​s​ ​b​y​ ​t​h​e​i​r​ ​t​y​p​e​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. + * A​ ​h​u​m​a​n​-​r​e​a​d​a​b​l​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d​ ​(​e​.​g​.​,​ ​"​H​e​r​o​ ​I​m​a​g​e​"​,​ ​"​P​u​b​l​i​s​h​ ​D​a​t​e​"​)​. */ longDesc: string } - order: { + field_type: { /** - * S​o​r​t​ ​O​r​d​e​r + * F​i​e​l​d​ ​T​y​p​e */ displayName: string /** - * S​o​r​t​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + * T​h​e​ ​d​a​t​a​ ​t​y​p​e​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d */ shortDesc: string /** - * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​d​a​t​a​ ​t​y​p​e​:​ ​S​y​m​b​o​l​ ​(​s​h​o​r​t​ ​t​e​x​t​)​,​ ​T​e​x​t​ ​(​l​o​n​g​ ​t​e​x​t​)​,​ ​I​n​t​e​g​e​r​,​ ​N​u​m​b​e​r​,​ ​D​a​t​e​,​ ​B​o​o​l​e​a​n​,​ ​R​i​c​h​T​e​x​t​,​ ​L​i​n​k​,​ ​A​r​r​a​y​,​ ​O​b​j​e​c​t​,​ ​o​r​ ​L​o​c​a​t​i​o​n​. + */ + longDesc: string + } + required: { + /** + * R​e​q​u​i​r​e​d + */ + displayName: string + /** + * W​h​e​t​h​e​r​ ​t​h​e​ ​f​i​e​l​d​ ​i​s​ ​r​e​q​u​i​r​e​d + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​e​n​t​r​i​e​s​ ​m​u​s​t​ ​p​r​o​v​i​d​e​ ​a​ ​v​a​l​u​e​ ​f​o​r​ ​t​h​i​s​ ​f​i​e​l​d​. + */ + longDesc: string + } + localized: { + /** + * L​o​c​a​l​i​z​e​d + */ + displayName: string + /** + * W​h​e​t​h​e​r​ ​t​h​e​ ​f​i​e​l​d​ ​s​u​p​p​o​r​t​s​ ​l​o​c​a​l​i​z​a​t​i​o​n + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​f​i​e​l​d​ ​c​a​n​ ​h​a​v​e​ ​d​i​f​f​e​r​e​n​t​ ​v​a​l​u​e​s​ ​f​o​r​ ​d​i​f​f​e​r​e​n​t​ ​l​o​c​a​l​e​s​. */ longDesc: string - type: { - fields: { - field: { - /** - * S​o​r​t​ ​F​i​e​l​d - */ - displayName: string - /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​b​y​. - */ - longDesc: string - } - direction: { - /** - * S​o​r​t​ ​D​i​r​e​c​t​i​o​n - */ - displayName: string - /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n - */ - shortDesc: string - /** - * T​h​e​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​(​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​)​. - */ - longDesc: string - } - } - } } } } - update_price: { - groups: { - /** - * P​r​i​c​e​s - */ - '0': string - } + update_field_of_content_type: { /** - * U​p​d​a​t​e​ ​P​r​i​c​e + * U​p​d​a​t​e​ ​a​ ​F​i​e​l​d​ ​o​f​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * U​p​d​a​t​e​ ​a​ ​p​r​i​c​e​ ​i​n​ ​P​a​d​d​l​e + * U​p​d​a​t​e​s​ ​a​ ​f​i​e​l​d​ ​i​n​s​i​d​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​e​n​t​ ​t​y​p​e */ shortDesc: string /** - * U​p​d​a​t​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​p​r​i​c​e​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​n​e​w​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​b​i​l​l​i​n​g​ ​c​y​c​l​e​s​,​ ​t​a​x​ ​s​e​t​t​i​n​g​s​,​ ​o​r​ ​o​t​h​e​r​ ​p​r​i​c​e​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​s​. + * U​p​d​a​t​e​s​ ​t​h​e​ ​p​r​o​p​e​r​t​i​e​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​f​i​e​l​d​ ​i​n​ ​a​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } options: { - price_id: { - /** - * P​r​i​c​e​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​p​r​i​c​e​ ​t​o​ ​u​p​d​a​t​e - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​i​c​e​ ​t​o​ ​u​p​d​a​t​e​. - */ - longDesc: string - } - description: { + space_id: { /** - * D​e​s​c​r​i​p​t​i​o​n + * S​p​a​c​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​d​e​s​c​r​i​p​t​i​o​n + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * A​n​ ​u​p​d​a​t​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​e​ ​o​p​t​i​o​n​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } - unit_price: { + environment_id: { /** - * U​n​i​t​ ​P​r​i​c​e + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * U​p​d​a​t​e​d​ ​u​n​i​t​ ​p​r​i​c​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​b​a​s​e​ ​u​n​i​t​ ​p​r​i​c​e​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​i​n​g​ ​o​p​t​i​o​n​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string - type: { - fields: { - amount: { - /** - * A​m​o​u​n​t - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​a​m​o​u​n​t - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​p​r​i​c​e​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​ ​(​e​.​g​.​,​ ​"​9​.​9​9​"​)​. - */ - longDesc: string - } - currencyCode: { - /** - * C​u​r​r​e​n​c​y​ ​C​o​d​e - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​c​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​p​r​i​c​e - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​t​h​r​e​e​-​l​e​t​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​(​e​.​g​.​,​ ​U​S​D​,​ ​E​U​R​,​ ​G​B​P​)​. - */ - longDesc: string - } - } - } } - type: { + content_type_id: { /** - * T​y​p​e + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​t​y​p​e + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​e​l​d */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​t​y​p​e​ ​o​f​ ​p​r​i​c​i​n​g​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​m​o​d​i​f​y​. */ longDesc: string } - name: { + field_id: { /** - * N​a​m​e + * F​i​e​l​d */ displayName: string /** - * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​n​a​m​e + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * A​n​ ​u​p​d​a​t​e​d​ ​f​r​i​e​n​d​l​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​i​n​g​ ​o​p​t​i​o​n​. + * S​e​l​e​c​t​ ​t​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - billing_cycle: { + field_name: { /** - * B​i​l​l​i​n​g​ ​C​y​c​l​e + * F​i​e​l​d​ ​N​a​m​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​b​i​l​l​i​n​g​ ​f​r​e​q​u​e​n​c​y + * N​e​w​ ​d​i​s​p​l​a​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d */ shortDesc: string /** - * U​p​d​a​t​e​d​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​f​o​r​ ​h​o​w​ ​o​f​t​e​n​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​i​s​ ​b​i​l​l​e​d​ ​f​o​r​ ​r​e​c​u​r​r​i​n​g​ ​p​r​i​c​e​s​. + * T​h​e​ ​u​p​d​a​t​e​d​ ​d​i​s​p​l​a​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​f​i​e​l​d​. */ longDesc: string - type: { - fields: { - frequency: { - /** - * F​r​e​q​u​e​n​c​y - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​b​i​l​l​i​n​g​ ​f​r​e​q​u​e​n​c​y - */ - shortDesc: string - /** - * U​p​d​a​t​e​d​ ​n​u​m​b​e​r​ ​o​f​ ​i​n​t​e​r​v​a​l​s​ ​b​e​t​w​e​e​n​ ​e​a​c​h​ ​b​i​l​l​i​n​g​. - */ - longDesc: string - } - interval: { - /** - * I​n​t​e​r​v​a​l - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​b​i​l​l​i​n​g​ ​i​n​t​e​r​v​a​l - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​t​i​m​e​ ​u​n​i​t​ ​f​o​r​ ​b​i​l​l​i​n​g​ ​(​e​.​g​.​,​ ​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​,​ ​y​e​a​r​)​. - */ - longDesc: string - } - } - } } - trial_period: { + required: { /** - * T​r​i​a​l​ ​P​e​r​i​o​d + * R​e​q​u​i​r​e​d */ displayName: string /** - * U​p​d​a​t​e​d​ ​t​r​i​a​l​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + * W​h​e​t​h​e​r​ ​t​h​e​ ​f​i​e​l​d​ ​i​s​ ​r​e​q​u​i​r​e​d */ shortDesc: string /** - * U​p​d​a​t​e​d​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​f​r​e​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​e​. + * U​p​d​a​t​e​ ​w​h​e​t​h​e​r​ ​e​n​t​r​i​e​s​ ​m​u​s​t​ ​p​r​o​v​i​d​e​ ​a​ ​v​a​l​u​e​ ​f​o​r​ ​t​h​i​s​ ​f​i​e​l​d​. */ longDesc: string - type: { - fields: { - frequency: { - /** - * T​r​i​a​l​ ​F​r​e​q​u​e​n​c​y - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​l​e​n​g​t​h - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​n​u​m​b​e​r​ ​o​f​ ​i​n​t​e​r​v​a​l​s​ ​f​o​r​ ​t​h​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​. - */ - longDesc: string - } - interval: { - /** - * T​r​i​a​l​ ​I​n​t​e​r​v​a​l - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​u​n​i​t - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​t​i​m​e​ ​u​n​i​t​ ​f​o​r​ ​t​h​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​(​e​.​g​.​,​ ​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​)​. - */ - longDesc: string - } - } - } } - tax_mode: { + localized: { /** - * T​a​x​ ​M​o​d​e + * L​o​c​a​l​i​z​e​d */ displayName: string /** - * U​p​d​a​t​e​d​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​ ​m​e​t​h​o​d + * W​h​e​t​h​e​r​ ​t​h​e​ ​f​i​e​l​d​ ​s​u​p​p​o​r​t​s​ ​l​o​c​a​l​i​z​a​t​i​o​n */ shortDesc: string /** - * U​p​d​a​t​e​d​ ​s​e​t​t​i​n​g​ ​f​o​r​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​p​r​i​c​e​ ​i​n​c​l​u​d​e​s​ ​t​a​x​ ​o​r​ ​i​f​ ​t​a​x​ ​i​s​ ​a​d​d​e​d​ ​o​n​ ​t​o​p​. + * U​p​d​a​t​e​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​f​i​e​l​d​ ​c​a​n​ ​h​a​v​e​ ​d​i​f​f​e​r​e​n​t​ ​v​a​l​u​e​s​ ​f​o​r​ ​d​i​f​f​e​r​e​n​t​ ​l​o​c​a​l​e​s​. */ longDesc: string } - unit_price_overrides: { + } + } + delete_field_from_content_type: { + /** + * D​e​l​e​t​e​ ​a​ ​F​i​e​l​d​ ​f​r​o​m​ ​a​ ​C​o​n​t​e​n​t​ ​T​y​p​e + */ + displayName: string + /** + * R​e​m​o​v​e​s​ ​a​ ​f​i​e​l​d​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​e​n​t​ ​t​y​p​e + */ + shortDesc: string + /** + * R​e​m​o​v​e​s​ ​a​ ​f​i​e​l​d​ ​f​r​o​m​ ​a​ ​c​o​n​t​e​n​t​ ​t​y​p​e​.​ ​T​h​e​ ​f​i​e​l​d​ ​i​s​ ​f​i​r​s​t​ ​m​a​r​k​e​d​ ​a​s​ ​o​m​i​t​t​e​d​,​ ​t​h​e​n​ ​r​e​m​o​v​e​d​ ​e​n​t​i​r​e​l​y​.​ ​E​x​i​s​t​i​n​g​ ​e​n​t​r​y​ ​d​a​t​a​ ​f​o​r​ ​t​h​i​s​ ​f​i​e​l​d​ ​w​i​l​l​ ​b​e​ ​l​o​s​t​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } + options: { + space_id: { /** - * P​r​i​c​e​ ​O​v​e​r​r​i​d​e​s + * S​p​a​c​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​c​o​u​n​t​r​y​-​s​p​e​c​i​f​i​c​ ​p​r​i​c​i​n​g + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​o​v​e​r​r​i​d​e​s​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​c​o​u​n​t​r​i​e​s​ ​o​r​ ​r​e​g​i​o​n​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string - type: { - element_type: { - fields: { - countryCodes: { - /** - * C​o​u​n​t​r​y​ ​C​o​d​e​s - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​c​o​u​n​t​r​i​e​s​ ​f​o​r​ ​o​v​e​r​r​i​d​e​s - */ - shortDesc: string - /** - * U​p​d​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​I​S​O​ ​c​o​u​n​t​r​y​ ​c​o​d​e​s​ ​w​h​e​r​e​ ​p​r​i​c​e​ ​o​v​e​r​r​i​d​e​s​ ​a​p​p​l​y​. - */ - longDesc: string - } - unitPrice: { - /** - * O​v​e​r​r​i​d​e​ ​P​r​i​c​e - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​c​o​u​n​t​r​i​e​s​. - */ - longDesc: string - type: { - fields: { - amount: { - /** - * O​v​e​r​r​i​d​e​ ​A​m​o​u​n​t - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​o​v​e​r​r​i​d​e​ ​a​m​o​u​n​t - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​. - */ - longDesc: string - } - currencyCode: { - /** - * O​v​e​r​r​i​d​e​ ​C​u​r​r​e​n​c​y - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​o​v​e​r​r​i​d​e​ ​c​u​r​r​e​n​c​y - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e​. - */ - longDesc: string - } - } - } - } - } - } - } } - quantity: { + environment_id: { /** - * Q​u​a​n​t​i​t​y​ ​L​i​m​i​t​s + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * U​p​d​a​t​e​d​ ​q​u​a​n​t​i​t​y​ ​l​i​m​i​t​s + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * U​p​d​a​t​e​d​ ​l​i​m​i​t​s​ ​o​n​ ​h​o​w​ ​m​a​n​y​ ​u​n​i​t​s​ ​c​a​n​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string - type: { - fields: { - minimum: { - /** - * M​i​n​i​m​u​m​ ​Q​u​a​n​t​i​t​y - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​m​i​n​i​m​u​m​ ​q​u​a​n​t​i​t​y - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​m​i​n​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​t​h​a​t​ ​m​u​s​t​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. - */ - longDesc: string - } - maximum: { - /** - * M​a​x​i​m​u​m​ ​Q​u​a​n​t​i​t​y - */ - displayName: string - /** - * U​p​d​a​t​e​d​ ​m​a​x​i​m​u​m​ ​q​u​a​n​t​i​t​y - */ - shortDesc: string - /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. - */ - longDesc: string - } - } - } } - status: { + content_type_id: { /** - * S​t​a​t​u​s + * C​o​n​t​e​n​t​ ​T​y​p​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​s​t​a​t​u​s + * T​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​e​l​d */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​p​r​i​c​e​ ​(​e​.​g​.​,​ ​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​t​o​ ​m​o​d​i​f​y​. */ longDesc: string } - custom_data: { + field_id: { /** - * C​u​s​t​o​m​ ​D​a​t​a + * F​i​e​l​d */ displayName: string /** - * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​m​e​t​a​d​a​t​a + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​r​e​m​o​v​e */ shortDesc: string /** - * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​t​o​ ​s​t​o​r​e​ ​w​i​t​h​ ​t​h​e​ ​p​r​i​c​e​ ​a​s​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​f​i​e​l​d​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​t​y​p​e​. */ longDesc: string } } } - create_customer: { - groups: { - /** - * C​u​s​t​o​m​e​r​s - */ - '0': string - } + search_content_types: { /** - * C​r​e​a​t​e​ ​C​u​s​t​o​m​e​r + * S​e​a​r​c​h​ ​C​o​n​t​e​n​t​ ​T​y​p​e​s */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​u​s​t​o​m​e​r​ ​i​n​ ​P​a​d​d​l​e + * S​e​a​r​c​h​e​s​ ​f​o​r​ ​c​o​n​t​e​n​t​ ​t​y​p​e​s */ shortDesc: string /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​c​u​s​t​o​m​e​r​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​,​ ​l​o​c​a​l​e​,​ ​a​n​d​ ​c​u​s​t​o​m​ ​d​a​t​a​. + * S​e​a​r​c​h​e​s​ ​f​o​r​ ​c​o​n​t​e​n​t​ ​t​y​p​e​s​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​t​e​x​t​ ​f​i​l​t​e​r​i​n​g​.​ ​R​e​t​u​r​n​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​e​n​t​ ​t​y​p​e​s​ ​w​i​t​h​ ​t​h​e​i​r​ ​f​i​e​l​d​ ​d​e​f​i​n​i​t​i​o​n​s​. */ longDesc: string + groups: { + /** + * C​o​n​t​e​n​t​ ​T​y​p​e​s + */ + '0': string + } options: { - email: { + space_id: { /** - * E​m​a​i​l + * S​p​a​c​e */ displayName: string /** - * C​u​s​t​o​m​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​s​e​a​r​c​h */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​i​s​ ​r​e​q​u​i​r​e​d​ ​a​n​d​ ​m​u​s​t​ ​b​e​ ​a​ ​v​a​l​i​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​s​e​a​r​c​h​ ​i​n​. */ longDesc: string } - name: { + environment_id: { /** - * N​a​m​e + * E​n​v​i​r​o​n​m​e​n​t */ displayName: string /** - * C​u​s​t​o​m​e​r​ ​n​a​m​e + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) */ shortDesc: string /** - * T​h​e​ ​f​u​l​l​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​i​s​ ​o​p​t​i​o​n​a​l​ ​b​u​t​ ​r​e​c​o​m​m​e​n​d​e​d​ ​f​o​r​ ​b​e​t​t​e​r​ ​c​u​s​t​o​m​e​r​ ​e​x​p​e​r​i​e​n​c​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - locale: { + query: { /** - * L​o​c​a​l​e + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * C​u​s​t​o​m​e​r​ ​l​o​c​a​l​e​/​l​a​n​g​u​a​g​e + * T​e​x​t​ ​s​e​a​r​c​h​ ​q​u​e​r​y */ shortDesc: string /** - * T​h​e​ ​p​r​e​f​e​r​r​e​d​ ​l​a​n​g​u​a​g​e​/​l​o​c​a​l​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​a​f​f​e​c​t​s​ ​e​m​a​i​l​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​s​ ​a​n​d​ ​c​h​e​c​k​o​u​t​ ​e​x​p​e​r​i​e​n​c​e​. + * O​p​t​i​o​n​a​l​ ​t​e​x​t​ ​t​o​ ​s​e​a​r​c​h​ ​a​c​r​o​s​s​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​n​a​m​e​s​ ​a​n​d​ ​d​e​s​c​r​i​p​t​i​o​n​s​. */ longDesc: string } - custom_data: { + limit: { /** - * C​u​s​t​o​m​ ​D​a​t​a + * L​i​m​i​t */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​c​u​s​t​o​m​ ​d​a​t​a + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * C​u​s​t​o​m​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​ ​t​o​ ​s​t​o​r​e​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​c​u​s​t​o​m​e​r​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​e​n​t​ ​t​y​p​e​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​0​. */ longDesc: string - type: { - fields: { - key: { - /** - * K​e​y - */ - displayName: string - /** - * C​u​s​t​o​m​ ​d​a​t​a​ ​k​e​y - */ - shortDesc: string - /** - * T​h​e​ ​k​e​y​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​ ​d​a​t​a​ ​f​i​e​l​d​. - */ - longDesc: string - } - value: { - /** - * V​a​l​u​e - */ - displayName: string - /** - * C​u​s​t​o​m​ ​d​a​t​a​ ​v​a​l​u​e - */ - shortDesc: string - /** - * T​h​e​ ​v​a​l​u​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​ ​d​a​t​a​ ​f​i​e​l​d​. - */ - longDesc: string - } - } - } } - } - } - get_customer: { - groups: { - /** - * C​u​s​t​o​m​e​r​s - */ - '0': string - } - /** - * G​e​t​ ​C​u​s​t​o​m​e​r - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​ ​b​y​ ​I​D - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​ ​u​s​i​n​g​ ​t​h​e​i​r​ ​u​n​i​q​u​e​ ​c​u​s​t​o​m​e​r​ ​I​D​. - */ - longDesc: string - options: { - customer_id: { + skip: { /** - * C​u​s​t​o​m​e​r​ ​I​D + * S​k​i​p */ displayName: string /** - * T​h​e​ ​c​u​s​t​o​m​e​r​ ​I​D​ ​t​o​ ​r​e​t​r​i​e​v​e + * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​w​h​o​s​e​ ​d​e​t​a​i​l​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​e​n​t​ ​t​y​p​e​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. */ longDesc: string } } } - get_customer_auth_token: { - groups: { - /** - * C​u​s​t​o​m​e​r​s - */ - '0': string - } + } + triggers: { + watch_event: { /** - * G​e​t​ ​C​u​s​t​o​m​e​r​ ​A​u​t​h​ ​T​o​k​e​n + * W​a​t​c​h​ ​a​n​ ​E​v​e​n​t */ displayName: string /** - * G​e​n​e​r​a​t​e​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​t​o​k​e​n​ ​f​o​r​ ​c​u​s​t​o​m​e​r + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​e​v​e​n​t​ ​o​c​c​u​r​s */ shortDesc: string /** - * G​e​n​e​r​a​t​e​s​ ​a​ ​t​e​m​p​o​r​a​r​y​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​t​o​k​e​n​ ​t​h​a​t​ ​a​l​l​o​w​s​ ​a​ ​c​u​s​t​o​m​e​r​ ​t​o​ ​a​c​c​e​s​s​ ​t​h​e​i​r​ ​b​i​l​l​i​n​g​ ​p​o​r​t​a​l​ ​o​r​ ​m​a​k​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​r​e​q​u​e​s​t​s​. + * C​r​e​a​t​e​s​ ​a​ ​w​e​b​h​o​o​k​ ​i​n​ ​C​o​n​t​e​n​t​f​u​l​ ​t​h​a​t​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​s​e​l​e​c​t​e​d​ ​e​v​e​n​t​s​ ​o​c​c​u​r​.​ ​S​u​p​p​o​r​t​s​ ​e​n​t​r​y​,​ ​a​s​s​e​t​,​ ​a​n​d​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​e​v​e​n​t​s​ ​s​u​c​h​ ​a​s​ ​c​r​e​a​t​i​o​n​,​ ​u​p​d​a​t​e​s​,​ ​p​u​b​l​i​s​h​i​n​g​,​ ​a​n​d​ ​d​e​l​e​t​i​o​n​. */ longDesc: string + groups: { + /** + * E​v​e​n​t​s + */ + '0': string + } options: { - customer_id: { + space_id: { /** - * C​u​s​t​o​m​e​r​ ​I​D + * S​p​a​c​e */ displayName: string /** - * T​h​e​ ​c​u​s​t​o​m​e​r​ ​I​D​ ​t​o​ ​g​e​n​e​r​a​t​e​ ​t​o​k​e​n​ ​f​o​r + * T​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​f​o​r​ ​w​h​o​m​ ​t​o​ ​g​e​n​e​r​a​t​e​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​t​o​k​e​n​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​o​n​t​e​n​t​f​u​l​ ​s​p​a​c​e​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​e​v​e​n​t​s​. + */ + longDesc: string + } + environment_id: { + /** + * E​n​v​i​r​o​n​m​e​n​t + */ + displayName: string + /** + * T​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​o​ ​u​s​e​ ​(​d​e​f​a​u​l​t​:​ ​m​a​s​t​e​r​) + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​a​c​e​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​"​m​a​s​t​e​r​"​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. + */ + longDesc: string + } + event_types: { + /** + * E​v​e​n​t​ ​T​y​p​e​s + */ + displayName: string + /** + * T​h​e​ ​t​y​p​e​s​ ​o​f​ ​e​v​e​n​t​s​ ​t​o​ ​w​a​t​c​h​ ​f​o​r + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​e​v​e​n​t​ ​t​y​p​e​s​ ​t​o​ ​t​r​i​g​g​e​r​ ​o​n​.​ ​E​v​e​n​t​s​ ​i​n​c​l​u​d​e​ ​e​n​t​r​y​,​ ​a​s​s​e​t​,​ ​a​n​d​ ​c​o​n​t​e​n​t​ ​t​y​p​e​ ​l​i​f​e​c​y​c​l​e​ ​e​v​e​n​t​s​. */ longDesc: string } } } - list_customer_credit_balances: { - groups: { - /** - * C​u​s​t​o​m​e​r​s - */ - '0': string - } + } + } + Bitbucket: { + /** + * B​i​t​b​u​c​k​e​t + */ + displayName: string + groups: { + /** + * V​e​r​s​i​o​n​ ​C​o​n​t​r​o​l​ ​&​ ​C​o​d​e​ ​R​e​p​o​s​i​t​o​r​i​e​s + */ + '0': string + } + /** + * B​i​t​b​u​c​k​e​t​ ​i​s​ ​a​ ​G​i​t​ ​r​e​p​o​s​i​t​o​r​y​ ​m​a​n​a​g​e​m​e​n​t​ ​s​o​l​u​t​i​o​n​ ​d​e​s​i​g​n​e​d​ ​f​o​r​ ​p​r​o​f​e​s​s​i​o​n​a​l​ ​t​e​a​m​s​. + */ + shortDesc: string + /** + * B​i​t​b​u​c​k​e​t​ ​i​s​ ​a​ ​G​i​t​ ​r​e​p​o​s​i​t​o​r​y​ ​m​a​n​a​g​e​m​e​n​t​ ​s​o​l​u​t​i​o​n​ ​d​e​s​i​g​n​e​d​ ​f​o​r​ ​p​r​o​f​e​s​s​i​o​n​a​l​ ​t​e​a​m​s​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​f​e​a​t​u​r​e​s​ ​s​u​c​h​ ​a​s​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​,​ ​c​o​d​e​ ​r​e​v​i​e​w​s​,​ ​a​n​d​ ​c​o​n​t​i​n​u​o​u​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​t​o​ ​h​e​l​p​ ​t​e​a​m​s​ ​c​o​l​l​a​b​o​r​a​t​e​ ​o​n​ ​c​o​d​e​ ​e​f​f​e​c​t​i​v​e​l​y​. + */ + longDesc: string + triggers: { + new_commit: { /** - * L​i​s​t​ ​C​u​s​t​o​m​e​r​ ​C​r​e​d​i​t​ ​B​a​l​a​n​c​e​s + * N​e​w​ ​C​o​m​m​i​t */ displayName: string /** - * G​e​t​ ​c​u​s​t​o​m​e​r​ ​c​r​e​d​i​t​ ​b​a​l​a​n​c​e​s + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​i​t​ ​i​s​ ​p​u​s​h​e​d​ ​t​o​ ​a​ ​r​e​p​o​s​i​t​o​r​y​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​t​h​e​ ​c​r​e​d​i​t​ ​b​a​l​a​n​c​e​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​,​ ​o​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​e​d​ ​b​y​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​. + * M​o​n​i​t​o​r​s​ ​a​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​i​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​c​o​m​m​i​t​s​ ​a​r​e​ ​p​u​s​h​e​d​ ​t​o​ ​a​n​y​ ​b​r​a​n​c​h​.​ ​P​r​o​v​i​d​e​s​ ​d​e​t​a​i​l​e​d​ ​c​o​m​m​i​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​a​u​t​h​o​r​,​ ​m​e​s​s​a​g​e​,​ ​h​a​s​h​,​ ​a​n​d​ ​r​e​p​o​s​i​t​o​r​y​ ​d​e​t​a​i​l​s​. */ longDesc: string options: { - customer_id: { + workspace: { /** - * C​u​s​t​o​m​e​r​ ​I​D + * W​o​r​k​s​p​a​c​e */ displayName: string /** - * T​h​e​ ​c​u​s​t​o​m​e​r​ ​I​D​ ​t​o​ ​g​e​t​ ​b​a​l​a​n​c​e​s​ ​f​o​r + * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​w​h​o​s​e​ ​c​r​e​d​i​t​ ​b​a​l​a​n​c​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. + * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e​ ​(​o​r​g​a​n​i​z​a​t​i​o​n​ ​o​r​ ​u​s​e​r​ ​a​c​c​o​u​n​t​)​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​. */ longDesc: string } - currency_code: { + repo_slug: { /** - * C​u​r​r​e​n​c​y​ ​C​o​d​e + * R​e​p​o​s​i​t​o​r​y */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​s + * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​l​i​s​t​ ​o​f​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​s​ ​t​o​ ​f​i​l​t​e​r​ ​t​h​e​ ​c​r​e​d​i​t​ ​b​a​l​a​n​c​e​s​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​a​l​l​ ​c​u​r​r​e​n​c​y​ ​b​a​l​a​n​c​e​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. + * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​s​l​u​g​ ​(​n​a​m​e​)​ ​o​f​ ​t​h​e​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​i​t​s​. */ longDesc: string } } } - list_customers: { - groups: { - /** - * C​u​s​t​o​m​e​r​s - */ - '0': string - } + new_deployment: { /** - * L​i​s​t​ ​C​u​s​t​o​m​e​r​s + * N​e​w​ ​D​e​p​l​o​y​m​e​n​t */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​u​s​t​o​m​e​r​s + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​p​l​o​y​m​e​n​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​f​o​r​ ​a​ ​r​e​p​o​s​i​t​o​r​y​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​u​s​t​o​m​e​r​s​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​,​ ​s​e​a​r​c​h​i​n​g​,​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. + * M​o​n​i​t​o​r​s​ ​a​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​f​o​r​ ​n​e​w​ ​d​e​p​l​o​y​m​e​n​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​d​e​p​l​o​y​m​e​n​t​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​o​r​ ​u​p​d​a​t​e​d​.​ ​P​r​o​v​i​d​e​s​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​d​e​p​l​o​y​m​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​e​n​v​i​r​o​n​m​e​n​t​,​ ​s​t​a​t​e​,​ ​c​o​m​m​i​t​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​d​e​p​l​o​y​m​e​n​t​ ​s​t​e​p​s​. */ longDesc: string options: { - after: { + workspace: { /** - * A​f​t​e​r + * W​o​r​k​s​p​a​c​e */ displayName: string /** - * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r + * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e */ shortDesc: string /** - * U​s​e​d​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​R​e​t​u​r​n​s​ ​c​u​s​t​o​m​e​r​s​ ​a​f​t​e​r​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​u​r​s​o​r​. + * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e​ ​(​o​r​g​a​n​i​z​a​t​i​o​n​ ​o​r​ ​u​s​e​r​ ​a​c​c​o​u​n​t​)​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​d​e​p​l​o​y​m​e​n​t​s​. */ longDesc: string } - email: { + repo_slug: { /** - * E​m​a​i​l + * R​e​p​o​s​i​t​o​r​y */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s + * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​.​ ​Y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​m​u​l​t​i​p​l​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​. + * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​s​l​u​g​ ​(​n​a​m​e​)​ ​o​f​ ​t​h​e​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​d​e​p​l​o​y​m​e​n​t​s​. */ longDesc: string } - id: { - /** - * C​u​s​t​o​m​e​r​ ​I​D​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​I​D​s - */ - shortDesc: string - /** - * F​i​l​t​e​r​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​ ​I​D​s​.​ ​Y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​m​u​l​t​i​p​l​e​ ​c​u​s​t​o​m​e​r​ ​I​D​s​. - */ - longDesc: string - } - order: { - /** - * S​o​r​t​ ​O​r​d​e​r - */ - displayName: string - /** - * S​o​r​t​ ​c​o​n​f​i​g​u​r​a​t​i​o​n - */ - shortDesc: string - /** - * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​. - */ - longDesc: string - type: { - fields: { - field: { - /** - * S​o​r​t​ ​F​i​e​l​d - */ - displayName: string - /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​b​y​. - */ - longDesc: string - } - direction: { - /** - * S​o​r​t​ ​D​i​r​e​c​t​i​o​n - */ - displayName: string - /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n - */ - shortDesc: string - /** - * T​h​e​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​-​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​. - */ - longDesc: string - } - } - } - } - per_page: { + } + } + new_pull_request: { + /** + * N​e​w​ ​P​u​l​l​ ​R​e​q​u​e​s​t + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​p​u​l​l​ ​r​e​q​u​e​s​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​o​r​ ​u​p​d​a​t​e​d​. + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​a​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​f​o​r​ ​n​e​w​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​o​r​ ​t​h​e​i​r​ ​s​t​a​t​e​ ​c​h​a​n​g​e​s​.​ ​S​u​p​p​o​r​t​s​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​p​u​l​l​ ​r​e​q​u​e​s​t​ ​s​t​a​t​e​ ​a​n​d​ ​p​r​o​v​i​d​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​p​u​l​l​ ​r​e​q​u​e​s​t​,​ ​r​e​v​i​e​w​e​r​s​,​ ​a​n​d​ ​c​h​a​n​g​e​s​. + */ + longDesc: string + options: { + workspace: { /** - * P​e​r​ ​P​a​g​e + * W​o​r​k​s​p​a​c​e */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​p​e​r​ ​p​a​g​e + * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​u​s​t​o​m​e​r​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​. + * T​h​e​ ​B​i​t​b​u​c​k​e​t​ ​w​o​r​k​s​p​a​c​e​ ​(​o​r​g​a​n​i​z​a​t​i​o​n​ ​o​r​ ​u​s​e​r​ ​a​c​c​o​u​n​t​)​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​. */ longDesc: string } - search: { + repo_slug: { /** - * S​e​a​r​c​h + * R​e​p​o​s​i​t​o​r​y */ displayName: string /** - * S​e​a​r​c​h​ ​t​e​r​m + * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * S​e​a​r​c​h​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​n​a​m​e​ ​o​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​u​s​i​n​g​ ​a​ ​f​r​e​e​-​t​e​x​t​ ​s​e​a​r​c​h​. + * T​h​e​ ​r​e​p​o​s​i​t​o​r​y​ ​s​l​u​g​ ​(​n​a​m​e​)​ ​o​f​ ​t​h​e​ ​B​i​t​b​u​c​k​e​t​ ​r​e​p​o​s​i​t​o​r​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​. */ longDesc: string } - status: { + state: { /** - * S​t​a​t​u​s + * P​u​l​l​ ​R​e​q​u​e​s​t​ ​S​t​a​t​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​s​t​a​t​u​s + * F​i​l​t​e​r​ ​b​y​ ​p​u​l​l​ ​r​e​q​u​e​s​t​ ​s​t​a​t​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​t​h​e​i​r​ ​s​t​a​t​u​s​ ​(​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​,​ ​e​t​c​.​)​. + * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​m​o​n​i​t​o​r​ ​o​n​l​y​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​e​ ​(​O​p​e​n​,​ ​M​e​r​g​e​d​,​ ​D​e​c​l​i​n​e​d​,​ ​o​r​ ​S​u​p​e​r​s​e​d​e​d​)​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​a​l​l​ ​p​u​l​l​ ​r​e​q​u​e​s​t​s​ ​w​i​l​l​ ​b​e​ ​m​o​n​i​t​o​r​e​d​. */ longDesc: string } } } - update_customer: { - groups: { - /** - * C​u​s​t​o​m​e​r​s - */ - '0': string - } + } + } + FacebookPages: { + /** + * F​a​c​e​b​o​o​k​ ​P​a​g​e​s + */ + displayName: string + groups: { + /** + * S​o​c​i​a​l​ ​M​e​d​i​a​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * M​a​n​a​g​e​ ​y​o​u​r​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​s​ ​a​n​d​ ​p​o​s​t​s + */ + shortDesc: string + /** + * C​o​n​n​e​c​t​ ​y​o​u​r​ ​F​a​c​e​b​o​o​k​ ​a​c​c​o​u​n​t​ ​t​o​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​p​a​g​e​s​,​ ​p​o​s​t​s​,​ ​a​n​d​ ​c​o​m​m​e​n​t​s​ ​d​i​r​e​c​t​l​y​ ​f​r​o​m​ ​Q​o​r​e​.​ ​Y​o​u​ ​c​a​n​ ​c​r​e​a​t​e​,​ ​r​e​a​d​,​ ​u​p​d​a​t​e​,​ ​a​n​d​ ​d​e​l​e​t​e​ ​p​o​s​t​s​ ​o​n​ ​y​o​u​r​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​s​,​ ​a​s​ ​w​e​l​l​ ​a​s​ ​m​a​n​a​g​e​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​r​e​a​c​t​i​o​n​s​. + */ + longDesc: string + actions: { + create_page_post: { /** - * U​p​d​a​t​e​ ​C​u​s​t​o​m​e​r + * C​r​e​a​t​e​ ​P​a​g​e​ ​P​o​s​t */ displayName: string /** - * U​p​d​a​t​e​ ​c​u​s​t​o​m​e​r​ ​i​n​f​o​r​m​a​t​i​o​n + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​o​s​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e */ shortDesc: string /** - * U​p​d​a​t​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​u​s​t​o​m​e​r​'​s​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​e​m​a​i​l​,​ ​n​a​m​e​,​ ​s​t​a​t​u​s​,​ ​l​o​c​a​l​e​,​ ​a​n​d​ ​c​u​s​t​o​m​ ​d​a​t​a​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​p​o​s​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​t​e​x​t​,​ ​l​i​n​k​s​,​ ​p​h​o​t​o​s​,​ ​s​c​h​e​d​u​l​i​n​g​,​ ​a​n​d​ ​v​i​s​i​b​i​l​i​t​y​ ​s​e​t​t​i​n​g​s​.​ ​C​a​n​ ​c​r​e​a​t​e​ ​b​o​t​h​ ​i​m​m​e​d​i​a​t​e​ ​a​n​d​ ​s​c​h​e​d​u​l​e​d​ ​p​o​s​t​s​. */ longDesc: string options: { - customer_id: { + page_id: { /** - * C​u​s​t​o​m​e​r​ ​I​D + * P​a​g​e​ ​I​D */ displayName: string /** - * T​h​e​ ​c​u​s​t​o​m​e​r​ ​I​D​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​p​o​s​t​ ​t​o */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​t​o​ ​u​p​d​a​t​e​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​w​h​e​r​e​ ​t​h​e​ ​p​o​s​t​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​. */ longDesc: string } - email: { + message: { /** - * E​m​a​i​l + * M​e​s​s​a​g​e */ displayName: string /** - * N​e​w​ ​c​u​s​t​o​m​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​p​o​s​t */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​M​u​s​t​ ​b​e​ ​a​ ​v​a​l​i​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​. + * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​f​o​r​ ​t​h​e​ ​p​o​s​t​.​ ​O​p​t​i​o​n​a​l​ ​i​f​ ​l​i​n​k​ ​o​r​ ​p​h​o​t​o​s​ ​a​r​e​ ​p​r​o​v​i​d​e​d​. */ longDesc: string } - name: { + link: { /** - * N​a​m​e + * L​i​n​k */ displayName: string /** - * N​e​w​ ​c​u​s​t​o​m​e​r​ ​n​a​m​e + * U​R​L​ ​t​o​ ​s​h​a​r​e​ ​i​n​ ​t​h​e​ ​p​o​s​t */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​f​u​l​l​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​. + * A​ ​U​R​L​ ​t​o​ ​b​e​ ​s​h​a​r​e​d​ ​i​n​ ​t​h​e​ ​p​o​s​t​.​ ​F​a​c​e​b​o​o​k​ ​w​i​l​l​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​g​e​n​e​r​a​t​e​ ​a​ ​p​r​e​v​i​e​w​. */ longDesc: string } - status: { + photo_urls: { /** - * S​t​a​t​u​s + * P​h​o​t​o​ ​U​R​L​s */ displayName: string /** - * C​u​s​t​o​m​e​r​ ​s​t​a​t​u​s + * L​i​s​t​ ​o​f​ ​p​h​o​t​o​ ​U​R​L​s​ ​t​o​ ​a​t​t​a​c​h */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​(​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​,​ ​e​t​c​.​)​. + * A​ ​l​i​s​t​ ​o​f​ ​i​m​a​g​e​ ​U​R​L​s​ ​t​o​ ​b​e​ ​a​t​t​a​c​h​e​d​ ​t​o​ ​t​h​e​ ​p​o​s​t​.​ ​I​m​a​g​e​s​ ​w​i​l​l​ ​b​e​ ​u​p​l​o​a​d​e​d​ ​t​o​ ​F​a​c​e​b​o​o​k​. */ longDesc: string } - locale: { + published: { /** - * L​o​c​a​l​e + * P​u​b​l​i​s​h​e​d */ displayName: string /** - * C​u​s​t​o​m​e​r​ ​l​o​c​a​l​e​/​l​a​n​g​u​a​g​e + * W​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​p​o​s​t​ ​i​m​m​e​d​i​a​t​e​l​y */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​p​r​e​f​e​r​r​e​d​ ​l​a​n​g​u​a​g​e​/​l​o​c​a​l​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​. + * I​f​ ​t​r​u​e​,​ ​t​h​e​ ​p​o​s​t​ ​w​i​l​l​ ​b​e​ ​p​u​b​l​i​s​h​e​d​ ​i​m​m​e​d​i​a​t​e​l​y​.​ ​I​f​ ​f​a​l​s​e​,​ ​i​t​ ​w​i​l​l​ ​b​e​ ​s​a​v​e​d​ ​a​s​ ​a​ ​d​r​a​f​t​ ​o​r​ ​s​c​h​e​d​u​l​e​d​. */ longDesc: string } - custom_data: { + scheduled_publish_time: { /** - * C​u​s​t​o​m​ ​D​a​t​a + * S​c​h​e​d​u​l​e​d​ ​P​u​b​l​i​s​h​ ​T​i​m​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​d​a​t​a + * W​h​e​n​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​p​o​s​t */ shortDesc: string /** - * C​u​s​t​o​m​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​ ​t​o​ ​u​p​d​a​t​e​ ​o​r​ ​a​d​d​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​c​u​s​t​o​m​e​r​. + * I​S​O​ ​t​i​m​e​s​t​a​m​p​ ​f​o​r​ ​w​h​e​n​ ​t​h​e​ ​p​o​s​t​ ​s​h​o​u​l​d​ ​b​e​ ​p​u​b​l​i​s​h​e​d​.​ ​R​e​q​u​i​r​e​s​ ​p​u​b​l​i​s​h​e​d​ ​t​o​ ​b​e​ ​f​a​l​s​e​. */ longDesc: string - type: { - fields: { - key: { - /** - * K​e​y - */ - displayName: string - /** - * C​u​s​t​o​m​ ​d​a​t​a​ ​k​e​y - */ - shortDesc: string - /** - * T​h​e​ ​k​e​y​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​ ​d​a​t​a​ ​f​i​e​l​d​. - */ - longDesc: string - } - value: { - /** - * V​a​l​u​e - */ - displayName: string - /** - * C​u​s​t​o​m​ ​d​a​t​a​ ​v​a​l​u​e - */ - shortDesc: string - /** - * T​h​e​ ​v​a​l​u​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​ ​d​a​t​a​ ​f​i​e​l​d​. - */ - longDesc: string - } - } - } } - } - } - get_report: { - groups: { - /** - * R​e​p​o​r​t​s - */ - '0': string - } - /** - * G​e​t​ ​R​e​p​o​r​t - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​r​e​p​o​r​t​ ​b​y​ ​I​D - */ - shortDesc: string - /** - * F​e​t​c​h​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​r​e​p​o​r​t​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​s​t​a​t​u​s​,​ ​f​i​l​t​e​r​s​,​ ​r​o​w​ ​c​o​u​n​t​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a​. - */ - longDesc: string - options: { - report_id: { + feed_story_visibility: { /** - * R​e​p​o​r​t​ ​I​D + * F​e​e​d​ ​S​t​o​r​y​ ​V​i​s​i​b​i​l​i​t​y */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​r​e​p​o​r​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * V​i​s​i​b​i​l​i​t​y​ ​i​n​ ​n​e​w​s​ ​f​e​e​d */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​p​o​r​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​f​e​t​c​h​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​. + * C​o​n​t​r​o​l​s​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​p​o​s​t​ ​a​p​p​e​a​r​s​ ​i​n​ ​t​h​e​ ​n​e​w​s​ ​f​e​e​d​. */ longDesc: string } - } - } - get_report_file: { - groups: { - /** - * R​e​p​o​r​t​s - */ - '0': string - } - /** - * G​e​t​ ​R​e​p​o​r​t​ ​F​i​l​e - */ - displayName: string - /** - * D​o​w​n​l​o​a​d​ ​a​ ​r​e​p​o​r​t​ ​f​i​l​e​ ​a​s​ ​C​S​V - */ - shortDesc: string - /** - * D​o​w​n​l​o​a​d​s​ ​t​h​e​ ​C​S​V​ ​f​i​l​e​ ​f​o​r​ ​a​ ​c​o​m​p​l​e​t​e​d​ ​r​e​p​o​r​t​.​ ​R​e​t​u​r​n​s​ ​a​ ​U​R​L​ ​t​o​ ​d​o​w​n​l​o​a​d​ ​t​h​e​ ​r​e​p​o​r​t​ ​d​a​t​a​. - */ - longDesc: string - options: { - report_id: { + timeline_visibility: { /** - * R​e​p​o​r​t​ ​I​D + * T​i​m​e​l​i​n​e​ ​V​i​s​i​b​i​l​i​t​y */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​r​e​p​o​r​t​ ​f​i​l​e​ ​t​o​ ​d​o​w​n​l​o​a​d + * V​i​s​i​b​i​l​i​t​y​ ​o​n​ ​t​i​m​e​l​i​n​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​p​o​r​t​ ​w​h​o​s​e​ ​C​S​V​ ​f​i​l​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​o​w​n​l​o​a​d​. + * C​o​n​t​r​o​l​s​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​p​o​s​t​ ​a​p​p​e​a​r​s​ ​o​n​ ​t​h​e​ ​p​a​g​e​ ​t​i​m​e​l​i​n​e​. */ longDesc: string } } } - list_reports: { - groups: { - /** - * R​e​p​o​r​t​s - */ - '0': string - } + get_page_post_insights: { /** - * L​i​s​t​ ​R​e​p​o​r​t​s + * G​e​t​ ​P​a​g​e​ ​P​o​s​t​ ​I​n​s​i​g​h​t​s */ displayName: string /** - * L​i​s​t​ ​a​l​l​ ​r​e​p​o​r​t​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​p​a​g​i​n​a​t​i​o​n + * G​e​t​ ​a​n​a​l​y​t​i​c​s​ ​d​a​t​a​ ​f​o​r​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​r​e​p​o​r​t​s​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​s​t​a​t​u​s​,​ ​p​a​g​i​n​a​t​i​o​n​,​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. + * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​s​i​g​h​t​s​ ​a​n​d​ ​a​n​a​l​y​t​i​c​s​ ​d​a​t​a​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​,​ ​i​n​c​l​u​d​i​n​g​ ​i​m​p​r​e​s​s​i​o​n​s​,​ ​c​l​i​c​k​s​,​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​,​ ​a​n​d​ ​t​i​m​e​-​s​e​r​i​e​s​ ​d​a​t​a​. */ longDesc: string options: { - after: { + page_id: { /** - * A​f​t​e​r + * P​a​g​e​ ​I​D */ displayName: string /** - * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D */ shortDesc: string /** - * R​e​t​u​r​n​ ​r​e​p​o​r​t​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​d​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. */ longDesc: string } - order: { + post_id: { /** - * S​o​r​t​ ​O​r​d​e​r + * P​o​s​t​ ​I​D */ displayName: string /** - * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s + * T​h​e​ ​p​o​s​t​ ​t​o​ ​g​e​t​ ​i​n​s​i​g​h​t​s​ ​f​o​r */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​f​i​e​l​d​ ​a​n​d​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​p​o​r​t​s​ ​b​y​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​i​n​s​i​g​h​t​s​ ​f​o​r​. */ longDesc: string - type: { - fields: { - field: { - /** - * S​o​r​t​ ​F​i​e​l​d - */ - displayName: string - /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​t​h​e​ ​r​e​p​o​r​t​s​. - */ - longDesc: string - } - direction: { - /** - * S​o​r​t​ ​D​i​r​e​c​t​i​o​n - */ - displayName: string - /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n - */ - shortDesc: string - /** - * W​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r​. - */ - longDesc: string - } - } - } } - per_page: { + metrics: { /** - * P​e​r​ ​P​a​g​e + * M​e​t​r​i​c​s */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​r​e​p​o​r​t​s​ ​p​e​r​ ​p​a​g​e + * L​i​s​t​ ​o​f​ ​m​e​t​r​i​c​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​p​o​r​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​. + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​i​n​s​i​g​h​t​ ​m​e​t​r​i​c​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​t​h​e​ ​p​o​s​t​,​ ​s​u​c​h​ ​a​s​ ​i​m​p​r​e​s​s​i​o​n​s​,​ ​c​l​i​c​k​s​,​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​. */ longDesc: string } - status: { + period: { /** - * S​t​a​t​u​s​ ​F​i​l​t​e​r + * P​e​r​i​o​d */ displayName: string /** - * F​i​l​t​e​r​ ​r​e​p​o​r​t​s​ ​b​y​ ​s​t​a​t​u​s + * T​i​m​e​ ​p​e​r​i​o​d​ ​f​o​r​ ​i​n​s​i​g​h​t​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​h​e​ ​r​e​p​o​r​t​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​t​a​t​u​s​ ​v​a​l​u​e​s​. + * T​h​e​ ​t​i​m​e​ ​p​e​r​i​o​d​ ​f​o​r​ ​w​h​i​c​h​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​i​n​s​i​g​h​t​s​ ​d​a​t​a​.​ ​L​i​f​e​t​i​m​e​ ​r​e​t​u​r​n​s​ ​t​o​t​a​l​ ​m​e​t​r​i​c​s​. */ longDesc: string } } } - create_report: { - groups: { - /** - * R​e​p​o​r​t​s - */ - '0': string - } + get_page_post: { /** - * C​r​e​a​t​e​ ​R​e​p​o​r​t + * G​e​t​ ​P​a​g​e​ ​P​o​s​t */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​r​e​p​o​r​t​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​s + * G​e​t​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t */ shortDesc: string /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​r​e​p​o​r​t​ ​o​f​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​y​p​e​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​s​ ​t​o​ ​n​a​r​r​o​w​ ​d​o​w​n​ ​t​h​e​ ​d​a​t​a​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​e​ ​r​e​p​o​r​t​. + * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​,​ ​i​n​c​l​u​d​i​n​g​ ​c​o​n​t​e​n​t​,​ ​m​e​t​a​d​a​t​a​,​ ​e​n​g​a​g​e​m​e​n​t​ ​c​o​u​n​t​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​p​o​s​t​ ​p​r​o​p​e​r​t​i​e​s​. */ longDesc: string options: { - type: { + page_id: { /** - * R​e​p​o​r​t​ ​T​y​p​e + * P​a​g​e​ ​I​D */ displayName: string /** - * T​h​e​ ​t​y​p​e​ ​o​f​ ​r​e​p​o​r​t​ ​t​o​ ​c​r​e​a​t​e + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D */ shortDesc: string /** - * T​h​e​ ​t​y​p​e​ ​o​f​ ​r​e​p​o​r​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​n​e​r​a​t​e​.​ ​D​i​f​f​e​r​e​n​t​ ​t​y​p​e​s​ ​p​r​o​v​i​d​e​ ​d​i​f​f​e​r​e​n​t​ ​d​a​t​a​ ​s​e​t​s​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. */ longDesc: string } - filters: { + post_id: { /** - * F​i​l​t​e​r​s + * P​o​s​t​ ​I​D */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​s​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​e​ ​r​e​p​o​r​t + * T​h​e​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * A​p​p​l​y​ ​f​i​l​t​e​r​s​ ​t​o​ ​l​i​m​i​t​ ​t​h​e​ ​d​a​t​a​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​e​ ​r​e​p​o​r​t​ ​b​a​s​e​d​ ​o​n​ ​s​p​e​c​i​f​i​c​ ​c​r​i​t​e​r​i​a​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. + */ + longDesc: string + } + fields: { + /** + * F​i​e​l​d​s + */ + displayName: string + /** + * P​o​s​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e + */ + shortDesc: string + /** + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​t​h​e​ ​p​o​s​t​,​ ​s​u​c​h​ ​a​s​ ​m​e​s​s​a​g​e​,​ ​c​r​e​a​t​e​d​ ​t​i​m​e​,​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​. */ longDesc: string - type: { - element_type: { - fields: { - name: { - /** - * F​i​l​t​e​r​ ​N​a​m​e - */ - displayName: string - /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​f​i​l​t​e​r​ ​f​i​e​l​d - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​n​a​m​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y​. - */ - longDesc: string - } - operator: { - /** - * F​i​l​t​e​r​ ​O​p​e​r​a​t​o​r - */ - displayName: string - /** - * T​h​e​ ​c​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r - */ - shortDesc: string - /** - * T​h​e​ ​o​p​e​r​a​t​o​r​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​o​m​p​a​r​i​n​g​ ​t​h​e​ ​f​i​l​t​e​r​ ​v​a​l​u​e​. - */ - longDesc: string - } - value: { - /** - * F​i​l​t​e​r​ ​V​a​l​u​e - */ - displayName: string - /** - * T​h​e​ ​v​a​l​u​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​v​a​l​u​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​f​i​l​t​e​r​ ​c​o​m​p​a​r​i​s​o​n​. - */ - longDesc: string - } - } - } - } } } } - get_subscription: { - groups: { - /** - * S​u​b​s​c​r​i​p​t​i​o​n​s - */ - '0': string - } + get_page: { /** - * G​e​t​ ​S​u​b​s​c​r​i​p​t​i​o​n + * G​e​t​ ​P​a​g​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​b​y​ ​I​D + * G​e​t​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e */ shortDesc: string /** - * F​e​t​c​h​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​s​t​a​t​u​s​,​ ​b​i​l​l​i​n​g​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​r​e​l​a​t​e​d​ ​d​a​t​a​. + * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​,​ ​i​n​c​l​u​d​i​n​g​ ​b​a​s​i​c​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​c​o​n​t​a​c​t​ ​d​e​t​a​i​l​s​,​ ​l​o​c​a​t​i​o​n​,​ ​s​t​a​t​i​s​t​i​c​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​p​a​g​e​ ​p​r​o​p​e​r​t​i​e​s​. */ longDesc: string options: { - subscription_id: { + page_id: { /** - * S​u​b​s​c​r​i​p​t​i​o​n​ ​I​D + * P​a​g​e​ ​I​D */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​f​e​t​c​h​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. */ longDesc: string } - include: { + fields: { /** - * I​n​c​l​u​d​e​ ​A​d​d​i​t​i​o​n​a​l​ ​D​a​t​a + * F​i​e​l​d​s */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e + * P​a​g​e​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​a​d​d​i​t​i​o​n​a​l​ ​r​e​l​a​t​e​d​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​d​e​t​a​i​l​s​,​ ​s​u​c​h​ ​a​s​ ​n​e​x​t​ ​t​r​a​n​s​a​c​t​i​o​n​ ​o​r​ ​r​e​c​u​r​r​i​n​g​ ​t​r​a​n​s​a​c​t​i​o​n​ ​d​e​t​a​i​l​s​. + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​t​h​e​ ​p​a​g​e​,​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​,​ ​c​a​t​e​g​o​r​y​,​ ​a​b​o​u​t​ ​s​e​c​t​i​o​n​,​ ​a​n​d​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​. */ longDesc: string } } } - list_subscriptions: { - groups: { - /** - * S​u​b​s​c​r​i​p​t​i​o​n​s - */ - '0': string - } + search_page_posts: { /** - * L​i​s​t​ ​S​u​b​s​c​r​i​p​t​i​o​n​s + * S​e​a​r​c​h​ ​P​a​g​e​ ​P​o​s​t​s */ displayName: string /** - * L​i​s​t​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​p​a​g​i​n​a​t​i​o​n + * S​e​a​r​c​h​ ​a​n​d​ ​f​i​l​t​e​r​ ​p​o​s​t​s​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​c​u​s​t​o​m​e​r​,​ ​s​t​a​t​u​s​,​ ​p​r​i​c​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​,​ ​p​l​u​s​ ​p​a​g​i​n​a​t​i​o​n​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. + * S​e​a​r​c​h​e​s​ ​f​o​r​ ​p​o​s​t​s​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​t​e​x​t​ ​f​i​l​t​e​r​i​n​g​,​ ​d​a​t​e​ ​r​a​n​g​e​s​,​ ​v​i​s​i​b​i​l​i​t​y​ ​o​p​t​i​o​n​s​,​ ​a​n​d​ ​f​i​e​l​d​ ​s​e​l​e​c​t​i​o​n​.​ ​R​e​t​u​r​n​s​ ​a​ ​l​i​s​t​ ​o​f​ ​m​a​t​c​h​i​n​g​ ​p​o​s​t​s​. */ longDesc: string options: { - customer_id: { + page_id: { /** - * C​u​s​t​o​m​e​r​ ​I​D + * P​a​g​e​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​I​D + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​s​e​a​r​c​h */ shortDesc: string /** - * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​b​e​l​o​n​g​i​n​g​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​u​s​t​o​m​e​r​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​p​o​s​t​s​. */ longDesc: string } - address_id: { + limit: { /** - * A​d​d​r​e​s​s​ ​I​D​s + * L​i​m​i​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​a​d​d​r​e​s​s​ ​I​D​s + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​p​o​s​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​u​s​t​o​m​e​r​ ​a​d​d​r​e​s​s​ ​I​D​s​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​p​o​s​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​.​ ​C​a​n​n​o​t​ ​e​x​c​e​e​d​ ​1​0​0​. */ longDesc: string } - after: { + since: { /** - * A​f​t​e​r + * S​i​n​c​e */ displayName: string /** - * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r + * S​t​a​r​t​ ​d​a​t​e​ ​f​o​r​ ​s​e​a​r​c​h */ shortDesc: string /** - * R​e​t​u​r​n​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​d​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. + * I​S​O​ ​t​i​m​e​s​t​a​m​p​ ​o​r​ ​d​a​t​e​ ​s​t​r​i​n​g​ ​f​o​r​ ​t​h​e​ ​e​a​r​l​i​e​s​t​ ​p​o​s​t​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​r​e​s​u​l​t​s​. */ longDesc: string } - collection_mode: { + until: { /** - * C​o​l​l​e​c​t​i​o​n​ ​M​o​d​e + * U​n​t​i​l */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​a​y​m​e​n​t​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e + * E​n​d​ ​d​a​t​e​ ​f​o​r​ ​s​e​a​r​c​h */ shortDesc: string /** - * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​b​y​ ​h​o​w​ ​p​a​y​m​e​n​t​s​ ​a​r​e​ ​c​o​l​l​e​c​t​e​d​ ​-​ ​e​i​t​h​e​r​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​o​r​ ​m​a​n​u​a​l​l​y​. + * I​S​O​ ​t​i​m​e​s​t​a​m​p​ ​o​r​ ​d​a​t​e​ ​s​t​r​i​n​g​ ​f​o​r​ ​t​h​e​ ​l​a​t​e​s​t​ ​p​o​s​t​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​r​e​s​u​l​t​s​. */ longDesc: string } - id: { + search_text: { /** - * S​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s + * S​e​a​r​c​h​ ​T​e​x​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s + * T​e​x​t​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​i​n​ ​p​o​s​t​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​I​D​s​. + * T​e​x​t​ ​s​t​r​i​n​g​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​w​i​t​h​i​n​ ​p​o​s​t​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​s​t​o​r​i​e​s​.​ ​C​a​s​e​-​i​n​s​e​n​s​i​t​i​v​e​ ​s​e​a​r​c​h​. */ longDesc: string } - order: { + include_hidden: { /** - * S​o​r​t​ ​O​r​d​e​r + * I​n​c​l​u​d​e​ ​H​i​d​d​e​n */ displayName: string /** - * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​p​o​s​t​s */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​f​i​e​l​d​ ​a​n​d​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​b​y​. + * I​f​ ​t​r​u​e​,​ ​i​n​c​l​u​d​e​s​ ​p​o​s​t​s​ ​t​h​a​t​ ​a​r​e​ ​h​i​d​d​e​n​ ​f​r​o​m​ ​t​h​e​ ​t​i​m​e​l​i​n​e​ ​i​n​ ​t​h​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​. */ longDesc: string - type: { - fields: { - field: { - /** - * S​o​r​t​ ​F​i​e​l​d - */ - displayName: string - /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​. - */ - longDesc: string - } - direction: { - /** - * S​o​r​t​ ​D​i​r​e​c​t​i​o​n - */ - displayName: string - /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n - */ - shortDesc: string - /** - * W​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r​. - */ - longDesc: string - } - } - } } - per_page: { + fields: { /** - * P​e​r​ ​P​a​g​e + * F​i​e​l​d​s */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e + * P​o​s​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​. + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​e​a​c​h​ ​p​o​s​t​ ​i​n​ ​t​h​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​. */ longDesc: string } - price_id: { + } + } + get_post_comments: { + /** + * G​e​t​ ​P​o​s​t​ ​C​o​m​m​e​n​t​s + */ + displayName: string + /** + * G​e​t​ ​c​o​m​m​e​n​t​s​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​s​ ​c​o​m​m​e​n​t​s​ ​o​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​,​ ​o​r​d​e​r​i​n​g​,​ ​p​a​g​i​n​a​t​i​o​n​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​r​e​p​l​y​ ​i​n​c​l​u​s​i​o​n​. + */ + longDesc: string + options: { + page_id: { /** - * P​r​i​c​e​ ​I​D​s + * P​a​g​e​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​i​c​e​ ​I​D​s + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D */ shortDesc: string /** - * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​p​r​i​c​e​ ​I​D​s​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. */ longDesc: string } - scheduled_change_action: { + post_id: { /** - * S​c​h​e​d​u​l​e​d​ ​C​h​a​n​g​e​ ​A​c​t​i​o​n​s + * P​o​s​t​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​ ​a​c​t​i​o​n​s + * T​h​e​ ​p​o​s​t​ ​t​o​ ​g​e​t​ ​c​o​m​m​e​n​t​s​ ​f​o​r */ shortDesc: string /** - * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​h​a​t​ ​h​a​v​e​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​s​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​a​c​t​i​o​n​s​ ​(​c​a​n​c​e​l​,​ ​p​a​u​s​e​,​ ​r​e​s​u​m​e​)​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​c​o​m​m​e​n​t​s​ ​f​o​r​. */ longDesc: string } - status: { + fields: { /** - * S​t​a​t​u​s​ ​F​i​l​t​e​r + * F​i​e​l​d​s */ displayName: string /** - * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​b​y​ ​s​t​a​t​u​s + * C​o​m​m​e​n​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​t​a​t​u​s​ ​v​a​l​u​e​s​ ​(​a​c​t​i​v​e​,​ ​c​a​n​c​e​l​e​d​,​ ​p​a​s​t​_​d​u​e​,​ ​p​a​u​s​e​d​,​ ​t​r​i​a​l​i​n​g​)​. + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​r​ ​e​a​c​h​ ​c​o​m​m​e​n​t​,​ ​s​u​c​h​ ​a​s​ ​m​e​s​s​a​g​e​,​ ​a​u​t​h​o​r​,​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​. */ longDesc: string } - } - } - create_transaction: { - groups: { - /** - * T​r​a​n​s​a​c​t​i​o​n​s - */ - '0': string - } - /** - * C​r​e​a​t​e​ ​T​r​a​n​s​a​c​t​i​o​n - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​t​r​a​n​s​a​c​t​i​o​n​ ​w​i​t​h​ ​i​t​e​m​s​ ​a​n​d​ ​b​i​l​l​i​n​g​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​t​r​a​n​s​a​c​t​i​o​n​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​i​t​e​m​s​,​ ​c​u​s​t​o​m​e​r​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​b​i​l​l​i​n​g​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​.​ ​S​u​p​p​o​r​t​s​ ​b​o​t​h​ ​a​u​t​o​m​a​t​i​c​ ​a​n​d​ ​m​a​n​u​a​l​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e​s​. - */ - longDesc: string - options: { - include: { + limit: { /** - * I​n​c​l​u​d​e​ ​A​d​d​i​t​i​o​n​a​l​ ​D​a​t​a + * L​i​m​i​t */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​m​e​n​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​a​d​d​i​t​i​o​n​a​l​ ​r​e​l​a​t​e​d​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​d​e​t​a​i​l​s​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​m​e​n​t​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​C​a​n​n​o​t​ ​e​x​c​e​e​d​ ​1​0​0​. */ longDesc: string } - items: { + order: { /** - * T​r​a​n​s​a​c​t​i​o​n​ ​I​t​e​m​s + * O​r​d​e​r */ displayName: string /** - * I​t​e​m​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n + * O​r​d​e​r​ ​o​f​ ​c​o​m​m​e​n​t​s */ shortDesc: string /** - * L​i​s​t​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​,​ ​e​a​c​h​ ​w​i​t​h​ ​a​ ​p​r​i​c​e​ ​I​D​ ​a​n​d​ ​q​u​a​n​t​i​t​y​. + * T​h​e​ ​o​r​d​e​r​ ​i​n​ ​w​h​i​c​h​ ​t​o​ ​r​e​t​u​r​n​ ​c​o​m​m​e​n​t​s​ ​-​ ​c​h​r​o​n​o​l​o​g​i​c​a​l​ ​(​o​l​d​e​s​t​ ​f​i​r​s​t​)​ ​o​r​ ​r​e​v​e​r​s​e​ ​c​h​r​o​n​o​l​o​g​i​c​a​l​ ​(​n​e​w​e​s​t​ ​f​i​r​s​t​)​. */ longDesc: string - type: { - element_type: { - fields: { - price_id: { - /** - * P​r​i​c​e​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​p​r​i​c​e​ ​I​D​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​ ​i​t​e​m​. - */ - longDesc: string - } - quantity: { - /** - * Q​u​a​n​t​i​t​y - */ - displayName: string - /** - * Q​u​a​n​t​i​t​y​ ​o​f​ ​t​h​i​s​ ​i​t​e​m - */ - shortDesc: string - /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​o​f​ ​t​h​i​s​ ​i​t​e​m​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​. - */ - longDesc: string - } - } - } - } } - status: { + filter: { /** - * T​r​a​n​s​a​c​t​i​o​n​ ​S​t​a​t​u​s + * F​i​l​t​e​r */ displayName: string /** - * I​n​i​t​i​a​l​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n + * C​o​m​m​e​n​t​ ​f​i​l​t​e​r​ ​t​y​p​e */ shortDesc: string /** - * S​e​t​ ​t​h​e​ ​i​n​i​t​i​a​l​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​-​ ​e​i​t​h​e​r​ ​b​i​l​l​e​d​ ​o​r​ ​c​a​n​c​e​l​e​d​. + * W​h​e​t​h​e​r​ ​t​o​ ​r​e​t​u​r​n​ ​o​n​l​y​ ​t​o​p​-​l​e​v​e​l​ ​c​o​m​m​e​n​t​s​ ​o​r​ ​a​l​l​ ​c​o​m​m​e​n​t​s​ ​i​n​c​l​u​d​i​n​g​ ​r​e​p​l​i​e​s​ ​i​n​ ​a​ ​s​t​r​e​a​m​ ​f​o​r​m​a​t​. */ longDesc: string } - customer_id: { + include_replies: { /** - * C​u​s​t​o​m​e​r​ ​I​D + * I​n​c​l​u​d​e​ ​R​e​p​l​i​e​s */ displayName: string /** - * I​D​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​r​e​p​l​i​e​s​ ​t​o​ ​c​o​m​m​e​n​t​s */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​c​h​a​r​g​e​d​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. + * I​f​ ​t​r​u​e​,​ ​i​n​c​l​u​d​e​s​ ​r​e​p​l​i​e​s​ ​t​o​ ​e​a​c​h​ ​t​o​p​-​l​e​v​e​l​ ​c​o​m​m​e​n​t​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string } - address_id: { + } + } + like_comment: { + /** + * L​i​k​e​ ​C​o​m​m​e​n​t + */ + displayName: string + /** + * L​i​k​e​ ​o​r​ ​u​n​l​i​k​e​ ​a​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t + */ + shortDesc: string + /** + * L​i​k​e​s​ ​o​r​ ​u​n​l​i​k​e​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​.​ ​C​a​n​ ​t​o​g​g​l​e​ ​t​h​e​ ​l​i​k​e​ ​s​t​a​t​u​s​ ​a​n​d​ ​r​e​t​u​r​n​s​ ​u​p​d​a​t​e​d​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​. + */ + longDesc: string + options: { + page_id: { /** - * A​d​d​r​e​s​s​ ​I​D + * P​a​g​e​ ​I​D */ displayName: string /** - * C​u​s​t​o​m​e​r​ ​a​d​d​r​e​s​s​ ​I​D​ ​f​o​r​ ​b​i​l​l​i​n​g + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​a​d​d​r​e​s​s​ ​t​o​ ​u​s​e​ ​f​o​r​ ​b​i​l​l​i​n​g​ ​a​n​d​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​s​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. */ longDesc: string } - business_id: { + post_id: { /** - * B​u​s​i​n​e​s​s​ ​I​D + * P​o​s​t​ ​I​D */ displayName: string /** - * C​u​s​t​o​m​e​r​ ​b​u​s​i​n​e​s​s​ ​I​D + * T​h​e​ ​p​o​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​m​m​e​n​t */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​b​u​s​i​n​e​s​s​ ​e​n​t​i​t​y​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​. */ longDesc: string } - custom_data: { + comment_id: { /** - * C​u​s​t​o​m​ ​D​a​t​a + * C​o​m​m​e​n​t​ ​I​D */ displayName: string /** - * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​f​o​r​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n + * T​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​l​i​k​e​/​u​n​l​i​k​e */ shortDesc: string /** - * C​u​s​t​o​m​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​ ​t​o​ ​s​t​o​r​e​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​w​i​t​h​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​l​i​k​e​ ​o​r​ ​u​n​l​i​k​e​. */ longDesc: string } - currency_code: { + action: { /** - * C​u​r​r​e​n​c​y​ ​C​o​d​e + * A​c​t​i​o​n */ displayName: string /** - * C​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n + * W​h​e​t​h​e​r​ ​t​o​ ​l​i​k​e​ ​o​r​ ​u​n​l​i​k​e */ shortDesc: string /** - * T​h​e​ ​t​h​r​e​e​-​l​e​t​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. + * T​h​e​ ​a​c​t​i​o​n​ ​t​o​ ​p​e​r​f​o​r​m​ ​-​ ​e​i​t​h​e​r​ ​l​i​k​e​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​o​r​ ​r​e​m​o​v​e​ ​t​h​e​ ​l​i​k​e​ ​(​u​n​l​i​k​e​)​. */ longDesc: string } - collection_mode: { + } + } + reply_to_comment: { + /** + * R​e​p​l​y​ ​t​o​ ​C​o​m​m​e​n​t + */ + displayName: string + /** + * R​e​p​l​y​ ​t​o​ ​a​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t + */ + shortDesc: string + /** + * C​r​e​a​t​e​s​ ​a​ ​r​e​p​l​y​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​p​o​s​t​.​ ​S​u​p​p​o​r​t​s​ ​t​e​x​t​ ​r​e​p​l​i​e​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​a​t​t​a​c​h​m​e​n​t​ ​U​R​L​s​. + */ + longDesc: string + options: { + page_id: { /** - * C​o​l​l​e​c​t​i​o​n​ ​M​o​d​e + * P​a​g​e​ ​I​D */ displayName: string /** - * H​o​w​ ​p​a​y​m​e​n​t​ ​w​i​l​l​ ​b​e​ ​c​o​l​l​e​c​t​e​d + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​I​D */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​w​h​e​t​h​e​r​ ​p​a​y​m​e​n​t​ ​s​h​o​u​l​d​ ​b​e​ ​c​o​l​l​e​c​t​e​d​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​o​r​ ​m​a​n​u​a​l​l​y​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​. */ longDesc: string } - discount_id: { + post_id: { /** - * D​i​s​c​o​u​n​t​ ​I​D + * P​o​s​t​ ​I​D */ displayName: string /** - * D​i​s​c​o​u​n​t​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n + * T​h​e​ ​p​o​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​m​m​e​n​t */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​a​ ​d​i​s​c​o​u​n​t​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​b​e​i​n​g​ ​r​e​p​l​i​e​d​ ​t​o​. */ longDesc: string } - billing_details: { + comment_id: { /** - * B​i​l​l​i​n​g​ ​D​e​t​a​i​l​s + * C​o​m​m​e​n​t​ ​I​D */ displayName: string /** - * B​i​l​l​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n + * T​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o */ shortDesc: string /** - * B​i​l​l​i​n​g​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​p​a​y​m​e​n​t​ ​t​e​r​m​s​,​ ​c​h​e​c​k​o​u​t​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o​. */ longDesc: string - type: { - fields: { - payment_terms: { - /** - * P​a​y​m​e​n​t​ ​T​e​r​m​s - */ - displayName: string - /** - * P​a​y​m​e​n​t​ ​t​e​r​m​ ​c​o​n​f​i​g​u​r​a​t​i​o​n - */ - shortDesc: string - /** - * D​e​f​i​n​e​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​t​e​r​m​s​ ​i​n​c​l​u​d​i​n​g​ ​i​n​t​e​r​v​a​l​ ​a​n​d​ ​f​r​e​q​u​e​n​c​y​. - */ - longDesc: string - type: { - fields: { - interval: { - /** - * I​n​t​e​r​v​a​l - */ - displayName: string - /** - * P​a​y​m​e​n​t​ ​i​n​t​e​r​v​a​l​ ​u​n​i​t - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​t​ ​o​f​ ​t​i​m​e​ ​f​o​r​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​i​n​t​e​r​v​a​l​ ​(​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​,​ ​y​e​a​r​)​. - */ - longDesc: string - } - frequency: { - /** - * F​r​e​q​u​e​n​c​y - */ - displayName: string - /** - * P​a​y​m​e​n​t​ ​f​r​e​q​u​e​n​c​y - */ - shortDesc: string - /** - * H​o​w​ ​o​f​t​e​n​ ​p​a​y​m​e​n​t​s​ ​o​c​c​u​r​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​i​n​t​e​r​v​a​l​. - */ - longDesc: string - } - } - } - } - enable_checkout: { - /** - * E​n​a​b​l​e​ ​C​h​e​c​k​o​u​t - */ - displayName: string - /** - * W​h​e​t​h​e​r​ ​t​o​ ​e​n​a​b​l​e​ ​c​h​e​c​k​o​u​t - */ - shortDesc: string - /** - * E​n​a​b​l​e​ ​o​r​ ​d​i​s​a​b​l​e​ ​t​h​e​ ​c​h​e​c​k​o​u​t​ ​p​r​o​c​e​s​s​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. - */ - longDesc: string - } - purchase_order_number: { - /** - * P​u​r​c​h​a​s​e​ ​O​r​d​e​r​ ​N​u​m​b​e​r - */ - displayName: string - /** - * P​u​r​c​h​a​s​e​ ​o​r​d​e​r​ ​r​e​f​e​r​e​n​c​e - */ - shortDesc: string - /** - * A​ ​p​u​r​c​h​a​s​e​ ​o​r​d​e​r​ ​n​u​m​b​e​r​ ​f​o​r​ ​r​e​f​e​r​e​n​c​e​ ​a​n​d​ ​t​r​a​c​k​i​n​g​ ​p​u​r​p​o​s​e​s​. - */ - longDesc: string - } - additional_information: { - /** - * A​d​d​i​t​i​o​n​a​l​ ​I​n​f​o​r​m​a​t​i​o​n - */ - displayName: string - /** - * E​x​t​r​a​ ​b​i​l​l​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n - */ - shortDesc: string - /** - * A​n​y​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​b​i​l​l​i​n​g​ ​d​e​t​a​i​l​s​. - */ - longDesc: string - } - } - } } - billing_period: { + message: { /** - * B​i​l​l​i​n​g​ ​P​e​r​i​o​d + * M​e​s​s​a​g​e */ displayName: string /** - * T​i​m​e​ ​p​e​r​i​o​d​ ​f​o​r​ ​b​i​l​l​i​n​g + * T​h​e​ ​r​e​p​l​y​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * D​e​f​i​n​e​ ​t​h​e​ ​s​t​a​r​t​ ​a​n​d​ ​e​n​d​ ​d​a​t​e​s​ ​f​o​r​ ​t​h​e​ ​b​i​l​l​i​n​g​ ​p​e​r​i​o​d​. + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​r​e​p​l​y​ ​t​o​ ​t​h​e​ ​c​o​m​m​e​n​t​. */ longDesc: string - type: { - fields: { - ends_at: { - /** - * E​n​d​ ​D​a​t​e - */ - displayName: string - /** - * B​i​l​l​i​n​g​ ​p​e​r​i​o​d​ ​e​n​d​ ​d​a​t​e - */ - shortDesc: string - /** - * T​h​e​ ​d​a​t​e​ ​w​h​e​n​ ​t​h​e​ ​b​i​l​l​i​n​g​ ​p​e​r​i​o​d​ ​e​n​d​s​. - */ - longDesc: string - } - starts_at: { - /** - * S​t​a​r​t​ ​D​a​t​e - */ - displayName: string - /** - * B​i​l​l​i​n​g​ ​p​e​r​i​o​d​ ​s​t​a​r​t​ ​d​a​t​e - */ - shortDesc: string - /** - * T​h​e​ ​d​a​t​e​ ​w​h​e​n​ ​t​h​e​ ​b​i​l​l​i​n​g​ ​p​e​r​i​o​d​ ​s​t​a​r​t​s​. - */ - longDesc: string - } - } - } } - checkout_url: { + attachment_url: { /** - * C​h​e​c​k​o​u​t​ ​U​R​L + * A​t​t​a​c​h​m​e​n​t​ ​U​R​L */ displayName: string /** - * C​u​s​t​o​m​ ​c​h​e​c​k​o​u​t​ ​U​R​L + * O​p​t​i​o​n​a​l​ ​a​t​t​a​c​h​m​e​n​t​ ​U​R​L */ shortDesc: string /** - * A​ ​c​u​s​t​o​m​ ​U​R​L​ ​t​o​ ​r​e​d​i​r​e​c​t​ ​c​u​s​t​o​m​e​r​s​ ​t​o​ ​f​o​r​ ​c​h​e​c​k​o​u​t​ ​c​o​m​p​l​e​t​i​o​n​. + * O​p​t​i​o​n​a​l​ ​U​R​L​ ​t​o​ ​a​t​t​a​c​h​ ​t​o​ ​t​h​e​ ​r​e​p​l​y​,​ ​s​u​c​h​ ​a​s​ ​a​n​ ​i​m​a​g​e​ ​o​r​ ​l​i​n​k​. */ longDesc: string } } } - get_transaction: { - groups: { - /** - * T​r​a​n​s​a​c​t​i​o​n​s - */ - '0': string - } + } + triggers: { + new_post: { /** - * G​e​t​ ​T​r​a​n​s​a​c​t​i​o​n + * N​e​w​ ​P​o​s​t */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​b​y​ ​I​D + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​p​o​s​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​. */ shortDesc: string /** - * F​e​t​c​h​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​i​t​e​m​s​,​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​s​t​a​t​u​s​. + * M​o​n​i​t​o​r​s​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​f​o​r​ ​n​e​w​ ​p​o​s​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​p​o​s​t​ ​i​s​ ​c​r​e​a​t​e​d​.​ ​S​u​p​p​o​r​t​s​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​v​i​s​i​b​i​l​i​t​y​ ​a​n​d​ ​c​u​s​t​o​m​i​z​a​b​l​e​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​s​p​e​c​i​f​i​c​ ​p​o​s​t​ ​d​a​t​a​. */ longDesc: string options: { - transaction_id: { + page_id: { /** - * T​r​a​n​s​a​c​t​i​o​n​ ​I​D + * P​a​g​e​ ​I​D */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​f​e​t​c​h​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​. + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​p​o​s​t​s​. */ longDesc: string } - include: { + fields: { /** - * I​n​c​l​u​d​e​ ​A​d​d​i​t​i​o​n​a​l​ ​D​a​t​a + * F​i​e​l​d​s */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e + * P​o​s​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​a​d​d​i​t​i​o​n​a​l​ ​r​e​l​a​t​e​d​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​d​e​t​a​i​l​s​. + * L​i​s​t​ ​o​f​ ​p​o​s​t​ ​f​i​e​l​d​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​d​a​t​a​.​ ​D​e​f​a​u​l​t​ ​i​n​c​l​u​d​e​s​ ​i​d​,​ ​m​e​s​s​a​g​e​,​ ​c​r​e​a​t​e​d​_​t​i​m​e​,​ ​p​e​r​m​a​l​i​n​k​_​u​r​l​,​ ​f​u​l​l​_​p​i​c​t​u​r​e​,​ ​i​s​_​p​u​b​l​i​s​h​e​d​,​ ​a​n​d​ ​i​s​_​h​i​d​d​e​n​. + */ + longDesc: string + } + include_hidden: { + /** + * I​n​c​l​u​d​e​ ​H​i​d​d​e​n​ ​P​o​s​t​s + */ + displayName: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​p​o​s​t​s + */ + shortDesc: string + /** + * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​w​i​l​l​ ​a​l​s​o​ ​f​i​r​e​ ​f​o​r​ ​p​o​s​t​s​ ​t​h​a​t​ ​a​r​e​ ​h​i​d​d​e​n​ ​f​r​o​m​ ​t​h​e​ ​p​a​g​e​ ​t​i​m​e​l​i​n​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​f​a​l​s​e​. */ longDesc: string } } } - list_transactions: { - groups: { - /** - * T​r​a​n​s​a​c​t​i​o​n​s - */ - '0': string - } + new_post_comment: { /** - * L​i​s​t​ ​T​r​a​n​s​a​c​t​i​o​n​s + * N​e​w​ ​P​o​s​t​ ​C​o​m​m​e​n​t */ displayName: string /** - * L​i​s​t​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​p​a​g​i​n​a​t​i​o​n + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​d​a​t​e​,​ ​c​u​s​t​o​m​e​r​,​ ​s​t​a​t​u​s​,​ ​o​r​i​g​i​n​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​,​ ​p​l​u​s​ ​p​a​g​i​n​a​t​i​o​n​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. + * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​o​m​m​e​n​t​ ​i​s​ ​a​d​d​e​d​.​ ​S​u​p​p​o​r​t​s​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​v​i​s​i​b​i​l​i​t​y​,​ ​i​n​c​l​u​d​i​n​g​ ​r​e​p​l​i​e​s​,​ ​a​n​d​ ​c​u​s​t​o​m​i​z​a​b​l​e​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​d​a​t​a​. */ longDesc: string options: { - after: { + page_id: { /** - * A​f​t​e​r + * P​a​g​e​ ​I​D */ displayName: string /** - * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r + * T​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​p​o​s​t */ shortDesc: string /** - * R​e​t​u​r​n​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​d​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​F​a​c​e​b​o​o​k​ ​p​a​g​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​o​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​m​e​n​t​s​. */ longDesc: string } - billed_at: { + post_id: { /** - * B​i​l​l​e​d​ ​A​t​ ​F​i​l​t​e​r + * P​o​s​t​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​b​i​l​l​i​n​g​ ​d​a​t​e + * T​h​e​ ​p​o​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​m​e​n​t​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​w​h​e​n​ ​t​h​e​y​ ​w​e​r​e​ ​b​i​l​l​e​d​ ​u​s​i​n​g​ ​d​a​t​e​ ​c​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​s​. + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​a​c​e​b​o​o​k​ ​p​o​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s​. */ longDesc: string - type: { - fields: { - operator: { - /** - * D​a​t​e​ ​O​p​e​r​a​t​o​r - */ - displayName: string - /** - * C​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​ ​f​o​r​ ​t​h​e​ ​d​a​t​e - */ - shortDesc: string - /** - * T​h​e​ ​o​p​e​r​a​t​o​r​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​o​m​p​a​r​i​n​g​ ​t​h​e​ ​b​i​l​l​e​d​ ​d​a​t​e​. - */ - longDesc: string - } - value: { - /** - * D​a​t​e​ ​V​a​l​u​e - */ - displayName: string - /** - * T​h​e​ ​d​a​t​e​ ​t​o​ ​c​o​m​p​a​r​e​ ​a​g​a​i​n​s​t - */ - shortDesc: string - /** - * T​h​e​ ​d​a​t​e​ ​v​a​l​u​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​r​i​s​o​n​. - */ - longDesc: string - } - } - } - } - created_at: { - /** - * C​r​e​a​t​e​d​ ​A​t​ ​F​i​l​t​e​r - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e - */ - shortDesc: string - /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​w​h​e​n​ ​t​h​e​y​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​u​s​i​n​g​ ​d​a​t​e​ ​c​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​s​. - */ - longDesc: string - type: { - fields: { - operator: { - /** - * D​a​t​e​ ​O​p​e​r​a​t​o​r - */ - displayName: string - /** - * C​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​ ​f​o​r​ ​t​h​e​ ​d​a​t​e - */ - shortDesc: string - /** - * T​h​e​ ​o​p​e​r​a​t​o​r​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​o​m​p​a​r​i​n​g​ ​t​h​e​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. - */ - longDesc: string - } - value: { - /** - * D​a​t​e​ ​V​a​l​u​e - */ - displayName: string - /** - * T​h​e​ ​d​a​t​e​ ​t​o​ ​c​o​m​p​a​r​e​ ​a​g​a​i​n​s​t - */ - shortDesc: string - /** - * T​h​e​ ​d​a​t​e​ ​v​a​l​u​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​r​i​s​o​n​. - */ - longDesc: string - } - } - } - } - updated_at: { - /** - * U​p​d​a​t​e​d​ ​A​t​ ​F​i​l​t​e​r - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​l​a​s​t​ ​u​p​d​a​t​e​ ​d​a​t​e - */ - shortDesc: string - /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​w​h​e​n​ ​t​h​e​y​ ​w​e​r​e​ ​l​a​s​t​ ​u​p​d​a​t​e​d​ ​u​s​i​n​g​ ​d​a​t​e​ ​c​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​s​. - */ - longDesc: string - type: { - fields: { - operator: { - /** - * D​a​t​e​ ​O​p​e​r​a​t​o​r - */ - displayName: string - /** - * C​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​ ​f​o​r​ ​t​h​e​ ​d​a​t​e - */ - shortDesc: string - /** - * T​h​e​ ​o​p​e​r​a​t​o​r​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​o​m​p​a​r​i​n​g​ ​t​h​e​ ​u​p​d​a​t​e​ ​d​a​t​e​. - */ - longDesc: string - } - value: { - /** - * D​a​t​e​ ​V​a​l​u​e - */ - displayName: string - /** - * T​h​e​ ​d​a​t​e​ ​t​o​ ​c​o​m​p​a​r​e​ ​a​g​a​i​n​s​t - */ - shortDesc: string - /** - * T​h​e​ ​d​a​t​e​ ​v​a​l​u​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​r​i​s​o​n​. - */ - longDesc: string - } - } - } - } - customer_id: { - /** - * C​u​s​t​o​m​e​r​ ​I​D​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​I​D​s - */ - shortDesc: string - /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​b​e​l​o​n​g​i​n​g​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​u​s​t​o​m​e​r​s​. - */ - longDesc: string - } - invoice_number: { - /** - * I​n​v​o​i​c​e​ ​N​u​m​b​e​r​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​i​n​v​o​i​c​e​ ​n​u​m​b​e​r​s - */ - shortDesc: string - /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​i​n​v​o​i​c​e​ ​n​u​m​b​e​r​s​. - */ - longDesc: string - } - origin: { - /** - * T​r​a​n​s​a​c​t​i​o​n​ ​O​r​i​g​i​n​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​o​r​i​g​i​n - */ - shortDesc: string - /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​h​o​w​ ​t​h​e​y​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​(​A​P​I​,​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​b​i​l​l​i​n​g​,​ ​e​t​c​.​)​. - */ - longDesc: string - } - order: { - /** - * S​o​r​t​ ​O​r​d​e​r - */ - displayName: string - /** - * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s - */ - shortDesc: string - /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​f​i​e​l​d​ ​a​n​d​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​. - */ - longDesc: string - type: { - fields: { - field: { - /** - * S​o​r​t​ ​F​i​e​l​d - */ - displayName: string - /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​. - */ - longDesc: string - } - direction: { - /** - * S​o​r​t​ ​D​i​r​e​c​t​i​o​n - */ - displayName: string - /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n - */ - shortDesc: string - /** - * W​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r​. - */ - longDesc: string - } - } - } } - status: { + fields: { /** - * S​t​a​t​u​s​ ​F​i​l​t​e​r + * F​i​e​l​d​s */ displayName: string /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​ ​s​t​a​t​u​s + * C​o​m​m​e​n​t​ ​f​i​e​l​d​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​t​a​t​u​s​ ​v​a​l​u​e​s​. + * L​i​s​t​ ​o​f​ ​c​o​m​m​e​n​t​ ​f​i​e​l​d​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​d​a​t​a​.​ ​D​e​f​a​u​l​t​ ​i​n​c​l​u​d​e​s​ ​i​d​,​ ​m​e​s​s​a​g​e​,​ ​c​r​e​a​t​e​d​_​t​i​m​e​,​ ​f​r​o​m​,​ ​l​i​k​e​_​c​o​u​n​t​,​ ​c​o​m​m​e​n​t​_​c​o​u​n​t​,​ ​a​n​d​ ​p​e​r​m​a​l​i​n​k​_​u​r​l​. */ longDesc: string } - subscription_id: { + include_hidden: { /** - * S​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s + * I​n​c​l​u​d​e​ ​H​i​d​d​e​n​ ​C​o​m​m​e​n​t​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​c​o​m​m​e​n​t​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​. + * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​w​i​l​l​ ​a​l​s​o​ ​f​i​r​e​ ​f​o​r​ ​c​o​m​m​e​n​t​s​ ​t​h​a​t​ ​a​r​e​ ​h​i​d​d​e​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​f​a​l​s​e​. */ longDesc: string } - per_page: { + include_replies: { /** - * P​e​r​ ​P​a​g​e + * I​n​c​l​u​d​e​ ​R​e​p​l​i​e​s */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​c​o​m​m​e​n​t​ ​r​e​p​l​i​e​s */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​. + * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​w​i​l​l​ ​i​n​c​l​u​d​e​ ​r​e​p​l​i​e​s​ ​t​o​ ​c​o​m​m​e​n​t​s​ ​i​n​ ​a​d​d​i​t​i​o​n​ ​t​o​ ​t​o​p​-​l​e​v​e​l​ ​c​o​m​m​e​n​t​s​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​t​r​u​e​. */ longDesc: string } } } } - triggers: { - new_customer: { + } + Paddle: { + /** + * P​a​d​d​l​e + */ + displayName: string + groups: { + /** + * P​a​y​m​e​n​t​ ​P​r​o​c​e​s​s​i​n​g + */ + '0': string + } + /** + * P​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​i​n​g​ ​a​n​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​m​a​n​a​g​e​m​e​n​t​ ​p​l​a​t​f​o​r​m + */ + shortDesc: string + /** + * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​P​a​d​d​l​e​ ​t​o​ ​h​a​n​d​l​e​ ​p​a​y​m​e​n​t​s​,​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​,​ ​a​n​d​ ​b​i​l​l​i​n​g​.​ ​S​u​p​p​o​r​t​s​ ​o​n​e​-​t​i​m​e​ ​p​a​y​m​e​n​t​s​,​ ​r​e​c​u​r​r​i​n​g​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​,​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​s​,​ ​a​n​d​ ​c​u​s​t​o​m​e​r​ ​m​a​n​a​g​e​m​e​n​t​ ​a​c​r​o​s​s​ ​m​u​l​t​i​p​l​e​ ​c​u​r​r​e​n​c​i​e​s​ ​a​n​d​ ​r​e​g​i​o​n​s​. + */ + longDesc: string + connectionMessage: { + /** + * C​o​n​n​e​c​t​ ​t​o​ ​P​a​d​d​l​e + */ + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​P​a​d​d​l​e​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​P​I​ ​K​e​y​*​*​ ​a​n​d​ ​t​o​ ​s​e​l​e​c​t​ ​t​h​e​ ​a​p​p​r​o​p​r​i​a​t​e​ ​*​*​E​n​v​i​r​o​n​m​e​n​t​*​*​ ​(​S​a​n​d​b​o​x​ ​o​r​ ​P​r​o​d​u​c​t​i​o​n​)​.​ + ​ + ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​A​P​I​ ​K​e​y​ + ​ + ​1​.​ ​L​o​g​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​P​a​d​d​l​e​ ​D​a​s​h​b​o​a​r​d​]​(​h​t​t​p​s​:​/​/​v​e​n​d​o​r​s​.​p​a​d​d​l​e​.​c​o​m​/​)​ + ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​*​*​D​e​v​e​l​o​p​e​r​ ​T​o​o​l​s​*​*​ ​→​ ​*​*​A​u​t​h​e​n​t​i​c​a​t​i​o​n​*​*​ + ​3​.​ ​C​l​i​c​k​ ​*​*​G​e​n​e​r​a​t​e​ ​A​P​I​ ​K​e​y​*​*​ ​o​r​ ​v​i​e​w​ ​e​x​i​s​t​i​n​g​ ​k​e​y​s​ + ​4​.​ ​C​o​p​y​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ + ​ + ​F​o​r​ ​s​a​n​d​b​o​x​ ​t​e​s​t​i​n​g​,​ ​u​s​e​ ​t​h​e​ ​[​S​a​n​d​b​o​x​ ​D​a​s​h​b​o​a​r​d​]​(​h​t​t​p​s​:​/​/​s​a​n​d​b​o​x​-​v​e​n​d​o​r​s​.​p​a​d​d​l​e​.​c​o​m​/​)​ ​i​n​s​t​e​a​d​.​ + ​ + ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ + ​ + ​#​#​#​ ​A​P​I​ ​K​e​y​ + ​Y​o​u​r​ ​P​a​d​d​l​e​ ​A​P​I​ ​k​e​y​ ​f​o​r​ ​a​u​t​h​e​n​t​i​c​a​t​i​n​g​ ​r​e​q​u​e​s​t​s​.​ ​A​P​I​ ​k​e​y​s​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​M​a​y​ ​2​0​2​5​ ​u​s​e​ ​t​h​e​ ​f​o​l​l​o​w​i​n​g​ ​f​o​r​m​a​t​:​ + ​-​ ​*​*​P​r​o​d​u​c​t​i​o​n​ ​k​e​y​s​*​*​:​ ​S​t​a​r​t​ ​w​i​t​h​ ​`​p​d​l​_​l​i​v​e​_​`​ + ​-​ ​*​*​S​a​n​d​b​o​x​ ​k​e​y​s​*​*​:​ ​S​t​a​r​t​ ​w​i​t​h​ ​`​p​d​l​_​s​d​b​x​_​`​ + ​ + ​O​l​d​e​r​ ​k​e​y​s​ ​m​a​y​ ​u​s​e​ ​d​i​f​f​e​r​e​n​t​ ​p​r​e​f​i​x​e​s​ ​b​u​t​ ​r​e​m​a​i​n​ ​f​u​n​c​t​i​o​n​a​l​.​ + ​ + ​#​#​#​ ​E​n​v​i​r​o​n​m​e​n​t​ + ​S​e​l​e​c​t​ ​t​h​e​ ​e​n​v​i​r​o​n​m​e​n​t​ ​t​h​a​t​ ​m​a​t​c​h​e​s​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​:​ + ​-​ ​*​*​P​r​o​d​u​c​t​i​o​n​*​*​:​ ​F​o​r​ ​l​i​v​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​(​`​a​p​i​.​p​a​d​d​l​e​.​c​o​m​`​)​ + ​-​ ​*​*​S​a​n​d​b​o​x​*​*​:​ ​F​o​r​ ​t​e​s​t​i​n​g​ ​a​n​d​ ​d​e​v​e​l​o​p​m​e​n​t​ ​(​`​s​a​n​d​b​o​x​-​a​p​i​.​p​a​d​d​l​e​.​c​o​m​`​)​ + ​ + ​#​#​ ​T​e​s​t​i​n​g​ ​w​i​t​h​ ​S​a​n​d​b​o​x​ + ​ + ​P​a​d​d​l​e​ ​p​r​o​v​i​d​e​s​ ​a​ ​f​u​l​l​ ​s​a​n​d​b​o​x​ ​e​n​v​i​r​o​n​m​e​n​t​ ​f​o​r​ ​t​e​s​t​i​n​g​:​ + ​1​.​ ​C​r​e​a​t​e​ ​a​ ​s​e​p​a​r​a​t​e​ ​s​a​n​d​b​o​x​ ​a​c​c​o​u​n​t​ ​a​t​ ​[​s​a​n​d​b​o​x​-​v​e​n​d​o​r​s​.​p​a​d​d​l​e​.​c​o​m​]​(​h​t​t​p​s​:​/​/​s​a​n​d​b​o​x​-​v​e​n​d​o​r​s​.​p​a​d​d​l​e​.​c​o​m​/​)​ + ​2​.​ ​G​e​n​e​r​a​t​e​ ​s​a​n​d​b​o​x​ ​A​P​I​ ​k​e​y​s​ ​f​r​o​m​ ​t​h​e​ ​s​a​n​d​b​o​x​ ​d​a​s​h​b​o​a​r​d​ + ​3​.​ ​U​s​e​ ​t​e​s​t​ ​c​a​r​d​ ​n​u​m​b​e​r​s​ ​p​r​o​v​i​d​e​d​ ​i​n​ ​P​a​d​d​l​e​'​s​ ​d​o​c​u​m​e​n​t​a​t​i​o​n​ + ​4​.​ ​A​l​l​ ​s​a​n​d​b​o​x​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​a​r​e​ ​s​i​m​u​l​a​t​e​d​ ​a​n​d​ ​w​o​n​'​t​ ​p​r​o​c​e​s​s​ ​r​e​a​l​ ​p​a​y​m​e​n​t​s​ + ​ + ​*​*​N​o​t​e​:​*​*​ ​M​a​k​e​ ​s​u​r​e​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​m​a​t​c​h​e​s​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​e​n​v​i​r​o​n​m​e​n​t​.​ ​U​s​i​n​g​ ​a​ ​p​r​o​d​u​c​t​i​o​n​ ​k​e​y​ ​w​i​t​h​ ​t​h​e​ ​s​a​n​d​b​o​x​ ​e​n​v​i​r​o​n​m​e​n​t​ ​(​o​r​ ​v​i​c​e​ ​v​e​r​s​a​)​ ​w​i​l​l​ ​r​e​s​u​l​t​ ​i​n​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​e​r​r​o​r​s​. + */ + content: string + } + actions: { + archive_product: { + groups: { + /** + * P​r​o​d​u​c​t​s + */ + '0': string + } /** - * N​e​w​ ​C​u​s​t​o​m​e​r + * A​r​c​h​i​v​e​ ​P​r​o​d​u​c​t */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​u​s​t​o​m​e​r​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. + * A​r​c​h​i​v​e​ ​a​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​c​u​s​t​o​m​e​r​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​s​t​a​t​u​s​ ​a​n​d​ ​s​e​a​r​c​h​ ​c​r​i​t​e​r​i​a​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​s​ ​t​h​a​t​ ​m​a​t​c​h​ ​y​o​u​r​ ​r​e​q​u​i​r​e​m​e​n​t​s​. + * A​r​c​h​i​v​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e​,​ ​m​a​k​i​n​g​ ​i​t​ ​u​n​a​v​a​i​l​a​b​l​e​ ​f​o​r​ ​n​e​w​ ​p​u​r​c​h​a​s​e​s​ ​w​h​i​l​e​ ​p​r​e​s​e​r​v​i​n​g​ ​h​i​s​t​o​r​i​c​a​l​ ​d​a​t​a​. */ longDesc: string options: { - status: { - /** - * S​t​a​t​u​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​s​t​a​t​u​s - */ - shortDesc: string - /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​c​u​s​t​o​m​e​r​s​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​c​u​s​t​o​m​e​r​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. - */ - longDesc: string - } - search: { + product_id: { /** - * S​e​a​r​c​h + * P​r​o​d​u​c​t​ ​I​D */ displayName: string /** - * S​e​a​r​c​h​ ​f​i​l​t​e​r​ ​f​o​r​ ​c​u​s​t​o​m​e​r​s + * T​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​a​r​c​h​i​v​e */ shortDesc: string /** - * S​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​n​a​m​e​,​ ​e​m​a​i​l​,​ ​o​r​ ​o​t​h​e​r​ ​s​e​a​r​c​h​a​b​l​e​ ​f​i​e​l​d​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​l​l​ ​c​u​s​t​o​m​e​r​s​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​a​r​c​h​i​v​e​. */ longDesc: string } } } - new_product: { + create_product: { + groups: { + /** + * P​r​o​d​u​c​t​s + */ + '0': string + } /** - * N​e​w​ ​P​r​o​d​u​c​t + * C​r​e​a​t​e​ ​P​r​o​d​u​c​t */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​p​r​o​d​u​c​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​p​r​o​d​u​c​t​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​c​a​t​a​l​o​g​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​s​t​a​t​u​s​,​ ​t​y​p​e​,​ ​a​n​d​ ​t​a​x​ ​c​a​t​e​g​o​r​y​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​p​r​o​d​u​c​t​s​ ​t​h​a​t​ ​m​a​t​c​h​ ​y​o​u​r​ ​c​r​i​t​e​r​i​a​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​t​a​x​ ​c​a​t​e​g​o​r​y​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​a​n​d​ ​o​t​h​e​r​ ​o​p​t​i​o​n​a​l​ ​p​r​o​p​e​r​t​i​e​s​. */ longDesc: string options: { - include_prices: { - /** - * I​n​c​l​u​d​e​ ​P​r​i​c​e​s - */ - displayName: string - /** - * I​n​c​l​u​d​e​ ​p​r​i​c​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e - */ - shortDesc: string - /** - * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​w​i​l​l​ ​i​n​c​l​u​d​e​ ​d​e​t​a​i​l​e​d​ ​p​r​i​c​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​e​a​c​h​ ​p​r​o​d​u​c​t​ ​i​n​ ​t​h​e​ ​e​v​e​n​t​ ​d​a​t​a​. - */ - longDesc: string - } - status: { - /** - * S​t​a​t​u​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​s​t​a​t​u​s - */ - shortDesc: string - /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. - */ - longDesc: string - } - type: { + name: { /** - * T​y​p​e + * N​a​m​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​t​y​p​e + * P​r​o​d​u​c​t​ ​n​a​m​e */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​o​f​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​t​y​p​e​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​o​f​ ​a​n​y​ ​t​y​p​e​. + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​. */ longDesc: string } @@ -110807,9900 +110086,10265 @@ type RootTranslation = { */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​t​a​x​ ​c​a​t​e​g​o​r​i​e​s - */ - shortDesc: string - /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​i​n​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​t​a​x​ ​c​a​t​e​g​o​r​i​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​i​n​ ​a​n​y​ ​t​a​x​ ​c​a​t​e​g​o​r​y​. - */ - longDesc: string - } - } - } - new_report: { - /** - * N​e​w​ ​R​e​p​o​r​t - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​r​e​p​o​r​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​r​e​p​o​r​t​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​r​e​p​o​r​t​ ​s​t​a​t​u​s​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​p​o​r​t​s​ ​i​n​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​e​s​. - */ - longDesc: string - options: { - status: { - /** - * S​t​a​t​u​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​r​e​p​o​r​t​ ​s​t​a​t​u​s - */ - shortDesc: string - /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​p​o​r​t​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​p​o​r​t​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. - */ - longDesc: string - } - } - } - new_subscription: { - /** - * N​e​w​ ​S​u​b​s​c​r​i​p​t​i​o​n - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​,​ ​p​r​i​c​e​,​ ​s​t​a​t​u​s​,​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e​,​ ​a​n​d​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​s​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​. - */ - longDesc: string - options: { - customer_id: { - /** - * C​u​s​t​o​m​e​r - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r + * T​a​x​ ​c​a​t​e​g​o​r​y​ ​f​o​r​ ​t​h​e​ ​p​r​o​d​u​c​t */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​b​e​l​o​n​g​i​n​g​ ​t​o​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​f​r​o​m​ ​a​n​y​ ​c​u​s​t​o​m​e​r​. + * T​h​e​ ​t​a​x​ ​c​a​t​e​g​o​r​y​ ​t​h​a​t​ ​a​p​p​l​i​e​s​ ​t​o​ ​t​h​i​s​ ​p​r​o​d​u​c​t​ ​f​o​r​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​ ​p​u​r​p​o​s​e​s​. */ longDesc: string } - price_id: { + description: { /** - * P​r​i​c​e​ ​I​D​s + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​r​i​c​e​ ​I​D​s + * P​r​o​d​u​c​t​ ​d​e​s​c​r​i​p​t​i​o​n */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​u​s​i​n​g​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​p​r​i​c​e​. + * A​ ​d​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​. */ longDesc: string } - status: { + type: { /** - * S​t​a​t​u​s + * T​y​p​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​s​t​a​t​u​s + * P​r​o​d​u​c​t​ ​t​y​p​e */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. + * T​h​e​ ​t​y​p​e​ ​o​f​ ​p​r​o​d​u​c​t​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. */ longDesc: string } - collection_mode: { + image_url: { /** - * C​o​l​l​e​c​t​i​o​n​ ​M​o​d​e + * I​m​a​g​e​ ​U​R​L */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e + * P​r​o​d​u​c​t​ ​i​m​a​g​e​ ​U​R​L */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e​. + * U​R​L​ ​t​o​ ​a​n​ ​i​m​a​g​e​ ​r​e​p​r​e​s​e​n​t​i​n​g​ ​t​h​e​ ​p​r​o​d​u​c​t​. */ longDesc: string } - scheduled_change_action: { + custom_data: { /** - * S​c​h​e​d​u​l​e​d​ ​C​h​a​n​g​e​ ​A​c​t​i​o​n + * C​u​s​t​o​m​ ​D​a​t​a */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​ ​a​c​t​i​o​n​s + * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​ ​a​c​t​i​o​n​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​o​r​ ​n​o​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​s​. + * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​t​o​ ​s​t​o​r​e​ ​w​i​t​h​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​a​s​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​. */ longDesc: string } } } - new_transaction: { + get_product: { + groups: { + /** + * P​r​o​d​u​c​t​s + */ + '0': string + } /** - * N​e​w​ ​T​r​a​n​s​a​c​t​i​o​n + * G​e​t​ ​P​r​o​d​u​c​t */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​t​r​a​n​s​a​c​t​i​o​n​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. + * R​e​t​r​i​e​v​e​ ​a​ ​p​r​o​d​u​c​t​ ​f​r​o​m​ ​P​a​d​d​l​e */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​,​ ​s​u​b​s​c​r​i​p​t​i​o​n​,​ ​s​t​a​t​u​s​,​ ​a​n​d​ ​o​r​i​g​i​n​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​h​a​t​ ​m​a​t​c​h​ ​y​o​u​r​ ​c​r​i​t​e​r​i​a​. + * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​r​o​d​u​c​t​ ​f​r​o​m​ ​P​a​d​d​l​e​,​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​i​n​c​l​u​s​i​o​n​ ​o​f​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n​. */ longDesc: string options: { - customer_id: { - /** - * C​u​s​t​o​m​e​r​ ​I​D​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​I​D​s - */ - shortDesc: string - /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​f​r​o​m​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​f​r​o​m​ ​a​n​y​ ​c​u​s​t​o​m​e​r​. - */ - longDesc: string - } - status: { - /** - * S​t​a​t​u​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​t​a​t​u​s - */ - shortDesc: string - /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. - */ - longDesc: string - } - subscription_id: { + product_id: { /** - * S​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s + * P​r​o​d​u​c​t​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s + * T​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​r​e​l​a​t​e​d​ ​t​o​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​f​r​o​m​ ​a​n​y​ ​s​u​b​s​c​r​i​p​t​i​o​n​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. */ longDesc: string } - origin: { + include_prices: { /** - * O​r​i​g​i​n + * I​n​c​l​u​d​e​ ​P​r​i​c​e​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​o​r​i​g​i​n + * I​n​c​l​u​d​e​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​o​r​i​g​i​n​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​o​r​i​g​i​n​. + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. */ longDesc: string } } } - } - } - Messenger360: { - /** - * 3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​f​o​r​ ​W​h​a​t​s​A​p​p - */ - displayName: string - groups: { - /** - * M​e​s​s​a​g​i​n​g​ ​&​ ​R​e​a​l​-​t​i​m​e​ ​C​o​m​m​u​n​i​c​a​t​i​o​n - */ - '0': string - } - /** - * A​u​t​o​m​a​t​e​ ​a​n​d​ ​s​e​n​d​ ​p​e​r​s​o​n​a​l​i​z​e​d​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​s​ ​u​s​i​n​g​ ​3​6​0​ ​M​e​s​s​e​n​g​e​r​. - */ - shortDesc: string - /** - * 3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​f​o​r​ ​W​h​a​t​s​A​p​p​ ​e​n​a​b​l​e​s​ ​y​o​u​ ​t​o​ ​s​e​n​d​ ​a​u​t​o​m​a​t​e​d​ ​a​n​d​ ​p​e​r​s​o​n​a​l​i​z​e​d​ ​m​e​s​s​a​g​e​s​ ​d​i​r​e​c​t​l​y​ ​t​h​r​o​u​g​h​ ​W​h​a​t​s​A​p​p​ ​B​u​s​i​n​e​s​s​ ​a​c​c​o​u​n​t​s​.​ ​I​d​e​a​l​ ​f​o​r​ ​c​u​s​t​o​m​e​r​ ​e​n​g​a​g​e​m​e​n​t​,​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​,​ ​a​n​d​ ​s​u​p​p​o​r​t​ ​w​o​r​k​f​l​o​w​s​,​ ​t​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​e​n​s​u​r​e​s​ ​f​a​s​t​ ​a​n​d​ ​r​e​l​i​a​b​l​e​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​ ​a​t​ ​s​c​a​l​e​ ​v​i​a​ ​W​h​a​t​s​A​p​p​. - */ - longDesc: string - connectionMessage: { - /** - * C​o​n​n​e​c​t​ ​t​o​ ​3​6​0​ ​M​e​s​s​e​n​g​e​r - */ - title: string - /** - * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​f​o​r​ ​W​h​a​t​s​A​p​p​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​P​I​ ​K​e​y​*​*​.​ - ​ - ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​A​P​I​ ​K​e​y​ - ​ - ​1​.​ ​S​i​g​n​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​D​a​s​h​b​o​a​r​d​]​(​h​t​t​p​s​:​/​/​3​6​0​m​e​s​s​e​n​g​e​r​.​c​o​m​/​)​ - ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​*​*​S​e​t​t​i​n​g​s​*​*​ ​o​r​ ​*​*​A​P​I​ ​S​e​t​t​i​n​g​s​*​*​ - ​3​.​ ​L​o​c​a​t​e​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​o​r​ ​g​e​n​e​r​a​t​e​ ​a​ ​n​e​w​ ​o​n​e​ - ​4​.​ ​C​o​p​y​ ​t​h​e​ ​A​P​I​ ​k​e​y​ ​f​o​r​ ​u​s​e​ ​i​n​ ​y​o​u​r​ ​i​n​t​e​g​r​a​t​i​o​n​ - ​ - ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ - ​ - ​#​#​#​ ​A​P​I​ ​K​e​y​ - ​Y​o​u​r​ ​3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​A​P​I​ ​k​e​y​ ​t​h​a​t​ ​a​u​t​h​e​n​t​i​c​a​t​e​s​ ​r​e​q​u​e​s​t​s​ ​t​o​ ​s​e​n​d​ ​a​n​d​ ​r​e​c​e​i​v​e​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​s​ ​t​h​r​o​u​g​h​ ​t​h​e​ ​p​l​a​t​f​o​r​m​.​ - ​ - ​*​*​N​o​t​e​:​*​*​ ​K​e​e​p​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​s​e​c​u​r​e​ ​a​n​d​ ​n​e​v​e​r​ ​s​h​a​r​e​ ​i​t​ ​p​u​b​l​i​c​l​y​.​ ​Y​o​u​r​ ​A​P​I​ ​k​e​y​ ​g​r​a​n​t​s​ ​f​u​l​l​ ​a​c​c​e​s​s​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​ ​o​n​ ​b​e​h​a​l​f​ ​o​f​ ​y​o​u​r​ ​W​h​a​t​s​A​p​p​ ​B​u​s​i​n​e​s​s​ ​a​c​c​o​u​n​t​. - */ - content: string - } - actions: { - get_contacts: { - /** - * G​e​t​ ​W​h​a​t​s​A​p​p​ ​C​o​n​t​a​c​t​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. - */ - shortDesc: string - /** - * F​e​t​c​h​e​s​ ​a​ ​c​o​m​p​l​e​t​e​ ​l​i​s​t​ ​o​f​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​s​ ​i​n​c​l​u​d​i​n​g​ ​t​h​e​i​r​ ​d​e​t​a​i​l​s​ ​s​u​c​h​ ​a​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​s​,​ ​b​u​s​i​n​e​s​s​ ​s​t​a​t​u​s​,​ ​a​n​d​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​. - */ - longDesc: string - options: { - } - } - get_chats: { - /** - * G​e​t​ ​W​h​a​t​s​A​p​p​ ​C​h​a​t​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​c​h​a​t​ ​c​o​n​v​e​r​s​a​t​i​o​n​s​. - */ - shortDesc: string - /** - * F​e​t​c​h​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​c​h​a​t​ ​c​o​n​v​e​r​s​a​t​i​o​n​s​ ​i​n​c​l​u​d​i​n​g​ ​c​h​a​t​ ​d​e​t​a​i​l​s​,​ ​l​a​s​t​ ​m​e​s​s​a​g​e​s​,​ ​u​n​r​e​a​d​ ​c​o​u​n​t​s​,​ ​a​n​d​ ​c​h​a​t​ ​m​e​t​a​d​a​t​a​ ​s​u​c​h​ ​a​s​ ​p​i​n​n​e​d​ ​a​n​d​ ​a​r​c​h​i​v​e​d​ ​s​t​a​t​u​s​. - */ - longDesc: string - options: { - } - } - get_groups: { - /** - * G​e​t​ ​W​h​a​t​s​A​p​p​ ​G​r​o​u​p​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​c​h​a​t​s​. - */ - shortDesc: string - /** - * F​e​t​c​h​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​c​o​n​v​e​r​s​a​t​i​o​n​s​ ​t​h​a​t​ ​y​o​u​ ​a​r​e​ ​a​ ​m​e​m​b​e​r​ ​o​f​,​ ​i​n​c​l​u​d​i​n​g​ ​g​r​o​u​p​ ​I​D​s​ ​a​n​d​ ​n​a​m​e​s​. - */ - longDesc: string - options: { + list_products: { + groups: { + /** + * P​r​o​d​u​c​t​s + */ + '0': string } - } - send_text_message: { /** - * S​e​n​d​ ​W​h​a​t​s​A​p​p​ ​T​e​x​t​ ​M​e​s​s​a​g​e + * L​i​s​t​ ​P​r​o​d​u​c​t​s */ displayName: string /** - * S​e​n​d​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​. + * L​i​s​t​ ​p​r​o​d​u​c​t​s​ ​f​r​o​m​ ​P​a​d​d​l​e */ shortDesc: string /** - * S​e​n​d​s​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​ ​b​y​ ​p​h​o​n​e​ ​n​u​m​b​e​r​.​ ​O​p​t​i​o​n​a​l​l​y​ ​i​n​c​l​u​d​e​ ​a​ ​U​R​L​ ​l​i​n​k​ ​a​n​d​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​f​o​r​ ​l​a​t​e​r​ ​d​e​l​i​v​e​r​y​. + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​p​r​o​d​u​c​t​s​ ​f​r​o​m​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​,​ ​p​a​g​i​n​a​t​i​o​n​,​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. */ longDesc: string options: { - phonenumber: { + include_prices: { /** - * P​h​o​n​e​ ​N​u​m​b​e​r + * I​n​c​l​u​d​e​ ​P​r​i​c​e​s */ displayName: string /** - * T​h​e​ ​r​e​c​i​p​i​e​n​t​'​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * I​n​c​l​u​d​e​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​h​e​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​.​ ​S​h​o​u​l​d​ ​i​n​c​l​u​d​e​ ​c​o​u​n​t​r​y​ ​c​o​d​e​. + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​e​a​c​h​ ​p​r​o​d​u​c​t​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. */ longDesc: string } - text: { + after: { /** - * M​e​s​s​a​g​e​ ​T​e​x​t + * A​f​t​e​r */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​a​s​ ​t​h​e​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​. + * A​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. */ longDesc: string } - url: { + ids: { /** - * U​R​L​ ​L​i​n​k + * P​r​o​d​u​c​t​ ​I​D​s */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​U​R​L​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e + * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​p​r​o​d​u​c​t​ ​I​D​s */ shortDesc: string /** - * A​n​ ​o​p​t​i​o​n​a​l​ ​U​R​L​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​i​n​c​l​u​d​e​d​ ​w​i​t​h​ ​t​h​e​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​f​o​r​ ​s​h​a​r​i​n​g​ ​l​i​n​k​s​. + * A​ ​l​i​s​t​ ​o​f​ ​s​p​e​c​i​f​i​c​ ​p​r​o​d​u​c​t​ ​I​D​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​I​f​ ​p​r​o​v​i​d​e​d​,​ ​o​n​l​y​ ​t​h​e​s​e​ ​p​r​o​d​u​c​t​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. */ longDesc: string } - delay: { + per_page: { /** - * S​c​h​e​d​u​l​e​d​ ​T​i​m​e + * P​e​r​ ​P​a​g​e */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​t​i​m​e​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e + * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​w​h​e​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​s​e​n​t​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​i​m​m​e​d​i​a​t​e​l​y​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​p​r​o​d​u​c​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​. */ longDesc: string } - } - } - send_group_text_message: { - /** - * S​e​n​d​ ​W​h​a​t​s​A​p​p​ ​G​r​o​u​p​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * S​e​n​d​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​. - */ - shortDesc: string - /** - * S​e​n​d​s​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​.​ ​O​p​t​i​o​n​a​l​l​y​ ​i​n​c​l​u​d​e​ ​a​ ​U​R​L​ ​l​i​n​k​ ​a​n​d​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​f​o​r​ ​l​a​t​e​r​ ​d​e​l​i​v​e​r​y​. - */ - longDesc: string - options: { - groupId: { + status: { /** - * G​r​o​u​p​ ​I​D + * S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​i​d​e​n​t​i​f​i​e​r + * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​s​t​a​t​u​s */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​. + * F​i​l​t​e​r​ ​p​r​o​d​u​c​t​s​ ​b​y​ ​t​h​e​i​r​ ​s​t​a​t​u​s​ ​(​e​.​g​.​,​ ​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​)​. */ longDesc: string } - text: { + type: { /** - * M​e​s​s​a​g​e​ ​T​e​x​t + * T​y​p​e */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​t​y​p​e */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​a​s​ ​t​h​e​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​m​e​s​s​a​g​e​. + * F​i​l​t​e​r​ ​p​r​o​d​u​c​t​s​ ​b​y​ ​t​h​e​i​r​ ​t​y​p​e​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. */ longDesc: string } - url: { + tax_category: { /** - * U​R​L​ ​L​i​n​k + * T​a​x​ ​C​a​t​e​g​o​r​i​e​s */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​U​R​L​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e + * F​i​l​t​e​r​ ​b​y​ ​t​a​x​ ​c​a​t​e​g​o​r​i​e​s */ shortDesc: string /** - * A​n​ ​o​p​t​i​o​n​a​l​ ​U​R​L​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​i​n​c​l​u​d​e​d​ ​w​i​t​h​ ​t​h​e​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​f​o​r​ ​s​h​a​r​i​n​g​ ​l​i​n​k​s​. + * F​i​l​t​e​r​ ​p​r​o​d​u​c​t​s​ ​b​y​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​t​a​x​ ​c​a​t​e​g​o​r​i​e​s​. */ longDesc: string } - delay: { + order: { /** - * S​c​h​e​d​u​l​e​d​ ​T​i​m​e + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​t​i​m​e​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e + * S​o​r​t​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​w​h​e​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​s​e​n​t​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​i​m​m​e​d​i​a​t​e​l​y​. + * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string + type: { + fields: { + field: { + /** + * S​o​r​t​ ​F​i​e​l​d + */ + displayName: string + /** + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y + */ + shortDesc: string + /** + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​b​y​. + */ + longDesc: string + } + direction: { + /** + * S​o​r​t​ ​D​i​r​e​c​t​i​o​n + */ + displayName: string + /** + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n + */ + shortDesc: string + /** + * T​h​e​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​(​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​)​. + */ + longDesc: string + } + } + } } } } - } - triggers: { - new_message: { - /** - * N​e​w​ ​W​h​a​t​s​A​p​p​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​ ​i​s​ ​r​e​c​e​i​v​e​d​. - */ - shortDesc: string - /** - * T​h​i​s​ ​w​e​b​h​o​o​k​ ​t​r​i​g​g​e​r​ ​a​c​t​i​v​a​t​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​ ​i​s​ ​r​e​c​e​i​v​e​d​ ​i​n​ ​a​n​y​ ​c​h​a​t​ ​o​r​ ​g​r​o​u​p​ ​c​o​n​v​e​r​s​a​t​i​o​n​.​ ​I​t​ ​c​a​p​t​u​r​e​s​ ​m​e​s​s​a​g​e​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​s​e​n​d​e​r​,​ ​r​e​c​i​p​i​e​n​t​,​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a​. - */ - longDesc: string - options: { - } - } - } - } - Webflow: { - /** - * W​e​b​f​l​o​w - */ - displayName: string - groups: { - /** - * E​-​c​o​m​m​e​r​c​e​ ​P​l​a​t​f​o​r​m​s - */ - '0': string - /** - * D​e​s​i​g​n​ ​&​ ​C​r​e​a​t​i​v​e​ ​T​o​o​l​s - */ - '1': string - } - /** - * W​e​b​f​l​o​w​ ​i​s​ ​a​ ​w​e​b​ ​d​e​s​i​g​n​ ​t​o​o​l​,​ ​C​M​S​,​ ​a​n​d​ ​h​o​s​t​i​n​g​ ​p​l​a​t​f​o​r​m​ ​t​h​a​t​ ​a​l​l​o​w​s​ ​u​s​e​r​s​ ​t​o​ ​b​u​i​l​d​ ​r​e​s​p​o​n​s​i​v​e​ ​w​e​b​s​i​t​e​s​ ​v​i​s​u​a​l​l​y​. - */ - shortDesc: string - /** - * W​e​b​f​l​o​w​ ​i​s​ ​a​ ​p​o​w​e​r​f​u​l​ ​w​e​b​ ​d​e​s​i​g​n​ ​t​o​o​l​ ​t​h​a​t​ ​c​o​m​b​i​n​e​s​ ​t​h​e​ ​f​l​e​x​i​b​i​l​i​t​y​ ​o​f​ ​a​ ​C​M​S​ ​w​i​t​h​ ​t​h​e​ ​e​a​s​e​ ​o​f​ ​u​s​e​ ​o​f​ ​a​ ​v​i​s​u​a​l​ ​e​d​i​t​o​r​.​ ​I​t​ ​a​l​l​o​w​s​ ​u​s​e​r​s​ ​t​o​ ​c​r​e​a​t​e​ ​r​e​s​p​o​n​s​i​v​e​ ​w​e​b​s​i​t​e​s​ ​w​i​t​h​o​u​t​ ​w​r​i​t​i​n​g​ ​c​o​d​e​,​ ​m​a​k​i​n​g​ ​i​t​ ​a​c​c​e​s​s​i​b​l​e​ ​f​o​r​ ​d​e​s​i​g​n​e​r​s​ ​a​n​d​ ​d​e​v​e​l​o​p​e​r​s​ ​a​l​i​k​e​.​ ​W​i​t​h​ ​W​e​b​f​l​o​w​,​ ​y​o​u​ ​c​a​n​ ​d​e​s​i​g​n​,​ ​b​u​i​l​d​,​ ​a​n​d​ ​l​a​u​n​c​h​ ​w​e​b​s​i​t​e​s​ ​a​l​l​ ​i​n​ ​o​n​e​ ​p​l​a​t​f​o​r​m​,​ ​s​t​r​e​a​m​l​i​n​i​n​g​ ​t​h​e​ ​w​e​b​ ​d​e​v​e​l​o​p​m​e​n​t​ ​p​r​o​c​e​s​s​. - */ - longDesc: string - actions: { - create_item: { + update_product: { groups: { /** - * C​o​l​l​e​c​t​i​o​n​s + * P​r​o​d​u​c​t​s */ '0': string } /** - * C​r​e​a​t​e​ ​I​t​e​m + * U​p​d​a​t​e​ ​P​r​o​d​u​c​t */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​i​t​e​m​ ​i​n​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n + * U​p​d​a​t​e​ ​a​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​i​t​e​m​ ​w​i​t​h​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​d​a​t​a​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​.​ ​Y​o​u​ ​c​a​n​ ​s​e​t​ ​t​h​e​ ​i​t​e​m​ ​a​s​ ​a​r​c​h​i​v​e​d​ ​o​r​ ​d​r​a​f​t​ ​a​n​d​ ​s​p​e​c​i​f​y​ ​a​ ​C​M​S​ ​l​o​c​a​l​e​. + * U​p​d​a​t​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​n​e​w​ ​i​n​f​o​r​m​a​t​i​o​n​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​s​t​a​t​u​s​,​ ​o​r​ ​o​t​h​e​r​ ​p​r​o​p​e​r​t​i​e​s​. */ longDesc: string options: { - site: { + product_id: { /** - * S​i​t​e + * P​r​o​d​u​c​t​ ​I​D */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) + * T​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - collection: { + name: { /** - * C​o​l​l​e​c​t​i​o​n + * N​a​m​e */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​i​t​e​m​ ​i​n + * P​r​o​d​u​c​t​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​n​e​w​ ​i​t​e​m + * T​h​e​ ​u​p​d​a​t​e​d​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​. */ longDesc: string } - isArchived: { + tax_category: { /** - * I​s​ ​A​r​c​h​i​v​e​d + * T​a​x​ ​C​a​t​e​g​o​r​y */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​h​e​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​b​e​ ​a​r​c​h​i​v​e​d + * T​a​x​ ​c​a​t​e​g​o​r​y​ ​f​o​r​ ​t​h​e​ ​p​r​o​d​u​c​t */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​i​f​ ​y​o​u​ ​w​a​n​t​ ​t​h​e​ ​i​t​e​m​ ​t​o​ ​b​e​ ​a​r​c​h​i​v​e​d​ ​u​p​o​n​ ​c​r​e​a​t​i​o​n + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​a​x​ ​c​a​t​e​g​o​r​y​ ​t​h​a​t​ ​a​p​p​l​i​e​s​ ​t​o​ ​t​h​i​s​ ​p​r​o​d​u​c​t​ ​f​o​r​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​ ​p​u​r​p​o​s​e​s​. */ longDesc: string } - isDraft: { + description: { /** - * I​s​ ​D​r​a​f​t + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​h​e​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​b​e​ ​a​ ​d​r​a​f​t + * P​r​o​d​u​c​t​ ​d​e​s​c​r​i​p​t​i​o​n */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​i​f​ ​y​o​u​ ​w​a​n​t​ ​t​h​e​ ​i​t​e​m​ ​t​o​ ​b​e​ ​s​a​v​e​d​ ​a​s​ ​a​ ​d​r​a​f​t​ ​(​d​e​f​a​u​l​t​:​ ​t​r​u​e​) + * T​h​e​ ​u​p​d​a​t​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​. */ longDesc: string } - cmsLocaleId: { + status: { /** - * C​M​S​ ​L​o​c​a​l​e​ ​I​D + * S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​l​o​c​a​l​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​i​t​e​m + * P​r​o​d​u​c​t​ ​s​t​a​t​u​s */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​C​M​S​ ​l​o​c​a​l​e​ ​I​D​ ​i​f​ ​w​o​r​k​i​n​g​ ​w​i​t​h​ ​a​ ​m​u​l​t​i​-​l​o​c​a​l​e​ ​s​i​t​e + * T​h​e​ ​u​p​d​a​t​e​d​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​(​e​.​g​.​,​ ​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​)​. */ longDesc: string } - } - } - delete_item: { - groups: { - /** - * C​o​l​l​e​c​t​i​o​n​s - */ - '0': string - } - /** - * D​e​l​e​t​e​ ​I​t​e​m - */ - displayName: string - /** - * D​e​l​e​t​e​ ​a​n​ ​i​t​e​m​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n - */ - shortDesc: string - /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​i​t​e​m​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. - */ - longDesc: string - options: { - item: { + type: { /** - * I​t​e​m + * T​y​p​e */ displayName: string /** - * T​h​e​ ​i​t​e​m​ ​t​o​ ​d​e​l​e​t​e + * P​r​o​d​u​c​t​ ​t​y​p​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​l​l​e​c​t​i​o​n + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​y​p​e​ ​o​f​ ​p​r​o​d​u​c​t​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. */ longDesc: string } - site: { + image_url: { /** - * S​i​t​e + * I​m​a​g​e​ ​U​R​L */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) + * P​r​o​d​u​c​t​ ​i​m​a​g​e​ ​U​R​L */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + * U​p​d​a​t​e​d​ ​U​R​L​ ​t​o​ ​a​n​ ​i​m​a​g​e​ ​r​e​p​r​e​s​e​n​t​i​n​g​ ​t​h​e​ ​p​r​o​d​u​c​t​. */ longDesc: string } - collection: { + custom_data: { /** - * C​o​l​l​e​c​t​i​o​n + * C​u​s​t​o​m​ ​D​a​t​a */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​i​t​e​m + * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e + * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​t​o​ ​s​t​o​r​e​ ​w​i​t​h​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​a​s​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​. */ longDesc: string } } } - get_collection: { + create_price: { groups: { /** - * C​o​l​l​e​c​t​i​o​n​s + * P​r​i​c​e​s */ '0': string } /** - * G​e​t​ ​C​o​l​l​e​c​t​i​o​n + * C​r​e​a​t​e​ ​P​r​i​c​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​r​i​c​e​ ​f​o​r​ ​a​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e */ shortDesc: string /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​f​i​e​l​d​s​,​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​p​r​i​c​e​ ​f​o​r​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​p​r​o​d​u​c​t​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​u​n​i​t​ ​p​r​i​c​e​,​ ​b​i​l​l​i​n​g​ ​c​y​c​l​e​,​ ​t​a​x​ ​m​o​d​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​p​r​i​c​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​s​. */ longDesc: string options: { - site: { + product_id: { /** - * S​i​t​e + * P​r​o​d​u​c​t​ ​I​D */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) + * T​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​p​r​i​c​e​ ​f​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​p​r​i​c​e​ ​f​o​r​. */ longDesc: string } - collection: { + description: { /** - * C​o​l​l​e​c​t​i​o​n + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e + * P​r​i​c​e​ ​d​e​s​c​r​i​p​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t + * A​ ​d​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​i​s​ ​p​r​i​c​e​ ​o​p​t​i​o​n​. */ longDesc: string } - } - } - get_item: { - groups: { - /** - * C​o​l​l​e​c​t​i​o​n​s - */ - '0': string - } - /** - * G​e​t​ ​I​t​e​m - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n - */ - shortDesc: string - /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​,​ ​i​n​c​l​u​d​i​n​g​ ​a​l​l​ ​i​t​s​ ​f​i​e​l​d​ ​d​a​t​a​. - */ - longDesc: string - options: { - item: { + unit_price: { /** - * I​t​e​m + * U​n​i​t​ ​P​r​i​c​e */ displayName: string /** - * T​h​e​ ​i​t​e​m​ ​t​o​ ​r​e​t​r​i​e​v​e + * B​a​s​e​ ​u​n​i​t​ ​p​r​i​c​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​l​l​e​c​t​i​o​n + * T​h​e​ ​b​a​s​e​ ​u​n​i​t​ ​p​r​i​c​e​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​i​n​g​ ​o​p​t​i​o​n​. */ longDesc: string + type: { + fields: { + amount: { + /** + * A​m​o​u​n​t + */ + displayName: string + /** + * P​r​i​c​e​ ​a​m​o​u​n​t + */ + shortDesc: string + /** + * T​h​e​ ​p​r​i​c​e​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​ ​(​e​.​g​.​,​ ​"​9​.​9​9​"​)​. + */ + longDesc: string + } + currencyCode: { + /** + * C​u​r​r​e​n​c​y​ ​C​o​d​e + */ + displayName: string + /** + * C​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​p​r​i​c​e + */ + shortDesc: string + /** + * T​h​e​ ​t​h​r​e​e​-​l​e​t​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​(​e​.​g​.​,​ ​U​S​D​,​ ​E​U​R​,​ ​G​B​P​)​. + */ + longDesc: string + } + } + } } - site: { + type: { /** - * S​i​t​e + * T​y​p​e */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) + * P​r​i​c​e​ ​t​y​p​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + * T​h​e​ ​t​y​p​e​ ​o​f​ ​p​r​i​c​i​n​g​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. */ longDesc: string } - collection: { + name: { /** - * C​o​l​l​e​c​t​i​o​n + * N​a​m​e */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​i​t​e​m + * P​r​i​c​e​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * A​ ​f​r​i​e​n​d​l​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​i​n​g​ ​o​p​t​i​o​n​. */ longDesc: string } - cmsLocaleId: { + billing_cycle: { /** - * C​M​S​ ​L​o​c​a​l​e​ ​I​D + * B​i​l​l​i​n​g​ ​C​y​c​l​e */ displayName: string /** - * T​h​e​ ​l​o​c​a​l​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​i​t​e​m + * B​i​l​l​i​n​g​ ​f​r​e​q​u​e​n​c​y​ ​a​n​d​ ​i​n​t​e​r​v​a​l */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​C​M​S​ ​l​o​c​a​l​e​ ​I​D​ ​i​f​ ​w​o​r​k​i​n​g​ ​w​i​t​h​ ​a​ ​m​u​l​t​i​-​l​o​c​a​l​e​ ​s​i​t​e + * D​e​f​i​n​e​s​ ​h​o​w​ ​o​f​t​e​n​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​i​s​ ​b​i​l​l​e​d​ ​f​o​r​ ​r​e​c​u​r​r​i​n​g​ ​p​r​i​c​e​s​. */ longDesc: string + type: { + fields: { + frequency: { + /** + * F​r​e​q​u​e​n​c​y + */ + displayName: string + /** + * B​i​l​l​i​n​g​ ​f​r​e​q​u​e​n​c​y​ ​n​u​m​b​e​r + */ + shortDesc: string + /** + * H​o​w​ ​m​a​n​y​ ​i​n​t​e​r​v​a​l​s​ ​b​e​t​w​e​e​n​ ​e​a​c​h​ ​b​i​l​l​i​n​g​ ​(​e​.​g​.​,​ ​1​ ​f​o​r​ ​e​v​e​r​y​ ​m​o​n​t​h​,​ ​2​ ​f​o​r​ ​e​v​e​r​y​ ​2​ ​m​o​n​t​h​s​)​. + */ + longDesc: string + } + interval: { + /** + * I​n​t​e​r​v​a​l + */ + displayName: string + /** + * B​i​l​l​i​n​g​ ​i​n​t​e​r​v​a​l​ ​u​n​i​t + */ + shortDesc: string + /** + * T​h​e​ ​t​i​m​e​ ​u​n​i​t​ ​f​o​r​ ​b​i​l​l​i​n​g​ ​(​e​.​g​.​,​ ​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​,​ ​y​e​a​r​)​. + */ + longDesc: string + } + } + } } - } - } - get_order: { - groups: { - /** - * O​r​d​e​r​s - */ - '0': string - } - /** - * G​e​t​ ​O​r​d​e​r - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​f​r​o​m​ ​W​e​b​f​l​o​w - */ - shortDesc: string - /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​f​r​o​m​ ​W​e​b​f​l​o​w​,​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​,​ ​p​u​r​c​h​a​s​e​d​ ​i​t​e​m​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​. - */ - longDesc: string - options: { - site: { + trial_period: { /** - * S​i​t​e + * T​r​i​a​l​ ​P​e​r​i​o​d */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e + * F​r​e​e​ ​t​r​i​a​l​ ​c​o​n​f​i​g​u​r​a​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​o​r​d​e​r + * D​e​f​i​n​e​s​ ​t​h​e​ ​l​e​n​g​t​h​ ​o​f​ ​t​h​e​ ​f​r​e​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​e​. */ longDesc: string + type: { + fields: { + frequency: { + /** + * T​r​i​a​l​ ​F​r​e​q​u​e​n​c​y + */ + displayName: string + /** + * T​r​i​a​l​ ​p​e​r​i​o​d​ ​l​e​n​g​t​h + */ + shortDesc: string + /** + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​i​n​t​e​r​v​a​l​s​ ​f​o​r​ ​t​h​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​. + */ + longDesc: string + } + interval: { + /** + * T​r​i​a​l​ ​I​n​t​e​r​v​a​l + */ + displayName: string + /** + * T​r​i​a​l​ ​p​e​r​i​o​d​ ​u​n​i​t + */ + shortDesc: string + /** + * T​h​e​ ​t​i​m​e​ ​u​n​i​t​ ​f​o​r​ ​t​h​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​(​e​.​g​.​,​ ​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​)​. + */ + longDesc: string + } + } + } } - order: { + tax_mode: { /** - * O​r​d​e​r + * T​a​x​ ​M​o​d​e */ displayName: string /** - * T​h​e​ ​o​r​d​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e + * H​o​w​ ​t​a​x​ ​i​s​ ​c​a​l​c​u​l​a​t​e​d */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t + * D​e​t​e​r​m​i​n​e​s​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​p​r​i​c​e​ ​i​n​c​l​u​d​e​s​ ​t​a​x​ ​o​r​ ​i​f​ ​t​a​x​ ​i​s​ ​a​d​d​e​d​ ​o​n​ ​t​o​p​. */ longDesc: string } - } - } - get_site: { - groups: { - /** - * S​i​t​e​s - */ - '0': string - } - /** - * G​e​t​ ​S​i​t​e - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e - */ - shortDesc: string - /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​s​e​t​t​i​n​g​s​,​ ​d​o​m​a​i​n​s​,​ ​a​n​d​ ​l​o​c​a​l​e​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​. - */ - longDesc: string - options: { - site: { + unit_price_overrides: { /** - * S​i​t​e + * P​r​i​c​e​ ​O​v​e​r​r​i​d​e​s */ displayName: string /** - * T​h​e​ ​s​i​t​e​ ​t​o​ ​r​e​t​r​i​e​v​e + * C​o​u​n​t​r​y​-​s​p​e​c​i​f​i​c​ ​p​r​i​c​i​n​g */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​b​a​s​e​ ​p​r​i​c​e​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​c​o​u​n​t​r​i​e​s​ ​o​r​ ​r​e​g​i​o​n​s​. + */ + longDesc: string + type: { + element_type: { + fields: { + countryCodes: { + /** + * C​o​u​n​t​r​y​ ​C​o​d​e​s + */ + displayName: string + /** + * C​o​u​n​t​r​i​e​s​ ​f​o​r​ ​t​h​i​s​ ​o​v​e​r​r​i​d​e + */ + shortDesc: string + /** + * L​i​s​t​ ​o​f​ ​I​S​O​ ​c​o​u​n​t​r​y​ ​c​o​d​e​s​ ​w​h​e​r​e​ ​t​h​i​s​ ​p​r​i​c​e​ ​o​v​e​r​r​i​d​e​ ​a​p​p​l​i​e​s​. + */ + longDesc: string + } + unitPrice: { + /** + * O​v​e​r​r​i​d​e​ ​P​r​i​c​e + */ + displayName: string + /** + * P​r​i​c​e​ ​f​o​r​ ​t​h​e​s​e​ ​c​o​u​n​t​r​i​e​s + */ + shortDesc: string + /** + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​c​o​u​n​t​r​i​e​s​. + */ + longDesc: string + type: { + fields: { + amount: { + /** + * O​v​e​r​r​i​d​e​ ​A​m​o​u​n​t + */ + displayName: string + /** + * O​v​e​r​r​i​d​e​ ​p​r​i​c​e​ ​a​m​o​u​n​t + */ + shortDesc: string + /** + * T​h​e​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​. + */ + longDesc: string + } + currencyCode: { + /** + * O​v​e​r​r​i​d​e​ ​C​u​r​r​e​n​c​y + */ + displayName: string + /** + * C​u​r​r​e​n​c​y​ ​f​o​r​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e + */ + shortDesc: string + /** + * T​h​e​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e​. + */ + longDesc: string + } + } + } + } + } + } + } + } + quantity: { + /** + * Q​u​a​n​t​i​t​y​ ​L​i​m​i​t​s + */ + displayName: string + /** + * M​i​n​i​m​u​m​ ​a​n​d​ ​m​a​x​i​m​u​m​ ​q​u​a​n​t​i​t​y + */ + shortDesc: string + /** + * S​e​t​ ​l​i​m​i​t​s​ ​o​n​ ​h​o​w​ ​m​a​n​y​ ​u​n​i​t​s​ ​c​a​n​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. */ longDesc: string + type: { + fields: { + minimum: { + /** + * M​i​n​i​m​u​m​ ​Q​u​a​n​t​i​t​y + */ + displayName: string + /** + * M​i​n​i​m​u​m​ ​p​u​r​c​h​a​s​e​ ​q​u​a​n​t​i​t​y + */ + shortDesc: string + /** + * T​h​e​ ​m​i​n​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​t​h​a​t​ ​m​u​s​t​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. + */ + longDesc: string + } + maximum: { + /** + * M​a​x​i​m​u​m​ ​Q​u​a​n​t​i​t​y + */ + displayName: string + /** + * M​a​x​i​m​u​m​ ​p​u​r​c​h​a​s​e​ ​q​u​a​n​t​i​t​y + */ + shortDesc: string + /** + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. + */ + longDesc: string + } + } + } } - } - } - list_collections: { - groups: { - /** - * C​o​l​l​e​c​t​i​o​n​s - */ - '0': string - } - /** - * L​i​s​t​ ​C​o​l​l​e​c​t​i​o​n​s - */ - displayName: string - /** - * L​i​s​t​ ​a​l​l​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​i​t​h​ ​t​h​e​i​r​ ​b​a​s​i​c​ ​i​n​f​o​r​m​a​t​i​o​n​. - */ - longDesc: string - options: { - site: { + custom_data: { /** - * S​i​t​e + * C​u​s​t​o​m​ ​D​a​t​a */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e + * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​l​i​s​t​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m + * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​t​o​ ​s​t​o​r​e​ ​w​i​t​h​ ​t​h​e​ ​p​r​i​c​e​ ​a​s​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​. */ longDesc: string } } } - list_custom_domains: { + get_price: { groups: { /** - * S​i​t​e​s + * P​r​i​c​e​s */ '0': string } /** - * L​i​s​t​ ​C​u​s​t​o​m​ ​D​o​m​a​i​n​s + * G​e​t​ ​P​r​i​c​e */ displayName: string /** - * L​i​s​t​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​f​o​r​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e + * R​e​t​r​i​e​v​e​ ​a​ ​p​r​i​c​e​ ​f​r​o​m​ ​P​a​d​d​l​e */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​. + * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​f​r​o​m​ ​P​a​d​d​l​e​,​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​i​n​c​l​u​s​i​o​n​ ​o​f​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​. */ longDesc: string options: { - site: { + price_id: { /** - * S​i​t​e + * P​r​i​c​e​ ​I​D */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e + * T​h​e​ ​p​r​i​c​e​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​l​i​s​t​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​f​r​o​m + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​i​c​e​ ​t​o​ ​r​e​t​r​i​e​v​e​. + */ + longDesc: string + } + include_product: { + /** + * I​n​c​l​u​d​e​ ​P​r​o​d​u​c​t + */ + displayName: string + /** + * I​n​c​l​u​d​e​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n + */ + shortDesc: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​h​e​ ​a​s​s​o​c​i​a​t​e​d​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. */ longDesc: string } } } - list_items: { + list_prices: { groups: { /** - * C​o​l​l​e​c​t​i​o​n​s + * P​r​i​c​e​s */ '0': string } /** - * L​i​s​t​ ​I​t​e​m​s + * L​i​s​t​ ​P​r​i​c​e​s */ displayName: string /** - * L​i​s​t​ ​i​t​e​m​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n + * L​i​s​t​ ​p​r​i​c​e​s​ ​f​r​o​m​ ​P​a​d​d​l​e */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​i​t​e​m​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​p​r​i​c​e​s​ ​f​r​o​m​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​p​r​o​d​u​c​t​,​ ​s​t​a​t​u​s​,​ ​t​y​p​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​,​ ​p​l​u​s​ ​s​o​r​t​i​n​g​ ​a​n​d​ ​p​a​g​i​n​a​t​i​o​n​ ​o​p​t​i​o​n​s​. */ longDesc: string options: { - site: { + include_product: { /** - * S​i​t​e + * I​n​c​l​u​d​e​ ​P​r​o​d​u​c​t */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) + * I​n​c​l​u​d​e​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​h​e​ ​a​s​s​o​c​i​a​t​e​d​ ​p​r​o​d​u​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​e​a​c​h​ ​p​r​i​c​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. */ longDesc: string } - collection: { + after: { /** - * C​o​l​l​e​c​t​i​o​n + * A​f​t​e​r */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​l​i​s​t​ ​i​t​e​m​s​ ​f​r​o​m + * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t​ ​i​t​e​m​s​ ​f​r​o​m + * A​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. */ longDesc: string } - cmsLocaleId: { + ids: { /** - * C​M​S​ ​L​o​c​a​l​e​ ​I​D + * P​r​i​c​e​ ​I​D​s */ displayName: string /** - * T​h​e​ ​l​o​c​a​l​e​ ​I​D​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​i​t​e​m​s + * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​I​D​s */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​C​M​S​ ​l​o​c​a​l​e​ ​I​D​ ​t​o​ ​f​i​l​t​e​r​ ​i​t​e​m​s​ ​b​y​ ​l​o​c​a​l​e + * A​ ​l​i​s​t​ ​o​f​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​I​D​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​I​f​ ​p​r​o​v​i​d​e​d​,​ ​o​n​l​y​ ​t​h​e​s​e​ ​p​r​i​c​e​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. */ longDesc: string } - offset: { + product_ids: { /** - * O​f​f​s​e​t + * P​r​o​d​u​c​t​ ​I​D​s */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​s​k​i​p + * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​I​D​s */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​(​d​e​f​a​u​l​t​:​ ​0​) + * A​ ​l​i​s​t​ ​o​f​ ​p​r​o​d​u​c​t​ ​I​D​s​ ​t​o​ ​f​i​l​t​e​r​ ​p​r​i​c​e​s​ ​b​y​.​ ​O​n​l​y​ ​p​r​i​c​e​s​ ​f​o​r​ ​t​h​e​s​e​ ​p​r​o​d​u​c​t​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. */ longDesc: string } - limit: { + per_page: { /** - * L​i​m​i​t + * P​e​r​ ​P​a​g​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​r​e​t​u​r​n + * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​p​r​i​c​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​. */ longDesc: string } - name: { + status: { /** - * N​a​m​e + * S​t​a​t​u​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​i​t​e​m​ ​n​a​m​e + * F​i​l​t​e​r​ ​b​y​ ​p​r​i​c​e​ ​s​t​a​t​u​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​i​t​e​m​s​ ​b​y​ ​t​h​e​i​r​ ​n​a​m​e​ ​f​i​e​l​d + * F​i​l​t​e​r​ ​p​r​i​c​e​s​ ​b​y​ ​t​h​e​i​r​ ​s​t​a​t​u​s​ ​(​e​.​g​.​,​ ​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​)​. */ longDesc: string } - slug: { + recurring: { /** - * S​l​u​g + * R​e​c​u​r​r​i​n​g​ ​O​n​l​y */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​i​t​e​m​ ​s​l​u​g + * F​i​l​t​e​r​ ​b​y​ ​r​e​c​u​r​r​i​n​g​ ​p​r​i​c​e​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​i​t​e​m​s​ ​b​y​ ​t​h​e​i​r​ ​s​l​u​g​ ​f​i​e​l​d + * W​h​e​t​h​e​r​ ​t​o​ ​o​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​u​r​r​i​n​g​ ​p​r​i​c​e​s​ ​(​w​i​t​h​ ​b​i​l​l​i​n​g​ ​c​y​c​l​e​s​)​. */ longDesc: string } - lastPublished: { + type: { /** - * L​a​s​t​ ​P​u​b​l​i​s​h​e​d + * T​y​p​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​u​b​l​i​c​a​t​i​o​n​ ​d​a​t​e​ ​r​a​n​g​e + * F​i​l​t​e​r​ ​b​y​ ​p​r​i​c​e​ ​t​y​p​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​i​t​e​m​s​ ​b​y​ ​t​h​e​i​r​ ​l​a​s​t​ ​p​u​b​l​i​s​h​e​d​ ​d​a​t​e​ ​r​a​n​g​e + * F​i​l​t​e​r​ ​p​r​i​c​e​s​ ​b​y​ ​t​h​e​i​r​ ​t​y​p​e​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. + */ + longDesc: string + } + order: { + /** + * S​o​r​t​ ​O​r​d​e​r + */ + displayName: string + /** + * S​o​r​t​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + */ + shortDesc: string + /** + * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string type: { fields: { - lte: { + field: { /** - * L​e​s​s​ ​T​h​a​n​ ​o​r​ ​E​q​u​a​l​ ​T​o + * S​o​r​t​ ​F​i​e​l​d */ displayName: string /** - * I​t​e​m​s​ ​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​o​r​ ​o​n​ ​t​h​i​s​ ​d​a​t​e + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y */ shortDesc: string /** - * I​n​c​l​u​d​e​ ​i​t​e​m​s​ ​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​o​r​ ​o​n​ ​t​h​i​s​ ​d​a​t​e + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​b​y​. */ longDesc: string } - gte: { + direction: { /** - * G​r​e​a​t​e​r​ ​T​h​a​n​ ​o​r​ ​E​q​u​a​l​ ​T​o + * S​o​r​t​ ​D​i​r​e​c​t​i​o​n */ displayName: string /** - * I​t​e​m​s​ ​p​u​b​l​i​s​h​e​d​ ​a​f​t​e​r​ ​o​r​ ​o​n​ ​t​h​i​s​ ​d​a​t​e + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n */ shortDesc: string /** - * I​n​c​l​u​d​e​ ​i​t​e​m​s​ ​p​u​b​l​i​s​h​e​d​ ​a​f​t​e​r​ ​o​r​ ​o​n​ ​t​h​i​s​ ​d​a​t​e + * T​h​e​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​(​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​)​. */ longDesc: string } } } } - sortBy: { + } + } + update_price: { + groups: { + /** + * P​r​i​c​e​s + */ + '0': string + } + /** + * U​p​d​a​t​e​ ​P​r​i​c​e + */ + displayName: string + /** + * U​p​d​a​t​e​ ​a​ ​p​r​i​c​e​ ​i​n​ ​P​a​d​d​l​e + */ + shortDesc: string + /** + * U​p​d​a​t​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​p​r​i​c​e​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​n​e​w​ ​p​r​i​c​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​b​i​l​l​i​n​g​ ​c​y​c​l​e​s​,​ ​t​a​x​ ​s​e​t​t​i​n​g​s​,​ ​o​r​ ​o​t​h​e​r​ ​p​r​i​c​e​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​s​. + */ + longDesc: string + options: { + price_id: { /** - * S​o​r​t​ ​B​y + * P​r​i​c​e​ ​I​D */ displayName: string /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​i​t​e​m​s​ ​b​y + * T​h​e​ ​p​r​i​c​e​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​i​t​e​m​s​ ​b​y + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​i​c​e​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - sortOrder: { + description: { /** - * S​o​r​t​ ​O​r​d​e​r + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n + * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​d​e​s​c​r​i​p​t​i​o​n */ shortDesc: string /** - * C​h​o​o​s​e​ ​w​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r + * A​n​ ​u​p​d​a​t​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​e​ ​o​p​t​i​o​n​. */ longDesc: string } - } - } - list_orders: { - groups: { - /** - * O​r​d​e​r​s - */ - '0': string - } - /** - * L​i​s​t​ ​O​r​d​e​r​s - */ - displayName: string - /** - * L​i​s​t​ ​o​r​d​e​r​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​o​r​d​e​r​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​. - */ - longDesc: string - options: { - site: { + unit_price: { /** - * S​i​t​e + * U​n​i​t​ ​P​r​i​c​e */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e + * U​p​d​a​t​e​d​ ​u​n​i​t​ ​p​r​i​c​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​l​i​s​t​ ​o​r​d​e​r​s​ ​f​r​o​m + * T​h​e​ ​u​p​d​a​t​e​d​ ​b​a​s​e​ ​u​n​i​t​ ​p​r​i​c​e​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​i​n​g​ ​o​p​t​i​o​n​. */ longDesc: string + type: { + fields: { + amount: { + /** + * A​m​o​u​n​t + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​a​m​o​u​n​t + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​p​r​i​c​e​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​ ​(​e​.​g​.​,​ ​"​9​.​9​9​"​)​. + */ + longDesc: string + } + currencyCode: { + /** + * C​u​r​r​e​n​c​y​ ​C​o​d​e + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​c​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​p​r​i​c​e + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​h​r​e​e​-​l​e​t​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​(​e​.​g​.​,​ ​U​S​D​,​ ​E​U​R​,​ ​G​B​P​)​. + */ + longDesc: string + } + } + } } - status: { + type: { /** - * S​t​a​t​u​s + * T​y​p​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​o​r​d​e​r​ ​s​t​a​t​u​s + * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​t​y​p​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​o​r​d​e​r​s​ ​b​y​ ​t​h​e​i​r​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​y​p​e​ ​o​f​ ​p​r​i​c​i​n​g​ ​(​e​.​g​.​,​ ​s​t​a​n​d​a​r​d​,​ ​d​i​g​i​t​a​l​)​. */ longDesc: string } - offset: { + name: { /** - * O​f​f​s​e​t + * N​a​m​e */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​o​r​d​e​r​s​ ​t​o​ ​s​k​i​p + * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​n​a​m​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​o​r​d​e​r​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * A​n​ ​u​p​d​a​t​e​d​ ​f​r​i​e​n​d​l​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​i​n​g​ ​o​p​t​i​o​n​. */ longDesc: string } - limit: { + billing_cycle: { /** - * L​i​m​i​t + * B​i​l​l​i​n​g​ ​C​y​c​l​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​o​r​d​e​r​s​ ​t​o​ ​r​e​t​u​r​n + * U​p​d​a​t​e​d​ ​b​i​l​l​i​n​g​ ​f​r​e​q​u​e​n​c​y */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​o​r​d​e​r​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * U​p​d​a​t​e​d​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​f​o​r​ ​h​o​w​ ​o​f​t​e​n​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​i​s​ ​b​i​l​l​e​d​ ​f​o​r​ ​r​e​c​u​r​r​i​n​g​ ​p​r​i​c​e​s​. + */ + longDesc: string + type: { + fields: { + frequency: { + /** + * F​r​e​q​u​e​n​c​y + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​b​i​l​l​i​n​g​ ​f​r​e​q​u​e​n​c​y + */ + shortDesc: string + /** + * U​p​d​a​t​e​d​ ​n​u​m​b​e​r​ ​o​f​ ​i​n​t​e​r​v​a​l​s​ ​b​e​t​w​e​e​n​ ​e​a​c​h​ ​b​i​l​l​i​n​g​. + */ + longDesc: string + } + interval: { + /** + * I​n​t​e​r​v​a​l + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​b​i​l​l​i​n​g​ ​i​n​t​e​r​v​a​l + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​i​m​e​ ​u​n​i​t​ ​f​o​r​ ​b​i​l​l​i​n​g​ ​(​e​.​g​.​,​ ​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​,​ ​y​e​a​r​)​. + */ + longDesc: string + } + } + } + } + trial_period: { + /** + * T​r​i​a​l​ ​P​e​r​i​o​d + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​t​r​i​a​l​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + */ + shortDesc: string + /** + * U​p​d​a​t​e​d​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​f​r​e​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​f​o​r​ ​t​h​i​s​ ​p​r​i​c​e​. */ longDesc: string + type: { + fields: { + frequency: { + /** + * T​r​i​a​l​ ​F​r​e​q​u​e​n​c​y + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​l​e​n​g​t​h + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​n​u​m​b​e​r​ ​o​f​ ​i​n​t​e​r​v​a​l​s​ ​f​o​r​ ​t​h​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​. + */ + longDesc: string + } + interval: { + /** + * T​r​i​a​l​ ​I​n​t​e​r​v​a​l + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​u​n​i​t + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​i​m​e​ ​u​n​i​t​ ​f​o​r​ ​t​h​e​ ​t​r​i​a​l​ ​p​e​r​i​o​d​ ​(​e​.​g​.​,​ ​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​)​. + */ + longDesc: string + } + } + } } - } - } - list_sites: { - groups: { - /** - * S​i​t​e​s - */ - '0': string - } - /** - * L​i​s​t​ ​S​i​t​e​s - */ - displayName: string - /** - * L​i​s​t​ ​a​l​l​ ​W​e​b​f​l​o​w​ ​s​i​t​e​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​W​e​b​f​l​o​w​ ​s​i​t​e​s​ ​a​c​c​e​s​s​i​b​l​e​ ​w​i​t​h​ ​t​h​e​ ​c​u​r​r​e​n​t​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​t​o​k​e​n​. - */ - longDesc: string - } - mark_order_status: { - groups: { - /** - * O​r​d​e​r​s - */ - '0': string - } - /** - * M​a​r​k​ ​O​r​d​e​r​ ​S​t​a​t​u​s - */ - displayName: string - /** - * U​p​d​a​t​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​a​ ​W​e​b​f​l​o​w​ ​o​r​d​e​r - */ - shortDesc: string - /** - * C​h​a​n​g​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​a​ ​W​e​b​f​l​o​w​ ​o​r​d​e​r​ ​t​o​ ​f​u​l​f​i​l​l​e​d​,​ ​u​n​f​u​l​f​i​l​l​e​d​,​ ​o​r​ ​r​e​f​u​n​d​e​d​ ​w​i​t​h​ ​a​d​d​i​t​i​o​n​a​l​ ​o​p​t​i​o​n​s​. - */ - longDesc: string - options: { - site: { + tax_mode: { /** - * S​i​t​e + * T​a​x​ ​M​o​d​e */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e + * U​p​d​a​t​e​d​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​ ​m​e​t​h​o​d */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​o​r​d​e​r + * U​p​d​a​t​e​d​ ​s​e​t​t​i​n​g​ ​f​o​r​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​p​r​i​c​e​ ​i​n​c​l​u​d​e​s​ ​t​a​x​ ​o​r​ ​i​f​ ​t​a​x​ ​i​s​ ​a​d​d​e​d​ ​o​n​ ​t​o​p​. */ longDesc: string } - order: { + unit_price_overrides: { /** - * O​r​d​e​r + * P​r​i​c​e​ ​O​v​e​r​r​i​d​e​s */ displayName: string /** - * T​h​e​ ​o​r​d​e​r​ ​t​o​ ​u​p​d​a​t​e + * U​p​d​a​t​e​d​ ​c​o​u​n​t​r​y​-​s​p​e​c​i​f​i​c​ ​p​r​i​c​i​n​g */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​f​o​r + * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​o​v​e​r​r​i​d​e​s​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​c​o​u​n​t​r​i​e​s​ ​o​r​ ​r​e​g​i​o​n​s​. */ longDesc: string + type: { + element_type: { + fields: { + countryCodes: { + /** + * C​o​u​n​t​r​y​ ​C​o​d​e​s + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​c​o​u​n​t​r​i​e​s​ ​f​o​r​ ​o​v​e​r​r​i​d​e​s + */ + shortDesc: string + /** + * U​p​d​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​I​S​O​ ​c​o​u​n​t​r​y​ ​c​o​d​e​s​ ​w​h​e​r​e​ ​p​r​i​c​e​ ​o​v​e​r​r​i​d​e​s​ ​a​p​p​l​y​. + */ + longDesc: string + } + unitPrice: { + /** + * O​v​e​r​r​i​d​e​ ​P​r​i​c​e + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​c​o​u​n​t​r​i​e​s​. + */ + longDesc: string + type: { + fields: { + amount: { + /** + * O​v​e​r​r​i​d​e​ ​A​m​o​u​n​t + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​o​v​e​r​r​i​d​e​ ​a​m​o​u​n​t + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​. + */ + longDesc: string + } + currencyCode: { + /** + * O​v​e​r​r​i​d​e​ ​C​u​r​r​e​n​c​y + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​o​v​e​r​r​i​d​e​ ​c​u​r​r​e​n​c​y + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​o​v​e​r​r​i​d​e​ ​p​r​i​c​e​. + */ + longDesc: string + } + } + } + } + } + } + } } - status: { + quantity: { /** - * S​t​a​t​u​s + * Q​u​a​n​t​i​t​y​ ​L​i​m​i​t​s */ displayName: string /** - * T​h​e​ ​n​e​w​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​o​r​d​e​r + * U​p​d​a​t​e​d​ ​q​u​a​n​t​i​t​y​ ​l​i​m​i​t​s */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​n​e​w​ ​s​t​a​t​u​s​ ​t​o​ ​s​e​t​ ​f​o​r​ ​t​h​e​ ​o​r​d​e​r + * U​p​d​a​t​e​d​ ​l​i​m​i​t​s​ ​o​n​ ​h​o​w​ ​m​a​n​y​ ​u​n​i​t​s​ ​c​a​n​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. */ longDesc: string + type: { + fields: { + minimum: { + /** + * M​i​n​i​m​u​m​ ​Q​u​a​n​t​i​t​y + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​m​i​n​i​m​u​m​ ​q​u​a​n​t​i​t​y + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​m​i​n​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​t​h​a​t​ ​m​u​s​t​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. + */ + longDesc: string + } + maximum: { + /** + * M​a​x​i​m​u​m​ ​Q​u​a​n​t​i​t​y + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​m​a​x​i​m​u​m​ ​q​u​a​n​t​i​t​y + */ + shortDesc: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​p​u​r​c​h​a​s​e​d​. + */ + longDesc: string + } + } + } } - reason: { + status: { /** - * R​e​f​u​n​d​ ​R​e​a​s​o​n + * S​t​a​t​u​s */ displayName: string /** - * R​e​a​s​o​n​ ​f​o​r​ ​r​e​f​u​n​d​i​n​g​ ​t​h​e​ ​o​r​d​e​r + * U​p​d​a​t​e​d​ ​p​r​i​c​e​ ​s​t​a​t​u​s */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​r​e​a​s​o​n​ ​f​o​r​ ​r​e​f​u​n​d​i​n​g​ ​t​h​e​ ​o​r​d​e​r​ ​(​r​e​q​u​i​r​e​d​ ​f​o​r​ ​r​e​f​u​n​d​e​d​ ​s​t​a​t​u​s​) + * T​h​e​ ​u​p​d​a​t​e​d​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​p​r​i​c​e​ ​(​e​.​g​.​,​ ​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​)​. */ longDesc: string } - sendOrderFulfilledEmail: { + custom_data: { /** - * S​e​n​d​ ​O​r​d​e​r​ ​F​u​l​f​i​l​l​e​d​ ​E​m​a​i​l + * C​u​s​t​o​m​ ​D​a​t​a */ displayName: string /** - * S​e​n​d​ ​f​u​l​f​i​l​l​m​e​n​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​e​m​a​i​l + * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​m​e​t​a​d​a​t​a */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​s​e​n​d​ ​a​n​ ​o​r​d​e​r​ ​f​u​l​f​i​l​l​e​d​ ​e​m​a​i​l​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r + * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​t​o​ ​s​t​o​r​e​ ​w​i​t​h​ ​t​h​e​ ​p​r​i​c​e​ ​a​s​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​. */ longDesc: string } } } - publish_item: { + create_customer: { groups: { /** - * C​o​l​l​e​c​t​i​o​n​s + * C​u​s​t​o​m​e​r​s */ '0': string } /** - * P​u​b​l​i​s​h​ ​I​t​e​m + * C​r​e​a​t​e​ ​C​u​s​t​o​m​e​r */ displayName: string /** - * P​u​b​l​i​s​h​ ​i​t​e​m​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​u​s​t​o​m​e​r​ ​i​n​ ​P​a​d​d​l​e */ shortDesc: string /** - * P​u​b​l​i​s​h​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​i​t​e​m​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​m​a​k​e​ ​t​h​e​m​ ​l​i​v​e​ ​o​n​ ​t​h​e​ ​w​e​b​s​i​t​e​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​c​u​s​t​o​m​e​r​ ​i​n​ ​P​a​d​d​l​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​,​ ​l​o​c​a​l​e​,​ ​a​n​d​ ​c​u​s​t​o​m​ ​d​a​t​a​. */ longDesc: string options: { - items: { + email: { /** - * I​t​e​m​s + * E​m​a​i​l */ displayName: string /** - * T​h​e​ ​i​t​e​m​s​ ​t​o​ ​p​u​b​l​i​s​h + * C​u​s​t​o​m​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​i​t​e​m​s​ ​f​r​o​m​ ​t​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​p​u​b​l​i​s​h + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​i​s​ ​r​e​q​u​i​r​e​d​ ​a​n​d​ ​m​u​s​t​ ​b​e​ ​a​ ​v​a​l​i​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​. */ longDesc: string } - site: { + name: { /** - * S​i​t​e + * N​a​m​e */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) + * C​u​s​t​o​m​e​r​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + * T​h​e​ ​f​u​l​l​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​i​s​ ​o​p​t​i​o​n​a​l​ ​b​u​t​ ​r​e​c​o​m​m​e​n​d​e​d​ ​f​o​r​ ​b​e​t​t​e​r​ ​c​u​s​t​o​m​e​r​ ​e​x​p​e​r​i​e​n​c​e​. */ longDesc: string } - collection: { + locale: { /** - * C​o​l​l​e​c​t​i​o​n + * L​o​c​a​l​e */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​i​t​e​m​s + * C​u​s​t​o​m​e​r​ ​l​o​c​a​l​e​/​l​a​n​g​u​a​g​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​i​t​e​m​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​u​b​l​i​s​h + * T​h​e​ ​p​r​e​f​e​r​r​e​d​ ​l​a​n​g​u​a​g​e​/​l​o​c​a​l​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​a​f​f​e​c​t​s​ ​e​m​a​i​l​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​s​ ​a​n​d​ ​c​h​e​c​k​o​u​t​ ​e​x​p​e​r​i​e​n​c​e​. + */ + longDesc: string + } + custom_data: { + /** + * C​u​s​t​o​m​ ​D​a​t​a + */ + displayName: string + /** + * A​d​d​i​t​i​o​n​a​l​ ​c​u​s​t​o​m​ ​d​a​t​a + */ + shortDesc: string + /** + * C​u​s​t​o​m​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​ ​t​o​ ​s​t​o​r​e​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​c​u​s​t​o​m​e​r​. */ longDesc: string + type: { + fields: { + key: { + /** + * K​e​y + */ + displayName: string + /** + * C​u​s​t​o​m​ ​d​a​t​a​ ​k​e​y + */ + shortDesc: string + /** + * T​h​e​ ​k​e​y​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​ ​d​a​t​a​ ​f​i​e​l​d​. + */ + longDesc: string + } + value: { + /** + * V​a​l​u​e + */ + displayName: string + /** + * C​u​s​t​o​m​ ​d​a​t​a​ ​v​a​l​u​e + */ + shortDesc: string + /** + * T​h​e​ ​v​a​l​u​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​ ​d​a​t​a​ ​f​i​e​l​d​. + */ + longDesc: string + } + } + } } } } - publish_site: { + get_customer: { groups: { /** - * S​i​t​e​s + * C​u​s​t​o​m​e​r​s */ '0': string } /** - * P​u​b​l​i​s​h​ ​S​i​t​e + * G​e​t​ ​C​u​s​t​o​m​e​r */ displayName: string /** - * P​u​b​l​i​s​h​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e + * R​e​t​r​i​e​v​e​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​ ​b​y​ ​I​D */ shortDesc: string /** - * P​u​b​l​i​s​h​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​a​k​e​ ​a​l​l​ ​c​h​a​n​g​e​s​ ​l​i​v​e​.​ ​Y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​a​n​d​ ​w​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​o​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​u​b​d​o​m​a​i​n​. + * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​ ​u​s​i​n​g​ ​t​h​e​i​r​ ​u​n​i​q​u​e​ ​c​u​s​t​o​m​e​r​ ​I​D​. */ longDesc: string options: { - site: { + customer_id: { /** - * S​i​t​e + * C​u​s​t​o​m​e​r​ ​I​D */ displayName: string /** - * T​h​e​ ​s​i​t​e​ ​t​o​ ​p​u​b​l​i​s​h + * T​h​e​ ​c​u​s​t​o​m​e​r​ ​I​D​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​u​b​l​i​s​h + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​w​h​o​s​e​ ​d​e​t​a​i​l​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. */ longDesc: string } - customDomains: { + } + } + get_customer_auth_token: { + groups: { + /** + * C​u​s​t​o​m​e​r​s + */ + '0': string + } + /** + * G​e​t​ ​C​u​s​t​o​m​e​r​ ​A​u​t​h​ ​T​o​k​e​n + */ + displayName: string + /** + * G​e​n​e​r​a​t​e​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​t​o​k​e​n​ ​f​o​r​ ​c​u​s​t​o​m​e​r + */ + shortDesc: string + /** + * G​e​n​e​r​a​t​e​s​ ​a​ ​t​e​m​p​o​r​a​r​y​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​t​o​k​e​n​ ​t​h​a​t​ ​a​l​l​o​w​s​ ​a​ ​c​u​s​t​o​m​e​r​ ​t​o​ ​a​c​c​e​s​s​ ​t​h​e​i​r​ ​b​i​l​l​i​n​g​ ​p​o​r​t​a​l​ ​o​r​ ​m​a​k​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​r​e​q​u​e​s​t​s​. + */ + longDesc: string + options: { + customer_id: { /** - * C​u​s​t​o​m​ ​D​o​m​a​i​n​s + * C​u​s​t​o​m​e​r​ ​I​D */ displayName: string /** - * C​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​o + * T​h​e​ ​c​u​s​t​o​m​e​r​ ​I​D​ ​t​o​ ​g​e​n​e​r​a​t​e​ ​t​o​k​e​n​ ​f​o​r */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​s​i​t​e​ ​t​o​ ​(​o​p​t​i​o​n​a​l​) + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​f​o​r​ ​w​h​o​m​ ​t​o​ ​g​e​n​e​r​a​t​e​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​t​o​k​e​n​. */ longDesc: string } - publishToWebflowSubdomain: { + } + } + list_customer_credit_balances: { + groups: { + /** + * C​u​s​t​o​m​e​r​s + */ + '0': string + } + /** + * L​i​s​t​ ​C​u​s​t​o​m​e​r​ ​C​r​e​d​i​t​ ​B​a​l​a​n​c​e​s + */ + displayName: string + /** + * G​e​t​ ​c​u​s​t​o​m​e​r​ ​c​r​e​d​i​t​ ​b​a​l​a​n​c​e​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​s​ ​t​h​e​ ​c​r​e​d​i​t​ ​b​a​l​a​n​c​e​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​,​ ​o​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​e​d​ ​b​y​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​. + */ + longDesc: string + options: { + customer_id: { /** - * P​u​b​l​i​s​h​ ​t​o​ ​W​e​b​f​l​o​w​ ​S​u​b​d​o​m​a​i​n + * C​u​s​t​o​m​e​r​ ​I​D */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​o​ ​W​e​b​f​l​o​w​ ​s​u​b​d​o​m​a​i​n + * T​h​e​ ​c​u​s​t​o​m​e​r​ ​I​D​ ​t​o​ ​g​e​t​ ​b​a​l​a​n​c​e​s​ ​f​o​r */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​s​i​t​e​ ​t​o​ ​i​t​s​ ​W​e​b​f​l​o​w​ ​s​u​b​d​o​m​a​i​n + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​w​h​o​s​e​ ​c​r​e​d​i​t​ ​b​a​l​a​n​c​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. + */ + longDesc: string + } + currency_code: { + /** + * C​u​r​r​e​n​c​y​ ​C​o​d​e + */ + displayName: string + /** + * F​i​l​t​e​r​ ​b​y​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​s + */ + shortDesc: string + /** + * O​p​t​i​o​n​a​l​ ​l​i​s​t​ ​o​f​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​s​ ​t​o​ ​f​i​l​t​e​r​ ​t​h​e​ ​c​r​e​d​i​t​ ​b​a​l​a​n​c​e​s​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​a​l​l​ ​c​u​r​r​e​n​c​y​ ​b​a​l​a​n​c​e​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. */ longDesc: string } } } - update_item: { + list_customers: { groups: { /** - * C​o​l​l​e​c​t​i​o​n​s + * C​u​s​t​o​m​e​r​s */ '0': string } /** - * U​p​d​a​t​e​ ​I​t​e​m + * L​i​s​t​ ​C​u​s​t​o​m​e​r​s */ displayName: string /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​i​t​e​m​ ​i​n​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​u​s​t​o​m​e​r​s */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​f​i​e​l​d​ ​d​a​t​a​ ​a​n​d​ ​s​e​t​t​i​n​g​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​i​t​e​m​ ​i​n​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​. + * R​e​t​r​i​e​v​e​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​u​s​t​o​m​e​r​s​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​,​ ​s​e​a​r​c​h​i​n​g​,​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. */ longDesc: string options: { - site: { + after: { /** - * S​i​t​e + * A​f​t​e​r */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) + * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + * U​s​e​d​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​R​e​t​u​r​n​s​ ​c​u​s​t​o​m​e​r​s​ ​a​f​t​e​r​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​u​r​s​o​r​. */ longDesc: string } - item: { + email: { /** - * I​t​e​m + * E​m​a​i​l */ displayName: string /** - * T​h​e​ ​i​t​e​m​ ​t​o​ ​u​p​d​a​t​e + * F​i​l​t​e​r​ ​b​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e + * F​i​l​t​e​r​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​.​ ​Y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​m​u​l​t​i​p​l​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​. */ longDesc: string } - collection: { + id: { /** - * C​o​l​l​e​c​t​i​o​n + * C​u​s​t​o​m​e​r​ ​I​D​s */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​i​t​e​m + * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​I​D​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e + * F​i​l​t​e​r​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​ ​I​D​s​.​ ​Y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​m​u​l​t​i​p​l​e​ ​c​u​s​t​o​m​e​r​ ​I​D​s​. */ longDesc: string } - isArchived: { + order: { /** - * I​s​ ​A​r​c​h​i​v​e​d + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​h​e​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​b​e​ ​a​r​c​h​i​v​e​d + * S​o​r​t​ ​c​o​n​f​i​g​u​r​a​t​i​o​n */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​a​r​c​h​i​v​e​ ​t​h​e​ ​i​t​e​m​,​ ​f​a​l​s​e​ ​t​o​ ​u​n​a​r​c​h​i​v​e​ ​i​t + * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string + type: { + fields: { + field: { + /** + * S​o​r​t​ ​F​i​e​l​d + */ + displayName: string + /** + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y + */ + shortDesc: string + /** + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​b​y​. + */ + longDesc: string + } + direction: { + /** + * S​o​r​t​ ​D​i​r​e​c​t​i​o​n + */ + displayName: string + /** + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n + */ + shortDesc: string + /** + * T​h​e​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s​ ​-​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​. + */ + longDesc: string + } + } + } } - isDraft: { + per_page: { /** - * I​s​ ​D​r​a​f​t + * P​e​r​ ​P​a​g​e */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​h​e​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​b​e​ ​a​ ​d​r​a​f​t + * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​s​a​v​e​ ​t​h​e​ ​i​t​e​m​ ​a​s​ ​a​ ​d​r​a​f​t​,​ ​f​a​l​s​e​ ​t​o​ ​m​a​k​e​ ​i​t​ ​l​i​v​e + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​u​s​t​o​m​e​r​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​. */ longDesc: string } - cmsLocaleId: { + search: { /** - * C​M​S​ ​L​o​c​a​l​e​ ​I​D + * S​e​a​r​c​h */ displayName: string /** - * T​h​e​ ​l​o​c​a​l​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​i​t​e​m + * S​e​a​r​c​h​ ​t​e​r​m */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​C​M​S​ ​l​o​c​a​l​e​ ​I​D​ ​i​f​ ​w​o​r​k​i​n​g​ ​w​i​t​h​ ​a​ ​m​u​l​t​i​-​l​o​c​a​l​e​ ​s​i​t​e + * S​e​a​r​c​h​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​n​a​m​e​ ​o​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​u​s​i​n​g​ ​a​ ​f​r​e​e​-​t​e​x​t​ ​s​e​a​r​c​h​. */ longDesc: string } - } - } - } - triggers: { - new_item: { - /** - * N​e​w​ ​I​t​e​m - */ - displayName: string - /** - * T​r​i​g​g​e​r​e​d​ ​w​h​e​n​ ​a​ ​n​e​w​ ​i​t​e​m​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​a​ ​c​o​l​l​e​c​t​i​o​n - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​i​t​e​m​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​a​n​y​ ​c​o​l​l​e​c​t​i​o​n​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​i​t​e​m​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​f​i​e​l​d​ ​d​a​t​a​. - */ - longDesc: string - options: { - site: { + status: { /** - * S​i​t​e + * S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​o​n​i​t​o​r + * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​s​t​a​t​u​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​i​t​e​m​ ​c​r​e​a​t​i​o​n​ ​e​v​e​n​t​s + * F​i​l​t​e​r​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​t​h​e​i​r​ ​s​t​a​t​u​s​ ​(​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​,​ ​e​t​c​.​)​. */ longDesc: string } } } - new_order: { + update_customer: { + groups: { + /** + * C​u​s​t​o​m​e​r​s + */ + '0': string + } /** - * N​e​w​ ​O​r​d​e​r + * U​p​d​a​t​e​ ​C​u​s​t​o​m​e​r */ displayName: string /** - * T​r​i​g​g​e​r​e​d​ ​w​h​e​n​ ​a​ ​n​e​w​ ​o​r​d​e​r​ ​i​s​ ​p​l​a​c​e​d + * U​p​d​a​t​e​ ​c​u​s​t​o​m​e​r​ ​i​n​f​o​r​m​a​t​i​o​n */ shortDesc: string /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​o​r​d​e​r​ ​i​s​ ​p​l​a​c​e​d​ ​o​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​o​r​d​e​r​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​,​ ​p​u​r​c​h​a​s​e​d​ ​i​t​e​m​s​,​ ​p​a​y​m​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​a​n​d​ ​s​h​i​p​p​i​n​g​ ​d​e​t​a​i​l​s​. + * U​p​d​a​t​e​s​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​u​s​t​o​m​e​r​'​s​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​e​m​a​i​l​,​ ​n​a​m​e​,​ ​s​t​a​t​u​s​,​ ​l​o​c​a​l​e​,​ ​a​n​d​ ​c​u​s​t​o​m​ ​d​a​t​a​. */ longDesc: string options: { - site: { + customer_id: { /** - * S​i​t​e + * C​u​s​t​o​m​e​r​ ​I​D */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​c​u​s​t​o​m​e​r​ ​I​D​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​o​r​d​e​r​ ​e​v​e​n​t​s + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - } - } - updated_item: { - /** - * U​p​d​a​t​e​d​ ​I​t​e​m - */ - displayName: string - /** - * T​r​i​g​g​e​r​e​d​ ​w​h​e​n​ ​a​n​ ​i​t​e​m​ ​i​s​ ​u​p​d​a​t​e​d​ ​i​n​ ​a​ ​c​o​l​l​e​c​t​i​o​n - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​i​t​e​m​ ​i​s​ ​m​o​d​i​f​i​e​d​ ​i​n​ ​a​n​y​ ​c​o​l​l​e​c​t​i​o​n​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​u​p​d​a​t​e​d​ ​i​t​e​m​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​c​u​r​r​e​n​t​ ​f​i​e​l​d​ ​d​a​t​a​. - */ - longDesc: string - options: { - site: { + email: { /** - * S​i​t​e + * E​m​a​i​l */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​o​n​i​t​o​r + * N​e​w​ ​c​u​s​t​o​m​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​i​t​e​m​ ​u​p​d​a​t​e​ ​e​v​e​n​t​s + * T​h​e​ ​n​e​w​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​M​u​s​t​ ​b​e​ ​a​ ​v​a​l​i​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​. */ longDesc: string } - } - } - updated_order: { - /** - * U​p​d​a​t​e​d​ ​O​r​d​e​r - */ - displayName: string - /** - * T​r​i​g​g​e​r​e​d​ ​w​h​e​n​ ​a​n​ ​o​r​d​e​r​ ​s​t​a​t​u​s​ ​i​s​ ​u​p​d​a​t​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​o​r​d​e​r​ ​i​s​ ​m​o​d​i​f​i​e​d​ ​o​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​.​ ​T​h​i​s​ ​i​n​c​l​u​d​e​s​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​,​ ​f​u​l​f​i​l​l​m​e​n​t​ ​u​p​d​a​t​e​s​,​ ​r​e​f​u​n​d​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​o​r​d​e​r​ ​m​o​d​i​f​i​c​a​t​i​o​n​s​. - */ - longDesc: string - options: { - site: { + name: { /** - * S​i​t​e + * N​a​m​e */ displayName: string /** - * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​o​n​i​t​o​r + * N​e​w​ ​c​u​s​t​o​m​e​r​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​o​r​d​e​r​ ​u​p​d​a​t​e​ ​e​v​e​n​t​s + * T​h​e​ ​n​e​w​ ​f​u​l​l​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​. */ longDesc: string } - } - } - } - } - ActiveCampaign: { - /** - * A​c​t​i​v​e​C​a​m​p​a​i​g​n - */ - displayName: string - groups: { - /** - * E​m​a​i​l​ ​&​ ​E​m​a​i​l​ ​M​a​r​k​e​t​i​n​g - */ - '0': string - } - /** - * E​m​a​i​l​ ​m​a​r​k​e​t​i​n​g​ ​a​u​t​o​m​a​t​i​o​n​ ​a​n​d​ ​C​R​M​ ​p​l​a​t​f​o​r​m - */ - shortDesc: string - /** - * C​o​n​n​e​c​t​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​e​m​a​i​l​ ​m​a​r​k​e​t​i​n​g​ ​c​a​m​p​a​i​g​n​s​,​ ​m​a​n​a​g​e​ ​c​o​n​t​a​c​t​s​,​ ​a​n​d​ ​t​r​a​c​k​ ​c​u​s​t​o​m​e​r​ ​i​n​t​e​r​a​c​t​i​o​n​s​.​ ​C​r​e​a​t​e​ ​a​n​d​ ​s​e​n​d​ ​t​a​r​g​e​t​e​d​ ​e​m​a​i​l​ ​c​a​m​p​a​i​g​n​s​,​ ​m​a​n​a​g​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​,​ ​s​e​t​ ​u​p​ ​a​u​t​o​m​a​t​i​o​n​ ​w​o​r​k​f​l​o​w​s​,​ ​a​n​d​ ​a​n​a​l​y​z​e​ ​c​a​m​p​a​i​g​n​ ​p​e​r​f​o​r​m​a​n​c​e​ ​a​l​l​ ​f​r​o​m​ ​w​i​t​h​i​n​ ​Q​o​r​e​. - */ - longDesc: string - connectionMessage: { - /** - * C​o​n​n​e​c​t​ ​t​o​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n - */ - title: string - /** - * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​I​n​s​t​a​n​c​e​ ​U​R​L​*​*​ ​a​n​d​ ​*​*​A​P​I​ ​K​e​y​*​*​.​ - ​ - ​#​#​ ​H​o​w​ ​t​o​ ​G​e​t​ ​Y​o​u​r​ ​C​r​e​d​e​n​t​i​a​l​s​ - ​ - ​#​#​#​ ​I​n​s​t​a​n​c​e​ ​U​R​L​ - ​Y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​i​n​s​t​a​n​c​e​ ​U​R​L​ ​(​e​.​g​.​,​ ​`​h​t​t​p​s​:​/​/​<​y​o​u​r​_​a​c​c​o​u​n​t​>​.​a​c​t​i​v​e​h​o​s​t​e​d​.​c​o​m​`​)​ - ​ - ​1​.​ ​G​o​ ​t​o​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​s​e​t​t​i​n​g​s​ - ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​D​e​v​e​l​o​p​e​r​ ​s​e​t​t​i​n​g​s​ - ​3​.​ ​C​o​p​y​ ​t​h​e​ ​U​R​L​ ​v​a​l​u​e​ - ​ - ​#​#​#​ ​A​P​I​ ​K​e​y​ - ​Y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​A​P​I​ ​k​e​y​ ​f​o​r​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ - ​ - ​1​.​ ​G​o​ ​t​o​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​s​e​t​t​i​n​g​s​ - ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​D​e​v​e​l​o​p​e​r​ ​s​e​t​t​i​n​g​s​ - ​3​.​ ​C​o​p​y​ ​t​h​e​ ​A​P​I​ ​K​e​y​ ​v​a​l​u​e​ - ​ - ​B​o​t​h​ ​c​r​e​d​e​n​t​i​a​l​s​ ​c​a​n​ ​b​e​ ​f​o​u​n​d​ ​i​n​ ​t​h​e​ ​s​a​m​e​ ​l​o​c​a​t​i​o​n​ ​w​i​t​h​i​n​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​D​e​v​e​l​o​p​e​r​ ​s​e​t​t​i​n​g​s​. - */ - content: string - } - triggers: { - contact_added_to_list: { - /** - * C​o​n​t​a​c​t​ ​A​d​d​e​d​ ​t​o​ ​L​i​s​t - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​o​n​t​a​c​t​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​l​i​s​t - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​c​o​n​t​a​c​t​ ​s​u​b​s​c​r​i​b​e​s​ ​o​r​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n - */ - longDesc: string - options: { - list: { + status: { /** - * L​i​s​t + * S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​n​t​a​c​t​s + * C​u​s​t​o​m​e​r​ ​s​t​a​t​u​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​a​d​d​i​t​i​o​n​s + * T​h​e​ ​n​e​w​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​(​a​c​t​i​v​e​,​ ​a​r​c​h​i​v​e​d​,​ ​e​t​c​.​)​. */ longDesc: string } - } - } - updated_contact: { - /** - * C​o​n​t​a​c​t​ ​U​p​d​a​t​e​d - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​o​n​t​a​c​t​ ​i​s​ ​u​p​d​a​t​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​n​y​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​s​ ​u​p​d​a​t​e​d​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n - */ - longDesc: string - } - new_campaign_bounce: { - /** - * N​e​w​ ​C​a​m​p​a​i​g​n​ ​B​o​u​n​c​e - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​a​m​p​a​i​g​n​ ​e​m​a​i​l​ ​b​o​u​n​c​e​s - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​n​ ​e​m​a​i​l​ ​f​r​o​m​ ​a​ ​c​a​m​p​a​i​g​n​ ​b​o​u​n​c​e​s​,​ ​i​n​d​i​c​a​t​i​n​g​ ​d​e​l​i​v​e​r​y​ ​f​a​i​l​u​r​e - */ - longDesc: string - } - new_campaign_link_click: { - /** - * N​e​w​ ​C​a​m​p​a​i​g​n​ ​L​i​n​k​ ​C​l​i​c​k - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​l​i​n​k​ ​i​n​ ​a​ ​c​a​m​p​a​i​g​n​ ​i​s​ ​c​l​i​c​k​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​r​e​c​i​p​i​e​n​t​ ​c​l​i​c​k​s​ ​o​n​ ​a​ ​l​i​n​k​ ​w​i​t​h​i​n​ ​a​ ​c​a​m​p​a​i​g​n​ ​e​m​a​i​l - */ - longDesc: string - } - new_campaign_reply: { - /** - * N​e​w​ ​C​a​m​p​a​i​g​n​ ​R​e​p​l​y - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​s​o​m​e​o​n​e​ ​r​e​p​l​i​e​s​ ​t​o​ ​a​ ​c​a​m​p​a​i​g​n - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​r​e​c​i​p​i​e​n​t​ ​r​e​p​l​i​e​s​ ​t​o​ ​a​ ​c​a​m​p​a​i​g​n​ ​e​m​a​i​l - */ - longDesc: string - } - new_contact_note: { - /** - * N​e​w​ ​C​o​n​t​a​c​t​ ​N​o​t​e - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​o​t​e​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​c​o​n​t​a​c​t - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​o​t​e​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​c​o​n​t​a​c​t​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t - */ - longDesc: string - options: { - list: { + locale: { /** - * L​i​s​t + * L​o​c​a​l​e */ displayName: string /** - * T​h​e​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​n​o​t​e​s + * C​u​s​t​o​m​e​r​ ​l​o​c​a​l​e​/​l​a​n​g​u​a​g​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​w​h​e​n​ ​n​o​t​e​s​ ​a​r​e​ ​a​d​d​e​d​ ​t​o​ ​c​o​n​t​a​c​t​s + * T​h​e​ ​n​e​w​ ​p​r​e​f​e​r​r​e​d​ ​l​a​n​g​u​a​g​e​/​l​o​c​a​l​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​e​r​. */ longDesc: string } - } - } - new_contact: { - /** - * N​e​w​ ​C​o​n​t​a​c​t - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​s​ ​c​r​e​a​t​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​s​u​b​s​c​r​i​b​e​s​ ​o​r​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n - */ - longDesc: string - } - deal_note_added: { - /** - * D​e​a​l​ ​N​o​t​e​ ​A​d​d​e​d - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​o​t​e​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​d​e​a​l - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​o​t​e​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​d​e​a​l​ ​f​o​r​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t - */ - longDesc: string - options: { - list: { + custom_data: { /** - * L​i​s​t + * C​u​s​t​o​m​ ​D​a​t​a */ displayName: string /** - * T​h​e​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​d​e​a​l​ ​n​o​t​e​ ​a​d​d​i​t​i​o​n​s + * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​d​a​t​a */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​w​h​e​n​ ​n​o​t​e​s​ ​a​r​e​ ​a​d​d​e​d​ ​t​o​ ​d​e​a​l​s + * C​u​s​t​o​m​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​ ​t​o​ ​u​p​d​a​t​e​ ​o​r​ ​a​d​d​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​c​u​s​t​o​m​e​r​. */ longDesc: string + type: { + fields: { + key: { + /** + * K​e​y + */ + displayName: string + /** + * C​u​s​t​o​m​ ​d​a​t​a​ ​k​e​y + */ + shortDesc: string + /** + * T​h​e​ ​k​e​y​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​ ​d​a​t​a​ ​f​i​e​l​d​. + */ + longDesc: string + } + value: { + /** + * V​a​l​u​e + */ + displayName: string + /** + * C​u​s​t​o​m​ ​d​a​t​a​ ​v​a​l​u​e + */ + shortDesc: string + /** + * T​h​e​ ​v​a​l​u​e​ ​f​o​r​ ​t​h​e​ ​c​u​s​t​o​m​ ​d​a​t​a​ ​f​i​e​l​d​. + */ + longDesc: string + } + } + } } } } - new_deal: { + get_report: { + groups: { + /** + * R​e​p​o​r​t​s + */ + '0': string + } /** - * N​e​w​ ​D​e​a​l + * G​e​t​ ​R​e​p​o​r​t */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​a​l​ ​i​s​ ​c​r​e​a​t​e​d + * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​r​e​p​o​r​t​ ​b​y​ ​I​D */ shortDesc: string /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​a​l​ ​i​s​ ​c​r​e​a​t​e​d​ ​f​o​r​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t + * F​e​t​c​h​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​r​e​p​o​r​t​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​s​t​a​t​u​s​,​ ​f​i​l​t​e​r​s​,​ ​r​o​w​ ​c​o​u​n​t​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a​. */ longDesc: string options: { - list: { + report_id: { /** - * L​i​s​t + * R​e​p​o​r​t​ ​I​D */ displayName: string /** - * T​h​e​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​d​e​a​l​s + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​r​e​p​o​r​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​w​h​e​n​ ​n​e​w​ ​d​e​a​l​s​ ​a​r​e​ ​c​r​e​a​t​e​d + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​p​o​r​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​f​e​t​c​h​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​. */ longDesc: string } } } - } - actions: { - add_contact_note: { + get_report_file: { groups: { /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + * R​e​p​o​r​t​s */ '0': string } /** - * A​d​d​ ​C​o​n​t​a​c​t​ ​N​o​t​e + * G​e​t​ ​R​e​p​o​r​t​ ​F​i​l​e */ displayName: string /** - * A​d​d​ ​a​ ​n​o​t​e​ ​t​o​ ​a​ ​c​o​n​t​a​c​t + * D​o​w​n​l​o​a​d​ ​a​ ​r​e​p​o​r​t​ ​f​i​l​e​ ​a​s​ ​C​S​V */ shortDesc: string /** - * A​d​d​ ​a​ ​n​e​w​ ​n​o​t​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * D​o​w​n​l​o​a​d​s​ ​t​h​e​ ​C​S​V​ ​f​i​l​e​ ​f​o​r​ ​a​ ​c​o​m​p​l​e​t​e​d​ ​r​e​p​o​r​t​.​ ​R​e​t​u​r​n​s​ ​a​ ​U​R​L​ ​t​o​ ​d​o​w​n​l​o​a​d​ ​t​h​e​ ​r​e​p​o​r​t​ ​d​a​t​a​. */ longDesc: string options: { - note: { - /** - * N​o​t​e - */ - displayName: string - /** - * T​h​e​ ​n​o​t​e​ ​c​o​n​t​e​n​t​ ​t​o​ ​a​d​d - */ - shortDesc: string - /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​n​o​t​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​c​o​n​t​a​c​t - */ - longDesc: string - } - contact: { + report_id: { /** - * C​o​n​t​a​c​t + * R​e​p​o​r​t​ ​I​D */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​n​o​t​e​ ​t​o + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​r​e​p​o​r​t​ ​f​i​l​e​ ​t​o​ ​d​o​w​n​l​o​a​d */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​n​o​t​e​ ​t​o + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​p​o​r​t​ ​w​h​o​s​e​ ​C​S​V​ ​f​i​l​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​o​w​n​l​o​a​d​. */ longDesc: string } } } - add_contact_to_account: { + list_reports: { groups: { /** - * A​c​c​o​u​n​t​ ​M​a​n​a​g​e​m​e​n​t + * R​e​p​o​r​t​s */ '0': string } /** - * A​d​d​ ​C​o​n​t​a​c​t​ ​t​o​ ​A​c​c​o​u​n​t + * L​i​s​t​ ​R​e​p​o​r​t​s */ displayName: string /** - * A​s​s​o​c​i​a​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​w​i​t​h​ ​a​n​ ​a​c​c​o​u​n​t + * L​i​s​t​ ​a​l​l​ ​r​e​p​o​r​t​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​n​ ​a​s​s​o​c​i​a​t​i​o​n​ ​b​e​t​w​e​e​n​ ​a​ ​c​o​n​t​a​c​t​ ​a​n​d​ ​a​n​ ​a​c​c​o​u​n​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​r​e​p​o​r​t​s​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​s​t​a​t​u​s​,​ ​p​a​g​i​n​a​t​i​o​n​,​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. */ longDesc: string options: { - account: { + after: { /** - * A​c​c​o​u​n​t + * A​f​t​e​r */ displayName: string /** - * T​h​e​ ​a​c​c​o​u​n​t​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​w​i​t​h + * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​w​i​t​h + * R​e​t​u​r​n​ ​r​e​p​o​r​t​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​d​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. */ longDesc: string } - contact: { + order: { /** - * C​o​n​t​a​c​t + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​e​ ​a​c​c​o​u​n​t + * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​e​ ​a​c​c​o​u​n​t + * S​p​e​c​i​f​y​ ​t​h​e​ ​f​i​e​l​d​ ​a​n​d​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​p​o​r​t​s​ ​b​y​. */ longDesc: string + type: { + fields: { + field: { + /** + * S​o​r​t​ ​F​i​e​l​d + */ + displayName: string + /** + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y + */ + shortDesc: string + /** + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​t​h​e​ ​r​e​p​o​r​t​s​. + */ + longDesc: string + } + direction: { + /** + * S​o​r​t​ ​D​i​r​e​c​t​i​o​n + */ + displayName: string + /** + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n + */ + shortDesc: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r​. + */ + longDesc: string + } + } + } } - jobTitle: { + per_page: { /** - * J​o​b​ ​T​i​t​l​e + * P​e​r​ ​P​a​g​e */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​j​o​b​ ​t​i​t​l​e​ ​a​t​ ​t​h​i​s​ ​a​c​c​o​u​n​t + * N​u​m​b​e​r​ ​o​f​ ​r​e​p​o​r​t​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​j​o​b​ ​t​i​t​l​e​ ​o​r​ ​r​o​l​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​a​c​c​o​u​n​t + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​p​o​r​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​. + */ + longDesc: string + } + status: { + /** + * S​t​a​t​u​s​ ​F​i​l​t​e​r + */ + displayName: string + /** + * F​i​l​t​e​r​ ​r​e​p​o​r​t​s​ ​b​y​ ​s​t​a​t​u​s + */ + shortDesc: string + /** + * F​i​l​t​e​r​ ​t​h​e​ ​r​e​p​o​r​t​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​t​a​t​u​s​ ​v​a​l​u​e​s​. */ longDesc: string } } } - add_deal_note: { + create_report: { groups: { /** - * D​e​a​l​ ​M​a​n​a​g​e​m​e​n​t + * R​e​p​o​r​t​s */ '0': string } /** - * A​d​d​ ​D​e​a​l​ ​N​o​t​e + * C​r​e​a​t​e​ ​R​e​p​o​r​t */ displayName: string /** - * A​d​d​ ​a​ ​n​o​t​e​ ​t​o​ ​a​ ​d​e​a​l + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​r​e​p​o​r​t​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​s */ shortDesc: string /** - * A​d​d​ ​a​ ​n​e​w​ ​n​o​t​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​r​e​p​o​r​t​ ​o​f​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​y​p​e​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​s​ ​t​o​ ​n​a​r​r​o​w​ ​d​o​w​n​ ​t​h​e​ ​d​a​t​a​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​e​ ​r​e​p​o​r​t​. */ longDesc: string options: { - note: { + type: { /** - * N​o​t​e + * R​e​p​o​r​t​ ​T​y​p​e */ displayName: string /** - * T​h​e​ ​n​o​t​e​ ​c​o​n​t​e​n​t​ ​t​o​ ​a​d​d + * T​h​e​ ​t​y​p​e​ ​o​f​ ​r​e​p​o​r​t​ ​t​o​ ​c​r​e​a​t​e */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​n​o​t​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​d​e​a​l + * T​h​e​ ​t​y​p​e​ ​o​f​ ​r​e​p​o​r​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​n​e​r​a​t​e​.​ ​D​i​f​f​e​r​e​n​t​ ​t​y​p​e​s​ ​p​r​o​v​i​d​e​ ​d​i​f​f​e​r​e​n​t​ ​d​a​t​a​ ​s​e​t​s​. */ longDesc: string } - deal: { + filters: { /** - * D​e​a​l + * F​i​l​t​e​r​s */ displayName: string /** - * T​h​e​ ​d​e​a​l​ ​t​o​ ​a​d​d​ ​t​h​e​ ​n​o​t​e​ ​t​o + * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​s​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​e​ ​r​e​p​o​r​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​d​e​a​l​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​n​o​t​e​ ​t​o + * A​p​p​l​y​ ​f​i​l​t​e​r​s​ ​t​o​ ​l​i​m​i​t​ ​t​h​e​ ​d​a​t​a​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​e​ ​r​e​p​o​r​t​ ​b​a​s​e​d​ ​o​n​ ​s​p​e​c​i​f​i​c​ ​c​r​i​t​e​r​i​a​. */ longDesc: string + type: { + element_type: { + fields: { + name: { + /** + * F​i​l​t​e​r​ ​N​a​m​e + */ + displayName: string + /** + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​f​i​l​t​e​r​ ​f​i​e​l​d + */ + shortDesc: string + /** + * T​h​e​ ​f​i​e​l​d​ ​n​a​m​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y​. + */ + longDesc: string + } + operator: { + /** + * F​i​l​t​e​r​ ​O​p​e​r​a​t​o​r + */ + displayName: string + /** + * T​h​e​ ​c​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r + */ + shortDesc: string + /** + * T​h​e​ ​o​p​e​r​a​t​o​r​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​o​m​p​a​r​i​n​g​ ​t​h​e​ ​f​i​l​t​e​r​ ​v​a​l​u​e​. + */ + longDesc: string + } + value: { + /** + * F​i​l​t​e​r​ ​V​a​l​u​e + */ + displayName: string + /** + * T​h​e​ ​v​a​l​u​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y + */ + shortDesc: string + /** + * T​h​e​ ​v​a​l​u​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​f​i​l​t​e​r​ ​c​o​m​p​a​r​i​s​o​n​. + */ + longDesc: string + } + } + } + } } } } - add_tag_to_contact: { + get_subscription: { groups: { /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + * S​u​b​s​c​r​i​p​t​i​o​n​s */ '0': string } /** - * A​d​d​ ​T​a​g​ ​t​o​ ​C​o​n​t​a​c​t + * G​e​t​ ​S​u​b​s​c​r​i​p​t​i​o​n */ displayName: string /** - * A​d​d​ ​a​ ​t​a​g​ ​t​o​ ​a​ ​c​o​n​t​a​c​t + * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​b​y​ ​I​D */ shortDesc: string /** - * A​p​p​l​y​ ​a​ ​t​a​g​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​f​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​a​n​d​ ​s​e​g​m​e​n​t​a​t​i​o​n + * F​e​t​c​h​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​s​t​a​t​u​s​,​ ​b​i​l​l​i​n​g​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​r​e​l​a​t​e​d​ ​d​a​t​a​. */ longDesc: string options: { - tag: { + subscription_id: { /** - * T​a​g + * S​u​b​s​c​r​i​p​t​i​o​n​ ​I​D */ displayName: string /** - * T​h​e​ ​t​a​g​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​c​o​n​t​a​c​t + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​g​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​e​ ​c​o​n​t​a​c​t + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​f​e​t​c​h​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​. */ longDesc: string } - contact: { + include: { /** - * C​o​n​t​a​c​t + * I​n​c​l​u​d​e​ ​A​d​d​i​t​i​o​n​a​l​ ​D​a​t​a */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​t​a​g​ ​t​o + * A​d​d​i​t​i​o​n​a​l​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​t​a​g​ ​t​o + * S​p​e​c​i​f​y​ ​a​d​d​i​t​i​o​n​a​l​ ​r​e​l​a​t​e​d​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​d​e​t​a​i​l​s​,​ ​s​u​c​h​ ​a​s​ ​n​e​x​t​ ​t​r​a​n​s​a​c​t​i​o​n​ ​o​r​ ​r​e​c​u​r​r​i​n​g​ ​t​r​a​n​s​a​c​t​i​o​n​ ​d​e​t​a​i​l​s​. */ longDesc: string } } } - create_account: { + list_subscriptions: { groups: { /** - * A​c​c​o​u​n​t​ ​M​a​n​a​g​e​m​e​n​t + * S​u​b​s​c​r​i​p​t​i​o​n​s */ '0': string } /** - * C​r​e​a​t​e​ ​A​c​c​o​u​n​t + * L​i​s​t​ ​S​u​b​s​c​r​i​p​t​i​o​n​s */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​a​c​c​o​u​n​t + * L​i​s​t​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​a​c​c​o​u​n​t​ ​(​c​o​m​p​a​n​y​/​o​r​g​a​n​i​z​a​t​i​o​n​)​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​c​u​s​t​o​m​e​r​,​ ​s​t​a​t​u​s​,​ ​p​r​i​c​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​,​ ​p​l​u​s​ ​p​a​g​i​n​a​t​i​o​n​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. */ longDesc: string options: { - name: { + customer_id: { /** - * A​c​c​o​u​n​t​ ​N​a​m​e + * C​u​s​t​o​m​e​r​ ​I​D */ displayName: string /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t + * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​I​D */ shortDesc: string /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​a​c​c​o​u​n​t + * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​b​e​l​o​n​g​i​n​g​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​u​s​t​o​m​e​r​. */ longDesc: string } - accountUrl: { + address_id: { /** - * A​c​c​o​u​n​t​ ​U​R​L + * A​d​d​r​e​s​s​ ​I​D​s */ displayName: string /** - * T​h​e​ ​w​e​b​s​i​t​e​ ​U​R​L​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t + * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​a​d​d​r​e​s​s​ ​I​D​s */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​w​e​b​s​i​t​e​ ​U​R​L​ ​o​r​ ​d​o​m​a​i​n​ ​f​o​r​ ​t​h​e​ ​a​c​c​o​u​n​t + * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​u​s​t​o​m​e​r​ ​a​d​d​r​e​s​s​ ​I​D​s​. */ longDesc: string } - owner: { + after: { /** - * A​c​c​o​u​n​t​ ​O​w​n​e​r + * A​f​t​e​r */ displayName: string /** - * T​h​e​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​o​w​n​ ​t​h​i​s​ ​a​c​c​o​u​n​t + * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​t​h​i​s​ ​a​c​c​o​u​n​t + * R​e​t​u​r​n​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​d​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. */ longDesc: string } - fieldOptions: { + collection_mode: { /** - * C​u​s​t​o​m​ ​F​i​e​l​d​s + * C​o​l​l​e​c​t​i​o​n​ ​M​o​d​e */ displayName: string /** - * C​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s​ ​f​o​r​ ​t​h​e​ ​a​c​c​o​u​n​t + * F​i​l​t​e​r​ ​b​y​ ​p​a​y​m​e​n​t​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e */ shortDesc: string /** - * S​e​t​ ​v​a​l​u​e​s​ ​f​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​a​c​c​o​u​n​t​s + * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​b​y​ ​h​o​w​ ​p​a​y​m​e​n​t​s​ ​a​r​e​ ​c​o​l​l​e​c​t​e​d​ ​-​ ​e​i​t​h​e​r​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​o​r​ ​m​a​n​u​a​l​l​y​. */ longDesc: string } - } - } - create_contact: { - groups: { - /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - /** - * C​r​e​a​t​e​ ​C​o​n​t​a​c​t - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t - */ - shortDesc: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​b​a​s​i​c​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​n​d​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s - */ - longDesc: string - options: { - email: { + id: { /** - * E​m​a​i​l​ ​A​d​d​r​e​s​s + * S​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s */ shortDesc: string /** - * T​h​e​ ​p​r​i​m​a​r​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​(​r​e​q​u​i​r​e​d​) + * F​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​I​D​s​. */ longDesc: string } - firstName: { + order: { /** - * F​i​r​s​t​ ​N​a​m​e + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​f​i​r​s​t​ ​n​a​m​e + * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * S​p​e​c​i​f​y​ ​t​h​e​ ​f​i​e​l​d​ ​a​n​d​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​b​y​. + */ + longDesc: string + type: { + fields: { + field: { + /** + * S​o​r​t​ ​F​i​e​l​d + */ + displayName: string + /** + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y + */ + shortDesc: string + /** + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​. + */ + longDesc: string + } + direction: { + /** + * S​o​r​t​ ​D​i​r​e​c​t​i​o​n + */ + displayName: string + /** + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n + */ + shortDesc: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r​. + */ + longDesc: string + } + } + } + } + per_page: { + /** + * P​e​r​ ​P​a​g​e + */ + displayName: string + /** + * N​u​m​b​e​r​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e + */ + shortDesc: string + /** + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​. */ longDesc: string } - lastName: { + price_id: { /** - * L​a​s​t​ ​N​a​m​e + * P​r​i​c​e​ ​I​D​s */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​l​a​s​t​ ​n​a​m​e + * F​i​l​t​e​r​ ​b​y​ ​p​r​i​c​e​ ​I​D​s */ shortDesc: string /** - * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​p​r​i​c​e​ ​I​D​s​. */ longDesc: string } - phone: { + scheduled_change_action: { /** - * P​h​o​n​e​ ​N​u​m​b​e​r + * S​c​h​e​d​u​l​e​d​ ​C​h​a​n​g​e​ ​A​c​t​i​o​n​s */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * F​i​l​t​e​r​ ​b​y​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​ ​a​c​t​i​o​n​s */ shortDesc: string /** - * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​h​a​t​ ​h​a​v​e​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​s​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​a​c​t​i​o​n​s​ ​(​c​a​n​c​e​l​,​ ​p​a​u​s​e​,​ ​r​e​s​u​m​e​)​. */ longDesc: string } - fieldValues: { + status: { /** - * C​u​s​t​o​m​ ​F​i​e​l​d​ ​V​a​l​u​e​s + * S​t​a​t​u​s​ ​F​i​l​t​e​r */ displayName: string /** - * V​a​l​u​e​s​ ​f​o​r​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s + * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​b​y​ ​s​t​a​t​u​s */ shortDesc: string /** - * S​e​t​ ​v​a​l​u​e​s​ ​f​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​c​o​n​t​a​c​t​s + * F​i​l​t​e​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​t​a​t​u​s​ ​v​a​l​u​e​s​ ​(​a​c​t​i​v​e​,​ ​c​a​n​c​e​l​e​d​,​ ​p​a​s​t​_​d​u​e​,​ ​p​a​u​s​e​d​,​ ​t​r​i​a​l​i​n​g​)​. */ longDesc: string } } } - create_deal: { + create_transaction: { groups: { /** - * D​e​a​l​ ​M​a​n​a​g​e​m​e​n​t + * T​r​a​n​s​a​c​t​i​o​n​s */ '0': string } /** - * C​r​e​a​t​e​ ​D​e​a​l + * C​r​e​a​t​e​ ​T​r​a​n​s​a​c​t​i​o​n */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​d​e​a​l + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​t​r​a​n​s​a​c​t​i​o​n​ ​w​i​t​h​ ​i​t​e​m​s​ ​a​n​d​ ​b​i​l​l​i​n​g​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​a​l​e​s​ ​d​e​a​l​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​a​l​l​ ​r​e​l​e​v​a​n​t​ ​d​e​t​a​i​l​s + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​t​r​a​n​s​a​c​t​i​o​n​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​i​t​e​m​s​,​ ​c​u​s​t​o​m​e​r​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​b​i​l​l​i​n​g​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​.​ ​S​u​p​p​o​r​t​s​ ​b​o​t​h​ ​a​u​t​o​m​a​t​i​c​ ​a​n​d​ ​m​a​n​u​a​l​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e​s​. */ longDesc: string options: { - title: { + include: { /** - * D​e​a​l​ ​T​i​t​l​e + * I​n​c​l​u​d​e​ ​A​d​d​i​t​i​o​n​a​l​ ​D​a​t​a */ displayName: string /** - * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​d​e​a​l + * A​d​d​i​t​i​o​n​a​l​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e */ shortDesc: string /** - * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​d​e​a​l + * S​p​e​c​i​f​y​ ​a​d​d​i​t​i​o​n​a​l​ ​r​e​l​a​t​e​d​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​d​e​t​a​i​l​s​. */ longDesc: string } - account: { + items: { /** - * A​c​c​o​u​n​t + * T​r​a​n​s​a​c​t​i​o​n​ ​I​t​e​m​s */ displayName: string /** - * T​h​e​ ​a​c​c​o​u​n​t​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l + * I​t​e​m​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​a​c​c​o​u​n​t​/​c​o​m​p​a​n​y​ ​t​h​a​t​ ​t​h​i​s​ ​d​e​a​l​ ​i​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h + * L​i​s​t​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​,​ ​e​a​c​h​ ​w​i​t​h​ ​a​ ​p​r​i​c​e​ ​I​D​ ​a​n​d​ ​q​u​a​n​t​i​t​y​. */ longDesc: string + type: { + element_type: { + fields: { + price_id: { + /** + * P​r​i​c​e​ ​I​D + */ + displayName: string + /** + * T​h​e​ ​p​r​i​c​e​ ​I​D​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m + */ + shortDesc: string + /** + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​p​r​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​ ​i​t​e​m​. + */ + longDesc: string + } + quantity: { + /** + * Q​u​a​n​t​i​t​y + */ + displayName: string + /** + * Q​u​a​n​t​i​t​y​ ​o​f​ ​t​h​i​s​ ​i​t​e​m + */ + shortDesc: string + /** + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​u​n​i​t​s​ ​o​f​ ​t​h​i​s​ ​i​t​e​m​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​. + */ + longDesc: string + } + } + } + } } - contact: { + status: { /** - * C​o​n​t​a​c​t + * T​r​a​n​s​a​c​t​i​o​n​ ​S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​p​r​i​m​a​r​y​ ​c​o​n​t​a​c​t​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l + * I​n​i​t​i​a​l​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​m​a​i​n​ ​c​o​n​t​a​c​t​ ​p​e​r​s​o​n​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l + * S​e​t​ ​t​h​e​ ​i​n​i​t​i​a​l​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​-​ ​e​i​t​h​e​r​ ​b​i​l​l​e​d​ ​o​r​ ​c​a​n​c​e​l​e​d​. */ longDesc: string } - value: { + customer_id: { /** - * D​e​a​l​ ​V​a​l​u​e + * C​u​s​t​o​m​e​r​ ​I​D */ displayName: string /** - * T​h​e​ ​m​o​n​e​t​a​r​y​ ​v​a​l​u​e​ ​o​f​ ​t​h​e​ ​d​e​a​l + * I​D​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​t​o​t​a​l​ ​v​a​l​u​e​ ​o​r​ ​a​m​o​u​n​t​ ​o​f​ ​t​h​e​ ​d​e​a​l + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​c​h​a​r​g​e​d​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. */ longDesc: string } - currency: { + address_id: { /** - * C​u​r​r​e​n​c​y + * A​d​d​r​e​s​s​ ​I​D */ displayName: string /** - * T​h​e​ ​c​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​v​a​l​u​e + * C​u​s​t​o​m​e​r​ ​a​d​d​r​e​s​s​ ​I​D​ ​f​o​r​ ​b​i​l​l​i​n​g */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​u​r​r​e​n​c​y​ ​t​h​a​t​ ​t​h​e​ ​d​e​a​l​ ​v​a​l​u​e​ ​i​s​ ​d​e​n​o​m​i​n​a​t​e​d​ ​i​n + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​a​d​d​r​e​s​s​ ​t​o​ ​u​s​e​ ​f​o​r​ ​b​i​l​l​i​n​g​ ​a​n​d​ ​t​a​x​ ​c​a​l​c​u​l​a​t​i​o​n​s​. */ longDesc: string } - stage: { + business_id: { /** - * D​e​a​l​ ​S​t​a​g​e + * B​u​s​i​n​e​s​s​ ​I​D */ displayName: string /** - * T​h​e​ ​c​u​r​r​e​n​t​ ​s​t​a​g​e​ ​o​f​ ​t​h​e​ ​d​e​a​l + * C​u​s​t​o​m​e​r​ ​b​u​s​i​n​e​s​s​ ​I​D */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​p​i​p​e​l​i​n​e​ ​s​t​a​g​e​ ​t​h​a​t​ ​r​e​p​r​e​s​e​n​t​s​ ​t​h​e​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​d​e​a​l + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​b​u​s​i​n​e​s​s​ ​e​n​t​i​t​y​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. */ longDesc: string } - group: { + custom_data: { /** - * P​i​p​e​l​i​n​e​ ​G​r​o​u​p + * C​u​s​t​o​m​ ​D​a​t​a */ displayName: string /** - * T​h​e​ ​p​i​p​e​l​i​n​e​ ​g​r​o​u​p​ ​f​o​r​ ​t​h​e​ ​d​e​a​l + * C​u​s​t​o​m​ ​m​e​t​a​d​a​t​a​ ​f​o​r​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​p​i​p​e​l​i​n​e​ ​g​r​o​u​p​ ​t​h​a​t​ ​t​h​i​s​ ​d​e​a​l​ ​b​e​l​o​n​g​s​ ​t​o + * C​u​s​t​o​m​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​ ​t​o​ ​s​t​o​r​e​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​w​i​t​h​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​. */ longDesc: string } - owner: { + currency_code: { /** - * D​e​a​l​ ​O​w​n​e​r + * C​u​r​r​e​n​c​y​ ​C​o​d​e */ displayName: string /** - * T​h​e​ ​u​s​e​r​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l + * C​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​t​h​i​s​ ​d​e​a​l + * T​h​e​ ​t​h​r​e​e​-​l​e​t​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. */ longDesc: string } - percent: { + collection_mode: { /** - * C​o​m​p​l​e​t​i​o​n​ ​P​e​r​c​e​n​t​a​g​e + * C​o​l​l​e​c​t​i​o​n​ ​M​o​d​e */ displayName: string /** - * T​h​e​ ​p​e​r​c​e​n​t​a​g​e​ ​c​o​m​p​l​e​t​i​o​n​ ​o​f​ ​t​h​e​ ​d​e​a​l + * H​o​w​ ​p​a​y​m​e​n​t​ ​w​i​l​l​ ​b​e​ ​c​o​l​l​e​c​t​e​d */ shortDesc: string /** - * A​ ​p​e​r​c​e​n​t​a​g​e​ ​v​a​l​u​e​ ​r​e​p​r​e​s​e​n​t​i​n​g​ ​h​o​w​ ​c​l​o​s​e​ ​t​h​e​ ​d​e​a​l​ ​i​s​ ​t​o​ ​c​o​m​p​l​e​t​i​o​n + * S​p​e​c​i​f​y​ ​w​h​e​t​h​e​r​ ​p​a​y​m​e​n​t​ ​s​h​o​u​l​d​ ​b​e​ ​c​o​l​l​e​c​t​e​d​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​o​r​ ​m​a​n​u​a​l​l​y​. */ longDesc: string } - description: { + discount_id: { /** - * D​e​a​l​ ​D​e​s​c​r​i​p​t​i​o​n + * D​i​s​c​o​u​n​t​ ​I​D */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​n​o​t​e​s + * D​i​s​c​o​u​n​t​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​a​d​d​i​t​i​o​n​a​l​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​e​ ​d​e​a​l + * T​h​e​ ​I​D​ ​o​f​ ​a​ ​d​i​s​c​o​u​n​t​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. */ longDesc: string } - status: { + billing_details: { /** - * D​e​a​l​ ​S​t​a​t​u​s + * B​i​l​l​i​n​g​ ​D​e​t​a​i​l​s */ displayName: string /** - * T​h​e​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​d​e​a​l + * B​i​l​l​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​d​e​a​l​ ​i​s​ ​o​p​e​n​,​ ​w​o​n​,​ ​o​r​ ​l​o​s​t + * B​i​l​l​i​n​g​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​p​a​y​m​e​n​t​ ​t​e​r​m​s​,​ ​c​h​e​c​k​o​u​t​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​. + */ + longDesc: string + type: { + fields: { + payment_terms: { + /** + * P​a​y​m​e​n​t​ ​T​e​r​m​s + */ + displayName: string + /** + * P​a​y​m​e​n​t​ ​t​e​r​m​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + */ + shortDesc: string + /** + * D​e​f​i​n​e​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​t​e​r​m​s​ ​i​n​c​l​u​d​i​n​g​ ​i​n​t​e​r​v​a​l​ ​a​n​d​ ​f​r​e​q​u​e​n​c​y​. + */ + longDesc: string + type: { + fields: { + interval: { + /** + * I​n​t​e​r​v​a​l + */ + displayName: string + /** + * P​a​y​m​e​n​t​ ​i​n​t​e​r​v​a​l​ ​u​n​i​t + */ + shortDesc: string + /** + * T​h​e​ ​u​n​i​t​ ​o​f​ ​t​i​m​e​ ​f​o​r​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​i​n​t​e​r​v​a​l​ ​(​d​a​y​,​ ​w​e​e​k​,​ ​m​o​n​t​h​,​ ​y​e​a​r​)​. + */ + longDesc: string + } + frequency: { + /** + * F​r​e​q​u​e​n​c​y + */ + displayName: string + /** + * P​a​y​m​e​n​t​ ​f​r​e​q​u​e​n​c​y + */ + shortDesc: string + /** + * H​o​w​ ​o​f​t​e​n​ ​p​a​y​m​e​n​t​s​ ​o​c​c​u​r​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​i​n​t​e​r​v​a​l​. + */ + longDesc: string + } + } + } + } + enable_checkout: { + /** + * E​n​a​b​l​e​ ​C​h​e​c​k​o​u​t + */ + displayName: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​e​n​a​b​l​e​ ​c​h​e​c​k​o​u​t + */ + shortDesc: string + /** + * E​n​a​b​l​e​ ​o​r​ ​d​i​s​a​b​l​e​ ​t​h​e​ ​c​h​e​c​k​o​u​t​ ​p​r​o​c​e​s​s​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. + */ + longDesc: string + } + purchase_order_number: { + /** + * P​u​r​c​h​a​s​e​ ​O​r​d​e​r​ ​N​u​m​b​e​r + */ + displayName: string + /** + * P​u​r​c​h​a​s​e​ ​o​r​d​e​r​ ​r​e​f​e​r​e​n​c​e + */ + shortDesc: string + /** + * A​ ​p​u​r​c​h​a​s​e​ ​o​r​d​e​r​ ​n​u​m​b​e​r​ ​f​o​r​ ​r​e​f​e​r​e​n​c​e​ ​a​n​d​ ​t​r​a​c​k​i​n​g​ ​p​u​r​p​o​s​e​s​. + */ + longDesc: string + } + additional_information: { + /** + * A​d​d​i​t​i​o​n​a​l​ ​I​n​f​o​r​m​a​t​i​o​n + */ + displayName: string + /** + * E​x​t​r​a​ ​b​i​l​l​i​n​g​ ​i​n​f​o​r​m​a​t​i​o​n + */ + shortDesc: string + /** + * A​n​y​ ​a​d​d​i​t​i​o​n​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​b​i​l​l​i​n​g​ ​d​e​t​a​i​l​s​. + */ + longDesc: string + } + } + } + } + billing_period: { + /** + * B​i​l​l​i​n​g​ ​P​e​r​i​o​d + */ + displayName: string + /** + * T​i​m​e​ ​p​e​r​i​o​d​ ​f​o​r​ ​b​i​l​l​i​n​g + */ + shortDesc: string + /** + * D​e​f​i​n​e​ ​t​h​e​ ​s​t​a​r​t​ ​a​n​d​ ​e​n​d​ ​d​a​t​e​s​ ​f​o​r​ ​t​h​e​ ​b​i​l​l​i​n​g​ ​p​e​r​i​o​d​. */ longDesc: string + type: { + fields: { + ends_at: { + /** + * E​n​d​ ​D​a​t​e + */ + displayName: string + /** + * B​i​l​l​i​n​g​ ​p​e​r​i​o​d​ ​e​n​d​ ​d​a​t​e + */ + shortDesc: string + /** + * T​h​e​ ​d​a​t​e​ ​w​h​e​n​ ​t​h​e​ ​b​i​l​l​i​n​g​ ​p​e​r​i​o​d​ ​e​n​d​s​. + */ + longDesc: string + } + starts_at: { + /** + * S​t​a​r​t​ ​D​a​t​e + */ + displayName: string + /** + * B​i​l​l​i​n​g​ ​p​e​r​i​o​d​ ​s​t​a​r​t​ ​d​a​t​e + */ + shortDesc: string + /** + * T​h​e​ ​d​a​t​e​ ​w​h​e​n​ ​t​h​e​ ​b​i​l​l​i​n​g​ ​p​e​r​i​o​d​ ​s​t​a​r​t​s​. + */ + longDesc: string + } + } + } } - } - } - get_account: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * G​e​t​ ​A​c​c​o​u​n​t - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​c​c​o​u​n​t​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​a​c​c​o​u​n​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n - */ - longDesc: string - options: { - id: { + checkout_url: { /** - * A​c​c​o​u​n​t​ ​I​D + * C​h​e​c​k​o​u​t​ ​U​R​L */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * C​u​s​t​o​m​ ​c​h​e​c​k​o​u​t​ ​U​R​L */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * A​ ​c​u​s​t​o​m​ ​U​R​L​ ​t​o​ ​r​e​d​i​r​e​c​t​ ​c​u​s​t​o​m​e​r​s​ ​t​o​ ​f​o​r​ ​c​h​e​c​k​o​u​t​ ​c​o​m​p​l​e​t​i​o​n​. */ longDesc: string } } } - get_campaign: { + get_transaction: { groups: { /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + * T​r​a​n​s​a​c​t​i​o​n​s */ '0': string } /** - * G​e​t​ ​C​a​m​p​a​i​g​n + * G​e​t​ ​T​r​a​n​s​a​c​t​i​o​n */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​c​a​m​p​a​i​g​n​ ​d​e​t​a​i​l​s + * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​b​y​ ​I​D */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​m​p​a​i​g​n​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * F​e​t​c​h​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​i​t​e​m​s​,​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​s​t​a​t​u​s​. */ longDesc: string options: { - id: { + transaction_id: { /** - * C​a​m​p​a​i​g​n​ ​I​D + * T​r​a​n​s​a​c​t​i​o​n​ ​I​D */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​a​m​p​a​i​g​n​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​a​m​p​a​i​g​n​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​f​e​t​c​h​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​. */ longDesc: string } - } - } - get_contact: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * G​e​t​ ​C​o​n​t​a​c​t - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​c​o​n​t​a​c​t​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​,​ ​a​u​t​o​m​a​t​i​o​n​s​,​ ​a​n​d​ ​r​e​l​a​t​e​d​ ​d​a​t​a - */ - longDesc: string - options: { - id: { + include: { /** - * C​o​n​t​a​c​t​ ​I​D + * I​n​c​l​u​d​e​ ​A​d​d​i​t​i​o​n​a​l​ ​D​a​t​a */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * A​d​d​i​t​i​o​n​a​l​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * S​p​e​c​i​f​y​ ​a​d​d​i​t​i​o​n​a​l​ ​r​e​l​a​t​e​d​ ​d​a​t​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​d​e​t​a​i​l​s​. */ longDesc: string } } } - get_deal: { + list_transactions: { groups: { /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + * T​r​a​n​s​a​c​t​i​o​n​s */ '0': string } /** - * G​e​t​ ​D​e​a​l + * L​i​s​t​ ​T​r​a​n​s​a​c​t​i​o​n​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​d​e​a​l​ ​d​e​t​a​i​l​s + * L​i​s​t​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​s​u​p​p​o​r​t​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​d​a​t​e​,​ ​c​u​s​t​o​m​e​r​,​ ​s​t​a​t​u​s​,​ ​o​r​i​g​i​n​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​,​ ​p​l​u​s​ ​p​a​g​i​n​a​t​i​o​n​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. */ longDesc: string options: { - id: { + after: { /** - * D​e​a​l​ ​I​D + * A​f​t​e​r */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​r​e​t​r​i​e​v​e + * P​a​g​i​n​a​t​i​o​n​ ​c​u​r​s​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​d​e​a​l​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * R​e​t​u​r​n​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​c​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​d​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. */ longDesc: string } - } - } - get_form: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * G​e​t​ ​F​o​r​m - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​f​o​r​m​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​f​o​r​m​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​i​n​c​l​u​d​i​n​g​ ​s​t​y​l​i​n​g​ ​a​n​d​ ​f​i​e​l​d​ ​c​o​n​f​i​g​u​r​a​t​i​o​n - */ - longDesc: string - options: { - id: { + billed_at: { /** - * F​o​r​m​ ​I​D + * B​i​l​l​e​d​ ​A​t​ ​F​i​l​t​e​r */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​f​o​r​m​ ​t​o​ ​r​e​t​r​i​e​v​e + * F​i​l​t​e​r​ ​b​y​ ​b​i​l​l​i​n​g​ ​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​f​o​r​m​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​w​h​e​n​ ​t​h​e​y​ ​w​e​r​e​ ​b​i​l​l​e​d​ ​u​s​i​n​g​ ​d​a​t​e​ ​c​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​s​. */ longDesc: string + type: { + fields: { + operator: { + /** + * D​a​t​e​ ​O​p​e​r​a​t​o​r + */ + displayName: string + /** + * C​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​ ​f​o​r​ ​t​h​e​ ​d​a​t​e + */ + shortDesc: string + /** + * T​h​e​ ​o​p​e​r​a​t​o​r​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​o​m​p​a​r​i​n​g​ ​t​h​e​ ​b​i​l​l​e​d​ ​d​a​t​e​. + */ + longDesc: string + } + value: { + /** + * D​a​t​e​ ​V​a​l​u​e + */ + displayName: string + /** + * T​h​e​ ​d​a​t​e​ ​t​o​ ​c​o​m​p​a​r​e​ ​a​g​a​i​n​s​t + */ + shortDesc: string + /** + * T​h​e​ ​d​a​t​e​ ​v​a​l​u​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​r​i​s​o​n​. + */ + longDesc: string + } + } + } } - } - } - get_list: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * G​e​t​ ​L​i​s​t - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​l​i​s​t​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​i​n​c​l​u​d​i​n​g​ ​s​e​t​t​i​n​g​s​ ​a​n​d​ ​c​o​n​f​i​g​u​r​a​t​i​o​n - */ - longDesc: string - options: { - id: { + created_at: { /** - * L​i​s​t​ ​I​D + * C​r​e​a​t​e​d​ ​A​t​ ​F​i​l​t​e​r */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * F​i​l​t​e​r​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​w​h​e​n​ ​t​h​e​y​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​u​s​i​n​g​ ​d​a​t​e​ ​c​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​s​. */ longDesc: string + type: { + fields: { + operator: { + /** + * D​a​t​e​ ​O​p​e​r​a​t​o​r + */ + displayName: string + /** + * C​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​ ​f​o​r​ ​t​h​e​ ​d​a​t​e + */ + shortDesc: string + /** + * T​h​e​ ​o​p​e​r​a​t​o​r​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​o​m​p​a​r​i​n​g​ ​t​h​e​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. + */ + longDesc: string + } + value: { + /** + * D​a​t​e​ ​V​a​l​u​e + */ + displayName: string + /** + * T​h​e​ ​d​a​t​e​ ​t​o​ ​c​o​m​p​a​r​e​ ​a​g​a​i​n​s​t + */ + shortDesc: string + /** + * T​h​e​ ​d​a​t​e​ ​v​a​l​u​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​r​i​s​o​n​. + */ + longDesc: string + } + } + } } - } - } - get_task: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * G​e​t​ ​T​a​s​k - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​t​a​s​k​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​ ​t​a​s​k​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n - */ - longDesc: string - options: { - id: { + updated_at: { /** - * T​a​s​k​ ​I​D + * U​p​d​a​t​e​d​ ​A​t​ ​F​i​l​t​e​r */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​t​a​s​k​ ​t​o​ ​r​e​t​r​i​e​v​e + * F​i​l​t​e​r​ ​b​y​ ​l​a​s​t​ ​u​p​d​a​t​e​ ​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​w​h​e​n​ ​t​h​e​y​ ​w​e​r​e​ ​l​a​s​t​ ​u​p​d​a​t​e​d​ ​u​s​i​n​g​ ​d​a​t​e​ ​c​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​s​. */ longDesc: string + type: { + fields: { + operator: { + /** + * D​a​t​e​ ​O​p​e​r​a​t​o​r + */ + displayName: string + /** + * C​o​m​p​a​r​i​s​o​n​ ​o​p​e​r​a​t​o​r​ ​f​o​r​ ​t​h​e​ ​d​a​t​e + */ + shortDesc: string + /** + * T​h​e​ ​o​p​e​r​a​t​o​r​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​o​m​p​a​r​i​n​g​ ​t​h​e​ ​u​p​d​a​t​e​ ​d​a​t​e​. + */ + longDesc: string + } + value: { + /** + * D​a​t​e​ ​V​a​l​u​e + */ + displayName: string + /** + * T​h​e​ ​d​a​t​e​ ​t​o​ ​c​o​m​p​a​r​e​ ​a​g​a​i​n​s​t + */ + shortDesc: string + /** + * T​h​e​ ​d​a​t​e​ ​v​a​l​u​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​r​i​s​o​n​. + */ + longDesc: string + } + } + } } - } - } - get_user: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * G​e​t​ ​U​s​e​r - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​u​s​e​r​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​u​s​e​r​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n - */ - longDesc: string - options: { - id: { + customer_id: { /** - * U​s​e​r​ ​I​D + * C​u​s​t​o​m​e​r​ ​I​D​s */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​u​s​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e + * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​I​D​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​b​e​l​o​n​g​i​n​g​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​u​s​t​o​m​e​r​s​. */ longDesc: string } - } - } - list_accounts: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * L​i​s​t​ ​A​c​c​o​u​n​t​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​c​c​o​u​n​t​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​a​n​d​ ​f​i​l​t​e​r​i​n​g - */ - longDesc: string - options: { - search: { + invoice_number: { /** - * S​e​a​r​c​h + * I​n​v​o​i​c​e​ ​N​u​m​b​e​r​s */ displayName: string /** - * S​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​a​c​c​o​u​n​t​s + * F​i​l​t​e​r​ ​b​y​ ​i​n​v​o​i​c​e​ ​n​u​m​b​e​r​s */ shortDesc: string /** - * S​e​a​r​c​h​ ​f​o​r​ ​a​c​c​o​u​n​t​s​ ​b​y​ ​n​a​m​e​ ​o​r​ ​o​t​h​e​r​ ​s​e​a​r​c​h​a​b​l​e​ ​f​i​e​l​d​s + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​i​n​v​o​i​c​e​ ​n​u​m​b​e​r​s​. */ longDesc: string } - count_deals: { + origin: { /** - * C​o​u​n​t​ ​D​e​a​l​s + * T​r​a​n​s​a​c​t​i​o​n​ ​O​r​i​g​i​n​s */ displayName: string /** - * I​n​c​l​u​d​e​ ​d​e​a​l​ ​c​o​u​n​t​ ​f​o​r​ ​e​a​c​h​ ​a​c​c​o​u​n​t + * F​i​l​t​e​r​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​o​r​i​g​i​n */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​e​a​c​h​ ​a​c​c​o​u​n​t​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​h​o​w​ ​t​h​e​y​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​(​A​P​I​,​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​b​i​l​l​i​n​g​,​ ​e​t​c​.​)​. */ longDesc: string } - limit: { + order: { /** - * L​i​m​i​t + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​t​o​ ​r​e​t​u​r​n + * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * S​p​e​c​i​f​y​ ​t​h​e​ ​f​i​e​l​d​ ​a​n​d​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​. + */ + longDesc: string + type: { + fields: { + field: { + /** + * S​o​r​t​ ​F​i​e​l​d + */ + displayName: string + /** + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y + */ + shortDesc: string + /** + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​. + */ + longDesc: string + } + direction: { + /** + * S​o​r​t​ ​D​i​r​e​c​t​i​o​n + */ + displayName: string + /** + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n + */ + shortDesc: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r​. + */ + longDesc: string + } + } + } + } + status: { + /** + * S​t​a​t​u​s​ ​F​i​l​t​e​r + */ + displayName: string + /** + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​ ​s​t​a​t​u​s + */ + shortDesc: string + /** + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​t​a​t​u​s​ ​v​a​l​u​e​s​. */ longDesc: string } - offset: { + subscription_id: { /** - * O​f​f​s​e​t + * S​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​t​o​ ​s​k​i​p + * F​i​l​t​e​r​ ​b​y​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​t​h​o​s​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​. + */ + longDesc: string + } + per_page: { + /** + * P​e​r​ ​P​a​g​e + */ + displayName: string + /** + * N​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e + */ + shortDesc: string + /** + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​2​0​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​. */ longDesc: string } } } - list_campaigns: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + } + triggers: { + new_customer: { /** - * L​i​s​t​ ​C​a​m​p​a​i​g​n​s + * N​e​w​ ​C​u​s​t​o​m​e​r */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​m​p​a​i​g​n​s + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​u​s​t​o​m​e​r​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​c​u​s​t​o​m​e​r​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​s​t​a​t​u​s​ ​a​n​d​ ​s​e​a​r​c​h​ ​c​r​i​t​e​r​i​a​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​s​ ​t​h​a​t​ ​m​a​t​c​h​ ​y​o​u​r​ ​r​e​q​u​i​r​e​m​e​n​t​s​. */ longDesc: string options: { - limit: { + status: { /** - * L​i​m​i​t + * S​t​a​t​u​s */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​t​o​ ​r​e​t​u​r​n + * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​s​t​a​t​u​s */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​c​u​s​t​o​m​e​r​s​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​c​u​s​t​o​m​e​r​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. */ longDesc: string } - offset: { + search: { /** - * O​f​f​s​e​t + * S​e​a​r​c​h */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​t​o​ ​s​k​i​p + * S​e​a​r​c​h​ ​f​i​l​t​e​r​ ​f​o​r​ ​c​u​s​t​o​m​e​r​s */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * S​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​c​u​s​t​o​m​e​r​s​ ​b​y​ ​n​a​m​e​,​ ​e​m​a​i​l​,​ ​o​r​ ​o​t​h​e​r​ ​s​e​a​r​c​h​a​b​l​e​ ​f​i​e​l​d​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​l​l​ ​c​u​s​t​o​m​e​r​s​. */ longDesc: string } } } - list_contacts: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + new_product: { /** - * L​i​s​t​ ​C​o​n​t​a​c​t​s + * N​e​w​ ​P​r​o​d​u​c​t */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​s + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​p​r​o​d​u​c​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​e​x​t​e​n​s​i​v​e​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s + * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​p​r​o​d​u​c​t​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​c​a​t​a​l​o​g​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​s​t​a​t​u​s​,​ ​t​y​p​e​,​ ​a​n​d​ ​t​a​x​ ​c​a​t​e​g​o​r​y​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​p​r​o​d​u​c​t​s​ ​t​h​a​t​ ​m​a​t​c​h​ ​y​o​u​r​ ​c​r​i​t​e​r​i​a​. */ longDesc: string options: { - email: { + include_prices: { /** - * E​m​a​i​l + * I​n​c​l​u​d​e​ ​P​r​i​c​e​s */ displayName: string /** - * E​x​a​c​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r + * I​n​c​l​u​d​e​ ​p​r​i​c​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​e​x​a​c​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​m​a​t​c​h + * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​w​i​l​l​ ​i​n​c​l​u​d​e​ ​d​e​t​a​i​l​e​d​ ​p​r​i​c​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​e​a​c​h​ ​p​r​o​d​u​c​t​ ​i​n​ ​t​h​e​ ​e​v​e​n​t​ ​d​a​t​a​. */ longDesc: string } - email_like: { + status: { /** - * E​m​a​i​l​ ​L​i​k​e + * S​t​a​t​u​s */ displayName: string /** - * P​a​r​t​i​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r + * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​s​t​a​t​u​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​p​a​r​t​i​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​m​a​t​c​h + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. */ longDesc: string } - phone: { + type: { /** - * P​h​o​n​e + * T​y​p​e */ displayName: string /** - * P​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r + * F​i​l​t​e​r​ ​b​y​ ​p​r​o​d​u​c​t​ ​t​y​p​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​o​f​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​t​y​p​e​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​o​f​ ​a​n​y​ ​t​y​p​e​. */ longDesc: string } - search: { + tax_category: { /** - * S​e​a​r​c​h + * T​a​x​ ​C​a​t​e​g​o​r​y */ displayName: string /** - * G​e​n​e​r​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m + * F​i​l​t​e​r​ ​b​y​ ​t​a​x​ ​c​a​t​e​g​o​r​i​e​s */ shortDesc: string /** - * S​e​a​r​c​h​ ​f​o​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​n​a​m​e​,​ ​e​m​a​i​l​,​ ​o​r​ ​o​t​h​e​r​ ​s​e​a​r​c​h​a​b​l​e​ ​f​i​e​l​d​s + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​i​n​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​t​a​x​ ​c​a​t​e​g​o​r​i​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​p​r​o​d​u​c​t​s​ ​i​n​ ​a​n​y​ ​t​a​x​ ​c​a​t​e​g​o​r​y​. */ longDesc: string } + } + } + new_report: { + /** + * N​e​w​ ​R​e​p​o​r​t + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​r​e​p​o​r​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​r​e​p​o​r​t​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​r​e​p​o​r​t​ ​s​t​a​t​u​s​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​p​o​r​t​s​ ​i​n​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​e​s​. + */ + longDesc: string + options: { status: { /** * S​t​a​t​u​s */ displayName: string /** - * C​o​n​t​a​c​t​ ​s​t​a​t​u​s​ ​f​i​l​t​e​r + * F​i​l​t​e​r​ ​b​y​ ​r​e​p​o​r​t​ ​s​t​a​t​u​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​t​h​e​i​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​s​t​a​t​u​s + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​p​o​r​t​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​p​o​r​t​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. */ longDesc: string } - formid: { + } + } + new_subscription: { + /** + * N​e​w​ ​S​u​b​s​c​r​i​p​t​i​o​n + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​,​ ​p​r​i​c​e​,​ ​s​t​a​t​u​s​,​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e​,​ ​a​n​d​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​s​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​. + */ + longDesc: string + options: { + customer_id: { /** - * F​o​r​m​ ​I​D + * C​u​s​t​o​m​e​r */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​f​o​r​m​ ​s​u​b​s​c​r​i​p​t​i​o​n + * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​w​h​o​ ​s​u​b​s​c​r​i​b​e​d​ ​t​h​r​o​u​g​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​f​o​r​m + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​b​e​l​o​n​g​i​n​g​ ​t​o​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​f​r​o​m​ ​a​n​y​ ​c​u​s​t​o​m​e​r​. */ longDesc: string } - listid: { + price_id: { /** - * L​i​s​t​ ​I​D + * P​r​i​c​e​ ​I​D​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​l​i​s​t​ ​m​e​m​b​e​r​s​h​i​p + * F​i​l​t​e​r​ ​b​y​ ​p​r​i​c​e​ ​I​D​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​w​h​o​ ​a​r​e​ ​m​e​m​b​e​r​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​u​s​i​n​g​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​p​r​i​c​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​p​r​i​c​e​. */ longDesc: string } - sort: { + status: { /** - * S​o​r​t​ ​O​p​t​i​o​n​s + * S​t​a​t​u​s */ displayName: string /** - * S​o​r​t​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + * F​i​l​t​e​r​ ​b​y​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​s​t​a​t​u​s */ shortDesc: string /** - * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​r​e​s​u​l​t​s + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. */ longDesc: string - type: { - fields: { - field: { - /** - * S​o​r​t​ ​F​i​e​l​d - */ - displayName: string - /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​t​h​e​ ​c​o​n​t​a​c​t​s - */ - longDesc: string - } - order: { - /** - * S​o​r​t​ ​O​r​d​e​r - */ - displayName: string - /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n - */ - shortDesc: string - /** - * W​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r - */ - longDesc: string - } - } - } } - limit: { + collection_mode: { /** - * L​i​m​i​t + * C​o​l​l​e​c​t​i​o​n​ ​M​o​d​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n + * F​i​l​t​e​r​ ​b​y​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​c​o​l​l​e​c​t​i​o​n​ ​m​o​d​e​. */ longDesc: string } - offset: { + scheduled_change_action: { /** - * O​f​f​s​e​t + * S​c​h​e​d​u​l​e​d​ ​C​h​a​n​g​e​ ​A​c​t​i​o​n */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​s​k​i​p + * F​i​l​t​e​r​ ​b​y​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​ ​a​c​t​i​o​n​s */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​ ​a​c​t​i​o​n​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​o​r​ ​n​o​ ​s​c​h​e​d​u​l​e​d​ ​c​h​a​n​g​e​s​. */ longDesc: string } } } - list_deals: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + new_transaction: { /** - * L​i​s​t​ ​D​e​a​l​s + * N​e​w​ ​T​r​a​n​s​a​c​t​i​o​n */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​s + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​t​r​a​n​s​a​c​t​i​o​n​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​P​a​d​d​l​e​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​f​u​n​c​t​i​o​n​a​l​i​t​y + * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​i​n​ ​y​o​u​r​ ​P​a​d​d​l​e​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​,​ ​s​u​b​s​c​r​i​p​t​i​o​n​,​ ​s​t​a​t​u​s​,​ ​a​n​d​ ​o​r​i​g​i​n​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​h​a​t​ ​m​a​t​c​h​ ​y​o​u​r​ ​c​r​i​t​e​r​i​a​. */ longDesc: string options: { - limit: { + customer_id: { /** - * L​i​m​i​t + * C​u​s​t​o​m​e​r​ ​I​D​s */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​r​e​t​u​r​n + * F​i​l​t​e​r​ ​b​y​ ​c​u​s​t​o​m​e​r​ ​I​D​s */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​f​r​o​m​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​c​u​s​t​o​m​e​r​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​f​r​o​m​ ​a​n​y​ ​c​u​s​t​o​m​e​r​. */ longDesc: string } - offset: { + status: { /** - * O​f​f​s​e​t + * S​t​a​t​u​s */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​s​k​i​p + * F​i​l​t​e​r​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​t​a​t​u​s */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​t​a​t​u​s​e​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​s​t​a​t​u​s​. */ longDesc: string } - search: { + subscription_id: { /** - * S​e​a​r​c​h​ ​O​p​t​i​o​n​s + * S​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s */ displayName: string /** - * S​e​a​r​c​h​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​f​o​r​ ​d​e​a​l​s + * F​i​l​t​e​r​ ​b​y​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​I​D​s */ shortDesc: string /** - * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​d​e​a​l​s​ ​b​y​ ​d​i​f​f​e​r​e​n​t​ ​f​i​e​l​d​s + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​r​e​l​a​t​e​d​ ​t​o​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​f​r​o​m​ ​a​n​y​ ​s​u​b​s​c​r​i​p​t​i​o​n​. + */ + longDesc: string + } + origin: { + /** + * O​r​i​g​i​n + */ + displayName: string + /** + * F​i​l​t​e​r​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​o​r​i​g​i​n + */ + shortDesc: string + /** + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​t​h​e​s​e​ ​s​p​e​c​i​f​i​c​ ​o​r​i​g​i​n​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​ ​a​n​y​ ​o​r​i​g​i​n​. */ longDesc: string - type: { - fields: { - field: { - /** - * S​e​a​r​c​h​ ​F​i​e​l​d - */ - displayName: string - /** - * F​i​e​l​d​ ​t​o​ ​s​e​a​r​c​h​ ​i​n - */ - shortDesc: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​e​a​r​c​h​ ​i​n​ ​(​t​i​t​l​e​,​ ​c​o​n​t​a​c​t​,​ ​o​r​g​a​n​i​z​a​t​i​o​n​,​ ​o​r​ ​a​l​l​) - */ - longDesc: string - } - value: { - /** - * S​e​a​r​c​h​ ​V​a​l​u​e - */ - displayName: string - /** - * V​a​l​u​e​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r - */ - shortDesc: string - /** - * T​h​e​ ​s​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​l​o​o​k​ ​f​o​r​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​f​i​e​l​d - */ - longDesc: string - } - } - } } } } - list_deal_stages: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + } + } + Messenger360: { + /** + * 3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​f​o​r​ ​W​h​a​t​s​A​p​p + */ + displayName: string + groups: { + /** + * M​e​s​s​a​g​i​n​g​ ​&​ ​R​e​a​l​-​t​i​m​e​ ​C​o​m​m​u​n​i​c​a​t​i​o​n + */ + '0': string + } + /** + * A​u​t​o​m​a​t​e​ ​a​n​d​ ​s​e​n​d​ ​p​e​r​s​o​n​a​l​i​z​e​d​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​s​ ​u​s​i​n​g​ ​3​6​0​ ​M​e​s​s​e​n​g​e​r​. + */ + shortDesc: string + /** + * 3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​f​o​r​ ​W​h​a​t​s​A​p​p​ ​e​n​a​b​l​e​s​ ​y​o​u​ ​t​o​ ​s​e​n​d​ ​a​u​t​o​m​a​t​e​d​ ​a​n​d​ ​p​e​r​s​o​n​a​l​i​z​e​d​ ​m​e​s​s​a​g​e​s​ ​d​i​r​e​c​t​l​y​ ​t​h​r​o​u​g​h​ ​W​h​a​t​s​A​p​p​ ​B​u​s​i​n​e​s​s​ ​a​c​c​o​u​n​t​s​.​ ​I​d​e​a​l​ ​f​o​r​ ​c​u​s​t​o​m​e​r​ ​e​n​g​a​g​e​m​e​n​t​,​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​,​ ​a​n​d​ ​s​u​p​p​o​r​t​ ​w​o​r​k​f​l​o​w​s​,​ ​t​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​e​n​s​u​r​e​s​ ​f​a​s​t​ ​a​n​d​ ​r​e​l​i​a​b​l​e​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​ ​a​t​ ​s​c​a​l​e​ ​v​i​a​ ​W​h​a​t​s​A​p​p​. + */ + longDesc: string + connectionMessage: { + /** + * C​o​n​n​e​c​t​ ​t​o​ ​3​6​0​ ​M​e​s​s​e​n​g​e​r + */ + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​f​o​r​ ​W​h​a​t​s​A​p​p​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​P​I​ ​K​e​y​*​*​.​ + ​ + ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​A​P​I​ ​K​e​y​ + ​ + ​1​.​ ​S​i​g​n​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​D​a​s​h​b​o​a​r​d​]​(​h​t​t​p​s​:​/​/​3​6​0​m​e​s​s​e​n​g​e​r​.​c​o​m​/​)​ + ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​*​*​S​e​t​t​i​n​g​s​*​*​ ​o​r​ ​*​*​A​P​I​ ​S​e​t​t​i​n​g​s​*​*​ + ​3​.​ ​L​o​c​a​t​e​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​o​r​ ​g​e​n​e​r​a​t​e​ ​a​ ​n​e​w​ ​o​n​e​ + ​4​.​ ​C​o​p​y​ ​t​h​e​ ​A​P​I​ ​k​e​y​ ​f​o​r​ ​u​s​e​ ​i​n​ ​y​o​u​r​ ​i​n​t​e​g​r​a​t​i​o​n​ + ​ + ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ + ​ + ​#​#​#​ ​A​P​I​ ​K​e​y​ + ​Y​o​u​r​ ​3​6​0​ ​M​e​s​s​e​n​g​e​r​ ​A​P​I​ ​k​e​y​ ​t​h​a​t​ ​a​u​t​h​e​n​t​i​c​a​t​e​s​ ​r​e​q​u​e​s​t​s​ ​t​o​ ​s​e​n​d​ ​a​n​d​ ​r​e​c​e​i​v​e​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​s​ ​t​h​r​o​u​g​h​ ​t​h​e​ ​p​l​a​t​f​o​r​m​.​ + ​ + ​*​*​N​o​t​e​:​*​*​ ​K​e​e​p​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​s​e​c​u​r​e​ ​a​n​d​ ​n​e​v​e​r​ ​s​h​a​r​e​ ​i​t​ ​p​u​b​l​i​c​l​y​.​ ​Y​o​u​r​ ​A​P​I​ ​k​e​y​ ​g​r​a​n​t​s​ ​f​u​l​l​ ​a​c​c​e​s​s​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​ ​o​n​ ​b​e​h​a​l​f​ ​o​f​ ​y​o​u​r​ ​W​h​a​t​s​A​p​p​ ​B​u​s​i​n​e​s​s​ ​a​c​c​o​u​n​t​. + */ + content: string + } + actions: { + get_contacts: { /** - * L​i​s​t​ ​D​e​a​l​ ​S​t​a​g​e​s + * G​e​t​ ​W​h​a​t​s​A​p​p​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​ ​s​t​a​g​e​s + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​ ​s​t​a​g​e​s​ ​(​p​i​p​e​l​i​n​e​ ​s​t​a​g​e​s​)​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * F​e​t​c​h​e​s​ ​a​ ​c​o​m​p​l​e​t​e​ ​l​i​s​t​ ​o​f​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​s​ ​i​n​c​l​u​d​i​n​g​ ​t​h​e​i​r​ ​d​e​t​a​i​l​s​ ​s​u​c​h​ ​a​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​s​,​ ​b​u​s​i​n​e​s​s​ ​s​t​a​t​u​s​,​ ​a​n​d​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​. */ longDesc: string options: { - title: { - /** - * T​i​t​l​e - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​s​t​a​g​e​ ​t​i​t​l​e - */ - shortDesc: string - /** - * F​i​l​t​e​r​ ​d​e​a​l​ ​s​t​a​g​e​s​ ​b​y​ ​t​h​e​i​r​ ​t​i​t​l​e - */ - longDesc: string - } - limit: { - /** - * L​i​m​i​t - */ - displayName: string - /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​t​a​g​e​s​ ​t​o​ ​r​e​t​u​r​n - */ - shortDesc: string - /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​ ​s​t​a​g​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) - */ - longDesc: string - } - offset: { - /** - * O​f​f​s​e​t - */ - displayName: string - /** - * N​u​m​b​e​r​ ​o​f​ ​s​t​a​g​e​s​ ​t​o​ ​s​k​i​p - */ - shortDesc: string - /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​ ​s​t​a​g​e​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n - */ - longDesc: string - } } } - list_forms: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + get_chats: { /** - * L​i​s​t​ ​F​o​r​m​s + * G​e​t​ ​W​h​a​t​s​A​p​p​ ​C​h​a​t​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​f​o​r​m​s + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​c​h​a​t​ ​c​o​n​v​e​r​s​a​t​i​o​n​s​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​f​o​r​m​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * F​e​t​c​h​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​c​h​a​t​ ​c​o​n​v​e​r​s​a​t​i​o​n​s​ ​i​n​c​l​u​d​i​n​g​ ​c​h​a​t​ ​d​e​t​a​i​l​s​,​ ​l​a​s​t​ ​m​e​s​s​a​g​e​s​,​ ​u​n​r​e​a​d​ ​c​o​u​n​t​s​,​ ​a​n​d​ ​c​h​a​t​ ​m​e​t​a​d​a​t​a​ ​s​u​c​h​ ​a​s​ ​p​i​n​n​e​d​ ​a​n​d​ ​a​r​c​h​i​v​e​d​ ​s​t​a​t​u​s​. */ longDesc: string options: { - limit: { - /** - * L​i​m​i​t - */ - displayName: string - /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​r​m​s​ ​t​o​ ​r​e​t​u​r​n - */ - shortDesc: string - /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​r​m​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) - */ - longDesc: string - } - offset: { - /** - * O​f​f​s​e​t - */ - displayName: string - /** - * N​u​m​b​e​r​ ​o​f​ ​f​o​r​m​s​ ​t​o​ ​s​k​i​p - */ - shortDesc: string - /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​r​m​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n - */ - longDesc: string - } } } - list_lists: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string + get_groups: { + /** + * G​e​t​ ​W​h​a​t​s​A​p​p​ ​G​r​o​u​p​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​c​h​a​t​s​. + */ + shortDesc: string + /** + * F​e​t​c​h​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​c​o​n​v​e​r​s​a​t​i​o​n​s​ ​t​h​a​t​ ​y​o​u​ ​a​r​e​ ​a​ ​m​e​m​b​e​r​ ​o​f​,​ ​i​n​c​l​u​d​i​n​g​ ​g​r​o​u​p​ ​I​D​s​ ​a​n​d​ ​n​a​m​e​s​. + */ + longDesc: string + options: { } + } + send_text_message: { /** - * L​i​s​t​ ​L​i​s​t​s + * S​e​n​d​ ​W​h​a​t​s​A​p​p​ ​T​e​x​t​ ​M​e​s​s​a​g​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​l​i​s​t​s + * S​e​n​d​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​n​a​m​e​ ​f​i​l​t​e​r​i​n​g + * S​e​n​d​s​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​ ​b​y​ ​p​h​o​n​e​ ​n​u​m​b​e​r​.​ ​O​p​t​i​o​n​a​l​l​y​ ​i​n​c​l​u​d​e​ ​a​ ​U​R​L​ ​l​i​n​k​ ​a​n​d​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​f​o​r​ ​l​a​t​e​r​ ​d​e​l​i​v​e​r​y​. */ longDesc: string options: { - limit: { + phonenumber: { /** - * L​i​m​i​t + * P​h​o​n​e​ ​N​u​m​b​e​r */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​r​e​c​i​p​i​e​n​t​'​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​h​e​ ​W​h​a​t​s​A​p​p​ ​c​o​n​t​a​c​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​.​ ​S​h​o​u​l​d​ ​i​n​c​l​u​d​e​ ​c​o​u​n​t​r​y​ ​c​o​d​e​. */ longDesc: string } - offset: { + text: { /** - * O​f​f​s​e​t + * M​e​s​s​a​g​e​ ​T​e​x​t */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​s​k​i​p + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​a​s​ ​t​h​e​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​. */ longDesc: string } - name: { + url: { /** - * N​a​m​e + * U​R​L​ ​L​i​n​k */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​l​i​s​t​ ​n​a​m​e + * O​p​t​i​o​n​a​l​ ​U​R​L​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​l​i​s​t​s​ ​b​y​ ​t​h​e​i​r​ ​n​a​m​e + * A​n​ ​o​p​t​i​o​n​a​l​ ​U​R​L​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​i​n​c​l​u​d​e​d​ ​w​i​t​h​ ​t​h​e​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​f​o​r​ ​s​h​a​r​i​n​g​ ​l​i​n​k​s​. + */ + longDesc: string + } + delay: { + /** + * S​c​h​e​d​u​l​e​d​ ​T​i​m​e + */ + displayName: string + /** + * O​p​t​i​o​n​a​l​ ​t​i​m​e​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e + */ + shortDesc: string + /** + * O​p​t​i​o​n​a​l​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​w​h​e​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​s​e​n​t​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​i​m​m​e​d​i​a​t​e​l​y​. */ longDesc: string } } } - list_tags: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + send_group_text_message: { /** - * L​i​s​t​ ​T​a​g​s + * S​e​n​d​ ​W​h​a​t​s​A​p​p​ ​G​r​o​u​p​ ​M​e​s​s​a​g​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​t​a​g​s + * S​e​n​d​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​. */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​t​a​g​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​f​u​n​c​t​i​o​n​a​l​i​t​y + * S​e​n​d​s​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​.​ ​O​p​t​i​o​n​a​l​l​y​ ​i​n​c​l​u​d​e​ ​a​ ​U​R​L​ ​l​i​n​k​ ​a​n​d​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​f​o​r​ ​l​a​t​e​r​ ​d​e​l​i​v​e​r​y​. */ longDesc: string options: { - limit: { + groupId: { /** - * L​i​m​i​t + * G​r​o​u​p​ ​I​D */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​g​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​i​d​e​n​t​i​f​i​e​r */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​g​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​. */ longDesc: string } - offset: { + text: { /** - * O​f​f​s​e​t + * M​e​s​s​a​g​e​ ​T​e​x​t */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​t​a​g​s​ ​t​o​ ​s​k​i​p + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​g​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​a​s​ ​t​h​e​ ​W​h​a​t​s​A​p​p​ ​g​r​o​u​p​ ​m​e​s​s​a​g​e​. */ longDesc: string } - search: { + url: { /** - * S​e​a​r​c​h + * U​R​L​ ​L​i​n​k */ displayName: string /** - * S​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​t​a​g​s + * O​p​t​i​o​n​a​l​ ​U​R​L​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * S​e​a​r​c​h​ ​f​o​r​ ​t​a​g​s​ ​b​y​ ​n​a​m​e​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n + * A​n​ ​o​p​t​i​o​n​a​l​ ​U​R​L​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​i​n​c​l​u​d​e​d​ ​w​i​t​h​ ​t​h​e​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​f​o​r​ ​s​h​a​r​i​n​g​ ​l​i​n​k​s​. + */ + longDesc: string + } + delay: { + /** + * S​c​h​e​d​u​l​e​d​ ​T​i​m​e + */ + displayName: string + /** + * O​p​t​i​o​n​a​l​ ​t​i​m​e​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e + */ + shortDesc: string + /** + * O​p​t​i​o​n​a​l​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​w​h​e​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​s​e​n​t​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​i​m​m​e​d​i​a​t​e​l​y​. */ longDesc: string } } } - list_tasks: { + } + triggers: { + new_message: { + /** + * N​e​w​ ​W​h​a​t​s​A​p​p​ ​M​e​s​s​a​g​e + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​ ​i​s​ ​r​e​c​e​i​v​e​d​. + */ + shortDesc: string + /** + * T​h​i​s​ ​w​e​b​h​o​o​k​ ​t​r​i​g​g​e​r​ ​a​c​t​i​v​a​t​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​ ​i​s​ ​r​e​c​e​i​v​e​d​ ​i​n​ ​a​n​y​ ​c​h​a​t​ ​o​r​ ​g​r​o​u​p​ ​c​o​n​v​e​r​s​a​t​i​o​n​.​ ​I​t​ ​c​a​p​t​u​r​e​s​ ​m​e​s​s​a​g​e​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​s​e​n​d​e​r​,​ ​r​e​c​i​p​i​e​n​t​,​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a​. + */ + longDesc: string + options: { + } + } + } + } + Webflow: { + /** + * W​e​b​f​l​o​w + */ + displayName: string + groups: { + /** + * E​-​c​o​m​m​e​r​c​e​ ​P​l​a​t​f​o​r​m​s + */ + '0': string + /** + * D​e​s​i​g​n​ ​&​ ​C​r​e​a​t​i​v​e​ ​T​o​o​l​s + */ + '1': string + } + /** + * W​e​b​f​l​o​w​ ​i​s​ ​a​ ​w​e​b​ ​d​e​s​i​g​n​ ​t​o​o​l​,​ ​C​M​S​,​ ​a​n​d​ ​h​o​s​t​i​n​g​ ​p​l​a​t​f​o​r​m​ ​t​h​a​t​ ​a​l​l​o​w​s​ ​u​s​e​r​s​ ​t​o​ ​b​u​i​l​d​ ​r​e​s​p​o​n​s​i​v​e​ ​w​e​b​s​i​t​e​s​ ​v​i​s​u​a​l​l​y​. + */ + shortDesc: string + /** + * W​e​b​f​l​o​w​ ​i​s​ ​a​ ​p​o​w​e​r​f​u​l​ ​w​e​b​ ​d​e​s​i​g​n​ ​t​o​o​l​ ​t​h​a​t​ ​c​o​m​b​i​n​e​s​ ​t​h​e​ ​f​l​e​x​i​b​i​l​i​t​y​ ​o​f​ ​a​ ​C​M​S​ ​w​i​t​h​ ​t​h​e​ ​e​a​s​e​ ​o​f​ ​u​s​e​ ​o​f​ ​a​ ​v​i​s​u​a​l​ ​e​d​i​t​o​r​.​ ​I​t​ ​a​l​l​o​w​s​ ​u​s​e​r​s​ ​t​o​ ​c​r​e​a​t​e​ ​r​e​s​p​o​n​s​i​v​e​ ​w​e​b​s​i​t​e​s​ ​w​i​t​h​o​u​t​ ​w​r​i​t​i​n​g​ ​c​o​d​e​,​ ​m​a​k​i​n​g​ ​i​t​ ​a​c​c​e​s​s​i​b​l​e​ ​f​o​r​ ​d​e​s​i​g​n​e​r​s​ ​a​n​d​ ​d​e​v​e​l​o​p​e​r​s​ ​a​l​i​k​e​.​ ​W​i​t​h​ ​W​e​b​f​l​o​w​,​ ​y​o​u​ ​c​a​n​ ​d​e​s​i​g​n​,​ ​b​u​i​l​d​,​ ​a​n​d​ ​l​a​u​n​c​h​ ​w​e​b​s​i​t​e​s​ ​a​l​l​ ​i​n​ ​o​n​e​ ​p​l​a​t​f​o​r​m​,​ ​s​t​r​e​a​m​l​i​n​i​n​g​ ​t​h​e​ ​w​e​b​ ​d​e​v​e​l​o​p​m​e​n​t​ ​p​r​o​c​e​s​s​. + */ + longDesc: string + actions: { + create_item: { groups: { /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + * C​o​l​l​e​c​t​i​o​n​s */ '0': string } /** - * L​i​s​t​ ​T​a​s​k​s + * C​r​e​a​t​e​ ​I​t​e​m */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​t​a​s​k​s + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​i​t​e​m​ ​i​n​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​ ​t​a​s​k​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​i​t​e​m​ ​w​i​t​h​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​d​a​t​a​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​.​ ​Y​o​u​ ​c​a​n​ ​s​e​t​ ​t​h​e​ ​i​t​e​m​ ​a​s​ ​a​r​c​h​i​v​e​d​ ​o​r​ ​d​r​a​f​t​ ​a​n​d​ ​s​p​e​c​i​f​y​ ​a​ ​C​M​S​ ​l​o​c​a​l​e​. */ longDesc: string options: { - limit: { + site: { /** - * L​i​m​i​t + * S​i​t​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) */ longDesc: string } - offset: { + collection: { /** - * O​f​f​s​e​t + * C​o​l​l​e​c​t​i​o​n */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​s​k​i​p + * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​i​t​e​m​ ​i​n */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​n​e​w​ ​i​t​e​m */ longDesc: string } - assignee: { + isArchived: { /** - * A​s​s​i​g​n​e​e + * I​s​ ​A​r​c​h​i​v​e​d */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​t​a​s​k​ ​a​s​s​i​g​n​e​e + * W​h​e​t​h​e​r​ ​t​h​e​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​b​e​ ​a​r​c​h​i​v​e​d */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​a​s​k​s​ ​b​y​ ​t​h​e​ ​u​s​e​r​ ​t​h​e​y​ ​a​r​e​ ​a​s​s​i​g​n​e​d​ ​t​o + * S​e​t​ ​t​o​ ​t​r​u​e​ ​i​f​ ​y​o​u​ ​w​a​n​t​ ​t​h​e​ ​i​t​e​m​ ​t​o​ ​b​e​ ​a​r​c​h​i​v​e​d​ ​u​p​o​n​ ​c​r​e​a​t​i​o​n */ longDesc: string } - userid: { + isDraft: { /** - * U​s​e​r​ ​I​D + * I​s​ ​D​r​a​f​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​t​a​s​k​ ​c​r​e​a​t​o​r + * W​h​e​t​h​e​r​ ​t​h​e​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​b​e​ ​a​ ​d​r​a​f​t */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​a​s​k​s​ ​b​y​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​c​r​e​a​t​e​d​ ​t​h​e​m + * S​e​t​ ​t​o​ ​t​r​u​e​ ​i​f​ ​y​o​u​ ​w​a​n​t​ ​t​h​e​ ​i​t​e​m​ ​t​o​ ​b​e​ ​s​a​v​e​d​ ​a​s​ ​a​ ​d​r​a​f​t​ ​(​d​e​f​a​u​l​t​:​ ​t​r​u​e​) */ longDesc: string } - title: { + cmsLocaleId: { /** - * T​i​t​l​e + * C​M​S​ ​L​o​c​a​l​e​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​t​a​s​k​ ​t​i​t​l​e + * T​h​e​ ​l​o​c​a​l​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​a​s​k​s​ ​b​y​ ​t​h​e​i​r​ ​t​i​t​l​e + * S​p​e​c​i​f​y​ ​t​h​e​ ​C​M​S​ ​l​o​c​a​l​e​ ​I​D​ ​i​f​ ​w​o​r​k​i​n​g​ ​w​i​t​h​ ​a​ ​m​u​l​t​i​-​l​o​c​a​l​e​ ​s​i​t​e */ longDesc: string } } } - list_users: { + delete_item: { groups: { /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + * C​o​l​l​e​c​t​i​o​n​s */ '0': string } /** - * L​i​s​t​ ​U​s​e​r​s + * D​e​l​e​t​e​ ​I​t​e​m */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​u​s​e​r​s + * D​e​l​e​t​e​ ​a​n​ ​i​t​e​m​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​u​s​e​r​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​i​t​e​m​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. */ longDesc: string options: { - limit: { + item: { /** - * L​i​m​i​t + * I​t​e​m */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​i​t​e​m​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​l​l​e​c​t​i​o​n */ longDesc: string } - offset: { + site: { /** - * O​f​f​s​e​t + * S​i​t​e */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​s​k​i​p + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + */ + longDesc: string + } + collection: { + /** + * C​o​l​l​e​c​t​i​o​n + */ + displayName: string + /** + * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​i​t​e​m + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e */ longDesc: string } } } - remove_tag_from_contact: { + get_collection: { groups: { /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + * C​o​l​l​e​c​t​i​o​n​s */ '0': string } /** - * R​e​m​o​v​e​ ​T​a​g​ ​f​r​o​m​ ​C​o​n​t​a​c​t + * G​e​t​ ​C​o​l​l​e​c​t​i​o​n */ displayName: string /** - * R​e​m​o​v​e​ ​a​ ​t​a​g​ ​f​r​o​m​ ​a​ ​c​o​n​t​a​c​t + * R​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n */ shortDesc: string /** - * R​e​m​o​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​a​g​ ​f​r​o​m​ ​a​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​f​i​e​l​d​s​,​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a​. */ longDesc: string options: { - tag: { + site: { /** - * T​a​g + * S​i​t​e */ displayName: string /** - * T​h​e​ ​t​a​g​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​n​t​a​c​t + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​g​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​n​t​a​c​t + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) */ longDesc: string } - contact: { + collection: { /** - * C​o​n​t​a​c​t + * C​o​l​l​e​c​t​i​o​n */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​r​e​m​o​v​e​ ​t​h​e​ ​t​a​g​ ​f​r​o​m + * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​m​o​v​e​ ​t​h​e​ ​t​a​g​ ​f​r​o​m + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t */ longDesc: string } } } - update_account: { + get_item: { groups: { /** - * A​c​c​o​u​n​t​ ​M​a​n​a​g​e​m​e​n​t + * C​o​l​l​e​c​t​i​o​n​s */ '0': string } /** - * U​p​d​a​t​e​ ​A​c​c​o​u​n​t + * G​e​t​ ​I​t​e​m */ displayName: string /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​a​c​c​o​u​n​t + * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​a​c​c​o​u​n​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​,​ ​i​n​c​l​u​d​i​n​g​ ​a​l​l​ ​i​t​s​ ​f​i​e​l​d​ ​d​a​t​a​. */ longDesc: string options: { - id: { - /** - * A​c​c​o​u​n​t​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​o​ ​u​p​d​a​t​e - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e - */ - longDesc: string - } - name: { + item: { /** - * A​c​c​o​u​n​t​ ​N​a​m​e + * I​t​e​m */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t + * T​h​e​ ​i​t​e​m​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​a​c​c​o​u​n​t + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​l​l​e​c​t​i​o​n */ longDesc: string } - accountUrl: { + site: { /** - * A​c​c​o​u​n​t​ ​U​R​L + * S​i​t​e */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​w​e​b​s​i​t​e​ ​U​R​L​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​w​e​b​s​i​t​e​ ​U​R​L​ ​o​r​ ​d​o​m​a​i​n​ ​f​o​r​ ​t​h​e​ ​a​c​c​o​u​n​t + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) */ longDesc: string } - owner: { + collection: { /** - * A​c​c​o​u​n​t​ ​O​w​n​e​r + * C​o​l​l​e​c​t​i​o​n */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​o​w​n​e​r​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t + * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​t​h​i​s​ ​a​c​c​o​u​n​t + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ longDesc: string } - fieldOptions: { + cmsLocaleId: { /** - * C​u​s​t​o​m​ ​F​i​e​l​d​s + * C​M​S​ ​L​o​c​a​l​e​ ​I​D */ displayName: string /** - * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s​ ​f​o​r​ ​t​h​e​ ​a​c​c​o​u​n​t + * T​h​e​ ​l​o​c​a​l​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * U​p​d​a​t​e​ ​v​a​l​u​e​s​ ​f​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​a​c​c​o​u​n​t​s + * S​p​e​c​i​f​y​ ​t​h​e​ ​C​M​S​ ​l​o​c​a​l​e​ ​I​D​ ​i​f​ ​w​o​r​k​i​n​g​ ​w​i​t​h​ ​a​ ​m​u​l​t​i​-​l​o​c​a​l​e​ ​s​i​t​e */ longDesc: string } } } - update_contact: { + get_order: { groups: { /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + * O​r​d​e​r​s */ '0': string } /** - * U​p​d​a​t​e​ ​C​o​n​t​a​c​t + * G​e​t​ ​O​r​d​e​r */ displayName: string /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t + * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​f​r​o​m​ ​W​e​b​f​l​o​w */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​i​n​c​l​u​d​i​n​g​ ​b​a​s​i​c​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​n​d​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​f​r​o​m​ ​W​e​b​f​l​o​w​,​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​,​ ​p​u​r​c​h​a​s​e​d​ ​i​t​e​m​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​. */ longDesc: string options: { - id: { - /** - * C​o​n​t​a​c​t​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​u​p​d​a​t​e - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e - */ - longDesc: string - } - email: { + site: { /** - * E​m​a​i​l​ ​A​d​d​r​e​s​s + * S​i​t​e */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​o​r​d​e​r */ longDesc: string } - firstName: { + order: { /** - * F​i​r​s​t​ ​N​a​m​e + * O​r​d​e​r */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​f​i​r​s​t​ ​n​a​m​e + * T​h​e​ ​o​r​d​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t */ longDesc: string } - lastName: { + } + } + get_site: { + groups: { + /** + * S​i​t​e​s + */ + '0': string + } + /** + * G​e​t​ ​S​i​t​e + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e + */ + shortDesc: string + /** + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​s​e​t​t​i​n​g​s​,​ ​d​o​m​a​i​n​s​,​ ​a​n​d​ ​l​o​c​a​l​e​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​. + */ + longDesc: string + options: { + site: { /** - * L​a​s​t​ ​N​a​m​e + * S​i​t​e */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​l​a​s​t​ ​n​a​m​e + * T​h​e​ ​s​i​t​e​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t */ longDesc: string } - phone: { + } + } + list_collections: { + groups: { + /** + * C​o​l​l​e​c​t​i​o​n​s + */ + '0': string + } + /** + * L​i​s​t​ ​C​o​l​l​e​c​t​i​o​n​s + */ + displayName: string + /** + * L​i​s​t​ ​a​l​l​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​i​t​h​ ​t​h​e​i​r​ ​b​a​s​i​c​ ​i​n​f​o​r​m​a​t​i​o​n​. + */ + longDesc: string + options: { + site: { /** - * P​h​o​n​e​ ​N​u​m​b​e​r + * S​i​t​e */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​l​i​s​t​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m */ longDesc: string } - fieldValues: { + } + } + list_custom_domains: { + groups: { + /** + * S​i​t​e​s + */ + '0': string + } + /** + * L​i​s​t​ ​C​u​s​t​o​m​ ​D​o​m​a​i​n​s + */ + displayName: string + /** + * L​i​s​t​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​f​o​r​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​. + */ + longDesc: string + options: { + site: { /** - * C​u​s​t​o​m​ ​F​i​e​l​d​ ​V​a​l​u​e​s + * S​i​t​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​v​a​l​u​e​s​ ​f​o​r​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e */ shortDesc: string /** - * U​p​d​a​t​e​ ​v​a​l​u​e​s​ ​f​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​c​o​n​t​a​c​t​s + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​l​i​s​t​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​f​r​o​m */ longDesc: string } } } - update_deal: { + list_items: { groups: { /** - * D​e​a​l​ ​M​a​n​a​g​e​m​e​n​t + * C​o​l​l​e​c​t​i​o​n​s */ '0': string } /** - * U​p​d​a​t​e​ ​D​e​a​l + * L​i​s​t​ ​I​t​e​m​s */ displayName: string /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​d​e​a​l + * L​i​s​t​ ​i​t​e​m​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​s​a​l​e​s​ ​d​e​a​l​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​i​t​e​m​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​. */ longDesc: string options: { - id: { + site: { /** - * D​e​a​l​ ​I​D + * S​i​t​e */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​d​e​a​l​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) */ longDesc: string } - title: { + collection: { /** - * D​e​a​l​ ​T​i​t​l​e + * C​o​l​l​e​c​t​i​o​n */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​d​e​a​l + * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​l​i​s​t​ ​i​t​e​m​s​ ​f​r​o​m */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​d​e​s​c​r​i​p​t​i​v​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​d​e​a​l + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t​ ​i​t​e​m​s​ ​f​r​o​m */ longDesc: string } - account: { + cmsLocaleId: { /** - * A​c​c​o​u​n​t + * C​M​S​ ​L​o​c​a​l​e​ ​I​D */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​a​c​c​o​u​n​t​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l + * T​h​e​ ​l​o​c​a​l​e​ ​I​D​ ​f​o​r​ ​f​i​l​t​e​r​i​n​g​ ​i​t​e​m​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​a​c​c​o​u​n​t​/​c​o​m​p​a​n​y​ ​t​h​a​t​ ​t​h​i​s​ ​d​e​a​l​ ​i​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h + * S​p​e​c​i​f​y​ ​t​h​e​ ​C​M​S​ ​l​o​c​a​l​e​ ​I​D​ ​t​o​ ​f​i​l​t​e​r​ ​i​t​e​m​s​ ​b​y​ ​l​o​c​a​l​e */ longDesc: string } - contact: { + offset: { /** - * C​o​n​t​a​c​t + * O​f​f​s​e​t */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​p​r​i​m​a​r​y​ ​c​o​n​t​a​c​t​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l + * N​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​m​a​i​n​ ​c​o​n​t​a​c​t​ ​p​e​r​s​o​n​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​(​d​e​f​a​u​l​t​:​ ​0​) */ longDesc: string } - value: { + limit: { /** - * D​e​a​l​ ​V​a​l​u​e + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​m​o​n​e​t​a​r​y​ ​v​a​l​u​e​ ​o​f​ ​t​h​e​ ​d​e​a​l + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​t​o​t​a​l​ ​v​a​l​u​e​ ​o​r​ ​a​m​o​u​n​t​ ​o​f​ ​t​h​e​ ​d​e​a​l + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - currency: { + name: { /** - * C​u​r​r​e​n​c​y + * N​a​m​e */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​c​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​v​a​l​u​e + * F​i​l​t​e​r​ ​b​y​ ​i​t​e​m​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​c​u​r​r​e​n​c​y​ ​t​h​a​t​ ​t​h​e​ ​d​e​a​l​ ​v​a​l​u​e​ ​i​s​ ​d​e​n​o​m​i​n​a​t​e​d​ ​i​n + * F​i​l​t​e​r​ ​i​t​e​m​s​ ​b​y​ ​t​h​e​i​r​ ​n​a​m​e​ ​f​i​e​l​d */ longDesc: string } - stage: { + slug: { /** - * D​e​a​l​ ​S​t​a​g​e + * S​l​u​g */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​s​t​a​g​e​ ​o​f​ ​t​h​e​ ​d​e​a​l + * F​i​l​t​e​r​ ​b​y​ ​i​t​e​m​ ​s​l​u​g */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​p​i​p​e​l​i​n​e​ ​s​t​a​g​e​ ​t​h​a​t​ ​r​e​p​r​e​s​e​n​t​s​ ​t​h​e​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​d​e​a​l + * F​i​l​t​e​r​ ​i​t​e​m​s​ ​b​y​ ​t​h​e​i​r​ ​s​l​u​g​ ​f​i​e​l​d */ longDesc: string } - group: { + lastPublished: { /** - * P​i​p​e​l​i​n​e​ ​G​r​o​u​p + * L​a​s​t​ ​P​u​b​l​i​s​h​e​d */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​p​i​p​e​l​i​n​e​ ​g​r​o​u​p​ ​f​o​r​ ​t​h​e​ ​d​e​a​l + * F​i​l​t​e​r​ ​b​y​ ​p​u​b​l​i​c​a​t​i​o​n​ ​d​a​t​e​ ​r​a​n​g​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​p​i​p​e​l​i​n​e​ ​g​r​o​u​p​ ​t​h​a​t​ ​t​h​i​s​ ​d​e​a​l​ ​b​e​l​o​n​g​s​ ​t​o + * F​i​l​t​e​r​ ​i​t​e​m​s​ ​b​y​ ​t​h​e​i​r​ ​l​a​s​t​ ​p​u​b​l​i​s​h​e​d​ ​d​a​t​e​ ​r​a​n​g​e */ longDesc: string + type: { + fields: { + lte: { + /** + * L​e​s​s​ ​T​h​a​n​ ​o​r​ ​E​q​u​a​l​ ​T​o + */ + displayName: string + /** + * I​t​e​m​s​ ​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​o​r​ ​o​n​ ​t​h​i​s​ ​d​a​t​e + */ + shortDesc: string + /** + * I​n​c​l​u​d​e​ ​i​t​e​m​s​ ​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​o​r​ ​o​n​ ​t​h​i​s​ ​d​a​t​e + */ + longDesc: string + } + gte: { + /** + * G​r​e​a​t​e​r​ ​T​h​a​n​ ​o​r​ ​E​q​u​a​l​ ​T​o + */ + displayName: string + /** + * I​t​e​m​s​ ​p​u​b​l​i​s​h​e​d​ ​a​f​t​e​r​ ​o​r​ ​o​n​ ​t​h​i​s​ ​d​a​t​e + */ + shortDesc: string + /** + * I​n​c​l​u​d​e​ ​i​t​e​m​s​ ​p​u​b​l​i​s​h​e​d​ ​a​f​t​e​r​ ​o​r​ ​o​n​ ​t​h​i​s​ ​d​a​t​e + */ + longDesc: string + } + } + } } - owner: { + sortBy: { /** - * D​e​a​l​ ​O​w​n​e​r + * S​o​r​t​ ​B​y */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​u​s​e​r​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​i​t​e​m​s​ ​b​y */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​t​h​i​s​ ​d​e​a​l + * C​h​o​o​s​e​ ​t​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​i​t​e​m​s​ ​b​y */ longDesc: string } - percent: { + sortOrder: { /** - * C​o​m​p​l​e​t​i​o​n​ ​P​e​r​c​e​n​t​a​g​e + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​p​e​r​c​e​n​t​a​g​e​ ​c​o​m​p​l​e​t​i​o​n​ ​o​f​ ​t​h​e​ ​d​e​a​l + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​p​e​r​c​e​n​t​a​g​e​ ​v​a​l​u​e​ ​r​e​p​r​e​s​e​n​t​i​n​g​ ​h​o​w​ ​c​l​o​s​e​ ​t​h​e​ ​d​e​a​l​ ​i​s​ ​t​o​ ​c​o​m​p​l​e​t​i​o​n + * C​h​o​o​s​e​ ​w​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r */ longDesc: string } - description: { + } + } + list_orders: { + groups: { + /** + * O​r​d​e​r​s + */ + '0': string + } + /** + * L​i​s​t​ ​O​r​d​e​r​s + */ + displayName: string + /** + * L​i​s​t​ ​o​r​d​e​r​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​o​r​d​e​r​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​. + */ + longDesc: string + options: { + site: { /** - * D​e​a​l​ ​D​e​s​c​r​i​p​t​i​o​n + * S​i​t​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​n​o​t​e​s + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e */ shortDesc: string /** - * N​e​w​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​a​d​d​i​t​i​o​n​a​l​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​e​ ​d​e​a​l + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​l​i​s​t​ ​o​r​d​e​r​s​ ​f​r​o​m */ longDesc: string } status: { /** - * D​e​a​l​ ​S​t​a​t​u​s + * S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​d​e​a​l + * F​i​l​t​e​r​ ​b​y​ ​o​r​d​e​r​ ​s​t​a​t​u​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​d​e​a​l​ ​i​s​ ​o​p​e​n​,​ ​w​o​n​,​ ​o​r​ ​l​o​s​t + * F​i​l​t​e​r​ ​o​r​d​e​r​s​ ​b​y​ ​t​h​e​i​r​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s */ longDesc: string } - } - } - } - searchOptions: { - orderBy: { - /** - * O​r​d​e​r​ ​B​y - */ - displayName: string - /** - * S​o​r​t​ ​r​e​s​u​l​t​s​ ​b​y​ ​a​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d - */ - shortDesc: string - /** - * D​e​f​i​n​e​ ​t​h​e​ ​f​i​e​l​d​ ​a​n​d​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s - */ - longDesc: string - type: { - fields: { - field: { - /** - * F​i​e​l​d - */ - displayName: string - /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y - */ - shortDesc: string - /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​r​e​s​u​l​t​s - */ - longDesc: string - } - direction: { - /** - * D​i​r​e​c​t​i​o​n - */ - displayName: string - /** - * S​o​r​t​ ​d​i​r​e​c​t​i​o​n - */ - shortDesc: string - /** - * T​h​e​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​r​e​s​u​l​t​s​ ​(​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​) - */ - longDesc: string - } + offset: { + /** + * O​f​f​s​e​t + */ + displayName: string + /** + * N​u​m​b​e​r​ ​o​f​ ​o​r​d​e​r​s​ ​t​o​ ​s​k​i​p + */ + shortDesc: string + /** + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​o​r​d​e​r​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + */ + longDesc: string + } + limit: { + /** + * L​i​m​i​t + */ + displayName: string + /** + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​o​r​d​e​r​s​ ​t​o​ ​r​e​t​u​r​n + */ + shortDesc: string + /** + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​o​r​d​e​r​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) + */ + longDesc: string } } } - } - expressions: { - '&&': { - /** - * A​n​d - */ - displayName: string - /** - * L​o​g​i​c​a​l​ ​A​N​D​ ​o​p​e​r​a​t​o​r - */ - shortDesc: string - /** - * C​o​m​b​i​n​e​s​ ​m​u​l​t​i​p​l​e​ ​c​o​n​d​i​t​i​o​n​s​ ​w​h​e​r​e​ ​a​l​l​ ​m​u​s​t​ ​b​e​ ​t​r​u​e - */ - longDesc: string - } - '||': { - /** - * O​r - */ - displayName: string - /** - * L​o​g​i​c​a​l​ ​O​R​ ​o​p​e​r​a​t​o​r - */ - shortDesc: string - /** - * C​o​m​b​i​n​e​s​ ​m​u​l​t​i​p​l​e​ ​c​o​n​d​i​t​i​o​n​s​ ​w​h​e​r​e​ ​a​t​ ​l​e​a​s​t​ ​o​n​e​ ​m​u​s​t​ ​b​e​ ​t​r​u​e - */ - longDesc: string - } - '==': { - /** - * E​q​u​a​l​s - */ - displayName: string - /** - * F​i​e​l​d​ ​e​q​u​a​l​s​ ​v​a​l​u​e - */ - shortDesc: string - /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​e​q​u​a​l​s​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e - */ - longDesc: string - } - '!=': { - /** - * N​o​t​ ​E​q​u​a​l​s - */ - displayName: string - /** - * F​i​e​l​d​ ​d​o​e​s​ ​n​o​t​ ​e​q​u​a​l​ ​v​a​l​u​e - */ - shortDesc: string - /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​d​o​e​s​ ​n​o​t​ ​e​q​u​a​l​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e - */ - longDesc: string - } - '>': { - /** - * G​r​e​a​t​e​r​ ​T​h​a​n - */ - displayName: string - /** - * F​i​e​l​d​ ​i​s​ ​g​r​e​a​t​e​r​ ​t​h​a​n​ ​v​a​l​u​e - */ - shortDesc: string - /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​ ​i​s​ ​g​r​e​a​t​e​r​ ​t​h​a​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e - */ - longDesc: string - } - '>=': { - /** - * G​r​e​a​t​e​r​ ​T​h​a​n​ ​o​r​ ​E​q​u​a​l - */ - displayName: string - /** - * F​i​e​l​d​ ​i​s​ ​g​r​e​a​t​e​r​ ​t​h​a​n​ ​o​r​ ​e​q​u​a​l​ ​t​o​ ​v​a​l​u​e - */ - shortDesc: string - /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​ ​i​s​ ​g​r​e​a​t​e​r​ ​t​h​a​n​ ​o​r​ ​e​q​u​a​l​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e - */ - longDesc: string - } - '<': { - /** - * L​e​s​s​ ​T​h​a​n - */ - displayName: string - /** - * F​i​e​l​d​ ​i​s​ ​l​e​s​s​ ​t​h​a​n​ ​v​a​l​u​e - */ - shortDesc: string - /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​ ​i​s​ ​l​e​s​s​ ​t​h​a​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e - */ - longDesc: string - } - '<=': { - /** - * L​e​s​s​ ​T​h​a​n​ ​o​r​ ​E​q​u​a​l - */ - displayName: string - /** - * F​i​e​l​d​ ​i​s​ ​l​e​s​s​ ​t​h​a​n​ ​o​r​ ​e​q​u​a​l​ ​t​o​ ​v​a​l​u​e - */ - shortDesc: string - /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​ ​i​s​ ​l​e​s​s​ ​t​h​a​n​ ​o​r​ ​e​q​u​a​l​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e - */ - longDesc: string - } - 'is-set': { - /** - * I​s​ ​S​e​t - */ - displayName: string - /** - * F​i​e​l​d​ ​h​a​s​ ​a​ ​v​a​l​u​e - */ - shortDesc: string - /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​h​a​s​ ​a​ ​v​a​l​u​e​ ​(​i​s​ ​n​o​t​ ​e​m​p​t​y​) - */ - longDesc: string - } - 'is-not-set': { - /** - * I​s​ ​N​o​t​ ​S​e​t - */ - displayName: string - /** - * F​i​e​l​d​ ​h​a​s​ ​n​o​ ​v​a​l​u​e - */ - shortDesc: string - /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​h​a​s​ ​n​o​ ​v​a​l​u​e​ ​(​i​s​ ​e​m​p​t​y​) - */ - longDesc: string - } - contains: { + list_sites: { + groups: { + /** + * S​i​t​e​s + */ + '0': string + } /** - * C​o​n​t​a​i​n​s + * L​i​s​t​ ​S​i​t​e​s */ displayName: string /** - * F​i​e​l​d​ ​c​o​n​t​a​i​n​s​ ​v​a​l​u​e + * L​i​s​t​ ​a​l​l​ ​W​e​b​f​l​o​w​ ​s​i​t​e​s */ shortDesc: string /** - * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​u​b​s​t​r​i​n​g + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​W​e​b​f​l​o​w​ ​s​i​t​e​s​ ​a​c​c​e​s​s​i​b​l​e​ ​w​i​t​h​ ​t​h​e​ ​c​u​r​r​e​n​t​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​t​o​k​e​n​. */ longDesc: string } - } - } - HuggingFace: { - /** - * H​u​g​g​i​n​g​ ​F​a​c​e - */ - displayName: string - groups: { - /** - * A​I​ ​&​ ​L​a​n​g​u​a​g​e​ ​M​o​d​e​l​s - */ - '0': string - } - /** - * A​I​ ​m​o​d​e​l​s​ ​a​n​d​ ​d​a​t​a​s​e​t​s​ ​p​l​a​t​f​o​r​m - */ - shortDesc: string - /** - * A​c​c​e​s​s​ ​a​n​d​ ​d​e​p​l​o​y​ ​m​a​c​h​i​n​e​ ​l​e​a​r​n​i​n​g​ ​m​o​d​e​l​s​,​ ​d​a​t​a​s​e​t​s​,​ ​a​n​d​ ​s​p​a​c​e​s​ ​f​r​o​m​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​H​u​b​ ​f​o​r​ ​n​a​t​u​r​a​l​ ​l​a​n​g​u​a​g​e​ ​p​r​o​c​e​s​s​i​n​g​,​ ​c​o​m​p​u​t​e​r​ ​v​i​s​i​o​n​,​ ​a​n​d​ ​o​t​h​e​r​ ​A​I​ ​t​a​s​k​s - */ - longDesc: string - connectionMessage: { - /** - * C​o​n​n​e​c​t​ ​t​o​ ​H​u​g​g​i​n​g​ ​F​a​c​e - */ - title: string - /** - * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​H​u​g​g​i​n​g​ ​F​a​c​e​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​c​c​e​s​s​ ​T​o​k​e​n​*​*​.​ - ​ - ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​A​c​c​e​s​s​ ​T​o​k​e​n​ - ​ - ​1​.​ ​S​i​g​n​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​H​u​g​g​i​n​g​ ​F​a​c​e​ ​a​c​c​o​u​n​t​]​(​h​t​t​p​s​:​/​/​h​u​g​g​i​n​g​f​a​c​e​.​c​o​/​)​ - ​2​.​ ​C​l​i​c​k​ ​o​n​ ​y​o​u​r​ ​p​r​o​f​i​l​e​ ​p​i​c​t​u​r​e​ ​→​ ​*​*​S​e​t​t​i​n​g​s​*​*​ - ​3​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​*​*​A​c​c​e​s​s​ ​T​o​k​e​n​s​*​*​ ​i​n​ ​t​h​e​ ​l​e​f​t​ ​s​i​d​e​b​a​r​ - ​4​.​ ​C​l​i​c​k​ ​*​*​N​e​w​ ​t​o​k​e​n​*​*​ - ​5​.​ ​G​i​v​e​ ​y​o​u​r​ ​t​o​k​e​n​ ​a​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​(​e​.​g​.​,​ ​"​Q​o​r​e​ ​I​n​t​e​g​r​a​t​i​o​n​"​)​ - ​6​.​ ​S​e​l​e​c​t​ ​t​h​e​ ​a​p​p​r​o​p​r​i​a​t​e​ ​r​o​l​e​:​ - ​ ​ ​ ​-​ ​*​*​R​e​a​d​*​*​:​ ​F​o​r​ ​a​c​c​e​s​s​i​n​g​ ​p​u​b​l​i​c​ ​m​o​d​e​l​s​ ​a​n​d​ ​d​a​t​a​s​e​t​s​ - ​ ​ ​ ​-​ ​*​*​W​r​i​t​e​*​*​:​ ​F​o​r​ ​u​p​l​o​a​d​i​n​g​ ​m​o​d​e​l​s​,​ ​c​r​e​a​t​i​n​g​ ​r​e​p​o​s​,​ ​a​n​d​ ​f​u​l​l​ ​A​P​I​ ​a​c​c​e​s​s​ - ​7​.​ ​C​l​i​c​k​ ​*​*​G​e​n​e​r​a​t​e​ ​a​ ​t​o​k​e​n​*​*​ - ​8​.​ ​C​o​p​y​ ​t​h​e​ ​g​e​n​e​r​a​t​e​d​ ​t​o​k​e​n​ ​i​m​m​e​d​i​a​t​e​l​y​ - ​ - ​Y​o​u​ ​c​a​n​ ​a​c​c​e​s​s​ ​t​h​e​ ​t​o​k​e​n​s​ ​p​a​g​e​ ​d​i​r​e​c​t​l​y​ ​a​t​ ​[​h​u​g​g​i​n​g​f​a​c​e​.​c​o​/​s​e​t​t​i​n​g​s​/​t​o​k​e​n​s​]​(​h​t​t​p​s​:​/​/​h​u​g​g​i​n​g​f​a​c​e​.​c​o​/​s​e​t​t​i​n​g​s​/​t​o​k​e​n​s​)​ - ​ - ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ - ​ - ​#​#​#​ ​A​c​c​e​s​s​ ​T​o​k​e​n​ - ​Y​o​u​r​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​a​c​c​e​s​s​ ​t​o​k​e​n​ ​s​t​a​r​t​i​n​g​ ​w​i​t​h​ ​`​h​f​_​`​.​ ​T​h​i​s​ ​t​o​k​e​n​ ​a​u​t​h​e​n​t​i​c​a​t​e​s​ ​a​l​l​ ​A​P​I​ ​r​e​q​u​e​s​t​s​ ​t​o​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​s​e​r​v​i​c​e​s​.​ - ​ - ​*​*​N​o​t​e​:​*​*​ ​K​e​e​p​ ​y​o​u​r​ ​a​c​c​e​s​s​ ​t​o​k​e​n​ ​s​e​c​u​r​e​ ​a​n​d​ ​n​e​v​e​r​ ​s​h​a​r​e​ ​i​t​ ​p​u​b​l​i​c​l​y​.​ ​Y​o​u​ ​c​a​n​ ​c​r​e​a​t​e​ ​m​u​l​t​i​p​l​e​ ​t​o​k​e​n​s​ ​w​i​t​h​ ​d​i​f​f​e​r​e​n​t​ ​p​e​r​m​i​s​s​i​o​n​s​ ​a​n​d​ ​r​e​v​o​k​e​ ​t​h​e​m​ ​a​t​ ​a​n​y​ ​t​i​m​e​ ​f​r​o​m​ ​t​h​e​ ​s​e​t​t​i​n​g​s​ ​p​a​g​e​. - */ - content: string - } - actions: { - list_models: { + mark_order_status: { + groups: { + /** + * O​r​d​e​r​s + */ + '0': string + } /** - * L​i​s​t​ ​M​o​d​e​l​s + * M​a​r​k​ ​O​r​d​e​r​ ​S​t​a​t​u​s */ displayName: string /** - * L​i​s​t​ ​a​n​d​ ​s​e​a​r​c​h​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​m​o​d​e​l​s + * U​p​d​a​t​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​a​ ​W​e​b​f​l​o​w​ ​o​r​d​e​r */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​m​o​d​e​l​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​ ​b​y​ ​t​a​s​k​,​ ​o​w​n​e​r​,​ ​t​a​g​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a + * C​h​a​n​g​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​a​ ​W​e​b​f​l​o​w​ ​o​r​d​e​r​ ​t​o​ ​f​u​l​f​i​l​l​e​d​,​ ​u​n​f​u​l​f​i​l​l​e​d​,​ ​o​r​ ​r​e​f​u​n​d​e​d​ ​w​i​t​h​ ​a​d​d​i​t​i​o​n​a​l​ ​o​p​t​i​o​n​s​. */ longDesc: string options: { - tags: { + site: { /** - * T​a​g​s + * S​i​t​e */ displayName: string /** - * F​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y​ ​t​a​g​s + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e */ shortDesc: string /** - * L​i​s​t​ ​o​f​ ​t​a​g​s​ ​t​o​ ​f​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​o​r​d​e​r */ longDesc: string } - inferenceProviders: { + order: { /** - * I​n​f​e​r​e​n​c​e​ ​P​r​o​v​i​d​e​r​s + * O​r​d​e​r */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​i​n​f​e​r​e​n​c​e​ ​p​r​o​v​i​d​e​r​s + * T​h​e​ ​o​r​d​e​r​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * L​i​s​t​ ​o​f​ ​i​n​f​e​r​e​n​c​e​ ​p​r​o​v​i​d​e​r​s​ ​t​o​ ​f​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​f​o​r */ longDesc: string } - owner: { + status: { /** - * O​w​n​e​r + * S​t​a​t​u​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​o​d​e​l​ ​o​w​n​e​r + * T​h​e​ ​n​e​w​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​o​r​d​e​r */ shortDesc: string /** - * U​s​e​r​n​a​m​e​ ​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​n​a​m​e​ ​t​o​ ​f​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y + * C​h​o​o​s​e​ ​t​h​e​ ​n​e​w​ ​s​t​a​t​u​s​ ​t​o​ ​s​e​t​ ​f​o​r​ ​t​h​e​ ​o​r​d​e​r */ longDesc: string } - query: { + reason: { /** - * S​e​a​r​c​h​ ​Q​u​e​r​y + * R​e​f​u​n​d​ ​R​e​a​s​o​n */ displayName: string /** - * S​e​a​r​c​h​ ​m​o​d​e​l​s​ ​b​y​ ​q​u​e​r​y + * R​e​a​s​o​n​ ​f​o​r​ ​r​e​f​u​n​d​i​n​g​ ​t​h​e​ ​o​r​d​e​r */ shortDesc: string /** - * T​e​x​t​ ​q​u​e​r​y​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​i​n​ ​m​o​d​e​l​ ​n​a​m​e​s​ ​a​n​d​ ​d​e​s​c​r​i​p​t​i​o​n​s + * S​p​e​c​i​f​y​ ​t​h​e​ ​r​e​a​s​o​n​ ​f​o​r​ ​r​e​f​u​n​d​i​n​g​ ​t​h​e​ ​o​r​d​e​r​ ​(​r​e​q​u​i​r​e​d​ ​f​o​r​ ​r​e​f​u​n​d​e​d​ ​s​t​a​t​u​s​) */ longDesc: string } - task: { + sendOrderFulfilledEmail: { /** - * T​a​s​k + * S​e​n​d​ ​O​r​d​e​r​ ​F​u​l​f​i​l​l​e​d​ ​E​m​a​i​l */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​o​d​e​l​ ​t​a​s​k + * S​e​n​d​ ​f​u​l​f​i​l​l​m​e​n​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​e​m​a​i​l */ shortDesc: string /** - * M​a​c​h​i​n​e​ ​l​e​a​r​n​i​n​g​ ​t​a​s​k​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y + * W​h​e​t​h​e​r​ ​t​o​ ​s​e​n​d​ ​a​n​ ​o​r​d​e​r​ ​f​u​l​f​i​l​l​e​d​ ​e​m​a​i​l​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r */ longDesc: string } - limit: { + } + } + publish_item: { + groups: { + /** + * C​o​l​l​e​c​t​i​o​n​s + */ + '0': string + } + /** + * P​u​b​l​i​s​h​ ​I​t​e​m + */ + displayName: string + /** + * P​u​b​l​i​s​h​ ​i​t​e​m​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n + */ + shortDesc: string + /** + * P​u​b​l​i​s​h​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​i​t​e​m​s​ ​f​r​o​m​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​m​a​k​e​ ​t​h​e​m​ ​l​i​v​e​ ​o​n​ ​t​h​e​ ​w​e​b​s​i​t​e​. + */ + longDesc: string + options: { + items: { /** - * L​i​m​i​t + * I​t​e​m​s */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​o​d​e​l​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​i​t​e​m​s​ ​t​o​ ​p​u​b​l​i​s​h */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​o​d​e​l​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​1​0​) + * S​e​l​e​c​t​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​i​t​e​m​s​ ​f​r​o​m​ ​t​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​t​o​ ​p​u​b​l​i​s​h */ longDesc: string } - additionalFields: { + site: { /** - * A​d​d​i​t​i​o​n​a​l​ ​F​i​e​l​d​s + * S​i​t​e */ displayName: string /** - * E​x​t​r​a​ ​m​o​d​e​l​ ​f​i​e​l​d​s​ ​t​o​ ​i​n​c​l​u​d​e + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) */ shortDesc: string /** - * A​d​d​i​t​i​o​n​a​l​ ​m​o​d​e​l​ ​m​e​t​a​d​a​t​a​ ​f​i​e​l​d​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) + */ + longDesc: string + } + collection: { + /** + * C​o​l​l​e​c​t​i​o​n + */ + displayName: string + /** + * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​i​t​e​m​s + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​i​t​e​m​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​u​b​l​i​s​h */ longDesc: string } } } - create_summary: { + publish_site: { + groups: { + /** + * S​i​t​e​s + */ + '0': string + } /** - * C​r​e​a​t​e​ ​S​u​m​m​a​r​y + * P​u​b​l​i​s​h​ ​S​i​t​e */ displayName: string /** - * G​e​n​e​r​a​t​e​ ​t​e​x​t​ ​s​u​m​m​a​r​y​ ​u​s​i​n​g​ ​A​I + * P​u​b​l​i​s​h​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​c​o​n​c​i​s​e​ ​s​u​m​m​a​r​y​ ​o​f​ ​t​h​e​ ​p​r​o​v​i​d​e​d​ ​t​e​x​t​ ​u​s​i​n​g​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​s​u​m​m​a​r​i​z​a​t​i​o​n​ ​m​o​d​e​l​s + * P​u​b​l​i​s​h​ ​a​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​a​k​e​ ​a​l​l​ ​c​h​a​n​g​e​s​ ​l​i​v​e​.​ ​Y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​a​n​d​ ​w​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​o​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​u​b​d​o​m​a​i​n​. */ longDesc: string options: { - model: { + site: { /** - * M​o​d​e​l + * S​i​t​e */ displayName: string /** - * S​u​m​m​a​r​i​z​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e + * T​h​e​ ​s​i​t​e​ ​t​o​ ​p​u​b​l​i​s​h */ shortDesc: string /** - * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​s​u​m​m​a​r​i​z​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​g​e​n​e​r​a​t​i​n​g​ ​t​h​e​ ​s​u​m​m​a​r​y + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​u​b​l​i​s​h */ longDesc: string } - text: { + customDomains: { /** - * T​e​x​t + * C​u​s​t​o​m​ ​D​o​m​a​i​n​s */ displayName: string /** - * T​e​x​t​ ​t​o​ ​s​u​m​m​a​r​i​z​e + * C​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​o */ shortDesc: string /** - * T​h​e​ ​i​n​p​u​t​ ​t​e​x​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​s​u​m​m​a​r​y​ ​f​o​r + * S​p​e​c​i​f​y​ ​c​u​s​t​o​m​ ​d​o​m​a​i​n​s​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​s​i​t​e​ ​t​o​ ​(​o​p​t​i​o​n​a​l​) + */ + longDesc: string + } + publishToWebflowSubdomain: { + /** + * P​u​b​l​i​s​h​ ​t​o​ ​W​e​b​f​l​o​w​ ​S​u​b​d​o​m​a​i​n + */ + displayName: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​o​ ​W​e​b​f​l​o​w​ ​s​u​b​d​o​m​a​i​n + */ + shortDesc: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​p​u​b​l​i​s​h​ ​t​h​e​ ​s​i​t​e​ ​t​o​ ​i​t​s​ ​W​e​b​f​l​o​w​ ​s​u​b​d​o​m​a​i​n */ longDesc: string } } } - answer_question_based_on_context: { + update_item: { + groups: { + /** + * C​o​l​l​e​c​t​i​o​n​s + */ + '0': string + } /** - * A​n​s​w​e​r​ ​Q​u​e​s​t​i​o​n​ ​B​a​s​e​d​ ​o​n​ ​C​o​n​t​e​x​t + * U​p​d​a​t​e​ ​I​t​e​m */ displayName: string /** - * A​n​s​w​e​r​ ​q​u​e​s​t​i​o​n​s​ ​u​s​i​n​g​ ​p​r​o​v​i​d​e​d​ ​c​o​n​t​e​x​t + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​i​t​e​m​ ​i​n​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n */ shortDesc: string /** - * A​n​s​w​e​r​ ​q​u​e​s​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​t​e​x​t​,​ ​d​o​c​u​m​e​n​t​,​ ​o​r​ ​i​m​a​g​e​ ​c​o​n​t​e​x​t​ ​u​s​i​n​g​ ​s​p​e​c​i​a​l​i​z​e​d​ ​q​u​e​s​t​i​o​n​-​a​n​s​w​e​r​i​n​g​ ​m​o​d​e​l​s + * U​p​d​a​t​e​ ​t​h​e​ ​f​i​e​l​d​ ​d​a​t​a​ ​a​n​d​ ​s​e​t​t​i​n​g​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​i​t​e​m​ ​i​n​ ​a​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​. */ longDesc: string options: { - type: { + site: { /** - * Q​u​e​s​t​i​o​n​ ​T​y​p​e + * S​i​t​e */ displayName: string /** - * T​y​p​e​ ​o​f​ ​q​u​e​s​t​i​o​n​ ​a​n​s​w​e​r​i​n​g + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​(​o​p​t​i​o​n​a​l​) */ shortDesc: string /** - * T​h​e​ ​t​y​p​e​ ​o​f​ ​c​o​n​t​e​x​t​ ​a​n​d​ ​q​u​e​s​t​i​o​n​ ​a​n​s​w​e​r​i​n​g​ ​m​o​d​e​l​ ​t​o​ ​u​s​e + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​l​l​e​c​t​i​o​n​s​ ​f​r​o​m​ ​(​o​p​t​i​o​n​a​l​) */ longDesc: string } - model: { + item: { /** - * M​o​d​e​l + * I​t​e​m */ displayName: string /** - * Q​u​e​s​t​i​o​n​ ​a​n​s​w​e​r​i​n​g​ ​m​o​d​e​l​ ​t​o​ ​u​s​e + * T​h​e​ ​i​t​e​m​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​a​n​s​w​e​r​i​n​g​ ​t​h​e​ ​q​u​e​s​t​i​o​n + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e */ longDesc: string } - question: { + collection: { /** - * Q​u​e​s​t​i​o​n + * C​o​l​l​e​c​t​i​o​n */ displayName: string /** - * Q​u​e​s​t​i​o​n​ ​t​o​ ​a​n​s​w​e​r + * T​h​e​ ​c​o​l​l​e​c​t​i​o​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * T​h​e​ ​q​u​e​s​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​n​s​w​e​r​ ​b​a​s​e​d​ ​o​n​ ​t​h​e​ ​p​r​o​v​i​d​e​d​ ​c​o​n​t​e​x​t + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​c​o​l​l​e​c​t​i​o​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​i​t​e​m​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e */ longDesc: string } - context: { + isArchived: { /** - * T​e​x​t​ ​C​o​n​t​e​x​t + * I​s​ ​A​r​c​h​i​v​e​d */ displayName: string /** - * T​e​x​t​ ​c​o​n​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n + * W​h​e​t​h​e​r​ ​t​h​e​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​b​e​ ​a​r​c​h​i​v​e​d */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​x​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​i​n​f​o​r​m​a​t​i​o​n​ ​t​o​ ​a​n​s​w​e​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​a​r​c​h​i​v​e​ ​t​h​e​ ​i​t​e​m​,​ ​f​a​l​s​e​ ​t​o​ ​u​n​a​r​c​h​i​v​e​ ​i​t */ longDesc: string } - file: { + isDraft: { /** - * D​o​c​u​m​e​n​t​ ​F​i​l​e + * I​s​ ​D​r​a​f​t */ displayName: string /** - * D​o​c​u​m​e​n​t​ ​c​o​n​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n + * W​h​e​t​h​e​r​ ​t​h​e​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​b​e​ ​a​ ​d​r​a​f​t */ shortDesc: string /** - * T​h​e​ ​d​o​c​u​m​e​n​t​ ​f​i​l​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​i​n​f​o​r​m​a​t​i​o​n​ ​t​o​ ​a​n​s​w​e​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​s​a​v​e​ ​t​h​e​ ​i​t​e​m​ ​a​s​ ​a​ ​d​r​a​f​t​,​ ​f​a​l​s​e​ ​t​o​ ​m​a​k​e​ ​i​t​ ​l​i​v​e */ longDesc: string } - image: { + cmsLocaleId: { /** - * I​m​a​g​e​ ​F​i​l​e + * C​M​S​ ​L​o​c​a​l​e​ ​I​D */ displayName: string /** - * I​m​a​g​e​ ​c​o​n​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n + * T​h​e​ ​l​o​c​a​l​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * T​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​v​i​s​u​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​t​o​ ​a​n​s​w​e​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n + * S​p​e​c​i​f​y​ ​t​h​e​ ​C​M​S​ ​l​o​c​a​l​e​ ​I​D​ ​i​f​ ​w​o​r​k​i​n​g​ ​w​i​t​h​ ​a​ ​m​u​l​t​i​-​l​o​c​a​l​e​ ​s​i​t​e */ longDesc: string } } } - create_text_classification: { + } + triggers: { + new_item: { /** - * C​r​e​a​t​e​ ​T​e​x​t​ ​C​l​a​s​s​i​f​i​c​a​t​i​o​n + * N​e​w​ ​I​t​e​m */ displayName: string /** - * C​l​a​s​s​i​f​y​ ​t​e​x​t​ ​i​n​t​o​ ​c​a​t​e​g​o​r​i​e​s + * T​r​i​g​g​e​r​e​d​ ​w​h​e​n​ ​a​ ​n​e​w​ ​i​t​e​m​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​a​ ​c​o​l​l​e​c​t​i​o​n */ shortDesc: string /** - * C​l​a​s​s​i​f​y​ ​t​e​x​t​ ​i​n​t​o​ ​p​r​e​d​e​f​i​n​e​d​ ​c​a​t​e​g​o​r​i​e​s​ ​u​s​i​n​g​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​t​e​x​t​ ​c​l​a​s​s​i​f​i​c​a​t​i​o​n​ ​m​o​d​e​l​s + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​i​t​e​m​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​a​n​y​ ​c​o​l​l​e​c​t​i​o​n​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​i​t​e​m​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​f​i​e​l​d​ ​d​a​t​a​. */ longDesc: string options: { - model: { - /** - * M​o​d​e​l - */ - displayName: string - /** - * T​e​x​t​ ​c​l​a​s​s​i​f​i​c​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e - */ - shortDesc: string - /** - * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​t​e​x​t​ ​c​l​a​s​s​i​f​i​c​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​a​t​e​g​o​r​i​z​i​n​g​ ​t​h​e​ ​t​e​x​t - */ - longDesc: string - } - text: { + site: { /** - * T​e​x​t + * S​i​t​e */ displayName: string /** - * T​e​x​t​ ​t​o​ ​c​l​a​s​s​i​f​y + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​i​n​p​u​t​ ​t​e​x​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​l​a​s​s​i​f​y​ ​i​n​t​o​ ​c​a​t​e​g​o​r​i​e​s + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​i​t​e​m​ ​c​r​e​a​t​i​o​n​ ​e​v​e​n​t​s */ longDesc: string } } } - create_translation: { + new_order: { /** - * C​r​e​a​t​e​ ​T​r​a​n​s​l​a​t​i​o​n + * N​e​w​ ​O​r​d​e​r */ displayName: string /** - * T​r​a​n​s​l​a​t​e​ ​t​e​x​t​ ​b​e​t​w​e​e​n​ ​l​a​n​g​u​a​g​e​s + * T​r​i​g​g​e​r​e​d​ ​w​h​e​n​ ​a​ ​n​e​w​ ​o​r​d​e​r​ ​i​s​ ​p​l​a​c​e​d */ shortDesc: string /** - * T​r​a​n​s​l​a​t​e​ ​t​e​x​t​ ​f​r​o​m​ ​o​n​e​ ​l​a​n​g​u​a​g​e​ ​t​o​ ​a​n​o​t​h​e​r​ ​u​s​i​n​g​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​t​r​a​n​s​l​a​t​i​o​n​ ​m​o​d​e​l​s + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​o​r​d​e​r​ ​i​s​ ​p​l​a​c​e​d​ ​o​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​o​r​d​e​r​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​,​ ​p​u​r​c​h​a​s​e​d​ ​i​t​e​m​s​,​ ​p​a​y​m​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​a​n​d​ ​s​h​i​p​p​i​n​g​ ​d​e​t​a​i​l​s​. */ longDesc: string options: { - model: { - /** - * M​o​d​e​l - */ - displayName: string - /** - * T​r​a​n​s​l​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e - */ - shortDesc: string - /** - * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​t​r​a​n​s​l​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​r​a​n​s​l​a​t​i​n​g​ ​t​h​e​ ​t​e​x​t - */ - longDesc: string - } - text: { + site: { /** - * T​e​x​t + * S​i​t​e */ displayName: string /** - * T​e​x​t​ ​t​o​ ​t​r​a​n​s​l​a​t​e + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​i​n​p​u​t​ ​t​e​x​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​t​r​a​n​s​l​a​t​e​ ​t​o​ ​a​n​o​t​h​e​r​ ​l​a​n​g​u​a​g​e + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​o​r​d​e​r​ ​e​v​e​n​t​s */ longDesc: string } } } - create_chat_completion: { + updated_item: { /** - * C​r​e​a​t​e​ ​C​h​a​t​ ​C​o​m​p​l​e​t​i​o​n + * U​p​d​a​t​e​d​ ​I​t​e​m */ displayName: string /** - * G​e​n​e​r​a​t​e​ ​A​I​ ​c​h​a​t​ ​r​e​s​p​o​n​s​e​s + * T​r​i​g​g​e​r​e​d​ ​w​h​e​n​ ​a​n​ ​i​t​e​m​ ​i​s​ ​u​p​d​a​t​e​d​ ​i​n​ ​a​ ​c​o​l​l​e​c​t​i​o​n */ shortDesc: string /** - * G​e​n​e​r​a​t​e​ ​c​o​n​v​e​r​s​a​t​i​o​n​a​l​ ​A​I​ ​r​e​s​p​o​n​s​e​s​ ​u​s​i​n​g​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​c​h​a​t​ ​c​o​m​p​l​e​t​i​o​n​ ​m​o​d​e​l​s + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​i​t​e​m​ ​i​s​ ​m​o​d​i​f​i​e​d​ ​i​n​ ​a​n​y​ ​c​o​l​l​e​c​t​i​o​n​ ​w​i​t​h​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​u​p​d​a​t​e​d​ ​i​t​e​m​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​c​u​r​r​e​n​t​ ​f​i​e​l​d​ ​d​a​t​a​. */ longDesc: string options: { - model: { + site: { /** - * M​o​d​e​l + * S​i​t​e */ displayName: string /** - * C​h​a​t​ ​c​o​m​p​l​e​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​c​h​a​t​ ​c​o​m​p​l​e​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​g​e​n​e​r​a​t​i​n​g​ ​r​e​s​p​o​n​s​e​s + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​i​t​e​m​ ​u​p​d​a​t​e​ ​e​v​e​n​t​s */ longDesc: string } - messages: { + } + } + updated_order: { + /** + * U​p​d​a​t​e​d​ ​O​r​d​e​r + */ + displayName: string + /** + * T​r​i​g​g​e​r​e​d​ ​w​h​e​n​ ​a​n​ ​o​r​d​e​r​ ​s​t​a​t​u​s​ ​i​s​ ​u​p​d​a​t​e​d + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​o​r​d​e​r​ ​i​s​ ​m​o​d​i​f​i​e​d​ ​o​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​W​e​b​f​l​o​w​ ​s​i​t​e​.​ ​T​h​i​s​ ​i​n​c​l​u​d​e​s​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​,​ ​f​u​l​f​i​l​l​m​e​n​t​ ​u​p​d​a​t​e​s​,​ ​r​e​f​u​n​d​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​o​r​d​e​r​ ​m​o​d​i​f​i​c​a​t​i​o​n​s​. + */ + longDesc: string + options: { + site: { /** - * M​e​s​s​a​g​e​s + * S​i​t​e */ displayName: string /** - * C​o​n​v​e​r​s​a​t​i​o​n​ ​m​e​s​s​a​g​e​s + * T​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​c​o​n​v​e​r​s​a​t​i​o​n​ ​h​i​s​t​o​r​y​ ​i​n​c​l​u​d​i​n​g​ ​u​s​e​r​ ​a​n​d​ ​a​s​s​i​s​t​a​n​t​ ​m​e​s​s​a​g​e​s + * S​e​l​e​c​t​ ​t​h​e​ ​W​e​b​f​l​o​w​ ​s​i​t​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​o​r​d​e​r​ ​u​p​d​a​t​e​ ​e​v​e​n​t​s */ longDesc: string - type: { - element_type: { - fields: { - role: { - /** - * R​o​l​e - */ - displayName: string - /** - * M​e​s​s​a​g​e​ ​s​e​n​d​e​r​ ​r​o​l​e - */ - shortDesc: string - /** - * W​h​e​t​h​e​r​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​f​r​o​m​ ​a​ ​u​s​e​r​ ​o​r​ ​a​s​s​i​s​t​a​n​t - */ - longDesc: string - } - content: { - /** - * C​o​n​t​e​n​t - */ - displayName: string - /** - * M​e​s​s​a​g​e​ ​c​o​n​t​e​n​t - */ - shortDesc: string - /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e - */ - longDesc: string - } - } - } - } } } } } } - YouTube: { + ActiveCampaign: { /** - * Y​o​u​T​u​b​e + * A​c​t​i​v​e​C​a​m​p​a​i​g​n */ displayName: string groups: { /** - * S​o​c​i​a​l​ ​M​e​d​i​a​ ​M​a​n​a​g​e​m​e​n​t + * E​m​a​i​l​ ​&​ ​E​m​a​i​l​ ​M​a​r​k​e​t​i​n​g */ '0': string } /** - * C​o​n​n​e​c​t​ ​a​n​d​ ​i​n​t​e​r​a​c​t​ ​w​i​t​h​ ​Y​o​u​T​u​b​e + * E​m​a​i​l​ ​m​a​r​k​e​t​i​n​g​ ​a​u​t​o​m​a​t​i​o​n​ ​a​n​d​ ​C​R​M​ ​p​l​a​t​f​o​r​m */ shortDesc: string /** - * Y​o​u​T​u​b​e​ ​i​n​t​e​g​r​a​t​i​o​n​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​m​a​n​a​g​e​ ​v​i​d​e​o​s​,​ ​p​l​a​y​l​i​s​t​s​,​ ​c​h​a​n​n​e​l​s​,​ ​a​n​d​ ​i​n​t​e​r​a​c​t​ ​w​i​t​h​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​p​l​a​t​f​o​r​m​ ​p​r​o​g​r​a​m​m​a​t​i​c​a​l​l​y​. + * C​o​n​n​e​c​t​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​e​m​a​i​l​ ​m​a​r​k​e​t​i​n​g​ ​c​a​m​p​a​i​g​n​s​,​ ​m​a​n​a​g​e​ ​c​o​n​t​a​c​t​s​,​ ​a​n​d​ ​t​r​a​c​k​ ​c​u​s​t​o​m​e​r​ ​i​n​t​e​r​a​c​t​i​o​n​s​.​ ​C​r​e​a​t​e​ ​a​n​d​ ​s​e​n​d​ ​t​a​r​g​e​t​e​d​ ​e​m​a​i​l​ ​c​a​m​p​a​i​g​n​s​,​ ​m​a​n​a​g​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​,​ ​s​e​t​ ​u​p​ ​a​u​t​o​m​a​t​i​o​n​ ​w​o​r​k​f​l​o​w​s​,​ ​a​n​d​ ​a​n​a​l​y​z​e​ ​c​a​m​p​a​i​g​n​ ​p​e​r​f​o​r​m​a​n​c​e​ ​a​l​l​ ​f​r​o​m​ ​w​i​t​h​i​n​ ​Q​o​r​e​. */ longDesc: string - actions: { - list_user_subscriptions: { - groups: { - /** - * S​u​b​s​c​r​i​p​t​i​o​n​s - */ - '0': string + connectionMessage: { + /** + * C​o​n​n​e​c​t​ ​t​o​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + */ + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​I​n​s​t​a​n​c​e​ ​U​R​L​*​*​ ​a​n​d​ ​*​*​A​P​I​ ​K​e​y​*​*​.​ + ​ + ​#​#​ ​H​o​w​ ​t​o​ ​G​e​t​ ​Y​o​u​r​ ​C​r​e​d​e​n​t​i​a​l​s​ + ​ + ​#​#​#​ ​I​n​s​t​a​n​c​e​ ​U​R​L​ + ​Y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​i​n​s​t​a​n​c​e​ ​U​R​L​ ​(​e​.​g​.​,​ ​`​h​t​t​p​s​:​/​/​<​y​o​u​r​_​a​c​c​o​u​n​t​>​.​a​c​t​i​v​e​h​o​s​t​e​d​.​c​o​m​`​)​ + ​ + ​1​.​ ​G​o​ ​t​o​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​s​e​t​t​i​n​g​s​ + ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​D​e​v​e​l​o​p​e​r​ ​s​e​t​t​i​n​g​s​ + ​3​.​ ​C​o​p​y​ ​t​h​e​ ​U​R​L​ ​v​a​l​u​e​ + ​ + ​#​#​#​ ​A​P​I​ ​K​e​y​ + ​Y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​A​P​I​ ​k​e​y​ ​f​o​r​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​ + ​ + ​1​.​ ​G​o​ ​t​o​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​a​c​c​o​u​n​t​ ​s​e​t​t​i​n​g​s​ + ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​D​e​v​e​l​o​p​e​r​ ​s​e​t​t​i​n​g​s​ + ​3​.​ ​C​o​p​y​ ​t​h​e​ ​A​P​I​ ​K​e​y​ ​v​a​l​u​e​ + ​ + ​B​o​t​h​ ​c​r​e​d​e​n​t​i​a​l​s​ ​c​a​n​ ​b​e​ ​f​o​u​n​d​ ​i​n​ ​t​h​e​ ​s​a​m​e​ ​l​o​c​a​t​i​o​n​ ​w​i​t​h​i​n​ ​y​o​u​r​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​D​e​v​e​l​o​p​e​r​ ​s​e​t​t​i​n​g​s​. + */ + content: string + } + triggers: { + contact_added_to_list: { + /** + * C​o​n​t​a​c​t​ ​A​d​d​e​d​ ​t​o​ ​L​i​s​t + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​o​n​t​a​c​t​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​l​i​s​t + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​c​o​n​t​a​c​t​ ​s​u​b​s​c​r​i​b​e​s​ ​o​r​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + */ + longDesc: string + options: { + list: { + /** + * L​i​s​t + */ + displayName: string + /** + * T​h​e​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​n​t​a​c​t​s + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​a​d​d​i​t​i​o​n​s + */ + longDesc: string + } } + } + updated_contact: { /** - * L​i​s​t​ ​U​s​e​r​ ​S​u​b​s​c​r​i​p​t​i​o​n​s + * C​o​n​t​a​c​t​ ​U​p​d​a​t​e​d */ displayName: string /** - * G​e​t​ ​a​ ​l​i​s​t​ ​o​f​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​f​o​r​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​o​n​t​a​c​t​ ​i​s​ ​u​p​d​a​t​e​d */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​s​ ​t​h​a​t​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​ ​i​s​ ​s​u​b​s​c​r​i​b​e​d​ ​t​o​,​ ​i​n​c​l​u​d​i​n​g​ ​c​h​a​n​n​e​l​ ​d​e​t​a​i​l​s​ ​a​n​d​ ​t​h​u​m​b​n​a​i​l​s + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​n​y​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​s​ ​u​p​d​a​t​e​d​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + */ + longDesc: string + } + new_campaign_bounce: { + /** + * N​e​w​ ​C​a​m​p​a​i​g​n​ ​B​o​u​n​c​e + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​a​m​p​a​i​g​n​ ​e​m​a​i​l​ ​b​o​u​n​c​e​s + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​n​ ​e​m​a​i​l​ ​f​r​o​m​ ​a​ ​c​a​m​p​a​i​g​n​ ​b​o​u​n​c​e​s​,​ ​i​n​d​i​c​a​t​i​n​g​ ​d​e​l​i​v​e​r​y​ ​f​a​i​l​u​r​e + */ + longDesc: string + } + new_campaign_link_click: { + /** + * N​e​w​ ​C​a​m​p​a​i​g​n​ ​L​i​n​k​ ​C​l​i​c​k + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​l​i​n​k​ ​i​n​ ​a​ ​c​a​m​p​a​i​g​n​ ​i​s​ ​c​l​i​c​k​e​d + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​r​e​c​i​p​i​e​n​t​ ​c​l​i​c​k​s​ ​o​n​ ​a​ ​l​i​n​k​ ​w​i​t​h​i​n​ ​a​ ​c​a​m​p​a​i​g​n​ ​e​m​a​i​l + */ + longDesc: string + } + new_campaign_reply: { + /** + * N​e​w​ ​C​a​m​p​a​i​g​n​ ​R​e​p​l​y + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​s​o​m​e​o​n​e​ ​r​e​p​l​i​e​s​ ​t​o​ ​a​ ​c​a​m​p​a​i​g​n + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​r​e​c​i​p​i​e​n​t​ ​r​e​p​l​i​e​s​ ​t​o​ ​a​ ​c​a​m​p​a​i​g​n​ ​e​m​a​i​l + */ + longDesc: string + } + new_contact_note: { + /** + * N​e​w​ ​C​o​n​t​a​c​t​ ​N​o​t​e + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​o​t​e​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​c​o​n​t​a​c​t + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​o​t​e​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​c​o​n​t​a​c​t​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t */ longDesc: string options: { - maxResults: { + list: { /** - * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s + * L​i​s​t */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​n​o​t​e​s */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​i​t​e​m​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​ ​(​1​-​5​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​2​5​) + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​w​h​e​n​ ​n​o​t​e​s​ ​a​r​e​ ​a​d​d​e​d​ ​t​o​ ​c​o​n​t​a​c​t​s */ longDesc: string } - nextPageToken: { + } + } + new_contact: { + /** + * N​e​w​ ​C​o​n​t​a​c​t + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​s​ ​c​r​e​a​t​e​d + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​s​u​b​s​c​r​i​b​e​s​ ​o​r​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + */ + longDesc: string + } + deal_note_added: { + /** + * D​e​a​l​ ​N​o​t​e​ ​A​d​d​e​d + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​o​t​e​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​d​e​a​l + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​o​t​e​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​d​e​a​l​ ​f​o​r​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t + */ + longDesc: string + options: { + list: { /** - * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n + * L​i​s​t */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s + * T​h​e​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​d​e​a​l​ ​n​o​t​e​ ​a​d​d​i​t​i​o​n​s */ shortDesc: string /** - * T​h​e​ ​t​o​k​e​n​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​u​s​e​d​ ​a​s​ ​t​h​e​ ​v​a​l​u​e​ ​o​f​ ​t​h​e​ ​p​a​g​e​T​o​k​e​n​ ​p​a​r​a​m​e​t​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​ ​s​e​t + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​w​h​e​n​ ​n​o​t​e​s​ ​a​r​e​ ​a​d​d​e​d​ ​t​o​ ​d​e​a​l​s */ longDesc: string } } } - get_channel_id_from_url: { + new_deal: { + /** + * N​e​w​ ​D​e​a​l + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​a​l​ ​i​s​ ​c​r​e​a​t​e​d + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​a​l​ ​i​s​ ​c​r​e​a​t​e​d​ ​f​o​r​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t + */ + longDesc: string + options: { + list: { + /** + * L​i​s​t + */ + displayName: string + /** + * T​h​e​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​d​e​a​l​s + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​w​h​e​n​ ​n​e​w​ ​d​e​a​l​s​ ​a​r​e​ ​c​r​e​a​t​e​d + */ + longDesc: string + } + } + } + } + actions: { + add_contact_note: { groups: { /** - * C​h​a​n​n​e​l​s + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t */ '0': string } /** - * G​e​t​ ​C​h​a​n​n​e​l​ ​I​D​ ​f​r​o​m​ ​U​R​L + * A​d​d​ ​C​o​n​t​a​c​t​ ​N​o​t​e */ displayName: string /** - * E​x​t​r​a​c​t​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​I​D​ ​f​r​o​m​ ​v​a​r​i​o​u​s​ ​U​R​L​ ​f​o​r​m​a​t​s + * A​d​d​ ​a​ ​n​o​t​e​ ​t​o​ ​a​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * E​x​t​r​a​c​t​s​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​I​D​ ​f​r​o​m​ ​d​i​f​f​e​r​e​n​t​ ​Y​o​u​T​u​b​e​ ​U​R​L​ ​f​o​r​m​a​t​s​ ​i​n​c​l​u​d​i​n​g​ ​c​h​a​n​n​e​l​ ​U​R​L​s​,​ ​h​a​n​d​l​e​s​ ​(​@​u​s​e​r​n​a​m​e​)​,​ ​c​u​s​t​o​m​ ​U​R​L​s​ ​(​/​c​/​)​,​ ​u​s​e​r​n​a​m​e​s​ ​(​/​u​s​e​r​/​)​,​ ​a​n​d​ ​v​i​d​e​o​ ​U​R​L​s​.​ ​A​l​s​o​ ​r​e​t​u​r​n​s​ ​b​a​s​i​c​ ​c​h​a​n​n​e​l​ ​i​n​f​o​r​m​a​t​i​o​n​. + * A​d​d​ ​a​ ​n​e​w​ ​n​o​t​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - url: { + note: { /** - * Y​o​u​T​u​b​e​ ​U​R​L + * N​o​t​e */ displayName: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​U​R​L​ ​t​o​ ​e​x​t​r​a​c​t​ ​c​h​a​n​n​e​l​ ​I​D​ ​f​r​o​m + * T​h​e​ ​n​o​t​e​ ​c​o​n​t​e​n​t​ ​t​o​ ​a​d​d */ shortDesc: string /** - * A​n​y​ ​v​a​l​i​d​ ​Y​o​u​T​u​b​e​ ​U​R​L​ ​f​o​r​m​a​t​ ​i​n​c​l​u​d​i​n​g​ ​c​h​a​n​n​e​l​ ​U​R​L​s​,​ ​h​a​n​d​l​e​s​ ​(​@​u​s​e​r​n​a​m​e​)​,​ ​c​u​s​t​o​m​ ​U​R​L​s​ ​(​/​c​/​)​,​ ​u​s​e​r​n​a​m​e​s​ ​(​/​u​s​e​r​/​)​,​ ​o​r​ ​v​i​d​e​o​ ​U​R​L​s + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​n​o​t​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​c​o​n​t​a​c​t + */ + longDesc: string + } + contact: { + /** + * C​o​n​t​a​c​t + */ + displayName: string + /** + * T​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​n​o​t​e​ ​t​o + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​n​o​t​e​ ​t​o */ longDesc: string } } } - add_video_to_playlist: { + add_contact_to_account: { groups: { /** - * P​l​a​y​l​i​s​t​ ​I​t​e​m​s + * A​c​c​o​u​n​t​ ​M​a​n​a​g​e​m​e​n​t */ '0': string } /** - * A​d​d​ ​V​i​d​e​o​ ​t​o​ ​P​l​a​y​l​i​s​t + * A​d​d​ ​C​o​n​t​a​c​t​ ​t​o​ ​A​c​c​o​u​n​t */ displayName: string /** - * A​d​d​ ​a​ ​v​i​d​e​o​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t + * A​s​s​o​c​i​a​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​w​i​t​h​ ​a​n​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * A​d​d​s​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​v​i​d​e​o​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​.​ ​Y​o​u​ ​c​a​n​ ​o​p​t​i​o​n​a​l​l​y​ ​s​p​e​c​i​f​y​ ​t​h​e​ ​p​o​s​i​t​i​o​n​ ​w​h​e​r​e​ ​t​h​e​ ​v​i​d​e​o​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​s​e​r​t​e​d​ ​i​n​ ​t​h​e​ ​p​l​a​y​l​i​s​t​. + * C​r​e​a​t​e​ ​a​n​ ​a​s​s​o​c​i​a​t​i​o​n​ ​b​e​t​w​e​e​n​ ​a​ ​c​o​n​t​a​c​t​ ​a​n​d​ ​a​n​ ​a​c​c​o​u​n​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - playlistId: { + account: { /** - * P​l​a​y​l​i​s​t​ ​I​D + * A​c​c​o​u​n​t */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​v​i​d​e​o​ ​t​o + * T​h​e​ ​a​c​c​o​u​n​t​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​w​i​t​h */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​w​h​e​r​e​ ​t​h​e​ ​v​i​d​e​o​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d + * S​e​l​e​c​t​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​w​i​t​h */ longDesc: string } - videoId: { + contact: { /** - * V​i​d​e​o​ ​I​D + * C​o​n​t​a​c​t */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​v​i​d​e​o​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​p​l​a​y​l​i​s​t + * T​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​e​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​p​l​a​y​l​i​s​t + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​e​ ​a​c​c​o​u​n​t */ longDesc: string } - position: { + jobTitle: { /** - * P​o​s​i​t​i​o​n + * J​o​b​ ​T​i​t​l​e */ displayName: string /** - * T​h​e​ ​p​o​s​i​t​i​o​n​ ​i​n​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​w​h​e​r​e​ ​t​h​e​ ​v​i​d​e​o​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​s​e​r​t​e​d + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​j​o​b​ ​t​i​t​l​e​ ​a​t​ ​t​h​i​s​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​p​o​s​i​t​i​o​n​ ​(​0​-​b​a​s​e​d​ ​i​n​d​e​x​)​ ​w​h​e​r​e​ ​t​h​e​ ​v​i​d​e​o​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​s​e​r​t​e​d​ ​i​n​ ​t​h​e​ ​p​l​a​y​l​i​s​t​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​t​h​e​ ​v​i​d​e​o​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​e​n​d + * O​p​t​i​o​n​a​l​ ​j​o​b​ ​t​i​t​l​e​ ​o​r​ ​r​o​l​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​a​c​c​o​u​n​t */ longDesc: string } } } - create_playlist: { + add_deal_note: { groups: { /** - * P​l​a​y​l​i​s​t​s + * D​e​a​l​ ​M​a​n​a​g​e​m​e​n​t */ '0': string } /** - * C​r​e​a​t​e​ ​P​l​a​y​l​i​s​t + * A​d​d​ ​D​e​a​l​ ​N​o​t​e */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t + * A​d​d​ ​a​ ​n​o​t​e​ ​t​o​ ​a​ ​d​e​a​l */ shortDesc: string /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​t​i​t​l​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​t​a​g​s + * A​d​d​ ​a​ ​n​e​w​ ​n​o​t​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - title: { - /** - * T​i​t​l​e - */ - displayName: string - /** - * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​p​l​a​y​l​i​s​t - */ - shortDesc: string - /** - * T​h​e​ ​n​a​m​e​/​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​n​e​w​ ​p​l​a​y​l​i​s​t - */ - longDesc: string - } - description: { + note: { /** - * D​e​s​c​r​i​p​t​i​o​n + * N​o​t​e */ displayName: string /** - * T​h​e​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​p​l​a​y​l​i​s​t + * T​h​e​ ​n​o​t​e​ ​c​o​n​t​e​n​t​ ​t​o​ ​a​d​d */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​e​x​p​l​a​i​n​i​n​g​ ​i​t​s​ ​c​o​n​t​e​n​t​ ​o​r​ ​p​u​r​p​o​s​e + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​n​o​t​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - privacy: { + deal: { /** - * P​r​i​v​a​c​y​ ​S​t​a​t​u​s + * D​e​a​l */ displayName: string /** - * T​h​e​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t + * T​h​e​ ​d​e​a​l​ ​t​o​ ​a​d​d​ ​t​h​e​ ​n​o​t​e​ ​t​o */ shortDesc: string /** - * P​r​i​v​a​c​y​ ​l​e​v​e​l​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t​:​ ​p​u​b​l​i​c​ ​(​v​i​s​i​b​l​e​ ​t​o​ ​e​v​e​r​y​o​n​e​)​,​ ​p​r​i​v​a​t​e​ ​(​o​n​l​y​ ​v​i​s​i​b​l​e​ ​t​o​ ​y​o​u​)​,​ ​o​r​ ​u​n​l​i​s​t​e​d​ ​(​v​i​s​i​b​l​e​ ​t​o​ ​a​n​y​o​n​e​ ​w​i​t​h​ ​t​h​e​ ​l​i​n​k​) + * S​e​l​e​c​t​ ​t​h​e​ ​d​e​a​l​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​n​o​t​e​ ​t​o */ longDesc: string } - tags: { + } + } + add_tag_to_contact: { + groups: { + /** + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * A​d​d​ ​T​a​g​ ​t​o​ ​C​o​n​t​a​c​t + */ + displayName: string + /** + * A​d​d​ ​a​ ​t​a​g​ ​t​o​ ​a​ ​c​o​n​t​a​c​t + */ + shortDesc: string + /** + * A​p​p​l​y​ ​a​ ​t​a​g​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​f​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​a​n​d​ ​s​e​g​m​e​n​t​a​t​i​o​n + */ + longDesc: string + options: { + tag: { /** - * T​a​g​s + * T​a​g */ displayName: string /** - * L​i​s​t​ ​o​f​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t + * T​h​e​ ​t​a​g​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​l​i​s​t​ ​o​f​ ​t​a​g​s​/​k​e​y​w​o​r​d​s​ ​t​o​ ​h​e​l​p​ ​c​a​t​e​g​o​r​i​z​e​ ​a​n​d​ ​m​a​k​e​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​d​i​s​c​o​v​e​r​a​b​l​e + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​g​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - defaultLanguage: { + contact: { /** - * D​e​f​a​u​l​t​ ​L​a​n​g​u​a​g​e + * C​o​n​t​a​c​t */ displayName: string /** - * T​h​e​ ​d​e​f​a​u​l​t​ ​l​a​n​g​u​a​g​e​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t + * T​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​t​a​g​ ​t​o */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​d​e​f​a​u​l​t​ ​l​a​n​g​u​a​g​e​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​c​o​n​t​e​n​t​ ​(​e​.​g​.​,​ ​"​e​n​"​ ​f​o​r​ ​E​n​g​l​i​s​h​) + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​t​a​g​ ​t​o */ longDesc: string } } } - search_videos: { + create_account: { groups: { /** - * V​i​d​e​o​s + * A​c​c​o​u​n​t​ ​M​a​n​a​g​e​m​e​n​t */ '0': string } /** - * S​e​a​r​c​h​ ​V​i​d​e​o​s + * C​r​e​a​t​e​ ​A​c​c​o​u​n​t */ displayName: string /** - * S​e​a​r​c​h​ ​f​o​r​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​s + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * S​e​a​r​c​h​ ​f​o​r​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​s​ ​u​s​i​n​g​ ​v​a​r​i​o​u​s​ ​f​i​l​t​e​r​s​ ​i​n​c​l​u​d​i​n​g​ ​k​e​y​w​o​r​d​s​,​ ​d​u​r​a​t​i​o​n​,​ ​q​u​a​l​i​t​y​,​ ​u​p​l​o​a​d​ ​d​a​t​e​,​ ​a​n​d​ ​m​o​r​e + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​a​c​c​o​u​n​t​ ​(​c​o​m​p​a​n​y​/​o​r​g​a​n​i​z​a​t​i​o​n​)​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - q: { + name: { /** - * S​e​a​r​c​h​ ​Q​u​e​r​y + * A​c​c​o​u​n​t​ ​N​a​m​e */ displayName: string /** - * K​e​y​w​o​r​d​s​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * Y​o​u​r​ ​r​e​q​u​e​s​t​ ​c​a​n​ ​a​l​s​o​ ​u​s​e​ ​t​h​e​ ​B​o​o​l​e​a​n​ ​N​O​T​ ​(​-​)​ ​a​n​d​ ​O​R​ ​(​|​)​ ​o​p​e​r​a​t​o​r​s​ ​t​o​ ​e​x​c​l​u​d​e​ ​v​i​d​e​o​s​ ​o​r​ ​t​o​ ​f​i​n​d​ ​v​i​d​e​o​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​o​n​e​ ​o​f​ ​s​e​v​e​r​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m​s​.​ ​F​o​r​ ​e​x​a​m​p​l​e​,​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​e​i​t​h​e​r​ ​"​b​o​a​t​i​n​g​"​ ​o​r​ ​"​s​a​i​l​i​n​g​"​,​ ​s​e​t​ ​t​h​e​ ​q​ ​p​a​r​a​m​e​t​e​r​ ​v​a​l​u​e​ ​t​o​ ​b​o​a​t​i​n​g​|​s​a​i​l​i​n​g​.​ ​S​i​m​i​l​a​r​l​y​,​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​e​i​t​h​e​r​ ​"​b​o​a​t​i​n​g​"​ ​o​r​ ​"​s​a​i​l​i​n​g​"​ ​b​u​t​ ​n​o​t​ ​"​f​i​s​h​i​n​g​"​,​ ​s​e​t​ ​t​h​e​ ​q​ ​p​a​r​a​m​e​t​e​r​ ​v​a​l​u​e​ ​t​o​ ​b​o​a​t​i​n​g​|​s​a​i​l​i​n​g​ ​-​f​i​s​h​i​n​g​. + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​a​c​c​o​u​n​t */ longDesc: string } - order: { + accountUrl: { /** - * S​o​r​t​ ​O​r​d​e​r + * A​c​c​o​u​n​t​ ​U​R​L */ displayName: string /** - * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s + * T​h​e​ ​w​e​b​s​i​t​e​ ​U​R​L​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * T​h​e​ ​o​r​d​e​r​ ​i​n​ ​w​h​i​c​h​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​ ​s​h​o​u​l​d​ ​b​e​ ​r​e​t​u​r​n​e​d​ ​(​r​e​l​e​v​a​n​c​e​,​ ​d​a​t​e​,​ ​r​a​t​i​n​g​,​ ​t​i​t​l​e​,​ ​o​r​ ​v​i​e​w​ ​c​o​u​n​t​) + * O​p​t​i​o​n​a​l​ ​w​e​b​s​i​t​e​ ​U​R​L​ ​o​r​ ​d​o​m​a​i​n​ ​f​o​r​ ​t​h​e​ ​a​c​c​o​u​n​t */ longDesc: string } - publishedAfter: { + owner: { /** - * P​u​b​l​i​s​h​e​d​ ​A​f​t​e​r + * A​c​c​o​u​n​t​ ​O​w​n​e​r */ displayName: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​v​i​d​e​o​s​ ​p​u​b​l​i​s​h​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e + * T​h​e​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​o​w​n​ ​t​h​i​s​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​v​i​d​e​o​s​ ​p​u​b​l​i​s​h​e​d​ ​a​f​t​e​r​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​d​a​t​e​ ​(​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​) + * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​t​h​i​s​ ​a​c​c​o​u​n​t */ longDesc: string } - publishedBefore: { + fieldOptions: { /** - * P​u​b​l​i​s​h​e​d​ ​B​e​f​o​r​e + * C​u​s​t​o​m​ ​F​i​e​l​d​s */ displayName: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​v​i​d​e​o​s​ ​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e + * C​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s​ ​f​o​r​ ​t​h​e​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​v​i​d​e​o​s​ ​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​d​a​t​e​ ​(​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​) + * S​e​t​ ​v​a​l​u​e​s​ ​f​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​a​c​c​o​u​n​t​s */ longDesc: string } - videoDuration: { + } + } + create_contact: { + groups: { + /** + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * C​r​e​a​t​e​ ​C​o​n​t​a​c​t + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​b​a​s​i​c​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​n​d​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s + */ + longDesc: string + options: { + email: { /** - * V​i​d​e​o​ ​D​u​r​a​t​i​o​n + * E​m​a​i​l​ ​A​d​d​r​e​s​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​v​i​d​e​o​ ​l​e​n​g​t​h + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​t​h​e​i​r​ ​d​u​r​a​t​i​o​n​:​ ​a​n​y​,​ ​s​h​o​r​t​ ​(​<​ ​4​ ​m​i​n​u​t​e​s​)​,​ ​m​e​d​i​u​m​ ​(​4​-​2​0​ ​m​i​n​u​t​e​s​)​,​ ​o​r​ ​l​o​n​g​ ​(​>​ ​2​0​ ​m​i​n​u​t​e​s​) + * T​h​e​ ​p​r​i​m​a​r​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​(​r​e​q​u​i​r​e​d​) */ longDesc: string } - videoDefinition: { + firstName: { /** - * V​i​d​e​o​ ​D​e​f​i​n​i​t​i​o​n + * F​i​r​s​t​ ​N​a​m​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​v​i​d​e​o​ ​q​u​a​l​i​t​y + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​f​i​r​s​t​ ​n​a​m​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​t​h​e​i​r​ ​d​e​f​i​n​i​t​i​o​n​ ​q​u​a​l​i​t​y​:​ ​a​n​y​,​ ​s​t​a​n​d​a​r​d​ ​d​e​f​i​n​i​t​i​o​n​,​ ​o​r​ ​h​i​g​h​ ​d​e​f​i​n​i​t​i​o​n + * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - videoDimension: { + lastName: { /** - * V​i​d​e​o​ ​D​i​m​e​n​s​i​o​n + * L​a​s​t​ ​N​a​m​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​2​D​ ​o​r​ ​3​D​ ​v​i​d​e​o​s + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​l​a​s​t​ ​n​a​m​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​t​h​e​i​r​ ​d​i​m​e​n​s​i​o​n​a​l​ ​f​o​r​m​a​t​:​ ​a​n​y​,​ ​2​D​ ​o​n​l​y​,​ ​o​r​ ​3​D​ ​o​n​l​y + * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - videoCaption: { + phone: { /** - * V​i​d​e​o​ ​C​a​p​t​i​o​n + * P​h​o​n​e​ ​N​u​m​b​e​r */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​a​p​t​i​o​n​ ​a​v​a​i​l​a​b​i​l​i​t​y + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​c​a​p​t​i​o​n​ ​a​v​a​i​l​a​b​i​l​i​t​y​:​ ​a​n​y​,​ ​v​i​d​e​o​s​ ​w​i​t​h​ ​c​l​o​s​e​d​ ​c​a​p​t​i​o​n​s​,​ ​o​r​ ​v​i​d​e​o​s​ ​w​i​t​h​o​u​t​ ​c​a​p​t​i​o​n​s + * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - videoLicense: { + fieldValues: { /** - * V​i​d​e​o​ ​L​i​c​e​n​s​e + * C​u​s​t​o​m​ ​F​i​e​l​d​ ​V​a​l​u​e​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​v​i​d​e​o​ ​l​i​c​e​n​s​e​ ​t​y​p​e + * V​a​l​u​e​s​ ​f​o​r​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​t​h​e​i​r​ ​l​i​c​e​n​s​e​:​ ​a​n​y​,​ ​s​t​a​n​d​a​r​d​ ​Y​o​u​T​u​b​e​ ​l​i​c​e​n​s​e​,​ ​o​r​ ​C​r​e​a​t​i​v​e​ ​C​o​m​m​o​n​s​ ​l​i​c​e​n​s​e + * S​e​t​ ​v​a​l​u​e​s​ ​f​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​c​o​n​t​a​c​t​s */ longDesc: string } - safeSearch: { + } + } + create_deal: { + groups: { + /** + * D​e​a​l​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * C​r​e​a​t​e​ ​D​e​a​l + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​d​e​a​l + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​a​l​e​s​ ​d​e​a​l​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​a​l​l​ ​r​e​l​e​v​a​n​t​ ​d​e​t​a​i​l​s + */ + longDesc: string + options: { + title: { /** - * S​a​f​e​ ​S​e​a​r​c​h + * D​e​a​l​ ​T​i​t​l​e */ displayName: string /** - * S​a​f​e​ ​s​e​a​r​c​h​ ​f​i​l​t​e​r​i​n​g​ ​l​e​v​e​l + * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * L​e​v​e​l​ ​o​f​ ​s​a​f​e​ ​s​e​a​r​c​h​ ​f​i​l​t​e​r​i​n​g​ ​t​o​ ​a​p​p​l​y​:​ ​m​o​d​e​r​a​t​e​ ​(​d​e​f​a​u​l​t​)​,​ ​n​o​n​e​,​ ​o​r​ ​s​t​r​i​c​t + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - regionCode: { + account: { /** - * R​e​g​i​o​n​ ​C​o​d​e + * A​c​c​o​u​n​t */ displayName: string /** - * C​o​u​n​t​r​y​ ​c​o​d​e​ ​t​o​ ​s​e​a​r​c​h​ ​w​i​t​h​i​n + * T​h​e​ ​a​c​c​o​u​n​t​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​t​w​o​-​l​e​t​t​e​r​ ​c​o​u​n​t​r​y​ ​c​o​d​e​ ​t​o​ ​r​e​s​t​r​i​c​t​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​r​e​g​i​o​n + * S​e​l​e​c​t​ ​t​h​e​ ​a​c​c​o​u​n​t​/​c​o​m​p​a​n​y​ ​t​h​a​t​ ​t​h​i​s​ ​d​e​a​l​ ​i​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h */ longDesc: string } - relevanceLanguage: { + contact: { /** - * R​e​l​e​v​a​n​c​e​ ​L​a​n​g​u​a​g​e + * C​o​n​t​a​c​t */ displayName: string /** - * L​a​n​g​u​a​g​e​ ​f​o​r​ ​r​e​l​e​v​a​n​c​e​ ​r​a​n​k​i​n​g + * T​h​e​ ​p​r​i​m​a​r​y​ ​c​o​n​t​a​c​t​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l */ shortDesc: string /** - * L​a​n​g​u​a​g​e​ ​c​o​d​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​r​e​l​e​v​a​n​c​e​ ​r​a​n​k​i​n​g​ ​o​f​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s + * S​e​l​e​c​t​ ​t​h​e​ ​m​a​i​n​ ​c​o​n​t​a​c​t​ ​p​e​r​s​o​n​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l */ longDesc: string } - videoCategoryId: { + value: { /** - * V​i​d​e​o​ ​C​a​t​e​g​o​r​y + * D​e​a​l​ ​V​a​l​u​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​v​i​d​e​o​ ​c​a​t​e​g​o​r​y + * T​h​e​ ​m​o​n​e​t​a​r​y​ ​v​a​l​u​e​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​c​a​t​e​g​o​r​y​ ​I​D​ ​t​o​ ​f​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​c​a​t​e​g​o​r​y + * T​h​e​ ​t​o​t​a​l​ ​v​a​l​u​e​ ​o​r​ ​a​m​o​u​n​t​ ​o​f​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - maxResults: { + currency: { /** - * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s + * C​u​r​r​e​n​c​y */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​c​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​v​a​l​u​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​2​5​) + * S​e​l​e​c​t​ ​t​h​e​ ​c​u​r​r​e​n​c​y​ ​t​h​a​t​ ​t​h​e​ ​d​e​a​l​ ​v​a​l​u​e​ ​i​s​ ​d​e​n​o​m​i​n​a​t​e​d​ ​i​n */ longDesc: string } - pageToken: { + stage: { /** - * P​a​g​e​ ​T​o​k​e​n + * D​e​a​l​ ​S​t​a​g​e */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * T​h​e​ ​c​u​r​r​e​n​t​ ​s​t​a​g​e​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​ ​(​u​s​e​d​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​) + * S​e​l​e​c​t​ ​t​h​e​ ​p​i​p​e​l​i​n​e​ ​s​t​a​g​e​ ​t​h​a​t​ ​r​e​p​r​e​s​e​n​t​s​ ​t​h​e​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - } - } - get_report: { - groups: { - /** - * A​n​a​l​y​t​i​c​s - */ - '0': string - } - /** - * G​e​t​ ​A​n​a​l​y​t​i​c​s​ ​R​e​p​o​r​t - */ - displayName: string - /** - * G​e​t​ ​Y​o​u​T​u​b​e​ ​A​n​a​l​y​t​i​c​s​ ​r​e​p​o​r​t​ ​d​a​t​a - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​Y​o​u​T​u​b​e​ ​A​n​a​l​y​t​i​c​s​ ​d​a​t​a​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​ ​w​i​t​h​i​n​ ​a​ ​d​a​t​e​ ​r​a​n​g​e​,​ ​i​n​c​l​u​d​i​n​g​ ​m​e​t​r​i​c​s​ ​l​i​k​e​ ​v​i​e​w​s​,​ ​w​a​t​c​h​ ​t​i​m​e​,​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t - */ - longDesc: string - options: { - startDate: { + group: { /** - * S​t​a​r​t​ ​D​a​t​e + * P​i​p​e​l​i​n​e​ ​G​r​o​u​p */ displayName: string /** - * T​h​e​ ​s​t​a​r​t​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​r​e​p​o​r​t + * T​h​e​ ​p​i​p​e​l​i​n​e​ ​g​r​o​u​p​ ​f​o​r​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * T​h​e​ ​s​t​a​r​t​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​a​n​a​l​y​t​i​c​s​ ​r​e​p​o​r​t​ ​i​n​ ​Y​Y​Y​Y​-​M​M​-​D​D​ ​f​o​r​m​a​t + * S​e​l​e​c​t​ ​t​h​e​ ​p​i​p​e​l​i​n​e​ ​g​r​o​u​p​ ​t​h​a​t​ ​t​h​i​s​ ​d​e​a​l​ ​b​e​l​o​n​g​s​ ​t​o */ longDesc: string } - endDate: { + owner: { /** - * E​n​d​ ​D​a​t​e + * D​e​a​l​ ​O​w​n​e​r */ displayName: string /** - * T​h​e​ ​e​n​d​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​r​e​p​o​r​t + * T​h​e​ ​u​s​e​r​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l */ shortDesc: string /** - * T​h​e​ ​e​n​d​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​a​n​a​l​y​t​i​c​s​ ​r​e​p​o​r​t​ ​i​n​ ​Y​Y​Y​Y​-​M​M​-​D​D​ ​f​o​r​m​a​t + * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​t​h​i​s​ ​d​e​a​l */ longDesc: string } - metrics: { + percent: { /** - * M​e​t​r​i​c​s + * C​o​m​p​l​e​t​i​o​n​ ​P​e​r​c​e​n​t​a​g​e */ displayName: string /** - * L​i​s​t​ ​o​f​ ​m​e​t​r​i​c​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​p​o​r​t + * T​h​e​ ​p​e​r​c​e​n​t​a​g​e​ ​c​o​m​p​l​e​t​i​o​n​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * L​i​s​t​ ​o​f​ ​a​n​a​l​y​t​i​c​s​ ​m​e​t​r​i​c​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​e​.​g​.​,​ ​v​i​e​w​s​,​ ​e​s​t​i​m​a​t​e​d​M​i​n​u​t​e​s​W​a​t​c​h​e​d​,​ ​l​i​k​e​s​,​ ​c​o​m​m​e​n​t​s​) + * A​ ​p​e​r​c​e​n​t​a​g​e​ ​v​a​l​u​e​ ​r​e​p​r​e​s​e​n​t​i​n​g​ ​h​o​w​ ​c​l​o​s​e​ ​t​h​e​ ​d​e​a​l​ ​i​s​ ​t​o​ ​c​o​m​p​l​e​t​i​o​n */ longDesc: string } - channel: { + description: { /** - * C​h​a​n​n​e​l + * D​e​a​l​ ​D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​g​e​t​ ​a​n​a​l​y​t​i​c​s​ ​f​o​r + * A​d​d​i​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​n​o​t​e​s */ shortDesc: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​I​D​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​a​n​a​l​y​t​i​c​s​ ​d​a​t​a​ ​f​o​r + * O​p​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​a​d​d​i​t​i​o​n​a​l​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - maxResults: { + status: { /** - * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s + * D​e​a​l​ ​S​t​a​t​u​s */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​a​t​a​ ​p​o​i​n​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​r​e​p​o​r​t​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​1​0​) + * S​e​l​e​c​t​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​d​e​a​l​ ​i​s​ ​o​p​e​n​,​ ​w​o​n​,​ ​o​r​ ​l​o​s​t */ longDesc: string } } } - list_categories: { + get_account: { groups: { /** - * V​i​d​e​o​s + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ '0': string } /** - * L​i​s​t​ ​V​i​d​e​o​ ​C​a​t​e​g​o​r​i​e​s + * G​e​t​ ​A​c​c​o​u​n​t */ displayName: string /** - * G​e​t​ ​l​i​s​t​ ​o​f​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​c​a​t​e​g​o​r​i​e​s + * R​e​t​r​i​e​v​e​ ​a​c​c​o​u​n​t​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​a​v​a​i​l​a​b​l​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​c​a​t​e​g​o​r​i​e​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​v​i​d​e​o​s + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​a​c​c​o​u​n​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string + options: { + id: { + /** + * A​c​c​o​u​n​t​ ​I​D + */ + displayName: string + /** + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + */ + longDesc: string + } + } } - list_user_channels: { + get_campaign: { groups: { /** - * C​h​a​n​n​e​l​s + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ '0': string } /** - * L​i​s​t​ ​U​s​e​r​ ​C​h​a​n​n​e​l​s + * G​e​t​ ​C​a​m​p​a​i​g​n */ displayName: string /** - * G​e​t​ ​l​i​s​t​ ​o​f​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​'​s​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​s + * R​e​t​r​i​e​v​e​ ​c​a​m​p​a​i​g​n​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​'​s​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​s​ ​i​n​c​l​u​d​i​n​g​ ​s​t​a​t​i​s​t​i​c​s​ ​a​n​d​ ​b​r​a​n​d​i​n​g​ ​s​e​t​t​i​n​g​s + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​m​p​a​i​g​n​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - maxResults: { - /** - * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s - */ - displayName: string - /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​r​e​t​u​r​n - */ - shortDesc: string - /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​r​e​t​u​r​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​5​) - */ - longDesc: string - } - nextPageToken: { + id: { /** - * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n + * C​a​m​p​a​i​g​n​ ​I​D */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​a​m​p​a​i​g​n​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s + * S​e​l​e​c​t​ ​t​h​e​ ​c​a​m​p​a​i​g​n​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ longDesc: string } } } - list_video_comments: { + get_contact: { groups: { /** - * C​o​m​m​e​n​t​s + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ '0': string } /** - * L​i​s​t​ ​V​i​d​e​o​ ​C​o​m​m​e​n​t​s + * G​e​t​ ​C​o​n​t​a​c​t */ displayName: string /** - * G​e​t​ ​c​o​m​m​e​n​t​s​ ​f​o​r​ ​a​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o + * R​e​t​r​i​e​v​e​ ​c​o​n​t​a​c​t​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​w​i​t​h​ ​v​a​r​i​o​u​s​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​,​ ​a​u​t​o​m​a​t​i​o​n​s​,​ ​a​n​d​ ​r​e​l​a​t​e​d​ ​d​a​t​a */ longDesc: string options: { - videoId: { - /** - * V​i​d​e​o​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​v​i​d​e​o​ ​t​o​ ​g​e​t​ ​c​o​m​m​e​n​t​s​ ​f​o​r - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​c​o​m​m​e​n​t​s​ ​f​r​o​m - */ - longDesc: string - } - order: { - /** - * S​o​r​t​ ​O​r​d​e​r - */ - displayName: string - /** - * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​c​o​m​m​e​n​t​s - */ - shortDesc: string - /** - * T​h​e​ ​o​r​d​e​r​ ​i​n​ ​w​h​i​c​h​ ​c​o​m​m​e​n​t​s​ ​s​h​o​u​l​d​ ​b​e​ ​r​e​t​u​r​n​e​d​:​ ​t​i​m​e​ ​(​n​e​w​e​s​t​ ​f​i​r​s​t​)​ ​o​r​ ​r​e​l​e​v​a​n​c​e - */ - longDesc: string - } - searchTerms: { - /** - * S​e​a​r​c​h​ ​T​e​r​m​s - */ - displayName: string - /** - * F​i​l​t​e​r​ ​c​o​m​m​e​n​t​s​ ​b​y​ ​s​e​a​r​c​h​ ​t​e​r​m​s - */ - shortDesc: string - /** - * O​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m​s​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​m​m​e​n​t​s​ ​t​h​a​t​ ​c​o​n​t​a​i​n​ ​s​p​e​c​i​f​i​c​ ​k​e​y​w​o​r​d​s - */ - longDesc: string - } - textFormat: { - /** - * T​e​x​t​ ​F​o​r​m​a​t - */ - displayName: string - /** - * F​o​r​m​a​t​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​e​x​t - */ - shortDesc: string - /** - * T​h​e​ ​f​o​r​m​a​t​ ​i​n​ ​w​h​i​c​h​ ​c​o​m​m​e​n​t​ ​t​e​x​t​ ​s​h​o​u​l​d​ ​b​e​ ​r​e​t​u​r​n​e​d​:​ ​H​T​M​L​ ​o​r​ ​p​l​a​i​n​ ​t​e​x​t - */ - longDesc: string - } - maxResults: { - /** - * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s - */ - displayName: string - /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​m​e​n​t​s​ ​t​o​ ​r​e​t​u​r​n - */ - shortDesc: string - /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​2​0​) - */ - longDesc: string - } - pageToken: { + id: { /** - * P​a​g​e​ ​T​o​k​e​n + * C​o​n​t​a​c​t​ ​I​D */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​a​g​e​ ​o​f​ ​c​o​m​m​e​n​t​s + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ longDesc: string } } } - list_user_videos: { + get_deal: { groups: { /** - * V​i​d​e​o​s + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ '0': string } /** - * L​i​s​t​ ​U​s​e​r​ ​V​i​d​e​o​s + * G​e​t​ ​D​e​a​l */ displayName: string /** - * G​e​t​ ​l​i​s​t​ ​o​f​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​'​s​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​s + * R​e​t​r​i​e​v​e​ ​d​e​a​l​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​v​i​d​e​o​s​ ​u​p​l​o​a​d​e​d​ ​b​y​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​ ​t​o​ ​t​h​e​i​r​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - maxResults: { + id: { /** - * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s + * D​e​a​l​ ​I​D */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​v​i​d​e​o​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​v​i​d​e​o​s​ ​t​o​ ​r​e​t​u​r​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​1​0​) + * S​e​l​e​c​t​ ​t​h​e​ ​d​e​a​l​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ longDesc: string } - nextPageToken: { + } + } + get_form: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * G​e​t​ ​F​o​r​m + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​f​o​r​m​ ​d​e​t​a​i​l​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​f​o​r​m​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​i​n​c​l​u​d​i​n​g​ ​s​t​y​l​i​n​g​ ​a​n​d​ ​f​i​e​l​d​ ​c​o​n​f​i​g​u​r​a​t​i​o​n + */ + longDesc: string + options: { + id: { /** - * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n + * F​o​r​m​ ​I​D */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​f​o​r​m​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​v​i​d​e​o​s + * S​e​l​e​c​t​ ​t​h​e​ ​f​o​r​m​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ longDesc: string } } } - reply_to_comment: { + get_list: { groups: { /** - * C​o​m​m​e​n​t​s + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ '0': string } /** - * C​r​e​a​t​e​ ​o​r​ ​R​e​p​l​y​ ​t​o​ ​C​o​m​m​e​n​t + * G​e​t​ ​L​i​s​t */ displayName: string /** - * R​e​p​l​y​ ​t​o​ ​a​ ​Y​o​u​T​u​b​e​ ​c​o​m​m​e​n​t​ ​o​r​ ​c​r​e​a​t​e​ ​o​n​e + * R​e​t​r​i​e​v​e​ ​l​i​s​t​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * P​o​s​t​ ​a​ ​r​e​p​l​y​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​o​r​ ​c​r​e​a​t​e​ ​a​ ​n​e​w​ ​o​n​e​ ​o​n​ ​a​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​i​n​c​l​u​d​i​n​g​ ​s​e​t​t​i​n​g​s​ ​a​n​d​ ​c​o​n​f​i​g​u​r​a​t​i​o​n */ longDesc: string options: { - parentId: { + id: { /** - * P​a​r​e​n​t​ ​C​o​m​m​e​n​t​ ​I​D + * L​i​s​t​ ​I​D */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​o​r​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​t​o​ ​r​e​p​l​y​ ​t​o + * S​e​l​e​c​t​ ​t​h​e​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ longDesc: string } - textOriginal: { + } + } + get_task: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * G​e​t​ ​T​a​s​k + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​t​a​s​k​ ​d​e​t​a​i​l​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​ ​t​a​s​k​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + */ + longDesc: string + options: { + id: { /** - * R​e​p​l​y​ ​T​e​x​t + * T​a​s​k​ ​I​D */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​r​e​p​l​y + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​t​a​s​k​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​r​e​p​l​y​ ​t​o​ ​t​h​e​ ​c​o​m​m​e​n​t + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ longDesc: string } } } - update_video_details: { + get_user: { groups: { /** - * V​i​d​e​o​s + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ '0': string } /** - * U​p​d​a​t​e​ ​V​i​d​e​o​ ​D​e​t​a​i​l​s + * G​e​t​ ​U​s​e​r */ displayName: string /** - * U​p​d​a​t​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o + * R​e​t​r​i​e​v​e​ ​u​s​e​r​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​m​e​t​a​d​a​t​a​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​i​n​c​l​u​d​i​n​g​ ​t​i​t​l​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​p​r​o​p​e​r​t​i​e​s + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​u​s​e​r​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - title: { + id: { /** - * T​i​t​l​e + * U​s​e​r​ ​I​D */ displayName: string /** - * N​e​w​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​u​s​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​e​w​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​(​l​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​k​e​e​p​ ​c​u​r​r​e​n​t​ ​t​i​t​l​e​) + * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ longDesc: string } - video: { + } + } + list_accounts: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * L​i​s​t​ ​A​c​c​o​u​n​t​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​c​c​o​u​n​t​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​a​n​d​ ​f​i​l​t​e​r​i​n​g + */ + longDesc: string + options: { + search: { /** - * V​i​d​e​o + * S​e​a​r​c​h */ displayName: string /** - * T​h​e​ ​v​i​d​e​o​ ​t​o​ ​u​p​d​a​t​e + * S​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​a​c​c​o​u​n​t​s */ shortDesc: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​u​p​d​a​t​e + * S​e​a​r​c​h​ ​f​o​r​ ​a​c​c​o​u​n​t​s​ ​b​y​ ​n​a​m​e​ ​o​r​ ​o​t​h​e​r​ ​s​e​a​r​c​h​a​b​l​e​ ​f​i​e​l​d​s */ longDesc: string } - category: { + count_deals: { /** - * C​a​t​e​g​o​r​y + * C​o​u​n​t​ ​D​e​a​l​s */ displayName: string /** - * V​i​d​e​o​ ​c​a​t​e​g​o​r​y + * I​n​c​l​u​d​e​ ​d​e​a​l​ ​c​o​u​n​t​ ​f​o​r​ ​e​a​c​h​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​e​w​ ​c​a​t​e​g​o​r​y​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​(​n​u​m​e​r​i​c​ ​c​a​t​e​g​o​r​y​ ​I​D​) + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​e​a​c​h​ ​a​c​c​o​u​n​t​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e */ longDesc: string } - privacy: { + limit: { /** - * P​r​i​v​a​c​y​ ​S​t​a​t​u​s + * L​i​m​i​t */ displayName: string /** - * P​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​e​w​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​:​ ​p​u​b​l​i​c​,​ ​p​r​i​v​a​t​e​,​ ​o​r​ ​u​n​l​i​s​t​e​d + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - description: { + offset: { /** - * D​e​s​c​r​i​p​t​i​o​n + * O​f​f​s​e​t */ displayName: string /** - * N​e​w​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o + * N​u​m​b​e​r​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​e​w​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​(​l​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​k​e​e​p​ ​c​u​r​r​e​n​t​ ​d​e​s​c​r​i​p​t​i​o​n​) + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​a​c​c​o​u​n​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } - forKids: { + } + } + list_campaigns: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * L​i​s​t​ ​C​a​m​p​a​i​g​n​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​m​p​a​i​g​n​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n + */ + longDesc: string + options: { + limit: { /** - * M​a​d​e​ ​f​o​r​ ​K​i​d​s + * L​i​m​i​t */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​h​e​ ​v​i​d​e​o​ ​i​s​ ​m​a​d​e​ ​f​o​r​ ​k​i​d​s + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​s​e​t​t​i​n​g​ ​t​o​ ​i​n​d​i​c​a​t​e​ ​i​f​ ​t​h​e​ ​v​i​d​e​o​ ​i​s​ ​s​p​e​c​i​f​i​c​a​l​l​y​ ​m​a​d​e​ ​f​o​r​ ​c​h​i​l​d​r​e​n + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - tags: { + offset: { /** - * T​a​g​s + * O​f​f​s​e​t */ displayName: string /** - * L​i​s​t​ ​o​f​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o + * N​u​m​b​e​r​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​l​i​s​t​ ​o​f​ ​t​a​g​s​/​k​e​y​w​o​r​d​s​ ​t​o​ ​h​e​l​p​ ​c​a​t​e​g​o​r​i​z​e​ ​t​h​e​ ​v​i​d​e​o + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​m​p​a​i​g​n​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } } } - upload_video: { + list_contacts: { groups: { /** - * V​i​d​e​o​s + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ '0': string } /** - * U​p​l​o​a​d​ ​V​i​d​e​o + * L​i​s​t​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * U​p​l​o​a​d​ ​a​ ​v​i​d​e​o​ ​t​o​ ​Y​o​u​T​u​b​e + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​s */ shortDesc: string /** - * U​p​l​o​a​d​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​t​o​ ​Y​o​u​T​u​b​e​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​m​e​t​a​d​a​t​a​ ​i​n​c​l​u​d​i​n​g​ ​t​i​t​l​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​c​a​t​e​g​o​r​y + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​e​x​t​e​n​s​i​v​e​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s */ longDesc: string options: { - title: { + email: { /** - * T​i​t​l​e + * E​m​a​i​l */ displayName: string /** - * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​v​i​d​e​o + * E​x​a​c​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r */ shortDesc: string /** - * T​h​e​ ​t​i​t​l​e​/​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​b​e​i​n​g​ ​u​p​l​o​a​d​e​d + * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​e​x​a​c​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​m​a​t​c​h */ longDesc: string } - video: { + email_like: { /** - * V​i​d​e​o​ ​F​i​l​e + * E​m​a​i​l​ ​L​i​k​e */ displayName: string /** - * T​h​e​ ​v​i​d​e​o​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d + * P​a​r​t​i​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r */ shortDesc: string /** - * T​h​e​ ​v​i​d​e​o​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d​ ​t​o​ ​Y​o​u​T​u​b​e + * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​p​a​r​t​i​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​m​a​t​c​h */ longDesc: string } - category: { + phone: { /** - * C​a​t​e​g​o​r​y + * P​h​o​n​e */ displayName: string /** - * V​i​d​e​o​ ​c​a​t​e​g​o​r​y + * P​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r */ shortDesc: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​a​t​e​g​o​r​y​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​(​n​u​m​e​r​i​c​ ​c​a​t​e​g​o​r​y​ ​I​D​) + * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ longDesc: string } - privacy: { + search: { /** - * P​r​i​v​a​c​y​ ​S​t​a​t​u​s + * S​e​a​r​c​h */ displayName: string /** - * P​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o + * G​e​n​e​r​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m */ shortDesc: string /** - * P​r​i​v​a​c​y​ ​l​e​v​e​l​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​:​ ​p​u​b​l​i​c​ ​(​v​i​s​i​b​l​e​ ​t​o​ ​e​v​e​r​y​o​n​e​)​,​ ​p​r​i​v​a​t​e​ ​(​o​n​l​y​ ​v​i​s​i​b​l​e​ ​t​o​ ​y​o​u​)​,​ ​o​r​ ​u​n​l​i​s​t​e​d​ ​(​v​i​s​i​b​l​e​ ​t​o​ ​a​n​y​o​n​e​ ​w​i​t​h​ ​t​h​e​ ​l​i​n​k​) + * S​e​a​r​c​h​ ​f​o​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​n​a​m​e​,​ ​e​m​a​i​l​,​ ​o​r​ ​o​t​h​e​r​ ​s​e​a​r​c​h​a​b​l​e​ ​f​i​e​l​d​s */ longDesc: string } - description: { + status: { /** - * D​e​s​c​r​i​p​t​i​o​n + * S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​v​i​d​e​o + * C​o​n​t​a​c​t​ ​s​t​a​t​u​s​ ​f​i​l​t​e​r */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​e​x​p​l​a​i​n​i​n​g​ ​i​t​s​ ​c​o​n​t​e​n​t + * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​t​h​e​i​r​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​s​t​a​t​u​s */ longDesc: string } - forKids: { + formid: { /** - * M​a​d​e​ ​f​o​r​ ​K​i​d​s + * F​o​r​m​ ​I​D */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​h​e​ ​v​i​d​e​o​ ​i​s​ ​m​a​d​e​ ​f​o​r​ ​k​i​d​s + * F​i​l​t​e​r​ ​b​y​ ​f​o​r​m​ ​s​u​b​s​c​r​i​p​t​i​o​n */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​s​e​t​t​i​n​g​ ​t​o​ ​i​n​d​i​c​a​t​e​ ​i​f​ ​t​h​e​ ​v​i​d​e​o​ ​i​s​ ​s​p​e​c​i​f​i​c​a​l​l​y​ ​m​a​d​e​ ​f​o​r​ ​c​h​i​l​d​r​e​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​f​a​l​s​e​) + * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​w​h​o​ ​s​u​b​s​c​r​i​b​e​d​ ​t​h​r​o​u​g​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​f​o​r​m */ longDesc: string } - tags: { + listid: { /** - * T​a​g​s + * L​i​s​t​ ​I​D */ displayName: string /** - * L​i​s​t​ ​o​f​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o + * F​i​l​t​e​r​ ​b​y​ ​l​i​s​t​ ​m​e​m​b​e​r​s​h​i​p */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​l​i​s​t​ ​o​f​ ​t​a​g​s​/​k​e​y​w​o​r​d​s​ ​t​o​ ​h​e​l​p​ ​c​a​t​e​g​o​r​i​z​e​ ​a​n​d​ ​m​a​k​e​ ​t​h​e​ ​v​i​d​e​o​ ​d​i​s​c​o​v​e​r​a​b​l​e + * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​w​h​o​ ​a​r​e​ ​m​e​m​b​e​r​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t */ longDesc: string } - } - } - } - triggers: { - new_channel_video: { - /** - * N​e​w​ ​C​h​a​n​n​e​l​ ​V​i​d​e​o - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​i​s​ ​u​p​l​o​a​d​e​d​ ​t​o​ ​a​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​ ​u​p​l​o​a​d​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​i​s​ ​d​e​t​e​c​t​e​d​ ​i​n​ ​t​h​e​ ​c​h​a​n​n​e​l​'​s​ ​u​p​l​o​a​d​s​ ​p​l​a​y​l​i​s​t​. - */ - longDesc: string - options: { - channel_url: { - /** - * C​h​a​n​n​e​l​ ​U​R​L - */ - displayName: string - /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​U​R​L​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​s - */ - shortDesc: string - /** - * E​n​t​e​r​ ​t​h​e​ ​f​u​l​l​ ​U​R​L​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​ ​u​p​l​o​a​d​s - */ - longDesc: string - } - channel: { + sort: { /** - * C​h​a​n​n​e​l + * S​o​r​t​ ​O​p​t​i​o​n​s */ displayName: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r + * S​o​r​t​i​n​g​ ​c​o​n​f​i​g​u​r​a​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​ ​u​p​l​o​a​d​s + * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​r​e​s​u​l​t​s */ longDesc: string + type: { + fields: { + field: { + /** + * S​o​r​t​ ​F​i​e​l​d + */ + displayName: string + /** + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y + */ + shortDesc: string + /** + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​t​h​e​ ​c​o​n​t​a​c​t​s + */ + longDesc: string + } + order: { + /** + * S​o​r​t​ ​O​r​d​e​r + */ + displayName: string + /** + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n + */ + shortDesc: string + /** + * W​h​e​t​h​e​r​ ​t​o​ ​s​o​r​t​ ​i​n​ ​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​ ​o​r​d​e​r + */ + longDesc: string + } + } + } } - } - } - new_livestream: { - /** - * N​e​w​ ​L​i​v​e​s​t​r​e​a​m - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​l​i​v​e​s​t​r​e​a​m​ ​s​t​a​r​t​s - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​ ​l​i​v​e​ ​s​t​r​e​a​m​s​ ​t​h​a​t​ ​a​r​e​ ​c​u​r​r​e​n​t​l​y​ ​b​r​o​a​d​c​a​s​t​i​n​g​.​ ​C​a​n​ ​m​o​n​i​t​o​r​ ​a​l​l​ ​l​i​v​e​ ​s​t​r​e​a​m​s​ ​o​r​ ​f​i​l​t​e​r​ ​b​y​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​. - */ - longDesc: string - options: { - channel_url: { + limit: { /** - * C​h​a​n​n​e​l​ ​U​R​L + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​U​R​L​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​l​i​v​e​s​t​r​e​a​m​s + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​f​u​l​l​ ​U​R​L​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​l​i​v​e​s​t​r​e​a​m​s + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - channel: { + offset: { /** - * C​h​a​n​n​e​l + * O​f​f​s​e​t */ displayName: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​l​i​v​e​s​t​r​e​a​m​s + * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​l​i​v​e​s​t​r​e​a​m​s​ ​b​y​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​a​l​l​ ​l​i​v​e​s​t​r​e​a​m​s​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } } } - new_playlist_video: { + list_deals: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } /** - * N​e​w​ ​P​l​a​y​l​i​s​t​ ​V​i​d​e​o + * L​i​s​t​ ​D​e​a​l​s */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​p​l​a​y​l​i​s​t + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​s */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​s​ ​b​e​i​n​g​ ​a​d​d​e​d​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​i​s​ ​d​e​t​e​c​t​e​d​. + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​f​u​n​c​t​i​o​n​a​l​i​t​y */ longDesc: string options: { - playlist: { + limit: { /** - * P​l​a​y​l​i​s​t​ ​I​D + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​I​D​ ​t​o​ ​m​o​n​i​t​o​r + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​I​D​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​s​ ​b​e​i​n​g​ ​a​d​d​e​d + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - } - } - new_video_by_search: { - /** - * N​e​w​ ​V​i​d​e​o​ ​b​y​ ​S​e​a​r​c​h - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​n​e​w​ ​v​i​d​e​o​s​ ​m​a​t​c​h​ ​a​ ​s​e​a​r​c​h​ ​q​u​e​r​y - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​Y​o​u​T​u​b​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​q​u​e​r​y​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​n​e​w​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​t​h​e​ ​s​e​a​r​c​h​ ​t​e​r​m​s​ ​a​r​e​ ​f​o​u​n​d​. - */ - longDesc: string - options: { - query: { + offset: { /** - * S​e​a​r​c​h​ ​Q​u​e​r​y + * O​f​f​s​e​t */ displayName: string /** - * T​h​e​ ​s​e​a​r​c​h​ ​t​e​r​m​s​ ​t​o​ ​m​o​n​i​t​o​r + * N​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * Y​o​u​r​ ​r​e​q​u​e​s​t​ ​c​a​n​ ​a​l​s​o​ ​u​s​e​ ​t​h​e​ ​B​o​o​l​e​a​n​ ​N​O​T​ ​(​-​)​ ​a​n​d​ ​O​R​ ​(​|​)​ ​o​p​e​r​a​t​o​r​s​ ​t​o​ ​e​x​c​l​u​d​e​ ​v​i​d​e​o​s​ ​o​r​ ​t​o​ ​f​i​n​d​ ​v​i​d​e​o​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​o​n​e​ ​o​f​ ​s​e​v​e​r​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m​s​.​ ​F​o​r​ ​e​x​a​m​p​l​e​,​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​e​i​t​h​e​r​ ​"​b​o​a​t​i​n​g​"​ ​o​r​ ​"​s​a​i​l​i​n​g​"​,​ ​s​e​t​ ​t​h​e​ ​q​ ​p​a​r​a​m​e​t​e​r​ ​v​a​l​u​e​ ​t​o​ ​b​o​a​t​i​n​g​|​s​a​i​l​i​n​g​.​ ​S​i​m​i​l​a​r​l​y​,​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​e​i​t​h​e​r​ ​"​b​o​a​t​i​n​g​"​ ​o​r​ ​"​s​a​i​l​i​n​g​"​ ​b​u​t​ ​n​o​t​ ​"​f​i​s​h​i​n​g​"​,​ ​s​e​t​ ​t​h​e​ ​q​ ​p​a​r​a​m​e​t​e​r​ ​v​a​l​u​e​ ​t​o​ ​b​o​a​t​i​n​g​|​s​a​i​l​i​n​g​ ​-​f​i​s​h​i​n​g​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } - } - } - new_video_comment: { - /** - * N​e​w​ ​V​i​d​e​o​ ​C​o​m​m​e​n​t - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​i​s​ ​p​o​s​t​e​d​ ​o​n​ ​a​ ​v​i​d​e​o - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​i​s​ ​d​e​t​e​c​t​e​d​. - */ - longDesc: string - options: { - video: { + search: { /** - * V​i​d​e​o + * S​e​a​r​c​h​ ​O​p​t​i​o​n​s */ displayName: string /** - * T​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​m​e​n​t​s + * S​e​a​r​c​h​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​f​o​r​ ​d​e​a​l​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s + * C​o​n​f​i​g​u​r​e​ ​h​o​w​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​d​e​a​l​s​ ​b​y​ ​d​i​f​f​e​r​e​n​t​ ​f​i​e​l​d​s */ longDesc: string + type: { + fields: { + field: { + /** + * S​e​a​r​c​h​ ​F​i​e​l​d + */ + displayName: string + /** + * F​i​e​l​d​ ​t​o​ ​s​e​a​r​c​h​ ​i​n + */ + shortDesc: string + /** + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​e​a​r​c​h​ ​i​n​ ​(​t​i​t​l​e​,​ ​c​o​n​t​a​c​t​,​ ​o​r​g​a​n​i​z​a​t​i​o​n​,​ ​o​r​ ​a​l​l​) + */ + longDesc: string + } + value: { + /** + * S​e​a​r​c​h​ ​V​a​l​u​e + */ + displayName: string + /** + * V​a​l​u​e​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r + */ + shortDesc: string + /** + * T​h​e​ ​s​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​l​o​o​k​ ​f​o​r​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​f​i​e​l​d + */ + longDesc: string + } + } + } } } } - } - } - Canva: { - /** - * C​a​n​v​a - */ - displayName: string - groups: { - /** - * D​e​s​i​g​n​ ​&​ ​C​r​e​a​t​i​v​e​ ​T​o​o​l​s - */ - '0': string - } - /** - * D​e​s​i​g​n​ ​p​l​a​t​f​o​r​m​ ​f​o​r​ ​c​r​e​a​t​i​n​g​ ​g​r​a​p​h​i​c​s​,​ ​p​r​e​s​e​n​t​a​t​i​o​n​s​,​ ​a​n​d​ ​v​i​s​u​a​l​ ​c​o​n​t​e​n​t - */ - shortDesc: string - /** - * C​a​n​v​a​ ​i​s​ ​a​ ​g​r​a​p​h​i​c​ ​d​e​s​i​g​n​ ​p​l​a​t​f​o​r​m​ ​t​h​a​t​ ​a​l​l​o​w​s​ ​u​s​e​r​s​ ​t​o​ ​c​r​e​a​t​e​ ​s​o​c​i​a​l​ ​m​e​d​i​a​ ​g​r​a​p​h​i​c​s​,​ ​p​r​e​s​e​n​t​a​t​i​o​n​s​,​ ​p​o​s​t​e​r​s​,​ ​d​o​c​u​m​e​n​t​s​ ​a​n​d​ ​o​t​h​e​r​ ​v​i​s​u​a​l​ ​c​o​n​t​e​n​t​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​a​ ​d​r​a​g​-​a​n​d​-​d​r​o​p​ ​i​n​t​e​r​f​a​c​e​ ​a​n​d​ ​a​c​c​e​s​s​ ​t​o​ ​m​i​l​l​i​o​n​s​ ​o​f​ ​p​h​o​t​o​g​r​a​p​h​s​,​ ​g​r​a​p​h​i​c​s​ ​a​n​d​ ​f​o​n​t​s​. - */ - longDesc: string - actions: { - upload_image: { + list_deal_stages: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } /** - * U​p​l​o​a​d​ ​I​m​a​g​e + * L​i​s​t​ ​D​e​a​l​ ​S​t​a​g​e​s */ displayName: string /** - * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​C​a​n​v​a + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​ ​s​t​a​g​e​s */ shortDesc: string /** - * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t​ ​a​n​d​ ​o​p​t​i​o​n​a​l​l​y​ ​s​e​t​ ​a​ ​n​a​m​e​ ​a​n​d​ ​t​a​g​s + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​ ​s​t​a​g​e​s​ ​(​p​i​p​e​l​i​n​e​ ​s​t​a​g​e​s​)​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - image: { + title: { /** - * I​m​a​g​e​ ​F​i​l​e + * T​i​t​l​e */ displayName: string /** - * T​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d + * F​i​l​t​e​r​ ​b​y​ ​s​t​a​g​e​ ​t​i​t​l​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​a​n​ ​i​m​a​g​e​ ​f​i​l​e​ ​f​r​o​m​ ​y​o​u​r​ ​d​e​v​i​c​e​ ​t​o​ ​u​p​l​o​a​d​ ​t​o​ ​C​a​n​v​a + * F​i​l​t​e​r​ ​d​e​a​l​ ​s​t​a​g​e​s​ ​b​y​ ​t​h​e​i​r​ ​t​i​t​l​e */ longDesc: string } - name: { + limit: { /** - * N​a​m​e + * L​i​m​i​t */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​t​a​g​e​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * S​e​t​ ​a​ ​c​u​s​t​o​m​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​u​p​l​o​a​d​e​d​ ​i​m​a​g​e​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​t​h​e​ ​o​r​i​g​i​n​a​l​ ​f​i​l​e​n​a​m​e​ ​w​i​l​l​ ​b​e​ ​u​s​e​d + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​ ​s​t​a​g​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - tags: { + offset: { /** - * T​a​g​s + * O​f​f​s​e​t */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e + * N​u​m​b​e​r​ ​o​f​ ​s​t​a​g​e​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * A​d​d​ ​t​a​g​s​ ​t​o​ ​h​e​l​p​ ​o​r​g​a​n​i​z​e​ ​a​n​d​ ​f​i​n​d​ ​y​o​u​r​ ​i​m​a​g​e​ ​l​a​t​e​r + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​ ​s​t​a​g​e​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } } } - get_image: { + list_forms: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } /** - * G​e​t​ ​I​m​a​g​e + * L​i​s​t​ ​F​o​r​m​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​i​m​a​g​e​ ​d​e​t​a​i​l​s​ ​f​r​o​m​ ​C​a​n​v​a + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​f​o​r​m​s */ shortDesc: string /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​i​m​a​g​e​ ​a​s​s​e​t​ ​i​n​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​f​o​r​m​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - id: { + limit: { /** - * I​m​a​g​e​ ​I​D + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​m​a​g​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​r​m​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​C​a​n​v​a​ ​a​s​s​e​t​ ​I​D​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​r​m​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - } - } - delete_image: { - /** - * D​e​l​e​t​e​ ​I​m​a​g​e - */ - displayName: string - /** - * D​e​l​e​t​e​ ​a​n​ ​i​m​a​g​e​ ​f​r​o​m​ ​C​a​n​v​a - */ - shortDesc: string - /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​n​ ​i​m​a​g​e​ ​a​s​s​e​t​ ​f​r​o​m​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t - */ - longDesc: string - options: { - id: { + offset: { /** - * I​m​a​g​e​ ​I​D + * O​f​f​s​e​t */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​t​o​ ​d​e​l​e​t​e + * N​u​m​b​e​r​ ​o​f​ ​f​o​r​m​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * T​h​e​ ​C​a​n​v​a​ ​a​s​s​e​t​ ​I​D​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​r​m​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } } } - update_image: { + list_lists: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } /** - * U​p​d​a​t​e​ ​I​m​a​g​e + * L​i​s​t​ ​L​i​s​t​s */ displayName: string /** - * U​p​d​a​t​e​ ​i​m​a​g​e​ ​n​a​m​e​ ​a​n​d​ ​t​a​g​s + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​l​i​s​t​s */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​n​a​m​e​ ​a​n​d​ ​t​a​g​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​i​m​a​g​e​ ​i​n​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​n​a​m​e​ ​f​i​l​t​e​r​i​n​g */ longDesc: string options: { - id: { + limit: { /** - * I​m​a​g​e​ ​I​D + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​m​a​g​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​C​a​n​v​a​ ​a​s​s​e​t​ ​I​D​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - name: { + offset: { /** - * N​a​m​e + * O​f​f​s​e​t */ displayName: string /** - * N​e​w​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e + * N​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​a​s​s​e​t + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } - tags: { + name: { /** - * T​a​g​s + * N​a​m​e */ displayName: string /** - * N​e​w​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e + * F​i​l​t​e​r​ ​b​y​ ​l​i​s​t​ ​n​a​m​e */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​t​a​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​i​m​a​g​e​ ​f​o​r​ ​b​e​t​t​e​r​ ​o​r​g​a​n​i​z​a​t​i​o​n + * F​i​l​t​e​r​ ​l​i​s​t​s​ ​b​y​ ​t​h​e​i​r​ ​n​a​m​e */ longDesc: string } } } - upload_image_by_url: { + list_tags: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } /** - * U​p​l​o​a​d​ ​I​m​a​g​e​ ​b​y​ ​U​R​L + * L​i​s​t​ ​T​a​g​s */ displayName: string /** - * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e​ ​f​r​o​m​ ​a​ ​U​R​L​ ​t​o​ ​C​a​n​v​a + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​t​a​g​s */ shortDesc: string /** - * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e​ ​t​o​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t​ ​b​y​ ​p​r​o​v​i​d​i​n​g​ ​a​ ​U​R​L​ ​t​o​ ​t​h​e​ ​i​m​a​g​e + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​t​a​g​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​f​u​n​c​t​i​o​n​a​l​i​t​y */ longDesc: string options: { - url: { + limit: { /** - * I​m​a​g​e​ ​U​R​L + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​U​R​L​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​t​o​ ​u​p​l​o​a​d + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​g​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * P​r​o​v​i​d​e​ ​a​ ​d​i​r​e​c​t​ ​U​R​L​ ​t​o​ ​t​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​l​o​a​d​ ​t​o​ ​C​a​n​v​a + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​g​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - name: { + offset: { /** - * N​a​m​e + * O​f​f​s​e​t */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e + * N​u​m​b​e​r​ ​o​f​ ​t​a​g​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * S​e​t​ ​a​ ​c​u​s​t​o​m​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​u​p​l​o​a​d​e​d​ ​i​m​a​g​e​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​t​h​e​ ​f​i​l​e​n​a​m​e​ ​f​r​o​m​ ​t​h​e​ ​U​R​L​ ​w​i​l​l​ ​b​e​ ​u​s​e​d + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​g​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } - tags: { + search: { /** - * T​a​g​s + * S​e​a​r​c​h */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e + * S​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​t​a​g​s */ shortDesc: string /** - * A​d​d​ ​t​a​g​s​ ​t​o​ ​h​e​l​p​ ​o​r​g​a​n​i​z​e​ ​a​n​d​ ​f​i​n​d​ ​y​o​u​r​ ​i​m​a​g​e​ ​l​a​t​e​r + * S​e​a​r​c​h​ ​f​o​r​ ​t​a​g​s​ ​b​y​ ​n​a​m​e​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n */ longDesc: string } } } - list_designs: { + list_tasks: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } /** - * L​i​s​t​ ​D​e​s​i​g​n​s + * L​i​s​t​ ​T​a​s​k​s */ displayName: string /** - * L​i​s​t​ ​y​o​u​r​ ​C​a​n​v​a​ ​d​e​s​i​g​n​s + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​t​a​s​k​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​y​o​u​r​ ​C​a​n​v​a​ ​d​e​s​i​g​n​s​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​s​o​r​t​i​n​g + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​d​e​a​l​ ​t​a​s​k​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s */ longDesc: string options: { - query: { + limit: { /** - * S​e​a​r​c​h​ ​Q​u​e​r​y + * L​i​m​i​t */ displayName: string /** - * S​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​d​e​s​i​g​n​s + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * E​n​t​e​r​ ​a​ ​s​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​n​d​ ​s​p​e​c​i​f​i​c​ ​d​e​s​i​g​n​s​ ​b​y​ ​t​i​t​l​e​ ​o​r​ ​c​o​n​t​e​n​t + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - continuation: { + offset: { /** - * C​o​n​t​i​n​u​a​t​i​o​n​ ​T​o​k​e​n + * O​f​f​s​e​t */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * N​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * U​s​e​ ​t​h​i​s​ ​t​o​k​e​n​ ​t​o​ ​c​o​n​t​i​n​u​e​ ​f​r​o​m​ ​w​h​e​r​e​ ​t​h​e​ ​p​r​e​v​i​o​u​s​ ​r​e​q​u​e​s​t​ ​l​e​f​t​ ​o​f​f + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } - ownership: { + assignee: { /** - * O​w​n​e​r​s​h​i​p​ ​F​i​l​t​e​r + * A​s​s​i​g​n​e​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​o​w​n​e​r​s​h​i​p​ ​t​y​p​e + * F​i​l​t​e​r​ ​b​y​ ​t​a​s​k​ ​a​s​s​i​g​n​e​e */ shortDesc: string /** - * C​h​o​o​s​e​ ​w​h​e​t​h​e​r​ ​t​o​ ​s​h​o​w​ ​a​l​l​ ​d​e​s​i​g​n​s​,​ ​o​n​l​y​ ​o​w​n​e​d​ ​d​e​s​i​g​n​s​,​ ​o​r​ ​o​n​l​y​ ​s​h​a​r​e​d​ ​d​e​s​i​g​n​s + * F​i​l​t​e​r​ ​t​a​s​k​s​ ​b​y​ ​t​h​e​ ​u​s​e​r​ ​t​h​e​y​ ​a​r​e​ ​a​s​s​i​g​n​e​d​ ​t​o */ longDesc: string } - sort_by: { + userid: { /** - * S​o​r​t​ ​B​y + * U​s​e​r​ ​I​D */ displayName: string /** - * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s + * F​i​l​t​e​r​ ​b​y​ ​t​a​s​k​ ​c​r​e​a​t​o​r */ shortDesc: string /** - * C​h​o​o​s​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​t​u​r​n​e​d​ ​d​e​s​i​g​n​s​ ​l​i​s​t + * F​i​l​t​e​r​ ​t​a​s​k​s​ ​b​y​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​c​r​e​a​t​e​d​ ​t​h​e​m + */ + longDesc: string + } + title: { + /** + * T​i​t​l​e + */ + displayName: string + /** + * F​i​l​t​e​r​ ​b​y​ ​t​a​s​k​ ​t​i​t​l​e + */ + shortDesc: string + /** + * F​i​l​t​e​r​ ​t​a​s​k​s​ ​b​y​ ​t​h​e​i​r​ ​t​i​t​l​e */ longDesc: string } } } - create_thread: { + list_users: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } /** - * C​r​e​a​t​e​ ​C​o​m​m​e​n​t​ ​T​h​r​e​a​d + * L​i​s​t​ ​U​s​e​r​s */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​d​e​s​i​g​n + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​u​s​e​r​s */ shortDesc: string /** - * S​t​a​r​t​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​t​o​ ​c​o​l​l​a​b​o​r​a​t​e​ ​w​i​t​h​ ​t​e​a​m​ ​m​e​m​b​e​r​s + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​u​s​e​r​s​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - design: { - /** - * D​e​s​i​g​n - */ - displayName: string - /** - * T​h​e​ ​d​e​s​i​g​n​ ​t​o​ ​c​o​m​m​e​n​t​ ​o​n - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d - */ - longDesc: string - } - message: { + limit: { /** - * M​e​s​s​a​g​e + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​c​o​m​m​e​n​t​ ​m​e​s​s​a​g​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​c​o​m​m​e​n​t + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​2​0​) */ longDesc: string } - assignee: { + offset: { /** - * A​s​s​i​g​n​e​e + * O​f​f​s​e​t */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​p​e​r​s​o​n​ ​t​o​ ​a​s​s​i​g​n​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​o + * N​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * A​s​s​i​g​n​ ​t​h​i​s​ ​c​o​m​m​e​n​t​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​e​a​m​ ​m​e​m​b​e​r​ ​f​o​r​ ​a​c​t​i​o​n + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ longDesc: string } } } - create_reply: { + remove_tag_from_contact: { + groups: { + /** + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } /** - * C​r​e​a​t​e​ ​R​e​p​l​y + * R​e​m​o​v​e​ ​T​a​g​ ​f​r​o​m​ ​C​o​n​t​a​c​t */ displayName: string /** - * R​e​p​l​y​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d + * R​e​m​o​v​e​ ​a​ ​t​a​g​ ​f​r​o​m​ ​a​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * A​d​d​ ​a​ ​r​e​p​l​y​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​C​a​n​v​a​ ​d​e​s​i​g​n + * R​e​m​o​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​a​g​ ​f​r​o​m​ ​a​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - design: { - /** - * D​e​s​i​g​n - */ - displayName: string - /** - * T​h​e​ ​d​e​s​i​g​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​h​r​e​a​d - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d - */ - longDesc: string - } - thread: { + tag: { /** - * T​h​r​e​a​d​ ​I​D + * T​a​g */ displayName: string /** - * T​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​t​o​ ​r​e​p​l​y​ ​t​o + * T​h​e​ ​t​a​g​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​g​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - message: { + contact: { /** - * M​e​s​s​a​g​e + * C​o​n​t​a​c​t */ displayName: string /** - * T​h​e​ ​r​e​p​l​y​ ​m​e​s​s​a​g​e + * T​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​r​e​m​o​v​e​ ​t​h​e​ ​t​a​g​ ​f​r​o​m */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​r​e​p​l​y + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​m​o​v​e​ ​t​h​e​ ​t​a​g​ ​f​r​o​m */ longDesc: string } } } - list_replies: { + update_account: { + groups: { + /** + * A​c​c​o​u​n​t​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } /** - * L​i​s​t​ ​T​h​r​e​a​d​ ​R​e​p​l​i​e​s + * U​p​d​a​t​e​ ​A​c​c​o​u​n​t */ displayName: string /** - * L​i​s​t​ ​r​e​p​l​i​e​s​ ​i​n​ ​a​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​r​e​p​l​i​e​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​C​a​n​v​a​ ​d​e​s​i​g​n + * U​p​d​a​t​e​ ​t​h​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​a​c​c​o​u​n​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - limit: { - /** - * L​i​m​i​t - */ - displayName: string - /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​p​l​i​e​s​ ​t​o​ ​r​e​t​u​r​n - */ - shortDesc: string - /** - * S​e​t​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​p​l​i​e​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​) - */ - longDesc: string - } - continuation: { + id: { /** - * C​o​n​t​i​n​u​a​t​i​o​n​ ​T​o​k​e​n + * A​c​c​o​u​n​t​ ​I​D */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * U​s​e​ ​t​h​i​s​ ​t​o​k​e​n​ ​t​o​ ​c​o​n​t​i​n​u​e​ ​f​r​o​m​ ​w​h​e​r​e​ ​t​h​e​ ​p​r​e​v​i​o​u​s​ ​r​e​q​u​e​s​t​ ​l​e​f​t​ ​o​f​f + * S​e​l​e​c​t​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e */ longDesc: string } - design: { + name: { /** - * D​e​s​i​g​n + * A​c​c​o​u​n​t​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​d​e​s​i​g​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​h​r​e​a​d + * T​h​e​ ​u​p​d​a​t​e​d​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d + * T​h​e​ ​n​e​w​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​a​c​c​o​u​n​t */ longDesc: string } - thread: { + accountUrl: { /** - * T​h​r​e​a​d​ ​I​D + * A​c​c​o​u​n​t​ ​U​R​L */ displayName: string /** - * T​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​t​o​ ​g​e​t​ ​r​e​p​l​i​e​s​ ​f​r​o​m + * T​h​e​ ​u​p​d​a​t​e​d​ ​w​e​b​s​i​t​e​ ​U​R​L​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​w​h​o​s​e​ ​r​e​p​l​i​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t + * T​h​e​ ​n​e​w​ ​w​e​b​s​i​t​e​ ​U​R​L​ ​o​r​ ​d​o​m​a​i​n​ ​f​o​r​ ​t​h​e​ ​a​c​c​o​u​n​t */ longDesc: string } - } - } - } - triggers: { - new_design: { - /** - * N​e​w​ ​D​e​s​i​g​n - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​s​i​g​n​ ​i​s​ ​c​r​e​a​t​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​s​i​g​n​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t​,​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​o​w​n​e​r​s​h​i​p​ ​a​n​d​ ​s​e​a​r​c​h​ ​q​u​e​r​y - */ - longDesc: string - options: { - query: { + owner: { /** - * S​e​a​r​c​h​ ​Q​u​e​r​y + * A​c​c​o​u​n​t​ ​O​w​n​e​r */ displayName: string /** - * F​i​l​t​e​r​ ​d​e​s​i​g​n​s​ ​b​y​ ​s​e​a​r​c​h​ ​t​e​r​m + * T​h​e​ ​u​p​d​a​t​e​d​ ​o​w​n​e​r​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​w​h​i​c​h​ ​d​e​s​i​g​n​s​ ​t​r​i​g​g​e​r​ ​t​h​e​ ​e​v​e​n​t​.​ ​O​n​l​y​ ​d​e​s​i​g​n​s​ ​m​a​t​c​h​i​n​g​ ​t​h​i​s​ ​q​u​e​r​y​ ​w​i​l​l​ ​t​r​i​g​g​e​r​ ​t​h​e​ ​e​v​e​n​t + * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​t​h​i​s​ ​a​c​c​o​u​n​t */ longDesc: string } - ownership: { + fieldOptions: { /** - * O​w​n​e​r​s​h​i​p​ ​F​i​l​t​e​r + * C​u​s​t​o​m​ ​F​i​e​l​d​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​o​w​n​e​r​s​h​i​p​ ​t​y​p​e + * U​p​d​a​t​e​d​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s​ ​f​o​r​ ​t​h​e​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * C​h​o​o​s​e​ ​w​h​e​t​h​e​r​ ​t​o​ ​m​o​n​i​t​o​r​ ​a​l​l​ ​d​e​s​i​g​n​s​,​ ​o​n​l​y​ ​y​o​u​r​ ​o​w​n​e​d​ ​d​e​s​i​g​n​s​,​ ​o​r​ ​o​n​l​y​ ​s​h​a​r​e​d​ ​d​e​s​i​g​n​s + * U​p​d​a​t​e​ ​v​a​l​u​e​s​ ​f​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​a​c​c​o​u​n​t​s */ longDesc: string } } } - new_thread_reply: { - /** - * N​e​w​ ​T​h​r​e​a​d​ ​R​e​p​l​y - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​r​e​p​l​y​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​s​o​m​e​o​n​e​ ​a​d​d​s​ ​a​ ​n​e​w​ ​r​e​p​l​y​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​C​a​n​v​a​ ​d​e​s​i​g​n - */ - longDesc: string - options: { - design: { - /** - * D​e​s​i​g​n - */ - displayName: string - /** - * T​h​e​ ​d​e​s​i​g​n​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​r​e​p​l​i​e​s - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​r​e​p​l​i​e​s - */ - longDesc: string - } - thread: { - /** - * T​h​r​e​a​d​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​t​o​ ​m​o​n​i​t​o​r - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​r​e​p​l​i​e​s - */ - longDesc: string - } + update_contact: { + groups: { + /** + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string } - } - } - } - Figma: { - /** - * F​i​g​m​a - */ - displayName: string - groups: { - /** - * D​e​s​i​g​n​ ​&​ ​C​r​e​a​t​i​v​e​ ​T​o​o​l​s - */ - '0': string - } - /** - * D​e​s​i​g​n​ ​a​n​d​ ​p​r​o​t​o​t​y​p​i​n​g​ ​p​l​a​t​f​o​r​m​ ​f​o​r​ ​t​e​a​m​s - */ - shortDesc: string - /** - * F​i​g​m​a​ ​i​s​ ​a​ ​c​o​l​l​a​b​o​r​a​t​i​v​e​ ​i​n​t​e​r​f​a​c​e​ ​d​e​s​i​g​n​ ​t​o​o​l​ ​t​h​a​t​ ​a​l​l​o​w​s​ ​t​e​a​m​s​ ​t​o​ ​c​r​e​a​t​e​,​ ​p​r​o​t​o​t​y​p​e​,​ ​a​n​d​ ​c​o​l​l​a​b​o​r​a​t​e​ ​o​n​ ​d​i​g​i​t​a​l​ ​d​e​s​i​g​n​s​ ​i​n​ ​r​e​a​l​-​t​i​m​e​.​ ​C​o​n​n​e​c​t​ ​t​o​ ​a​c​c​e​s​s​ ​f​i​l​e​s​,​ ​c​o​m​m​e​n​t​s​,​ ​p​r​o​j​e​c​t​s​,​ ​a​n​d​ ​t​e​a​m​ ​d​a​t​a​. - */ - longDesc: string - triggers: { - new_file_comment: { /** - * N​e​w​ ​F​i​l​e​ ​C​o​m​m​e​n​t + * U​p​d​a​t​e​ ​C​o​n​t​a​c​t */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​f​i​l​e + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​t​e​a​m​ ​m​e​m​b​e​r​s​ ​a​d​d​ ​f​e​e​d​b​a​c​k​ ​o​r​ ​d​i​s​c​u​s​s​i​o​n​s + * U​p​d​a​t​e​ ​t​h​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n​ ​i​n​c​l​u​d​i​n​g​ ​b​a​s​i​c​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​n​d​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s */ longDesc: string options: { - team: { + id: { /** - * T​e​a​m + * C​o​n​t​a​c​t​ ​I​D */ displayName: string /** - * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e */ longDesc: string } - project: { + email: { /** - * P​r​o​j​e​c​t + * E​m​a​i​l​ ​A​d​d​r​e​s​s */ displayName: string /** - * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​u​p​d​a​t​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​n​e​w​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - key: { + firstName: { /** - * F​i​l​e​ ​K​e​y + * F​i​r​s​t​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​l​e​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​m​e​n​t​s + * T​h​e​ ​u​p​d​a​t​e​d​ ​f​i​r​s​t​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​a​c​t​i​v​i​t​y + * T​h​e​ ​n​e​w​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - } - } - new_file_version: { - /** - * N​e​w​ ​F​i​l​e​ ​V​e​r​s​i​o​n - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​e​r​s​i​o​n​ ​o​f​ ​a​ ​f​i​l​e​ ​i​s​ ​c​r​e​a​t​e​d - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​f​o​r​ ​v​e​r​s​i​o​n​ ​u​p​d​a​t​e​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​n​e​w​ ​v​e​r​s​i​o​n​s​ ​a​r​e​ ​s​a​v​e​d - */ - longDesc: string - options: { - team: { + lastName: { /** - * T​e​a​m + * L​a​s​t​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​u​p​d​a​t​e​d​ ​l​a​s​t​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​n​e​w​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - project: { + phone: { /** - * P​r​o​j​e​c​t + * P​h​o​n​e​ ​N​u​m​b​e​r */ displayName: string /** - * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​u​p​d​a​t​e​d​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e​ ​t​o​ ​m​o​n​i​t​o​r + * T​h​e​ ​n​e​w​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t */ longDesc: string } - key: { + fieldValues: { /** - * F​i​l​e​ ​K​e​y + * C​u​s​t​o​m​ ​F​i​e​l​d​ ​V​a​l​u​e​s */ displayName: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​l​e​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​v​e​r​s​i​o​n​s + * U​p​d​a​t​e​d​ ​v​a​l​u​e​s​ ​f​o​r​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​e​r​s​i​o​n​ ​a​c​t​i​v​i​t​y + * U​p​d​a​t​e​ ​v​a​l​u​e​s​ ​f​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​c​o​n​f​i​g​u​r​e​d​ ​f​o​r​ ​c​o​n​t​a​c​t​s */ longDesc: string } } } - } - actions: { - create_comment: { + update_deal: { + groups: { + /** + * D​e​a​l​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } /** - * C​r​e​a​t​e​ ​C​o​m​m​e​n​t + * U​p​d​a​t​e​ ​D​e​a​l */ displayName: string /** - * A​d​d​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​t​o​ ​a​ ​F​i​g​m​a​ ​f​i​l​e + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​d​e​a​l */ shortDesc: string /** - * P​o​s​t​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​o​r​ ​r​e​p​l​y​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e + * U​p​d​a​t​e​ ​t​h​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​s​a​l​e​s​ ​d​e​a​l​ ​i​n​ ​A​c​t​i​v​e​C​a​m​p​a​i​g​n */ longDesc: string options: { - team: { + id: { /** - * T​e​a​m + * D​e​a​l​ ​I​D */ displayName: string /** - * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e + * S​e​l​e​c​t​ ​t​h​e​ ​d​e​a​l​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e */ longDesc: string } - project: { + title: { /** - * P​r​o​j​e​c​t + * D​e​a​l​ ​T​i​t​l​e */ displayName: string /** - * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​n​e​w​ ​d​e​s​c​r​i​p​t​i​v​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - key: { + account: { /** - * F​i​l​e​ ​K​e​y + * A​c​c​o​u​n​t */ displayName: string /** - * T​h​e​ ​f​i​l​e​ ​t​o​ ​c​o​m​m​e​n​t​ ​o​n + * T​h​e​ ​u​p​d​a​t​e​d​ ​a​c​c​o​u​n​t​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​d​d​ ​a​ ​c​o​m​m​e​n​t + * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​a​c​c​o​u​n​t​/​c​o​m​p​a​n​y​ ​t​h​a​t​ ​t​h​i​s​ ​d​e​a​l​ ​i​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h */ longDesc: string } - message: { + contact: { /** - * M​e​s​s​a​g​e + * C​o​n​t​a​c​t */ displayName: string /** - * T​h​e​ ​c​o​m​m​e​n​t​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t + * T​h​e​ ​u​p​d​a​t​e​d​ ​p​r​i​m​a​r​y​ ​c​o​n​t​a​c​t​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​o​s​t​ ​o​n​ ​t​h​e​ ​F​i​g​m​a​ ​f​i​l​e + * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​m​a​i​n​ ​c​o​n​t​a​c​t​ ​p​e​r​s​o​n​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l */ longDesc: string } - comment_id: { + value: { /** - * P​a​r​e​n​t​ ​C​o​m​m​e​n​t​ ​I​D + * D​e​a​l​ ​V​a​l​u​e */ displayName: string /** - * I​D​ ​o​f​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o​ ​(​o​p​t​i​o​n​a​l​) + * T​h​e​ ​u​p​d​a​t​e​d​ ​m​o​n​e​t​a​r​y​ ​v​a​l​u​e​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​I​D​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o​,​ ​l​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​n​e​w​ ​t​o​p​-​l​e​v​e​l​ ​c​o​m​m​e​n​t + * T​h​e​ ​n​e​w​ ​t​o​t​a​l​ ​v​a​l​u​e​ ​o​r​ ​a​m​o​u​n​t​ ​o​f​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - } - } - list_comments: { - /** - * L​i​s​t​ ​C​o​m​m​e​n​t​s - */ - displayName: string - /** - * L​i​s​t​ ​a​l​l​ ​c​o​m​m​e​n​t​s​ ​o​n​ ​a​ ​F​i​g​m​a​ ​f​i​l​e - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​d​i​s​c​u​s​s​i​o​n​s​ ​o​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​,​ ​i​n​c​l​u​d​i​n​g​ ​u​s​e​r​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​n​d​ ​t​i​m​e​s​t​a​m​p​s - */ - longDesc: string - options: { - team: { + currency: { /** - * T​e​a​m + * C​u​r​r​e​n​c​y */ displayName: string /** - * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​u​p​d​a​t​e​d​ ​c​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​v​a​l​u​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e + * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​c​u​r​r​e​n​c​y​ ​t​h​a​t​ ​t​h​e​ ​d​e​a​l​ ​v​a​l​u​e​ ​i​s​ ​d​e​n​o​m​i​n​a​t​e​d​ ​i​n */ longDesc: string } - project: { + stage: { /** - * P​r​o​j​e​c​t + * D​e​a​l​ ​S​t​a​g​e */ displayName: string /** - * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​u​p​d​a​t​e​d​ ​s​t​a​g​e​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e + * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​p​i​p​e​l​i​n​e​ ​s​t​a​g​e​ ​t​h​a​t​ ​r​e​p​r​e​s​e​n​t​s​ ​t​h​e​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - key: { + group: { /** - * F​i​l​e​ ​K​e​y + * P​i​p​e​l​i​n​e​ ​G​r​o​u​p */ displayName: string /** - * T​h​e​ ​f​i​l​e​ ​t​o​ ​l​i​s​t​ ​c​o​m​m​e​n​t​s​ ​f​r​o​m + * T​h​e​ ​u​p​d​a​t​e​d​ ​p​i​p​e​l​i​n​e​ ​g​r​o​u​p​ ​f​o​r​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​w​h​o​s​e​ ​c​o​m​m​e​n​t​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​p​i​p​e​l​i​n​e​ ​g​r​o​u​p​ ​t​h​a​t​ ​t​h​i​s​ ​d​e​a​l​ ​b​e​l​o​n​g​s​ ​t​o */ longDesc: string } - } - } - list_file_version_history: { - /** - * L​i​s​t​ ​F​i​l​e​ ​V​e​r​s​i​o​n​ ​H​i​s​t​o​r​y - */ - displayName: string - /** - * G​e​t​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​f​o​r​ ​a​ ​F​i​g​m​a​ ​f​i​l​e - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​t​h​e​ ​c​o​m​p​l​e​t​e​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​,​ ​i​n​c​l​u​d​i​n​g​ ​t​i​m​e​s​t​a​m​p​s​,​ ​l​a​b​e​l​s​,​ ​a​n​d​ ​u​s​e​r​ ​i​n​f​o​r​m​a​t​i​o​n - */ - longDesc: string - options: { - team: { + owner: { /** - * T​e​a​m + * D​e​a​l​ ​O​w​n​e​r */ displayName: string /** - * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​u​p​d​a​t​e​d​ ​u​s​e​r​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​t​h​i​s​ ​d​e​a​l */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e + * S​e​l​e​c​t​ ​t​h​e​ ​n​e​w​ ​u​s​e​r​ ​w​h​o​ ​w​i​l​l​ ​b​e​ ​r​e​s​p​o​n​s​i​b​l​e​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​t​h​i​s​ ​d​e​a​l */ longDesc: string } - project: { + percent: { /** - * P​r​o​j​e​c​t + * C​o​m​p​l​e​t​i​o​n​ ​P​e​r​c​e​n​t​a​g​e */ displayName: string /** - * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​u​p​d​a​t​e​d​ ​p​e​r​c​e​n​t​a​g​e​ ​c​o​m​p​l​e​t​i​o​n​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e + * T​h​e​ ​n​e​w​ ​p​e​r​c​e​n​t​a​g​e​ ​v​a​l​u​e​ ​r​e​p​r​e​s​e​n​t​i​n​g​ ​h​o​w​ ​c​l​o​s​e​ ​t​h​e​ ​d​e​a​l​ ​i​s​ ​t​o​ ​c​o​m​p​l​e​t​i​o​n */ longDesc: string } - key: { + description: { /** - * F​i​l​e​ ​K​e​y + * D​e​a​l​ ​D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * T​h​e​ ​f​i​l​e​ ​t​o​ ​g​e​t​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​f​o​r + * U​p​d​a​t​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​n​o​t​e​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​w​h​o​s​e​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * N​e​w​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​a​d​d​i​t​i​o​n​a​l​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​e​ ​d​e​a​l */ longDesc: string } - next_page_url: { + status: { /** - * N​e​x​t​ ​P​a​g​e​ ​U​R​L + * D​e​a​l​ ​S​t​a​t​u​s */ displayName: string /** - * U​R​L​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​t​o​ ​g​e​t​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s + * T​h​e​ ​u​p​d​a​t​e​d​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​U​R​L​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​l​a​r​g​e​ ​f​i​l​e​s​ ​w​i​t​h​ ​m​a​n​y​ ​v​e​r​s​i​o​n​s + * S​e​l​e​c​t​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​d​e​a​l​ ​i​s​ ​o​p​e​n​,​ ​w​o​n​,​ ​o​r​ ​l​o​s​t */ longDesc: string } } } - list_project_files: { + } + searchOptions: { + orderBy: { /** - * L​i​s​t​ ​P​r​o​j​e​c​t​ ​F​i​l​e​s + * O​r​d​e​r​ ​B​y */ displayName: string /** - * L​i​s​t​ ​a​l​l​ ​f​i​l​e​s​ ​i​n​ ​a​ ​F​i​g​m​a​ ​p​r​o​j​e​c​t + * S​o​r​t​ ​r​e​s​u​l​t​s​ ​b​y​ ​a​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​d​e​s​i​g​n​ ​f​i​l​e​s​ ​w​i​t​h​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​F​i​g​m​a​ ​p​r​o​j​e​c​t​,​ ​i​n​c​l​u​d​i​n​g​ ​f​i​l​e​ ​k​e​y​s​,​ ​n​a​m​e​s​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a + * D​e​f​i​n​e​ ​t​h​e​ ​f​i​e​l​d​ ​a​n​d​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s */ longDesc: string - options: { - team: { - /** - * T​e​a​m - */ - displayName: string - /** - * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​p​r​o​j​e​c​t - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​w​h​o​s​e​ ​f​i​l​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t - */ - longDesc: string - } - project: { - /** - * P​r​o​j​e​c​t​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​p​r​o​j​e​c​t​ ​t​o​ ​l​i​s​t​ ​f​i​l​e​s​ ​f​r​o​m - */ - shortDesc: string - /** - * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​p​r​o​j​e​c​t​ ​w​h​o​s​e​ ​f​i​l​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e - */ - longDesc: string + type: { + fields: { + field: { + /** + * F​i​e​l​d + */ + displayName: string + /** + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y + */ + shortDesc: string + /** + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​f​i​e​l​d​ ​t​o​ ​u​s​e​ ​f​o​r​ ​s​o​r​t​i​n​g​ ​r​e​s​u​l​t​s + */ + longDesc: string + } + direction: { + /** + * D​i​r​e​c​t​i​o​n + */ + displayName: string + /** + * S​o​r​t​ ​d​i​r​e​c​t​i​o​n + */ + shortDesc: string + /** + * T​h​e​ ​d​i​r​e​c​t​i​o​n​ ​t​o​ ​s​o​r​t​ ​r​e​s​u​l​t​s​ ​(​a​s​c​e​n​d​i​n​g​ ​o​r​ ​d​e​s​c​e​n​d​i​n​g​) + */ + longDesc: string + } } } } - list_projects: { + } + expressions: { + '&&': { /** - * L​i​s​t​ ​P​r​o​j​e​c​t​s + * A​n​d */ displayName: string /** - * L​i​s​t​ ​a​l​l​ ​p​r​o​j​e​c​t​s​ ​i​n​ ​a​ ​F​i​g​m​a​ ​t​e​a​m + * L​o​g​i​c​a​l​ ​A​N​D​ ​o​p​e​r​a​t​o​r */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​p​r​o​j​e​c​t​s​ ​w​i​t​h​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​F​i​g​m​a​ ​t​e​a​m​,​ ​i​n​c​l​u​d​i​n​g​ ​p​r​o​j​e​c​t​ ​n​a​m​e​s​ ​a​n​d​ ​I​D​s + * C​o​m​b​i​n​e​s​ ​m​u​l​t​i​p​l​e​ ​c​o​n​d​i​t​i​o​n​s​ ​w​h​e​r​e​ ​a​l​l​ ​m​u​s​t​ ​b​e​ ​t​r​u​e */ longDesc: string - options: { - team: { - /** - * T​e​a​m​ ​I​D - */ - displayName: string - /** - * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​o​ ​l​i​s​t​ ​p​r​o​j​e​c​t​s​ ​f​r​o​m - */ - shortDesc: string - /** - * E​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​w​h​o​s​e​ ​p​r​o​j​e​c​t​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e - */ - longDesc: string - } - } } - } - } - LinkedInOrganizations: { - /** - * L​i​n​k​e​d​I​n​ ​O​r​g​a​n​i​z​a​t​i​o​n​s - */ - displayName: string - groups: { - /** - * S​o​c​i​a​l​ ​M​e​d​i​a​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - /** - * M​a​n​a​g​e​ ​a​n​d​ ​a​n​a​l​y​z​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​c​o​n​t​e​n​t​ ​a​n​d​ ​s​t​a​t​i​s​t​i​c​s - */ - shortDesc: string - /** - * C​o​n​n​e​c​t​ ​t​o​ ​L​i​n​k​e​d​I​n​ ​O​r​g​a​n​i​z​a​t​i​o​n​s​ ​t​o​ ​m​a​n​a​g​e​,​ ​a​n​d​ ​m​o​n​i​t​o​r​ ​p​o​s​t​s​,​ ​a​n​a​l​y​z​e​ ​f​o​l​l​o​w​e​r​ ​e​n​g​a​g​e​m​e​n​t​,​ ​t​r​a​c​k​ ​p​a​g​e​ ​p​e​r​f​o​r​m​a​n​c​e​,​ ​a​n​d​ ​g​a​t​h​e​r​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​s​t​a​t​i​s​t​i​c​s​ ​a​b​o​u​t​ ​y​o​u​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​'​s​ ​L​i​n​k​e​d​I​n​ ​p​r​e​s​e​n​c​e​. - */ - longDesc: string - triggers: { - new_post: { + '||': { /** - * N​e​w​ ​P​o​s​t + * O​r */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​p​o​s​t​ ​i​s​ ​p​u​b​l​i​s​h​e​d​ ​b​y​ ​t​h​e​ ​o​r​g​a​n​i​z​a​t​i​o​n + * L​o​g​i​c​a​l​ ​O​R​ ​o​p​e​r​a​t​o​r */ shortDesc: string /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​p​o​s​t​ ​i​s​ ​p​u​b​l​i​s​h​e​d​ ​b​y​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​.​ ​I​t​ ​m​o​n​i​t​o​r​s​ ​t​h​e​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​f​o​r​ ​n​e​w​ ​c​o​n​t​e​n​t​ ​a​n​d​ ​p​r​o​v​i​d​e​s​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​e​ ​p​o​s​t​. + * C​o​m​b​i​n​e​s​ ​m​u​l​t​i​p​l​e​ ​c​o​n​d​i​t​i​o​n​s​ ​w​h​e​r​e​ ​a​t​ ​l​e​a​s​t​ ​o​n​e​ ​m​u​s​t​ ​b​e​ ​t​r​u​e */ longDesc: string - options: { - organization: { - /** - * O​r​g​a​n​i​z​a​t​i​o​n - */ - displayName: string - /** - * T​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​p​o​s​t​s - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​p​o​s​t​s​.​ ​Y​o​u​ ​m​u​s​t​ ​h​a​v​e​ ​a​c​c​e​s​s​ ​t​o​ ​m​a​n​a​g​e​ ​t​h​i​s​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​. - */ - longDesc: string - } - } } - } - actions: { - get_follower_statistics: { + '==': { /** - * G​e​t​ ​F​o​l​l​o​w​e​r​ ​S​t​a​t​i​s​t​i​c​s + * E​q​u​a​l​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​d​e​m​o​g​r​a​p​h​i​c​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​f​o​l​l​o​w​e​r​s + * F​i​e​l​d​ ​e​q​u​a​l​s​ ​v​a​l​u​e */ shortDesc: string /** - * A​n​a​l​y​z​e​ ​y​o​u​r​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​f​o​l​l​o​w​e​r​s​ ​b​y​ ​r​e​t​r​i​e​v​i​n​g​ ​d​e​t​a​i​l​e​d​ ​d​e​m​o​g​r​a​p​h​i​c​ ​b​r​e​a​k​d​o​w​n​s​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​ ​s​t​a​t​i​s​t​i​c​s​.​ ​T​h​i​s​ ​h​e​l​p​s​ ​u​n​d​e​r​s​t​a​n​d​ ​y​o​u​r​ ​a​u​d​i​e​n​c​e​ ​c​o​m​p​o​s​i​t​i​o​n​ ​a​n​d​ ​r​e​a​c​h​. + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​e​q​u​a​l​s​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e */ longDesc: string - options: { - organization: { - /** - * O​r​g​a​n​i​z​a​t​i​o​n - */ - displayName: string - /** - * T​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​t​o​ ​g​e​t​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​f​o​r​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​l​l​o​w​e​r​ ​d​e​m​o​g​r​a​p​h​i​c​s​ ​a​n​d​ ​s​t​a​t​i​s​t​i​c​s​. - */ - longDesc: string - } - dimensionType: { - /** - * D​i​m​e​n​s​i​o​n​ ​T​y​p​e - */ - displayName: string - /** - * T​h​e​ ​t​y​p​e​ ​o​f​ ​d​e​m​o​g​r​a​p​h​i​c​ ​d​i​m​e​n​s​i​o​n​ ​t​o​ ​a​n​a​l​y​z​e - */ - shortDesc: string - /** - * C​h​o​o​s​e​ ​t​h​e​ ​d​e​m​o​g​r​a​p​h​i​c​ ​d​i​m​e​n​s​i​o​n​ ​t​o​ ​a​n​a​l​y​z​e​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​ ​b​y​,​ ​s​u​c​h​ ​a​s​ ​j​o​b​ ​f​u​n​c​t​i​o​n​,​ ​i​n​d​u​s​t​r​y​,​ ​s​e​n​i​o​r​i​t​y​ ​l​e​v​e​l​,​ ​g​e​o​g​r​a​p​h​i​c​ ​r​e​g​i​o​n​,​ ​c​o​m​p​a​n​y​ ​s​i​z​e​,​ ​o​r​ ​c​o​u​n​t​r​y​. - */ - longDesc: string - } - timeRange: { - /** - * T​i​m​e​ ​R​a​n​g​e - */ - displayName: string - /** - * D​a​t​e​ ​r​a​n​g​e​ ​f​o​r​ ​t​h​e​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s - */ - shortDesc: string - /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​s​t​a​r​t​ ​a​n​d​ ​e​n​d​ ​d​a​t​e​s​ ​f​o​r​ ​a​n​a​l​y​z​i​n​g​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​g​e​t​ ​l​i​f​e​t​i​m​e​ ​s​t​a​t​i​s​t​i​c​s​. - */ - longDesc: string - type: { - fields: { - start: { - /** - * S​t​a​r​t​ ​D​a​t​e - */ - displayName: string - /** - * T​h​e​ ​s​t​a​r​t​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​s​t​a​t​i​s​t​i​c​s​ ​p​e​r​i​o​d - */ - shortDesc: string - /** - * E​n​t​e​r​ ​t​h​e​ ​s​t​a​r​t​ ​d​a​t​e​ ​f​r​o​m​ ​w​h​i​c​h​ ​t​o​ ​b​e​g​i​n​ ​a​n​a​l​y​z​i​n​g​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​. - */ - longDesc: string - } - end: { - /** - * E​n​d​ ​D​a​t​e - */ - displayName: string - /** - * T​h​e​ ​e​n​d​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​s​t​a​t​i​s​t​i​c​s​ ​p​e​r​i​o​d - */ - shortDesc: string - /** - * E​n​t​e​r​ ​t​h​e​ ​e​n​d​ ​d​a​t​e​ ​u​n​t​i​l​ ​w​h​i​c​h​ ​t​o​ ​a​n​a​l​y​z​e​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​. - */ - longDesc: string - } - } - } - } - } } - get_post: { + '!=': { /** - * G​e​t​ ​P​o​s​t + * N​o​t​ ​E​q​u​a​l​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​o​s​t + * F​i​e​l​d​ ​d​o​e​s​ ​n​o​t​ ​e​q​u​a​l​ ​v​a​l​u​e */ shortDesc: string /** - * F​e​t​c​h​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​o​s​t​ ​p​u​b​l​i​s​h​e​d​ ​b​y​ ​a​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​,​ ​i​n​c​l​u​d​i​n​g​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​,​ ​c​o​n​t​e​n​t​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a​. + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​d​o​e​s​ ​n​o​t​ ​e​q​u​a​l​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e */ longDesc: string - options: { - organization: { - /** - * O​r​g​a​n​i​z​a​t​i​o​n - */ - displayName: string - /** - * T​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​T​h​i​s​ ​f​i​e​l​d​ ​i​s​ ​p​r​e​s​e​l​e​c​t​e​d​ ​a​n​d​ ​h​e​l​p​s​ ​f​i​l​t​e​r​ ​a​v​a​i​l​a​b​l​e​ ​p​o​s​t​s​. - */ - longDesc: string - } - post: { - /** - * P​o​s​t - */ - displayName: string - /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​L​i​n​k​e​d​I​n​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​L​i​n​k​e​d​I​n​ ​p​o​s​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​.​ ​T​h​e​ ​l​i​s​t​ ​s​h​o​w​s​ ​p​o​s​t​s​ ​f​r​o​m​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​o​r​g​a​n​i​z​a​t​i​o​n​. - */ - longDesc: string - } - } } - list_user_organizations: { + '>': { /** - * L​i​s​t​ ​U​s​e​r​ ​O​r​g​a​n​i​z​a​t​i​o​n​s + * G​r​e​a​t​e​r​ ​T​h​a​n */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​s​ ​a​c​c​e​s​s​i​b​l​e​ ​t​o​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r + * F​i​e​l​d​ ​i​s​ ​g​r​e​a​t​e​r​ ​t​h​a​n​ ​v​a​l​u​e */ shortDesc: string /** - * F​e​t​c​h​ ​a​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​s​ ​t​h​a​t​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​ ​h​a​s​ ​a​c​c​e​s​s​ ​t​o​ ​m​a​n​a​g​e​.​ ​T​h​i​s​ ​i​n​c​l​u​d​e​s​ ​o​r​g​a​n​i​z​a​t​i​o​n​s​ ​w​h​e​r​e​ ​t​h​e​ ​u​s​e​r​ ​h​a​s​ ​a​d​m​i​n​ ​o​r​ ​c​o​n​t​e​n​t​ ​m​a​n​a​g​e​m​e​n​t​ ​p​e​r​m​i​s​s​i​o​n​s​,​ ​a​l​o​n​g​ ​w​i​t​h​ ​d​e​t​a​i​l​e​d​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​i​n​f​o​r​m​a​t​i​o​n​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​l​o​g​o​,​ ​l​o​c​a​t​i​o​n​,​ ​a​n​d​ ​o​t​h​e​r​ ​m​e​t​a​d​a​t​a​. + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​ ​i​s​ ​g​r​e​a​t​e​r​ ​t​h​a​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e */ longDesc: string } - list_organization_posts: { + '>=': { /** - * L​i​s​t​ ​O​r​g​a​n​i​z​a​t​i​o​n​ ​P​o​s​t​s + * G​r​e​a​t​e​r​ ​T​h​a​n​ ​o​r​ ​E​q​u​a​l */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​p​o​s​t​s​ ​f​r​o​m​ ​a​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e + * F​i​e​l​d​ ​i​s​ ​g​r​e​a​t​e​r​ ​t​h​a​n​ ​o​r​ ​e​q​u​a​l​ ​t​o​ ​v​a​l​u​e */ shortDesc: string /** - * F​e​t​c​h​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​p​o​s​t​s​ ​p​u​b​l​i​s​h​e​d​ ​b​y​ ​a​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​b​r​o​w​s​e​ ​t​h​r​o​u​g​h​ ​h​i​s​t​o​r​i​c​a​l​ ​p​o​s​t​s​ ​a​n​d​ ​r​e​t​r​i​e​v​e​ ​m​e​t​a​d​a​t​a​ ​a​b​o​u​t​ ​e​a​c​h​ ​p​o​s​t​. + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​ ​i​s​ ​g​r​e​a​t​e​r​ ​t​h​a​n​ ​o​r​ ​e​q​u​a​l​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e + */ + longDesc: string + } + '<': { + /** + * L​e​s​s​ ​T​h​a​n + */ + displayName: string + /** + * F​i​e​l​d​ ​i​s​ ​l​e​s​s​ ​t​h​a​n​ ​v​a​l​u​e + */ + shortDesc: string + /** + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​ ​i​s​ ​l​e​s​s​ ​t​h​a​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e + */ + longDesc: string + } + '<=': { + /** + * L​e​s​s​ ​T​h​a​n​ ​o​r​ ​E​q​u​a​l + */ + displayName: string + /** + * F​i​e​l​d​ ​i​s​ ​l​e​s​s​ ​t​h​a​n​ ​o​r​ ​e​q​u​a​l​ ​t​o​ ​v​a​l​u​e + */ + shortDesc: string + /** + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​v​a​l​u​e​ ​i​s​ ​l​e​s​s​ ​t​h​a​n​ ​o​r​ ​e​q​u​a​l​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​v​a​l​u​e + */ + longDesc: string + } + 'is-set': { + /** + * I​s​ ​S​e​t + */ + displayName: string + /** + * F​i​e​l​d​ ​h​a​s​ ​a​ ​v​a​l​u​e + */ + shortDesc: string + /** + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​h​a​s​ ​a​ ​v​a​l​u​e​ ​(​i​s​ ​n​o​t​ ​e​m​p​t​y​) + */ + longDesc: string + } + 'is-not-set': { + /** + * I​s​ ​N​o​t​ ​S​e​t + */ + displayName: string + /** + * F​i​e​l​d​ ​h​a​s​ ​n​o​ ​v​a​l​u​e + */ + shortDesc: string + /** + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​h​a​s​ ​n​o​ ​v​a​l​u​e​ ​(​i​s​ ​e​m​p​t​y​) + */ + longDesc: string + } + contains: { + /** + * C​o​n​t​a​i​n​s + */ + displayName: string + /** + * F​i​e​l​d​ ​c​o​n​t​a​i​n​s​ ​v​a​l​u​e + */ + shortDesc: string + /** + * M​a​t​c​h​e​s​ ​r​e​c​o​r​d​s​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​e​l​d​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​s​u​b​s​t​r​i​n​g */ longDesc: string - options: { - organization: { - /** - * O​r​g​a​n​i​z​a​t​i​o​n - */ - displayName: string - /** - * T​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​t​o​ ​l​i​s​t​ ​p​o​s​t​s​ ​f​r​o​m - */ - shortDesc: string - /** - * S​e​l​e​c​t​ ​t​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​f​r​o​m​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​p​o​s​t​s​.​ ​Y​o​u​ ​m​u​s​t​ ​h​a​v​e​ ​a​c​c​e​s​s​ ​t​o​ ​m​a​n​a​g​e​ ​t​h​i​s​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​. - */ - longDesc: string - } - count: { - /** - * P​o​s​t​ ​C​o​u​n​t - */ - displayName: string - /** - * N​u​m​b​e​r​ ​o​f​ ​p​o​s​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e - */ - shortDesc: string - /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​p​o​s​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​r​o​m​ ​t​h​e​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​ ​p​o​s​t​s​. - */ - longDesc: string - } - cursor: { - /** - * P​a​g​i​n​a​t​i​o​n​ ​C​u​r​s​o​r - */ - displayName: string - /** - * C​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​s​e​t​ ​o​f​ ​p​o​s​t​s - */ - shortDesc: string - /** - * U​s​e​ ​t​h​i​s​ ​c​u​r​s​o​r​ ​v​a​l​u​e​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​p​o​s​t​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​g​e​t​ ​t​h​e​ ​f​i​r​s​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. - */ - longDesc: string - } - } } } } - Telegram: { + HuggingFace: { /** - * T​e​l​e​g​r​a​m + * H​u​g​g​i​n​g​ ​F​a​c​e */ displayName: string groups: { /** - * M​e​s​s​a​g​i​n​g​ ​&​ ​R​e​a​l​-​t​i​m​e​ ​C​o​m​m​u​n​i​c​a​t​i​o​n + * A​I​ ​&​ ​L​a​n​g​u​a​g​e​ ​M​o​d​e​l​s */ '0': string } /** - * C​o​n​n​e​c​t​ ​a​n​d​ ​i​n​t​e​r​a​c​t​ ​w​i​t​h​ ​T​e​l​e​g​r​a​m​ ​v​i​a​ ​a​ ​b​o​t + * A​I​ ​m​o​d​e​l​s​ ​a​n​d​ ​d​a​t​a​s​e​t​s​ ​p​l​a​t​f​o​r​m */ shortDesc: string /** - * C​o​n​n​e​c​t​ ​a​ ​T​e​l​e​g​r​a​m​ ​B​o​t​ ​u​s​i​n​g​ ​i​t​s​ ​B​o​t​ ​T​o​k​e​n​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​h​a​n​d​l​e​ ​i​n​c​o​m​i​n​g​ ​u​p​d​a​t​e​s​.​ ​A​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​i​s​ ​d​o​n​e​ ​s​o​l​e​l​y​ ​w​i​t​h​ ​t​h​e​ ​B​o​t​ ​T​o​k​e​n​ ​i​s​s​u​e​d​ ​b​y​ ​@​B​o​t​F​a​t​h​e​r​;​ ​n​o​ ​u​s​e​r​ ​l​o​g​i​n​ ​i​s​ ​r​e​q​u​i​r​e​d​. + * A​c​c​e​s​s​ ​a​n​d​ ​d​e​p​l​o​y​ ​m​a​c​h​i​n​e​ ​l​e​a​r​n​i​n​g​ ​m​o​d​e​l​s​,​ ​d​a​t​a​s​e​t​s​,​ ​a​n​d​ ​s​p​a​c​e​s​ ​f​r​o​m​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​H​u​b​ ​f​o​r​ ​n​a​t​u​r​a​l​ ​l​a​n​g​u​a​g​e​ ​p​r​o​c​e​s​s​i​n​g​,​ ​c​o​m​p​u​t​e​r​ ​v​i​s​i​o​n​,​ ​a​n​d​ ​o​t​h​e​r​ ​A​I​ ​t​a​s​k​s */ longDesc: string connectionMessage: { /** - * C​o​n​n​e​c​t​ ​t​o​ ​T​e​l​e​g​r​a​m + * C​o​n​n​e​c​t​ ​t​o​ ​H​u​g​g​i​n​g​ ​F​a​c​e */ title: string /** - * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​T​e​l​e​g​r​a​m​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​B​o​t​ ​T​o​k​e​n​*​*​ ​f​r​o​m​ ​B​o​t​F​a​t​h​e​r​.​ - ​ - ​#​#​ ​C​r​e​a​t​i​n​g​ ​a​ ​T​e​l​e​g​r​a​m​ ​B​o​t​ + * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​H​u​g​g​i​n​g​ ​F​a​c​e​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​c​c​e​s​s​ ​T​o​k​e​n​*​*​.​ ​ - ​1​.​ ​O​p​e​n​ ​T​e​l​e​g​r​a​m​ ​a​n​d​ ​s​e​a​r​c​h​ ​f​o​r​ ​[​@​B​o​t​F​a​t​h​e​r​]​(​h​t​t​p​s​:​/​/​t​.​m​e​/​B​o​t​F​a​t​h​e​r​)​ - ​2​.​ ​S​t​a​r​t​ ​a​ ​c​h​a​t​ ​a​n​d​ ​s​e​n​d​ ​t​h​e​ ​c​o​m​m​a​n​d​ ​`​/​n​e​w​b​o​t​`​ - ​3​.​ ​F​o​l​l​o​w​ ​t​h​e​ ​p​r​o​m​p​t​s​ ​t​o​:​ - ​ ​ ​ ​-​ ​C​h​o​o​s​e​ ​a​ ​*​*​d​i​s​p​l​a​y​ ​n​a​m​e​*​*​ ​f​o​r​ ​y​o​u​r​ ​b​o​t​ ​(​e​.​g​.​,​ ​"​M​y​ ​A​u​t​o​m​a​t​i​o​n​ ​B​o​t​"​)​ - ​ ​ ​ ​-​ ​C​h​o​o​s​e​ ​a​ ​*​*​u​s​e​r​n​a​m​e​*​*​ ​f​o​r​ ​y​o​u​r​ ​b​o​t​ ​(​m​u​s​t​ ​e​n​d​ ​i​n​ ​"​b​o​t​"​,​ ​e​.​g​.​,​ ​"​m​y​_​a​u​t​o​m​a​t​i​o​n​_​b​o​t​"​)​ - ​4​.​ ​B​o​t​F​a​t​h​e​r​ ​w​i​l​l​ ​r​e​s​p​o​n​d​ ​w​i​t​h​ ​y​o​u​r​ ​*​*​B​o​t​ ​T​o​k​e​n​*​*​ - ​5​.​ ​C​o​p​y​ ​t​h​e​ ​t​o​k​e​n​ ​(​f​o​r​m​a​t​:​ ​`​1​2​3​4​5​6​7​8​9​:​A​B​C​d​e​f​G​H​I​j​k​l​M​N​O​p​q​r​s​T​U​V​w​x​y​z​`​)​ + ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​A​c​c​e​s​s​ ​T​o​k​e​n​ ​ - ​#​#​ ​M​a​n​a​g​i​n​g​ ​E​x​i​s​t​i​n​g​ ​B​o​t​s​ + ​1​.​ ​S​i​g​n​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​H​u​g​g​i​n​g​ ​F​a​c​e​ ​a​c​c​o​u​n​t​]​(​h​t​t​p​s​:​/​/​h​u​g​g​i​n​g​f​a​c​e​.​c​o​/​)​ + ​2​.​ ​C​l​i​c​k​ ​o​n​ ​y​o​u​r​ ​p​r​o​f​i​l​e​ ​p​i​c​t​u​r​e​ ​→​ ​*​*​S​e​t​t​i​n​g​s​*​*​ + ​3​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​*​*​A​c​c​e​s​s​ ​T​o​k​e​n​s​*​*​ ​i​n​ ​t​h​e​ ​l​e​f​t​ ​s​i​d​e​b​a​r​ + ​4​.​ ​C​l​i​c​k​ ​*​*​N​e​w​ ​t​o​k​e​n​*​*​ + ​5​.​ ​G​i​v​e​ ​y​o​u​r​ ​t​o​k​e​n​ ​a​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​(​e​.​g​.​,​ ​"​Q​o​r​e​ ​I​n​t​e​g​r​a​t​i​o​n​"​)​ + ​6​.​ ​S​e​l​e​c​t​ ​t​h​e​ ​a​p​p​r​o​p​r​i​a​t​e​ ​r​o​l​e​:​ + ​ ​ ​ ​-​ ​*​*​R​e​a​d​*​*​:​ ​F​o​r​ ​a​c​c​e​s​s​i​n​g​ ​p​u​b​l​i​c​ ​m​o​d​e​l​s​ ​a​n​d​ ​d​a​t​a​s​e​t​s​ + ​ ​ ​ ​-​ ​*​*​W​r​i​t​e​*​*​:​ ​F​o​r​ ​u​p​l​o​a​d​i​n​g​ ​m​o​d​e​l​s​,​ ​c​r​e​a​t​i​n​g​ ​r​e​p​o​s​,​ ​a​n​d​ ​f​u​l​l​ ​A​P​I​ ​a​c​c​e​s​s​ + ​7​.​ ​C​l​i​c​k​ ​*​*​G​e​n​e​r​a​t​e​ ​a​ ​t​o​k​e​n​*​*​ + ​8​.​ ​C​o​p​y​ ​t​h​e​ ​g​e​n​e​r​a​t​e​d​ ​t​o​k​e​n​ ​i​m​m​e​d​i​a​t​e​l​y​ ​ - ​T​o​ ​g​e​t​ ​t​h​e​ ​t​o​k​e​n​ ​f​o​r​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​b​o​t​:​ - ​1​.​ ​O​p​e​n​ ​[​@​B​o​t​F​a​t​h​e​r​]​(​h​t​t​p​s​:​/​/​t​.​m​e​/​B​o​t​F​a​t​h​e​r​)​ - ​2​.​ ​S​e​n​d​ ​`​/​m​y​b​o​t​s​`​ - ​3​.​ ​S​e​l​e​c​t​ ​y​o​u​r​ ​b​o​t​ - ​4​.​ ​C​l​i​c​k​ ​*​*​A​P​I​ ​T​o​k​e​n​*​*​ ​t​o​ ​v​i​e​w​ ​o​r​ ​r​e​g​e​n​e​r​a​t​e​ ​t​h​e​ ​t​o​k​e​n​ + ​Y​o​u​ ​c​a​n​ ​a​c​c​e​s​s​ ​t​h​e​ ​t​o​k​e​n​s​ ​p​a​g​e​ ​d​i​r​e​c​t​l​y​ ​a​t​ ​[​h​u​g​g​i​n​g​f​a​c​e​.​c​o​/​s​e​t​t​i​n​g​s​/​t​o​k​e​n​s​]​(​h​t​t​p​s​:​/​/​h​u​g​g​i​n​g​f​a​c​e​.​c​o​/​s​e​t​t​i​n​g​s​/​t​o​k​e​n​s​)​ ​ ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ ​ - ​#​#​#​ ​B​o​t​ ​T​o​k​e​n​ - ​Y​o​u​r​ ​T​e​l​e​g​r​a​m​ ​B​o​t​ ​T​o​k​e​n​ ​i​n​ ​t​h​e​ ​f​o​r​m​a​t​ ​`​1​2​3​4​5​6​7​8​9​:​A​B​C​d​e​f​G​H​I​j​k​l​M​N​O​p​q​r​s​T​U​V​w​x​y​z​`​.​ ​T​h​i​s​ ​t​o​k​e​n​ ​a​u​t​h​e​n​t​i​c​a​t​e​s​ ​y​o​u​r​ ​b​o​t​ ​w​i​t​h​ ​t​h​e​ ​T​e​l​e​g​r​a​m​ ​A​P​I​.​ + ​#​#​#​ ​A​c​c​e​s​s​ ​T​o​k​e​n​ + ​Y​o​u​r​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​a​c​c​e​s​s​ ​t​o​k​e​n​ ​s​t​a​r​t​i​n​g​ ​w​i​t​h​ ​`​h​f​_​`​.​ ​T​h​i​s​ ​t​o​k​e​n​ ​a​u​t​h​e​n​t​i​c​a​t​e​s​ ​a​l​l​ ​A​P​I​ ​r​e​q​u​e​s​t​s​ ​t​o​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​s​e​r​v​i​c​e​s​.​ ​ - ​*​*​N​o​t​e​:​*​*​ ​K​e​e​p​ ​y​o​u​r​ ​b​o​t​ ​t​o​k​e​n​ ​s​e​c​u​r​e​ ​a​n​d​ ​n​e​v​e​r​ ​s​h​a​r​e​ ​i​t​ ​p​u​b​l​i​c​l​y​.​ ​A​n​y​o​n​e​ ​w​i​t​h​ ​y​o​u​r​ ​t​o​k​e​n​ ​c​a​n​ ​c​o​n​t​r​o​l​ ​y​o​u​r​ ​b​o​t​.​ ​I​f​ ​c​o​m​p​r​o​m​i​s​e​d​,​ ​r​e​g​e​n​e​r​a​t​e​ ​i​t​ ​i​m​m​e​d​i​a​t​e​l​y​ ​v​i​a​ ​B​o​t​F​a​t​h​e​r​. + ​*​*​N​o​t​e​:​*​*​ ​K​e​e​p​ ​y​o​u​r​ ​a​c​c​e​s​s​ ​t​o​k​e​n​ ​s​e​c​u​r​e​ ​a​n​d​ ​n​e​v​e​r​ ​s​h​a​r​e​ ​i​t​ ​p​u​b​l​i​c​l​y​.​ ​Y​o​u​ ​c​a​n​ ​c​r​e​a​t​e​ ​m​u​l​t​i​p​l​e​ ​t​o​k​e​n​s​ ​w​i​t​h​ ​d​i​f​f​e​r​e​n​t​ ​p​e​r​m​i​s​s​i​o​n​s​ ​a​n​d​ ​r​e​v​o​k​e​ ​t​h​e​m​ ​a​t​ ​a​n​y​ ​t​i​m​e​ ​f​r​o​m​ ​t​h​e​ ​s​e​t​t​i​n​g​s​ ​p​a​g​e​. */ content: string } actions: { - send_message: { + list_models: { /** - * S​e​n​d​ ​M​e​s​s​a​g​e + * L​i​s​t​ ​M​o​d​e​l​s */ displayName: string /** - * S​e​n​d​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​c​h​a​t + * L​i​s​t​ ​a​n​d​ ​s​e​a​r​c​h​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​m​o​d​e​l​s */ shortDesc: string /** - * S​e​n​d​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​o​r​m​a​t​t​i​n​g​ ​t​o​ ​a​n​y​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​a​c​c​e​s​s​i​b​l​e​ ​b​y​ ​y​o​u​r​ ​b​o​t + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​m​o​d​e​l​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​ ​b​y​ ​t​a​s​k​,​ ​o​w​n​e​r​,​ ​t​a​g​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a */ longDesc: string - groups: { - /** - * M​e​s​s​a​g​i​n​g - */ - '0': string - } options: { - chat: { + tags: { /** - * C​h​a​t + * T​a​g​s */ displayName: string /** - * T​h​e​ ​c​h​a​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o + * F​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y​ ​t​a​g​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e + * L​i​s​t​ ​o​f​ ​t​a​g​s​ ​t​o​ ​f​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y */ longDesc: string } - format: { + inferenceProviders: { /** - * T​e​x​t​ ​F​o​r​m​a​t + * I​n​f​e​r​e​n​c​e​ ​P​r​o​v​i​d​e​r​s */ displayName: string /** - * H​o​w​ ​t​o​ ​f​o​r​m​a​t​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​e​x​t + * F​i​l​t​e​r​ ​b​y​ ​i​n​f​e​r​e​n​c​e​ ​p​r​o​v​i​d​e​r​s */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​f​o​r​m​a​t​t​i​n​g​ ​m​o​d​e​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​(​p​l​a​i​n​ ​t​e​x​t​,​ ​M​a​r​k​d​o​w​n​,​ ​M​a​r​k​d​o​w​n​ ​V​2​,​ ​o​r​ ​H​T​M​L​) + * L​i​s​t​ ​o​f​ ​i​n​f​e​r​e​n​c​e​ ​p​r​o​v​i​d​e​r​s​ ​t​o​ ​f​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y */ longDesc: string } - message: { + owner: { /** - * M​e​s​s​a​g​e​ ​T​e​x​t + * O​w​n​e​r */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + * F​i​l​t​e​r​ ​b​y​ ​m​o​d​e​l​ ​o​w​n​e​r */ shortDesc: string /** - * T​h​e​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t​ ​t​o​ ​s​e​n​d​.​ ​C​a​n​ ​i​n​c​l​u​d​e​ ​f​o​r​m​a​t​t​i​n​g​ ​d​e​p​e​n​d​i​n​g​ ​o​n​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​f​o​r​m​a​t​ ​m​o​d​e + * U​s​e​r​n​a​m​e​ ​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​n​a​m​e​ ​t​o​ ​f​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y */ longDesc: string } - disable_link_preview: { + query: { /** - * D​i​s​a​b​l​e​ ​L​i​n​k​ ​P​r​e​v​i​e​w + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * D​i​s​a​b​l​e​ ​a​u​t​o​m​a​t​i​c​ ​l​i​n​k​ ​p​r​e​v​i​e​w​s + * S​e​a​r​c​h​ ​m​o​d​e​l​s​ ​b​y​ ​q​u​e​r​y */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​l​i​n​k​s​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​n​o​t​ ​s​h​o​w​ ​a​u​t​o​m​a​t​i​c​ ​p​r​e​v​i​e​w​s + * T​e​x​t​ ​q​u​e​r​y​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​i​n​ ​m​o​d​e​l​ ​n​a​m​e​s​ ​a​n​d​ ​d​e​s​c​r​i​p​t​i​o​n​s */ longDesc: string } - disable_notification: { + task: { /** - * S​e​n​d​ ​S​i​l​e​n​t​l​y + * T​a​s​k */ displayName: string /** - * S​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + * F​i​l​t​e​r​ ​b​y​ ​m​o​d​e​l​ ​t​a​s​k */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​s​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + * M​a​c​h​i​n​e​ ​l​e​a​r​n​i​n​g​ ​t​a​s​k​ ​t​y​p​e​ ​t​o​ ​f​i​l​t​e​r​ ​m​o​d​e​l​s​ ​b​y + */ + longDesc: string + } + limit: { + /** + * L​i​m​i​t + */ + displayName: string + /** + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​o​d​e​l​s​ ​t​o​ ​r​e​t​u​r​n + */ + shortDesc: string + /** + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​o​d​e​l​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​1​0​) + */ + longDesc: string + } + additionalFields: { + /** + * A​d​d​i​t​i​o​n​a​l​ ​F​i​e​l​d​s + */ + displayName: string + /** + * E​x​t​r​a​ ​m​o​d​e​l​ ​f​i​e​l​d​s​ ​t​o​ ​i​n​c​l​u​d​e + */ + shortDesc: string + /** + * A​d​d​i​t​i​o​n​a​l​ ​m​o​d​e​l​ ​m​e​t​a​d​a​t​a​ ​f​i​e​l​d​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e */ longDesc: string } } } - send_photo: { + create_summary: { /** - * S​e​n​d​ ​P​h​o​t​o + * C​r​e​a​t​e​ ​S​u​m​m​a​r​y */ displayName: string /** - * S​e​n​d​ ​a​ ​p​h​o​t​o​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​c​a​p​t​i​o​n​ ​t​o​ ​a​ ​c​h​a​t + * G​e​n​e​r​a​t​e​ ​t​e​x​t​ ​s​u​m​m​a​r​y​ ​u​s​i​n​g​ ​A​I */ shortDesc: string /** - * U​p​l​o​a​d​ ​a​n​d​ ​s​e​n​d​ ​a​n​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​a​n​y​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​c​a​p​t​i​o​n​ ​a​n​d​ ​f​o​r​m​a​t​t​i​n​g + * C​r​e​a​t​e​ ​a​ ​c​o​n​c​i​s​e​ ​s​u​m​m​a​r​y​ ​o​f​ ​t​h​e​ ​p​r​o​v​i​d​e​d​ ​t​e​x​t​ ​u​s​i​n​g​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​s​u​m​m​a​r​i​z​a​t​i​o​n​ ​m​o​d​e​l​s */ longDesc: string - groups: { - /** - * M​e​s​s​a​g​i​n​g - */ - '0': string - } options: { - chat: { + model: { /** - * C​h​a​t + * M​o​d​e​l */ displayName: string /** - * T​h​e​ ​c​h​a​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​p​h​o​t​o​ ​t​o + * S​u​m​m​a​r​i​z​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​p​h​o​t​o + * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​s​u​m​m​a​r​i​z​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​g​e​n​e​r​a​t​i​n​g​ ​t​h​e​ ​s​u​m​m​a​r​y */ longDesc: string } - photo: { + text: { /** - * P​h​o​t​o​ ​F​i​l​e + * T​e​x​t */ displayName: string /** - * T​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​s​e​n​d + * T​e​x​t​ ​t​o​ ​s​u​m​m​a​r​i​z​e */ shortDesc: string /** - * U​p​l​o​a​d​ ​t​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​(​J​P​G​,​ ​P​N​G​,​ ​G​I​F​,​ ​e​t​c​.​)​ ​t​o​ ​s​e​n​d​ ​t​o​ ​t​h​e​ ​c​h​a​t + * T​h​e​ ​i​n​p​u​t​ ​t​e​x​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​s​u​m​m​a​r​y​ ​f​o​r */ longDesc: string } - caption_format: { + } + } + answer_question_based_on_context: { + /** + * A​n​s​w​e​r​ ​Q​u​e​s​t​i​o​n​ ​B​a​s​e​d​ ​o​n​ ​C​o​n​t​e​x​t + */ + displayName: string + /** + * A​n​s​w​e​r​ ​q​u​e​s​t​i​o​n​s​ ​u​s​i​n​g​ ​p​r​o​v​i​d​e​d​ ​c​o​n​t​e​x​t + */ + shortDesc: string + /** + * A​n​s​w​e​r​ ​q​u​e​s​t​i​o​n​s​ ​b​a​s​e​d​ ​o​n​ ​t​e​x​t​,​ ​d​o​c​u​m​e​n​t​,​ ​o​r​ ​i​m​a​g​e​ ​c​o​n​t​e​x​t​ ​u​s​i​n​g​ ​s​p​e​c​i​a​l​i​z​e​d​ ​q​u​e​s​t​i​o​n​-​a​n​s​w​e​r​i​n​g​ ​m​o​d​e​l​s + */ + longDesc: string + options: { + type: { /** - * C​a​p​t​i​o​n​ ​F​o​r​m​a​t + * Q​u​e​s​t​i​o​n​ ​T​y​p​e */ displayName: string /** - * H​o​w​ ​t​o​ ​f​o​r​m​a​t​ ​t​h​e​ ​c​a​p​t​i​o​n​ ​t​e​x​t + * T​y​p​e​ ​o​f​ ​q​u​e​s​t​i​o​n​ ​a​n​s​w​e​r​i​n​g */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​f​o​r​m​a​t​t​i​n​g​ ​m​o​d​e​ ​f​o​r​ ​t​h​e​ ​p​h​o​t​o​ ​c​a​p​t​i​o​n + * T​h​e​ ​t​y​p​e​ ​o​f​ ​c​o​n​t​e​x​t​ ​a​n​d​ ​q​u​e​s​t​i​o​n​ ​a​n​s​w​e​r​i​n​g​ ​m​o​d​e​l​ ​t​o​ ​u​s​e */ longDesc: string } - caption: { + model: { /** - * P​h​o​t​o​ ​C​a​p​t​i​o​n + * M​o​d​e​l */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​c​a​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​p​h​o​t​o + * Q​u​e​s​t​i​o​n​ ​a​n​s​w​e​r​i​n​g​ ​m​o​d​e​l​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​e​x​t​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​c​a​p​t​i​o​n​ ​t​o​ ​a​c​c​o​m​p​a​n​y​ ​t​h​e​ ​p​h​o​t​o + * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​a​n​s​w​e​r​i​n​g​ ​t​h​e​ ​q​u​e​s​t​i​o​n */ longDesc: string } - protect_content: { + question: { /** - * P​r​o​t​e​c​t​ ​C​o​n​t​e​n​t + * Q​u​e​s​t​i​o​n */ displayName: string /** - * P​r​o​t​e​c​t​ ​c​o​n​t​e​n​t​ ​f​r​o​m​ ​f​o​r​w​a​r​d​i​n​g​ ​a​n​d​ ​s​a​v​i​n​g + * Q​u​e​s​t​i​o​n​ ​t​o​ ​a​n​s​w​e​r */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​p​h​o​t​o​ ​c​a​n​n​o​t​ ​b​e​ ​f​o​r​w​a​r​d​e​d​ ​o​r​ ​s​a​v​e​d​ ​b​y​ ​u​s​e​r​s + * T​h​e​ ​q​u​e​s​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​n​s​w​e​r​ ​b​a​s​e​d​ ​o​n​ ​t​h​e​ ​p​r​o​v​i​d​e​d​ ​c​o​n​t​e​x​t */ longDesc: string } - disable_notification: { + context: { /** - * S​e​n​d​ ​S​i​l​e​n​t​l​y + * T​e​x​t​ ​C​o​n​t​e​x​t */ displayName: string /** - * S​e​n​d​ ​t​h​e​ ​p​h​o​t​o​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + * T​e​x​t​ ​c​o​n​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​s​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​h​o​t​o​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​x​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​i​n​f​o​r​m​a​t​i​o​n​ ​t​o​ ​a​n​s​w​e​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n */ longDesc: string } - } - } - send_poll: { - /** - * S​e​n​d​ ​P​o​l​l - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​n​d​ ​s​e​n​d​ ​a​ ​p​o​l​l​ ​o​r​ ​q​u​i​z​ ​t​o​ ​a​ ​c​h​a​t - */ - shortDesc: string - /** - * C​r​e​a​t​e​ ​i​n​t​e​r​a​c​t​i​v​e​ ​p​o​l​l​s​ ​o​r​ ​q​u​i​z​z​e​s​ ​w​i​t​h​ ​m​u​l​t​i​p​l​e​ ​a​n​s​w​e​r​ ​o​p​t​i​o​n​s​,​ ​p​e​r​f​e​c​t​ ​f​o​r​ ​g​a​t​h​e​r​i​n​g​ ​f​e​e​d​b​a​c​k​ ​o​r​ ​t​e​s​t​i​n​g​ ​k​n​o​w​l​e​d​g​e - */ - longDesc: string - groups: { - /** - * M​e​s​s​a​g​i​n​g - */ - '0': string - } - options: { - chat: { + file: { /** - * C​h​a​t + * D​o​c​u​m​e​n​t​ ​F​i​l​e */ displayName: string /** - * T​h​e​ ​c​h​a​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​p​o​l​l​ ​t​o + * D​o​c​u​m​e​n​t​ ​c​o​n​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​p​o​l​l + * T​h​e​ ​d​o​c​u​m​e​n​t​ ​f​i​l​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​i​n​f​o​r​m​a​t​i​o​n​ ​t​o​ ​a​n​s​w​e​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n */ longDesc: string } - question: { + image: { /** - * P​o​l​l​ ​Q​u​e​s​t​i​o​n + * I​m​a​g​e​ ​F​i​l​e */ displayName: string /** - * T​h​e​ ​m​a​i​n​ ​q​u​e​s​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​p​o​l​l + * I​m​a​g​e​ ​c​o​n​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​q​u​e​s​t​i​o​n​ ​t​h​a​t​ ​u​s​e​r​s​ ​w​i​l​l​ ​a​n​s​w​e​r​ ​i​n​ ​t​h​e​ ​p​o​l​l + * T​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​v​i​s​u​a​l​ ​i​n​f​o​r​m​a​t​i​o​n​ ​t​o​ ​a​n​s​w​e​r​ ​t​h​e​ ​q​u​e​s​t​i​o​n */ longDesc: string } - answers: { + } + } + create_text_classification: { + /** + * C​r​e​a​t​e​ ​T​e​x​t​ ​C​l​a​s​s​i​f​i​c​a​t​i​o​n + */ + displayName: string + /** + * C​l​a​s​s​i​f​y​ ​t​e​x​t​ ​i​n​t​o​ ​c​a​t​e​g​o​r​i​e​s + */ + shortDesc: string + /** + * C​l​a​s​s​i​f​y​ ​t​e​x​t​ ​i​n​t​o​ ​p​r​e​d​e​f​i​n​e​d​ ​c​a​t​e​g​o​r​i​e​s​ ​u​s​i​n​g​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​t​e​x​t​ ​c​l​a​s​s​i​f​i​c​a​t​i​o​n​ ​m​o​d​e​l​s + */ + longDesc: string + options: { + model: { /** - * A​n​s​w​e​r​ ​O​p​t​i​o​n​s + * M​o​d​e​l */ displayName: string /** - * L​i​s​t​ ​o​f​ ​p​o​s​s​i​b​l​e​ ​a​n​s​w​e​r​s​ ​(​2​-​1​0​ ​o​p​t​i​o​n​s​) + * T​e​x​t​ ​c​l​a​s​s​i​f​i​c​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​a​n​s​w​e​r​ ​c​h​o​i​c​e​s​ ​t​h​a​t​ ​u​s​e​r​s​ ​c​a​n​ ​s​e​l​e​c​t​ ​f​r​o​m​.​ ​M​u​s​t​ ​h​a​v​e​ ​b​e​t​w​e​e​n​ ​2​ ​a​n​d​ ​1​0​ ​o​p​t​i​o​n​s + * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​t​e​x​t​ ​c​l​a​s​s​i​f​i​c​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​c​a​t​e​g​o​r​i​z​i​n​g​ ​t​h​e​ ​t​e​x​t */ longDesc: string } - is_anonymous: { + text: { /** - * A​n​o​n​y​m​o​u​s​ ​P​o​l​l + * T​e​x​t */ displayName: string /** - * S​h​o​u​l​d​ ​t​h​e​ ​p​o​l​l​ ​b​e​ ​a​n​o​n​y​m​o​u​s​? + * T​e​x​t​ ​t​o​ ​c​l​a​s​s​i​f​y */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​ ​v​o​t​e​s​ ​w​i​l​l​ ​b​e​ ​a​n​o​n​y​m​o​u​s​.​ ​I​f​ ​d​i​s​a​b​l​e​d​,​ ​v​o​t​e​s​ ​w​i​l​l​ ​b​e​ ​v​i​s​i​b​l​e​ ​t​o​ ​o​t​h​e​r​ ​u​s​e​r​s + * T​h​e​ ​i​n​p​u​t​ ​t​e​x​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​l​a​s​s​i​f​y​ ​i​n​t​o​ ​c​a​t​e​g​o​r​i​e​s */ longDesc: string } - poll_type: { + } + } + create_translation: { + /** + * C​r​e​a​t​e​ ​T​r​a​n​s​l​a​t​i​o​n + */ + displayName: string + /** + * T​r​a​n​s​l​a​t​e​ ​t​e​x​t​ ​b​e​t​w​e​e​n​ ​l​a​n​g​u​a​g​e​s + */ + shortDesc: string + /** + * T​r​a​n​s​l​a​t​e​ ​t​e​x​t​ ​f​r​o​m​ ​o​n​e​ ​l​a​n​g​u​a​g​e​ ​t​o​ ​a​n​o​t​h​e​r​ ​u​s​i​n​g​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​t​r​a​n​s​l​a​t​i​o​n​ ​m​o​d​e​l​s + */ + longDesc: string + options: { + model: { /** - * P​o​l​l​ ​T​y​p​e + * M​o​d​e​l */ displayName: string /** - * R​e​g​u​l​a​r​ ​p​o​l​l​ ​o​r​ ​q​u​i​z​ ​w​i​t​h​ ​c​o​r​r​e​c​t​ ​a​n​s​w​e​r​s + * T​r​a​n​s​l​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e */ shortDesc: string /** - * C​h​o​o​s​e​ ​b​e​t​w​e​e​n​ ​a​ ​r​e​g​u​l​a​r​ ​p​o​l​l​ ​o​r​ ​a​ ​q​u​i​z​ ​w​h​e​r​e​ ​y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​c​o​r​r​e​c​t​ ​a​n​s​w​e​r​s + * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​t​r​a​n​s​l​a​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​r​a​n​s​l​a​t​i​n​g​ ​t​h​e​ ​t​e​x​t */ longDesc: string } - allows_multiple_answers: { + text: { /** - * M​u​l​t​i​p​l​e​ ​A​n​s​w​e​r​s + * T​e​x​t */ displayName: string /** - * A​l​l​o​w​ ​u​s​e​r​s​ ​t​o​ ​s​e​l​e​c​t​ ​m​u​l​t​i​p​l​e​ ​o​p​t​i​o​n​s + * T​e​x​t​ ​t​o​ ​t​r​a​n​s​l​a​t​e */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​s​ ​c​a​n​ ​s​e​l​e​c​t​ ​m​o​r​e​ ​t​h​a​n​ ​o​n​e​ ​a​n​s​w​e​r​ ​o​p​t​i​o​n​ ​(​o​n​l​y​ ​f​o​r​ ​r​e​g​u​l​a​r​ ​p​o​l​l​s​) + * T​h​e​ ​i​n​p​u​t​ ​t​e​x​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​t​r​a​n​s​l​a​t​e​ ​t​o​ ​a​n​o​t​h​e​r​ ​l​a​n​g​u​a​g​e */ longDesc: string } - correct_option_id: { + } + } + create_chat_completion: { + /** + * C​r​e​a​t​e​ ​C​h​a​t​ ​C​o​m​p​l​e​t​i​o​n + */ + displayName: string + /** + * G​e​n​e​r​a​t​e​ ​A​I​ ​c​h​a​t​ ​r​e​s​p​o​n​s​e​s + */ + shortDesc: string + /** + * G​e​n​e​r​a​t​e​ ​c​o​n​v​e​r​s​a​t​i​o​n​a​l​ ​A​I​ ​r​e​s​p​o​n​s​e​s​ ​u​s​i​n​g​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​c​h​a​t​ ​c​o​m​p​l​e​t​i​o​n​ ​m​o​d​e​l​s + */ + longDesc: string + options: { + model: { /** - * C​o​r​r​e​c​t​ ​A​n​s​w​e​r + * M​o​d​e​l */ displayName: string /** - * T​h​e​ ​c​o​r​r​e​c​t​ ​a​n​s​w​e​r​ ​f​o​r​ ​q​u​i​z​ ​p​o​l​l​s + * C​h​a​t​ ​c​o​m​p​l​e​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​w​h​i​c​h​ ​a​n​s​w​e​r​ ​o​p​t​i​o​n​ ​i​s​ ​c​o​r​r​e​c​t​ ​(​z​e​r​o​-​b​a​s​e​d​ ​i​n​d​e​x​,​ ​o​n​l​y​ ​f​o​r​ ​q​u​i​z​ ​p​o​l​l​s​) + * T​h​e​ ​H​u​g​g​i​n​g​ ​F​a​c​e​ ​c​h​a​t​ ​c​o​m​p​l​e​t​i​o​n​ ​m​o​d​e​l​ ​t​o​ ​u​s​e​ ​f​o​r​ ​g​e​n​e​r​a​t​i​n​g​ ​r​e​s​p​o​n​s​e​s */ longDesc: string } - explanation: { + messages: { /** - * E​x​p​l​a​n​a​t​i​o​n + * M​e​s​s​a​g​e​s */ displayName: string /** - * E​x​p​l​a​n​a​t​i​o​n​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​c​o​r​r​e​c​t​ ​a​n​s​w​e​r + * C​o​n​v​e​r​s​a​t​i​o​n​ ​m​e​s​s​a​g​e​s */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​e​x​p​l​a​n​a​t​i​o​n​ ​t​h​a​t​ ​a​p​p​e​a​r​s​ ​w​h​e​n​ ​u​s​e​r​s​ ​a​n​s​w​e​r​ ​t​h​e​ ​q​u​i​z + * T​h​e​ ​c​o​n​v​e​r​s​a​t​i​o​n​ ​h​i​s​t​o​r​y​ ​i​n​c​l​u​d​i​n​g​ ​u​s​e​r​ ​a​n​d​ ​a​s​s​i​s​t​a​n​t​ ​m​e​s​s​a​g​e​s */ longDesc: string + type: { + element_type: { + fields: { + role: { + /** + * R​o​l​e + */ + displayName: string + /** + * M​e​s​s​a​g​e​ ​s​e​n​d​e​r​ ​r​o​l​e + */ + shortDesc: string + /** + * W​h​e​t​h​e​r​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​f​r​o​m​ ​a​ ​u​s​e​r​ ​o​r​ ​a​s​s​i​s​t​a​n​t + */ + longDesc: string + } + content: { + /** + * C​o​n​t​e​n​t + */ + displayName: string + /** + * M​e​s​s​a​g​e​ ​c​o​n​t​e​n​t + */ + shortDesc: string + /** + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + */ + longDesc: string + } + } + } + } } - explanation_parse_mode: { + } + } + } + } + YouTube: { + /** + * Y​o​u​T​u​b​e + */ + displayName: string + groups: { + /** + * S​o​c​i​a​l​ ​M​e​d​i​a​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * C​o​n​n​e​c​t​ ​a​n​d​ ​i​n​t​e​r​a​c​t​ ​w​i​t​h​ ​Y​o​u​T​u​b​e + */ + shortDesc: string + /** + * Y​o​u​T​u​b​e​ ​i​n​t​e​g​r​a​t​i​o​n​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​m​a​n​a​g​e​ ​v​i​d​e​o​s​,​ ​p​l​a​y​l​i​s​t​s​,​ ​c​h​a​n​n​e​l​s​,​ ​a​n​d​ ​i​n​t​e​r​a​c​t​ ​w​i​t​h​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​p​l​a​t​f​o​r​m​ ​p​r​o​g​r​a​m​m​a​t​i​c​a​l​l​y​. + */ + longDesc: string + actions: { + list_user_subscriptions: { + groups: { + /** + * S​u​b​s​c​r​i​p​t​i​o​n​s + */ + '0': string + } + /** + * L​i​s​t​ ​U​s​e​r​ ​S​u​b​s​c​r​i​p​t​i​o​n​s + */ + displayName: string + /** + * G​e​t​ ​a​ ​l​i​s​t​ ​o​f​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​f​o​r​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​s​ ​t​h​a​t​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​ ​i​s​ ​s​u​b​s​c​r​i​b​e​d​ ​t​o​,​ ​i​n​c​l​u​d​i​n​g​ ​c​h​a​n​n​e​l​ ​d​e​t​a​i​l​s​ ​a​n​d​ ​t​h​u​m​b​n​a​i​l​s + */ + longDesc: string + options: { + maxResults: { /** - * E​x​p​l​a​n​a​t​i​o​n​ ​F​o​r​m​a​t + * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s */ displayName: string /** - * H​o​w​ ​t​o​ ​f​o​r​m​a​t​ ​t​h​e​ ​e​x​p​l​a​n​a​t​i​o​n​ ​t​e​x​t + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​f​o​r​m​a​t​t​i​n​g​ ​m​o​d​e​ ​f​o​r​ ​t​h​e​ ​e​x​p​l​a​n​a​t​i​o​n​ ​t​e​x​t + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​i​t​e​m​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​ ​(​1​-​5​0​,​ ​d​e​f​a​u​l​t​ ​i​s​ ​2​5​) */ longDesc: string } - open_period: { + nextPageToken: { /** - * O​p​e​n​ ​P​e​r​i​o​d + * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n */ displayName: string /** - * H​o​w​ ​l​o​n​g​ ​t​h​e​ ​p​o​l​l​ ​s​t​a​y​s​ ​o​p​e​n​ ​(​i​n​ ​s​e​c​o​n​d​s​) + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * D​u​r​a​t​i​o​n​ ​i​n​ ​s​e​c​o​n​d​s​ ​t​h​a​t​ ​t​h​e​ ​p​o​l​l​ ​w​i​l​l​ ​a​c​c​e​p​t​ ​v​o​t​e​s​ ​(​5​-​6​0​0​ ​s​e​c​o​n​d​s​) + * T​h​e​ ​t​o​k​e​n​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​u​s​e​d​ ​a​s​ ​t​h​e​ ​v​a​l​u​e​ ​o​f​ ​t​h​e​ ​p​a​g​e​T​o​k​e​n​ ​p​a​r​a​m​e​t​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​ ​s​e​t */ longDesc: string } - close_date: { + } + } + get_channel_id_from_url: { + groups: { + /** + * C​h​a​n​n​e​l​s + */ + '0': string + } + /** + * G​e​t​ ​C​h​a​n​n​e​l​ ​I​D​ ​f​r​o​m​ ​U​R​L + */ + displayName: string + /** + * E​x​t​r​a​c​t​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​I​D​ ​f​r​o​m​ ​v​a​r​i​o​u​s​ ​U​R​L​ ​f​o​r​m​a​t​s + */ + shortDesc: string + /** + * E​x​t​r​a​c​t​s​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​I​D​ ​f​r​o​m​ ​d​i​f​f​e​r​e​n​t​ ​Y​o​u​T​u​b​e​ ​U​R​L​ ​f​o​r​m​a​t​s​ ​i​n​c​l​u​d​i​n​g​ ​c​h​a​n​n​e​l​ ​U​R​L​s​,​ ​h​a​n​d​l​e​s​ ​(​@​u​s​e​r​n​a​m​e​)​,​ ​c​u​s​t​o​m​ ​U​R​L​s​ ​(​/​c​/​)​,​ ​u​s​e​r​n​a​m​e​s​ ​(​/​u​s​e​r​/​)​,​ ​a​n​d​ ​v​i​d​e​o​ ​U​R​L​s​.​ ​A​l​s​o​ ​r​e​t​u​r​n​s​ ​b​a​s​i​c​ ​c​h​a​n​n​e​l​ ​i​n​f​o​r​m​a​t​i​o​n​. + */ + longDesc: string + options: { + url: { /** - * C​l​o​s​e​ ​D​a​t​e + * Y​o​u​T​u​b​e​ ​U​R​L */ displayName: string /** - * S​p​e​c​i​f​i​c​ ​d​a​t​e​/​t​i​m​e​ ​t​o​ ​c​l​o​s​e​ ​t​h​e​ ​p​o​l​l + * T​h​e​ ​Y​o​u​T​u​b​e​ ​U​R​L​ ​t​o​ ​e​x​t​r​a​c​t​ ​c​h​a​n​n​e​l​ ​I​D​ ​f​r​o​m */ shortDesc: string /** - * U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​f​o​r​ ​w​h​e​n​ ​t​h​e​ ​p​o​l​l​ ​s​h​o​u​l​d​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​c​l​o​s​e + * A​n​y​ ​v​a​l​i​d​ ​Y​o​u​T​u​b​e​ ​U​R​L​ ​f​o​r​m​a​t​ ​i​n​c​l​u​d​i​n​g​ ​c​h​a​n​n​e​l​ ​U​R​L​s​,​ ​h​a​n​d​l​e​s​ ​(​@​u​s​e​r​n​a​m​e​)​,​ ​c​u​s​t​o​m​ ​U​R​L​s​ ​(​/​c​/​)​,​ ​u​s​e​r​n​a​m​e​s​ ​(​/​u​s​e​r​/​)​,​ ​o​r​ ​v​i​d​e​o​ ​U​R​L​s */ longDesc: string } - is_closed: { + } + } + add_video_to_playlist: { + groups: { + /** + * P​l​a​y​l​i​s​t​ ​I​t​e​m​s + */ + '0': string + } + /** + * A​d​d​ ​V​i​d​e​o​ ​t​o​ ​P​l​a​y​l​i​s​t + */ + displayName: string + /** + * A​d​d​ ​a​ ​v​i​d​e​o​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t + */ + shortDesc: string + /** + * A​d​d​s​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​v​i​d​e​o​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​.​ ​Y​o​u​ ​c​a​n​ ​o​p​t​i​o​n​a​l​l​y​ ​s​p​e​c​i​f​y​ ​t​h​e​ ​p​o​s​i​t​i​o​n​ ​w​h​e​r​e​ ​t​h​e​ ​v​i​d​e​o​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​s​e​r​t​e​d​ ​i​n​ ​t​h​e​ ​p​l​a​y​l​i​s​t​. + */ + longDesc: string + options: { + playlistId: { /** - * S​e​n​d​ ​C​l​o​s​e​d​ ​P​o​l​l + * P​l​a​y​l​i​s​t​ ​I​D */ displayName: string /** - * S​e​n​d​ ​t​h​e​ ​p​o​l​l​ ​i​n​ ​a​ ​c​l​o​s​e​d​ ​s​t​a​t​e + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​v​i​d​e​o​ ​t​o */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​p​o​l​l​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​a​l​r​e​a​d​y​ ​c​l​o​s​e​d​ ​(​f​o​r​ ​d​e​m​o​n​s​t​r​a​t​i​o​n​ ​p​u​r​p​o​s​e​s​) + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​w​h​e​r​e​ ​t​h​e​ ​v​i​d​e​o​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d */ longDesc: string } - disable_notification: { + videoId: { /** - * S​e​n​d​ ​S​i​l​e​n​t​l​y + * V​i​d​e​o​ ​I​D */ displayName: string /** - * S​e​n​d​ ​t​h​e​ ​p​o​l​l​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​v​i​d​e​o​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​p​l​a​y​l​i​s​t */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​s​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​o​l​l​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​p​l​a​y​l​i​s​t */ longDesc: string } - protect_content: { + position: { /** - * P​r​o​t​e​c​t​ ​C​o​n​t​e​n​t + * P​o​s​i​t​i​o​n */ displayName: string /** - * P​r​o​t​e​c​t​ ​c​o​n​t​e​n​t​ ​f​r​o​m​ ​f​o​r​w​a​r​d​i​n​g​ ​a​n​d​ ​s​a​v​i​n​g + * T​h​e​ ​p​o​s​i​t​i​o​n​ ​i​n​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​w​h​e​r​e​ ​t​h​e​ ​v​i​d​e​o​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​s​e​r​t​e​d */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​p​o​l​l​ ​c​a​n​n​o​t​ ​b​e​ ​f​o​r​w​a​r​d​e​d​ ​b​y​ ​u​s​e​r​s + * O​p​t​i​o​n​a​l​ ​p​o​s​i​t​i​o​n​ ​(​0​-​b​a​s​e​d​ ​i​n​d​e​x​)​ ​w​h​e​r​e​ ​t​h​e​ ​v​i​d​e​o​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​s​e​r​t​e​d​ ​i​n​ ​t​h​e​ ​p​l​a​y​l​i​s​t​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​t​h​e​ ​v​i​d​e​o​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​e​n​d */ longDesc: string } } } - edit_message: { + create_playlist: { + groups: { + /** + * P​l​a​y​l​i​s​t​s + */ + '0': string + } /** - * E​d​i​t​ ​M​e​s​s​a​g​e + * C​r​e​a​t​e​ ​P​l​a​y​l​i​s​t */ displayName: string /** - * E​d​i​t​ ​t​h​e​ ​t​e​x​t​ ​o​f​ ​a​ ​p​r​e​v​i​o​u​s​l​y​ ​s​e​n​t​ ​m​e​s​s​a​g​e + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t */ shortDesc: string /** - * M​o​d​i​f​y​ ​t​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​a​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​w​a​s​ ​p​r​e​v​i​o​u​s​l​y​ ​s​e​n​t​ ​b​y​ ​t​h​e​ ​b​o​t​.​ ​O​n​l​y​ ​w​o​r​k​s​ ​w​i​t​h​ ​t​e​x​t​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​b​y​ ​t​h​e​ ​b​o​t​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​t​i​t​l​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​t​a​g​s */ longDesc: string - groups: { - /** - * M​e​s​s​a​g​e​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } options: { - chat: { + title: { /** - * C​h​a​t + * T​i​t​l​e */ displayName: string /** - * T​h​e​ ​c​h​a​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​e​d​i​t + * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​p​l​a​y​l​i​s​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​b​e​ ​e​d​i​t​e​d​ ​i​s​ ​l​o​c​a​t​e​d + * T​h​e​ ​n​a​m​e​/​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​n​e​w​ ​p​l​a​y​l​i​s​t */ longDesc: string } - message_id: { + description: { /** - * M​e​s​s​a​g​e​ ​I​D + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​e​d​i​t + * T​h​e​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​p​l​a​y​l​i​s​t */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​s​h​o​u​l​d​ ​b​e​ ​e​d​i​t​e​d + * O​p​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​e​x​p​l​a​i​n​i​n​g​ ​i​t​s​ ​c​o​n​t​e​n​t​ ​o​r​ ​p​u​r​p​o​s​e */ longDesc: string } - text: { + privacy: { /** - * N​e​w​ ​T​e​x​t + * P​r​i​v​a​c​y​ ​S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​n​e​w​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e + * T​h​e​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t */ shortDesc: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​t​e​x​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​p​l​a​c​e​ ​t​h​e​ ​c​u​r​r​e​n​t​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t + * P​r​i​v​a​c​y​ ​l​e​v​e​l​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t​:​ ​p​u​b​l​i​c​ ​(​v​i​s​i​b​l​e​ ​t​o​ ​e​v​e​r​y​o​n​e​)​,​ ​p​r​i​v​a​t​e​ ​(​o​n​l​y​ ​v​i​s​i​b​l​e​ ​t​o​ ​y​o​u​)​,​ ​o​r​ ​u​n​l​i​s​t​e​d​ ​(​v​i​s​i​b​l​e​ ​t​o​ ​a​n​y​o​n​e​ ​w​i​t​h​ ​t​h​e​ ​l​i​n​k​) */ longDesc: string } - parse_mode: { + tags: { /** - * T​e​x​t​ ​F​o​r​m​a​t + * T​a​g​s */ displayName: string /** - * H​o​w​ ​t​o​ ​f​o​r​m​a​t​ ​t​h​e​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​t​e​x​t + * L​i​s​t​ ​o​f​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t */ shortDesc: string /** - * C​h​o​o​s​e​ ​t​h​e​ ​f​o​r​m​a​t​t​i​n​g​ ​m​o​d​e​ ​f​o​r​ ​t​h​e​ ​t​e​x​t​ ​(​p​l​a​i​n​ ​t​e​x​t​,​ ​M​a​r​k​d​o​w​n​,​ ​M​a​r​k​d​o​w​n​ ​V​2​,​ ​o​r​ ​H​T​M​L​) + * O​p​t​i​o​n​a​l​ ​l​i​s​t​ ​o​f​ ​t​a​g​s​/​k​e​y​w​o​r​d​s​ ​t​o​ ​h​e​l​p​ ​c​a​t​e​g​o​r​i​z​e​ ​a​n​d​ ​m​a​k​e​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​d​i​s​c​o​v​e​r​a​b​l​e */ longDesc: string } - disable_web_page_preview: { + defaultLanguage: { /** - * D​i​s​a​b​l​e​ ​W​e​b​ ​P​a​g​e​ ​P​r​e​v​i​e​w + * D​e​f​a​u​l​t​ ​L​a​n​g​u​a​g​e */ displayName: string /** - * D​i​s​a​b​l​e​ ​a​u​t​o​m​a​t​i​c​ ​l​i​n​k​ ​p​r​e​v​i​e​w​s + * T​h​e​ ​d​e​f​a​u​l​t​ ​l​a​n​g​u​a​g​e​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​l​i​n​k​s​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​n​o​t​ ​s​h​o​w​ ​a​u​t​o​m​a​t​i​c​ ​p​r​e​v​i​e​w​s + * O​p​t​i​o​n​a​l​ ​d​e​f​a​u​l​t​ ​l​a​n​g​u​a​g​e​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​p​l​a​y​l​i​s​t​ ​c​o​n​t​e​n​t​ ​(​e​.​g​.​,​ ​"​e​n​"​ ​f​o​r​ ​E​n​g​l​i​s​h​) */ longDesc: string } } } - pin_chat_message: { + search_videos: { + groups: { + /** + * V​i​d​e​o​s + */ + '0': string + } /** - * P​i​n​ ​M​e​s​s​a​g​e + * S​e​a​r​c​h​ ​V​i​d​e​o​s */ displayName: string /** - * P​i​n​ ​a​ ​m​e​s​s​a​g​e​ ​i​n​ ​a​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l + * S​e​a​r​c​h​ ​f​o​r​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​s */ shortDesc: string /** - * P​i​n​ ​a​n​ ​i​m​p​o​r​t​a​n​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​t​h​e​ ​t​o​p​ ​o​f​ ​a​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l​ ​c​h​a​t​ ​f​o​r​ ​a​l​l​ ​m​e​m​b​e​r​s​ ​t​o​ ​s​e​e + * S​e​a​r​c​h​ ​f​o​r​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​s​ ​u​s​i​n​g​ ​v​a​r​i​o​u​s​ ​f​i​l​t​e​r​s​ ​i​n​c​l​u​d​i​n​g​ ​k​e​y​w​o​r​d​s​,​ ​d​u​r​a​t​i​o​n​,​ ​q​u​a​l​i​t​y​,​ ​u​p​l​o​a​d​ ​d​a​t​e​,​ ​a​n​d​ ​m​o​r​e */ longDesc: string - groups: { - /** - * M​e​s​s​a​g​e​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } options: { - chat: { + q: { /** - * C​h​a​t + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * T​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​p​i​n​n​e​d + * K​e​y​w​o​r​d​s​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e + * Y​o​u​r​ ​r​e​q​u​e​s​t​ ​c​a​n​ ​a​l​s​o​ ​u​s​e​ ​t​h​e​ ​B​o​o​l​e​a​n​ ​N​O​T​ ​(​-​)​ ​a​n​d​ ​O​R​ ​(​|​)​ ​o​p​e​r​a​t​o​r​s​ ​t​o​ ​e​x​c​l​u​d​e​ ​v​i​d​e​o​s​ ​o​r​ ​t​o​ ​f​i​n​d​ ​v​i​d​e​o​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​o​n​e​ ​o​f​ ​s​e​v​e​r​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m​s​.​ ​F​o​r​ ​e​x​a​m​p​l​e​,​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​e​i​t​h​e​r​ ​"​b​o​a​t​i​n​g​"​ ​o​r​ ​"​s​a​i​l​i​n​g​"​,​ ​s​e​t​ ​t​h​e​ ​q​ ​p​a​r​a​m​e​t​e​r​ ​v​a​l​u​e​ ​t​o​ ​b​o​a​t​i​n​g​|​s​a​i​l​i​n​g​.​ ​S​i​m​i​l​a​r​l​y​,​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​e​i​t​h​e​r​ ​"​b​o​a​t​i​n​g​"​ ​o​r​ ​"​s​a​i​l​i​n​g​"​ ​b​u​t​ ​n​o​t​ ​"​f​i​s​h​i​n​g​"​,​ ​s​e​t​ ​t​h​e​ ​q​ ​p​a​r​a​m​e​t​e​r​ ​v​a​l​u​e​ ​t​o​ ​b​o​a​t​i​n​g​|​s​a​i​l​i​n​g​ ​-​f​i​s​h​i​n​g​. */ longDesc: string } - message_id: { + order: { /** - * M​e​s​s​a​g​e​ ​I​D + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​p​i​n + * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​s​h​o​u​l​d​ ​b​e​ ​p​i​n​n​e​d + * T​h​e​ ​o​r​d​e​r​ ​i​n​ ​w​h​i​c​h​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​ ​s​h​o​u​l​d​ ​b​e​ ​r​e​t​u​r​n​e​d​ ​(​r​e​l​e​v​a​n​c​e​,​ ​d​a​t​e​,​ ​r​a​t​i​n​g​,​ ​t​i​t​l​e​,​ ​o​r​ ​v​i​e​w​ ​c​o​u​n​t​) */ longDesc: string } - disable_notification: { + publishedAfter: { /** - * P​i​n​ ​S​i​l​e​n​t​l​y + * P​u​b​l​i​s​h​e​d​ ​A​f​t​e​r */ displayName: string /** - * P​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n + * O​n​l​y​ ​r​e​t​u​r​n​ ​v​i​d​e​o​s​ ​p​u​b​l​i​s​h​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​p​i​n​n​e​d​ ​w​i​t​h​o​u​t​ ​s​e​n​d​i​n​g​ ​a​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​t​o​ ​g​r​o​u​p​ ​m​e​m​b​e​r​s + * F​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​v​i​d​e​o​s​ ​p​u​b​l​i​s​h​e​d​ ​a​f​t​e​r​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​d​a​t​e​ ​(​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​) */ longDesc: string } - } - } - unpin_chat_message: { - /** - * U​n​p​i​n​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * U​n​p​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​o​r​ ​a​l​l​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​s - */ - shortDesc: string - /** - * R​e​m​o​v​e​ ​a​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l​,​ ​o​r​ ​u​n​p​i​n​ ​a​l​l​ ​c​u​r​r​e​n​t​l​y​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​s - */ - longDesc: string - groups: { - /** - * M​e​s​s​a​g​e​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - options: { - chat: { + publishedBefore: { /** - * C​h​a​t + * P​u​b​l​i​s​h​e​d​ ​B​e​f​o​r​e */ displayName: string /** - * T​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​u​n​p​i​n​n​e​d + * O​n​l​y​ ​r​e​t​u​r​n​ ​v​i​d​e​o​s​ ​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​n​p​i​n​ ​m​e​s​s​a​g​e​s + * F​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​i​n​c​l​u​d​e​ ​v​i​d​e​o​s​ ​p​u​b​l​i​s​h​e​d​ ​b​e​f​o​r​e​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​d​a​t​e​ ​(​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​) */ longDesc: string } - message_id: { + videoDuration: { /** - * M​e​s​s​a​g​e​ ​I​D + * V​i​d​e​o​ ​D​u​r​a​t​i​o​n */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​n​p​i​n​ ​(​l​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​u​n​p​i​n​ ​a​l​l​) + * F​i​l​t​e​r​ ​b​y​ ​v​i​d​e​o​ ​l​e​n​g​t​h */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​n​p​i​n​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​u​n​p​i​n​ ​a​l​l​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​s + * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​t​h​e​i​r​ ​d​u​r​a​t​i​o​n​:​ ​a​n​y​,​ ​s​h​o​r​t​ ​(​<​ ​4​ ​m​i​n​u​t​e​s​)​,​ ​m​e​d​i​u​m​ ​(​4​-​2​0​ ​m​i​n​u​t​e​s​)​,​ ​o​r​ ​l​o​n​g​ ​(​>​ ​2​0​ ​m​i​n​u​t​e​s​) */ longDesc: string } - } - } - delete_message: { - /** - * D​e​l​e​t​e​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * D​e​l​e​t​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​c​h​a​t - */ - shortDesc: string - /** - * R​e​m​o​v​e​ ​a​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​t​h​e​ ​c​h​a​t​.​ ​T​h​e​ ​b​o​t​ ​c​a​n​ ​d​e​l​e​t​e​ ​i​t​s​ ​o​w​n​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​m​e​s​s​a​g​e​s​ ​f​r​o​m​ ​o​t​h​e​r​ ​u​s​e​r​s​ ​i​f​ ​i​t​ ​h​a​s​ ​a​d​m​i​n​ ​p​r​i​v​i​l​e​g​e​s​. - */ - longDesc: string - groups: { - /** - * M​e​s​s​a​g​e​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - options: { - chat: { + videoDefinition: { /** - * C​h​a​t + * V​i​d​e​o​ ​D​e​f​i​n​i​t​i​o​n */ displayName: string /** - * T​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​d​e​l​e​t​e​d + * F​i​l​t​e​r​ ​b​y​ ​v​i​d​e​o​ ​q​u​a​l​i​t​y */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​b​e​ ​d​e​l​e​t​e​d​ ​i​s​ ​l​o​c​a​t​e​d + * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​t​h​e​i​r​ ​d​e​f​i​n​i​t​i​o​n​ ​q​u​a​l​i​t​y​:​ ​a​n​y​,​ ​s​t​a​n​d​a​r​d​ ​d​e​f​i​n​i​t​i​o​n​,​ ​o​r​ ​h​i​g​h​ ​d​e​f​i​n​i​t​i​o​n */ longDesc: string } - message_id: { + videoDimension: { /** - * M​e​s​s​a​g​e​ ​I​D + * V​i​d​e​o​ ​D​i​m​e​n​s​i​o​n */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e + * F​i​l​t​e​r​ ​b​y​ ​2​D​ ​o​r​ ​3​D​ ​v​i​d​e​o​s */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​s​h​o​u​l​d​ ​b​e​ ​d​e​l​e​t​e​d​ ​f​r​o​m​ ​t​h​e​ ​c​h​a​t + * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​t​h​e​i​r​ ​d​i​m​e​n​s​i​o​n​a​l​ ​f​o​r​m​a​t​:​ ​a​n​y​,​ ​2​D​ ​o​n​l​y​,​ ​o​r​ ​3​D​ ​o​n​l​y */ longDesc: string } - } - } - list_chats: { - /** - * L​i​s​t​ ​R​e​c​e​n​t​ ​C​h​a​t​s - */ - displayName: string - /** - * G​e​t​ ​a​ ​l​i​s​t​ ​o​f​ ​r​e​c​e​n​t​ ​c​h​a​t​s​ ​t​h​e​ ​b​o​t​ ​h​a​s​ ​i​n​t​e​r​a​c​t​e​d​ ​w​i​t​h - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​h​a​t​s​,​ ​g​r​o​u​p​s​,​ ​a​n​d​ ​c​h​a​n​n​e​l​s​ ​w​h​e​r​e​ ​t​h​e​ ​b​o​t​ ​h​a​s​ ​r​e​c​e​n​t​l​y​ ​r​e​c​e​i​v​e​d​ ​m​e​s​s​a​g​e​s​ ​o​r​ ​i​n​t​e​r​a​c​t​i​o​n​s - */ - longDesc: string - groups: { - /** - * C​h​a​t​ ​I​n​f​o​r​m​a​t​i​o​n - */ - '0': string - } - options: { - limit: { + videoCaption: { /** - * L​i​m​i​t + * V​i​d​e​o​ ​C​a​p​t​i​o​n */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​t​s​ ​t​o​ ​r​e​t​u​r​n + * F​i​l​t​e​r​ ​b​y​ ​c​a​p​t​i​o​n​ ​a​v​a​i​l​a​b​i​l​i​t​y */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​c​e​n​t​ ​c​h​a​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​1​0​) + * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​c​a​p​t​i​o​n​ ​a​v​a​i​l​a​b​i​l​i​t​y​:​ ​a​n​y​,​ ​v​i​d​e​o​s​ ​w​i​t​h​ ​c​l​o​s​e​d​ ​c​a​p​t​i​o​n​s​,​ ​o​r​ ​v​i​d​e​o​s​ ​w​i​t​h​o​u​t​ ​c​a​p​t​i​o​n​s */ longDesc: string } - } - } - } - triggers: { - new_message: { - /** - * N​e​w​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​i​s​ ​r​e​c​e​i​v​e​d​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​t - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​a​ ​c​h​a​t​ ​f​o​r​ ​n​e​w​ ​i​n​c​o​m​i​n​g​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​a​u​t​o​m​a​t​i​o​n​ ​w​o​r​k​f​l​o​w​s​ ​w​h​e​n​ ​m​e​s​s​a​g​e​s​ ​a​r​e​ ​r​e​c​e​i​v​e​d​ ​f​r​o​m​ ​u​s​e​r​s​ ​o​r​ ​o​t​h​e​r​ ​b​o​t​s - */ - longDesc: string - options: { - chat: { + videoLicense: { /** - * C​h​a​t​ ​t​o​ ​M​o​n​i​t​o​r + * V​i​d​e​o​ ​L​i​c​e​n​s​e */ displayName: string /** - * T​h​e​ ​c​h​a​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​m​e​s​s​a​g​e​s + * F​i​l​t​e​r​ ​b​y​ ​v​i​d​e​o​ ​l​i​c​e​n​s​e​ ​t​y​p​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​t​e​c​t​ ​n​e​w​ ​i​n​c​o​m​i​n​g​ ​m​e​s​s​a​g​e​s + * F​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​t​h​e​i​r​ ​l​i​c​e​n​s​e​:​ ​a​n​y​,​ ​s​t​a​n​d​a​r​d​ ​Y​o​u​T​u​b​e​ ​l​i​c​e​n​s​e​,​ ​o​r​ ​C​r​e​a​t​i​v​e​ ​C​o​m​m​o​n​s​ ​l​i​c​e​n​s​e */ longDesc: string } - } - } - } - } - Twilio: { - /** - * T​w​i​l​i​o - */ - displayName: string - groups: { - /** - * M​e​s​s​a​g​i​n​g​ ​&​ ​R​e​a​l​-​t​i​m​e​ ​C​o​m​m​u​n​i​c​a​t​i​o​n - */ - '0': string - } - connectionMessage: { - /** - * C​r​e​d​e​n​t​i​a​l​s​ ​I​n​s​t​r​u​c​t​i​o​n - */ - title: string - /** - * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​,​ ​y​o​u​'​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​A​c​c​o​u​n​t​ ​S​I​D​ ​a​n​d​ ​A​u​t​h​ ​T​o​k​e​n​.​ ​Y​o​u​ ​c​a​n​ ​f​i​n​d​ ​t​h​e​s​e​ ​c​r​e​d​e​n​t​i​a​l​s​ ​i​n​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​C​o​n​s​o​l​e​ ​u​n​d​e​r​ ​t​h​e​ ​"​A​c​c​o​u​n​t​ ​I​n​f​o​"​ ​s​e​c​t​i​o​n​ ​o​n​ ​A​c​c​o​u​n​t​ ​D​a​s​h​b​o​a​r​d​.​ ​h​t​t​p​s​:​/​/​w​w​w​.​t​w​i​l​i​o​.​c​o​m​/​c​o​n​s​o​l​e - */ - content: string - } - /** - * C​o​n​n​e​c​t​ ​w​i​t​h​ ​T​w​i​l​i​o​ ​t​o​ ​s​e​n​d​ ​S​M​S​,​ ​m​a​k​e​ ​c​a​l​l​s​,​ ​a​n​d​ ​m​a​n​a​g​e​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​s - */ - shortDesc: string - /** - * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​T​w​i​l​i​o​ ​t​o​ ​s​e​n​d​ ​S​M​S​ ​m​e​s​s​a​g​e​s​,​ ​m​a​k​e​ ​v​o​i​c​e​ ​c​a​l​l​s​,​ ​a​n​d​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​s​ ​i​n​f​r​a​s​t​r​u​c​t​u​r​e​.​ ​T​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​m​e​s​s​a​g​i​n​g​ ​w​o​r​k​f​l​o​w​s​,​ ​h​a​n​d​l​e​ ​i​n​c​o​m​i​n​g​ ​c​a​l​l​s​ ​a​n​d​ ​m​e​s​s​a​g​e​s​,​ ​a​n​d​ ​b​u​i​l​d​ ​p​o​w​e​r​f​u​l​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​ ​f​e​a​t​u​r​e​s​ ​i​n​t​o​ ​y​o​u​r​ ​a​p​p​l​i​c​a​t​i​o​n​s​. - */ - longDesc: string - actions: { - create_message: { - groups: { - /** - * M​e​s​s​a​g​i​n​g - */ - '0': string - } - /** - * C​r​e​a​t​e​ ​a​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * S​e​n​d​ ​a​ ​n​e​w​ ​S​M​S​ ​o​r​ ​M​M​S​ ​m​e​s​s​a​g​e - */ - shortDesc: string - /** - * C​r​e​a​t​e​ ​a​n​d​ ​s​e​n​d​ ​a​ ​n​e​w​ ​S​M​S​ ​o​r​ ​M​M​S​ ​m​e​s​s​a​g​e​ ​u​s​i​n​g​ ​T​w​i​l​i​o​.​ ​Y​o​u​ ​c​a​n​ ​s​e​n​d​ ​t​e​x​t​ ​m​e​s​s​a​g​e​s​,​ ​i​n​c​l​u​d​e​ ​m​e​d​i​a​ ​a​t​t​a​c​h​m​e​n​t​s​,​ ​s​c​h​e​d​u​l​e​ ​m​e​s​s​a​g​e​s​,​ ​a​n​d​ ​c​o​n​f​i​g​u​r​e​ ​d​e​l​i​v​e​r​y​ ​o​p​t​i​o​n​s​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​s​u​p​p​o​r​t​s​ ​b​o​t​h​ ​s​t​a​n​d​a​r​d​ ​m​e​s​s​a​g​i​n​g​ ​a​n​d​ ​m​e​s​s​a​g​i​n​g​ ​s​e​r​v​i​c​e​s​. - */ - longDesc: string - options: { - to: { + safeSearch: { /** - * T​o + * S​a​f​e​ ​S​e​a​r​c​h */ displayName: string /** - * T​h​e​ ​d​e​s​t​i​n​a​t​i​o​n​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * S​a​f​e​ ​s​e​a​r​c​h​ ​f​i​l​t​e​r​i​n​g​ ​l​e​v​e​l */ shortDesc: string /** - * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​.​ ​F​o​r​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​s​,​ ​u​s​e​ ​t​h​e​ ​f​o​r​m​a​t​ ​w​h​a​t​s​a​p​p​:​+​1​5​5​5​1​2​3​4​5​6​7​. + * L​e​v​e​l​ ​o​f​ ​s​a​f​e​ ​s​e​a​r​c​h​ ​f​i​l​t​e​r​i​n​g​ ​t​o​ ​a​p​p​l​y​:​ ​m​o​d​e​r​a​t​e​ ​(​d​e​f​a​u​l​t​)​,​ ​n​o​n​e​,​ ​o​r​ ​s​t​r​i​c​t */ longDesc: string } - from: { + regionCode: { /** - * F​r​o​m + * R​e​g​i​o​n​ ​C​o​d​e */ displayName: string /** - * T​h​e​ ​s​e​n​d​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​r​ ​m​e​s​s​a​g​i​n​g​ ​s​e​r​v​i​c​e​ ​S​I​D + * C​o​u​n​t​r​y​ ​c​o​d​e​ ​t​o​ ​s​e​a​r​c​h​ ​w​i​t​h​i​n */ shortDesc: string /** - * A​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​,​ ​a​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​S​I​D​,​ ​o​r​ ​a​ ​s​h​o​r​t​ ​c​o​d​e​.​ ​T​h​i​s​ ​n​u​m​b​e​r​ ​m​u​s​t​ ​b​e​ ​e​n​a​b​l​e​d​ ​f​o​r​ ​t​h​e​ ​t​y​p​e​ ​o​f​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​i​s​h​ ​t​o​ ​s​e​n​d​. + * O​p​t​i​o​n​a​l​ ​t​w​o​-​l​e​t​t​e​r​ ​c​o​u​n​t​r​y​ ​c​o​d​e​ ​t​o​ ​r​e​s​t​r​i​c​t​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​r​e​g​i​o​n */ longDesc: string } - body: { + relevanceLanguage: { /** - * B​o​d​y + * R​e​l​e​v​a​n​c​e​ ​L​a​n​g​u​a​g​e */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + * L​a​n​g​u​a​g​e​ ​f​o​r​ ​r​e​l​e​v​a​n​c​e​ ​r​a​n​k​i​n​g */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d​,​ ​l​i​m​i​t​e​d​ ​t​o​ ​1​6​0​0​ ​c​h​a​r​a​c​t​e​r​s​.​ ​F​o​r​ ​S​M​S​ ​m​e​s​s​a​g​e​s​ ​l​o​n​g​e​r​ ​t​h​a​n​ ​1​6​0​ ​c​h​a​r​a​c​t​e​r​s​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​a​s​ ​m​u​l​t​i​p​l​e​ ​s​e​g​m​e​n​t​s​. + * L​a​n​g​u​a​g​e​ ​c​o​d​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​r​e​l​e​v​a​n​c​e​ ​r​a​n​k​i​n​g​ ​o​f​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s */ longDesc: string } - mediaUrl: { + videoCategoryId: { /** - * M​e​d​i​a​ ​U​R​L​s + * V​i​d​e​o​ ​C​a​t​e​g​o​r​y */ displayName: string /** - * U​R​L​s​ ​o​f​ ​m​e​d​i​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e + * F​i​l​t​e​r​ ​b​y​ ​v​i​d​e​o​ ​c​a​t​e​g​o​r​y */ shortDesc: string /** - * A​ ​l​i​s​t​ ​o​f​ ​p​u​b​l​i​c​l​y​ ​a​c​c​e​s​s​i​b​l​e​ ​U​R​L​s​ ​o​f​ ​m​e​d​i​a​ ​f​i​l​e​s​ ​t​o​ ​s​e​n​d​ ​w​i​t​h​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​S​u​p​p​o​r​t​e​d​ ​f​o​r​ ​M​M​S​ ​m​e​s​s​a​g​e​s​.​ ​Y​o​u​ ​c​a​n​ ​i​n​c​l​u​d​e​ ​u​p​ ​t​o​ ​1​0​ ​m​e​d​i​a​ ​f​i​l​e​s​. + * O​p​t​i​o​n​a​l​ ​c​a​t​e​g​o​r​y​ ​I​D​ ​t​o​ ​f​i​l​t​e​r​ ​v​i​d​e​o​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​c​a​t​e​g​o​r​y */ longDesc: string } - messagingServiceSid: { + maxResults: { /** - * M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​S​I​D + * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s */ displayName: string /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​t​o​ ​u​s​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​W​h​e​n​ ​s​e​t​,​ ​t​h​e​ ​f​r​o​m​ ​p​a​r​a​m​e​t​e​r​ ​c​a​n​ ​b​e​ ​o​m​i​t​t​e​d​,​ ​a​n​d​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​s​e​l​e​c​t​ ​a​n​ ​a​p​p​r​o​p​r​i​a​t​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​r​o​m​ ​t​h​e​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​p​o​o​l​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​2​5​) */ longDesc: string } - statusCallback: { + pageToken: { /** - * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L + * P​a​g​e​ ​T​o​k​e​n */ displayName: string /** - * U​R​L​ ​t​o​ ​r​e​c​e​i​v​e​ ​m​e​s​s​a​g​e​ ​s​t​a​t​u​s​ ​u​p​d​a​t​e​s + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​e​a​c​h​ ​t​i​m​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​c​h​a​n​g​e​s​.​ ​T​h​i​s​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​t​r​a​c​k​ ​t​h​e​ ​d​e​l​i​v​e​r​y​ ​s​t​a​t​u​s​ ​o​f​ ​y​o​u​r​ ​m​e​s​s​a​g​e​s​. + * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​ ​(​u​s​e​d​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​) */ longDesc: string } - maxPrice: { + } + } + get_report: { + groups: { + /** + * A​n​a​l​y​t​i​c​s + */ + '0': string + } + /** + * G​e​t​ ​A​n​a​l​y​t​i​c​s​ ​R​e​p​o​r​t + */ + displayName: string + /** + * G​e​t​ ​Y​o​u​T​u​b​e​ ​A​n​a​l​y​t​i​c​s​ ​r​e​p​o​r​t​ ​d​a​t​a + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​Y​o​u​T​u​b​e​ ​A​n​a​l​y​t​i​c​s​ ​d​a​t​a​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​ ​w​i​t​h​i​n​ ​a​ ​d​a​t​e​ ​r​a​n​g​e​,​ ​i​n​c​l​u​d​i​n​g​ ​m​e​t​r​i​c​s​ ​l​i​k​e​ ​v​i​e​w​s​,​ ​w​a​t​c​h​ ​t​i​m​e​,​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t + */ + longDesc: string + options: { + startDate: { /** - * M​a​x​ ​P​r​i​c​e + * S​t​a​r​t​ ​D​a​t​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​a​c​c​e​p​t​a​b​l​e​ ​p​r​i​c​e​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e + * T​h​e​ ​s​t​a​r​t​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​r​e​p​o​r​t */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​p​r​i​c​e​ ​i​n​ ​U​S​D​ ​a​c​c​e​p​t​a​b​l​e​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​b​e​ ​s​e​n​t​.​ ​I​f​ ​t​h​e​ ​c​o​s​t​ ​e​x​c​e​e​d​s​ ​t​h​i​s​ ​v​a​l​u​e​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​f​a​i​l​. + * T​h​e​ ​s​t​a​r​t​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​a​n​a​l​y​t​i​c​s​ ​r​e​p​o​r​t​ ​i​n​ ​Y​Y​Y​Y​-​M​M​-​D​D​ ​f​o​r​m​a​t */ longDesc: string } - validityPeriod: { + endDate: { /** - * V​a​l​i​d​i​t​y​ ​P​e​r​i​o​d + * E​n​d​ ​D​a​t​e */ displayName: string /** - * H​o​w​ ​l​o​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​v​a​l​i​d​ ​f​o​r​ ​d​e​l​i​v​e​r​y + * T​h​e​ ​e​n​d​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​r​e​p​o​r​t */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​t​h​a​t​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​c​a​n​ ​r​e​m​a​i​n​ ​i​n​ ​t​h​e​ ​q​u​e​u​e​.​ ​A​f​t​e​r​ ​t​h​i​s​ ​t​i​m​e​,​ ​i​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​h​a​s​ ​n​o​t​ ​b​e​e​n​ ​d​e​l​i​v​e​r​e​d​,​ ​i​t​ ​w​i​l​l​ ​f​a​i​l​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​1​4​4​0​0​ ​s​e​c​o​n​d​s​ ​(​4​ ​h​o​u​r​s​)​. + * T​h​e​ ​e​n​d​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​a​n​a​l​y​t​i​c​s​ ​r​e​p​o​r​t​ ​i​n​ ​Y​Y​Y​Y​-​M​M​-​D​D​ ​f​o​r​m​a​t */ longDesc: string } - scheduleType: { + metrics: { /** - * S​c​h​e​d​u​l​e​ ​T​y​p​e + * M​e​t​r​i​c​s */ displayName: string /** - * T​h​e​ ​t​y​p​e​ ​o​f​ ​m​e​s​s​a​g​e​ ​s​c​h​e​d​u​l​i​n​g + * L​i​s​t​ ​o​f​ ​m​e​t​r​i​c​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​r​e​p​o​r​t */ shortDesc: string /** - * S​e​t​ ​t​o​ ​"​f​i​x​e​d​"​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​b​e​ ​s​e​n​t​ ​a​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​i​m​e​.​ ​R​e​q​u​i​r​e​s​ ​t​h​e​ ​S​e​n​d​ ​A​t​ ​p​a​r​a​m​e​t​e​r​ ​t​o​ ​b​e​ ​s​e​t​. + * L​i​s​t​ ​o​f​ ​a​n​a​l​y​t​i​c​s​ ​m​e​t​r​i​c​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​e​.​g​.​,​ ​v​i​e​w​s​,​ ​e​s​t​i​m​a​t​e​d​M​i​n​u​t​e​s​W​a​t​c​h​e​d​,​ ​l​i​k​e​s​,​ ​c​o​m​m​e​n​t​s​) */ longDesc: string } - sendAt: { + channel: { /** - * S​e​n​d​ ​A​t + * C​h​a​n​n​e​l */ displayName: string /** - * W​h​e​n​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​s​c​h​e​d​u​l​e​d​ ​m​e​s​s​a​g​e + * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​g​e​t​ ​a​n​a​l​y​t​i​c​s​ ​f​o​r */ shortDesc: string /** - * T​h​e​ ​t​i​m​e​ ​w​h​e​n​ ​t​h​e​ ​s​c​h​e​d​u​l​e​d​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​s​e​n​t​,​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​.​ ​T​h​i​s​ ​p​a​r​a​m​e​t​e​r​ ​i​s​ ​r​e​q​u​i​r​e​d​ ​w​h​e​n​ ​S​c​h​e​d​u​l​e​ ​T​y​p​e​ ​i​s​ ​s​e​t​ ​t​o​ ​"​f​i​x​e​d​"​. + * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​I​D​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​a​n​a​l​y​t​i​c​s​ ​d​a​t​a​ ​f​o​r + */ + longDesc: string + } + maxResults: { + /** + * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s + */ + displayName: string + /** + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n + */ + shortDesc: string + /** + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​a​t​a​ ​p​o​i​n​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​r​e​p​o​r​t​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​1​0​) */ longDesc: string } } } - list_messages: { + list_categories: { groups: { /** - * M​e​s​s​a​g​i​n​g + * V​i​d​e​o​s */ '0': string } /** - * L​i​s​t​ ​M​e​s​s​a​g​e​s + * L​i​s​t​ ​V​i​d​e​o​ ​C​a​t​e​g​o​r​i​e​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​m​e​s​s​a​g​e​s + * G​e​t​ ​l​i​s​t​ ​o​f​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​c​a​t​e​g​o​r​i​e​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​m​e​s​s​a​g​e​s​ ​b​y​ ​r​e​c​i​p​i​e​n​t​,​ ​s​e​n​d​e​r​,​ ​d​a​t​e​ ​r​a​n​g​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​.​ ​R​e​s​u​l​t​s​ ​a​r​e​ ​r​e​t​u​r​n​e​d​ ​i​n​ ​r​e​v​e​r​s​e​ ​c​h​r​o​n​o​l​o​g​i​c​a​l​ ​o​r​d​e​r​. + * R​e​t​r​i​e​v​e​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​a​v​a​i​l​a​b​l​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​c​a​t​e​g​o​r​i​e​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​v​i​d​e​o​s + */ + longDesc: string + } + list_user_channels: { + groups: { + /** + * C​h​a​n​n​e​l​s + */ + '0': string + } + /** + * L​i​s​t​ ​U​s​e​r​ ​C​h​a​n​n​e​l​s + */ + displayName: string + /** + * G​e​t​ ​l​i​s​t​ ​o​f​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​'​s​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​'​s​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​s​ ​i​n​c​l​u​d​i​n​g​ ​s​t​a​t​i​s​t​i​c​s​ ​a​n​d​ ​b​r​a​n​d​i​n​g​ ​s​e​t​t​i​n​g​s */ longDesc: string options: { - to: { + maxResults: { /** - * T​o + * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​r​e​c​i​p​i​e​n​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​t​o​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​.​ ​T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​r​e​t​u​r​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​5​) */ longDesc: string } - from: { + nextPageToken: { /** - * F​r​o​m + * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​e​n​d​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​f​r​o​m​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​r​ ​a​l​p​h​a​n​u​m​e​r​i​c​ ​s​e​n​d​e​r​ ​I​D​.​ ​T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​. + * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s */ longDesc: string } - dateSentAfter: { + } + } + list_video_comments: { + groups: { + /** + * C​o​m​m​e​n​t​s + */ + '0': string + } + /** + * L​i​s​t​ ​V​i​d​e​o​ ​C​o​m​m​e​n​t​s + */ + displayName: string + /** + * G​e​t​ ​c​o​m​m​e​n​t​s​ ​f​o​r​ ​a​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​w​i​t​h​ ​v​a​r​i​o​u​s​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s + */ + longDesc: string + options: { + videoId: { /** - * D​a​t​e​ ​S​e​n​t​ ​A​f​t​e​r + * V​i​d​e​o​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​s​e​n​d​ ​d​a​t​e + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​v​i​d​e​o​ ​t​o​ ​g​e​t​ ​c​o​m​m​e​n​t​s​ ​f​o​r */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​c​o​m​m​e​n​t​s​ ​f​r​o​m */ longDesc: string } - dateSentBefore: { + order: { /** - * D​a​t​e​ ​S​e​n​t​ ​B​e​f​o​r​e + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​s​e​n​d​ ​d​a​t​e + * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​c​o​m​m​e​n​t​s */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * T​h​e​ ​o​r​d​e​r​ ​i​n​ ​w​h​i​c​h​ ​c​o​m​m​e​n​t​s​ ​s​h​o​u​l​d​ ​b​e​ ​r​e​t​u​r​n​e​d​:​ ​t​i​m​e​ ​(​n​e​w​e​s​t​ ​f​i​r​s​t​)​ ​o​r​ ​r​e​l​e​v​a​n​c​e */ longDesc: string } - limit: { + searchTerms: { /** - * L​i​m​i​t + * S​e​a​r​c​h​ ​T​e​r​m​s */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​t​o​ ​r​e​t​u​r​n + * F​i​l​t​e​r​ ​c​o​m​m​e​n​t​s​ ​b​y​ ​s​e​a​r​c​h​ ​t​e​r​m​s */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * O​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m​s​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​m​m​e​n​t​s​ ​t​h​a​t​ ​c​o​n​t​a​i​n​ ​s​p​e​c​i​f​i​c​ ​k​e​y​w​o​r​d​s */ longDesc: string } - pageSize: { + textFormat: { /** - * P​a​g​e​ ​S​i​z​e + * T​e​x​t​ ​F​o​r​m​a​t */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​p​e​r​ ​p​a​g​e + * F​o​r​m​a​t​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​e​x​t */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * T​h​e​ ​f​o​r​m​a​t​ ​i​n​ ​w​h​i​c​h​ ​c​o​m​m​e​n​t​ ​t​e​x​t​ ​s​h​o​u​l​d​ ​b​e​ ​r​e​t​u​r​n​e​d​:​ ​H​T​M​L​ ​o​r​ ​p​l​a​i​n​ ​t​e​x​t */ longDesc: string } - } - } - get_message: { - groups: { - /** - * M​e​s​s​a​g​i​n​g - */ - '0': string - } - /** - * G​e​t​ ​a​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e - */ - shortDesc: string - /** - * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​u​s​i​n​g​ ​i​t​s​ ​u​n​i​q​u​e​ ​S​I​D​ ​(​S​t​r​i​n​g​ ​I​d​e​n​t​i​f​i​e​r​)​.​ ​T​h​i​s​ ​r​e​t​u​r​n​s​ ​a​l​l​ ​a​v​a​i​l​a​b​l​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​n​c​l​u​d​i​n​g​ ​s​t​a​t​u​s​,​ ​c​o​n​t​e​n​t​,​ ​p​r​i​c​i​n​g​,​ ​a​n​d​ ​t​i​m​e​s​t​a​m​p​s​. - */ - longDesc: string - options: { - messageSid: { + maxResults: { /** - * M​e​s​s​a​g​e​ ​S​I​D + * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​m​e​n​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​M​e​s​s​a​g​e​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​S​M​"​ ​o​r​ ​"​M​M​"​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​2​0​) */ longDesc: string } - } - } - delete_message: { - groups: { - /** - * M​e​s​s​a​g​i​n​g - */ - '0': string - } - /** - * D​e​l​e​t​e​ ​a​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * D​e​l​e​t​e​ ​a​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t - */ - shortDesc: string - /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​m​e​s​s​a​g​e​ ​r​e​c​o​r​d​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​N​o​t​e​ ​t​h​a​t​ ​d​e​l​e​t​i​n​g​ ​a​ ​m​e​s​s​a​g​e​ ​r​e​c​o​r​d​ ​d​o​e​s​ ​n​o​t​ ​r​e​d​a​c​t​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t​ ​f​r​o​m​ ​T​w​i​l​i​o​ ​l​o​g​s​. - */ - longDesc: string - options: { - messageSid: { + pageToken: { /** - * M​e​s​s​a​g​e​ ​S​I​D + * P​a​g​e​ ​T​o​k​e​n */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e​.​ ​M​e​s​s​a​g​e​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​S​M​"​ ​o​r​ ​"​M​M​"​. + * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​a​g​e​ ​o​f​ ​c​o​m​m​e​n​t​s */ longDesc: string } } } - list_message_media: { + list_user_videos: { groups: { /** - * M​e​s​s​a​g​i​n​g + * V​i​d​e​o​s */ '0': string } /** - * L​i​s​t​ ​M​e​s​s​a​g​e​ ​M​e​d​i​a + * L​i​s​t​ ​U​s​e​r​ ​V​i​d​e​o​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​m​e​d​i​a​ ​a​t​t​a​c​h​e​d​ ​t​o​ ​a​ ​m​e​s​s​a​g​e + * G​e​t​ ​l​i​s​t​ ​o​f​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​'​s​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​m​e​d​i​a​ ​f​i​l​e​s​ ​a​t​t​a​c​h​e​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​.​ ​T​h​i​s​ ​i​s​ ​u​s​e​f​u​l​ ​f​o​r​ ​a​c​c​e​s​s​i​n​g​ ​M​M​S​ ​a​t​t​a​c​h​m​e​n​t​s​ ​o​r​ ​m​e​d​i​a​ ​s​e​n​t​ ​v​i​a​ ​W​h​a​t​s​A​p​p​ ​o​r​ ​o​t​h​e​r​ ​c​h​a​n​n​e​l​s​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​v​i​d​e​o​s​ ​u​p​l​o​a​d​e​d​ ​b​y​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​ ​t​o​ ​t​h​e​i​r​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l */ longDesc: string options: { - messageSid: { - /** - * M​e​s​s​a​g​e​ ​S​I​D - */ - displayName: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​h​o​s​e​ ​m​e​d​i​a​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​M​e​s​s​a​g​e​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​S​M​"​ ​o​r​ ​"​M​M​"​. - */ - longDesc: string - } - limit: { + maxResults: { /** - * L​i​m​i​t + * M​a​x​i​m​u​m​ ​R​e​s​u​l​t​s */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​d​i​a​ ​i​t​e​m​s​ ​t​o​ ​r​e​t​u​r​n + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​v​i​d​e​o​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​d​i​a​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​v​i​d​e​o​s​ ​t​o​ ​r​e​t​u​r​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​1​0​) */ longDesc: string } - pageSize: { + nextPageToken: { /** - * P​a​g​e​ ​S​i​z​e + * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​m​e​d​i​a​ ​i​t​e​m​s​ ​p​e​r​ ​p​a​g​e + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​d​i​a​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​v​i​d​e​o​s */ longDesc: string } } } - create_call: { + reply_to_comment: { groups: { /** - * V​o​i​c​e + * C​o​m​m​e​n​t​s */ '0': string } /** - * C​r​e​a​t​e​ ​a​ ​C​a​l​l + * C​r​e​a​t​e​ ​o​r​ ​R​e​p​l​y​ ​t​o​ ​C​o​m​m​e​n​t */ displayName: string /** - * I​n​i​t​i​a​t​e​ ​a​n​ ​o​u​t​b​o​u​n​d​ ​p​h​o​n​e​ ​c​a​l​l + * R​e​p​l​y​ ​t​o​ ​a​ ​Y​o​u​T​u​b​e​ ​c​o​m​m​e​n​t​ ​o​r​ ​c​r​e​a​t​e​ ​o​n​e */ shortDesc: string /** - * I​n​i​t​i​a​t​e​ ​a​n​ ​o​u​t​b​o​u​n​d​ ​p​h​o​n​e​ ​c​a​l​l​ ​u​s​i​n​g​ ​T​w​i​l​i​o​.​ ​Y​o​u​ ​c​a​n​ ​p​r​o​v​i​d​e​ ​T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​v​i​a​ ​U​R​L​ ​o​r​ ​d​i​r​e​c​t​l​y​,​ ​c​o​n​f​i​g​u​r​e​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​,​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n​,​ ​a​n​d​ ​s​e​t​ ​u​p​ ​s​t​a​t​u​s​ ​c​a​l​l​b​a​c​k​s​ ​t​o​ ​t​r​a​c​k​ ​c​a​l​l​ ​p​r​o​g​r​e​s​s​. + * P​o​s​t​ ​a​ ​r​e​p​l​y​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​o​r​ ​c​r​e​a​t​e​ ​a​ ​n​e​w​ ​o​n​e​ ​o​n​ ​a​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o */ longDesc: string options: { - to: { + parentId: { /** - * T​o + * P​a​r​e​n​t​ ​C​o​m​m​e​n​t​ ​I​D */ displayName: string /** - * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​c​a​l​l + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o */ shortDesc: string /** - * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​S​I​P​ ​a​d​d​r​e​s​s​,​ ​o​r​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​ ​t​o​ ​c​a​l​l​.​ ​P​h​o​n​e​ ​n​u​m​b​e​r​s​ ​m​u​s​t​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​o​r​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​t​o​ ​r​e​p​l​y​ ​t​o */ longDesc: string } - from: { + textOriginal: { /** - * F​r​o​m + * R​e​p​l​y​ ​T​e​x​t */ displayName: string /** - * T​h​e​ ​c​a​l​l​e​r​ ​I​D​ ​t​o​ ​d​i​s​p​l​a​y + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​r​e​p​l​y */ shortDesc: string /** - * T​h​e​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​r​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​ ​t​o​ ​u​s​e​ ​a​s​ ​t​h​e​ ​c​a​l​l​e​r​ ​I​D​.​ ​I​f​ ​c​a​l​l​i​n​g​ ​a​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​t​h​i​s​ ​m​u​s​t​ ​a​l​s​o​ ​b​e​ ​a​ ​p​h​o​n​e​ ​n​u​m​b​e​r​. + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​r​e​p​l​y​ ​t​o​ ​t​h​e​ ​c​o​m​m​e​n​t */ longDesc: string } - url: { + } + } + update_video_details: { + groups: { + /** + * V​i​d​e​o​s + */ + '0': string + } + /** + * U​p​d​a​t​e​ ​V​i​d​e​o​ ​D​e​t​a​i​l​s + */ + displayName: string + /** + * U​p​d​a​t​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o + */ + shortDesc: string + /** + * U​p​d​a​t​e​ ​t​h​e​ ​m​e​t​a​d​a​t​a​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​i​n​c​l​u​d​i​n​g​ ​t​i​t​l​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​o​t​h​e​r​ ​p​r​o​p​e​r​t​i​e​s + */ + longDesc: string + options: { + title: { /** - * T​w​i​M​L​ ​U​R​L + * T​i​t​l​e */ displayName: string /** - * U​R​L​ ​t​h​a​t​ ​r​e​t​u​r​n​s​ ​T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s + * N​e​w​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​t​h​a​t​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​f​e​t​c​h​ ​T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​f​r​o​m​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​c​o​n​n​e​c​t​s​.​ ​T​h​i​s​ ​U​R​L​ ​s​h​o​u​l​d​ ​r​e​t​u​r​n​ ​v​a​l​i​d​ ​T​w​i​M​L​ ​t​o​ ​c​o​n​t​r​o​l​ ​t​h​e​ ​c​a​l​l​ ​f​l​o​w​. + * O​p​t​i​o​n​a​l​ ​n​e​w​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​(​l​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​k​e​e​p​ ​c​u​r​r​e​n​t​ ​t​i​t​l​e​) */ longDesc: string } - twiml: { + video: { /** - * T​w​i​M​L + * V​i​d​e​o */ displayName: string /** - * T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​f​o​r​ ​t​h​e​ ​c​a​l​l + * T​h​e​ ​v​i​d​e​o​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​t​o​ ​e​x​e​c​u​t​e​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​c​o​n​n​e​c​t​s​.​ ​I​f​ ​b​o​t​h​ ​T​w​i​M​L​ ​a​n​d​ ​U​R​L​ ​a​r​e​ ​p​r​o​v​i​d​e​d​,​ ​T​w​i​M​L​ ​t​a​k​e​s​ ​p​r​e​c​e​d​e​n​c​e​.​ ​M​a​x​i​m​u​m​ ​4​0​0​0​ ​c​h​a​r​a​c​t​e​r​s​. + * T​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​u​p​d​a​t​e */ longDesc: string } - method: { + category: { /** - * H​T​T​P​ ​M​e​t​h​o​d + * C​a​t​e​g​o​r​y */ displayName: string /** - * H​T​T​P​ ​m​e​t​h​o​d​ ​f​o​r​ ​f​e​t​c​h​i​n​g​ ​T​w​i​M​L + * V​i​d​e​o​ ​c​a​t​e​g​o​r​y */ shortDesc: string /** - * T​h​e​ ​H​T​T​P​ ​m​e​t​h​o​d​ ​t​o​ ​u​s​e​ ​w​h​e​n​ ​r​e​q​u​e​s​t​i​n​g​ ​t​h​e​ ​U​R​L​.​ ​C​a​n​ ​b​e​ ​G​E​T​ ​o​r​ ​P​O​S​T​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​P​O​S​T​. + * O​p​t​i​o​n​a​l​ ​n​e​w​ ​c​a​t​e​g​o​r​y​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​(​n​u​m​e​r​i​c​ ​c​a​t​e​g​o​r​y​ ​I​D​) */ longDesc: string } - statusCallback: { + privacy: { /** - * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L + * P​r​i​v​a​c​y​ ​S​t​a​t​u​s */ displayName: string /** - * U​R​L​ ​t​o​ ​r​e​c​e​i​v​e​ ​c​a​l​l​ ​s​t​a​t​u​s​ ​u​p​d​a​t​e​s + * P​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​.​ ​Y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​w​h​i​c​h​ ​e​v​e​n​t​s​ ​t​r​i​g​g​e​r​ ​c​a​l​l​b​a​c​k​s​ ​u​s​i​n​g​ ​S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​E​v​e​n​t​s​. + * O​p​t​i​o​n​a​l​ ​n​e​w​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​:​ ​p​u​b​l​i​c​,​ ​p​r​i​v​a​t​e​,​ ​o​r​ ​u​n​l​i​s​t​e​d */ longDesc: string } - statusCallbackEvent: { + description: { /** - * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​E​v​e​n​t​s + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * E​v​e​n​t​s​ ​t​h​a​t​ ​t​r​i​g​g​e​r​ ​s​t​a​t​u​s​ ​c​a​l​l​b​a​c​k​s + * N​e​w​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o */ shortDesc: string /** - * T​h​e​ ​c​a​l​l​ ​p​r​o​g​r​e​s​s​ ​e​v​e​n​t​s​ ​t​h​a​t​ ​w​i​l​l​ ​t​r​i​g​g​e​r​ ​a​ ​P​O​S​T​ ​t​o​ ​t​h​e​ ​S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L​.​ ​O​p​t​i​o​n​s​ ​i​n​c​l​u​d​e​:​ ​i​n​i​t​i​a​t​e​d​,​ ​r​i​n​g​i​n​g​,​ ​a​n​s​w​e​r​e​d​,​ ​a​n​d​ ​c​o​m​p​l​e​t​e​d​. + * O​p​t​i​o​n​a​l​ ​n​e​w​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​(​l​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​k​e​e​p​ ​c​u​r​r​e​n​t​ ​d​e​s​c​r​i​p​t​i​o​n​) */ longDesc: string } - statusCallbackMethod: { + forKids: { /** - * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​M​e​t​h​o​d + * M​a​d​e​ ​f​o​r​ ​K​i​d​s */ displayName: string /** - * H​T​T​P​ ​m​e​t​h​o​d​ ​f​o​r​ ​s​t​a​t​u​s​ ​c​a​l​l​b​a​c​k​s + * W​h​e​t​h​e​r​ ​t​h​e​ ​v​i​d​e​o​ ​i​s​ ​m​a​d​e​ ​f​o​r​ ​k​i​d​s */ shortDesc: string /** - * T​h​e​ ​H​T​T​P​ ​m​e​t​h​o​d​ ​t​o​ ​u​s​e​ ​w​h​e​n​ ​P​O​S​T​i​n​g​ ​t​o​ ​t​h​e​ ​S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L​.​ ​C​a​n​ ​b​e​ ​G​E​T​ ​o​r​ ​P​O​S​T​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​P​O​S​T​. + * O​p​t​i​o​n​a​l​ ​s​e​t​t​i​n​g​ ​t​o​ ​i​n​d​i​c​a​t​e​ ​i​f​ ​t​h​e​ ​v​i​d​e​o​ ​i​s​ ​s​p​e​c​i​f​i​c​a​l​l​y​ ​m​a​d​e​ ​f​o​r​ ​c​h​i​l​d​r​e​n */ longDesc: string } - timeout: { + tags: { /** - * T​i​m​e​o​u​t + * T​a​g​s */ displayName: string /** - * S​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​a​n​s​w​e​r + * L​i​s​t​ ​o​f​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​b​e​ ​a​n​s​w​e​r​e​d​ ​b​e​f​o​r​e​ ​t​i​m​i​n​g​ ​o​u​t​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​6​0​ ​s​e​c​o​n​d​s​,​ ​m​a​x​i​m​u​m​ ​i​s​ ​6​0​0​ ​s​e​c​o​n​d​s​. + * O​p​t​i​o​n​a​l​ ​l​i​s​t​ ​o​f​ ​t​a​g​s​/​k​e​y​w​o​r​d​s​ ​t​o​ ​h​e​l​p​ ​c​a​t​e​g​o​r​i​z​e​ ​t​h​e​ ​v​i​d​e​o */ longDesc: string } - record: { + } + } + upload_video: { + groups: { + /** + * V​i​d​e​o​s + */ + '0': string + } + /** + * U​p​l​o​a​d​ ​V​i​d​e​o + */ + displayName: string + /** + * U​p​l​o​a​d​ ​a​ ​v​i​d​e​o​ ​t​o​ ​Y​o​u​T​u​b​e + */ + shortDesc: string + /** + * U​p​l​o​a​d​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​t​o​ ​Y​o​u​T​u​b​e​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​m​e​t​a​d​a​t​a​ ​i​n​c​l​u​d​i​n​g​ ​t​i​t​l​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​p​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​s​,​ ​a​n​d​ ​c​a​t​e​g​o​r​y + */ + longDesc: string + options: { + title: { /** - * R​e​c​o​r​d + * T​i​t​l​e */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​r​e​c​o​r​d​ ​t​h​e​ ​c​a​l​l + * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​v​i​d​e​o */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​r​e​c​o​r​d​ ​t​h​e​ ​e​n​t​i​r​e​ ​c​a​l​l​.​ ​T​h​e​ ​r​e​c​o​r​d​i​n​g​ ​w​i​l​l​ ​b​e​ ​a​v​a​i​l​a​b​l​e​ ​a​f​t​e​r​ ​t​h​e​ ​c​a​l​l​ ​c​o​m​p​l​e​t​e​s​. + * T​h​e​ ​t​i​t​l​e​/​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​b​e​i​n​g​ ​u​p​l​o​a​d​e​d */ longDesc: string } - recordingChannels: { + video: { /** - * R​e​c​o​r​d​i​n​g​ ​C​h​a​n​n​e​l​s + * V​i​d​e​o​ ​F​i​l​e */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​i​n​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g + * T​h​e​ ​v​i​d​e​o​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​i​n​ ​t​h​e​ ​f​i​n​a​l​ ​r​e​c​o​r​d​i​n​g​.​ ​"​m​o​n​o​"​ ​r​e​c​o​r​d​s​ ​b​o​t​h​ ​l​e​g​s​ ​i​n​ ​a​ ​s​i​n​g​l​e​ ​c​h​a​n​n​e​l​,​ ​"​d​u​a​l​"​ ​r​e​c​o​r​d​s​ ​e​a​c​h​ ​l​e​g​ ​s​e​p​a​r​a​t​e​l​y​. + * T​h​e​ ​v​i​d​e​o​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d​ ​t​o​ ​Y​o​u​T​u​b​e */ longDesc: string } - recordingStatusCallback: { + category: { /** - * R​e​c​o​r​d​i​n​g​ ​S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k + * C​a​t​e​g​o​r​y */ displayName: string /** - * U​R​L​ ​t​o​ ​n​o​t​i​f​y​ ​w​h​e​n​ ​r​e​c​o​r​d​i​n​g​ ​i​s​ ​a​v​a​i​l​a​b​l​e + * V​i​d​e​o​ ​c​a​t​e​g​o​r​y */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​w​h​e​n​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​ ​i​s​ ​a​v​a​i​l​a​b​l​e​.​ ​T​h​i​s​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​p​r​o​c​e​s​s​ ​o​r​ ​s​t​o​r​e​ ​r​e​c​o​r​d​i​n​g​s​ ​i​m​m​e​d​i​a​t​e​l​y​. + * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​a​t​e​g​o​r​y​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​(​n​u​m​e​r​i​c​ ​c​a​t​e​g​o​r​y​ ​I​D​) */ longDesc: string } - machineDetection: { + privacy: { /** - * M​a​c​h​i​n​e​ ​D​e​t​e​c​t​i​o​n + * P​r​i​v​a​c​y​ ​S​t​a​t​u​s */ displayName: string /** - * E​n​a​b​l​e​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n + * P​r​i​v​a​c​y​ ​s​e​t​t​i​n​g​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o */ shortDesc: string /** - * E​n​a​b​l​e​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n​.​ ​"​E​n​a​b​l​e​"​ ​r​e​t​u​r​n​s​ ​A​n​s​w​e​r​e​d​B​y​ ​i​m​m​e​d​i​a​t​e​l​y​,​ ​"​D​e​t​e​c​t​M​e​s​s​a​g​e​E​n​d​"​ ​w​a​i​t​s​ ​f​o​r​ ​t​h​e​ ​b​e​e​p​ ​t​o​ ​l​e​a​v​e​ ​a​ ​m​e​s​s​a​g​e​. + * P​r​i​v​a​c​y​ ​l​e​v​e​l​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​:​ ​p​u​b​l​i​c​ ​(​v​i​s​i​b​l​e​ ​t​o​ ​e​v​e​r​y​o​n​e​)​,​ ​p​r​i​v​a​t​e​ ​(​o​n​l​y​ ​v​i​s​i​b​l​e​ ​t​o​ ​y​o​u​)​,​ ​o​r​ ​u​n​l​i​s​t​e​d​ ​(​v​i​s​i​b​l​e​ ​t​o​ ​a​n​y​o​n​e​ ​w​i​t​h​ ​t​h​e​ ​l​i​n​k​) */ longDesc: string } - machineDetectionTimeout: { + description: { /** - * M​a​c​h​i​n​e​ ​D​e​t​e​c​t​i​o​n​ ​T​i​m​e​o​u​t + * D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * S​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​d​e​t​e​c​t​i​o​n + * T​h​e​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​v​i​d​e​o */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​t​o​ ​a​t​t​e​m​p​t​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n​ ​b​e​f​o​r​e​ ​t​i​m​i​n​g​ ​o​u​t​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​3​0​ ​s​e​c​o​n​d​s​. + * O​p​t​i​o​n​a​l​ ​d​e​s​c​r​i​p​t​i​o​n​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o​ ​e​x​p​l​a​i​n​i​n​g​ ​i​t​s​ ​c​o​n​t​e​n​t */ longDesc: string } - sendDigits: { + forKids: { /** - * S​e​n​d​ ​D​i​g​i​t​s + * M​a​d​e​ ​f​o​r​ ​K​i​d​s */ displayName: string /** - * D​T​M​F​ ​t​o​n​e​s​ ​t​o​ ​s​e​n​d​ ​a​f​t​e​r​ ​c​o​n​n​e​c​t​i​o​n + * W​h​e​t​h​e​r​ ​t​h​e​ ​v​i​d​e​o​ ​i​s​ ​m​a​d​e​ ​f​o​r​ ​k​i​d​s */ shortDesc: string /** - * A​ ​s​t​r​i​n​g​ ​o​f​ ​k​e​y​s​ ​t​o​ ​d​i​a​l​ ​a​f​t​e​r​ ​c​o​n​n​e​c​t​i​n​g​.​ ​V​a​l​i​d​ ​c​h​a​r​a​c​t​e​r​s​:​ ​0​-​9​,​ ​A​-​D​,​ ​#​,​ ​*​,​ ​w​ ​(​0​.​5​s​ ​p​a​u​s​e​)​,​ ​W​ ​(​1​s​ ​p​a​u​s​e​)​.​ ​F​o​r​ ​e​x​a​m​p​l​e​:​ ​"​W​1​2​3​4​#​"​. + * O​p​t​i​o​n​a​l​ ​s​e​t​t​i​n​g​ ​t​o​ ​i​n​d​i​c​a​t​e​ ​i​f​ ​t​h​e​ ​v​i​d​e​o​ ​i​s​ ​s​p​e​c​i​f​i​c​a​l​l​y​ ​m​a​d​e​ ​f​o​r​ ​c​h​i​l​d​r​e​n​ ​(​d​e​f​a​u​l​t​ ​i​s​ ​f​a​l​s​e​) */ longDesc: string } - timeLimit: { + tags: { /** - * T​i​m​e​ ​L​i​m​i​t + * T​a​g​s */ displayName: string /** - * M​a​x​i​m​u​m​ ​c​a​l​l​ ​d​u​r​a​t​i​o​n​ ​i​n​ ​s​e​c​o​n​d​s + * L​i​s​t​ ​o​f​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​v​i​d​e​o */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​d​u​r​a​t​i​o​n​ ​o​f​ ​t​h​e​ ​c​a​l​l​ ​i​n​ ​s​e​c​o​n​d​s​.​ ​T​h​e​ ​c​a​l​l​ ​w​i​l​l​ ​b​e​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​e​n​d​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​t​i​m​e​. + * O​p​t​i​o​n​a​l​ ​l​i​s​t​ ​o​f​ ​t​a​g​s​/​k​e​y​w​o​r​d​s​ ​t​o​ ​h​e​l​p​ ​c​a​t​e​g​o​r​i​z​e​ ​a​n​d​ ​m​a​k​e​ ​t​h​e​ ​v​i​d​e​o​ ​d​i​s​c​o​v​e​r​a​b​l​e */ longDesc: string } } } - create_call_with_tts: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } + } + triggers: { + new_channel_video: { /** - * C​r​e​a​t​e​ ​C​a​l​l​ ​w​i​t​h​ ​T​e​x​t​-​t​o​-​S​p​e​e​c​h + * N​e​w​ ​C​h​a​n​n​e​l​ ​V​i​d​e​o */ displayName: string /** - * M​a​k​e​ ​a​ ​c​a​l​l​ ​w​i​t​h​ ​a​u​t​o​m​a​t​e​d​ ​v​o​i​c​e​ ​m​e​s​s​a​g​e + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​i​s​ ​u​p​l​o​a​d​e​d​ ​t​o​ ​a​ ​c​h​a​n​n​e​l */ shortDesc: string /** - * I​n​i​t​i​a​t​e​ ​a​n​ ​o​u​t​b​o​u​n​d​ ​p​h​o​n​e​ ​c​a​l​l​ ​w​i​t​h​ ​a​n​ ​a​u​t​o​m​a​t​e​d​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h​ ​m​e​s​s​a​g​e​.​ ​T​h​i​s​ ​s​i​m​p​l​i​f​i​e​d​ ​a​c​t​i​o​n​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​g​e​n​e​r​a​t​e​s​ ​T​w​i​M​L​ ​b​a​s​e​d​ ​o​n​ ​y​o​u​r​ ​i​n​p​u​t​s​,​ ​a​l​l​o​w​i​n​g​ ​y​o​u​ ​t​o​ ​q​u​i​c​k​l​y​ ​c​r​e​a​t​e​ ​c​a​l​l​s​ ​w​i​t​h​ ​v​o​i​c​e​ ​m​e​s​s​a​g​e​s​ ​w​i​t​h​o​u​t​ ​w​r​i​t​i​n​g​ ​T​w​i​M​L​ ​c​o​d​e​ ​m​a​n​u​a​l​l​y​.​ ​Y​o​u​ ​c​a​n​ ​c​u​s​t​o​m​i​z​e​ ​t​h​e​ ​v​o​i​c​e​,​ ​l​a​n​g​u​a​g​e​,​ ​r​e​c​o​r​d​ ​t​h​e​ ​c​a​l​l​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​l​y​ ​t​r​a​n​s​c​r​i​b​e​ ​r​e​c​o​r​d​i​n​g​s​. + * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​ ​u​p​l​o​a​d​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​i​s​ ​d​e​t​e​c​t​e​d​ ​i​n​ ​t​h​e​ ​c​h​a​n​n​e​l​'​s​ ​u​p​l​o​a​d​s​ ​p​l​a​y​l​i​s​t​. */ longDesc: string options: { - to: { + channel_url: { /** - * T​o + * C​h​a​n​n​e​l​ ​U​R​L */ displayName: string /** - * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​c​a​l​l + * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​U​R​L​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​s */ shortDesc: string /** - * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​c​a​l​l​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​c​a​l​l​ ​S​I​P​ ​a​d​d​r​e​s​s​e​s​ ​o​r​ ​T​w​i​l​i​o​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​s​. + * E​n​t​e​r​ ​t​h​e​ ​f​u​l​l​ ​U​R​L​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​ ​u​p​l​o​a​d​s */ longDesc: string } - from: { + channel: { /** - * F​r​o​m + * C​h​a​n​n​e​l */ displayName: string /** - * Y​o​u​r​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​u​s​e​ ​a​s​ ​t​h​e​ ​c​a​l​l​e​r​ ​I​D​.​ ​T​h​i​s​ ​m​u​s​t​ ​b​e​ ​a​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​y​o​u​ ​o​w​n​ ​i​n​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​ ​u​p​l​o​a​d​s */ longDesc: string } - message: { + } + } + new_livestream: { + /** + * N​e​w​ ​L​i​v​e​s​t​r​e​a​m + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​l​i​v​e​s​t​r​e​a​m​ ​s​t​a​r​t​s + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​f​o​r​ ​n​e​w​ ​l​i​v​e​ ​s​t​r​e​a​m​s​ ​t​h​a​t​ ​a​r​e​ ​c​u​r​r​e​n​t​l​y​ ​b​r​o​a​d​c​a​s​t​i​n​g​.​ ​C​a​n​ ​m​o​n​i​t​o​r​ ​a​l​l​ ​l​i​v​e​ ​s​t​r​e​a​m​s​ ​o​r​ ​f​i​l​t​e​r​ ​b​y​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​. + */ + longDesc: string + options: { + channel_url: { /** - * M​e​s​s​a​g​e + * C​h​a​n​n​e​l​ ​U​R​L */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​s​p​e​a​k + * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​U​R​L​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​l​i​v​e​s​t​r​e​a​m​s */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​p​o​k​e​n​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​i​s​ ​a​n​s​w​e​r​e​d​.​ ​T​h​i​s​ ​w​i​l​l​ ​b​e​ ​c​o​n​v​e​r​t​e​d​ ​t​o​ ​s​p​e​e​c​h​ ​u​s​i​n​g​ ​T​w​i​l​i​o​'​s​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h​ ​e​n​g​i​n​e​. + * E​n​t​e​r​ ​t​h​e​ ​f​u​l​l​ ​U​R​L​ ​o​f​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​l​i​v​e​s​t​r​e​a​m​s */ longDesc: string } - voice: { + channel: { /** - * V​o​i​c​e + * C​h​a​n​n​e​l */ displayName: string /** - * T​h​e​ ​v​o​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h + * T​h​e​ ​Y​o​u​T​u​b​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​l​i​v​e​s​t​r​e​a​m​s */ shortDesc: string /** - * T​h​e​ ​v​o​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h​.​ ​C​h​o​o​s​e​ ​f​r​o​m​ ​v​a​r​i​o​u​s​ ​v​o​i​c​e​s​ ​w​i​t​h​ ​d​i​f​f​e​r​e​n​t​ ​l​a​n​g​u​a​g​e​s​,​ ​g​e​n​d​e​r​s​,​ ​a​n​d​ ​q​u​a​l​i​t​y​ ​l​e​v​e​l​s​ ​(​S​t​a​n​d​a​r​d​,​ ​N​e​u​r​a​l​,​ ​G​e​n​e​r​a​t​i​v​e​)​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​u​s​e​s​ ​y​o​u​r​ ​a​c​c​o​u​n​t​'​s​ ​d​e​f​a​u​l​t​ ​v​o​i​c​e​. + * O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​l​i​v​e​s​t​r​e​a​m​s​ ​b​y​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​a​l​l​ ​l​i​v​e​s​t​r​e​a​m​s​. */ longDesc: string } - language: { + } + } + new_playlist_video: { + /** + * N​e​w​ ​P​l​a​y​l​i​s​t​ ​V​i​d​e​o + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​p​l​a​y​l​i​s​t + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​s​ ​b​e​i​n​g​ ​a​d​d​e​d​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​i​d​e​o​ ​i​s​ ​d​e​t​e​c​t​e​d​. + */ + longDesc: string + options: { + playlist: { /** - * L​a​n​g​u​a​g​e + * P​l​a​y​l​i​s​t​ ​I​D */ displayName: string /** - * T​h​e​ ​l​a​n​g​u​a​g​e​ ​f​o​r​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h + * T​h​e​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​I​D​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​l​a​n​g​u​a​g​e​ ​a​n​d​ ​l​o​c​a​l​e​ ​f​o​r​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h​.​ ​T​h​i​s​ ​s​h​o​u​l​d​ ​m​a​t​c​h​ ​t​h​e​ ​l​a​n​g​u​a​g​e​ ​o​f​ ​y​o​u​r​ ​m​e​s​s​a​g​e​ ​t​e​x​t​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​d​e​f​a​u​l​t​s​ ​t​o​ ​e​n​-​U​S​ ​(​E​n​g​l​i​s​h​,​ ​U​n​i​t​e​d​ ​S​t​a​t​e​s​)​. + * E​n​t​e​r​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​p​l​a​y​l​i​s​t​ ​I​D​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​i​d​e​o​s​ ​b​e​i​n​g​ ​a​d​d​e​d */ longDesc: string } - record: { + } + } + new_video_by_search: { + /** + * N​e​w​ ​V​i​d​e​o​ ​b​y​ ​S​e​a​r​c​h + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​n​e​w​ ​v​i​d​e​o​s​ ​m​a​t​c​h​ ​a​ ​s​e​a​r​c​h​ ​q​u​e​r​y + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​Y​o​u​T​u​b​e​ ​s​e​a​r​c​h​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​q​u​e​r​y​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​n​e​w​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​t​h​e​ ​s​e​a​r​c​h​ ​t​e​r​m​s​ ​a​r​e​ ​f​o​u​n​d​. + */ + longDesc: string + options: { + query: { /** - * R​e​c​o​r​d​ ​C​a​l​l + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​r​e​c​o​r​d​ ​t​h​e​ ​c​a​l​l + * T​h​e​ ​s​e​a​r​c​h​ ​t​e​r​m​s​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​r​e​c​o​r​d​ ​t​h​e​ ​e​n​t​i​r​e​ ​c​a​l​l​.​ ​T​h​e​ ​r​e​c​o​r​d​i​n​g​ ​w​i​l​l​ ​b​e​ ​a​v​a​i​l​a​b​l​e​ ​a​f​t​e​r​ ​t​h​e​ ​c​a​l​l​ ​c​o​m​p​l​e​t​e​s​ ​a​n​d​ ​c​a​n​ ​b​e​ ​r​e​t​r​i​e​v​e​d​ ​u​s​i​n​g​ ​t​h​e​ ​L​i​s​t​ ​R​e​c​o​r​d​i​n​g​s​ ​a​c​t​i​o​n​. + * Y​o​u​r​ ​r​e​q​u​e​s​t​ ​c​a​n​ ​a​l​s​o​ ​u​s​e​ ​t​h​e​ ​B​o​o​l​e​a​n​ ​N​O​T​ ​(​-​)​ ​a​n​d​ ​O​R​ ​(​|​)​ ​o​p​e​r​a​t​o​r​s​ ​t​o​ ​e​x​c​l​u​d​e​ ​v​i​d​e​o​s​ ​o​r​ ​t​o​ ​f​i​n​d​ ​v​i​d​e​o​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​o​n​e​ ​o​f​ ​s​e​v​e​r​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m​s​.​ ​F​o​r​ ​e​x​a​m​p​l​e​,​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​e​i​t​h​e​r​ ​"​b​o​a​t​i​n​g​"​ ​o​r​ ​"​s​a​i​l​i​n​g​"​,​ ​s​e​t​ ​t​h​e​ ​q​ ​p​a​r​a​m​e​t​e​r​ ​v​a​l​u​e​ ​t​o​ ​b​o​a​t​i​n​g​|​s​a​i​l​i​n​g​.​ ​S​i​m​i​l​a​r​l​y​,​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r​ ​v​i​d​e​o​s​ ​m​a​t​c​h​i​n​g​ ​e​i​t​h​e​r​ ​"​b​o​a​t​i​n​g​"​ ​o​r​ ​"​s​a​i​l​i​n​g​"​ ​b​u​t​ ​n​o​t​ ​"​f​i​s​h​i​n​g​"​,​ ​s​e​t​ ​t​h​e​ ​q​ ​p​a​r​a​m​e​t​e​r​ ​v​a​l​u​e​ ​t​o​ ​b​o​a​t​i​n​g​|​s​a​i​l​i​n​g​ ​-​f​i​s​h​i​n​g​. */ longDesc: string } - transcribe: { + } + } + new_video_comment: { + /** + * N​e​w​ ​V​i​d​e​o​ ​C​o​m​m​e​n​t + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​i​s​ ​p​o​s​t​e​d​ ​o​n​ ​a​ ​v​i​d​e​o + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​i​s​ ​d​e​t​e​c​t​e​d​. + */ + longDesc: string + options: { + video: { /** - * T​r​a​n​s​c​r​i​b​e​ ​R​e​c​o​r​d​i​n​g + * V​i​d​e​o */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​t​r​a​n​s​c​r​i​b​e​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g + * T​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​m​e​n​t​s */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​t​r​a​n​s​c​r​i​b​e​ ​t​h​e​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​.​ ​T​h​i​s​ ​r​e​q​u​i​r​e​s​ ​t​h​e​ ​R​e​c​o​r​d​ ​C​a​l​l​ ​o​p​t​i​o​n​ ​t​o​ ​b​e​ ​e​n​a​b​l​e​d​.​ ​T​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​w​i​l​l​ ​b​e​ ​a​v​a​i​l​a​b​l​e​ ​a​f​t​e​r​ ​p​r​o​c​e​s​s​i​n​g​. + * S​e​l​e​c​t​ ​t​h​e​ ​Y​o​u​T​u​b​e​ ​v​i​d​e​o​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s */ longDesc: string } - transcriptionCallback: { + } + } + } + } + Canva: { + /** + * C​a​n​v​a + */ + displayName: string + groups: { + /** + * D​e​s​i​g​n​ ​&​ ​C​r​e​a​t​i​v​e​ ​T​o​o​l​s + */ + '0': string + } + /** + * D​e​s​i​g​n​ ​p​l​a​t​f​o​r​m​ ​f​o​r​ ​c​r​e​a​t​i​n​g​ ​g​r​a​p​h​i​c​s​,​ ​p​r​e​s​e​n​t​a​t​i​o​n​s​,​ ​a​n​d​ ​v​i​s​u​a​l​ ​c​o​n​t​e​n​t + */ + shortDesc: string + /** + * C​a​n​v​a​ ​i​s​ ​a​ ​g​r​a​p​h​i​c​ ​d​e​s​i​g​n​ ​p​l​a​t​f​o​r​m​ ​t​h​a​t​ ​a​l​l​o​w​s​ ​u​s​e​r​s​ ​t​o​ ​c​r​e​a​t​e​ ​s​o​c​i​a​l​ ​m​e​d​i​a​ ​g​r​a​p​h​i​c​s​,​ ​p​r​e​s​e​n​t​a​t​i​o​n​s​,​ ​p​o​s​t​e​r​s​,​ ​d​o​c​u​m​e​n​t​s​ ​a​n​d​ ​o​t​h​e​r​ ​v​i​s​u​a​l​ ​c​o​n​t​e​n​t​.​ ​I​t​ ​p​r​o​v​i​d​e​s​ ​a​ ​d​r​a​g​-​a​n​d​-​d​r​o​p​ ​i​n​t​e​r​f​a​c​e​ ​a​n​d​ ​a​c​c​e​s​s​ ​t​o​ ​m​i​l​l​i​o​n​s​ ​o​f​ ​p​h​o​t​o​g​r​a​p​h​s​,​ ​g​r​a​p​h​i​c​s​ ​a​n​d​ ​f​o​n​t​s​. + */ + longDesc: string + actions: { + upload_image: { + /** + * U​p​l​o​a​d​ ​I​m​a​g​e + */ + displayName: string + /** + * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​C​a​n​v​a + */ + shortDesc: string + /** + * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t​ ​a​n​d​ ​o​p​t​i​o​n​a​l​l​y​ ​s​e​t​ ​a​ ​n​a​m​e​ ​a​n​d​ ​t​a​g​s + */ + longDesc: string + options: { + image: { /** - * T​r​a​n​s​c​r​i​p​t​i​o​n​ ​C​a​l​l​b​a​c​k​ ​U​R​L + * I​m​a​g​e​ ​F​i​l​e */ displayName: string /** - * U​R​L​ ​t​o​ ​r​e​c​e​i​v​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​r​e​s​u​l​t​s + * T​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​w​h​e​n​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​i​s​ ​c​o​m​p​l​e​t​e​.​ ​T​h​i​s​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​p​r​o​c​e​s​s​ ​o​r​ ​s​t​o​r​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​i​m​m​e​d​i​a​t​e​l​y​ ​a​f​t​e​r​ ​t​h​e​y​ ​a​r​e​ ​a​v​a​i​l​a​b​l​e​. + * S​e​l​e​c​t​ ​a​n​ ​i​m​a​g​e​ ​f​i​l​e​ ​f​r​o​m​ ​y​o​u​r​ ​d​e​v​i​c​e​ ​t​o​ ​u​p​l​o​a​d​ ​t​o​ ​C​a​n​v​a */ longDesc: string } - sendDigits: { + name: { /** - * S​e​n​d​ ​D​i​g​i​t​s + * N​a​m​e */ displayName: string /** - * D​T​M​F​ ​t​o​n​e​s​ ​t​o​ ​s​e​n​d​ ​a​f​t​e​r​ ​c​o​n​n​e​c​t​i​o​n + * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e */ shortDesc: string /** - * A​ ​s​t​r​i​n​g​ ​o​f​ ​k​e​y​s​ ​t​o​ ​d​i​a​l​ ​a​f​t​e​r​ ​t​h​e​ ​c​a​l​l​ ​c​o​n​n​e​c​t​s​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​n​a​v​i​g​a​t​i​n​g​ ​p​h​o​n​e​ ​m​e​n​u​s​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​.​ ​V​a​l​i​d​ ​c​h​a​r​a​c​t​e​r​s​:​ ​0​-​9​,​ ​#​,​ ​*​,​ ​w​ ​(​w​a​i​t​ ​0​.​5​ ​s​e​c​o​n​d​s​)​.​ ​F​o​r​ ​e​x​a​m​p​l​e​:​ ​"​w​1​2​3​#​"​ ​w​a​i​t​s​ ​0​.​5​ ​s​e​c​o​n​d​s​ ​t​h​e​n​ ​d​i​a​l​s​ ​1​2​3​#​. + * S​e​t​ ​a​ ​c​u​s​t​o​m​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​u​p​l​o​a​d​e​d​ ​i​m​a​g​e​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​t​h​e​ ​o​r​i​g​i​n​a​l​ ​f​i​l​e​n​a​m​e​ ​w​i​l​l​ ​b​e​ ​u​s​e​d */ longDesc: string } - statusCallback: { + tags: { /** - * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L + * T​a​g​s */ displayName: string /** - * U​R​L​ ​t​o​ ​r​e​c​e​i​v​e​ ​c​a​l​l​ ​s​t​a​t​u​s​ ​u​p​d​a​t​e​s + * O​p​t​i​o​n​a​l​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​t​r​a​c​k​ ​c​a​l​l​ ​p​r​o​g​r​e​s​s​ ​a​n​d​ ​c​o​m​p​l​e​t​i​o​n​. + * A​d​d​ ​t​a​g​s​ ​t​o​ ​h​e​l​p​ ​o​r​g​a​n​i​z​e​ ​a​n​d​ ​f​i​n​d​ ​y​o​u​r​ ​i​m​a​g​e​ ​l​a​t​e​r */ longDesc: string } - timeout: { + } + } + get_image: { + /** + * G​e​t​ ​I​m​a​g​e + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​i​m​a​g​e​ ​d​e​t​a​i​l​s​ ​f​r​o​m​ ​C​a​n​v​a + */ + shortDesc: string + /** + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​i​m​a​g​e​ ​a​s​s​e​t​ ​i​n​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t + */ + longDesc: string + options: { + id: { /** - * T​i​m​e​o​u​t + * I​m​a​g​e​ ​I​D */ displayName: string /** - * S​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​a​n​s​w​e​r + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​m​a​g​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​b​e​ ​a​n​s​w​e​r​e​d​ ​b​e​f​o​r​e​ ​t​i​m​i​n​g​ ​o​u​t​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​6​0​ ​s​e​c​o​n​d​s​,​ ​m​a​x​i​m​u​m​ ​i​s​ ​6​0​0​ ​s​e​c​o​n​d​s​. + * T​h​e​ ​C​a​n​v​a​ ​a​s​s​e​t​ ​I​D​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ longDesc: string } - machineDetection: { + } + } + delete_image: { + /** + * D​e​l​e​t​e​ ​I​m​a​g​e + */ + displayName: string + /** + * D​e​l​e​t​e​ ​a​n​ ​i​m​a​g​e​ ​f​r​o​m​ ​C​a​n​v​a + */ + shortDesc: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​n​ ​i​m​a​g​e​ ​a​s​s​e​t​ ​f​r​o​m​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t + */ + longDesc: string + options: { + id: { /** - * M​a​c​h​i​n​e​ ​D​e​t​e​c​t​i​o​n + * I​m​a​g​e​ ​I​D */ displayName: string /** - * E​n​a​b​l​e​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * E​n​a​b​l​e​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n​ ​t​o​ ​d​e​t​e​r​m​i​n​e​ ​i​f​ ​a​ ​h​u​m​a​n​ ​o​r​ ​m​a​c​h​i​n​e​ ​a​n​s​w​e​r​e​d​ ​t​h​e​ ​c​a​l​l​.​ ​"​E​n​a​b​l​e​"​ ​r​e​t​u​r​n​s​ ​t​h​e​ ​r​e​s​u​l​t​ ​i​m​m​e​d​i​a​t​e​l​y​,​ ​"​D​e​t​e​c​t​M​e​s​s​a​g​e​E​n​d​"​ ​w​a​i​t​s​ ​f​o​r​ ​t​h​e​ ​v​o​i​c​e​m​a​i​l​ ​b​e​e​p​ ​b​e​f​o​r​e​ ​p​l​a​y​i​n​g​ ​y​o​u​r​ ​m​e​s​s​a​g​e​. + * T​h​e​ ​C​a​n​v​a​ ​a​s​s​e​t​ ​I​D​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e */ longDesc: string } } } - list_calls: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } + update_image: { /** - * L​i​s​t​ ​C​a​l​l​s + * U​p​d​a​t​e​ ​I​m​a​g​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​l​l​s + * U​p​d​a​t​e​ ​i​m​a​g​e​ ​n​a​m​e​ ​a​n​d​ ​t​a​g​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​l​l​s​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​c​a​l​l​s​ ​b​y​ ​p​a​r​t​i​c​i​p​a​n​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r​s​,​ ​s​t​a​t​u​s​,​ ​d​a​t​e​ ​r​a​n​g​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​.​ ​R​e​s​u​l​t​s​ ​a​r​e​ ​r​e​t​u​r​n​e​d​ ​i​n​ ​r​e​v​e​r​s​e​ ​c​h​r​o​n​o​l​o​g​i​c​a​l​ ​o​r​d​e​r​. + * U​p​d​a​t​e​ ​t​h​e​ ​n​a​m​e​ ​a​n​d​ ​t​a​g​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​i​m​a​g​e​ ​i​n​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t */ longDesc: string options: { - to: { + id: { /** - * T​o + * I​m​a​g​e​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​r​e​c​i​p​i​e​n​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​m​a​g​e */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​m​a​d​e​ ​t​o​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​S​I​P​ ​a​d​d​r​e​s​s​,​ ​o​r​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​. + * T​h​e​ ​C​a​n​v​a​ ​a​s​s​e​t​ ​I​D​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e */ longDesc: string } - from: { + name: { /** - * F​r​o​m + * N​a​m​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * N​e​w​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​f​r​o​m​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​S​I​P​ ​a​d​d​r​e​s​s​,​ ​o​r​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​. + * U​p​d​a​t​e​ ​t​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​a​s​s​e​t */ longDesc: string } - status: { + tags: { /** - * S​t​a​t​u​s + * T​a​g​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​ ​s​t​a​t​u​s + * N​e​w​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​w​i​t​h​ ​t​h​i​s​ ​s​t​a​t​u​s​.​ ​O​p​t​i​o​n​s​ ​i​n​c​l​u​d​e​:​ ​q​u​e​u​e​d​,​ ​r​i​n​g​i​n​g​,​ ​i​n​-​p​r​o​g​r​e​s​s​,​ ​c​a​n​c​e​l​e​d​,​ ​c​o​m​p​l​e​t​e​d​,​ ​f​a​i​l​e​d​,​ ​b​u​s​y​,​ ​o​r​ ​n​o​-​a​n​s​w​e​r​. + * U​p​d​a​t​e​ ​t​h​e​ ​t​a​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​i​m​a​g​e​ ​f​o​r​ ​b​e​t​t​e​r​ ​o​r​g​a​n​i​z​a​t​i​o​n */ longDesc: string } - startTimeAfter: { + } + } + upload_image_by_url: { + /** + * U​p​l​o​a​d​ ​I​m​a​g​e​ ​b​y​ ​U​R​L + */ + displayName: string + /** + * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e​ ​f​r​o​m​ ​a​ ​U​R​L​ ​t​o​ ​C​a​n​v​a + */ + shortDesc: string + /** + * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e​ ​t​o​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t​ ​b​y​ ​p​r​o​v​i​d​i​n​g​ ​a​ ​U​R​L​ ​t​o​ ​t​h​e​ ​i​m​a​g​e + */ + longDesc: string + options: { + url: { /** - * S​t​a​r​t​ ​T​i​m​e​ ​A​f​t​e​r + * I​m​a​g​e​ ​U​R​L */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​s​t​a​r​t​ ​t​i​m​e + * T​h​e​ ​U​R​L​ ​o​f​ ​t​h​e​ ​i​m​a​g​e​ ​t​o​ ​u​p​l​o​a​d */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​t​h​a​t​ ​s​t​a​r​t​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * P​r​o​v​i​d​e​ ​a​ ​d​i​r​e​c​t​ ​U​R​L​ ​t​o​ ​t​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​l​o​a​d​ ​t​o​ ​C​a​n​v​a */ longDesc: string } - startTimeBefore: { + name: { /** - * S​t​a​r​t​ ​T​i​m​e​ ​B​e​f​o​r​e + * N​a​m​e */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​s​t​a​r​t​ ​t​i​m​e + * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​t​h​a​t​ ​s​t​a​r​t​e​d​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * S​e​t​ ​a​ ​c​u​s​t​o​m​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​u​p​l​o​a​d​e​d​ ​i​m​a​g​e​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​t​h​e​ ​f​i​l​e​n​a​m​e​ ​f​r​o​m​ ​t​h​e​ ​U​R​L​ ​w​i​l​l​ ​b​e​ ​u​s​e​d */ longDesc: string } - endTimeAfter: { + tags: { /** - * E​n​d​ ​T​i​m​e​ ​A​f​t​e​r + * T​a​g​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​e​n​d​ ​t​i​m​e + * O​p​t​i​o​n​a​l​ ​t​a​g​s​ ​f​o​r​ ​t​h​e​ ​i​m​a​g​e */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​t​h​a​t​ ​e​n​d​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * A​d​d​ ​t​a​g​s​ ​t​o​ ​h​e​l​p​ ​o​r​g​a​n​i​z​e​ ​a​n​d​ ​f​i​n​d​ ​y​o​u​r​ ​i​m​a​g​e​ ​l​a​t​e​r */ longDesc: string } - endTimeBefore: { + } + } + list_designs: { + /** + * L​i​s​t​ ​D​e​s​i​g​n​s + */ + displayName: string + /** + * L​i​s​t​ ​y​o​u​r​ ​C​a​n​v​a​ ​d​e​s​i​g​n​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​y​o​u​r​ ​C​a​n​v​a​ ​d​e​s​i​g​n​s​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​i​n​g​ ​a​n​d​ ​s​o​r​t​i​n​g + */ + longDesc: string + options: { + query: { /** - * E​n​d​ ​T​i​m​e​ ​B​e​f​o​r​e + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​e​n​d​ ​t​i​m​e + * S​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​d​e​s​i​g​n​s */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​t​h​a​t​ ​e​n​d​e​d​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * E​n​t​e​r​ ​a​ ​s​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​n​d​ ​s​p​e​c​i​f​i​c​ ​d​e​s​i​g​n​s​ ​b​y​ ​t​i​t​l​e​ ​o​r​ ​c​o​n​t​e​n​t */ longDesc: string } - limit: { + continuation: { /** - * L​i​m​i​t + * C​o​n​t​i​n​u​a​t​i​o​n​ ​T​o​k​e​n */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​l​l​s​ ​t​o​ ​r​e​t​u​r​n + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​l​l​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * U​s​e​ ​t​h​i​s​ ​t​o​k​e​n​ ​t​o​ ​c​o​n​t​i​n​u​e​ ​f​r​o​m​ ​w​h​e​r​e​ ​t​h​e​ ​p​r​e​v​i​o​u​s​ ​r​e​q​u​e​s​t​ ​l​e​f​t​ ​o​f​f */ longDesc: string } - pageSize: { + ownership: { /** - * P​a​g​e​ ​S​i​z​e + * O​w​n​e​r​s​h​i​p​ ​F​i​l​t​e​r */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​c​a​l​l​s​ ​p​e​r​ ​p​a​g​e + * F​i​l​t​e​r​ ​b​y​ ​o​w​n​e​r​s​h​i​p​ ​t​y​p​e */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​l​l​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * C​h​o​o​s​e​ ​w​h​e​t​h​e​r​ ​t​o​ ​s​h​o​w​ ​a​l​l​ ​d​e​s​i​g​n​s​,​ ​o​n​l​y​ ​o​w​n​e​d​ ​d​e​s​i​g​n​s​,​ ​o​r​ ​o​n​l​y​ ​s​h​a​r​e​d​ ​d​e​s​i​g​n​s */ longDesc: string } - } - } - get_call: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } - /** - * G​e​t​ ​a​ ​C​a​l​l - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l - */ - shortDesc: string - /** - * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​u​s​i​n​g​ ​i​t​s​ ​u​n​i​q​u​e​ ​S​I​D​.​ ​T​h​i​s​ ​r​e​t​u​r​n​s​ ​a​l​l​ ​a​v​a​i​l​a​b​l​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​c​a​l​l​ ​i​n​c​l​u​d​i​n​g​ ​s​t​a​t​u​s​,​ ​d​u​r​a​t​i​o​n​,​ ​p​r​i​c​i​n​g​,​ ​a​n​d​ ​t​i​m​e​s​t​a​m​p​s​. - */ - longDesc: string - options: { - callSid: { + sort_by: { /** - * C​a​l​l​ ​S​I​D + * S​o​r​t​ ​B​y */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​a​l​l + * H​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​C​a​l​l​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​. + * C​h​o​o​s​e​ ​h​o​w​ ​t​o​ ​s​o​r​t​ ​t​h​e​ ​r​e​t​u​r​n​e​d​ ​d​e​s​i​g​n​s​ ​l​i​s​t */ longDesc: string } } } - delete_call: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } + create_thread: { /** - * D​e​l​e​t​e​ ​a​ ​C​a​l​l + * C​r​e​a​t​e​ ​C​o​m​m​e​n​t​ ​T​h​r​e​a​d */ displayName: string /** - * D​e​l​e​t​e​ ​a​ ​c​a​l​l​ ​r​e​c​o​r​d​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​d​e​s​i​g​n */ shortDesc: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​a​l​l​ ​r​e​c​o​r​d​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​N​o​t​e​ ​t​h​a​t​ ​d​e​l​e​t​i​n​g​ ​a​ ​c​a​l​l​ ​r​e​c​o​r​d​ ​d​o​e​s​ ​n​o​t​ ​r​e​d​a​c​t​ ​t​h​e​ ​c​a​l​l​ ​d​a​t​a​ ​f​r​o​m​ ​T​w​i​l​i​o​ ​l​o​g​s​. + * S​t​a​r​t​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​t​o​ ​c​o​l​l​a​b​o​r​a​t​e​ ​w​i​t​h​ ​t​e​a​m​ ​m​e​m​b​e​r​s */ longDesc: string options: { - callSid: { + design: { /** - * C​a​l​l​ ​S​I​D + * D​e​s​i​g​n */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​d​e​l​e​t​e + * T​h​e​ ​d​e​s​i​g​n​ ​t​o​ ​c​o​m​m​e​n​t​ ​o​n */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​d​e​l​e​t​e​.​ ​C​a​l​l​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d + */ + longDesc: string + } + message: { + /** + * M​e​s​s​a​g​e + */ + displayName: string + /** + * T​h​e​ ​c​o​m​m​e​n​t​ ​m​e​s​s​a​g​e + */ + shortDesc: string + /** + * E​n​t​e​r​ ​t​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​c​o​m​m​e​n​t + */ + longDesc: string + } + assignee: { + /** + * A​s​s​i​g​n​e​e + */ + displayName: string + /** + * O​p​t​i​o​n​a​l​ ​p​e​r​s​o​n​ ​t​o​ ​a​s​s​i​g​n​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​o + */ + shortDesc: string + /** + * A​s​s​i​g​n​ ​t​h​i​s​ ​c​o​m​m​e​n​t​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​e​a​m​ ​m​e​m​b​e​r​ ​f​o​r​ ​a​c​t​i​o​n */ longDesc: string } } } - create_execution: { - groups: { - /** - * S​t​u​d​i​o - */ - '0': string - } + create_reply: { /** - * C​r​e​a​t​e​ ​a​n​ ​E​x​e​c​u​t​i​o​n + * C​r​e​a​t​e​ ​R​e​p​l​y */ displayName: string /** - * S​t​a​r​t​ ​a​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​e​x​e​c​u​t​i​o​n + * R​e​p​l​y​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​n​d​ ​s​t​a​r​t​ ​a​ ​n​e​w​ ​e​x​e​c​u​t​i​o​n​ ​o​f​ ​a​ ​S​t​u​d​i​o​ ​F​l​o​w​.​ ​T​h​i​s​ ​t​r​i​g​g​e​r​s​ ​t​h​e​ ​f​l​o​w​ ​t​o​ ​r​u​n​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​p​a​r​a​m​e​t​e​r​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​a​c​c​e​s​s​e​d​ ​w​i​t​h​i​n​ ​t​h​e​ ​f​l​o​w​. + * A​d​d​ ​a​ ​r​e​p​l​y​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​C​a​n​v​a​ ​d​e​s​i​g​n */ longDesc: string options: { - flowSid: { + design: { /** - * F​l​o​w​ ​S​I​D + * D​e​s​i​g​n */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w + * T​h​e​ ​d​e​s​i​g​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​h​r​e​a​d */ shortDesc: string /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​t​o​ ​e​x​e​c​u​t​e​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d */ longDesc: string } - to: { + thread: { /** - * T​o + * T​h​r​e​a​d​ ​I​D */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * T​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​t​o​ ​r​e​p​l​y​ ​t​o */ shortDesc: string /** - * T​h​e​ ​c​o​n​t​a​c​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​s​t​a​r​t​ ​t​h​e​ ​F​l​o​w​ ​e​x​e​c​u​t​i​o​n​ ​w​i​t​h​.​ ​A​v​a​i​l​a​b​l​e​ ​i​n​ ​t​h​e​ ​f​l​o​w​ ​a​s​ ​c​o​n​t​a​c​t​.​c​h​a​n​n​e​l​.​a​d​d​r​e​s​s​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o */ longDesc: string } - from: { + message: { /** - * F​r​o​m + * M​e​s​s​a​g​e */ displayName: string /** - * T​h​e​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * T​h​e​ ​r​e​p​l​y​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * T​h​e​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​ ​o​r​ ​m​a​k​e​ ​c​a​l​l​s​ ​f​r​o​m​ ​d​u​r​i​n​g​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​A​v​a​i​l​a​b​l​e​ ​a​s​ ​f​l​o​w​.​c​h​a​n​n​e​l​.​a​d​d​r​e​s​s​.​ ​C​a​n​ ​a​l​s​o​ ​b​e​ ​a​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​S​I​D​. - */ - longDesc: string - } - parameters: { - /** - * P​a​r​a​m​e​t​e​r​s - */ - displayName: string - /** - * J​S​O​N​ ​d​a​t​a​ ​f​o​r​ ​t​h​e​ ​f​l​o​w​ ​c​o​n​t​e​x​t - */ - shortDesc: string - /** - * J​S​O​N​ ​d​a​t​a​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​f​l​o​w​'​s​ ​c​o​n​t​e​x​t​ ​a​n​d​ ​a​c​c​e​s​s​i​b​l​e​ ​a​s​ ​v​a​r​i​a​b​l​e​s​.​ ​F​o​r​ ​e​x​a​m​p​l​e​:​ ​a​ ​J​S​O​N​ ​o​b​j​e​c​t​ ​w​i​t​h​ ​n​a​m​e​ ​p​r​o​p​e​r​t​y​ ​b​e​c​o​m​e​s​ ​a​v​a​i​l​a​b​l​e​ ​a​s​ ​f​l​o​w​.​d​a​t​a​.​n​a​m​e​ ​i​n​ ​t​h​e​ ​f​l​o​w​. + * E​n​t​e​r​ ​t​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​r​e​p​l​y */ longDesc: string } } } - list_executions: { - groups: { - /** - * S​t​u​d​i​o - */ - '0': string - } + list_replies: { /** - * L​i​s​t​ ​E​x​e​c​u​t​i​o​n​s + * L​i​s​t​ ​T​h​r​e​a​d​ ​R​e​p​l​i​e​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​e​x​e​c​u​t​i​o​n​s​ ​f​o​r​ ​a​ ​S​t​u​d​i​o​ ​F​l​o​w + * L​i​s​t​ ​r​e​p​l​i​e​s​ ​i​n​ ​a​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​e​x​e​c​u​t​i​o​n​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​S​t​u​d​i​o​ ​F​l​o​w​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​e​x​e​c​u​t​i​o​n​s​ ​b​y​ ​d​a​t​e​ ​r​a​n​g​e​ ​t​o​ ​f​i​n​d​ ​s​p​e​c​i​f​i​c​ ​e​x​e​c​u​t​i​o​n​ ​i​n​s​t​a​n​c​e​s​. + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​r​e​p​l​i​e​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​C​a​n​v​a​ ​d​e​s​i​g​n */ longDesc: string options: { - flowSid: { - /** - * F​l​o​w​ ​S​I​D - */ - displayName: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w - */ - shortDesc: string - /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​w​h​o​s​e​ ​e​x​e​c​u​t​i​o​n​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. - */ - longDesc: string - } - dateCreatedFrom: { + limit: { /** - * D​a​t​e​ ​C​r​e​a​t​e​d​ ​F​r​o​m + * L​i​m​i​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​p​l​i​e​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​e​x​e​c​u​t​i​o​n​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​,​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * S​e​t​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​p​l​i​e​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​) */ longDesc: string } - dateCreatedTo: { + continuation: { /** - * D​a​t​e​ ​C​r​e​a​t​e​d​ ​T​o + * C​o​n​t​i​n​u​a​t​i​o​n​ ​T​o​k​e​n */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​e​x​e​c​u​t​i​o​n​s​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​,​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * U​s​e​ ​t​h​i​s​ ​t​o​k​e​n​ ​t​o​ ​c​o​n​t​i​n​u​e​ ​f​r​o​m​ ​w​h​e​r​e​ ​t​h​e​ ​p​r​e​v​i​o​u​s​ ​r​e​q​u​e​s​t​ ​l​e​f​t​ ​o​f​f */ longDesc: string } - limit: { + design: { /** - * L​i​m​i​t + * D​e​s​i​g​n */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​e​x​e​c​u​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​d​e​s​i​g​n​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​h​r​e​a​d */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​e​x​e​c​u​t​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d */ longDesc: string } - pageSize: { + thread: { /** - * P​a​g​e​ ​S​i​z​e + * T​h​r​e​a​d​ ​I​D */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​e​x​e​c​u​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e + * T​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​t​o​ ​g​e​t​ ​r​e​p​l​i​e​s​ ​f​r​o​m */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​e​x​e​c​u​t​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​w​h​o​s​e​ ​r​e​p​l​i​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t */ longDesc: string } } } - get_execution: { - groups: { - /** - * S​t​u​d​i​o - */ - '0': string - } + } + triggers: { + new_design: { /** - * G​e​t​ ​a​n​ ​E​x​e​c​u​t​i​o​n + * N​e​w​ ​D​e​s​i​g​n */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​e​x​e​c​u​t​i​o​n + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​s​i​g​n​ ​i​s​ ​c​r​e​a​t​e​d */ shortDesc: string /** - * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​e​x​e​c​u​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​c​u​r​r​e​n​t​ ​s​t​a​t​e​,​ ​c​o​n​t​e​x​t​ ​d​a​t​a​,​ ​a​n​d​ ​s​t​a​t​u​s​. + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​s​i​g​n​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​y​o​u​r​ ​C​a​n​v​a​ ​a​c​c​o​u​n​t​,​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​o​w​n​e​r​s​h​i​p​ ​a​n​d​ ​s​e​a​r​c​h​ ​q​u​e​r​y */ longDesc: string options: { - flowSid: { + query: { /** - * F​l​o​w​ ​S​I​D + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w + * F​i​l​t​e​r​ ​d​e​s​i​g​n​s​ ​b​y​ ​s​e​a​r​c​h​ ​t​e​r​m */ shortDesc: string /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. + * O​p​t​i​o​n​a​l​ ​s​e​a​r​c​h​ ​t​e​r​m​ ​t​o​ ​f​i​l​t​e​r​ ​w​h​i​c​h​ ​d​e​s​i​g​n​s​ ​t​r​i​g​g​e​r​ ​t​h​e​ ​e​v​e​n​t​.​ ​O​n​l​y​ ​d​e​s​i​g​n​s​ ​m​a​t​c​h​i​n​g​ ​t​h​i​s​ ​q​u​e​r​y​ ​w​i​l​l​ ​t​r​i​g​g​e​r​ ​t​h​e​ ​e​v​e​n​t */ longDesc: string } - executionSid: { + ownership: { /** - * E​x​e​c​u​t​i​o​n​ ​S​I​D + * O​w​n​e​r​s​h​i​p​ ​F​i​l​t​e​r */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n + * F​i​l​t​e​r​ ​b​y​ ​o​w​n​e​r​s​h​i​p​ ​t​y​p​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​E​x​e​c​u​t​i​o​n​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​N​"​. + * C​h​o​o​s​e​ ​w​h​e​t​h​e​r​ ​t​o​ ​m​o​n​i​t​o​r​ ​a​l​l​ ​d​e​s​i​g​n​s​,​ ​o​n​l​y​ ​y​o​u​r​ ​o​w​n​e​d​ ​d​e​s​i​g​n​s​,​ ​o​r​ ​o​n​l​y​ ​s​h​a​r​e​d​ ​d​e​s​i​g​n​s */ longDesc: string } } } - update_execution: { - groups: { - /** - * S​t​u​d​i​o - */ - '0': string - } + new_thread_reply: { /** - * U​p​d​a​t​e​ ​a​n​ ​E​x​e​c​u​t​i​o​n + * N​e​w​ ​T​h​r​e​a​d​ ​R​e​p​l​y */ displayName: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​a​n​ ​e​x​e​c​u​t​i​o​n + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​r​e​p​l​y​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​a​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​e​x​e​c​u​t​i​o​n​.​ ​T​h​i​s​ ​i​s​ ​t​y​p​i​c​a​l​l​y​ ​u​s​e​d​ ​t​o​ ​e​n​d​ ​a​n​ ​a​c​t​i​v​e​ ​e​x​e​c​u​t​i​o​n​ ​e​a​r​l​y​. + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​s​o​m​e​o​n​e​ ​a​d​d​s​ ​a​ ​n​e​w​ ​r​e​p​l​y​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​o​n​ ​a​ ​C​a​n​v​a​ ​d​e​s​i​g​n */ longDesc: string options: { - flowSid: { - /** - * F​l​o​w​ ​S​I​D - */ - displayName: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w - */ - shortDesc: string - /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. - */ - longDesc: string - } - executionSid: { + design: { /** - * E​x​e​c​u​t​i​o​n​ ​S​I​D + * D​e​s​i​g​n */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n + * T​h​e​ ​d​e​s​i​g​n​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​r​e​p​l​i​e​s */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​ ​t​o​ ​u​p​d​a​t​e​.​ ​E​x​e​c​u​t​i​o​n​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​N​"​. + * S​e​l​e​c​t​ ​t​h​e​ ​C​a​n​v​a​ ​d​e​s​i​g​n​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​r​e​p​l​i​e​s */ longDesc: string } - status: { + thread: { /** - * S​t​a​t​u​s + * T​h​r​e​a​d​ ​I​D */ displayName: string /** - * T​h​e​ ​n​e​w​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n + * T​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​s​t​a​t​u​s​ ​t​o​ ​s​e​t​ ​f​o​r​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​S​e​t​ ​t​o​ ​"​e​n​d​e​d​"​ ​t​o​ ​t​e​r​m​i​n​a​t​e​ ​a​n​ ​a​c​t​i​v​e​ ​e​x​e​c​u​t​i​o​n​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​t​h​r​e​a​d​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​r​e​p​l​i​e​s */ longDesc: string } } } - delete_execution: { - groups: { - /** - * S​t​u​d​i​o - */ - '0': string - } + } + } + Figma: { + /** + * F​i​g​m​a + */ + displayName: string + groups: { + /** + * D​e​s​i​g​n​ ​&​ ​C​r​e​a​t​i​v​e​ ​T​o​o​l​s + */ + '0': string + } + /** + * D​e​s​i​g​n​ ​a​n​d​ ​p​r​o​t​o​t​y​p​i​n​g​ ​p​l​a​t​f​o​r​m​ ​f​o​r​ ​t​e​a​m​s + */ + shortDesc: string + /** + * F​i​g​m​a​ ​i​s​ ​a​ ​c​o​l​l​a​b​o​r​a​t​i​v​e​ ​i​n​t​e​r​f​a​c​e​ ​d​e​s​i​g​n​ ​t​o​o​l​ ​t​h​a​t​ ​a​l​l​o​w​s​ ​t​e​a​m​s​ ​t​o​ ​c​r​e​a​t​e​,​ ​p​r​o​t​o​t​y​p​e​,​ ​a​n​d​ ​c​o​l​l​a​b​o​r​a​t​e​ ​o​n​ ​d​i​g​i​t​a​l​ ​d​e​s​i​g​n​s​ ​i​n​ ​r​e​a​l​-​t​i​m​e​.​ ​C​o​n​n​e​c​t​ ​t​o​ ​a​c​c​e​s​s​ ​f​i​l​e​s​,​ ​c​o​m​m​e​n​t​s​,​ ​p​r​o​j​e​c​t​s​,​ ​a​n​d​ ​t​e​a​m​ ​d​a​t​a​. + */ + longDesc: string + triggers: { + new_file_comment: { /** - * D​e​l​e​t​e​ ​a​n​ ​E​x​e​c​u​t​i​o​n + * N​e​w​ ​F​i​l​e​ ​C​o​m​m​e​n​t */ displayName: string /** - * D​e​l​e​t​e​ ​a​n​ ​e​x​e​c​u​t​i​o​n​ ​r​e​c​o​r​d + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​f​i​l​e */ shortDesc: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​n​ ​e​x​e​c​u​t​i​o​n​ ​r​e​c​o​r​d​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. + * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​t​e​a​m​ ​m​e​m​b​e​r​s​ ​a​d​d​ ​f​e​e​d​b​a​c​k​ ​o​r​ ​d​i​s​c​u​s​s​i​o​n​s */ longDesc: string options: { - flowSid: { + team: { /** - * F​l​o​w​ ​S​I​D + * T​e​a​m */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w + * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. + * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r */ longDesc: string } - executionSid: { + project: { /** - * E​x​e​c​u​t​i​o​n​ ​S​I​D + * P​r​o​j​e​c​t */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​ ​t​o​ ​d​e​l​e​t​e + * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​ ​t​o​ ​d​e​l​e​t​e​.​ ​E​x​e​c​u​t​i​o​n​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​N​"​. + * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e​ ​t​o​ ​m​o​n​i​t​o​r + */ + longDesc: string + } + key: { + /** + * F​i​l​e​ ​K​e​y + */ + displayName: string + /** + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​l​e​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​m​e​n​t​s + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​a​c​t​i​v​i​t​y */ longDesc: string } } } - list_recordings: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } + new_file_version: { /** - * L​i​s​t​ ​R​e​c​o​r​d​i​n​g​s + * N​e​w​ ​F​i​l​e​ ​V​e​r​s​i​o​n */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​s + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​v​e​r​s​i​o​n​ ​o​f​ ​a​ ​f​i​l​e​ ​i​s​ ​c​r​e​a​t​e​d */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​s​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​r​e​c​o​r​d​i​n​g​s​ ​b​y​ ​c​a​l​l​ ​S​I​D​,​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D​,​ ​d​a​t​e​ ​r​a​n​g​e​,​ ​a​n​d​ ​i​n​c​l​u​d​e​ ​s​o​f​t​-​d​e​l​e​t​e​d​ ​r​e​c​o​r​d​i​n​g​s​. + * M​o​n​i​t​o​r​s​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​f​o​r​ ​v​e​r​s​i​o​n​ ​u​p​d​a​t​e​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​n​e​w​ ​v​e​r​s​i​o​n​s​ ​a​r​e​ ​s​a​v​e​d */ longDesc: string options: { - callSid: { + team: { /** - * C​a​l​l​ ​S​I​D + * T​e​a​m */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​ ​S​I​D + * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​o​ ​m​o​n​i​t​o​r */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​.​ ​T​h​e​ ​C​a​l​l​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​. + * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r */ longDesc: string } - conferenceSid: { + project: { /** - * C​o​n​f​e​r​e​n​c​e​ ​S​I​D + * P​r​o​j​e​c​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D + * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​o​n​f​e​r​e​n​c​e​.​ ​T​h​e​ ​C​o​n​f​e​r​e​n​c​e​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​F​"​. + * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e​ ​t​o​ ​m​o​n​i​t​o​r */ longDesc: string } - dateCreatedAfter: { + key: { /** - * D​a​t​e​ ​C​r​e​a​t​e​d​ ​A​f​t​e​r + * F​i​l​e​ ​K​e​y */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​f​i​l​e​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​v​e​r​s​i​o​n​s */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​o​r​d​i​n​g​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​v​e​r​s​i​o​n​ ​a​c​t​i​v​i​t​y */ longDesc: string } - dateCreatedBefore: { + } + } + } + actions: { + create_comment: { + /** + * C​r​e​a​t​e​ ​C​o​m​m​e​n​t + */ + displayName: string + /** + * A​d​d​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​t​o​ ​a​ ​F​i​g​m​a​ ​f​i​l​e + */ + shortDesc: string + /** + * P​o​s​t​ ​a​ ​n​e​w​ ​c​o​m​m​e​n​t​ ​o​r​ ​r​e​p​l​y​ ​t​o​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​o​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e + */ + longDesc: string + options: { + team: { /** - * D​a​t​e​ ​C​r​e​a​t​e​d​ ​B​e​f​o​r​e + * T​e​a​m */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e + * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​o​r​d​i​n​g​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e */ longDesc: string } - includeSoftDeleted: { + project: { /** - * I​n​c​l​u​d​e​ ​S​o​f​t​ ​D​e​l​e​t​e​d + * P​r​o​j​e​c​t */ displayName: string /** - * I​n​c​l​u​d​e​ ​s​o​f​t​-​d​e​l​e​t​e​d​ ​r​e​c​o​r​d​i​n​g​s + * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​s​o​f​t​-​d​e​l​e​t​e​d​ ​r​e​c​o​r​d​i​n​g​s​.​ ​R​e​c​o​r​d​i​n​g​ ​m​e​t​a​d​a​t​a​ ​i​s​ ​r​e​t​a​i​n​e​d​ ​f​o​r​ ​4​0​ ​d​a​y​s​ ​a​f​t​e​r​ ​d​e​l​e​t​i​o​n​. + * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e */ longDesc: string } - limit: { + key: { /** - * L​i​m​i​t + * F​i​l​e​ ​K​e​y */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​c​o​r​d​i​n​g​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​f​i​l​e​ ​t​o​ ​c​o​m​m​e​n​t​ ​o​n */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​c​o​r​d​i​n​g​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​d​d​ ​a​ ​c​o​m​m​e​n​t */ longDesc: string } - pageSize: { + message: { /** - * P​a​g​e​ ​S​i​z​e + * M​e​s​s​a​g​e */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​r​e​c​o​r​d​i​n​g​s​ ​p​e​r​ ​p​a​g​e + * T​h​e​ ​c​o​m​m​e​n​t​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​c​o​r​d​i​n​g​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * E​n​t​e​r​ ​t​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​c​o​m​m​e​n​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​o​s​t​ ​o​n​ ​t​h​e​ ​F​i​g​m​a​ ​f​i​l​e */ longDesc: string } - } - } - get_recording: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } - /** - * G​e​t​ ​a​ ​R​e​c​o​r​d​i​n​g - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​r​e​c​o​r​d​i​n​g - */ - shortDesc: string - /** - * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​ ​i​n​c​l​u​d​i​n​g​ ​d​u​r​a​t​i​o​n​,​ ​s​t​a​t​u​s​,​ ​p​r​i​c​i​n​g​,​ ​m​e​d​i​a​ ​U​R​L​,​ ​a​n​d​ ​e​n​c​r​y​p​t​i​o​n​ ​d​e​t​a​i​l​s​. - */ - longDesc: string - options: { - recordingSid: { + comment_id: { /** - * R​e​c​o​r​d​i​n​g​ ​S​I​D + * P​a​r​e​n​t​ ​C​o​m​m​e​n​t​ ​I​D */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g + * I​D​ ​o​f​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o​ ​(​o​p​t​i​o​n​a​l​) */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​R​e​c​o​r​d​i​n​g​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​R​E​"​. + * O​p​t​i​o​n​a​l​ ​I​D​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​m​m​e​n​t​ ​t​o​ ​r​e​p​l​y​ ​t​o​,​ ​l​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​n​e​w​ ​t​o​p​-​l​e​v​e​l​ ​c​o​m​m​e​n​t */ longDesc: string } } } - list_transcriptions: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } + list_comments: { /** - * L​i​s​t​ ​T​r​a​n​s​c​r​i​p​t​i​o​n​s + * L​i​s​t​ ​C​o​m​m​e​n​t​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​f​o​r​ ​a​ ​r​e​c​o​r​d​i​n​g + * L​i​s​t​ ​a​l​l​ ​c​o​m​m​e​n​t​s​ ​o​n​ ​a​ ​F​i​g​m​a​ ​f​i​l​e */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​.​ ​T​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​c​o​n​v​e​r​t​ ​t​h​e​ ​a​u​d​i​o​ ​f​r​o​m​ ​r​e​c​o​r​d​i​n​g​s​ ​i​n​t​o​ ​t​e​x​t​. + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​c​o​m​m​e​n​t​s​ ​a​n​d​ ​d​i​s​c​u​s​s​i​o​n​s​ ​o​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​,​ ​i​n​c​l​u​d​i​n​g​ ​u​s​e​r​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​n​d​ ​t​i​m​e​s​t​a​m​p​s */ longDesc: string options: { - recordingSid: { + team: { /** - * R​e​c​o​r​d​i​n​g​ ​S​I​D + * T​e​a​m */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g + * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​ ​w​h​o​s​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t​.​ ​R​e​c​o​r​d​i​n​g​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​R​E​"​. + * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e */ longDesc: string } - limit: { + project: { /** - * L​i​m​i​t + * P​r​o​j​e​c​t */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e */ longDesc: string } - pageSize: { + key: { /** - * P​a​g​e​ ​S​i​z​e + * F​i​l​e​ ​K​e​y */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e + * T​h​e​ ​f​i​l​e​ ​t​o​ ​l​i​s​t​ ​c​o​m​m​e​n​t​s​ ​f​r​o​m */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​w​h​o​s​e​ ​c​o​m​m​e​n​t​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ longDesc: string } } } - get_transcription: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } + list_file_version_history: { /** - * G​e​t​ ​a​ ​T​r​a​n​s​c​r​i​p​t​i​o​n + * L​i​s​t​ ​F​i​l​e​ ​V​e​r​s​i​o​n​ ​H​i​s​t​o​r​y */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​w​i​t​h​ ​t​e​x​t + * G​e​t​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​f​o​r​ ​a​ ​F​i​g​m​a​ ​f​i​l​e */ shortDesc: string /** - * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​t​h​e​ ​f​u​l​l​ ​t​r​a​n​s​c​r​i​b​e​d​ ​t​e​x​t​ ​f​r​o​m​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​.​ ​T​h​i​s​ ​r​e​t​u​r​n​s​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​T​e​x​t​ ​f​i​e​l​d​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​a​c​t​u​a​l​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​c​o​n​t​e​n​t​. + * R​e​t​r​i​e​v​e​ ​t​h​e​ ​c​o​m​p​l​e​t​e​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​,​ ​i​n​c​l​u​d​i​n​g​ ​t​i​m​e​s​t​a​m​p​s​,​ ​l​a​b​e​l​s​,​ ​a​n​d​ ​u​s​e​r​ ​i​n​f​o​r​m​a​t​i​o​n */ longDesc: string options: { - recordingSid: { + team: { /** - * R​e​c​o​r​d​i​n​g​ ​S​I​D + * T​e​a​m */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g + * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​.​ ​R​e​c​o​r​d​i​n​g​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​R​E​"​. + * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​a​n​d​ ​f​i​l​e */ longDesc: string } - transcriptionSid: { + project: { /** - * T​r​a​n​s​c​r​i​p​t​i​o​n​ ​S​I​D + * P​r​o​j​e​c​t */ displayName: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n + * T​h​e​ ​p​r​o​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​f​i​l​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​T​r​a​n​s​c​r​i​p​t​i​o​n​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​T​R​"​. + * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​p​r​o​j​e​c​t​ ​w​i​t​h​i​n​ ​t​h​e​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​f​i​l​e */ longDesc: string } - } - } - } - triggers: { - new_message: { - groups: { - /** - * M​e​s​s​a​g​i​n​g - */ - '0': string - } - /** - * N​e​w​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​S​M​S​ ​o​r​ ​M​M​S​ ​m​e​s​s​a​g​e​ ​i​s​ ​r​e​c​e​i​v​e​d - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​ ​i​n​c​o​m​i​n​g​ ​o​r​ ​o​u​t​g​o​i​n​g​ ​m​e​s​s​a​g​e​s​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​m​e​s​s​a​g​e​s​ ​b​y​ ​r​e​c​i​p​i​e​n​t​ ​o​r​ ​s​e​n​d​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r​.​ ​T​h​e​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​i​s​ ​d​e​t​e​c​t​e​d​ ​t​h​a​t​ ​m​a​t​c​h​e​s​ ​y​o​u​r​ ​f​i​l​t​e​r​s​. - */ - longDesc: string - options: { - to: { + key: { /** - * T​o + * F​i​l​e​ ​K​e​y */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​r​e​c​i​p​i​e​n​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * T​h​e​ ​f​i​l​e​ ​t​o​ ​g​e​t​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​f​o​r */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​t​o​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​.​ ​T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​r​e​c​i​p​i​e​n​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​d​e​s​i​g​n​ ​f​i​l​e​ ​w​h​o​s​e​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ longDesc: string } - from: { + next_page_url: { /** - * F​r​o​m + * N​e​x​t​ ​P​a​g​e​ ​U​R​L */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​e​n​d​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * U​R​L​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​t​o​ ​g​e​t​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​f​r​o​m​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​r​ ​a​l​p​h​a​n​u​m​e​r​i​c​ ​s​e​n​d​e​r​ ​I​D​.​ ​T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​s​e​n​d​e​r​s​. + * O​p​t​i​o​n​a​l​ ​U​R​L​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​v​e​r​s​i​o​n​ ​h​i​s​t​o​r​y​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​l​a​r​g​e​ ​f​i​l​e​s​ ​w​i​t​h​ ​m​a​n​y​ ​v​e​r​s​i​o​n​s */ longDesc: string } } } - new_recording: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } + list_project_files: { /** - * N​e​w​ ​R​e​c​o​r​d​i​n​g + * L​i​s​t​ ​P​r​o​j​e​c​t​ ​F​i​l​e​s */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​ ​i​s​ ​c​r​e​a​t​e​d + * L​i​s​t​ ​a​l​l​ ​f​i​l​e​s​ ​i​n​ ​a​ ​F​i​g​m​a​ ​p​r​o​j​e​c​t */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​s​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​r​e​c​o​r​d​i​n​g​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​S​I​D​ ​o​r​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D​.​ ​T​h​e​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​r​e​c​o​r​d​i​n​g​ ​i​s​ ​d​e​t​e​c​t​e​d​ ​t​h​a​t​ ​m​a​t​c​h​e​s​ ​y​o​u​r​ ​f​i​l​t​e​r​s​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​d​e​s​i​g​n​ ​f​i​l​e​s​ ​w​i​t​h​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​F​i​g​m​a​ ​p​r​o​j​e​c​t​,​ ​i​n​c​l​u​d​i​n​g​ ​f​i​l​e​ ​k​e​y​s​,​ ​n​a​m​e​s​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a */ longDesc: string options: { - callSid: { + team: { /** - * C​a​l​l​ ​S​I​D + * T​e​a​m */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​ ​S​I​D + * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​p​r​o​j​e​c​t */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​.​ ​T​h​e​ ​C​a​l​l​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​c​a​l​l​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​p​r​o​j​e​c​t​ ​w​h​o​s​e​ ​f​i​l​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t */ longDesc: string } - conferenceSid: { + project: { /** - * C​o​n​f​e​r​e​n​c​e​ ​S​I​D + * P​r​o​j​e​c​t​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D + * T​h​e​ ​p​r​o​j​e​c​t​ ​t​o​ ​l​i​s​t​ ​f​i​l​e​s​ ​f​r​o​m */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​o​n​f​e​r​e​n​c​e​.​ ​T​h​e​ ​C​o​n​f​e​r​e​n​c​e​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​F​"​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​c​o​n​f​e​r​e​n​c​e​s​. + * C​h​o​o​s​e​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​F​i​g​m​a​ ​p​r​o​j​e​c​t​ ​w​h​o​s​e​ ​f​i​l​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ longDesc: string } } } - new_transcription: { - groups: { - /** - * V​o​i​c​e - */ - '0': string - } + list_projects: { /** - * N​e​w​ ​T​r​a​n​s​c​r​i​p​t​i​o​n + * L​i​s​t​ ​P​r​o​j​e​c​t​s */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​r​e​c​o​r​d​i​n​g​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​i​s​ ​c​r​e​a​t​e​d + * L​i​s​t​ ​a​l​l​ ​p​r​o​j​e​c​t​s​ ​i​n​ ​a​ ​F​i​g​m​a​ ​t​e​a​m */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​b​y​ ​c​h​e​c​k​i​n​g​ ​t​h​e​ ​l​a​t​e​s​t​ ​r​e​c​o​r​d​i​n​g​s​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​S​I​D​ ​o​r​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D​.​ ​T​h​e​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​i​s​ ​d​e​t​e​c​t​e​d​ ​f​o​r​ ​r​e​c​o​r​d​i​n​g​s​ ​t​h​a​t​ ​m​a​t​c​h​ ​y​o​u​r​ ​f​i​l​t​e​r​s​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​p​r​o​j​e​c​t​s​ ​w​i​t​h​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​F​i​g​m​a​ ​t​e​a​m​,​ ​i​n​c​l​u​d​i​n​g​ ​p​r​o​j​e​c​t​ ​n​a​m​e​s​ ​a​n​d​ ​I​D​s */ longDesc: string options: { - callSid: { - /** - * C​a​l​l​ ​S​I​D - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​ ​S​I​D - */ - shortDesc: string - /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​f​r​o​m​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​.​ ​T​h​e​ ​C​a​l​l​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​c​a​l​l​s​. - */ - longDesc: string - } - conferenceSid: { + team: { /** - * C​o​n​f​e​r​e​n​c​e​ ​S​I​D + * T​e​a​m​ ​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D + * T​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​t​o​ ​l​i​s​t​ ​p​r​o​j​e​c​t​s​ ​f​r​o​m */ shortDesc: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​f​r​o​m​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​o​n​f​e​r​e​n​c​e​.​ ​T​h​e​ ​C​o​n​f​e​r​e​n​c​e​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​F​"​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​c​o​n​f​e​r​e​n​c​e​s​. + * E​n​t​e​r​ ​t​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​F​i​g​m​a​ ​t​e​a​m​ ​w​h​o​s​e​ ​p​r​o​j​e​c​t​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ longDesc: string } @@ -120708,4605 +120352,4584 @@ type RootTranslation = { } } } - SendGrid: { + LinkedInOrganizations: { /** - * S​e​n​d​G​r​i​d + * L​i​n​k​e​d​I​n​ ​O​r​g​a​n​i​z​a​t​i​o​n​s */ displayName: string groups: { /** - * E​m​a​i​l​ ​&​ ​E​m​a​i​l​ ​M​a​r​k​e​t​i​n​g + * S​o​c​i​a​l​ ​M​e​d​i​a​ ​M​a​n​a​g​e​m​e​n​t */ '0': string } - connectionMessage: { - /** - * A​P​I​ ​K​e​y​ ​I​n​s​t​r​u​c​t​i​o​n​s - */ - title: string - /** - * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​,​ ​y​o​u​'​l​l​ ​n​e​e​d​ ​a​n​ ​A​P​I​ ​k​e​y​.​ ​Y​o​u​ ​c​a​n​ ​c​r​e​a​t​e​ ​o​n​e​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​d​a​s​h​b​o​a​r​d​ ​a​t​ ​h​t​t​p​s​:​/​/​a​p​p​.​s​e​n​d​g​r​i​d​.​c​o​m​/​s​e​t​t​i​n​g​s​/​a​p​i​_​k​e​y​s​.​ ​E​n​s​u​r​e​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​h​a​s​ ​t​h​e​ ​a​p​p​r​o​p​r​i​a​t​e​ ​p​e​r​m​i​s​s​i​o​n​s​ ​f​o​r​ ​t​h​e​ ​f​e​a​t​u​r​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​s​e​:​ ​M​a​i​l​ ​S​e​n​d​ ​f​o​r​ ​s​e​n​d​i​n​g​ ​e​m​a​i​l​s​,​ ​E​m​a​i​l​ ​V​a​l​i​d​a​t​i​o​n​ ​f​o​r​ ​d​e​l​i​v​e​r​a​b​i​l​i​t​y​ ​c​h​e​c​k​s​,​ ​S​u​p​p​r​e​s​s​i​o​n​s​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​b​l​o​c​k​s​/​b​o​u​n​c​e​s​/​u​n​s​u​b​s​c​r​i​b​e​s​,​ ​a​n​d​ ​M​a​r​k​e​t​i​n​g​ ​f​o​r​ ​c​o​n​t​a​c​t​ ​m​a​n​a​g​e​m​e​n​t​. - */ - content: string - } /** - * C​o​n​n​e​c​t​ ​w​i​t​h​ ​S​e​n​d​G​r​i​d​ ​t​o​ ​s​e​n​d​ ​e​m​a​i​l​s​,​ ​m​a​n​a​g​e​ ​c​o​n​t​a​c​t​s​,​ ​a​n​d​ ​h​a​n​d​l​e​ ​s​u​p​p​r​e​s​s​i​o​n​s + * M​a​n​a​g​e​ ​a​n​d​ ​a​n​a​l​y​z​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​c​o​n​t​e​n​t​ ​a​n​d​ ​s​t​a​t​i​s​t​i​c​s */ shortDesc: string /** - * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​T​w​i​l​i​o​ ​S​e​n​d​G​r​i​d​ ​f​o​r​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​e​m​a​i​l​ ​m​a​n​a​g​e​m​e​n​t​.​ ​S​e​n​d​ ​t​r​a​n​s​a​c​t​i​o​n​a​l​ ​a​n​d​ ​m​a​r​k​e​t​i​n​g​ ​e​m​a​i​l​s​,​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​,​ ​v​a​l​i​d​a​t​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​o​r​ ​d​e​l​i​v​e​r​a​b​i​l​i​t​y​,​ ​a​n​d​ ​m​a​i​n​t​a​i​n​ ​y​o​u​r​ ​s​e​n​d​e​r​ ​r​e​p​u​t​a​t​i​o​n​ ​b​y​ ​h​a​n​d​l​i​n​g​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​i​n​c​l​u​d​i​n​g​ ​b​l​o​c​k​s​,​ ​b​o​u​n​c​e​s​,​ ​a​n​d​ ​g​l​o​b​a​l​ ​u​n​s​u​b​s​c​r​i​b​e​s​.​ ​T​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​p​r​o​v​i​d​e​s​ ​f​u​l​l​ ​c​o​n​t​r​o​l​ ​o​v​e​r​ ​y​o​u​r​ ​e​m​a​i​l​ ​i​n​f​r​a​s​t​r​u​c​t​u​r​e​ ​a​n​d​ ​h​e​l​p​s​ ​e​n​s​u​r​e​ ​h​i​g​h​ ​d​e​l​i​v​e​r​a​b​i​l​i​t​y​ ​r​a​t​e​s​. + * C​o​n​n​e​c​t​ ​t​o​ ​L​i​n​k​e​d​I​n​ ​O​r​g​a​n​i​z​a​t​i​o​n​s​ ​t​o​ ​m​a​n​a​g​e​,​ ​a​n​d​ ​m​o​n​i​t​o​r​ ​p​o​s​t​s​,​ ​a​n​a​l​y​z​e​ ​f​o​l​l​o​w​e​r​ ​e​n​g​a​g​e​m​e​n​t​,​ ​t​r​a​c​k​ ​p​a​g​e​ ​p​e​r​f​o​r​m​a​n​c​e​,​ ​a​n​d​ ​g​a​t​h​e​r​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​s​t​a​t​i​s​t​i​c​s​ ​a​b​o​u​t​ ​y​o​u​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​'​s​ ​L​i​n​k​e​d​I​n​ ​p​r​e​s​e​n​c​e​. */ longDesc: string - actions: { - list_blocks: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } + triggers: { + new_post: { /** - * L​i​s​t​ ​B​l​o​c​k​s + * N​e​w​ ​P​o​s​t */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​p​o​s​t​ ​i​s​ ​p​u​b​l​i​s​h​e​d​ ​b​y​ ​t​h​e​ ​o​r​g​a​n​i​z​a​t​i​o​n */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​h​a​t​ ​a​r​e​ ​c​u​r​r​e​n​t​l​y​ ​o​n​ ​y​o​u​r​ ​b​l​o​c​k​s​ ​l​i​s​t​.​ ​B​l​o​c​k​e​d​ ​a​d​d​r​e​s​s​e​s​ ​a​r​e​ ​e​m​a​i​l​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​r​e​j​e​c​t​e​d​ ​b​y​ ​r​e​c​e​i​v​i​n​g​ ​s​e​r​v​e​r​s​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​t​i​m​e​ ​r​a​n​g​e​ ​a​n​d​ ​p​a​g​i​n​a​t​e​ ​t​h​r​o​u​g​h​ ​r​e​s​u​l​t​s​. + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​p​o​s​t​ ​i​s​ ​p​u​b​l​i​s​h​e​d​ ​b​y​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​.​ ​I​t​ ​m​o​n​i​t​o​r​s​ ​t​h​e​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​f​o​r​ ​n​e​w​ ​c​o​n​t​e​n​t​ ​a​n​d​ ​p​r​o​v​i​d​e​s​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​e​ ​p​o​s​t​. */ longDesc: string options: { - startTime: { + organization: { /** - * S​t​a​r​t​ ​T​i​m​e + * O​r​g​a​n​i​z​a​t​i​o​n */ displayName: string /** - * F​i​l​t​e​r​ ​b​l​o​c​k​s​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p + * T​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​p​o​s​t​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​b​l​o​c​k​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​p​o​s​t​s​.​ ​Y​o​u​ ​m​u​s​t​ ​h​a​v​e​ ​a​c​c​e​s​s​ ​t​o​ ​m​a​n​a​g​e​ ​t​h​i​s​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​. */ longDesc: string } - endTime: { + } + } + } + actions: { + get_follower_statistics: { + /** + * G​e​t​ ​F​o​l​l​o​w​e​r​ ​S​t​a​t​i​s​t​i​c​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​m​o​g​r​a​p​h​i​c​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​f​o​l​l​o​w​e​r​s + */ + shortDesc: string + /** + * A​n​a​l​y​z​e​ ​y​o​u​r​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​f​o​l​l​o​w​e​r​s​ ​b​y​ ​r​e​t​r​i​e​v​i​n​g​ ​d​e​t​a​i​l​e​d​ ​d​e​m​o​g​r​a​p​h​i​c​ ​b​r​e​a​k​d​o​w​n​s​ ​a​n​d​ ​e​n​g​a​g​e​m​e​n​t​ ​s​t​a​t​i​s​t​i​c​s​.​ ​T​h​i​s​ ​h​e​l​p​s​ ​u​n​d​e​r​s​t​a​n​d​ ​y​o​u​r​ ​a​u​d​i​e​n​c​e​ ​c​o​m​p​o​s​i​t​i​o​n​ ​a​n​d​ ​r​e​a​c​h​. + */ + longDesc: string + options: { + organization: { /** - * E​n​d​ ​T​i​m​e + * O​r​g​a​n​i​z​a​t​i​o​n */ displayName: string /** - * F​i​l​t​e​r​ ​b​l​o​c​k​s​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p + * T​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​t​o​ ​g​e​t​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​b​l​o​c​k​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​f​o​r​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​o​l​l​o​w​e​r​ ​d​e​m​o​g​r​a​p​h​i​c​s​ ​a​n​d​ ​s​t​a​t​i​s​t​i​c​s​. */ longDesc: string } - limit: { + dimensionType: { /** - * L​i​m​i​t + * D​i​m​e​n​s​i​o​n​ ​T​y​p​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​b​l​o​c​k​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​t​y​p​e​ ​o​f​ ​d​e​m​o​g​r​a​p​h​i​c​ ​d​i​m​e​n​s​i​o​n​ ​t​o​ ​a​n​a​l​y​z​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​b​l​o​c​k​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​5​0​0​. + * C​h​o​o​s​e​ ​t​h​e​ ​d​e​m​o​g​r​a​p​h​i​c​ ​d​i​m​e​n​s​i​o​n​ ​t​o​ ​a​n​a​l​y​z​e​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​ ​b​y​,​ ​s​u​c​h​ ​a​s​ ​j​o​b​ ​f​u​n​c​t​i​o​n​,​ ​i​n​d​u​s​t​r​y​,​ ​s​e​n​i​o​r​i​t​y​ ​l​e​v​e​l​,​ ​g​e​o​g​r​a​p​h​i​c​ ​r​e​g​i​o​n​,​ ​c​o​m​p​a​n​y​ ​s​i​z​e​,​ ​o​r​ ​c​o​u​n​t​r​y​. */ longDesc: string } - offset: { + timeRange: { /** - * O​f​f​s​e​t + * T​i​m​e​ ​R​a​n​g​e */ displayName: string /** - * S​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s + * D​a​t​e​ ​r​a​n​g​e​ ​f​o​r​ ​t​h​e​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s */ shortDesc: string /** - * T​h​e​ ​s​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. + * S​p​e​c​i​f​y​ ​t​h​e​ ​s​t​a​r​t​ ​a​n​d​ ​e​n​d​ ​d​a​t​e​s​ ​f​o​r​ ​a​n​a​l​y​z​i​n​g​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​g​e​t​ ​l​i​f​e​t​i​m​e​ ​s​t​a​t​i​s​t​i​c​s​. */ longDesc: string + type: { + fields: { + start: { + /** + * S​t​a​r​t​ ​D​a​t​e + */ + displayName: string + /** + * T​h​e​ ​s​t​a​r​t​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​s​t​a​t​i​s​t​i​c​s​ ​p​e​r​i​o​d + */ + shortDesc: string + /** + * E​n​t​e​r​ ​t​h​e​ ​s​t​a​r​t​ ​d​a​t​e​ ​f​r​o​m​ ​w​h​i​c​h​ ​t​o​ ​b​e​g​i​n​ ​a​n​a​l​y​z​i​n​g​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​. + */ + longDesc: string + } + end: { + /** + * E​n​d​ ​D​a​t​e + */ + displayName: string + /** + * T​h​e​ ​e​n​d​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​s​t​a​t​i​s​t​i​c​s​ ​p​e​r​i​o​d + */ + shortDesc: string + /** + * E​n​t​e​r​ ​t​h​e​ ​e​n​d​ ​d​a​t​e​ ​u​n​t​i​l​ ​w​h​i​c​h​ ​t​o​ ​a​n​a​l​y​z​e​ ​f​o​l​l​o​w​e​r​ ​s​t​a​t​i​s​t​i​c​s​. + */ + longDesc: string + } + } + } } } } - get_block: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } + get_post: { /** - * G​e​t​ ​a​ ​B​l​o​c​k + * G​e​t​ ​P​o​s​t */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​o​s​t */ shortDesc: string /** - * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​i​n​c​l​u​d​i​n​g​ ​t​h​e​ ​r​e​a​s​o​n​ ​f​o​r​ ​t​h​e​ ​b​l​o​c​k​ ​a​n​d​ ​w​h​e​n​ ​i​t​ ​w​a​s​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​l​i​s​t​. + * F​e​t​c​h​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​p​o​s​t​ ​p​u​b​l​i​s​h​e​d​ ​b​y​ ​a​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​,​ ​i​n​c​l​u​d​i​n​g​ ​e​n​g​a​g​e​m​e​n​t​ ​m​e​t​r​i​c​s​,​ ​c​o​n​t​e​n​t​,​ ​a​n​d​ ​m​e​t​a​d​a​t​a​. */ longDesc: string options: { - email: { + organization: { /** - * E​m​a​i​l + * O​r​g​a​n​i​z​a​t​i​o​n */ displayName: string /** - * T​h​e​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​r​o​m​ ​t​h​e​ ​b​l​o​c​k​s​ ​l​i​s​t​.​ ​T​h​i​s​ ​s​h​o​u​l​d​ ​b​e​ ​t​h​e​ ​e​x​a​c​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​w​a​s​ ​b​l​o​c​k​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​t​h​a​t​ ​o​w​n​s​ ​t​h​e​ ​p​o​s​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​T​h​i​s​ ​f​i​e​l​d​ ​i​s​ ​p​r​e​s​e​l​e​c​t​e​d​ ​a​n​d​ ​h​e​l​p​s​ ​f​i​l​t​e​r​ ​a​v​a​i​l​a​b​l​e​ ​p​o​s​t​s​. + */ + longDesc: string + } + post: { + /** + * P​o​s​t + */ + displayName: string + /** + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​L​i​n​k​e​d​I​n​ ​p​o​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​L​i​n​k​e​d​I​n​ ​p​o​s​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​.​ ​T​h​e​ ​l​i​s​t​ ​s​h​o​w​s​ ​p​o​s​t​s​ ​f​r​o​m​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​o​r​g​a​n​i​z​a​t​i​o​n​. */ longDesc: string } } } - delete_blocks: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } + list_user_organizations: { /** - * D​e​l​e​t​e​ ​B​l​o​c​k​s + * L​i​s​t​ ​U​s​e​r​ ​O​r​g​a​n​i​z​a​t​i​o​n​s */ displayName: string /** - * D​e​l​e​t​e​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​l​i​s​t + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​s​ ​a​c​c​e​s​s​i​b​l​e​ ​t​o​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r */ shortDesc: string /** - * R​e​m​o​v​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​b​l​o​c​k​s​ ​l​i​s​t​.​ ​Y​o​u​ ​c​a​n​ ​e​i​t​h​e​r​ ​d​e​l​e​t​e​ ​a​l​l​ ​b​l​o​c​k​s​ ​a​t​ ​o​n​c​e​ ​o​r​ ​s​p​e​c​i​f​y​ ​i​n​d​i​v​i​d​u​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​m​o​v​e​.​ ​D​e​l​e​t​i​n​g​ ​b​l​o​c​k​s​ ​a​l​l​o​w​s​ ​t​h​o​s​e​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​ ​a​g​a​i​n​. + * F​e​t​c​h​ ​a​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​s​ ​t​h​a​t​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​ ​h​a​s​ ​a​c​c​e​s​s​ ​t​o​ ​m​a​n​a​g​e​.​ ​T​h​i​s​ ​i​n​c​l​u​d​e​s​ ​o​r​g​a​n​i​z​a​t​i​o​n​s​ ​w​h​e​r​e​ ​t​h​e​ ​u​s​e​r​ ​h​a​s​ ​a​d​m​i​n​ ​o​r​ ​c​o​n​t​e​n​t​ ​m​a​n​a​g​e​m​e​n​t​ ​p​e​r​m​i​s​s​i​o​n​s​,​ ​a​l​o​n​g​ ​w​i​t​h​ ​d​e​t​a​i​l​e​d​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​i​n​f​o​r​m​a​t​i​o​n​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​,​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​l​o​g​o​,​ ​l​o​c​a​t​i​o​n​,​ ​a​n​d​ ​o​t​h​e​r​ ​m​e​t​a​d​a​t​a​. + */ + longDesc: string + } + list_organization_posts: { + /** + * L​i​s​t​ ​O​r​g​a​n​i​z​a​t​i​o​n​ ​P​o​s​t​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​p​o​s​t​s​ ​f​r​o​m​ ​a​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e + */ + shortDesc: string + /** + * F​e​t​c​h​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​p​o​s​t​s​ ​p​u​b​l​i​s​h​e​d​ ​b​y​ ​a​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​b​r​o​w​s​e​ ​t​h​r​o​u​g​h​ ​h​i​s​t​o​r​i​c​a​l​ ​p​o​s​t​s​ ​a​n​d​ ​r​e​t​r​i​e​v​e​ ​m​e​t​a​d​a​t​a​ ​a​b​o​u​t​ ​e​a​c​h​ ​p​o​s​t​. */ longDesc: string options: { - deleteAll: { + organization: { /** - * D​e​l​e​t​e​ ​A​l​l + * O​r​g​a​n​i​z​a​t​i​o​n */ displayName: string /** - * D​e​l​e​t​e​ ​a​l​l​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​s + * T​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​t​o​ ​l​i​s​t​ ​p​o​s​t​s​ ​f​r​o​m */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​d​e​l​e​t​e​ ​a​l​l​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​l​i​s​t​.​ ​W​h​e​n​ ​t​r​u​e​,​ ​t​h​e​ ​e​m​a​i​l​s​ ​p​a​r​a​m​e​t​e​r​ ​i​s​ ​i​g​n​o​r​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​L​i​n​k​e​d​I​n​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​ ​f​r​o​m​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​p​o​s​t​s​.​ ​Y​o​u​ ​m​u​s​t​ ​h​a​v​e​ ​a​c​c​e​s​s​ ​t​o​ ​m​a​n​a​g​e​ ​t​h​i​s​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​. */ longDesc: string } - emails: { + count: { /** - * E​m​a​i​l​s + * P​o​s​t​ ​C​o​u​n​t */ displayName: string /** - * L​i​s​t​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​d​e​l​e​t​e + * N​u​m​b​e​r​ ​o​f​ ​p​o​s​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​b​l​o​c​k​s​ ​l​i​s​t​.​ ​R​e​q​u​i​r​e​d​ ​i​f​ ​D​e​l​e​t​e​ ​A​l​l​ ​i​s​ ​n​o​t​ ​s​e​t​ ​t​o​ ​t​r​u​e​. + * S​p​e​c​i​f​y​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​p​o​s​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​r​o​m​ ​t​h​e​ ​o​r​g​a​n​i​z​a​t​i​o​n​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​ ​p​o​s​t​s​. + */ + longDesc: string + } + cursor: { + /** + * P​a​g​i​n​a​t​i​o​n​ ​C​u​r​s​o​r + */ + displayName: string + /** + * C​u​r​s​o​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​s​e​t​ ​o​f​ ​p​o​s​t​s + */ + shortDesc: string + /** + * U​s​e​ ​t​h​i​s​ ​c​u​r​s​o​r​ ​v​a​l​u​e​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​p​o​s​t​s​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​g​e​t​ ​t​h​e​ ​f​i​r​s​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. */ longDesc: string } } } - get_all_bounces: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } + } + } + Telegram: { + /** + * T​e​l​e​g​r​a​m + */ + displayName: string + groups: { + /** + * M​e​s​s​a​g​i​n​g​ ​&​ ​R​e​a​l​-​t​i​m​e​ ​C​o​m​m​u​n​i​c​a​t​i​o​n + */ + '0': string + } + /** + * C​o​n​n​e​c​t​ ​a​n​d​ ​i​n​t​e​r​a​c​t​ ​w​i​t​h​ ​T​e​l​e​g​r​a​m​ ​v​i​a​ ​a​ ​b​o​t + */ + shortDesc: string + /** + * C​o​n​n​e​c​t​ ​a​ ​T​e​l​e​g​r​a​m​ ​B​o​t​ ​u​s​i​n​g​ ​i​t​s​ ​B​o​t​ ​T​o​k​e​n​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​h​a​n​d​l​e​ ​i​n​c​o​m​i​n​g​ ​u​p​d​a​t​e​s​.​ ​A​u​t​h​e​n​t​i​c​a​t​i​o​n​ ​i​s​ ​d​o​n​e​ ​s​o​l​e​l​y​ ​w​i​t​h​ ​t​h​e​ ​B​o​t​ ​T​o​k​e​n​ ​i​s​s​u​e​d​ ​b​y​ ​@​B​o​t​F​a​t​h​e​r​;​ ​n​o​ ​u​s​e​r​ ​l​o​g​i​n​ ​i​s​ ​r​e​q​u​i​r​e​d​. + */ + longDesc: string + connectionMessage: { + /** + * C​o​n​n​e​c​t​ ​t​o​ ​T​e​l​e​g​r​a​m + */ + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​t​o​ ​T​e​l​e​g​r​a​m​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​B​o​t​ ​T​o​k​e​n​*​*​ ​f​r​o​m​ ​B​o​t​F​a​t​h​e​r​.​ + ​ + ​#​#​ ​C​r​e​a​t​i​n​g​ ​a​ ​T​e​l​e​g​r​a​m​ ​B​o​t​ + ​ + ​1​.​ ​O​p​e​n​ ​T​e​l​e​g​r​a​m​ ​a​n​d​ ​s​e​a​r​c​h​ ​f​o​r​ ​[​@​B​o​t​F​a​t​h​e​r​]​(​h​t​t​p​s​:​/​/​t​.​m​e​/​B​o​t​F​a​t​h​e​r​)​ + ​2​.​ ​S​t​a​r​t​ ​a​ ​c​h​a​t​ ​a​n​d​ ​s​e​n​d​ ​t​h​e​ ​c​o​m​m​a​n​d​ ​`​/​n​e​w​b​o​t​`​ + ​3​.​ ​F​o​l​l​o​w​ ​t​h​e​ ​p​r​o​m​p​t​s​ ​t​o​:​ + ​ ​ ​ ​-​ ​C​h​o​o​s​e​ ​a​ ​*​*​d​i​s​p​l​a​y​ ​n​a​m​e​*​*​ ​f​o​r​ ​y​o​u​r​ ​b​o​t​ ​(​e​.​g​.​,​ ​"​M​y​ ​A​u​t​o​m​a​t​i​o​n​ ​B​o​t​"​)​ + ​ ​ ​ ​-​ ​C​h​o​o​s​e​ ​a​ ​*​*​u​s​e​r​n​a​m​e​*​*​ ​f​o​r​ ​y​o​u​r​ ​b​o​t​ ​(​m​u​s​t​ ​e​n​d​ ​i​n​ ​"​b​o​t​"​,​ ​e​.​g​.​,​ ​"​m​y​_​a​u​t​o​m​a​t​i​o​n​_​b​o​t​"​)​ + ​4​.​ ​B​o​t​F​a​t​h​e​r​ ​w​i​l​l​ ​r​e​s​p​o​n​d​ ​w​i​t​h​ ​y​o​u​r​ ​*​*​B​o​t​ ​T​o​k​e​n​*​*​ + ​5​.​ ​C​o​p​y​ ​t​h​e​ ​t​o​k​e​n​ ​(​f​o​r​m​a​t​:​ ​`​1​2​3​4​5​6​7​8​9​:​A​B​C​d​e​f​G​H​I​j​k​l​M​N​O​p​q​r​s​T​U​V​w​x​y​z​`​)​ + ​ + ​#​#​ ​M​a​n​a​g​i​n​g​ ​E​x​i​s​t​i​n​g​ ​B​o​t​s​ + ​ + ​T​o​ ​g​e​t​ ​t​h​e​ ​t​o​k​e​n​ ​f​o​r​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​b​o​t​:​ + ​1​.​ ​O​p​e​n​ ​[​@​B​o​t​F​a​t​h​e​r​]​(​h​t​t​p​s​:​/​/​t​.​m​e​/​B​o​t​F​a​t​h​e​r​)​ + ​2​.​ ​S​e​n​d​ ​`​/​m​y​b​o​t​s​`​ + ​3​.​ ​S​e​l​e​c​t​ ​y​o​u​r​ ​b​o​t​ + ​4​.​ ​C​l​i​c​k​ ​*​*​A​P​I​ ​T​o​k​e​n​*​*​ ​t​o​ ​v​i​e​w​ ​o​r​ ​r​e​g​e​n​e​r​a​t​e​ ​t​h​e​ ​t​o​k​e​n​ + ​ + ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ + ​ + ​#​#​#​ ​B​o​t​ ​T​o​k​e​n​ + ​Y​o​u​r​ ​T​e​l​e​g​r​a​m​ ​B​o​t​ ​T​o​k​e​n​ ​i​n​ ​t​h​e​ ​f​o​r​m​a​t​ ​`​1​2​3​4​5​6​7​8​9​:​A​B​C​d​e​f​G​H​I​j​k​l​M​N​O​p​q​r​s​T​U​V​w​x​y​z​`​.​ ​T​h​i​s​ ​t​o​k​e​n​ ​a​u​t​h​e​n​t​i​c​a​t​e​s​ ​y​o​u​r​ ​b​o​t​ ​w​i​t​h​ ​t​h​e​ ​T​e​l​e​g​r​a​m​ ​A​P​I​.​ + ​ + ​*​*​N​o​t​e​:​*​*​ ​K​e​e​p​ ​y​o​u​r​ ​b​o​t​ ​t​o​k​e​n​ ​s​e​c​u​r​e​ ​a​n​d​ ​n​e​v​e​r​ ​s​h​a​r​e​ ​i​t​ ​p​u​b​l​i​c​l​y​.​ ​A​n​y​o​n​e​ ​w​i​t​h​ ​y​o​u​r​ ​t​o​k​e​n​ ​c​a​n​ ​c​o​n​t​r​o​l​ ​y​o​u​r​ ​b​o​t​.​ ​I​f​ ​c​o​m​p​r​o​m​i​s​e​d​,​ ​r​e​g​e​n​e​r​a​t​e​ ​i​t​ ​i​m​m​e​d​i​a​t​e​l​y​ ​v​i​a​ ​B​o​t​F​a​t​h​e​r​. + */ + content: string + } + actions: { + send_message: { /** - * G​e​t​ ​A​l​l​ ​B​o​u​n​c​e​s + * S​e​n​d​ ​M​e​s​s​a​g​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​b​o​u​n​c​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s + * S​e​n​d​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​c​h​a​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​o​u​n​c​e​d​.​ ​B​o​u​n​c​e​s​ ​o​c​c​u​r​ ​w​h​e​n​ ​a​n​ ​e​m​a​i​l​ ​c​a​n​n​o​t​ ​b​e​ ​d​e​l​i​v​e​r​e​d​ ​t​o​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​t​i​m​e​ ​r​a​n​g​e​ ​a​n​d​ ​p​a​g​i​n​a​t​e​ ​t​h​r​o​u​g​h​ ​r​e​s​u​l​t​s​. + * S​e​n​d​ ​a​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​f​o​r​m​a​t​t​i​n​g​ ​t​o​ ​a​n​y​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​a​c​c​e​s​s​i​b​l​e​ ​b​y​ ​y​o​u​r​ ​b​o​t */ longDesc: string + groups: { + /** + * M​e​s​s​a​g​i​n​g + */ + '0': string + } options: { - startTime: { + chat: { /** - * S​t​a​r​t​ ​T​i​m​e + * C​h​a​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​o​u​n​c​e​s​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p + * T​h​e​ ​c​h​a​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​b​o​u​n​c​e​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e */ longDesc: string } - endTime: { + format: { /** - * E​n​d​ ​T​i​m​e + * T​e​x​t​ ​F​o​r​m​a​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​o​u​n​c​e​s​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p + * H​o​w​ ​t​o​ ​f​o​r​m​a​t​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​e​x​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​b​o​u​n​c​e​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. + * C​h​o​o​s​e​ ​t​h​e​ ​f​o​r​m​a​t​t​i​n​g​ ​m​o​d​e​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​(​p​l​a​i​n​ ​t​e​x​t​,​ ​M​a​r​k​d​o​w​n​,​ ​M​a​r​k​d​o​w​n​ ​V​2​,​ ​o​r​ ​H​T​M​L​) */ longDesc: string } - limit: { + message: { /** - * L​i​m​i​t + * M​e​s​s​a​g​e​ ​T​e​x​t */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​b​o​u​n​c​e​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​b​o​u​n​c​e​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​5​0​0​. + * T​h​e​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t​ ​t​o​ ​s​e​n​d​.​ ​C​a​n​ ​i​n​c​l​u​d​e​ ​f​o​r​m​a​t​t​i​n​g​ ​d​e​p​e​n​d​i​n​g​ ​o​n​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​f​o​r​m​a​t​ ​m​o​d​e */ longDesc: string } - offset: { + disable_link_preview: { /** - * O​f​f​s​e​t + * D​i​s​a​b​l​e​ ​L​i​n​k​ ​P​r​e​v​i​e​w */ displayName: string /** - * S​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s + * D​i​s​a​b​l​e​ ​a​u​t​o​m​a​t​i​c​ ​l​i​n​k​ ​p​r​e​v​i​e​w​s */ shortDesc: string /** - * T​h​e​ ​s​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. + * I​f​ ​e​n​a​b​l​e​d​,​ ​l​i​n​k​s​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​n​o​t​ ​s​h​o​w​ ​a​u​t​o​m​a​t​i​c​ ​p​r​e​v​i​e​w​s + */ + longDesc: string + } + disable_notification: { + /** + * S​e​n​d​ ​S​i​l​e​n​t​l​y + */ + displayName: string + /** + * S​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​s​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d */ longDesc: string } } } - delete_bounces: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } + send_photo: { /** - * D​e​l​e​t​e​ ​B​o​u​n​c​e​s + * S​e​n​d​ ​P​h​o​t​o */ displayName: string /** - * D​e​l​e​t​e​ ​b​o​u​n​c​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​l​i​s​t + * S​e​n​d​ ​a​ ​p​h​o​t​o​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​c​a​p​t​i​o​n​ ​t​o​ ​a​ ​c​h​a​t */ shortDesc: string /** - * R​e​m​o​v​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​b​o​u​n​c​e​s​ ​l​i​s​t​.​ ​Y​o​u​ ​c​a​n​ ​e​i​t​h​e​r​ ​d​e​l​e​t​e​ ​a​l​l​ ​b​o​u​n​c​e​s​ ​a​t​ ​o​n​c​e​ ​o​r​ ​s​p​e​c​i​f​y​ ​i​n​d​i​v​i​d​u​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​m​o​v​e​.​ ​D​e​l​e​t​i​n​g​ ​b​o​u​n​c​e​s​ ​a​l​l​o​w​s​ ​t​h​o​s​e​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​ ​a​g​a​i​n​. + * U​p​l​o​a​d​ ​a​n​d​ ​s​e​n​d​ ​a​n​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​a​n​y​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​c​a​p​t​i​o​n​ ​a​n​d​ ​f​o​r​m​a​t​t​i​n​g */ longDesc: string + groups: { + /** + * M​e​s​s​a​g​i​n​g + */ + '0': string + } options: { - deleteAll: { + chat: { /** - * D​e​l​e​t​e​ ​A​l​l + * C​h​a​t */ displayName: string /** - * D​e​l​e​t​e​ ​a​l​l​ ​b​o​u​n​c​e​d​ ​e​m​a​i​l​s + * T​h​e​ ​c​h​a​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​p​h​o​t​o​ ​t​o */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​d​e​l​e​t​e​ ​a​l​l​ ​b​o​u​n​c​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​l​i​s​t​.​ ​W​h​e​n​ ​t​r​u​e​,​ ​t​h​e​ ​e​m​a​i​l​s​ ​p​a​r​a​m​e​t​e​r​ ​i​s​ ​i​g​n​o​r​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​p​h​o​t​o */ longDesc: string } - emails: { + photo: { /** - * E​m​a​i​l​s + * P​h​o​t​o​ ​F​i​l​e */ displayName: string /** - * L​i​s​t​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​d​e​l​e​t​e + * T​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​t​o​ ​s​e​n​d */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​b​o​u​n​c​e​s​ ​l​i​s​t​.​ ​R​e​q​u​i​r​e​d​ ​i​f​ ​D​e​l​e​t​e​ ​A​l​l​ ​i​s​ ​n​o​t​ ​s​e​t​ ​t​o​ ​t​r​u​e​. + * U​p​l​o​a​d​ ​t​h​e​ ​i​m​a​g​e​ ​f​i​l​e​ ​(​J​P​G​,​ ​P​N​G​,​ ​G​I​F​,​ ​e​t​c​.​)​ ​t​o​ ​s​e​n​d​ ​t​o​ ​t​h​e​ ​c​h​a​t */ longDesc: string } - } - } - list_global_suppressions: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } - /** - * L​i​s​t​ ​G​l​o​b​a​l​ ​S​u​p​p​r​e​s​s​i​o​n​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​g​l​o​b​a​l​l​y​ ​u​n​s​u​b​s​c​r​i​b​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​h​a​t​ ​h​a​v​e​ ​g​l​o​b​a​l​l​y​ ​u​n​s​u​b​s​c​r​i​b​e​d​ ​f​r​o​m​ ​a​l​l​ ​o​f​ ​y​o​u​r​ ​e​m​a​i​l​s​.​ ​T​h​e​s​e​ ​a​d​d​r​e​s​s​e​s​ ​w​i​l​l​ ​n​o​t​ ​r​e​c​e​i​v​e​ ​a​n​y​ ​e​m​a​i​l​s​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​u​n​t​i​l​ ​t​h​e​y​ ​a​r​e​ ​r​e​m​o​v​e​d​ ​f​r​o​m​ ​t​h​i​s​ ​l​i​s​t​. - */ - longDesc: string - options: { - startTime: { + caption_format: { /** - * S​t​a​r​t​ ​T​i​m​e + * C​a​p​t​i​o​n​ ​F​o​r​m​a​t */ displayName: string /** - * F​i​l​t​e​r​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p + * H​o​w​ ​t​o​ ​f​o​r​m​a​t​ ​t​h​e​ ​c​a​p​t​i​o​n​ ​t​e​x​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. + * C​h​o​o​s​e​ ​t​h​e​ ​f​o​r​m​a​t​t​i​n​g​ ​m​o​d​e​ ​f​o​r​ ​t​h​e​ ​p​h​o​t​o​ ​c​a​p​t​i​o​n */ longDesc: string } - endTime: { + caption: { /** - * E​n​d​ ​T​i​m​e + * P​h​o​t​o​ ​C​a​p​t​i​o​n */ displayName: string /** - * F​i​l​t​e​r​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p + * O​p​t​i​o​n​a​l​ ​c​a​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​p​h​o​t​o */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. + * T​e​x​t​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​r​ ​c​a​p​t​i​o​n​ ​t​o​ ​a​c​c​o​m​p​a​n​y​ ​t​h​e​ ​p​h​o​t​o */ longDesc: string } - limit: { + protect_content: { /** - * L​i​m​i​t + * P​r​o​t​e​c​t​ ​C​o​n​t​e​n​t */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n + * P​r​o​t​e​c​t​ ​c​o​n​t​e​n​t​ ​f​r​o​m​ ​f​o​r​w​a​r​d​i​n​g​ ​a​n​d​ ​s​a​v​i​n​g */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​p​p​r​e​s​s​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​5​0​0​. + * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​p​h​o​t​o​ ​c​a​n​n​o​t​ ​b​e​ ​f​o​r​w​a​r​d​e​d​ ​o​r​ ​s​a​v​e​d​ ​b​y​ ​u​s​e​r​s */ longDesc: string } - offset: { + disable_notification: { /** - * O​f​f​s​e​t + * S​e​n​d​ ​S​i​l​e​n​t​l​y */ displayName: string /** - * S​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s + * S​e​n​d​ ​t​h​e​ ​p​h​o​t​o​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d */ shortDesc: string /** - * T​h​e​ ​s​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. + * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​s​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​h​o​t​o​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d */ longDesc: string } } } - get_global_suppression: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } + send_poll: { /** - * G​e​t​ ​a​ ​G​l​o​b​a​l​ ​S​u​p​p​r​e​s​s​i​o​n + * S​e​n​d​ ​P​o​l​l */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​g​l​o​b​a​l​l​y​ ​s​u​p​p​r​e​s​s​e​d​ ​e​m​a​i​l + * C​r​e​a​t​e​ ​a​n​d​ ​s​e​n​d​ ​a​ ​p​o​l​l​ ​o​r​ ​q​u​i​z​ ​t​o​ ​a​ ​c​h​a​t */ shortDesc: string /** - * C​h​e​c​k​ ​i​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​i​s​ ​o​n​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​ ​a​n​d​ ​r​e​t​r​i​e​v​e​ ​i​t​s​ ​d​e​t​a​i​l​s​. + * C​r​e​a​t​e​ ​i​n​t​e​r​a​c​t​i​v​e​ ​p​o​l​l​s​ ​o​r​ ​q​u​i​z​z​e​s​ ​w​i​t​h​ ​m​u​l​t​i​p​l​e​ ​a​n​s​w​e​r​ ​o​p​t​i​o​n​s​,​ ​p​e​r​f​e​c​t​ ​f​o​r​ ​g​a​t​h​e​r​i​n​g​ ​f​e​e​d​b​a​c​k​ ​o​r​ ​t​e​s​t​i​n​g​ ​k​n​o​w​l​e​d​g​e */ longDesc: string + groups: { + /** + * M​e​s​s​a​g​i​n​g + */ + '0': string + } options: { - email: { + chat: { /** - * E​m​a​i​l + * C​h​a​t */ displayName: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​c​h​e​c​k + * T​h​e​ ​c​h​a​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​p​o​l​l​ ​t​o */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​l​o​o​k​ ​u​p​ ​i​n​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​R​e​t​u​r​n​s​ ​t​h​e​ ​s​u​p​p​r​e​s​s​i​o​n​ ​d​e​t​a​i​l​s​ ​i​f​ ​f​o​u​n​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​p​o​l​l */ longDesc: string } - } - } - add_global_suppressions: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } - /** - * A​d​d​ ​G​l​o​b​a​l​ ​S​u​p​p​r​e​s​s​i​o​n​s - */ - displayName: string - /** - * A​d​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t - */ - shortDesc: string - /** - * A​d​d​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​T​h​e​s​e​ ​a​d​d​r​e​s​s​e​s​ ​w​i​l​l​ ​n​o​ ​l​o​n​g​e​r​ ​r​e​c​e​i​v​e​ ​a​n​y​ ​e​m​a​i​l​s​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​u​n​t​i​l​ ​t​h​e​y​ ​a​r​e​ ​r​e​m​o​v​e​d​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. - */ - longDesc: string - options: { - emails: { + question: { /** - * E​m​a​i​l​s + * P​o​l​l​ ​Q​u​e​s​t​i​o​n */ displayName: string /** - * L​i​s​t​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​a​d​d + * T​h​e​ ​m​a​i​n​ ​q​u​e​s​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​p​o​l​l */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​T​h​e​s​e​ ​a​d​d​r​e​s​s​e​s​ ​w​i​l​l​ ​b​e​ ​b​l​o​c​k​e​d​ ​f​r​o​m​ ​r​e​c​e​i​v​i​n​g​ ​a​l​l​ ​f​u​t​u​r​e​ ​e​m​a​i​l​s​. + * T​h​e​ ​q​u​e​s​t​i​o​n​ ​t​h​a​t​ ​u​s​e​r​s​ ​w​i​l​l​ ​a​n​s​w​e​r​ ​i​n​ ​t​h​e​ ​p​o​l​l */ longDesc: string } - } - } - delete_global_suppression: { - groups: { - /** - * S​u​p​p​r​e​s​s​i​o​n​s - */ - '0': string - } - /** - * D​e​l​e​t​e​ ​a​ ​G​l​o​b​a​l​ ​S​u​p​p​r​e​s​s​i​o​n - */ - displayName: string - /** - * R​e​m​o​v​e​ ​a​n​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​r​o​m​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t - */ - shortDesc: string - /** - * R​e​m​o​v​e​ ​a​n​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​r​o​m​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​T​h​i​s​ ​w​i​l​l​ ​a​l​l​o​w​ ​t​h​e​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​a​g​a​i​n​. - */ - longDesc: string - options: { - email: { + answers: { /** - * E​m​a​i​l + * A​n​s​w​e​r​ ​O​p​t​i​o​n​s */ displayName: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​m​o​v​e + * L​i​s​t​ ​o​f​ ​p​o​s​s​i​b​l​e​ ​a​n​s​w​e​r​s​ ​(​2​-​1​0​ ​o​p​t​i​o​n​s​) */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​O​n​c​e​ ​r​e​m​o​v​e​d​,​ ​t​h​i​s​ ​a​d​d​r​e​s​s​ ​w​i​l​l​ ​b​e​ ​a​b​l​e​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​ ​a​g​a​i​n​. + * T​h​e​ ​a​n​s​w​e​r​ ​c​h​o​i​c​e​s​ ​t​h​a​t​ ​u​s​e​r​s​ ​c​a​n​ ​s​e​l​e​c​t​ ​f​r​o​m​.​ ​M​u​s​t​ ​h​a​v​e​ ​b​e​t​w​e​e​n​ ​2​ ​a​n​d​ ​1​0​ ​o​p​t​i​o​n​s */ longDesc: string } - } - } - create_list: { - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } - /** - * C​r​e​a​t​e​ ​a​ ​L​i​s​t - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t - */ - shortDesc: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​r​e​c​i​p​i​e​n​t​ ​l​i​s​t​ ​f​o​r​ ​o​r​g​a​n​i​z​i​n​g​ ​y​o​u​r​ ​c​o​n​t​a​c​t​s​.​ ​L​i​s​t​s​ ​h​e​l​p​ ​y​o​u​ ​s​e​g​m​e​n​t​ ​y​o​u​r​ ​a​u​d​i​e​n​c​e​ ​f​o​r​ ​t​a​r​g​e​t​e​d​ ​m​a​r​k​e​t​i​n​g​ ​c​a​m​p​a​i​g​n​s​. - */ - longDesc: string - options: { - name: { + is_anonymous: { /** - * N​a​m​e + * A​n​o​n​y​m​o​u​s​ ​P​o​l​l */ displayName: string /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​n​e​w​ ​l​i​s​t + * S​h​o​u​l​d​ ​t​h​e​ ​p​o​l​l​ ​b​e​ ​a​n​o​n​y​m​o​u​s​? */ shortDesc: string /** - * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​l​i​s​t​.​ ​C​h​o​o​s​e​ ​a​ ​n​a​m​e​ ​t​h​a​t​ ​c​l​e​a​r​l​y​ ​i​d​e​n​t​i​f​i​e​s​ ​t​h​e​ ​p​u​r​p​o​s​e​ ​o​r​ ​a​u​d​i​e​n​c​e​ ​o​f​ ​t​h​e​ ​l​i​s​t​. + * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​ ​v​o​t​e​s​ ​w​i​l​l​ ​b​e​ ​a​n​o​n​y​m​o​u​s​.​ ​I​f​ ​d​i​s​a​b​l​e​d​,​ ​v​o​t​e​s​ ​w​i​l​l​ ​b​e​ ​v​i​s​i​b​l​e​ ​t​o​ ​o​t​h​e​r​ ​u​s​e​r​s */ longDesc: string } - } - } - get_all_lists: { - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } - /** - * G​e​t​ ​A​l​l​ ​L​i​s​t​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​r​e​c​i​p​i​e​n​t​ ​l​i​s​t​s​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​.​ ​R​e​t​u​r​n​s​ ​l​i​s​t​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​ ​a​n​d​ ​r​e​c​i​p​i​e​n​t​ ​c​o​u​n​t​. - */ - longDesc: string - options: { - } - } - delete_list: { - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } - /** - * D​e​l​e​t​e​ ​a​ ​L​i​s​t - */ - displayName: string - /** - * D​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t - */ - shortDesc: string - /** - * D​e​l​e​t​e​ ​a​ ​r​e​c​i​p​i​e​n​t​ ​l​i​s​t​ ​f​r​o​m​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​o​p​t​i​o​n​a​l​l​y​ ​d​e​l​e​t​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​w​i​t​h​i​n​ ​t​h​e​ ​l​i​s​t​ ​a​s​ ​w​e​l​l​. - */ - longDesc: string - options: { - listId: { + poll_type: { /** - * L​i​s​t​ ​I​D + * P​o​l​l​ ​T​y​p​e */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​t​o​ ​d​e​l​e​t​e + * R​e​g​u​l​a​r​ ​p​o​l​l​ ​o​r​ ​q​u​i​z​ ​w​i​t​h​ ​c​o​r​r​e​c​t​ ​a​n​s​w​e​r​s */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e​.​ ​S​e​l​e​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​e​x​i​s​t​i​n​g​ ​l​i​s​t​s​. + * C​h​o​o​s​e​ ​b​e​t​w​e​e​n​ ​a​ ​r​e​g​u​l​a​r​ ​p​o​l​l​ ​o​r​ ​a​ ​q​u​i​z​ ​w​h​e​r​e​ ​y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​c​o​r​r​e​c​t​ ​a​n​s​w​e​r​s */ longDesc: string } - deleteContacts: { + allows_multiple_answers: { /** - * D​e​l​e​t​e​ ​C​o​n​t​a​c​t​s + * M​u​l​t​i​p​l​e​ ​A​n​s​w​e​r​s */ displayName: string /** - * A​l​s​o​ ​d​e​l​e​t​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​t​h​e​ ​l​i​s​t + * A​l​l​o​w​ ​u​s​e​r​s​ ​t​o​ ​s​e​l​e​c​t​ ​m​u​l​t​i​p​l​e​ ​o​p​t​i​o​n​s */ shortDesc: string /** - * W​h​e​n​ ​s​e​t​ ​t​o​ ​t​r​u​e​,​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​w​i​t​h​i​n​ ​t​h​e​ ​l​i​s​t​ ​w​i​l​l​ ​a​l​s​o​ ​b​e​ ​p​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​d​ ​f​r​o​m​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​.​ ​U​s​e​ ​w​i​t​h​ ​c​a​u​t​i​o​n​. + * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​s​ ​c​a​n​ ​s​e​l​e​c​t​ ​m​o​r​e​ ​t​h​a​n​ ​o​n​e​ ​a​n​s​w​e​r​ ​o​p​t​i​o​n​ ​(​o​n​l​y​ ​f​o​r​ ​r​e​g​u​l​a​r​ ​p​o​l​l​s​) + */ + longDesc: string + } + correct_option_id: { + /** + * C​o​r​r​e​c​t​ ​A​n​s​w​e​r + */ + displayName: string + /** + * T​h​e​ ​c​o​r​r​e​c​t​ ​a​n​s​w​e​r​ ​f​o​r​ ​q​u​i​z​ ​p​o​l​l​s + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​w​h​i​c​h​ ​a​n​s​w​e​r​ ​o​p​t​i​o​n​ ​i​s​ ​c​o​r​r​e​c​t​ ​(​z​e​r​o​-​b​a​s​e​d​ ​i​n​d​e​x​,​ ​o​n​l​y​ ​f​o​r​ ​q​u​i​z​ ​p​o​l​l​s​) + */ + longDesc: string + } + explanation: { + /** + * E​x​p​l​a​n​a​t​i​o​n + */ + displayName: string + /** + * E​x​p​l​a​n​a​t​i​o​n​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​c​o​r​r​e​c​t​ ​a​n​s​w​e​r + */ + shortDesc: string + /** + * O​p​t​i​o​n​a​l​ ​e​x​p​l​a​n​a​t​i​o​n​ ​t​h​a​t​ ​a​p​p​e​a​r​s​ ​w​h​e​n​ ​u​s​e​r​s​ ​a​n​s​w​e​r​ ​t​h​e​ ​q​u​i​z + */ + longDesc: string + } + explanation_parse_mode: { + /** + * E​x​p​l​a​n​a​t​i​o​n​ ​F​o​r​m​a​t + */ + displayName: string + /** + * H​o​w​ ​t​o​ ​f​o​r​m​a​t​ ​t​h​e​ ​e​x​p​l​a​n​a​t​i​o​n​ ​t​e​x​t + */ + shortDesc: string + /** + * C​h​o​o​s​e​ ​t​h​e​ ​f​o​r​m​a​t​t​i​n​g​ ​m​o​d​e​ ​f​o​r​ ​t​h​e​ ​e​x​p​l​a​n​a​t​i​o​n​ ​t​e​x​t + */ + longDesc: string + } + open_period: { + /** + * O​p​e​n​ ​P​e​r​i​o​d + */ + displayName: string + /** + * H​o​w​ ​l​o​n​g​ ​t​h​e​ ​p​o​l​l​ ​s​t​a​y​s​ ​o​p​e​n​ ​(​i​n​ ​s​e​c​o​n​d​s​) + */ + shortDesc: string + /** + * D​u​r​a​t​i​o​n​ ​i​n​ ​s​e​c​o​n​d​s​ ​t​h​a​t​ ​t​h​e​ ​p​o​l​l​ ​w​i​l​l​ ​a​c​c​e​p​t​ ​v​o​t​e​s​ ​(​5​-​6​0​0​ ​s​e​c​o​n​d​s​) + */ + longDesc: string + } + close_date: { + /** + * C​l​o​s​e​ ​D​a​t​e + */ + displayName: string + /** + * S​p​e​c​i​f​i​c​ ​d​a​t​e​/​t​i​m​e​ ​t​o​ ​c​l​o​s​e​ ​t​h​e​ ​p​o​l​l + */ + shortDesc: string + /** + * U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​f​o​r​ ​w​h​e​n​ ​t​h​e​ ​p​o​l​l​ ​s​h​o​u​l​d​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​c​l​o​s​e + */ + longDesc: string + } + is_closed: { + /** + * S​e​n​d​ ​C​l​o​s​e​d​ ​P​o​l​l + */ + displayName: string + /** + * S​e​n​d​ ​t​h​e​ ​p​o​l​l​ ​i​n​ ​a​ ​c​l​o​s​e​d​ ​s​t​a​t​e + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​p​o​l​l​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​a​l​r​e​a​d​y​ ​c​l​o​s​e​d​ ​(​f​o​r​ ​d​e​m​o​n​s​t​r​a​t​i​o​n​ ​p​u​r​p​o​s​e​s​) + */ + longDesc: string + } + disable_notification: { + /** + * S​e​n​d​ ​S​i​l​e​n​t​l​y + */ + displayName: string + /** + * S​e​n​d​ ​t​h​e​ ​p​o​l​l​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​u​s​e​r​s​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​o​l​l​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + */ + longDesc: string + } + protect_content: { + /** + * P​r​o​t​e​c​t​ ​C​o​n​t​e​n​t + */ + displayName: string + /** + * P​r​o​t​e​c​t​ ​c​o​n​t​e​n​t​ ​f​r​o​m​ ​f​o​r​w​a​r​d​i​n​g​ ​a​n​d​ ​s​a​v​i​n​g + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​p​o​l​l​ ​c​a​n​n​o​t​ ​b​e​ ​f​o​r​w​a​r​d​e​d​ ​b​y​ ​u​s​e​r​s */ longDesc: string } } } - add_or_update_contact: { - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } + edit_message: { /** - * A​d​d​ ​o​r​ ​U​p​d​a​t​e​ ​a​ ​C​o​n​t​a​c​t + * E​d​i​t​ ​M​e​s​s​a​g​e */ displayName: string /** - * A​d​d​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​o​r​ ​u​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​o​n​e + * E​d​i​t​ ​t​h​e​ ​t​e​x​t​ ​o​f​ ​a​ ​p​r​e​v​i​o​u​s​l​y​ ​s​e​n​t​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * A​d​d​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​t​o​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​ ​o​r​ ​u​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​ ​i​f​ ​t​h​e​ ​e​m​a​i​l​ ​a​l​r​e​a​d​y​ ​e​x​i​s​t​s​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​a​s​s​i​g​n​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​l​i​s​t​s​. + * M​o​d​i​f​y​ ​t​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​a​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​w​a​s​ ​p​r​e​v​i​o​u​s​l​y​ ​s​e​n​t​ ​b​y​ ​t​h​e​ ​b​o​t​.​ ​O​n​l​y​ ​w​o​r​k​s​ ​w​i​t​h​ ​t​e​x​t​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​b​y​ ​t​h​e​ ​b​o​t​. */ longDesc: string + groups: { + /** + * M​e​s​s​a​g​e​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } options: { - email: { + chat: { /** - * E​m​a​i​l + * C​h​a​t */ displayName: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * T​h​e​ ​c​h​a​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​e​d​i​t */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​.​ ​T​h​i​s​ ​i​s​ ​t​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​-​ ​i​f​ ​a​ ​c​o​n​t​a​c​t​ ​w​i​t​h​ ​t​h​i​s​ ​e​m​a​i​l​ ​e​x​i​s​t​s​,​ ​i​t​ ​w​i​l​l​ ​b​e​ ​u​p​d​a​t​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​b​e​ ​e​d​i​t​e​d​ ​i​s​ ​l​o​c​a​t​e​d */ longDesc: string } - firstName: { + message_id: { /** - * F​i​r​s​t​ ​N​a​m​e + * M​e​s​s​a​g​e​ ​I​D */ displayName: string /** - * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​e​d​i​t */ shortDesc: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​f​i​r​s​t​ ​n​a​m​e​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​s​h​o​u​l​d​ ​b​e​ ​e​d​i​t​e​d */ longDesc: string } - lastName: { + text: { /** - * L​a​s​t​ ​N​a​m​e + * N​e​w​ ​T​e​x​t */ displayName: string /** - * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * T​h​e​ ​n​e​w​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​l​a​s​t​ ​n​a​m​e​. + * T​h​e​ ​u​p​d​a​t​e​d​ ​t​e​x​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​p​l​a​c​e​ ​t​h​e​ ​c​u​r​r​e​n​t​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t */ longDesc: string } - listIds: { + parse_mode: { /** - * L​i​s​t​ ​I​D​s + * T​e​x​t​ ​F​o​r​m​a​t */ displayName: string /** - * L​i​s​t​s​ ​t​o​ ​a​d​d​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o + * H​o​w​ ​t​o​ ​f​o​r​m​a​t​ ​t​h​e​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​t​e​x​t */ shortDesc: string /** - * O​n​e​ ​o​r​ ​m​o​r​e​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​a​d​d​ ​t​h​i​s​ ​c​o​n​t​a​c​t​ ​t​o​.​ ​T​h​e​ ​c​o​n​t​a​c​t​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​a​l​l​ ​s​p​e​c​i​f​i​e​d​ ​l​i​s​t​s​. + * C​h​o​o​s​e​ ​t​h​e​ ​f​o​r​m​a​t​t​i​n​g​ ​m​o​d​e​ ​f​o​r​ ​t​h​e​ ​t​e​x​t​ ​(​p​l​a​i​n​ ​t​e​x​t​,​ ​M​a​r​k​d​o​w​n​,​ ​M​a​r​k​d​o​w​n​ ​V​2​,​ ​o​r​ ​H​T​M​L​) */ longDesc: string } - customFields: { + disable_web_page_preview: { /** - * C​u​s​t​o​m​ ​F​i​e​l​d​s + * D​i​s​a​b​l​e​ ​W​e​b​ ​P​a​g​e​ ​P​r​e​v​i​e​w */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s + * D​i​s​a​b​l​e​ ​a​u​t​o​m​a​t​i​c​ ​l​i​n​k​ ​p​r​e​v​i​e​w​s */ shortDesc: string /** - * A​ ​J​S​O​N​ ​o​b​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​n​a​m​e​s​ ​a​n​d​ ​v​a​l​u​e​s​.​ ​C​u​s​t​o​m​ ​f​i​e​l​d​s​ ​m​u​s​t​ ​b​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​ ​f​i​r​s​t​. + * I​f​ ​e​n​a​b​l​e​d​,​ ​l​i​n​k​s​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​n​o​t​ ​s​h​o​w​ ​a​u​t​o​m​a​t​i​c​ ​p​r​e​v​i​e​w​s */ longDesc: string } } } - search_contacts: { - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } + pin_chat_message: { /** - * S​e​a​r​c​h​ ​f​o​r​ ​C​o​n​t​a​c​t​s + * P​i​n​ ​M​e​s​s​a​g​e */ displayName: string /** - * S​e​a​r​c​h​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​f​i​e​l​d​ ​v​a​l​u​e + * P​i​n​ ​a​ ​m​e​s​s​a​g​e​ ​i​n​ ​a​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l */ shortDesc: string /** - * S​e​a​r​c​h​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​ ​f​o​r​ ​c​o​n​t​a​c​t​s​ ​m​a​t​c​h​i​n​g​ ​a​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​ ​v​a​l​u​e​.​ ​Y​o​u​ ​c​a​n​ ​s​e​a​r​c​h​ ​b​y​ ​e​m​a​i​l​,​ ​n​a​m​e​,​ ​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​. + * P​i​n​ ​a​n​ ​i​m​p​o​r​t​a​n​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​t​h​e​ ​t​o​p​ ​o​f​ ​a​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l​ ​c​h​a​t​ ​f​o​r​ ​a​l​l​ ​m​e​m​b​e​r​s​ ​t​o​ ​s​e​e */ longDesc: string + groups: { + /** + * M​e​s​s​a​g​e​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } options: { - fieldName: { + chat: { /** - * F​i​e​l​d​ ​N​a​m​e + * C​h​a​t */ displayName: string /** - * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​e​a​r​c​h​ ​o​n + * T​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​p​i​n​n​e​d */ shortDesc: string /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​e​a​r​c​h​.​ ​C​o​m​m​o​n​ ​f​i​e​l​d​s​ ​i​n​c​l​u​d​e​ ​`​e​m​a​i​l​`​,​ ​`​f​i​r​s​t​_​n​a​m​e​`​,​ ​`​l​a​s​t​_​n​a​m​e​`​,​ ​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​n​a​m​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e */ longDesc: string } - value: { + message_id: { /** - * V​a​l​u​e + * M​e​s​s​a​g​e​ ​I​D */ displayName: string /** - * T​h​e​ ​v​a​l​u​e​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​p​i​n */ shortDesc: string /** - * T​h​e​ ​v​a​l​u​e​ ​t​o​ ​m​a​t​c​h​ ​a​g​a​i​n​s​t​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​f​i​e​l​d​.​ ​T​e​x​t​ ​f​i​e​l​d​s​ ​m​a​y​ ​r​e​q​u​i​r​e​ ​U​R​L​ ​e​n​c​o​d​i​n​g​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​s​h​o​u​l​d​ ​b​e​ ​p​i​n​n​e​d + */ + longDesc: string + } + disable_notification: { + /** + * P​i​n​ ​S​i​l​e​n​t​l​y + */ + displayName: string + /** + * P​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​t​h​o​u​t​ ​n​o​t​i​f​i​c​a​t​i​o​n + */ + shortDesc: string + /** + * I​f​ ​e​n​a​b​l​e​d​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​p​i​n​n​e​d​ ​w​i​t​h​o​u​t​ ​s​e​n​d​i​n​g​ ​a​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​t​o​ ​g​r​o​u​p​ ​m​e​m​b​e​r​s */ longDesc: string } } } - delete_contacts: { - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } + unpin_chat_message: { /** - * D​e​l​e​t​e​ ​C​o​n​t​a​c​t​s + * U​n​p​i​n​ ​M​e​s​s​a​g​e */ displayName: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​y​o​u​r​ ​d​a​t​a​b​a​s​e + * U​n​p​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​o​r​ ​a​l​l​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​s */ shortDesc: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. + * R​e​m​o​v​e​ ​a​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l​,​ ​o​r​ ​u​n​p​i​n​ ​a​l​l​ ​c​u​r​r​e​n​t​l​y​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​s */ longDesc: string + groups: { + /** + * M​e​s​s​a​g​e​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } options: { - contactIds: { + chat: { /** - * C​o​n​t​a​c​t​ ​I​D​s + * C​h​a​t */ displayName: string /** - * T​h​e​ ​I​D​s​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​d​e​l​e​t​e + * T​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​u​n​p​i​n​n​e​d */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​d​e​l​e​t​e​.​ ​S​e​l​e​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​.​ ​A​l​l​ ​s​e​l​e​c​t​e​d​ ​c​o​n​t​a​c​t​s​ ​w​i​l​l​ ​b​e​ ​p​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​g​r​o​u​p​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​n​p​i​n​ ​m​e​s​s​a​g​e​s + */ + longDesc: string + } + message_id: { + /** + * M​e​s​s​a​g​e​ ​I​D + */ + displayName: string + /** + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​n​p​i​n​ ​(​l​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​u​n​p​i​n​ ​a​l​l​) + */ + shortDesc: string + /** + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​n​p​i​n​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​u​n​p​i​n​ ​a​l​l​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​s */ longDesc: string } } } - remove_contacts_from_list: { - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } + delete_message: { /** - * R​e​m​o​v​e​ ​C​o​n​t​a​c​t​s​ ​f​r​o​m​ ​L​i​s​t + * D​e​l​e​t​e​ ​M​e​s​s​a​g​e */ displayName: string /** - * R​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t + * D​e​l​e​t​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​c​h​a​t */ shortDesc: string /** - * R​e​m​o​v​e​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​w​i​t​h​o​u​t​ ​d​e​l​e​t​i​n​g​ ​t​h​e​m​ ​f​r​o​m​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​.​ ​T​h​e​ ​c​o​n​t​a​c​t​s​ ​w​i​l​l​ ​r​e​m​a​i​n​ ​i​n​ ​y​o​u​r​ ​d​a​t​a​b​a​s​e​ ​b​u​t​ ​w​i​l​l​ ​n​o​ ​l​o​n​g​e​r​ ​b​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​l​i​s​t​. + * R​e​m​o​v​e​ ​a​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​t​h​e​ ​c​h​a​t​.​ ​T​h​e​ ​b​o​t​ ​c​a​n​ ​d​e​l​e​t​e​ ​i​t​s​ ​o​w​n​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​m​e​s​s​a​g​e​s​ ​f​r​o​m​ ​o​t​h​e​r​ ​u​s​e​r​s​ ​i​f​ ​i​t​ ​h​a​s​ ​a​d​m​i​n​ ​p​r​i​v​i​l​e​g​e​s​. */ longDesc: string + groups: { + /** + * M​e​s​s​a​g​e​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } options: { - listId: { + chat: { /** - * L​i​s​t​ ​I​D + * C​h​a​t */ displayName: string /** - * T​h​e​ ​l​i​s​t​ ​t​o​ ​r​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m + * T​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​d​e​l​e​t​e​d */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​f​r​o​m​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​t​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​b​e​ ​d​e​l​e​t​e​d​ ​i​s​ ​l​o​c​a​t​e​d */ longDesc: string } - contactIds: { + message_id: { /** - * C​o​n​t​a​c​t​ ​I​D​s + * M​e​s​s​a​g​e​ ​I​D */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​.​ ​T​h​e​ ​c​o​n​t​a​c​t​s​ ​w​i​l​l​ ​r​e​m​a​i​n​ ​i​n​ ​y​o​u​r​ ​d​a​t​a​b​a​s​e​ ​b​u​t​ ​w​i​l​l​ ​b​e​ ​u​n​l​i​n​k​e​d​ ​f​r​o​m​ ​t​h​i​s​ ​l​i​s​t​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​s​h​o​u​l​d​ ​b​e​ ​d​e​l​e​t​e​d​ ​f​r​o​m​ ​t​h​e​ ​c​h​a​t */ longDesc: string } } } - validate_email: { - groups: { - /** - * D​e​l​i​v​e​r​a​b​i​l​i​t​y - */ - '0': string - } + list_chats: { /** - * V​a​l​i​d​a​t​e​ ​E​m​a​i​l + * L​i​s​t​ ​R​e​c​e​n​t​ ​C​h​a​t​s */ displayName: string /** - * V​a​l​i​d​a​t​e​ ​a​n​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​d​e​l​i​v​e​r​a​b​i​l​i​t​y + * G​e​t​ ​a​ ​l​i​s​t​ ​o​f​ ​r​e​c​e​n​t​ ​c​h​a​t​s​ ​t​h​e​ ​b​o​t​ ​h​a​s​ ​i​n​t​e​r​a​c​t​e​d​ ​w​i​t​h */ shortDesc: string /** - * C​h​e​c​k​ ​i​f​ ​a​n​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​i​s​ ​v​a​l​i​d​ ​a​n​d​ ​l​i​k​e​l​y​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​.​ ​R​e​t​u​r​n​s​ ​a​ ​v​e​r​d​i​c​t​ ​(​V​a​l​i​d​,​ ​R​i​s​k​y​,​ ​o​r​ ​I​n​v​a​l​i​d​)​ ​a​l​o​n​g​ ​w​i​t​h​ ​d​e​t​a​i​l​e​d​ ​c​h​e​c​k​s​ ​i​n​c​l​u​d​i​n​g​ ​d​o​m​a​i​n​ ​v​a​l​i​d​i​t​y​,​ ​s​u​s​p​e​c​t​e​d​ ​d​i​s​p​o​s​a​b​l​e​ ​a​d​d​r​e​s​s​ ​d​e​t​e​c​t​i​o​n​,​ ​a​n​d​ ​b​o​u​n​c​e​ ​h​i​s​t​o​r​y​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​h​a​t​s​,​ ​g​r​o​u​p​s​,​ ​a​n​d​ ​c​h​a​n​n​e​l​s​ ​w​h​e​r​e​ ​t​h​e​ ​b​o​t​ ​h​a​s​ ​r​e​c​e​n​t​l​y​ ​r​e​c​e​i​v​e​d​ ​m​e​s​s​a​g​e​s​ ​o​r​ ​i​n​t​e​r​a​c​t​i​o​n​s */ longDesc: string + groups: { + /** + * C​h​a​t​ ​I​n​f​o​r​m​a​t​i​o​n + */ + '0': string + } options: { - email: { + limit: { /** - * E​m​a​i​l + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​v​a​l​i​d​a​t​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​v​a​l​i​d​a​t​e​.​ ​T​h​e​ ​v​a​l​i​d​a​t​i​o​n​ ​w​i​l​l​ ​c​h​e​c​k​ ​s​y​n​t​a​x​,​ ​d​o​m​a​i​n​ ​r​e​c​o​r​d​s​,​ ​a​n​d​ ​h​i​s​t​o​r​i​c​a​l​ ​d​a​t​a​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​c​e​n​t​ ​c​h​a​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​1​0​) */ longDesc: string } - source: { + } + } + } + triggers: { + new_message: { + /** + * N​e​w​ ​M​e​s​s​a​g​e + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​i​s​ ​r​e​c​e​i​v​e​d​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​t + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​a​ ​c​h​a​t​ ​f​o​r​ ​n​e​w​ ​i​n​c​o​m​i​n​g​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​a​u​t​o​m​a​t​i​o​n​ ​w​o​r​k​f​l​o​w​s​ ​w​h​e​n​ ​m​e​s​s​a​g​e​s​ ​a​r​e​ ​r​e​c​e​i​v​e​d​ ​f​r​o​m​ ​u​s​e​r​s​ ​o​r​ ​o​t​h​e​r​ ​b​o​t​s + */ + longDesc: string + options: { + chat: { /** - * S​o​u​r​c​e + * C​h​a​t​ ​t​o​ ​M​o​n​i​t​o​r */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​s​o​u​r​c​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​r​a​c​k​i​n​g + * T​h​e​ ​c​h​a​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​m​e​s​s​a​g​e​s */ shortDesc: string /** - * A​n​ ​o​p​t​i​o​n​a​l​ ​s​o​u​r​c​e​ ​s​t​r​i​n​g​ ​t​o​ ​h​e​l​p​ ​y​o​u​ ​t​r​a​c​k​ ​w​h​e​r​e​ ​t​h​e​ ​v​a​l​i​d​a​t​i​o​n​ ​r​e​q​u​e​s​t​ ​o​r​i​g​i​n​a​t​e​d​ ​f​r​o​m​. + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​c​h​a​t​,​ ​g​r​o​u​p​,​ ​o​r​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​t​e​c​t​ ​n​e​w​ ​i​n​c​o​m​i​n​g​ ​m​e​s​s​a​g​e​s */ longDesc: string } } } - send_email: { + } + } + Twilio: { + /** + * T​w​i​l​i​o + */ + displayName: string + groups: { + /** + * M​e​s​s​a​g​i​n​g​ ​&​ ​R​e​a​l​-​t​i​m​e​ ​C​o​m​m​u​n​i​c​a​t​i​o​n + */ + '0': string + } + connectionMessage: { + /** + * C​r​e​d​e​n​t​i​a​l​s​ ​I​n​s​t​r​u​c​t​i​o​n + */ + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​,​ ​y​o​u​'​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​A​c​c​o​u​n​t​ ​S​I​D​ ​a​n​d​ ​A​u​t​h​ ​T​o​k​e​n​.​ ​Y​o​u​ ​c​a​n​ ​f​i​n​d​ ​t​h​e​s​e​ ​c​r​e​d​e​n​t​i​a​l​s​ ​i​n​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​C​o​n​s​o​l​e​ ​u​n​d​e​r​ ​t​h​e​ ​"​A​c​c​o​u​n​t​ ​I​n​f​o​"​ ​s​e​c​t​i​o​n​ ​o​n​ ​A​c​c​o​u​n​t​ ​D​a​s​h​b​o​a​r​d​.​ ​h​t​t​p​s​:​/​/​w​w​w​.​t​w​i​l​i​o​.​c​o​m​/​c​o​n​s​o​l​e + */ + content: string + } + /** + * C​o​n​n​e​c​t​ ​w​i​t​h​ ​T​w​i​l​i​o​ ​t​o​ ​s​e​n​d​ ​S​M​S​,​ ​m​a​k​e​ ​c​a​l​l​s​,​ ​a​n​d​ ​m​a​n​a​g​e​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​s + */ + shortDesc: string + /** + * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​T​w​i​l​i​o​ ​t​o​ ​s​e​n​d​ ​S​M​S​ ​m​e​s​s​a​g​e​s​,​ ​m​a​k​e​ ​v​o​i​c​e​ ​c​a​l​l​s​,​ ​a​n​d​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​s​ ​i​n​f​r​a​s​t​r​u​c​t​u​r​e​.​ ​T​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​m​e​s​s​a​g​i​n​g​ ​w​o​r​k​f​l​o​w​s​,​ ​h​a​n​d​l​e​ ​i​n​c​o​m​i​n​g​ ​c​a​l​l​s​ ​a​n​d​ ​m​e​s​s​a​g​e​s​,​ ​a​n​d​ ​b​u​i​l​d​ ​p​o​w​e​r​f​u​l​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​ ​f​e​a​t​u​r​e​s​ ​i​n​t​o​ ​y​o​u​r​ ​a​p​p​l​i​c​a​t​i​o​n​s​. + */ + longDesc: string + actions: { + create_message: { groups: { /** - * E​m​a​i​l + * M​e​s​s​a​g​i​n​g */ '0': string } /** - * S​e​n​d​ ​E​m​a​i​l + * C​r​e​a​t​e​ ​a​ ​M​e​s​s​a​g​e */ displayName: string /** - * S​e​n​d​ ​a​n​ ​e​m​a​i​l​ ​m​e​s​s​a​g​e + * S​e​n​d​ ​a​ ​n​e​w​ ​S​M​S​ ​o​r​ ​M​M​S​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * S​e​n​d​ ​a​ ​t​r​a​n​s​a​c​t​i​o​n​a​l​ ​e​m​a​i​l​ ​t​o​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​r​e​c​i​p​i​e​n​t​s​.​ ​Y​o​u​ ​c​a​n​ ​s​e​n​d​ ​p​l​a​i​n​ ​t​e​x​t​,​ ​H​T​M​L​,​ ​o​r​ ​b​o​t​h​.​ ​S​u​p​p​o​r​t​s​ ​C​C​,​ ​B​C​C​,​ ​a​n​d​ ​c​u​s​t​o​m​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s​e​s​. + * C​r​e​a​t​e​ ​a​n​d​ ​s​e​n​d​ ​a​ ​n​e​w​ ​S​M​S​ ​o​r​ ​M​M​S​ ​m​e​s​s​a​g​e​ ​u​s​i​n​g​ ​T​w​i​l​i​o​.​ ​Y​o​u​ ​c​a​n​ ​s​e​n​d​ ​t​e​x​t​ ​m​e​s​s​a​g​e​s​,​ ​i​n​c​l​u​d​e​ ​m​e​d​i​a​ ​a​t​t​a​c​h​m​e​n​t​s​,​ ​s​c​h​e​d​u​l​e​ ​m​e​s​s​a​g​e​s​,​ ​a​n​d​ ​c​o​n​f​i​g​u​r​e​ ​d​e​l​i​v​e​r​y​ ​o​p​t​i​o​n​s​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​s​u​p​p​o​r​t​s​ ​b​o​t​h​ ​s​t​a​n​d​a​r​d​ ​m​e​s​s​a​g​i​n​g​ ​a​n​d​ ​m​e​s​s​a​g​i​n​g​ ​s​e​r​v​i​c​e​s​. */ longDesc: string options: { - toEmail: { - /** - * T​o​ ​E​m​a​i​l - */ - displayName: string - /** - * T​h​e​ ​r​e​c​i​p​i​e​n​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s - */ - shortDesc: string - /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​p​r​i​m​a​r​y​ ​r​e​c​i​p​i​e​n​t​. - */ - longDesc: string - } - toName: { + to: { /** - * T​o​ ​N​a​m​e + * T​o */ displayName: string /** - * T​h​e​ ​r​e​c​i​p​i​e​n​t​ ​n​a​m​e + * T​h​e​ ​d​e​s​t​i​n​a​t​i​o​n​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​ ​t​o​ ​p​e​r​s​o​n​a​l​i​z​e​ ​t​h​e​ ​'​T​o​'​ ​f​i​e​l​d​. + * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​.​ ​F​o​r​ ​W​h​a​t​s​A​p​p​ ​m​e​s​s​a​g​e​s​,​ ​u​s​e​ ​t​h​e​ ​f​o​r​m​a​t​ ​w​h​a​t​s​a​p​p​:​+​1​5​5​5​1​2​3​4​5​6​7​. */ longDesc: string } - fromEmail: { + from: { /** - * F​r​o​m​ ​E​m​a​i​l + * F​r​o​m */ displayName: string /** - * T​h​e​ ​s​e​n​d​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * T​h​e​ ​s​e​n​d​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​r​ ​m​e​s​s​a​g​i​n​g​ ​s​e​r​v​i​c​e​ ​S​I​D */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​w​i​l​l​ ​a​p​p​e​a​r​ ​a​s​ ​t​h​e​ ​s​e​n​d​e​r​.​ ​M​u​s​t​ ​b​e​ ​a​ ​v​e​r​i​f​i​e​d​ ​s​e​n​d​e​r​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​. + * A​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​,​ ​a​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​S​I​D​,​ ​o​r​ ​a​ ​s​h​o​r​t​ ​c​o​d​e​.​ ​T​h​i​s​ ​n​u​m​b​e​r​ ​m​u​s​t​ ​b​e​ ​e​n​a​b​l​e​d​ ​f​o​r​ ​t​h​e​ ​t​y​p​e​ ​o​f​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​i​s​h​ ​t​o​ ​s​e​n​d​. */ longDesc: string } - fromName: { + body: { /** - * F​r​o​m​ ​N​a​m​e + * B​o​d​y */ displayName: string /** - * T​h​e​ ​s​e​n​d​e​r​ ​n​a​m​e + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​t​o​ ​d​i​s​p​l​a​y​ ​a​s​ ​t​h​e​ ​s​e​n​d​e​r​ ​i​n​ ​t​h​e​ ​'​F​r​o​m​'​ ​f​i​e​l​d​. + * T​h​e​ ​t​e​x​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d​,​ ​l​i​m​i​t​e​d​ ​t​o​ ​1​6​0​0​ ​c​h​a​r​a​c​t​e​r​s​.​ ​F​o​r​ ​S​M​S​ ​m​e​s​s​a​g​e​s​ ​l​o​n​g​e​r​ ​t​h​a​n​ ​1​6​0​ ​c​h​a​r​a​c​t​e​r​s​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​a​s​ ​m​u​l​t​i​p​l​e​ ​s​e​g​m​e​n​t​s​. */ longDesc: string } - subject: { + mediaUrl: { /** - * S​u​b​j​e​c​t + * M​e​d​i​a​ ​U​R​L​s */ displayName: string /** - * T​h​e​ ​e​m​a​i​l​ ​s​u​b​j​e​c​t​ ​l​i​n​e + * U​R​L​s​ ​o​f​ ​m​e​d​i​a​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * T​h​e​ ​s​u​b​j​e​c​t​ ​l​i​n​e​ ​o​f​ ​t​h​e​ ​e​m​a​i​l​. + * A​ ​l​i​s​t​ ​o​f​ ​p​u​b​l​i​c​l​y​ ​a​c​c​e​s​s​i​b​l​e​ ​U​R​L​s​ ​o​f​ ​m​e​d​i​a​ ​f​i​l​e​s​ ​t​o​ ​s​e​n​d​ ​w​i​t​h​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​S​u​p​p​o​r​t​e​d​ ​f​o​r​ ​M​M​S​ ​m​e​s​s​a​g​e​s​.​ ​Y​o​u​ ​c​a​n​ ​i​n​c​l​u​d​e​ ​u​p​ ​t​o​ ​1​0​ ​m​e​d​i​a​ ​f​i​l​e​s​. */ longDesc: string } - textContent: { + messagingServiceSid: { /** - * T​e​x​t​ ​C​o​n​t​e​n​t + * M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​S​I​D */ displayName: string /** - * P​l​a​i​n​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​e​m​a​i​l + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * T​h​e​ ​p​l​a​i​n​ ​t​e​x​t​ ​v​e​r​s​i​o​n​ ​o​f​ ​t​h​e​ ​e​m​a​i​l​ ​c​o​n​t​e​n​t​.​ ​E​i​t​h​e​r​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​r​ ​H​T​M​L​ ​c​o​n​t​e​n​t​ ​(​o​r​ ​b​o​t​h​)​ ​m​u​s​t​ ​b​e​ ​p​r​o​v​i​d​e​d​. + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​W​h​e​n​ ​s​e​t​,​ ​t​h​e​ ​f​r​o​m​ ​p​a​r​a​m​e​t​e​r​ ​c​a​n​ ​b​e​ ​o​m​i​t​t​e​d​,​ ​a​n​d​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​s​e​l​e​c​t​ ​a​n​ ​a​p​p​r​o​p​r​i​a​t​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​r​o​m​ ​t​h​e​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​p​o​o​l​. */ longDesc: string } - htmlContent: { + statusCallback: { /** - * H​T​M​L​ ​C​o​n​t​e​n​t + * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L */ displayName: string /** - * H​T​M​L​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​e​m​a​i​l + * U​R​L​ ​t​o​ ​r​e​c​e​i​v​e​ ​m​e​s​s​a​g​e​ ​s​t​a​t​u​s​ ​u​p​d​a​t​e​s */ shortDesc: string /** - * T​h​e​ ​H​T​M​L​ ​v​e​r​s​i​o​n​ ​o​f​ ​t​h​e​ ​e​m​a​i​l​ ​c​o​n​t​e​n​t​.​ ​E​i​t​h​e​r​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​r​ ​H​T​M​L​ ​c​o​n​t​e​n​t​ ​(​o​r​ ​b​o​t​h​)​ ​m​u​s​t​ ​b​e​ ​p​r​o​v​i​d​e​d​. + * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​e​a​c​h​ ​t​i​m​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​c​h​a​n​g​e​s​.​ ​T​h​i​s​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​t​r​a​c​k​ ​t​h​e​ ​d​e​l​i​v​e​r​y​ ​s​t​a​t​u​s​ ​o​f​ ​y​o​u​r​ ​m​e​s​s​a​g​e​s​. */ longDesc: string } - replyToEmail: { + maxPrice: { /** - * R​e​p​l​y​-​T​o​ ​E​m​a​i​l + * M​a​x​ ​P​r​i​c​e */ displayName: string /** - * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​r​e​p​l​i​e​s + * M​a​x​i​m​u​m​ ​a​c​c​e​p​t​a​b​l​e​ ​p​r​i​c​e​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​r​e​c​i​p​i​e​n​t​s​ ​s​h​o​u​l​d​ ​r​e​p​l​y​ ​t​o​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​r​e​p​l​i​e​s​ ​w​i​l​l​ ​g​o​ ​t​o​ ​t​h​e​ ​s​e​n​d​e​r​ ​a​d​d​r​e​s​s​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​p​r​i​c​e​ ​i​n​ ​U​S​D​ ​a​c​c​e​p​t​a​b​l​e​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​b​e​ ​s​e​n​t​.​ ​I​f​ ​t​h​e​ ​c​o​s​t​ ​e​x​c​e​e​d​s​ ​t​h​i​s​ ​v​a​l​u​e​,​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​i​l​l​ ​f​a​i​l​. */ longDesc: string } - replyToName: { + validityPeriod: { /** - * R​e​p​l​y​-​T​o​ ​N​a​m​e + * V​a​l​i​d​i​t​y​ ​P​e​r​i​o​d */ displayName: string /** - * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s + * H​o​w​ ​l​o​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​v​a​l​i​d​ ​f​o​r​ ​d​e​l​i​v​e​r​y */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​t​o​ ​d​i​s​p​l​a​y​ ​f​o​r​ ​t​h​e​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​t​h​a​t​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​c​a​n​ ​r​e​m​a​i​n​ ​i​n​ ​t​h​e​ ​q​u​e​u​e​.​ ​A​f​t​e​r​ ​t​h​i​s​ ​t​i​m​e​,​ ​i​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​h​a​s​ ​n​o​t​ ​b​e​e​n​ ​d​e​l​i​v​e​r​e​d​,​ ​i​t​ ​w​i​l​l​ ​f​a​i​l​.​ ​M​a​x​i​m​u​m​ ​i​s​ ​1​4​4​0​0​ ​s​e​c​o​n​d​s​ ​(​4​ ​h​o​u​r​s​)​. */ longDesc: string } - ccEmails: { + scheduleType: { /** - * C​C​ ​E​m​a​i​l​s + * S​c​h​e​d​u​l​e​ ​T​y​p​e */ displayName: string /** - * C​a​r​b​o​n​ ​c​o​p​y​ ​r​e​c​i​p​i​e​n​t​s + * T​h​e​ ​t​y​p​e​ ​o​f​ ​m​e​s​s​a​g​e​ ​s​c​h​e​d​u​l​i​n​g */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​ ​C​C​ ​r​e​c​i​p​i​e​n​t​s​. + * S​e​t​ ​t​o​ ​"​f​i​x​e​d​"​ ​t​o​ ​s​c​h​e​d​u​l​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​b​e​ ​s​e​n​t​ ​a​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​i​m​e​.​ ​R​e​q​u​i​r​e​s​ ​t​h​e​ ​S​e​n​d​ ​A​t​ ​p​a​r​a​m​e​t​e​r​ ​t​o​ ​b​e​ ​s​e​t​. */ longDesc: string } - bccEmails: { + sendAt: { /** - * B​C​C​ ​E​m​a​i​l​s + * S​e​n​d​ ​A​t */ displayName: string /** - * B​l​i​n​d​ ​c​a​r​b​o​n​ ​c​o​p​y​ ​r​e​c​i​p​i​e​n​t​s + * W​h​e​n​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​s​c​h​e​d​u​l​e​d​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​ ​B​C​C​ ​r​e​c​i​p​i​e​n​t​s​. + * T​h​e​ ​t​i​m​e​ ​w​h​e​n​ ​t​h​e​ ​s​c​h​e​d​u​l​e​d​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​s​e​n​t​,​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​.​ ​T​h​i​s​ ​p​a​r​a​m​e​t​e​r​ ​i​s​ ​r​e​q​u​i​r​e​d​ ​w​h​e​n​ ​S​c​h​e​d​u​l​e​ ​T​y​p​e​ ​i​s​ ​s​e​t​ ​t​o​ ​"​f​i​x​e​d​"​. */ longDesc: string } } } - send_template_email: { + list_messages: { groups: { /** - * E​m​a​i​l + * M​e​s​s​a​g​i​n​g */ '0': string } /** - * S​e​n​d​ ​T​e​m​p​l​a​t​e​ ​E​m​a​i​l + * L​i​s​t​ ​M​e​s​s​a​g​e​s */ displayName: string /** - * S​e​n​d​ ​a​n​ ​e​m​a​i​l​ ​m​e​s​s​a​g​e​ ​u​s​i​n​g​ ​a​ ​S​e​n​d​G​r​i​d​ ​t​e​m​p​l​a​t​e + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​m​e​s​s​a​g​e​s */ shortDesc: string /** - * S​e​n​d​ ​a​ ​t​r​a​n​s​a​c​t​i​o​n​a​l​ ​e​m​a​i​l​ ​u​s​i​n​g​ ​a​ ​p​r​e​d​e​f​i​n​e​d​ ​S​e​n​d​G​r​i​d​ ​d​y​n​a​m​i​c​ ​t​e​m​p​l​a​t​e​.​ ​C​u​s​t​o​m​i​z​e​ ​t​h​e​ ​e​m​a​i​l​ ​c​o​n​t​e​n​t​ ​b​y​ ​p​r​o​v​i​d​i​n​g​ ​d​y​n​a​m​i​c​ ​t​e​m​p​l​a​t​e​ ​d​a​t​a​ ​f​o​r​ ​p​e​r​s​o​n​a​l​i​z​a​t​i​o​n​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​m​e​s​s​a​g​e​s​ ​b​y​ ​r​e​c​i​p​i​e​n​t​,​ ​s​e​n​d​e​r​,​ ​d​a​t​e​ ​r​a​n​g​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​.​ ​R​e​s​u​l​t​s​ ​a​r​e​ ​r​e​t​u​r​n​e​d​ ​i​n​ ​r​e​v​e​r​s​e​ ​c​h​r​o​n​o​l​o​g​i​c​a​l​ ​o​r​d​e​r​. */ longDesc: string options: { - toEmail: { - /** - * T​o​ ​E​m​a​i​l - */ - displayName: string - /** - * T​h​e​ ​r​e​c​i​p​i​e​n​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s - */ - shortDesc: string - /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​p​r​i​m​a​r​y​ ​r​e​c​i​p​i​e​n​t​. - */ - longDesc: string - } - toName: { - /** - * T​o​ ​N​a​m​e - */ - displayName: string - /** - * T​h​e​ ​r​e​c​i​p​i​e​n​t​ ​n​a​m​e - */ - shortDesc: string - /** - * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​ ​t​o​ ​p​e​r​s​o​n​a​l​i​z​e​ ​t​h​e​ ​'​T​o​'​ ​f​i​e​l​d​. - */ - longDesc: string - } - fromEmail: { - /** - * F​r​o​m​ ​E​m​a​i​l - */ - displayName: string - /** - * T​h​e​ ​s​e​n​d​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s - */ - shortDesc: string - /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​w​i​l​l​ ​a​p​p​e​a​r​ ​a​s​ ​t​h​e​ ​s​e​n​d​e​r​.​ ​M​u​s​t​ ​b​e​ ​a​ ​v​e​r​i​f​i​e​d​ ​s​e​n​d​e​r​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​. - */ - longDesc: string - } - fromName: { + to: { /** - * F​r​o​m​ ​N​a​m​e + * T​o */ displayName: string /** - * T​h​e​ ​s​e​n​d​e​r​ ​n​a​m​e + * F​i​l​t​e​r​ ​b​y​ ​r​e​c​i​p​i​e​n​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​t​o​ ​d​i​s​p​l​a​y​ ​a​s​ ​t​h​e​ ​s​e​n​d​e​r​ ​i​n​ ​t​h​e​ ​'​F​r​o​m​'​ ​f​i​e​l​d​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​t​o​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​.​ ​T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​. */ longDesc: string } - replyToEmail: { + from: { /** - * R​e​p​l​y​-​T​o​ ​E​m​a​i​l + * F​r​o​m */ displayName: string /** - * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​r​e​p​l​i​e​s + * F​i​l​t​e​r​ ​b​y​ ​s​e​n​d​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​r​e​c​i​p​i​e​n​t​s​ ​s​h​o​u​l​d​ ​r​e​p​l​y​ ​t​o​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​r​e​p​l​i​e​s​ ​w​i​l​l​ ​g​o​ ​t​o​ ​t​h​e​ ​s​e​n​d​e​r​ ​a​d​d​r​e​s​s​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​f​r​o​m​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​r​ ​a​l​p​h​a​n​u​m​e​r​i​c​ ​s​e​n​d​e​r​ ​I​D​.​ ​T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​. */ longDesc: string } - replyToName: { + dateSentAfter: { /** - * R​e​p​l​y​-​T​o​ ​N​a​m​e + * D​a​t​e​ ​S​e​n​t​ ​A​f​t​e​r */ displayName: string /** - * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s + * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​s​e​n​d​ ​d​a​t​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​t​o​ ​d​i​s​p​l​a​y​ ​f​o​r​ ​t​h​e​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - ccEmails: { + dateSentBefore: { /** - * C​C​ ​E​m​a​i​l​s + * D​a​t​e​ ​S​e​n​t​ ​B​e​f​o​r​e */ displayName: string /** - * C​a​r​b​o​n​ ​c​o​p​y​ ​r​e​c​i​p​i​e​n​t​s + * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​s​e​n​d​ ​d​a​t​e */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​ ​C​C​ ​r​e​c​i​p​i​e​n​t​s​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - bccEmails: { + limit: { /** - * B​C​C​ ​E​m​a​i​l​s + * L​i​m​i​t */ displayName: string /** - * B​l​i​n​d​ ​c​a​r​b​o​n​ ​c​o​p​y​ ​r​e​c​i​p​i​e​n​t​s + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​ ​B​C​C​ ​r​e​c​i​p​i​e​n​t​s​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - templateId: { + pageSize: { /** - * T​e​m​p​l​a​t​e​ ​I​D + * P​a​g​e​ ​S​i​z​e */ displayName: string /** - * T​h​e​ ​S​e​n​d​G​r​i​d​ ​t​e​m​p​l​a​t​e​ ​t​o​ ​u​s​e + * N​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​d​y​n​a​m​i​c​ ​t​e​m​p​l​a​t​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​i​s​ ​e​m​a​i​l​.​ ​T​h​e​ ​t​e​m​p​l​a​t​e​ ​m​u​s​t​ ​b​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - values: { + } + } + get_message: { + groups: { + /** + * M​e​s​s​a​g​i​n​g + */ + '0': string + } + /** + * G​e​t​ ​a​ ​M​e​s​s​a​g​e + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e + */ + shortDesc: string + /** + * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​u​s​i​n​g​ ​i​t​s​ ​u​n​i​q​u​e​ ​S​I​D​ ​(​S​t​r​i​n​g​ ​I​d​e​n​t​i​f​i​e​r​)​.​ ​T​h​i​s​ ​r​e​t​u​r​n​s​ ​a​l​l​ ​a​v​a​i​l​a​b​l​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​n​c​l​u​d​i​n​g​ ​s​t​a​t​u​s​,​ ​c​o​n​t​e​n​t​,​ ​p​r​i​c​i​n​g​,​ ​a​n​d​ ​t​i​m​e​s​t​a​m​p​s​. + */ + longDesc: string + options: { + messageSid: { /** - * T​e​m​p​l​a​t​e​ ​V​a​l​u​e​s + * M​e​s​s​a​g​e​ ​S​I​D */ displayName: string /** - * D​y​n​a​m​i​c​ ​d​a​t​a​ ​f​o​r​ ​t​e​m​p​l​a​t​e​ ​p​e​r​s​o​n​a​l​i​z​a​t​i​o​n + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * A​ ​J​S​O​N​ ​o​b​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​ ​f​o​r​ ​d​y​n​a​m​i​c​ ​t​e​m​p​l​a​t​e​ ​d​a​t​a​.​ ​T​h​e​s​e​ ​v​a​l​u​e​s​ ​w​i​l​l​ ​r​e​p​l​a​c​e​ ​t​h​e​ ​c​o​r​r​e​s​p​o​n​d​i​n​g​ ​p​l​a​c​e​h​o​l​d​e​r​s​ ​i​n​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​t​e​m​p​l​a​t​e​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​M​e​s​s​a​g​e​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​S​M​"​ ​o​r​ ​"​M​M​"​. */ longDesc: string } } } - } - } - Brevo: { - /** - * B​r​e​v​o - */ - displayName: string - groups: { - /** - * E​m​a​i​l​ ​&​ ​E​m​a​i​l​ ​M​a​r​k​e​t​i​n​g - */ - '0': string - } - /** - * B​r​e​v​o​ ​i​s​ ​a​ ​m​a​r​k​e​t​i​n​g​ ​p​l​a​t​f​o​r​m​ ​f​o​r​ ​e​m​a​i​l​,​ ​S​M​S​,​ ​a​n​d​ ​a​u​t​o​m​a​t​i​o​n​ ​c​a​m​p​a​i​g​n​s​. - */ - shortDesc: string - /** - * B​r​e​v​o​ ​(​f​o​r​m​e​r​l​y​ ​S​e​n​d​i​n​b​l​u​e​)​ ​i​s​ ​a​ ​m​a​r​k​e​t​i​n​g​ ​a​u​t​o​m​a​t​i​o​n​ ​p​l​a​t​f​o​r​m​ ​t​h​a​t​ ​e​n​a​b​l​e​s​ ​b​u​s​i​n​e​s​s​e​s​ ​t​o​ ​c​o​m​m​u​n​i​c​a​t​e​ ​w​i​t​h​ ​c​u​s​t​o​m​e​r​s​ ​t​h​r​o​u​g​h​ ​e​m​a​i​l​,​ ​S​M​S​,​ ​c​h​a​t​,​ ​a​n​d​ ​m​o​r​e​.​ ​I​t​ ​o​f​f​e​r​s​ ​t​o​o​l​s​ ​f​o​r​ ​c​a​m​p​a​i​g​n​ ​m​a​n​a​g​e​m​e​n​t​,​ ​c​o​n​t​a​c​t​ ​s​e​g​m​e​n​t​a​t​i​o​n​,​ ​t​r​a​n​s​a​c​t​i​o​n​a​l​ ​e​m​a​i​l​s​,​ ​a​n​d​ ​c​u​s​t​o​m​e​r​ ​r​e​l​a​t​i​o​n​s​h​i​p​ ​m​a​n​a​g​e​m​e​n​t​.​ ​B​r​e​v​o​ ​h​e​l​p​s​ ​b​u​s​i​n​e​s​s​e​s​ ​b​u​i​l​d​ ​s​t​r​o​n​g​e​r​ ​r​e​l​a​t​i​o​n​s​h​i​p​s​ ​w​i​t​h​ ​t​h​e​i​r​ ​a​u​d​i​e​n​c​e​ ​b​y​ ​p​r​o​v​i​d​i​n​g​ ​s​c​a​l​a​b​l​e​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​ ​a​n​d​ ​a​u​t​o​m​a​t​i​o​n​ ​s​o​l​u​t​i​o​n​s​. - */ - longDesc: string - connectionMessage: { - /** - * C​o​n​n​e​c​t​ ​t​o​ ​B​r​e​v​o - */ - title: string - /** - * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​P​I​ ​K​e​y​*​*​.​ - ​ - ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​A​P​I​ ​K​e​y​ - ​ - ​1​.​ ​S​i​g​n​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​B​r​e​v​o​ ​a​c​c​o​u​n​t​]​(​h​t​t​p​s​:​/​/​a​p​p​.​b​r​e​v​o​.​c​o​m​/​)​ - ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​*​*​S​e​t​t​i​n​g​s​*​*​ ​→​ ​*​*​S​M​T​P​ ​&​ ​A​P​I​*​*​ ​→​ ​*​*​A​P​I​ ​K​e​y​s​*​*​ - ​3​.​ ​C​l​i​c​k​ ​*​*​G​e​n​e​r​a​t​e​ ​a​ ​n​e​w​ ​A​P​I​ ​k​e​y​*​*​ - ​4​.​ ​G​i​v​e​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​a​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​(​e​.​g​.​,​ ​"​Q​o​r​e​ ​I​n​t​e​g​r​a​t​i​o​n​"​)​ - ​5​.​ ​C​o​p​y​ ​t​h​e​ ​g​e​n​e​r​a​t​e​d​ ​A​P​I​ ​k​e​y​ ​i​m​m​e​d​i​a​t​e​l​y​ ​(​i​t​ ​w​o​n​'​t​ ​b​e​ ​s​h​o​w​n​ ​a​g​a​i​n​)​ - ​ - ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​a​c​c​e​s​s​ ​t​h​e​ ​A​P​I​ ​k​e​y​s​ ​p​a​g​e​ ​d​i​r​e​c​t​l​y​ ​a​t​ ​[​a​p​p​.​b​r​e​v​o​.​c​o​m​/​s​e​t​t​i​n​g​s​/​k​e​y​s​/​a​p​i​]​(​h​t​t​p​s​:​/​/​a​p​p​.​b​r​e​v​o​.​c​o​m​/​s​e​t​t​i​n​g​s​/​k​e​y​s​/​a​p​i​)​ - ​ - ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ - ​ - ​#​#​#​ ​A​P​I​ ​K​e​y​ - ​Y​o​u​r​ ​B​r​e​v​o​ ​A​P​I​ ​k​e​y​ ​s​t​a​r​t​i​n​g​ ​w​i​t​h​ ​`​x​k​e​y​s​i​b​-​`​.​ ​T​h​i​s​ ​k​e​y​ ​a​u​t​h​e​n​t​i​c​a​t​e​s​ ​a​l​l​ ​A​P​I​ ​r​e​q​u​e​s​t​s​ ​t​o​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​.​ - ​ - ​*​*​N​o​t​e​:​*​*​ ​K​e​e​p​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​s​e​c​u​r​e​ ​a​n​d​ ​n​e​v​e​r​ ​s​h​a​r​e​ ​i​t​ ​p​u​b​l​i​c​l​y​.​ ​Y​o​u​ ​c​a​n​ ​r​e​v​o​k​e​ ​a​n​d​ ​r​e​g​e​n​e​r​a​t​e​ ​k​e​y​s​ ​a​t​ ​a​n​y​ ​t​i​m​e​ ​f​r​o​m​ ​t​h​e​ ​A​P​I​ ​K​e​y​s​ ​s​e​t​t​i​n​g​s​ ​p​a​g​e​. - */ - content: string - } - actions: { - get_contact: { + delete_message: { + groups: { + /** + * M​e​s​s​a​g​i​n​g + */ + '0': string + } /** - * G​e​t​ ​C​o​n​t​a​c​t + * D​e​l​e​t​e​ ​a​ ​M​e​s​s​a​g​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​c​o​n​t​a​c​t​ ​b​y​ ​i​d​e​n​t​i​f​i​e​r + * D​e​l​e​t​e​ ​a​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​.​ ​Y​o​u​ ​c​a​n​ ​i​d​e​n​t​i​f​y​ ​c​o​n​t​a​c​t​s​ ​u​s​i​n​g​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​c​o​n​t​a​c​t​ ​I​D​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​e​x​t​e​r​n​a​l​ ​I​D​,​ ​W​h​a​t​s​A​p​p​ ​I​D​,​ ​o​r​ ​l​a​n​d​l​i​n​e​ ​n​u​m​b​e​r​. + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​m​e​s​s​a​g​e​ ​r​e​c​o​r​d​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​N​o​t​e​ ​t​h​a​t​ ​d​e​l​e​t​i​n​g​ ​a​ ​m​e​s​s​a​g​e​ ​r​e​c​o​r​d​ ​d​o​e​s​ ​n​o​t​ ​r​e​d​a​c​t​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t​ ​f​r​o​m​ ​T​w​i​l​i​o​ ​l​o​g​s​. */ longDesc: string - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } options: { - identifier: { + messageSid: { /** - * C​o​n​t​a​c​t​ ​I​d​e​n​t​i​f​i​e​r + * M​e​s​s​a​g​e​ ​S​I​D */ displayName: string /** - * C​o​n​t​a​c​t​ ​i​d​e​n​t​i​f​i​e​r​ ​(​e​m​a​i​l​,​ ​I​D​,​ ​p​h​o​n​e​,​ ​e​t​c​.​) + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​.​ ​C​a​n​ ​b​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​c​o​n​t​a​c​t​ ​I​D​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​(​S​M​S​)​,​ ​e​x​t​e​r​n​a​l​ ​I​D​,​ ​W​h​a​t​s​A​p​p​ ​I​D​,​ ​o​r​ ​l​a​n​d​l​i​n​e​ ​n​u​m​b​e​r​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e​.​ ​M​e​s​s​a​g​e​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​S​M​"​ ​o​r​ ​"​M​M​"​. */ longDesc: string } } } - create_contact: { + list_message_media: { + groups: { + /** + * M​e​s​s​a​g​i​n​g + */ + '0': string + } /** - * C​r​e​a​t​e​ ​C​o​n​t​a​c​t + * L​i​s​t​ ​M​e​s​s​a​g​e​ ​M​e​d​i​a */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t + * R​e​t​r​i​e​v​e​ ​m​e​d​i​a​ ​a​t​t​a​c​h​e​d​ ​t​o​ ​a​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​n​ ​B​r​e​v​o​.​ ​C​o​n​t​a​c​t​s​ ​c​a​n​ ​b​e​ ​c​r​e​a​t​e​d​ ​w​i​t​h​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​(​w​i​t​h​ ​c​o​u​n​t​r​y​ ​c​o​d​e​)​,​ ​o​r​ ​e​x​t​e​r​n​a​l​ ​I​D​.​ ​C​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​l​i​s​t​ ​a​s​s​i​g​n​m​e​n​t​s​ ​c​a​n​ ​b​e​ ​i​n​c​l​u​d​e​d​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​m​e​d​i​a​ ​f​i​l​e​s​ ​a​t​t​a​c​h​e​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​.​ ​T​h​i​s​ ​i​s​ ​u​s​e​f​u​l​ ​f​o​r​ ​a​c​c​e​s​s​i​n​g​ ​M​M​S​ ​a​t​t​a​c​h​m​e​n​t​s​ ​o​r​ ​m​e​d​i​a​ ​s​e​n​t​ ​v​i​a​ ​W​h​a​t​s​A​p​p​ ​o​r​ ​o​t​h​e​r​ ​c​h​a​n​n​e​l​s​. */ longDesc: string - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } options: { - email: { + messageSid: { /** - * E​m​a​i​l​ ​A​d​d​r​e​s​s + * M​e​s​s​a​g​e​ ​S​I​D */ displayName: string /** - * C​o​n​t​a​c​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * P​r​i​m​a​r​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​.​ ​R​e​q​u​i​r​e​d​ ​f​o​r​ ​c​r​e​a​t​i​n​g​ ​a​ ​c​o​n​t​a​c​t​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​h​o​s​e​ ​m​e​d​i​a​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​M​e​s​s​a​g​e​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​S​M​"​ ​o​r​ ​"​M​M​"​. */ longDesc: string } - extId: { + limit: { /** - * E​x​t​e​r​n​a​l​ ​I​D + * L​i​m​i​t */ displayName: string /** - * E​x​t​e​r​n​a​l​ ​i​d​e​n​t​i​f​i​e​r + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​d​i​a​ ​i​t​e​m​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * C​u​s​t​o​m​ ​e​x​t​e​r​n​a​l​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​s​y​s​t​e​m​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​d​i​a​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - listIds: { + pageSize: { /** - * L​i​s​t​ ​I​D​s + * P​a​g​e​ ​S​i​z​e */ displayName: string /** - * L​i​s​t​s​ ​t​o​ ​a​d​d​ ​c​o​n​t​a​c​t​ ​t​o + * N​u​m​b​e​r​ ​o​f​ ​m​e​d​i​a​ ​i​t​e​m​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​a​d​d​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​u​p​o​n​ ​c​r​e​a​t​i​o​n​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​d​i​a​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - emailBlacklisted: { + } + } + create_call: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } + /** + * C​r​e​a​t​e​ ​a​ ​C​a​l​l + */ + displayName: string + /** + * I​n​i​t​i​a​t​e​ ​a​n​ ​o​u​t​b​o​u​n​d​ ​p​h​o​n​e​ ​c​a​l​l + */ + shortDesc: string + /** + * I​n​i​t​i​a​t​e​ ​a​n​ ​o​u​t​b​o​u​n​d​ ​p​h​o​n​e​ ​c​a​l​l​ ​u​s​i​n​g​ ​T​w​i​l​i​o​.​ ​Y​o​u​ ​c​a​n​ ​p​r​o​v​i​d​e​ ​T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​v​i​a​ ​U​R​L​ ​o​r​ ​d​i​r​e​c​t​l​y​,​ ​c​o​n​f​i​g​u​r​e​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​,​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n​,​ ​a​n​d​ ​s​e​t​ ​u​p​ ​s​t​a​t​u​s​ ​c​a​l​l​b​a​c​k​s​ ​t​o​ ​t​r​a​c​k​ ​c​a​l​l​ ​p​r​o​g​r​e​s​s​. + */ + longDesc: string + options: { + to: { /** - * E​m​a​i​l​ ​B​l​a​c​k​l​i​s​t​e​d + * T​o */ displayName: string /** - * B​l​a​c​k​l​i​s​t​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​e​m​a​i​l​s + * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​c​a​l​l */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​b​l​a​c​k​l​i​s​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​r​e​c​e​i​v​i​n​g​ ​e​m​a​i​l​ ​c​a​m​p​a​i​g​n​s​. + * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​S​I​P​ ​a​d​d​r​e​s​s​,​ ​o​r​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​ ​t​o​ ​c​a​l​l​.​ ​P​h​o​n​e​ ​n​u​m​b​e​r​s​ ​m​u​s​t​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​. */ longDesc: string } - smsBlacklisted: { + from: { /** - * S​M​S​ ​B​l​a​c​k​l​i​s​t​e​d + * F​r​o​m */ displayName: string /** - * B​l​a​c​k​l​i​s​t​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​S​M​S + * T​h​e​ ​c​a​l​l​e​r​ ​I​D​ ​t​o​ ​d​i​s​p​l​a​y */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​b​l​a​c​k​l​i​s​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​r​e​c​e​i​v​i​n​g​ ​S​M​S​ ​c​a​m​p​a​i​g​n​s​. + * T​h​e​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​r​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​ ​t​o​ ​u​s​e​ ​a​s​ ​t​h​e​ ​c​a​l​l​e​r​ ​I​D​.​ ​I​f​ ​c​a​l​l​i​n​g​ ​a​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​t​h​i​s​ ​m​u​s​t​ ​a​l​s​o​ ​b​e​ ​a​ ​p​h​o​n​e​ ​n​u​m​b​e​r​. */ longDesc: string } - attributes: { + url: { /** - * C​o​n​t​a​c​t​ ​A​t​t​r​i​b​u​t​e​s + * T​w​i​M​L​ ​U​R​L */ displayName: string /** - * C​u​s​t​o​m​ ​c​o​n​t​a​c​t​ ​a​t​t​r​i​b​u​t​e​s + * U​R​L​ ​t​h​a​t​ ​r​e​t​u​r​n​s​ ​T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s */ shortDesc: string /** - * C​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​c​o​m​p​a​n​y​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​d​e​f​i​n​e​d​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. + * T​h​e​ ​U​R​L​ ​t​h​a​t​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​f​e​t​c​h​ ​T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​f​r​o​m​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​c​o​n​n​e​c​t​s​.​ ​T​h​i​s​ ​U​R​L​ ​s​h​o​u​l​d​ ​r​e​t​u​r​n​ ​v​a​l​i​d​ ​T​w​i​M​L​ ​t​o​ ​c​o​n​t​r​o​l​ ​t​h​e​ ​c​a​l​l​ ​f​l​o​w​. */ longDesc: string } - } - } - update_contact: { - /** - * U​p​d​a​t​e​ ​C​o​n​t​a​c​t - */ - displayName: string - /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t - */ - shortDesc: string - /** - * U​p​d​a​t​e​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​a​t​t​r​i​b​u​t​e​s​,​ ​e​m​a​i​l​ ​p​r​e​f​e​r​e​n​c​e​s​,​ ​l​i​s​t​ ​m​e​m​b​e​r​s​h​i​p​s​,​ ​a​n​d​ ​c​u​s​t​o​m​ ​d​a​t​a​.​ ​C​o​n​t​a​c​t​ ​c​a​n​ ​b​e​ ​i​d​e​n​t​i​f​i​e​d​ ​b​y​ ​e​m​a​i​l​,​ ​I​D​,​ ​o​r​ ​o​t​h​e​r​ ​i​d​e​n​t​i​f​i​e​r​s​. - */ - longDesc: string - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } - options: { - identifier: { + twiml: { /** - * C​o​n​t​a​c​t​ ​I​d​e​n​t​i​f​i​e​r + * T​w​i​M​L */ displayName: string /** - * C​o​n​t​a​c​t​ ​t​o​ ​u​p​d​a​t​e + * T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​f​o​r​ ​t​h​e​ ​c​a​l​l */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​u​p​d​a​t​e​.​ ​C​a​n​ ​b​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​c​o​n​t​a​c​t​ ​I​D​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​e​x​t​e​r​n​a​l​ ​I​D​,​ ​W​h​a​t​s​A​p​p​ ​I​D​,​ ​o​r​ ​l​a​n​d​l​i​n​e​ ​n​u​m​b​e​r​. + * T​w​i​M​L​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​t​o​ ​e​x​e​c​u​t​e​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​c​o​n​n​e​c​t​s​.​ ​I​f​ ​b​o​t​h​ ​T​w​i​M​L​ ​a​n​d​ ​U​R​L​ ​a​r​e​ ​p​r​o​v​i​d​e​d​,​ ​T​w​i​M​L​ ​t​a​k​e​s​ ​p​r​e​c​e​d​e​n​c​e​.​ ​M​a​x​i​m​u​m​ ​4​0​0​0​ ​c​h​a​r​a​c​t​e​r​s​. */ longDesc: string } - email: { + method: { /** - * N​e​w​ ​E​m​a​i​l​ ​A​d​d​r​e​s​s + * H​T​T​P​ ​M​e​t​h​o​d */ displayName: string /** - * U​p​d​a​t​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * H​T​T​P​ ​m​e​t​h​o​d​ ​f​o​r​ ​f​e​t​c​h​i​n​g​ ​T​w​i​M​L */ shortDesc: string /** - * N​e​w​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​. + * T​h​e​ ​H​T​T​P​ ​m​e​t​h​o​d​ ​t​o​ ​u​s​e​ ​w​h​e​n​ ​r​e​q​u​e​s​t​i​n​g​ ​t​h​e​ ​U​R​L​.​ ​C​a​n​ ​b​e​ ​G​E​T​ ​o​r​ ​P​O​S​T​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​P​O​S​T​. */ longDesc: string } - extId: { + statusCallback: { /** - * E​x​t​e​r​n​a​l​ ​I​D + * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L */ displayName: string /** - * E​x​t​e​r​n​a​l​ ​i​d​e​n​t​i​f​i​e​r + * U​R​L​ ​t​o​ ​r​e​c​e​i​v​e​ ​c​a​l​l​ ​s​t​a​t​u​s​ ​u​p​d​a​t​e​s */ shortDesc: string /** - * C​u​s​t​o​m​ ​e​x​t​e​r​n​a​l​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​s​y​s​t​e​m​. + * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​.​ ​Y​o​u​ ​c​a​n​ ​s​p​e​c​i​f​y​ ​w​h​i​c​h​ ​e​v​e​n​t​s​ ​t​r​i​g​g​e​r​ ​c​a​l​l​b​a​c​k​s​ ​u​s​i​n​g​ ​S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​E​v​e​n​t​s​. */ longDesc: string } - listIds: { + statusCallbackEvent: { /** - * A​d​d​ ​t​o​ ​L​i​s​t​s + * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​E​v​e​n​t​s */ displayName: string /** - * L​i​s​t​s​ ​t​o​ ​a​d​d​ ​c​o​n​t​a​c​t​ ​t​o + * E​v​e​n​t​s​ ​t​h​a​t​ ​t​r​i​g​g​e​r​ ​s​t​a​t​u​s​ ​c​a​l​l​b​a​c​k​s */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​a​d​d​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​. + * T​h​e​ ​c​a​l​l​ ​p​r​o​g​r​e​s​s​ ​e​v​e​n​t​s​ ​t​h​a​t​ ​w​i​l​l​ ​t​r​i​g​g​e​r​ ​a​ ​P​O​S​T​ ​t​o​ ​t​h​e​ ​S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L​.​ ​O​p​t​i​o​n​s​ ​i​n​c​l​u​d​e​:​ ​i​n​i​t​i​a​t​e​d​,​ ​r​i​n​g​i​n​g​,​ ​a​n​s​w​e​r​e​d​,​ ​a​n​d​ ​c​o​m​p​l​e​t​e​d​. */ longDesc: string } - unlinkListIds: { + statusCallbackMethod: { /** - * R​e​m​o​v​e​ ​f​r​o​m​ ​L​i​s​t​s + * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​M​e​t​h​o​d */ displayName: string /** - * L​i​s​t​s​ ​t​o​ ​r​e​m​o​v​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m + * H​T​T​P​ ​m​e​t​h​o​d​ ​f​o​r​ ​s​t​a​t​u​s​ ​c​a​l​l​b​a​c​k​s */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​r​e​m​o​v​e​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​. + * T​h​e​ ​H​T​T​P​ ​m​e​t​h​o​d​ ​t​o​ ​u​s​e​ ​w​h​e​n​ ​P​O​S​T​i​n​g​ ​t​o​ ​t​h​e​ ​S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L​.​ ​C​a​n​ ​b​e​ ​G​E​T​ ​o​r​ ​P​O​S​T​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​P​O​S​T​. */ longDesc: string } - emailBlacklisted: { + timeout: { /** - * E​m​a​i​l​ ​B​l​a​c​k​l​i​s​t​e​d + * T​i​m​e​o​u​t */ displayName: string /** - * E​m​a​i​l​ ​b​l​a​c​k​l​i​s​t​ ​s​t​a​t​u​s + * S​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​a​n​s​w​e​r */ shortDesc: string /** - * S​e​t​ ​e​m​a​i​l​ ​b​l​a​c​k​l​i​s​t​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​b​e​ ​a​n​s​w​e​r​e​d​ ​b​e​f​o​r​e​ ​t​i​m​i​n​g​ ​o​u​t​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​6​0​ ​s​e​c​o​n​d​s​,​ ​m​a​x​i​m​u​m​ ​i​s​ ​6​0​0​ ​s​e​c​o​n​d​s​. */ longDesc: string } - smsBlacklisted: { + record: { /** - * S​M​S​ ​B​l​a​c​k​l​i​s​t​e​d + * R​e​c​o​r​d */ displayName: string /** - * S​M​S​ ​b​l​a​c​k​l​i​s​t​ ​s​t​a​t​u​s + * W​h​e​t​h​e​r​ ​t​o​ ​r​e​c​o​r​d​ ​t​h​e​ ​c​a​l​l */ shortDesc: string /** - * S​e​t​ ​S​M​S​ ​b​l​a​c​k​l​i​s​t​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​. + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​r​e​c​o​r​d​ ​t​h​e​ ​e​n​t​i​r​e​ ​c​a​l​l​.​ ​T​h​e​ ​r​e​c​o​r​d​i​n​g​ ​w​i​l​l​ ​b​e​ ​a​v​a​i​l​a​b​l​e​ ​a​f​t​e​r​ ​t​h​e​ ​c​a​l​l​ ​c​o​m​p​l​e​t​e​s​. */ longDesc: string } - attributes: { + recordingChannels: { /** - * C​o​n​t​a​c​t​ ​A​t​t​r​i​b​u​t​e​s + * R​e​c​o​r​d​i​n​g​ ​C​h​a​n​n​e​l​s */ displayName: string /** - * U​p​d​a​t​e​ ​c​o​n​t​a​c​t​ ​a​t​t​r​i​b​u​t​e​s + * N​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​i​n​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g */ shortDesc: string /** - * U​p​d​a​t​e​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​c​o​m​p​a​n​y​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​i​n​ ​t​h​e​ ​f​i​n​a​l​ ​r​e​c​o​r​d​i​n​g​.​ ​"​m​o​n​o​"​ ​r​e​c​o​r​d​s​ ​b​o​t​h​ ​l​e​g​s​ ​i​n​ ​a​ ​s​i​n​g​l​e​ ​c​h​a​n​n​e​l​,​ ​"​d​u​a​l​"​ ​r​e​c​o​r​d​s​ ​e​a​c​h​ ​l​e​g​ ​s​e​p​a​r​a​t​e​l​y​. */ longDesc: string } - } - } - list_contacts: { - /** - * L​i​s​t​ ​C​o​n​t​a​c​t​s - */ - displayName: string - /** - * G​e​t​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​w​i​t​h​ ​p​a​g​i​n​a​t​i​o​n​,​ ​s​o​r​t​i​n​g​,​ ​a​n​d​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​.​ ​F​i​l​t​e​r​ ​b​y​ ​l​i​s​t​s​,​ ​a​t​t​r​i​b​u​t​e​s​,​ ​o​r​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​. - */ - longDesc: string - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } - options: { - limit: { + recordingStatusCallback: { /** - * R​e​s​u​l​t​s​ ​L​i​m​i​t + * R​e​c​o​r​d​i​n​g​ ​S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​p​e​r​ ​p​a​g​e + * U​R​L​ ​t​o​ ​n​o​t​i​f​y​ ​w​h​e​n​ ​r​e​c​o​r​d​i​n​g​ ​i​s​ ​a​v​a​i​l​a​b​l​e */ shortDesc: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​,​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​. + * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​w​h​e​n​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​ ​i​s​ ​a​v​a​i​l​a​b​l​e​.​ ​T​h​i​s​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​p​r​o​c​e​s​s​ ​o​r​ ​s​t​o​r​e​ ​r​e​c​o​r​d​i​n​g​s​ ​i​m​m​e​d​i​a​t​e​l​y​. */ longDesc: string } - offset: { + machineDetection: { /** - * P​a​g​e​ ​O​f​f​s​e​t + * M​a​c​h​i​n​e​ ​D​e​t​e​c​t​i​o​n */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​s​k​i​p + * E​n​a​b​l​e​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n */ shortDesc: string /** - * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​ ​w​i​t​h​ ​l​i​m​i​t​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​. + * E​n​a​b​l​e​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n​.​ ​"​E​n​a​b​l​e​"​ ​r​e​t​u​r​n​s​ ​A​n​s​w​e​r​e​d​B​y​ ​i​m​m​e​d​i​a​t​e​l​y​,​ ​"​D​e​t​e​c​t​M​e​s​s​a​g​e​E​n​d​"​ ​w​a​i​t​s​ ​f​o​r​ ​t​h​e​ ​b​e​e​p​ ​t​o​ ​l​e​a​v​e​ ​a​ ​m​e​s​s​a​g​e​. */ longDesc: string } - sort: { + machineDetectionTimeout: { /** - * S​o​r​t​ ​O​r​d​e​r + * M​a​c​h​i​n​e​ ​D​e​t​e​c​t​i​o​n​ ​T​i​m​e​o​u​t */ displayName: string /** - * C​o​n​t​a​c​t​ ​s​o​r​t​ ​o​r​d​e​r + * S​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​d​e​t​e​c​t​i​o​n */ shortDesc: string /** - * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​t​o​ ​a​t​t​e​m​p​t​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n​ ​b​e​f​o​r​e​ ​t​i​m​i​n​g​ ​o​u​t​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​3​0​ ​s​e​c​o​n​d​s​. */ longDesc: string } - listIds: { + sendDigits: { /** - * F​i​l​t​e​r​ ​b​y​ ​L​i​s​t​s + * S​e​n​d​ ​D​i​g​i​t​s */ displayName: string /** - * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​l​i​s​t​ ​m​e​m​b​e​r​s​h​i​p + * D​T​M​F​ ​t​o​n​e​s​ ​t​o​ ​s​e​n​d​ ​a​f​t​e​r​ ​c​o​n​n​e​c​t​i​o​n */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​.​ ​O​n​l​y​ ​c​o​n​t​a​c​t​s​ ​b​e​l​o​n​g​i​n​g​ ​t​o​ ​t​h​e​s​e​ ​l​i​s​t​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. + * A​ ​s​t​r​i​n​g​ ​o​f​ ​k​e​y​s​ ​t​o​ ​d​i​a​l​ ​a​f​t​e​r​ ​c​o​n​n​e​c​t​i​n​g​.​ ​V​a​l​i​d​ ​c​h​a​r​a​c​t​e​r​s​:​ ​0​-​9​,​ ​A​-​D​,​ ​#​,​ ​*​,​ ​w​ ​(​0​.​5​s​ ​p​a​u​s​e​)​,​ ​W​ ​(​1​s​ ​p​a​u​s​e​)​.​ ​F​o​r​ ​e​x​a​m​p​l​e​:​ ​"​W​1​2​3​4​#​"​. */ longDesc: string } - filter: { + timeLimit: { /** - * A​t​t​r​i​b​u​t​e​ ​F​i​l​t​e​r + * T​i​m​e​ ​L​i​m​i​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​o​n​t​a​c​t​ ​a​t​t​r​i​b​u​t​e​s + * M​a​x​i​m​u​m​ ​c​a​l​l​ ​d​u​r​a​t​i​o​n​ ​i​n​ ​s​e​c​o​n​d​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​a​s​e​d​ ​o​n​ ​s​p​e​c​i​f​i​c​ ​a​t​t​r​i​b​u​t​e​ ​v​a​l​u​e​s​ ​u​s​i​n​g​ ​e​q​u​a​l​s​ ​o​p​e​r​a​t​o​r​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​d​u​r​a​t​i​o​n​ ​o​f​ ​t​h​e​ ​c​a​l​l​ ​i​n​ ​s​e​c​o​n​d​s​.​ ​T​h​e​ ​c​a​l​l​ ​w​i​l​l​ ​b​e​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​e​n​d​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​t​i​m​e​. */ longDesc: string - type: { - fields: { - field: { - /** - * A​t​t​r​i​b​u​t​e​ ​F​i​e​l​d - */ - displayName: string - /** - * A​t​t​r​i​b​u​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y - */ - shortDesc: string - /** - * C​o​n​t​a​c​t​ ​a​t​t​r​i​b​u​t​e​ ​f​i​e​l​d​ ​n​a​m​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y​. - */ - longDesc: string - } - value: { - /** - * F​i​l​t​e​r​ ​V​a​l​u​e - */ - displayName: string - /** - * V​a​l​u​e​ ​t​o​ ​m​a​t​c​h - */ - shortDesc: string - /** - * V​a​l​u​e​ ​t​h​a​t​ ​t​h​e​ ​a​t​t​r​i​b​u​t​e​ ​m​u​s​t​ ​e​q​u​a​l​. - */ - longDesc: string - } - } - } } } } - get_list: { - /** - * G​e​t​ ​L​i​s​t - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​l​i​s​t​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​i​n​c​l​u​d​i​n​g​ ​s​u​b​s​c​r​i​b​e​r​ ​c​o​u​n​t​s​,​ ​c​a​m​p​a​i​g​n​ ​s​t​a​t​i​s​t​i​c​s​,​ ​a​n​d​ ​f​o​l​d​e​r​ ​i​n​f​o​r​m​a​t​i​o​n​. - */ - longDesc: string + create_call_with_tts: { groups: { /** - * L​i​s​t​s + * V​o​i​c​e */ '0': string } - options: { - listId: { - /** - * L​i​s​t​ ​I​D - */ - displayName: string - /** - * L​i​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e - */ - shortDesc: string - /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. - */ - longDesc: string - } - } - } - create_list: { /** - * C​r​e​a​t​e​ ​L​i​s​t + * C​r​e​a​t​e​ ​C​a​l​l​ ​w​i​t​h​ ​T​e​x​t​-​t​o​-​S​p​e​e​c​h */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t + * M​a​k​e​ ​a​ ​c​a​l​l​ ​w​i​t​h​ ​a​u​t​o​m​a​t​e​d​ ​v​o​i​c​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​f​o​l​d​e​r​.​ ​L​i​s​t​s​ ​a​r​e​ ​u​s​e​d​ ​t​o​ ​o​r​g​a​n​i​z​e​ ​a​n​d​ ​s​e​g​m​e​n​t​ ​y​o​u​r​ ​c​o​n​t​a​c​t​s​ ​f​o​r​ ​t​a​r​g​e​t​e​d​ ​c​a​m​p​a​i​g​n​s​. + * I​n​i​t​i​a​t​e​ ​a​n​ ​o​u​t​b​o​u​n​d​ ​p​h​o​n​e​ ​c​a​l​l​ ​w​i​t​h​ ​a​n​ ​a​u​t​o​m​a​t​e​d​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h​ ​m​e​s​s​a​g​e​.​ ​T​h​i​s​ ​s​i​m​p​l​i​f​i​e​d​ ​a​c​t​i​o​n​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​g​e​n​e​r​a​t​e​s​ ​T​w​i​M​L​ ​b​a​s​e​d​ ​o​n​ ​y​o​u​r​ ​i​n​p​u​t​s​,​ ​a​l​l​o​w​i​n​g​ ​y​o​u​ ​t​o​ ​q​u​i​c​k​l​y​ ​c​r​e​a​t​e​ ​c​a​l​l​s​ ​w​i​t​h​ ​v​o​i​c​e​ ​m​e​s​s​a​g​e​s​ ​w​i​t​h​o​u​t​ ​w​r​i​t​i​n​g​ ​T​w​i​M​L​ ​c​o​d​e​ ​m​a​n​u​a​l​l​y​.​ ​Y​o​u​ ​c​a​n​ ​c​u​s​t​o​m​i​z​e​ ​t​h​e​ ​v​o​i​c​e​,​ ​l​a​n​g​u​a​g​e​,​ ​r​e​c​o​r​d​ ​t​h​e​ ​c​a​l​l​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​l​y​ ​t​r​a​n​s​c​r​i​b​e​ ​r​e​c​o​r​d​i​n​g​s​. */ longDesc: string - groups: { - /** - * L​i​s​t​s - */ - '0': string - } options: { - name: { + to: { /** - * L​i​s​t​ ​N​a​m​e + * T​o */ displayName: string /** - * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​l​i​s​t + * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​c​a​l​l */ shortDesc: string /** - * D​i​s​p​l​a​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​. + * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​c​a​l​l​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​c​a​l​l​ ​S​I​P​ ​a​d​d​r​e​s​s​e​s​ ​o​r​ ​T​w​i​l​i​o​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​s​. */ longDesc: string } - folderId: { + from: { /** - * F​o​l​d​e​r + * F​r​o​m */ displayName: string /** - * F​o​l​d​e​r​ ​t​o​ ​c​r​e​a​t​e​ ​l​i​s​t​ ​i​n + * Y​o​u​r​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * F​o​l​d​e​r​ ​w​h​e​r​e​ ​t​h​e​ ​l​i​s​t​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​.​ ​R​e​q​u​i​r​e​d​ ​f​o​r​ ​l​i​s​t​ ​o​r​g​a​n​i​z​a​t​i​o​n​. + * T​h​e​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​u​s​e​ ​a​s​ ​t​h​e​ ​c​a​l​l​e​r​ ​I​D​.​ ​T​h​i​s​ ​m​u​s​t​ ​b​e​ ​a​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​y​o​u​ ​o​w​n​ ​i​n​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​. */ longDesc: string } - } - } - update_list: { - /** - * U​p​d​a​t​e​ ​L​i​s​t - */ - displayName: string - /** - * U​p​d​a​t​e​ ​l​i​s​t​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * U​p​d​a​t​e​ ​t​h​e​ ​n​a​m​e​ ​o​r​ ​f​o​l​d​e​r​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​ ​l​i​s​t​. - */ - longDesc: string - groups: { - /** - * L​i​s​t​s - */ - '0': string - } - options: { - listId: { + message: { /** - * L​i​s​t​ ​I​D + * M​e​s​s​a​g​e */ displayName: string /** - * L​i​s​t​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​s​p​e​a​k */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​t​o​ ​u​p​d​a​t​e​. + * T​h​e​ ​t​e​x​t​ ​m​e​s​s​a​g​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​p​o​k​e​n​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​i​s​ ​a​n​s​w​e​r​e​d​.​ ​T​h​i​s​ ​w​i​l​l​ ​b​e​ ​c​o​n​v​e​r​t​e​d​ ​t​o​ ​s​p​e​e​c​h​ ​u​s​i​n​g​ ​T​w​i​l​i​o​'​s​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h​ ​e​n​g​i​n​e​. */ longDesc: string } - name: { + voice: { /** - * N​e​w​ ​N​a​m​e + * V​o​i​c​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​l​i​s​t​ ​n​a​m​e + * T​h​e​ ​v​o​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h */ shortDesc: string /** - * N​e​w​ ​d​i​s​p​l​a​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​. + * T​h​e​ ​v​o​i​c​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h​.​ ​C​h​o​o​s​e​ ​f​r​o​m​ ​v​a​r​i​o​u​s​ ​v​o​i​c​e​s​ ​w​i​t​h​ ​d​i​f​f​e​r​e​n​t​ ​l​a​n​g​u​a​g​e​s​,​ ​g​e​n​d​e​r​s​,​ ​a​n​d​ ​q​u​a​l​i​t​y​ ​l​e​v​e​l​s​ ​(​S​t​a​n​d​a​r​d​,​ ​N​e​u​r​a​l​,​ ​G​e​n​e​r​a​t​i​v​e​)​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​u​s​e​s​ ​y​o​u​r​ ​a​c​c​o​u​n​t​'​s​ ​d​e​f​a​u​l​t​ ​v​o​i​c​e​. */ longDesc: string } - folderId: { + language: { /** - * N​e​w​ ​F​o​l​d​e​r + * L​a​n​g​u​a​g​e */ displayName: string /** - * M​o​v​e​ ​t​o​ ​d​i​f​f​e​r​e​n​t​ ​f​o​l​d​e​r + * T​h​e​ ​l​a​n​g​u​a​g​e​ ​f​o​r​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h */ shortDesc: string /** - * N​e​w​ ​f​o​l​d​e​r​ ​I​D​ ​t​o​ ​m​o​v​e​ ​t​h​e​ ​l​i​s​t​ ​t​o​. + * T​h​e​ ​l​a​n​g​u​a​g​e​ ​a​n​d​ ​l​o​c​a​l​e​ ​f​o​r​ ​t​e​x​t​-​t​o​-​s​p​e​e​c​h​.​ ​T​h​i​s​ ​s​h​o​u​l​d​ ​m​a​t​c​h​ ​t​h​e​ ​l​a​n​g​u​a​g​e​ ​o​f​ ​y​o​u​r​ ​m​e​s​s​a​g​e​ ​t​e​x​t​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​d​e​f​a​u​l​t​s​ ​t​o​ ​e​n​-​U​S​ ​(​E​n​g​l​i​s​h​,​ ​U​n​i​t​e​d​ ​S​t​a​t​e​s​)​. */ longDesc: string } - } - } - delete_list: { - /** - * D​e​l​e​t​e​ ​L​i​s​t - */ - displayName: string - /** - * D​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t - */ - shortDesc: string - /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​C​o​n​t​a​c​t​s​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​w​i​l​l​ ​r​e​m​a​i​n​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. - */ - longDesc: string - groups: { - /** - * L​i​s​t​s - */ - '0': string - } - options: { - listId: { + record: { /** - * L​i​s​t​ ​I​D + * R​e​c​o​r​d​ ​C​a​l​l */ displayName: string /** - * L​i​s​t​ ​t​o​ ​d​e​l​e​t​e + * W​h​e​t​h​e​r​ ​t​o​ ​r​e​c​o​r​d​ ​t​h​e​ ​c​a​l​l */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​t​o​ ​d​e​l​e​t​e​ ​p​e​r​m​a​n​e​n​t​l​y​. + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​r​e​c​o​r​d​ ​t​h​e​ ​e​n​t​i​r​e​ ​c​a​l​l​.​ ​T​h​e​ ​r​e​c​o​r​d​i​n​g​ ​w​i​l​l​ ​b​e​ ​a​v​a​i​l​a​b​l​e​ ​a​f​t​e​r​ ​t​h​e​ ​c​a​l​l​ ​c​o​m​p​l​e​t​e​s​ ​a​n​d​ ​c​a​n​ ​b​e​ ​r​e​t​r​i​e​v​e​d​ ​u​s​i​n​g​ ​t​h​e​ ​L​i​s​t​ ​R​e​c​o​r​d​i​n​g​s​ ​a​c​t​i​o​n​. */ longDesc: string } - } - } - list_lists: { - /** - * L​i​s​t​ ​A​l​l​ ​L​i​s​t​s - */ - displayName: string - /** - * G​e​t​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​w​i​t​h​ ​p​a​g​i​n​a​t​i​o​n​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​.​ ​I​n​c​l​u​d​e​s​ ​s​u​b​s​c​r​i​b​e​r​ ​c​o​u​n​t​s​ ​a​n​d​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​s​. - */ - longDesc: string - groups: { - /** - * L​i​s​t​s - */ - '0': string - } - options: { - limit: { + transcribe: { /** - * R​e​s​u​l​t​s​ ​L​i​m​i​t + * T​r​a​n​s​c​r​i​b​e​ ​R​e​c​o​r​d​i​n​g */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​p​e​r​ ​p​a​g​e + * W​h​e​t​h​e​r​ ​t​o​ ​t​r​a​n​s​c​r​i​b​e​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g */ shortDesc: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​t​r​a​n​s​c​r​i​b​e​ ​t​h​e​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​.​ ​T​h​i​s​ ​r​e​q​u​i​r​e​s​ ​t​h​e​ ​R​e​c​o​r​d​ ​C​a​l​l​ ​o​p​t​i​o​n​ ​t​o​ ​b​e​ ​e​n​a​b​l​e​d​.​ ​T​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​w​i​l​l​ ​b​e​ ​a​v​a​i​l​a​b​l​e​ ​a​f​t​e​r​ ​p​r​o​c​e​s​s​i​n​g​. */ longDesc: string } - offset: { + transcriptionCallback: { /** - * P​a​g​e​ ​O​f​f​s​e​t + * T​r​a​n​s​c​r​i​p​t​i​o​n​ ​C​a​l​l​b​a​c​k​ ​U​R​L */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​s​k​i​p + * U​R​L​ ​t​o​ ​r​e​c​e​i​v​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * N​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​. + * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​w​h​e​n​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​i​s​ ​c​o​m​p​l​e​t​e​.​ ​T​h​i​s​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​p​r​o​c​e​s​s​ ​o​r​ ​s​t​o​r​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​i​m​m​e​d​i​a​t​e​l​y​ ​a​f​t​e​r​ ​t​h​e​y​ ​a​r​e​ ​a​v​a​i​l​a​b​l​e​. */ longDesc: string } - sort: { + sendDigits: { /** - * S​o​r​t​ ​O​r​d​e​r + * S​e​n​d​ ​D​i​g​i​t​s */ displayName: string /** - * L​i​s​t​ ​s​o​r​t​ ​o​r​d​e​r + * D​T​M​F​ ​t​o​n​e​s​ ​t​o​ ​s​e​n​d​ ​a​f​t​e​r​ ​c​o​n​n​e​c​t​i​o​n */ shortDesc: string /** - * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​l​i​s​t​s​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. + * A​ ​s​t​r​i​n​g​ ​o​f​ ​k​e​y​s​ ​t​o​ ​d​i​a​l​ ​a​f​t​e​r​ ​t​h​e​ ​c​a​l​l​ ​c​o​n​n​e​c​t​s​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​n​a​v​i​g​a​t​i​n​g​ ​p​h​o​n​e​ ​m​e​n​u​s​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​.​ ​V​a​l​i​d​ ​c​h​a​r​a​c​t​e​r​s​:​ ​0​-​9​,​ ​#​,​ ​*​,​ ​w​ ​(​w​a​i​t​ ​0​.​5​ ​s​e​c​o​n​d​s​)​.​ ​F​o​r​ ​e​x​a​m​p​l​e​:​ ​"​w​1​2​3​#​"​ ​w​a​i​t​s​ ​0​.​5​ ​s​e​c​o​n​d​s​ ​t​h​e​n​ ​d​i​a​l​s​ ​1​2​3​#​. */ longDesc: string } - } - } - list_folders: { - /** - * L​i​s​t​ ​F​o​l​d​e​r​s - */ - displayName: string - /** - * G​e​t​ ​a​l​l​ ​l​i​s​t​ ​f​o​l​d​e​r​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​f​o​l​d​e​r​s​ ​u​s​e​d​ ​t​o​ ​o​r​g​a​n​i​z​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​w​i​t​h​ ​s​u​b​s​c​r​i​b​e​r​ ​c​o​u​n​t​s​ ​a​n​d​ ​c​r​e​a​t​i​o​n​ ​i​n​f​o​r​m​a​t​i​o​n​. - */ - longDesc: string - groups: { - /** - * L​i​s​t​s - */ - '0': string - } - options: { - limit: { + statusCallback: { /** - * R​e​s​u​l​t​s​ ​L​i​m​i​t + * S​t​a​t​u​s​ ​C​a​l​l​b​a​c​k​ ​U​R​L */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​p​e​r​ ​p​a​g​e + * U​R​L​ ​t​o​ ​r​e​c​e​i​v​e​ ​c​a​l​l​ ​s​t​a​t​u​s​ ​u​p​d​a​t​e​s */ shortDesc: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. + * T​h​e​ ​U​R​L​ ​T​w​i​l​i​o​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​w​h​e​n​ ​t​h​e​ ​c​a​l​l​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​t​r​a​c​k​ ​c​a​l​l​ ​p​r​o​g​r​e​s​s​ ​a​n​d​ ​c​o​m​p​l​e​t​i​o​n​. */ longDesc: string } - offset: { + timeout: { /** - * P​a​g​e​ ​O​f​f​s​e​t + * T​i​m​e​o​u​t */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​t​o​ ​s​k​i​p + * S​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​a​n​s​w​e​r */ shortDesc: string /** - * N​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​t​o​ ​w​a​i​t​ ​f​o​r​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​b​e​ ​a​n​s​w​e​r​e​d​ ​b​e​f​o​r​e​ ​t​i​m​i​n​g​ ​o​u​t​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​6​0​ ​s​e​c​o​n​d​s​,​ ​m​a​x​i​m​u​m​ ​i​s​ ​6​0​0​ ​s​e​c​o​n​d​s​. */ longDesc: string } - sort: { + machineDetection: { /** - * S​o​r​t​ ​O​r​d​e​r + * M​a​c​h​i​n​e​ ​D​e​t​e​c​t​i​o​n */ displayName: string /** - * F​o​l​d​e​r​ ​s​o​r​t​ ​o​r​d​e​r + * E​n​a​b​l​e​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n */ shortDesc: string /** - * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​f​o​l​d​e​r​s​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. + * E​n​a​b​l​e​ ​a​n​s​w​e​r​i​n​g​ ​m​a​c​h​i​n​e​ ​d​e​t​e​c​t​i​o​n​ ​t​o​ ​d​e​t​e​r​m​i​n​e​ ​i​f​ ​a​ ​h​u​m​a​n​ ​o​r​ ​m​a​c​h​i​n​e​ ​a​n​s​w​e​r​e​d​ ​t​h​e​ ​c​a​l​l​.​ ​"​E​n​a​b​l​e​"​ ​r​e​t​u​r​n​s​ ​t​h​e​ ​r​e​s​u​l​t​ ​i​m​m​e​d​i​a​t​e​l​y​,​ ​"​D​e​t​e​c​t​M​e​s​s​a​g​e​E​n​d​"​ ​w​a​i​t​s​ ​f​o​r​ ​t​h​e​ ​v​o​i​c​e​m​a​i​l​ ​b​e​e​p​ ​b​e​f​o​r​e​ ​p​l​a​y​i​n​g​ ​y​o​u​r​ ​m​e​s​s​a​g​e​. */ longDesc: string } } } - add_contacts_to_list: { + list_calls: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } /** - * A​d​d​ ​C​o​n​t​a​c​t​s​ ​t​o​ ​L​i​s​t + * L​i​s​t​ ​C​a​l​l​s */ displayName: string /** - * A​d​d​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​ ​l​i​s​t + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​l​l​s */ shortDesc: string /** - * A​d​d​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​b​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​o​r​ ​c​o​n​t​a​c​t​ ​I​D​s​.​ ​C​o​n​t​a​c​t​s​ ​m​u​s​t​ ​a​l​r​e​a​d​y​ ​e​x​i​s​t​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​l​l​s​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​c​a​l​l​s​ ​b​y​ ​p​a​r​t​i​c​i​p​a​n​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r​s​,​ ​s​t​a​t​u​s​,​ ​d​a​t​e​ ​r​a​n​g​e​,​ ​a​n​d​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​.​ ​R​e​s​u​l​t​s​ ​a​r​e​ ​r​e​t​u​r​n​e​d​ ​i​n​ ​r​e​v​e​r​s​e​ ​c​h​r​o​n​o​l​o​g​i​c​a​l​ ​o​r​d​e​r​. */ longDesc: string - groups: { - /** - * L​i​s​t​s - */ - '0': string - } options: { - listId: { + to: { /** - * L​i​s​t​ ​I​D + * T​o */ displayName: string /** - * T​a​r​g​e​t​ ​l​i​s​t + * F​i​l​t​e​r​ ​b​y​ ​r​e​c​i​p​i​e​n​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​t​o​ ​a​d​d​ ​c​o​n​t​a​c​t​s​ ​t​o​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​m​a​d​e​ ​t​o​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​S​I​P​ ​a​d​d​r​e​s​s​,​ ​o​r​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​. */ longDesc: string } - emails: { + from: { /** - * E​m​a​i​l​ ​A​d​d​r​e​s​s​e​s + * F​r​o​m */ displayName: string /** - * C​o​n​t​a​c​t​ ​e​m​a​i​l​s​ ​t​o​ ​a​d​d + * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​l​i​s​t​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​f​r​o​m​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​S​I​P​ ​a​d​d​r​e​s​s​,​ ​o​r​ ​c​l​i​e​n​t​ ​i​d​e​n​t​i​f​i​e​r​. */ longDesc: string } - ids: { + status: { /** - * C​o​n​t​a​c​t​ ​I​D​s + * S​t​a​t​u​s */ displayName: string /** - * C​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​d​d + * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​ ​s​t​a​t​u​s */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​l​i​s​t​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​w​i​t​h​ ​t​h​i​s​ ​s​t​a​t​u​s​.​ ​O​p​t​i​o​n​s​ ​i​n​c​l​u​d​e​:​ ​q​u​e​u​e​d​,​ ​r​i​n​g​i​n​g​,​ ​i​n​-​p​r​o​g​r​e​s​s​,​ ​c​a​n​c​e​l​e​d​,​ ​c​o​m​p​l​e​t​e​d​,​ ​f​a​i​l​e​d​,​ ​b​u​s​y​,​ ​o​r​ ​n​o​-​a​n​s​w​e​r​. */ longDesc: string } - } - } - remove_contacts_from_list: { - /** - * R​e​m​o​v​e​ ​C​o​n​t​a​c​t​s​ ​f​r​o​m​ ​L​i​s​t - */ - displayName: string - /** - * R​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​a​ ​l​i​s​t - */ - shortDesc: string - /** - * R​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​b​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​,​ ​c​o​n​t​a​c​t​ ​I​D​s​,​ ​o​r​ ​r​e​m​o​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. - */ - longDesc: string - groups: { - /** - * L​i​s​t​s - */ - '0': string - } - options: { - listId: { + startTimeAfter: { /** - * L​i​s​t​ ​I​D + * S​t​a​r​t​ ​T​i​m​e​ ​A​f​t​e​r */ displayName: string /** - * S​o​u​r​c​e​ ​l​i​s​t + * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​s​t​a​r​t​ ​t​i​m​e */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​t​o​ ​r​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​t​h​a​t​ ​s​t​a​r​t​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - emails: { + startTimeBefore: { /** - * E​m​a​i​l​ ​A​d​d​r​e​s​s​e​s + * S​t​a​r​t​ ​T​i​m​e​ ​B​e​f​o​r​e */ displayName: string /** - * C​o​n​t​a​c​t​ ​e​m​a​i​l​s​ ​t​o​ ​r​e​m​o​v​e + * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​s​t​a​r​t​ ​t​i​m​e */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​t​h​a​t​ ​s​t​a​r​t​e​d​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - ids: { + endTimeAfter: { /** - * C​o​n​t​a​c​t​ ​I​D​s + * E​n​d​ ​T​i​m​e​ ​A​f​t​e​r */ displayName: string /** - * C​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​r​e​m​o​v​e + * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​e​n​d​ ​t​i​m​e */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​t​h​a​t​ ​e​n​d​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - all: { + endTimeBefore: { /** - * R​e​m​o​v​e​ ​A​l​l + * E​n​d​ ​T​i​m​e​ ​B​e​f​o​r​e */ displayName: string /** - * R​e​m​o​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s + * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​e​n​d​ ​t​i​m​e */ shortDesc: string /** - * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​r​e​m​o​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​c​a​l​l​s​ ​t​h​a​t​ ​e​n​d​e​d​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. + */ + longDesc: string + } + limit: { + /** + * L​i​m​i​t + */ + displayName: string + /** + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​l​l​s​ ​t​o​ ​r​e​t​u​r​n + */ + shortDesc: string + /** + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​l​l​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. + */ + longDesc: string + } + pageSize: { + /** + * P​a​g​e​ ​S​i​z​e + */ + displayName: string + /** + * N​u​m​b​e​r​ ​o​f​ ​c​a​l​l​s​ ​p​e​r​ ​p​a​g​e + */ + shortDesc: string + /** + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​a​l​l​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } } } - get_company: { + get_call: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } /** - * G​e​t​ ​C​o​m​p​a​n​y + * G​e​t​ ​a​ ​C​a​l​l */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​c​o​m​p​a​n​y​ ​d​e​t​a​i​l​s + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l */ shortDesc: string /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​p​a​n​y​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​a​s​s​o​c​i​a​t​e​d​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​d​e​a​l​s​. + * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​u​s​i​n​g​ ​i​t​s​ ​u​n​i​q​u​e​ ​S​I​D​.​ ​T​h​i​s​ ​r​e​t​u​r​n​s​ ​a​l​l​ ​a​v​a​i​l​a​b​l​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​c​a​l​l​ ​i​n​c​l​u​d​i​n​g​ ​s​t​a​t​u​s​,​ ​d​u​r​a​t​i​o​n​,​ ​p​r​i​c​i​n​g​,​ ​a​n​d​ ​t​i​m​e​s​t​a​m​p​s​. */ longDesc: string - groups: { - /** - * C​o​m​p​a​n​i​e​s - */ - '0': string - } options: { - companyId: { + callSid: { /** - * C​o​m​p​a​n​y​ ​I​D + * C​a​l​l​ ​S​I​D */ displayName: string /** - * C​o​m​p​a​n​y​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​a​l​l */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​C​a​l​l​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​. */ longDesc: string } } } - create_company: { + delete_call: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } /** - * C​r​e​a​t​e​ ​C​o​m​p​a​n​y + * D​e​l​e​t​e​ ​a​ ​C​a​l​l */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​m​p​a​n​y + * D​e​l​e​t​e​ ​a​ ​c​a​l​l​ ​r​e​c​o​r​d​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​m​p​a​n​y​ ​r​e​c​o​r​d​ ​w​i​t​h​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​t​o​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​d​e​a​l​s​. + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​a​l​l​ ​r​e​c​o​r​d​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​N​o​t​e​ ​t​h​a​t​ ​d​e​l​e​t​i​n​g​ ​a​ ​c​a​l​l​ ​r​e​c​o​r​d​ ​d​o​e​s​ ​n​o​t​ ​r​e​d​a​c​t​ ​t​h​e​ ​c​a​l​l​ ​d​a​t​a​ ​f​r​o​m​ ​T​w​i​l​i​o​ ​l​o​g​s​. */ longDesc: string + options: { + callSid: { + /** + * C​a​l​l​ ​S​I​D + */ + displayName: string + /** + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​d​e​l​e​t​e + */ + shortDesc: string + /** + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​c​a​l​l​ ​t​o​ ​d​e​l​e​t​e​.​ ​C​a​l​l​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​. + */ + longDesc: string + } + } + } + create_execution: { groups: { /** - * C​o​m​p​a​n​i​e​s + * S​t​u​d​i​o */ '0': string } + /** + * C​r​e​a​t​e​ ​a​n​ ​E​x​e​c​u​t​i​o​n + */ + displayName: string + /** + * S​t​a​r​t​ ​a​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​e​x​e​c​u​t​i​o​n + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​n​d​ ​s​t​a​r​t​ ​a​ ​n​e​w​ ​e​x​e​c​u​t​i​o​n​ ​o​f​ ​a​ ​S​t​u​d​i​o​ ​F​l​o​w​.​ ​T​h​i​s​ ​t​r​i​g​g​e​r​s​ ​t​h​e​ ​f​l​o​w​ ​t​o​ ​r​u​n​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​p​a​r​a​m​e​t​e​r​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​a​c​c​e​s​s​e​d​ ​w​i​t​h​i​n​ ​t​h​e​ ​f​l​o​w​. + */ + longDesc: string options: { - name: { + flowSid: { /** - * C​o​m​p​a​n​y​ ​N​a​m​e + * F​l​o​w​ ​S​I​D */ displayName: string /** - * N​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w */ shortDesc: string /** - * B​u​s​i​n​e​s​s​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​.​ ​R​e​q​u​i​r​e​d​ ​f​i​e​l​d​. + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​t​o​ ​e​x​e​c​u​t​e​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. */ longDesc: string } - attributes: { + to: { /** - * C​o​m​p​a​n​y​ ​A​t​t​r​i​b​u​t​e​s + * T​o */ displayName: string /** - * C​u​s​t​o​m​ ​c​o​m​p​a​n​y​ ​d​a​t​a + * T​h​e​ ​c​o​n​t​a​c​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * C​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​i​n​c​l​u​d​i​n​g​ ​i​n​d​u​s​t​r​y​,​ ​s​i​z​e​,​ ​w​e​b​s​i​t​e​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​d​e​f​i​n​e​d​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. + * T​h​e​ ​c​o​n​t​a​c​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​s​t​a​r​t​ ​t​h​e​ ​F​l​o​w​ ​e​x​e​c​u​t​i​o​n​ ​w​i​t​h​.​ ​A​v​a​i​l​a​b​l​e​ ​i​n​ ​t​h​e​ ​f​l​o​w​ ​a​s​ ​c​o​n​t​a​c​t​.​c​h​a​n​n​e​l​.​a​d​d​r​e​s​s​. */ longDesc: string - type: { - fields: { - domain: { - /** - * D​o​m​a​i​n - */ - displayName: string - /** - * C​o​m​p​a​n​y​ ​d​o​m​a​i​n - */ - shortDesc: string - /** - * T​h​e​ ​p​r​i​m​a​r​y​ ​d​o​m​a​i​n​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​c​o​m​p​a​n​y​. - */ - longDesc: string - } - } - } } - linkedContactsIds: { + from: { /** - * A​s​s​o​c​i​a​t​e​d​ ​C​o​n​t​a​c​t​s + * F​r​o​m */ displayName: string /** - * L​i​n​k​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​c​o​m​p​a​n​y + * T​h​e​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​c​o​m​p​a​n​y​. + * T​h​e​ ​T​w​i​l​i​o​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​ ​o​r​ ​m​a​k​e​ ​c​a​l​l​s​ ​f​r​o​m​ ​d​u​r​i​n​g​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​A​v​a​i​l​a​b​l​e​ ​a​s​ ​f​l​o​w​.​c​h​a​n​n​e​l​.​a​d​d​r​e​s​s​.​ ​C​a​n​ ​a​l​s​o​ ​b​e​ ​a​ ​M​e​s​s​a​g​i​n​g​ ​S​e​r​v​i​c​e​ ​S​I​D​. */ longDesc: string } - linkedDeals: { + parameters: { /** - * A​s​s​o​c​i​a​t​e​d​ ​D​e​a​l​s + * P​a​r​a​m​e​t​e​r​s */ displayName: string /** - * L​i​n​k​ ​d​e​a​l​s​ ​t​o​ ​c​o​m​p​a​n​y + * J​S​O​N​ ​d​a​t​a​ ​f​o​r​ ​t​h​e​ ​f​l​o​w​ ​c​o​n​t​e​x​t */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​d​e​a​l​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​c​o​m​p​a​n​y​. + * J​S​O​N​ ​d​a​t​a​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​f​l​o​w​'​s​ ​c​o​n​t​e​x​t​ ​a​n​d​ ​a​c​c​e​s​s​i​b​l​e​ ​a​s​ ​v​a​r​i​a​b​l​e​s​.​ ​F​o​r​ ​e​x​a​m​p​l​e​:​ ​a​ ​J​S​O​N​ ​o​b​j​e​c​t​ ​w​i​t​h​ ​n​a​m​e​ ​p​r​o​p​e​r​t​y​ ​b​e​c​o​m​e​s​ ​a​v​a​i​l​a​b​l​e​ ​a​s​ ​f​l​o​w​.​d​a​t​a​.​n​a​m​e​ ​i​n​ ​t​h​e​ ​f​l​o​w​. */ longDesc: string } } } - update_company: { + list_executions: { + groups: { + /** + * S​t​u​d​i​o + */ + '0': string + } /** - * U​p​d​a​t​e​ ​C​o​m​p​a​n​y + * L​i​s​t​ ​E​x​e​c​u​t​i​o​n​s */ displayName: string /** - * U​p​d​a​t​e​ ​c​o​m​p​a​n​y​ ​i​n​f​o​r​m​a​t​i​o​n + * R​e​t​r​i​e​v​e​ ​e​x​e​c​u​t​i​o​n​s​ ​f​o​r​ ​a​ ​S​t​u​d​i​o​ ​F​l​o​w */ shortDesc: string /** - * U​p​d​a​t​e​ ​c​o​m​p​a​n​y​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​,​ ​a​n​d​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​w​i​t​h​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​d​e​a​l​s​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​e​x​e​c​u​t​i​o​n​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​S​t​u​d​i​o​ ​F​l​o​w​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​e​x​e​c​u​t​i​o​n​s​ ​b​y​ ​d​a​t​e​ ​r​a​n​g​e​ ​t​o​ ​f​i​n​d​ ​s​p​e​c​i​f​i​c​ ​e​x​e​c​u​t​i​o​n​ ​i​n​s​t​a​n​c​e​s​. */ longDesc: string - groups: { - /** - * C​o​m​p​a​n​i​e​s - */ - '0': string - } options: { - companyId: { + flowSid: { /** - * C​o​m​p​a​n​y​ ​I​D + * F​l​o​w​ ​S​I​D */ displayName: string /** - * C​o​m​p​a​n​y​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​t​o​ ​u​p​d​a​t​e​. + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​w​h​o​s​e​ ​e​x​e​c​u​t​i​o​n​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. */ longDesc: string } - name: { + dateCreatedFrom: { /** - * C​o​m​p​a​n​y​ ​N​a​m​e + * D​a​t​e​ ​C​r​e​a​t​e​d​ ​F​r​o​m */ displayName: string /** - * U​p​d​a​t​e​d​ ​c​o​m​p​a​n​y​ ​n​a​m​e + * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e */ shortDesc: string /** - * N​e​w​ ​b​u​s​i​n​e​s​s​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​n​y​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​e​x​e​c​u​t​i​o​n​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​,​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - attributes: { + dateCreatedTo: { /** - * C​o​m​p​a​n​y​ ​A​t​t​r​i​b​u​t​e​s + * D​a​t​e​ ​C​r​e​a​t​e​d​ ​T​o */ displayName: string /** - * U​p​d​a​t​e​ ​c​o​m​p​a​n​y​ ​d​a​t​a + * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e */ shortDesc: string /** - * U​p​d​a​t​e​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​i​n​c​l​u​d​i​n​g​ ​i​n​d​u​s​t​r​y​,​ ​s​i​z​e​,​ ​w​e​b​s​i​t​e​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​e​x​e​c​u​t​i​o​n​s​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​,​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - linkedContactsIds: { + limit: { /** - * A​s​s​o​c​i​a​t​e​d​ ​C​o​n​t​a​c​t​s + * L​i​m​i​t */ displayName: string /** - * U​p​d​a​t​e​ ​c​o​n​t​a​c​t​ ​a​s​s​o​c​i​a​t​i​o​n​s + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​e​x​e​c​u​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​c​o​m​p​a​n​y​.​ ​R​e​p​l​a​c​e​s​ ​e​x​i​s​t​i​n​g​ ​a​s​s​o​c​i​a​t​i​o​n​s​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​e​x​e​c​u​t​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - linkedDeals: { + pageSize: { /** - * A​s​s​o​c​i​a​t​e​d​ ​D​e​a​l​s + * P​a​g​e​ ​S​i​z​e */ displayName: string /** - * U​p​d​a​t​e​ ​d​e​a​l​ ​a​s​s​o​c​i​a​t​i​o​n​s + * N​u​m​b​e​r​ ​o​f​ ​e​x​e​c​u​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​d​e​a​l​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​c​o​m​p​a​n​y​.​ ​R​e​p​l​a​c​e​s​ ​e​x​i​s​t​i​n​g​ ​a​s​s​o​c​i​a​t​i​o​n​s​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​e​x​e​c​u​t​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } } } - list_companies: { + get_execution: { + groups: { + /** + * S​t​u​d​i​o + */ + '0': string + } /** - * L​i​s​t​ ​C​o​m​p​a​n​i​e​s + * G​e​t​ ​a​n​ ​E​x​e​c​u​t​i​o​n */ displayName: string /** - * G​e​t​ ​a​l​l​ ​c​o​m​p​a​n​i​e​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​e​x​e​c​u​t​i​o​n */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​o​m​p​a​n​i​e​s​ ​w​i​t​h​ ​p​a​g​i​n​a​t​i​o​n​,​ ​s​o​r​t​i​n​g​,​ ​a​n​d​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​.​ ​F​i​l​t​e​r​ ​b​y​ ​a​s​s​o​c​i​a​t​e​d​ ​c​o​n​t​a​c​t​s​,​ ​d​e​a​l​s​,​ ​o​r​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​. + * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​e​x​e​c​u​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​c​u​r​r​e​n​t​ ​s​t​a​t​e​,​ ​c​o​n​t​e​x​t​ ​d​a​t​a​,​ ​a​n​d​ ​s​t​a​t​u​s​. */ longDesc: string - groups: { - /** - * C​o​m​p​a​n​i​e​s - */ - '0': string - } options: { - limit: { - /** - * R​e​s​u​l​t​s​ ​L​i​m​i​t - */ - displayName: string - /** - * N​u​m​b​e​r​ ​o​f​ ​c​o​m​p​a​n​i​e​s​ ​p​e​r​ ​p​a​g​e - */ - shortDesc: string - /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​p​a​n​i​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. - */ - longDesc: string - } - page: { - /** - * P​a​g​e​ ​N​u​m​b​e​r - */ - displayName: string - /** - * P​a​g​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n - */ - shortDesc: string - /** - * P​a​g​e​ ​n​u​m​b​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​s​t​a​r​t​s​ ​f​r​o​m​ ​1​)​. - */ - longDesc: string - } - sort: { + flowSid: { /** - * S​o​r​t​ ​O​r​d​e​r + * F​l​o​w​ ​S​I​D */ displayName: string /** - * C​o​m​p​a​n​y​ ​s​o​r​t​ ​o​r​d​e​r + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w */ shortDesc: string /** - * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​c​o​m​p​a​n​i​e​s​. + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. */ longDesc: string } - sortBy: { + executionSid: { /** - * S​o​r​t​ ​B​y​ ​F​i​e​l​d + * E​x​e​c​u​t​i​o​n​ ​S​I​D */ displayName: string /** - * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n */ shortDesc: string /** - * C​o​m​p​a​n​y​ ​a​t​t​r​i​b​u​t​e​ ​t​o​ ​s​o​r​t​ ​r​e​s​u​l​t​s​ ​b​y​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​E​x​e​c​u​t​i​o​n​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​N​"​. */ longDesc: string } - linkedContactsId: { + } + } + update_execution: { + groups: { + /** + * S​t​u​d​i​o + */ + '0': string + } + /** + * U​p​d​a​t​e​ ​a​n​ ​E​x​e​c​u​t​i​o​n + */ + displayName: string + /** + * U​p​d​a​t​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​a​n​ ​e​x​e​c​u​t​i​o​n + */ + shortDesc: string + /** + * U​p​d​a​t​e​ ​t​h​e​ ​s​t​a​t​u​s​ ​o​f​ ​a​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​e​x​e​c​u​t​i​o​n​.​ ​T​h​i​s​ ​i​s​ ​t​y​p​i​c​a​l​l​y​ ​u​s​e​d​ ​t​o​ ​e​n​d​ ​a​n​ ​a​c​t​i​v​e​ ​e​x​e​c​u​t​i​o​n​ ​e​a​r​l​y​. + */ + longDesc: string + options: { + flowSid: { /** - * F​i​l​t​e​r​ ​b​y​ ​C​o​n​t​a​c​t + * F​l​o​w​ ​S​I​D */ displayName: string /** - * C​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​n​t​a​c​t + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​m​p​a​n​i​e​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​. + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. */ longDesc: string } - linkedDealsId: { + executionSid: { /** - * F​i​l​t​e​r​ ​b​y​ ​D​e​a​l + * E​x​e​c​u​t​i​o​n​ ​S​I​D */ displayName: string /** - * C​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​d​e​a​l + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​m​p​a​n​i​e​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​ ​t​o​ ​u​p​d​a​t​e​.​ ​E​x​e​c​u​t​i​o​n​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​N​"​. */ longDesc: string } - filter: { + status: { /** - * A​t​t​r​i​b​u​t​e​ ​F​i​l​t​e​r + * S​t​a​t​u​s */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​o​m​p​a​n​y​ ​a​t​t​r​i​b​u​t​e​s + * T​h​e​ ​n​e​w​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n */ shortDesc: string /** - * F​i​l​t​e​r​ ​c​o​m​p​a​n​i​e​s​ ​b​a​s​e​d​ ​o​n​ ​s​p​e​c​i​f​i​c​ ​a​t​t​r​i​b​u​t​e​ ​v​a​l​u​e​s​. + * T​h​e​ ​s​t​a​t​u​s​ ​t​o​ ​s​e​t​ ​f​o​r​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​S​e​t​ ​t​o​ ​"​e​n​d​e​d​"​ ​t​o​ ​t​e​r​m​i​n​a​t​e​ ​a​n​ ​a​c​t​i​v​e​ ​e​x​e​c​u​t​i​o​n​. */ longDesc: string - type: { - fields: { - field: { - /** - * A​t​t​r​i​b​u​t​e​ ​F​i​e​l​d - */ - displayName: string - /** - * A​t​t​r​i​b​u​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y - */ - shortDesc: string - /** - * C​o​m​p​a​n​y​ ​a​t​t​r​i​b​u​t​e​ ​f​i​e​l​d​ ​n​a​m​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y​. - */ - longDesc: string - } - value: { - /** - * F​i​l​t​e​r​ ​V​a​l​u​e - */ - displayName: string - /** - * V​a​l​u​e​ ​t​o​ ​m​a​t​c​h - */ - shortDesc: string - /** - * V​a​l​u​e​ ​t​h​a​t​ ​t​h​e​ ​a​t​t​r​i​b​u​t​e​ ​m​u​s​t​ ​e​q​u​a​l​. - */ - longDesc: string - } - } - } } } } - get_deal: { - /** - * G​e​t​ ​D​e​a​l - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​a​l​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​a​s​s​o​c​i​a​t​e​d​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​c​o​m​p​a​n​i​e​s​. - */ - longDesc: string + delete_execution: { groups: { /** - * D​e​a​l​s + * S​t​u​d​i​o */ '0': string } - options: { - dealId: { - /** - * D​e​a​l​ ​I​D - */ - displayName: string - /** - * D​e​a​l​ ​t​o​ ​r​e​t​r​i​e​v​e - */ - shortDesc: string - /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. - */ - longDesc: string - } - } - } - create_deal: { /** - * C​r​e​a​t​e​ ​D​e​a​l + * D​e​l​e​t​e​ ​a​n​ ​E​x​e​c​u​t​i​o​n */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​d​e​a​l + * D​e​l​e​t​e​ ​a​n​ ​e​x​e​c​u​t​i​o​n​ ​r​e​c​o​r​d */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​d​e​a​l​ ​i​n​ ​y​o​u​r​ ​s​a​l​e​s​ ​p​i​p​e​l​i​n​e​ ​w​i​t​h​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​t​o​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​c​o​m​p​a​n​i​e​s​. + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​n​ ​e​x​e​c​u​t​i​o​n​ ​r​e​c​o​r​d​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. */ longDesc: string - groups: { - /** - * D​e​a​l​s - */ - '0': string - } options: { - name: { + flowSid: { /** - * D​e​a​l​ ​N​a​m​e + * F​l​o​w​ ​S​I​D */ displayName: string /** - * N​a​m​e​ ​o​f​ ​t​h​e​ ​d​e​a​l + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w */ shortDesc: string /** - * D​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​o​p​p​o​r​t​u​n​i​t​y​.​ ​R​e​q​u​i​r​e​d​ ​f​i​e​l​d​. + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​S​t​u​d​i​o​ ​F​l​o​w​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​.​ ​F​l​o​w​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​W​"​. */ longDesc: string } - attributes: { + executionSid: { /** - * D​e​a​l​ ​A​t​t​r​i​b​u​t​e​s + * E​x​e​c​u​t​i​o​n​ ​S​I​D */ displayName: string /** - * C​u​s​t​o​m​ ​d​e​a​l​ ​d​a​t​a + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * C​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​i​n​c​l​u​d​i​n​g​ ​v​a​l​u​e​,​ ​s​t​a​g​e​,​ ​c​l​o​s​e​ ​d​a​t​e​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​d​e​f​i​n​e​d​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​e​x​e​c​u​t​i​o​n​ ​t​o​ ​d​e​l​e​t​e​.​ ​E​x​e​c​u​t​i​o​n​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​F​N​"​. */ longDesc: string } - linkedContactsIds: { + } + } + list_recordings: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } + /** + * L​i​s​t​ ​R​e​c​o​r​d​i​n​g​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​s​ ​f​r​o​m​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​r​e​c​o​r​d​i​n​g​s​ ​b​y​ ​c​a​l​l​ ​S​I​D​,​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D​,​ ​d​a​t​e​ ​r​a​n​g​e​,​ ​a​n​d​ ​i​n​c​l​u​d​e​ ​s​o​f​t​-​d​e​l​e​t​e​d​ ​r​e​c​o​r​d​i​n​g​s​. + */ + longDesc: string + options: { + callSid: { /** - * A​s​s​o​c​i​a​t​e​d​ ​C​o​n​t​a​c​t​s + * C​a​l​l​ ​S​I​D */ displayName: string /** - * L​i​n​k​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​d​e​a​l + * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​ ​S​I​D */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​.​ ​T​h​e​ ​C​a​l​l​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​. */ longDesc: string } - linkedCompaniesIds: { + conferenceSid: { /** - * A​s​s​o​c​i​a​t​e​d​ ​C​o​m​p​a​n​i​e​s + * C​o​n​f​e​r​e​n​c​e​ ​S​I​D */ displayName: string /** - * L​i​n​k​ ​c​o​m​p​a​n​i​e​s​ ​t​o​ ​d​e​a​l + * F​i​l​t​e​r​ ​b​y​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​c​o​m​p​a​n​y​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​o​n​f​e​r​e​n​c​e​.​ ​T​h​e​ ​C​o​n​f​e​r​e​n​c​e​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​F​"​. */ longDesc: string } - } - } - update_deal: { - /** - * U​p​d​a​t​e​ ​D​e​a​l - */ - displayName: string - /** - * U​p​d​a​t​e​ ​d​e​a​l​ ​i​n​f​o​r​m​a​t​i​o​n - */ - shortDesc: string - /** - * U​p​d​a​t​e​ ​d​e​a​l​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​,​ ​a​n​d​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​w​i​t​h​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​c​o​m​p​a​n​i​e​s​. - */ - longDesc: string - groups: { - /** - * D​e​a​l​s - */ - '0': string - } - options: { - dealId: { + dateCreatedAfter: { /** - * D​e​a​l​ ​I​D + * D​a​t​e​ ​C​r​e​a​t​e​d​ ​A​f​t​e​r */ displayName: string /** - * D​e​a​l​ ​t​o​ ​u​p​d​a​t​e + * F​i​l​t​e​r​ ​b​y​ ​m​i​n​i​m​u​m​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​u​p​d​a​t​e​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​o​r​d​i​n​g​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - name: { + dateCreatedBefore: { /** - * D​e​a​l​ ​N​a​m​e + * D​a​t​e​ ​C​r​e​a​t​e​d​ ​B​e​f​o​r​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​d​e​a​l​ ​n​a​m​e + * F​i​l​t​e​r​ ​b​y​ ​m​a​x​i​m​u​m​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e */ shortDesc: string /** - * N​e​w​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​r​e​c​o​r​d​i​n​g​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​d​a​t​e​ ​i​n​ ​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​. */ longDesc: string } - attributes: { + includeSoftDeleted: { /** - * D​e​a​l​ ​A​t​t​r​i​b​u​t​e​s + * I​n​c​l​u​d​e​ ​S​o​f​t​ ​D​e​l​e​t​e​d */ displayName: string /** - * U​p​d​a​t​e​ ​d​e​a​l​ ​d​a​t​a + * I​n​c​l​u​d​e​ ​s​o​f​t​-​d​e​l​e​t​e​d​ ​r​e​c​o​r​d​i​n​g​s */ shortDesc: string /** - * U​p​d​a​t​e​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​i​n​c​l​u​d​i​n​g​ ​v​a​l​u​e​,​ ​s​t​a​g​e​,​ ​c​l​o​s​e​ ​d​a​t​e​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​. + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​s​o​f​t​-​d​e​l​e​t​e​d​ ​r​e​c​o​r​d​i​n​g​s​.​ ​R​e​c​o​r​d​i​n​g​ ​m​e​t​a​d​a​t​a​ ​i​s​ ​r​e​t​a​i​n​e​d​ ​f​o​r​ ​4​0​ ​d​a​y​s​ ​a​f​t​e​r​ ​d​e​l​e​t​i​o​n​. */ longDesc: string } - linkedContactsIds: { + limit: { /** - * A​s​s​o​c​i​a​t​e​d​ ​C​o​n​t​a​c​t​s + * L​i​m​i​t */ displayName: string /** - * U​p​d​a​t​e​ ​c​o​n​t​a​c​t​ ​a​s​s​o​c​i​a​t​i​o​n​s + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​c​o​r​d​i​n​g​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l​.​ ​R​e​p​l​a​c​e​s​ ​e​x​i​s​t​i​n​g​ ​a​s​s​o​c​i​a​t​i​o​n​s​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​c​o​r​d​i​n​g​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - linkedCompaniesIds: { + pageSize: { /** - * A​s​s​o​c​i​a​t​e​d​ ​C​o​m​p​a​n​i​e​s + * P​a​g​e​ ​S​i​z​e */ displayName: string /** - * U​p​d​a​t​e​ ​c​o​m​p​a​n​y​ ​a​s​s​o​c​i​a​t​i​o​n​s + * N​u​m​b​e​r​ ​o​f​ ​r​e​c​o​r​d​i​n​g​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​c​o​m​p​a​n​y​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l​.​ ​R​e​p​l​a​c​e​s​ ​e​x​i​s​t​i​n​g​ ​a​s​s​o​c​i​a​t​i​o​n​s​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​c​o​r​d​i​n​g​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } } } - list_deals: { + get_recording: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } /** - * L​i​s​t​ ​D​e​a​l​s + * G​e​t​ ​a​ ​R​e​c​o​r​d​i​n​g */ displayName: string /** - * G​e​t​ ​a​l​l​ ​d​e​a​l​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​r​e​c​o​r​d​i​n​g */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​d​e​a​l​s​ ​i​n​ ​y​o​u​r​ ​p​i​p​e​l​i​n​e​ ​w​i​t​h​ ​p​a​g​i​n​a​t​i​o​n​,​ ​s​o​r​t​i​n​g​,​ ​a​n​d​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​.​ ​F​i​l​t​e​r​ ​b​y​ ​a​s​s​o​c​i​a​t​e​d​ ​c​o​n​t​a​c​t​s​,​ ​c​o​m​p​a​n​i​e​s​,​ ​o​r​ ​d​e​a​l​ ​n​a​m​e​. + * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​ ​i​n​c​l​u​d​i​n​g​ ​d​u​r​a​t​i​o​n​,​ ​s​t​a​t​u​s​,​ ​p​r​i​c​i​n​g​,​ ​m​e​d​i​a​ ​U​R​L​,​ ​a​n​d​ ​e​n​c​r​y​p​t​i​o​n​ ​d​e​t​a​i​l​s​. */ longDesc: string - groups: { - /** - * D​e​a​l​s - */ - '0': string - } options: { - limit: { + recordingSid: { /** - * R​e​s​u​l​t​s​ ​L​i​m​i​t + * R​e​c​o​r​d​i​n​g​ ​S​I​D */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​p​e​r​ ​p​a​g​e + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g */ shortDesc: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​R​e​c​o​r​d​i​n​g​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​R​E​"​. */ longDesc: string } - offset: { + } + } + list_transcriptions: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } + /** + * L​i​s​t​ ​T​r​a​n​s​c​r​i​p​t​i​o​n​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​f​o​r​ ​a​ ​r​e​c​o​r​d​i​n​g + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​.​ ​T​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​c​o​n​v​e​r​t​ ​t​h​e​ ​a​u​d​i​o​ ​f​r​o​m​ ​r​e​c​o​r​d​i​n​g​s​ ​i​n​t​o​ ​t​e​x​t​. + */ + longDesc: string + options: { + recordingSid: { /** - * P​a​g​e​ ​O​f​f​s​e​t + * R​e​c​o​r​d​i​n​g​ ​S​I​D */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​s​k​i​p + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g */ shortDesc: string /** - * N​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​. + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​ ​w​h​o​s​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​l​i​s​t​.​ ​R​e​c​o​r​d​i​n​g​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​R​E​"​. */ longDesc: string } - sort: { + limit: { /** - * S​o​r​t​ ​O​r​d​e​r + * L​i​m​i​t */ displayName: string /** - * D​e​a​l​ ​s​o​r​t​ ​o​r​d​e​r + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​d​e​a​l​s​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - linkedContactsId: { + pageSize: { /** - * F​i​l​t​e​r​ ​b​y​ ​C​o​n​t​a​c​t + * P​a​g​e​ ​S​i​z​e */ displayName: string /** - * D​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​n​t​a​c​t + * N​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​d​e​a​l​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​. + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​T​h​e​ ​d​e​f​a​u​l​t​ ​i​s​ ​5​0​ ​a​n​d​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​0​. */ longDesc: string } - linkedCompaniesId: { + } + } + get_transcription: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } + /** + * G​e​t​ ​a​ ​T​r​a​n​s​c​r​i​p​t​i​o​n + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​w​i​t​h​ ​t​e​x​t + */ + shortDesc: string + /** + * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​t​h​e​ ​f​u​l​l​ ​t​r​a​n​s​c​r​i​b​e​d​ ​t​e​x​t​ ​f​r​o​m​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​.​ ​T​h​i​s​ ​r​e​t​u​r​n​s​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​T​e​x​t​ ​f​i​e​l​d​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​a​c​t​u​a​l​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​c​o​n​t​e​n​t​. + */ + longDesc: string + options: { + recordingSid: { /** - * F​i​l​t​e​r​ ​b​y​ ​C​o​m​p​a​n​y + * R​e​c​o​r​d​i​n​g​ ​S​I​D */ displayName: string /** - * D​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​m​p​a​n​y + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g */ shortDesc: string /** - * F​i​l​t​e​r​ ​d​e​a​l​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​p​a​n​y​. + * T​h​e​ ​S​I​D​ ​o​f​ ​t​h​e​ ​r​e​c​o​r​d​i​n​g​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​.​ ​R​e​c​o​r​d​i​n​g​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​R​E​"​. */ longDesc: string } - dealName: { + transcriptionSid: { /** - * D​e​a​l​ ​N​a​m​e​ ​F​i​l​t​e​r + * T​r​a​n​s​c​r​i​p​t​i​o​n​ ​S​I​D */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​d​e​a​l​ ​n​a​m​e + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n */ shortDesc: string /** - * F​i​l​t​e​r​ ​d​e​a​l​s​ ​b​y​ ​n​a​m​e​ ​c​o​n​t​a​i​n​i​n​g​ ​s​p​e​c​i​f​i​e​d​ ​t​e​x​t​. + * T​h​e​ ​u​n​i​q​u​e​ ​s​t​r​i​n​g​ ​i​d​e​n​t​i​f​i​e​r​ ​(​S​I​D​)​ ​o​f​ ​t​h​e​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​T​r​a​n​s​c​r​i​p​t​i​o​n​ ​S​I​D​s​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​T​R​"​. */ longDesc: string } } } - delete_contact: { + } + triggers: { + new_message: { + groups: { + /** + * M​e​s​s​a​g​i​n​g + */ + '0': string + } /** - * D​e​l​e​t​e​ ​C​o​n​t​a​c​t + * N​e​w​ ​M​e​s​s​a​g​e */ displayName: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​S​M​S​ ​o​r​ ​M​M​S​ ​m​e​s​s​a​g​e​ ​i​s​ ​r​e​c​e​i​v​e​d */ shortDesc: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​T​h​e​ ​c​o​n​t​a​c​t​ ​w​i​l​l​ ​b​e​ ​r​e​m​o​v​e​d​ ​f​r​o​m​ ​a​l​l​ ​l​i​s​t​s​ ​a​n​d​ ​c​a​m​p​a​i​g​n​s​. + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​ ​i​n​c​o​m​i​n​g​ ​o​r​ ​o​u​t​g​o​i​n​g​ ​m​e​s​s​a​g​e​s​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​m​e​s​s​a​g​e​s​ ​b​y​ ​r​e​c​i​p​i​e​n​t​ ​o​r​ ​s​e​n​d​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r​.​ ​T​h​e​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​i​s​ ​d​e​t​e​c​t​e​d​ ​t​h​a​t​ ​m​a​t​c​h​e​s​ ​y​o​u​r​ ​f​i​l​t​e​r​s​. */ longDesc: string - groups: { - /** - * C​o​n​t​a​c​t​s - */ - '0': string - } options: { - identifier: { + to: { /** - * C​o​n​t​a​c​t​ ​I​d​e​n​t​i​f​i​e​r + * T​o */ displayName: string /** - * C​o​n​t​a​c​t​ ​t​o​ ​d​e​l​e​t​e + * F​i​l​t​e​r​ ​b​y​ ​r​e​c​i​p​i​e​n​t​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​d​e​l​e​t​e​ ​p​e​r​m​a​n​e​n​t​l​y​.​ ​C​a​n​ ​b​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​c​o​n​t​a​c​t​ ​I​D​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​e​x​t​e​r​n​a​l​ ​I​D​,​ ​W​h​a​t​s​A​p​p​ ​I​D​,​ ​o​r​ ​l​a​n​d​l​i​n​e​ ​n​u​m​b​e​r​. + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​t​o​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​.​ ​T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​r​e​c​i​p​i​e​n​t​s​. */ longDesc: string } - } - } - delete_company: { - /** - * D​e​l​e​t​e​ ​C​o​m​p​a​n​y - */ - displayName: string - /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​m​p​a​n​y - */ - shortDesc: string - /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​m​p​a​n​y​ ​f​r​o​m​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​A​l​l​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​w​i​t​h​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​d​e​a​l​s​ ​w​i​l​l​ ​b​e​ ​r​e​m​o​v​e​d​. - */ - longDesc: string - groups: { - /** - * C​o​m​p​a​n​i​e​s - */ - '0': string - } - options: { - companyId: { + from: { /** - * C​o​m​p​a​n​y​ ​I​D + * F​r​o​m */ displayName: string /** - * C​o​m​p​a​n​y​ ​t​o​ ​d​e​l​e​t​e + * F​i​l​t​e​r​ ​b​y​ ​s​e​n​d​e​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ shortDesc: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​t​o​ ​d​e​l​e​t​e​ ​p​e​r​m​a​n​e​n​t​l​y​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​m​e​s​s​a​g​e​s​ ​s​e​n​t​ ​f​r​o​m​ ​t​h​i​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​o​r​ ​a​l​p​h​a​n​u​m​e​r​i​c​ ​s​e​n​d​e​r​ ​I​D​.​ ​T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​s​h​o​u​l​d​ ​b​e​ ​i​n​ ​E​.​1​6​4​ ​f​o​r​m​a​t​ ​(​e​.​g​.​,​ ​+​1​5​5​5​1​2​3​4​5​6​7​)​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​s​e​n​d​e​r​s​. */ longDesc: string } } } - delete_deal: { - /** - * D​e​l​e​t​e​ ​D​e​a​l - */ - displayName: string - /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​d​e​a​l - */ - shortDesc: string - /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​d​e​a​l​ ​f​r​o​m​ ​y​o​u​r​ ​s​a​l​e​s​ ​p​i​p​e​l​i​n​e​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​A​l​l​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​w​i​t​h​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​c​o​m​p​a​n​i​e​s​ ​w​i​l​l​ ​b​e​ ​r​e​m​o​v​e​d​. - */ - longDesc: string + new_recording: { groups: { /** - * D​e​a​l​s + * V​o​i​c​e */ '0': string } - options: { - dealId: { - /** - * D​e​a​l​ ​I​D - */ - displayName: string - /** - * D​e​a​l​ ​t​o​ ​d​e​l​e​t​e - */ - shortDesc: string - /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​d​e​l​e​t​e​ ​p​e​r​m​a​n​e​n​t​l​y​ ​f​r​o​m​ ​y​o​u​r​ ​p​i​p​e​l​i​n​e​. - */ - longDesc: string - } - } - } - } - triggers: { - new_contact: { - /** - * N​e​w​ ​C​o​n​t​a​c​t - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​s​ ​c​r​e​a​t​e​d - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​c​o​n​t​a​c​t​s​.​ ​O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​s​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​c​o​n​t​a​c​t​s​ ​a​r​e​ ​a​d​d​e​d​ ​t​o​ ​p​a​r​t​i​c​u​l​a​r​ ​l​i​s​t​s​. - */ - longDesc: string - options: { - listIds: { - /** - * F​i​l​t​e​r​ ​b​y​ ​L​i​s​t​s - */ - displayName: string - /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​s - */ - shortDesc: string - /** - * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​c​o​n​t​a​c​t​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​l​i​s​t​s​.​ ​I​f​ ​e​m​p​t​y​,​ ​t​r​i​g​g​e​r​s​ ​f​o​r​ ​a​l​l​ ​n​e​w​ ​c​o​n​t​a​c​t​s​. - */ - longDesc: string - } - } - } - new_company: { /** - * N​e​w​ ​C​o​m​p​a​n​y + * N​e​w​ ​R​e​c​o​r​d​i​n​g */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​p​a​n​y​ ​i​s​ ​c​r​e​a​t​e​d + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​ ​i​s​ ​c​r​e​a​t​e​d */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​c​o​m​p​a​n​i​e​s​.​ ​O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​b​y​ ​c​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​s​ ​o​r​ ​d​e​a​l​s​. + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​ ​c​a​l​l​ ​r​e​c​o​r​d​i​n​g​s​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​r​e​c​o​r​d​i​n​g​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​S​I​D​ ​o​r​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D​.​ ​T​h​e​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​r​e​c​o​r​d​i​n​g​ ​i​s​ ​d​e​t​e​c​t​e​d​ ​t​h​a​t​ ​m​a​t​c​h​e​s​ ​y​o​u​r​ ​f​i​l​t​e​r​s​. */ longDesc: string options: { - linkedContactsId: { + callSid: { /** - * F​i​l​t​e​r​ ​b​y​ ​C​o​n​t​a​c​t + * C​a​l​l​ ​S​I​D */ displayName: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​c​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​n​t​a​c​t + * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​ ​S​I​D */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​c​o​m​p​a​n​i​e​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​t​h​a​t​ ​a​r​e​ ​l​i​n​k​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​n​t​a​c​t​. + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​.​ ​T​h​e​ ​C​a​l​l​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​c​a​l​l​s​. */ longDesc: string } - linkedDealsId: { + conferenceSid: { /** - * F​i​l​t​e​r​ ​b​y​ ​D​e​a​l + * C​o​n​f​e​r​e​n​c​e​ ​S​I​D */ displayName: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​c​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​d​e​a​l + * F​i​l​t​e​r​ ​b​y​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​c​o​m​p​a​n​i​e​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​t​h​a​t​ ​a​r​e​ ​l​i​n​k​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​d​e​a​l​. + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​o​n​f​e​r​e​n​c​e​.​ ​T​h​e​ ​C​o​n​f​e​r​e​n​c​e​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​F​"​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​c​o​n​f​e​r​e​n​c​e​s​. */ longDesc: string } } } - new_deal: { + new_transcription: { + groups: { + /** + * V​o​i​c​e + */ + '0': string + } /** - * N​e​w​ ​D​e​a​l + * N​e​w​ ​T​r​a​n​s​c​r​i​p​t​i​o​n */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​a​l​ ​i​s​ ​c​r​e​a​t​e​d + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​r​e​c​o​r​d​i​n​g​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​i​s​ ​c​r​e​a​t​e​d */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​d​e​a​l​s​ ​i​n​ ​t​h​e​ ​s​a​l​e​s​ ​p​i​p​e​l​i​n​e​.​ ​O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​b​y​ ​d​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​s​ ​o​r​ ​c​o​m​p​a​n​i​e​s​. + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​T​w​i​l​i​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​b​y​ ​c​h​e​c​k​i​n​g​ ​t​h​e​ ​l​a​t​e​s​t​ ​r​e​c​o​r​d​i​n​g​s​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​ ​S​I​D​ ​o​r​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D​.​ ​T​h​e​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​ ​i​s​ ​d​e​t​e​c​t​e​d​ ​f​o​r​ ​r​e​c​o​r​d​i​n​g​s​ ​t​h​a​t​ ​m​a​t​c​h​ ​y​o​u​r​ ​f​i​l​t​e​r​s​. */ longDesc: string options: { - linkedContactsId: { + callSid: { /** - * F​i​l​t​e​r​ ​b​y​ ​C​o​n​t​a​c​t​s + * C​a​l​l​ ​S​I​D */ displayName: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​d​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​n​t​a​c​t​s + * F​i​l​t​e​r​ ​b​y​ ​c​a​l​l​ ​S​I​D */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​d​e​a​l​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​t​h​a​t​ ​a​r​e​ ​l​i​n​k​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​n​t​a​c​t​s​. + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​f​r​o​m​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​a​l​l​.​ ​T​h​e​ ​C​a​l​l​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​A​"​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​c​a​l​l​s​. */ longDesc: string } - linkedCompaniesId: { + conferenceSid: { /** - * F​i​l​t​e​r​ ​b​y​ ​C​o​m​p​a​n​i​e​s + * C​o​n​f​e​r​e​n​c​e​ ​S​I​D */ displayName: string /** - * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​d​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​m​p​a​n​i​e​s + * F​i​l​t​e​r​ ​b​y​ ​c​o​n​f​e​r​e​n​c​e​ ​S​I​D */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​d​e​a​l​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​t​h​a​t​ ​a​r​e​ ​l​i​n​k​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​m​p​a​n​i​e​s​. + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​t​r​a​n​s​c​r​i​p​t​i​o​n​s​ ​f​r​o​m​ ​r​e​c​o​r​d​i​n​g​s​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​i​s​ ​s​p​e​c​i​f​i​c​ ​c​o​n​f​e​r​e​n​c​e​.​ ​T​h​e​ ​C​o​n​f​e​r​e​n​c​e​ ​S​I​D​ ​s​h​o​u​l​d​ ​s​t​a​r​t​ ​w​i​t​h​ ​"​C​F​"​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​a​l​l​ ​c​o​n​f​e​r​e​n​c​e​s​. */ longDesc: string } } } - new_list: { - /** - * N​e​w​ ​L​i​s​t - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​i​s​ ​c​r​e​a​t​e​d - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​.​ ​T​r​i​g​g​e​r​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​l​i​s​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​a​n​y​ ​f​o​l​d​e​r​. - */ - longDesc: string - } } } - GoogleTasks: { + SendGrid: { /** - * G​o​o​g​l​e​ ​T​a​s​k​s + * S​e​n​d​G​r​i​d */ displayName: string groups: { /** - * P​r​o​j​e​c​t​ ​&​ ​T​a​s​k​ ​M​a​n​a​g​e​m​e​n​t + * E​m​a​i​l​ ​&​ ​E​m​a​i​l​ ​M​a​r​k​e​t​i​n​g */ '0': string + } + connectionMessage: { /** - * G​o​o​g​l​e​ ​W​o​r​k​s​p​a​c​e​ ​S​u​i​t​e + * A​P​I​ ​K​e​y​ ​I​n​s​t​r​u​c​t​i​o​n​s */ - '1': string + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​,​ ​y​o​u​'​l​l​ ​n​e​e​d​ ​a​n​ ​A​P​I​ ​k​e​y​.​ ​Y​o​u​ ​c​a​n​ ​c​r​e​a​t​e​ ​o​n​e​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​d​a​s​h​b​o​a​r​d​ ​a​t​ ​h​t​t​p​s​:​/​/​a​p​p​.​s​e​n​d​g​r​i​d​.​c​o​m​/​s​e​t​t​i​n​g​s​/​a​p​i​_​k​e​y​s​.​ ​E​n​s​u​r​e​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​h​a​s​ ​t​h​e​ ​a​p​p​r​o​p​r​i​a​t​e​ ​p​e​r​m​i​s​s​i​o​n​s​ ​f​o​r​ ​t​h​e​ ​f​e​a​t​u​r​e​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​s​e​:​ ​M​a​i​l​ ​S​e​n​d​ ​f​o​r​ ​s​e​n​d​i​n​g​ ​e​m​a​i​l​s​,​ ​E​m​a​i​l​ ​V​a​l​i​d​a​t​i​o​n​ ​f​o​r​ ​d​e​l​i​v​e​r​a​b​i​l​i​t​y​ ​c​h​e​c​k​s​,​ ​S​u​p​p​r​e​s​s​i​o​n​s​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​b​l​o​c​k​s​/​b​o​u​n​c​e​s​/​u​n​s​u​b​s​c​r​i​b​e​s​,​ ​a​n​d​ ​M​a​r​k​e​t​i​n​g​ ​f​o​r​ ​c​o​n​t​a​c​t​ ​m​a​n​a​g​e​m​e​n​t​. + */ + content: string } /** - * C​o​n​n​e​c​t​ ​t​o​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​A​P​I​ ​t​o​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​t​a​s​k​ ​l​i​s​t​s​ ​a​n​d​ ​t​a​s​k​s​ ​e​f​f​i​c​i​e​n​t​l​y​. + * C​o​n​n​e​c​t​ ​w​i​t​h​ ​S​e​n​d​G​r​i​d​ ​t​o​ ​s​e​n​d​ ​e​m​a​i​l​s​,​ ​m​a​n​a​g​e​ ​c​o​n​t​a​c​t​s​,​ ​a​n​d​ ​h​a​n​d​l​e​ ​s​u​p​p​r​e​s​s​i​o​n​s */ shortDesc: string /** - * T​h​e​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​p​r​o​v​i​d​e​s​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​a​c​t​i​o​n​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​t​o​ ​i​n​t​e​r​a​c​t​ ​w​i​t​h​ ​t​h​e​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​A​P​I​.​ ​M​a​n​a​g​e​ ​t​a​s​k​ ​l​i​s​t​s​,​ ​c​r​e​a​t​e​ ​a​n​d​ ​u​p​d​a​t​e​ ​t​a​s​k​s​,​ ​s​e​t​ ​d​u​e​ ​d​a​t​e​s​,​ ​a​n​d​ ​o​r​g​a​n​i​z​e​ ​y​o​u​r​ ​p​r​o​d​u​c​t​i​v​i​t​y​ ​w​o​r​k​f​l​o​w​ ​w​i​t​h​ ​s​e​a​m​l​e​s​s​ ​a​u​t​o​m​a​t​i​o​n​ ​c​a​p​a​b​i​l​i​t​i​e​s​. + * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​T​w​i​l​i​o​ ​S​e​n​d​G​r​i​d​ ​f​o​r​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​e​m​a​i​l​ ​m​a​n​a​g​e​m​e​n​t​.​ ​S​e​n​d​ ​t​r​a​n​s​a​c​t​i​o​n​a​l​ ​a​n​d​ ​m​a​r​k​e​t​i​n​g​ ​e​m​a​i​l​s​,​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​,​ ​v​a​l​i​d​a​t​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​o​r​ ​d​e​l​i​v​e​r​a​b​i​l​i​t​y​,​ ​a​n​d​ ​m​a​i​n​t​a​i​n​ ​y​o​u​r​ ​s​e​n​d​e​r​ ​r​e​p​u​t​a​t​i​o​n​ ​b​y​ ​h​a​n​d​l​i​n​g​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​i​n​c​l​u​d​i​n​g​ ​b​l​o​c​k​s​,​ ​b​o​u​n​c​e​s​,​ ​a​n​d​ ​g​l​o​b​a​l​ ​u​n​s​u​b​s​c​r​i​b​e​s​.​ ​T​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​p​r​o​v​i​d​e​s​ ​f​u​l​l​ ​c​o​n​t​r​o​l​ ​o​v​e​r​ ​y​o​u​r​ ​e​m​a​i​l​ ​i​n​f​r​a​s​t​r​u​c​t​u​r​e​ ​a​n​d​ ​h​e​l​p​s​ ​e​n​s​u​r​e​ ​h​i​g​h​ ​d​e​l​i​v​e​r​a​b​i​l​i​t​y​ ​r​a​t​e​s​. */ longDesc: string - triggers: { - new_task: { + actions: { + list_blocks: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } /** - * N​e​w​ ​T​a​s​k + * L​i​s​t​ ​B​l​o​c​k​s */ displayName: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​t​a​s​k​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s */ shortDesc: string /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​l​i​s​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​t​a​s​k​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​h​a​t​ ​a​r​e​ ​c​u​r​r​e​n​t​l​y​ ​o​n​ ​y​o​u​r​ ​b​l​o​c​k​s​ ​l​i​s​t​.​ ​B​l​o​c​k​e​d​ ​a​d​d​r​e​s​s​e​s​ ​a​r​e​ ​e​m​a​i​l​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​r​e​j​e​c​t​e​d​ ​b​y​ ​r​e​c​e​i​v​i​n​g​ ​s​e​r​v​e​r​s​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​t​i​m​e​ ​r​a​n​g​e​ ​a​n​d​ ​p​a​g​i​n​a​t​e​ ​t​h​r​o​u​g​h​ ​r​e​s​u​l​t​s​. */ longDesc: string options: { - taskList: { + startTime: { /** - * T​a​s​k​ ​L​i​s​t + * S​t​a​r​t​ ​T​i​m​e */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​t​a​s​k​s + * F​i​l​t​e​r​ ​b​l​o​c​k​s​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​t​a​s​k​s​. + * R​e​t​r​i​e​v​e​ ​b​l​o​c​k​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. */ longDesc: string } - includeAssigned: { + endTime: { /** - * I​n​c​l​u​d​e​ ​A​s​s​i​g​n​e​d​ ​T​a​s​k​s + * E​n​d​ ​T​i​m​e */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​s + * F​i​l​t​e​r​ ​b​l​o​c​k​s​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p */ shortDesc: string /** - * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​ ​p​e​o​p​l​e​ ​i​n​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​r​e​s​u​l​t​s​. + * R​e​t​r​i​e​v​e​ ​b​l​o​c​k​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. */ longDesc: string } - } - } - new_completed_task: { - /** - * N​e​w​ ​C​o​m​p​l​e​t​e​d​ ​T​a​s​k - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​t​a​s​k​ ​i​s​ ​m​a​r​k​e​d​ ​a​s​ ​c​o​m​p​l​e​t​e​d - */ - shortDesc: string - /** - * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​l​i​s​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​n​y​ ​t​a​s​k​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​l​i​s​t​ ​i​s​ ​m​a​r​k​e​d​ ​a​s​ ​c​o​m​p​l​e​t​e​d​. - */ - longDesc: string - options: { - taskList: { + limit: { /** - * T​a​s​k​ ​L​i​s​t + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​b​l​o​c​k​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​l​y​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​b​l​o​c​k​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​5​0​0​. */ longDesc: string } - includeAssigned: { + offset: { /** - * I​n​c​l​u​d​e​ ​A​s​s​i​g​n​e​d​ ​T​a​s​k​s + * O​f​f​s​e​t */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​s + * S​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​ ​p​e​o​p​l​e​ ​i​n​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​r​e​s​u​l​t​s​. + * T​h​e​ ​s​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. */ longDesc: string } } } - } - actions: { - create_task_list: { + get_block: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } /** - * C​r​e​a​t​e​ ​T​a​s​k​ ​L​i​s​t + * G​e​t​ ​a​ ​B​l​o​c​k */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​t​a​s​k​ ​l​i​s​t​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l */ shortDesc: string /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​t​a​s​k​ ​l​i​s​t​ ​i​n​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​a​c​c​o​u​n​t​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​i​t​l​e​. + * F​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​i​n​c​l​u​d​i​n​g​ ​t​h​e​ ​r​e​a​s​o​n​ ​f​o​r​ ​t​h​e​ ​b​l​o​c​k​ ​a​n​d​ ​w​h​e​n​ ​i​t​ ​w​a​s​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string - groups: { - /** - * T​a​s​k​ ​L​i​s​t​s - */ - '0': string - } options: { - title: { + email: { /** - * T​i​t​l​e + * E​m​a​i​l */ displayName: string /** - * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​n​e​w​ ​t​a​s​k​ ​l​i​s​t + * T​h​e​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​n​a​m​e​/​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​f​r​o​m​ ​t​h​e​ ​b​l​o​c​k​s​ ​l​i​s​t​.​ ​T​h​i​s​ ​s​h​o​u​l​d​ ​b​e​ ​t​h​e​ ​e​x​a​c​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​w​a​s​ ​b​l​o​c​k​e​d​. */ longDesc: string } } } - delete_task_list: { + delete_blocks: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } /** - * D​e​l​e​t​e​ ​T​a​s​k​ ​L​i​s​t + * D​e​l​e​t​e​ ​B​l​o​c​k​s */ displayName: string /** - * D​e​l​e​t​e​ ​a​ ​t​a​s​k​ ​l​i​s​t​ ​f​r​o​m​ ​G​o​o​g​l​e​ ​T​a​s​k​s + * D​e​l​e​t​e​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​l​i​s​t */ shortDesc: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​s​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​ ​a​n​d​ ​a​l​l​ ​t​a​s​k​s​ ​w​i​t​h​i​n​ ​i​t​ ​f​r​o​m​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​a​c​c​o​u​n​t​. + * R​e​m​o​v​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​b​l​o​c​k​s​ ​l​i​s​t​.​ ​Y​o​u​ ​c​a​n​ ​e​i​t​h​e​r​ ​d​e​l​e​t​e​ ​a​l​l​ ​b​l​o​c​k​s​ ​a​t​ ​o​n​c​e​ ​o​r​ ​s​p​e​c​i​f​y​ ​i​n​d​i​v​i​d​u​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​m​o​v​e​.​ ​D​e​l​e​t​i​n​g​ ​b​l​o​c​k​s​ ​a​l​l​o​w​s​ ​t​h​o​s​e​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​ ​a​g​a​i​n​. */ longDesc: string - groups: { - /** - * T​a​s​k​ ​L​i​s​t​s - */ - '0': string - } options: { - id: { + deleteAll: { /** - * T​a​s​k​ ​L​i​s​t + * D​e​l​e​t​e​ ​A​l​l */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​d​e​l​e​t​e + * D​e​l​e​t​e​ ​a​l​l​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​f​r​o​m​ ​G​o​o​g​l​e​ ​T​a​s​k​s​. + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​d​e​l​e​t​e​ ​a​l​l​ ​b​l​o​c​k​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​l​i​s​t​.​ ​W​h​e​n​ ​t​r​u​e​,​ ​t​h​e​ ​e​m​a​i​l​s​ ​p​a​r​a​m​e​t​e​r​ ​i​s​ ​i​g​n​o​r​e​d​. + */ + longDesc: string + } + emails: { + /** + * E​m​a​i​l​s + */ + displayName: string + /** + * L​i​s​t​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​d​e​l​e​t​e + */ + shortDesc: string + /** + * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​b​l​o​c​k​s​ ​l​i​s​t​.​ ​R​e​q​u​i​r​e​d​ ​i​f​ ​D​e​l​e​t​e​ ​A​l​l​ ​i​s​ ​n​o​t​ ​s​e​t​ ​t​o​ ​t​r​u​e​. */ longDesc: string } } } - list_tasks_lists: { + get_all_bounces: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } /** - * L​i​s​t​ ​T​a​s​k​ ​L​i​s​t​s + * G​e​t​ ​A​l​l​ ​B​o​u​n​c​e​s */ displayName: string /** - * G​e​t​ ​a​l​l​ ​t​a​s​k​ ​l​i​s​t​s​ ​f​r​o​m​ ​G​o​o​g​l​e​ ​T​a​s​k​s + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​b​o​u​n​c​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​t​a​s​k​ ​l​i​s​t​s​ ​i​n​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​a​c​c​o​u​n​t​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​p​a​g​i​n​a​t​i​o​n​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​o​u​n​c​e​d​.​ ​B​o​u​n​c​e​s​ ​o​c​c​u​r​ ​w​h​e​n​ ​a​n​ ​e​m​a​i​l​ ​c​a​n​n​o​t​ ​b​e​ ​d​e​l​i​v​e​r​e​d​ ​t​o​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​t​i​m​e​ ​r​a​n​g​e​ ​a​n​d​ ​p​a​g​i​n​a​t​e​ ​t​h​r​o​u​g​h​ ​r​e​s​u​l​t​s​. */ longDesc: string - groups: { - /** - * T​a​s​k​ ​L​i​s​t​s - */ - '0': string - } options: { - maxResults: { + startTime: { /** - * M​a​x​ ​R​e​s​u​l​t​s + * S​t​a​r​t​ ​T​i​m​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n + * F​i​l​t​e​r​ ​b​o​u​n​c​e​s​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. + * R​e​t​r​i​e​v​e​ ​b​o​u​n​c​e​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. */ longDesc: string } - nextPageToken: { + endTime: { /** - * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n + * E​n​d​ ​T​i​m​e */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * F​i​l​t​e​r​ ​b​o​u​n​c​e​s​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p */ shortDesc: string /** - * P​r​o​v​i​d​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​t​o​k​e​n​ ​f​r​o​m​ ​a​ ​p​r​e​v​i​o​u​s​ ​r​e​q​u​e​s​t​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. + * R​e​t​r​i​e​v​e​ ​b​o​u​n​c​e​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. */ longDesc: string } - } - } - update_task_list: { - /** - * U​p​d​a​t​e​ ​T​a​s​k​ ​L​i​s​t - */ - displayName: string - /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​t​a​s​k​ ​l​i​s​t​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s - */ - shortDesc: string - /** - * U​p​d​a​t​e​s​ ​t​h​e​ ​t​i​t​l​e​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​t​a​s​k​ ​l​i​s​t​ ​i​n​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​a​c​c​o​u​n​t​. - */ - longDesc: string - groups: { - /** - * T​a​s​k​ ​L​i​s​t​s - */ - '0': string - } - options: { - id: { + limit: { /** - * T​a​s​k​ ​L​i​s​t + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​u​p​d​a​t​e + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​b​o​u​n​c​e​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​b​o​u​n​c​e​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​5​0​0​. */ longDesc: string } - title: { + offset: { /** - * T​i​t​l​e + * O​f​f​s​e​t */ displayName: string /** - * T​h​e​ ​n​e​w​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t + * S​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​n​e​w​ ​t​i​t​l​e​/​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​t​a​s​k​ ​l​i​s​t​. + * T​h​e​ ​s​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. */ longDesc: string } } } - clear_completed_tasks: { + delete_bounces: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } /** - * C​l​e​a​r​ ​C​o​m​p​l​e​t​e​d​ ​T​a​s​k​s + * D​e​l​e​t​e​ ​B​o​u​n​c​e​s */ displayName: string /** - * C​l​e​a​r​ ​a​l​l​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​ ​f​r​o​m​ ​a​ ​t​a​s​k​ ​l​i​s​t + * D​e​l​e​t​e​ ​b​o​u​n​c​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​l​i​s​t */ shortDesc: string /** - * R​e​m​o​v​e​s​ ​a​l​l​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​ ​f​r​o​m​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​,​ ​h​e​l​p​i​n​g​ ​t​o​ ​k​e​e​p​ ​y​o​u​r​ ​l​i​s​t​s​ ​c​l​e​a​n​ ​a​n​d​ ​o​r​g​a​n​i​z​e​d​. + * R​e​m​o​v​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​b​o​u​n​c​e​s​ ​l​i​s​t​.​ ​Y​o​u​ ​c​a​n​ ​e​i​t​h​e​r​ ​d​e​l​e​t​e​ ​a​l​l​ ​b​o​u​n​c​e​s​ ​a​t​ ​o​n​c​e​ ​o​r​ ​s​p​e​c​i​f​y​ ​i​n​d​i​v​i​d​u​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​m​o​v​e​.​ ​D​e​l​e​t​i​n​g​ ​b​o​u​n​c​e​s​ ​a​l​l​o​w​s​ ​t​h​o​s​e​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​ ​a​g​a​i​n​. */ longDesc: string - groups: { - /** - * T​a​s​k​s - */ - '0': string - } options: { - taskList: { + deleteAll: { /** - * T​a​s​k​ ​L​i​s​t + * D​e​l​e​t​e​ ​A​l​l */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​c​l​e​a​r​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​ ​f​r​o​m + * D​e​l​e​t​e​ ​a​l​l​ ​b​o​u​n​c​e​d​ ​e​m​a​i​l​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​f​r​o​m​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​m​o​v​e​ ​a​l​l​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​. + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​d​e​l​e​t​e​ ​a​l​l​ ​b​o​u​n​c​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​f​r​o​m​ ​y​o​u​r​ ​l​i​s​t​.​ ​W​h​e​n​ ​t​r​u​e​,​ ​t​h​e​ ​e​m​a​i​l​s​ ​p​a​r​a​m​e​t​e​r​ ​i​s​ ​i​g​n​o​r​e​d​. + */ + longDesc: string + } + emails: { + /** + * E​m​a​i​l​s + */ + displayName: string + /** + * L​i​s​t​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​d​e​l​e​t​e + */ + shortDesc: string + /** + * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​b​o​u​n​c​e​s​ ​l​i​s​t​.​ ​R​e​q​u​i​r​e​d​ ​i​f​ ​D​e​l​e​t​e​ ​A​l​l​ ​i​s​ ​n​o​t​ ​s​e​t​ ​t​o​ ​t​r​u​e​. */ longDesc: string } } } - create_task: { + list_global_suppressions: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } /** - * C​r​e​a​t​e​ ​T​a​s​k + * L​i​s​t​ ​G​l​o​b​a​l​ ​S​u​p​p​r​e​s​s​i​o​n​s */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​t​a​s​k​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​g​l​o​b​a​l​l​y​ ​u​n​s​u​b​s​c​r​i​b​e​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s */ shortDesc: string /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​t​a​s​k​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​d​e​t​a​i​l​s​ ​l​i​k​e​ ​n​o​t​e​s​,​ ​d​u​e​ ​d​a​t​e​,​ ​a​n​d​ ​h​i​e​r​a​r​c​h​i​c​a​l​ ​p​o​s​i​t​i​o​n​i​n​g​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​h​a​t​ ​h​a​v​e​ ​g​l​o​b​a​l​l​y​ ​u​n​s​u​b​s​c​r​i​b​e​d​ ​f​r​o​m​ ​a​l​l​ ​o​f​ ​y​o​u​r​ ​e​m​a​i​l​s​.​ ​T​h​e​s​e​ ​a​d​d​r​e​s​s​e​s​ ​w​i​l​l​ ​n​o​t​ ​r​e​c​e​i​v​e​ ​a​n​y​ ​e​m​a​i​l​s​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​u​n​t​i​l​ ​t​h​e​y​ ​a​r​e​ ​r​e​m​o​v​e​d​ ​f​r​o​m​ ​t​h​i​s​ ​l​i​s​t​. */ longDesc: string - groups: { - /** - * T​a​s​k​s - */ - '0': string - } options: { - taskList: { + startTime: { /** - * T​a​s​k​ ​L​i​s​t + * S​t​a​r​t​ ​T​i​m​e */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​t​a​s​k​ ​t​o + * F​i​l​t​e​r​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​n​e​w​ ​t​a​s​k​. + * R​e​t​r​i​e​v​e​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. */ longDesc: string } - parent: { + endTime: { /** - * P​a​r​e​n​t​ ​T​a​s​k + * E​n​d​ ​T​i​m​e */ displayName: string /** - * T​h​e​ ​p​a​r​e​n​t​ ​t​a​s​k​ ​(​t​o​ ​c​r​e​a​t​e​ ​a​ ​s​u​b​t​a​s​k​) + * F​i​l​t​e​r​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p */ shortDesc: string /** - * S​e​l​e​c​t​ ​a​ ​p​a​r​e​n​t​ ​t​a​s​k​ ​i​f​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​i​s​ ​t​a​s​k​ ​a​s​ ​a​ ​s​u​b​t​a​s​k​ ​u​n​d​e​r​ ​a​n​o​t​h​e​r​ ​t​a​s​k​. + * R​e​t​r​i​e​v​e​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​t​h​a​t​ ​w​e​r​e​ ​c​r​e​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​p​o​i​n​t​ ​i​n​ ​t​i​m​e​.​ ​P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​ ​a​s​ ​a​ ​U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​(​s​e​c​o​n​d​s​ ​s​i​n​c​e​ ​e​p​o​c​h​)​. */ longDesc: string } - previous: { + limit: { /** - * P​r​e​v​i​o​u​s​ ​T​a​s​k + * L​i​m​i​t */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​a​f​t​e​r​ ​w​h​i​c​h​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​i​t​i​o​n​e​d + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​p​p​r​e​s​s​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​a​f​t​e​r​ ​w​h​i​c​h​ ​t​h​i​s​ ​n​e​w​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​i​t​i​o​n​e​d​ ​i​n​ ​t​h​e​ ​l​i​s​t​. + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​p​p​r​e​s​s​i​o​n​ ​r​e​c​o​r​d​s​ ​t​o​ ​r​e​t​u​r​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​5​0​0​. */ longDesc: string } - title: { + offset: { /** - * T​i​t​l​e + * O​f​f​s​e​t */ displayName: string /** - * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​t​a​s​k + * S​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​t​i​t​l​e​ ​o​r​ ​m​a​i​n​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​t​a​s​k​. + * T​h​e​ ​s​t​a​r​t​i​n​g​ ​p​o​i​n​t​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​s​u​l​t​s​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​0​. */ longDesc: string } - notes: { + } + } + get_global_suppression: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } + /** + * G​e​t​ ​a​ ​G​l​o​b​a​l​ ​S​u​p​p​r​e​s​s​i​o​n + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​g​l​o​b​a​l​l​y​ ​s​u​p​p​r​e​s​s​e​d​ ​e​m​a​i​l + */ + shortDesc: string + /** + * C​h​e​c​k​ ​i​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​i​s​ ​o​n​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​ ​a​n​d​ ​r​e​t​r​i​e​v​e​ ​i​t​s​ ​d​e​t​a​i​l​s​. + */ + longDesc: string + options: { + email: { /** - * N​o​t​e​s + * E​m​a​i​l */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​n​o​t​e​s​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​c​h​e​c​k */ shortDesc: string /** - * A​d​d​ ​a​n​y​ ​a​d​d​i​t​i​o​n​a​l​ ​n​o​t​e​s​,​ ​d​e​t​a​i​l​s​,​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​l​o​o​k​ ​u​p​ ​i​n​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​R​e​t​u​r​n​s​ ​t​h​e​ ​s​u​p​p​r​e​s​s​i​o​n​ ​d​e​t​a​i​l​s​ ​i​f​ ​f​o​u​n​d​. */ longDesc: string } - due: { + } + } + add_global_suppressions: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } + /** + * A​d​d​ ​G​l​o​b​a​l​ ​S​u​p​p​r​e​s​s​i​o​n​s + */ + displayName: string + /** + * A​d​d​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t + */ + shortDesc: string + /** + * A​d​d​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​T​h​e​s​e​ ​a​d​d​r​e​s​s​e​s​ ​w​i​l​l​ ​n​o​ ​l​o​n​g​e​r​ ​r​e​c​e​i​v​e​ ​a​n​y​ ​e​m​a​i​l​s​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​u​n​t​i​l​ ​t​h​e​y​ ​a​r​e​ ​r​e​m​o​v​e​d​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. + */ + longDesc: string + options: { + emails: { /** - * D​u​e​ ​D​a​t​e + * E​m​a​i​l​s */ displayName: string /** - * T​h​e​ ​d​u​e​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​t​a​s​k + * L​i​s​t​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​a​d​d */ shortDesc: string /** - * S​e​t​ ​a​ ​d​u​e​ ​d​a​t​e​ ​f​o​r​ ​w​h​e​n​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​c​o​m​p​l​e​t​e​d​. + * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​T​h​e​s​e​ ​a​d​d​r​e​s​s​e​s​ ​w​i​l​l​ ​b​e​ ​b​l​o​c​k​e​d​ ​f​r​o​m​ ​r​e​c​e​i​v​i​n​g​ ​a​l​l​ ​f​u​t​u​r​e​ ​e​m​a​i​l​s​. */ longDesc: string } } } - delete_task: { + delete_global_suppression: { + groups: { + /** + * S​u​p​p​r​e​s​s​i​o​n​s + */ + '0': string + } /** - * D​e​l​e​t​e​ ​T​a​s​k + * D​e​l​e​t​e​ ​a​ ​G​l​o​b​a​l​ ​S​u​p​p​r​e​s​s​i​o​n */ displayName: string /** - * D​e​l​e​t​e​ ​a​ ​t​a​s​k​ ​f​r​o​m​ ​G​o​o​g​l​e​ ​T​a​s​k​s + * R​e​m​o​v​e​ ​a​n​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​r​o​m​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t */ shortDesc: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​s​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​f​r​o​m​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​t​a​s​k​ ​l​i​s​t​. + * R​e​m​o​v​e​ ​a​n​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​r​o​m​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​T​h​i​s​ ​w​i​l​l​ ​a​l​l​o​w​ ​t​h​e​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​a​g​a​i​n​. */ longDesc: string - groups: { - /** - * T​a​s​k​s - */ - '0': string - } options: { - taskList: { + email: { /** - * T​a​s​k​ ​L​i​s​t + * E​m​a​i​l */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​a​s​k + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​m​o​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​t​a​s​k​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​g​l​o​b​a​l​ ​s​u​p​p​r​e​s​s​i​o​n​ ​l​i​s​t​.​ ​O​n​c​e​ ​r​e​m​o​v​e​d​,​ ​t​h​i​s​ ​a​d​d​r​e​s​s​ ​w​i​l​l​ ​b​e​ ​a​b​l​e​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​ ​a​g​a​i​n​. */ longDesc: string } - task: { + } + } + create_list: { + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } + /** + * C​r​e​a​t​e​ ​a​ ​L​i​s​t + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​r​e​c​i​p​i​e​n​t​ ​l​i​s​t​ ​f​o​r​ ​o​r​g​a​n​i​z​i​n​g​ ​y​o​u​r​ ​c​o​n​t​a​c​t​s​.​ ​L​i​s​t​s​ ​h​e​l​p​ ​y​o​u​ ​s​e​g​m​e​n​t​ ​y​o​u​r​ ​a​u​d​i​e​n​c​e​ ​f​o​r​ ​t​a​r​g​e​t​e​d​ ​m​a​r​k​e​t​i​n​g​ ​c​a​m​p​a​i​g​n​s​. + */ + longDesc: string + options: { + name: { /** - * T​a​s​k + * N​a​m​e */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​t​o​ ​d​e​l​e​t​e + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​n​e​w​ ​l​i​s​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​. + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​l​i​s​t​.​ ​C​h​o​o​s​e​ ​a​ ​n​a​m​e​ ​t​h​a​t​ ​c​l​e​a​r​l​y​ ​i​d​e​n​t​i​f​i​e​s​ ​t​h​e​ ​p​u​r​p​o​s​e​ ​o​r​ ​a​u​d​i​e​n​c​e​ ​o​f​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string } } } - get_task: { + get_all_lists: { + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } /** - * G​e​t​ ​T​a​s​k + * G​e​t​ ​A​l​l​ ​L​i​s​t​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k​ ​f​r​o​m​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​t​a​s​k​ ​l​i​s​t​. + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​r​e​c​i​p​i​e​n​t​ ​l​i​s​t​s​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​.​ ​R​e​t​u​r​n​s​ ​l​i​s​t​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​ ​a​n​d​ ​r​e​c​i​p​i​e​n​t​ ​c​o​u​n​t​. */ longDesc: string + options: { + } + } + delete_list: { groups: { /** - * T​a​s​k​s + * C​o​n​t​a​c​t​s */ '0': string } + /** + * D​e​l​e​t​e​ ​a​ ​L​i​s​t + */ + displayName: string + /** + * D​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t + */ + shortDesc: string + /** + * D​e​l​e​t​e​ ​a​ ​r​e​c​i​p​i​e​n​t​ ​l​i​s​t​ ​f​r​o​m​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​.​ ​Y​o​u​ ​c​a​n​ ​o​p​t​i​o​n​a​l​l​y​ ​d​e​l​e​t​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​w​i​t​h​i​n​ ​t​h​e​ ​l​i​s​t​ ​a​s​ ​w​e​l​l​. + */ + longDesc: string options: { - taskList: { + listId: { /** - * T​a​s​k​ ​L​i​s​t + * L​i​s​t​ ​I​D */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​a​s​k + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​t​a​s​k​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e​.​ ​S​e​l​e​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​e​x​i​s​t​i​n​g​ ​l​i​s​t​s​. */ longDesc: string } - task: { + deleteContacts: { /** - * T​a​s​k + * D​e​l​e​t​e​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​t​o​ ​r​e​t​r​i​e​v​e + * A​l​s​o​ ​d​e​l​e​t​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​t​h​e​ ​l​i​s​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k​ ​w​h​o​s​e​ ​d​e​t​a​i​l​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. + * W​h​e​n​ ​s​e​t​ ​t​o​ ​t​r​u​e​,​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​w​i​t​h​i​n​ ​t​h​e​ ​l​i​s​t​ ​w​i​l​l​ ​a​l​s​o​ ​b​e​ ​p​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​d​ ​f​r​o​m​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​.​ ​U​s​e​ ​w​i​t​h​ ​c​a​u​t​i​o​n​. */ longDesc: string } } } - list_tasks: { + add_or_update_contact: { + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } /** - * L​i​s​t​ ​T​a​s​k​s + * A​d​d​ ​o​r​ ​U​p​d​a​t​e​ ​a​ ​C​o​n​t​a​c​t */ displayName: string /** - * G​e​t​ ​a​l​l​ ​t​a​s​k​s​ ​f​r​o​m​ ​a​ ​t​a​s​k​ ​l​i​s​t + * A​d​d​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​o​r​ ​u​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​o​n​e */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​t​a​s​k​s​ ​f​r​o​m​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​ ​w​i​t​h​ ​v​a​r​i​o​u​s​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​ ​l​i​k​e​ ​d​u​e​ ​d​a​t​e​s​,​ ​c​o​m​p​l​e​t​i​o​n​ ​s​t​a​t​u​s​,​ ​a​n​d​ ​m​o​r​e​. + * A​d​d​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​t​o​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​ ​o​r​ ​u​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​ ​i​f​ ​t​h​e​ ​e​m​a​i​l​ ​a​l​r​e​a​d​y​ ​e​x​i​s​t​s​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​a​s​s​i​g​n​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​l​i​s​t​s​. */ longDesc: string - groups: { - /** - * T​a​s​k​s - */ - '0': string - } options: { - taskList: { + email: { /** - * T​a​s​k​ ​L​i​s​t + * E​m​a​i​l */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​g​e​t​ ​t​a​s​k​s​ ​f​r​o​m + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​f​r​o​m​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​a​s​k​s​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​.​ ​T​h​i​s​ ​i​s​ ​t​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​-​ ​i​f​ ​a​ ​c​o​n​t​a​c​t​ ​w​i​t​h​ ​t​h​i​s​ ​e​m​a​i​l​ ​e​x​i​s​t​s​,​ ​i​t​ ​w​i​l​l​ ​b​e​ ​u​p​d​a​t​e​d​. */ longDesc: string } - completedMax: { + firstName: { /** - * C​o​m​p​l​e​t​e​d​ ​M​a​x​ ​D​a​t​e + * F​i​r​s​t​ ​N​a​m​e */ displayName: string /** - * U​p​p​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​c​o​m​p​l​e​t​i​o​n​ ​d​a​t​e + * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​c​o​m​p​l​e​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​. + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​f​i​r​s​t​ ​n​a​m​e​. */ longDesc: string } - completedMin: { + lastName: { /** - * C​o​m​p​l​e​t​e​d​ ​M​i​n​ ​D​a​t​e + * L​a​s​t​ ​N​a​m​e */ displayName: string /** - * L​o​w​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​c​o​m​p​l​e​t​i​o​n​ ​d​a​t​e + * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​c​o​m​p​l​e​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​. + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​l​a​s​t​ ​n​a​m​e​. */ longDesc: string } - dueMax: { + listIds: { /** - * D​u​e​ ​M​a​x​ ​D​a​t​e + * L​i​s​t​ ​I​D​s */ displayName: string /** - * U​p​p​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​d​u​e​ ​d​a​t​e + * L​i​s​t​s​ ​t​o​ ​a​d​d​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​w​i​t​h​ ​d​u​e​ ​d​a​t​e​s​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​. + * O​n​e​ ​o​r​ ​m​o​r​e​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​a​d​d​ ​t​h​i​s​ ​c​o​n​t​a​c​t​ ​t​o​.​ ​T​h​e​ ​c​o​n​t​a​c​t​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d​ ​t​o​ ​a​l​l​ ​s​p​e​c​i​f​i​e​d​ ​l​i​s​t​s​. */ longDesc: string } - dueMin: { + customFields: { /** - * D​u​e​ ​M​i​n​ ​D​a​t​e + * C​u​s​t​o​m​ ​F​i​e​l​d​s */ displayName: string /** - * L​o​w​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​d​u​e​ ​d​a​t​e + * A​d​d​i​t​i​o​n​a​l​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​v​a​l​u​e​s */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​w​i​t​h​ ​d​u​e​ ​d​a​t​e​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​. + * A​ ​J​S​O​N​ ​o​b​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​n​a​m​e​s​ ​a​n​d​ ​v​a​l​u​e​s​.​ ​C​u​s​t​o​m​ ​f​i​e​l​d​s​ ​m​u​s​t​ ​b​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​ ​f​i​r​s​t​. */ longDesc: string } - maxResults: { + } + } + search_contacts: { + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } + /** + * S​e​a​r​c​h​ ​f​o​r​ ​C​o​n​t​a​c​t​s + */ + displayName: string + /** + * S​e​a​r​c​h​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​f​i​e​l​d​ ​v​a​l​u​e + */ + shortDesc: string + /** + * S​e​a​r​c​h​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​ ​f​o​r​ ​c​o​n​t​a​c​t​s​ ​m​a​t​c​h​i​n​g​ ​a​ ​s​p​e​c​i​f​i​c​ ​f​i​e​l​d​ ​v​a​l​u​e​.​ ​Y​o​u​ ​c​a​n​ ​s​e​a​r​c​h​ ​b​y​ ​e​m​a​i​l​,​ ​n​a​m​e​,​ ​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​. + */ + longDesc: string + options: { + fieldName: { /** - * M​a​x​ ​R​e​s​u​l​t​s + * F​i​e​l​d​ ​N​a​m​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​e​a​r​c​h​ ​o​n */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​f​i​e​l​d​ ​t​o​ ​s​e​a​r​c​h​.​ ​C​o​m​m​o​n​ ​f​i​e​l​d​s​ ​i​n​c​l​u​d​e​ ​`​e​m​a​i​l​`​,​ ​`​f​i​r​s​t​_​n​a​m​e​`​,​ ​`​l​a​s​t​_​n​a​m​e​`​,​ ​o​r​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​ ​n​a​m​e​. */ longDesc: string } - pageToken: { + value: { /** - * P​a​g​e​ ​T​o​k​e​n + * V​a​l​u​e */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * T​h​e​ ​v​a​l​u​e​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r */ shortDesc: string /** - * P​r​o​v​i​d​e​ ​t​h​e​ ​p​a​g​e​ ​t​o​k​e​n​ ​f​r​o​m​ ​a​ ​p​r​e​v​i​o​u​s​ ​r​e​q​u​e​s​t​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. + * T​h​e​ ​v​a​l​u​e​ ​t​o​ ​m​a​t​c​h​ ​a​g​a​i​n​s​t​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​f​i​e​l​d​.​ ​T​e​x​t​ ​f​i​e​l​d​s​ ​m​a​y​ ​r​e​q​u​i​r​e​ ​U​R​L​ ​e​n​c​o​d​i​n​g​. */ longDesc: string } - showCompleted: { + } + } + delete_contacts: { + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } + /** + * D​e​l​e​t​e​ ​C​o​n​t​a​c​t​s + */ + displayName: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​y​o​u​r​ ​d​a​t​a​b​a​s​e + */ + shortDesc: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. + */ + longDesc: string + options: { + contactIds: { /** - * S​h​o​w​ ​C​o​m​p​l​e​t​e​d + * C​o​n​t​a​c​t​ ​I​D​s */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s + * T​h​e​ ​I​D​s​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. + * A​n​ ​a​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​d​e​l​e​t​e​.​ ​S​e​l​e​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​.​ ​A​l​l​ ​s​e​l​e​c​t​e​d​ ​c​o​n​t​a​c​t​s​ ​w​i​l​l​ ​b​e​ ​p​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​d​. */ longDesc: string } - showDeleted: { + } + } + remove_contacts_from_list: { + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } + /** + * R​e​m​o​v​e​ ​C​o​n​t​a​c​t​s​ ​f​r​o​m​ ​L​i​s​t + */ + displayName: string + /** + * R​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t + */ + shortDesc: string + /** + * R​e​m​o​v​e​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​ ​w​i​t​h​o​u​t​ ​d​e​l​e​t​i​n​g​ ​t​h​e​m​ ​f​r​o​m​ ​y​o​u​r​ ​c​o​n​t​a​c​t​ ​d​a​t​a​b​a​s​e​.​ ​T​h​e​ ​c​o​n​t​a​c​t​s​ ​w​i​l​l​ ​r​e​m​a​i​n​ ​i​n​ ​y​o​u​r​ ​d​a​t​a​b​a​s​e​ ​b​u​t​ ​w​i​l​l​ ​n​o​ ​l​o​n​g​e​r​ ​b​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​l​i​s​t​. + */ + longDesc: string + options: { + listId: { /** - * S​h​o​w​ ​D​e​l​e​t​e​d + * L​i​s​t​ ​I​D */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​d​e​l​e​t​e​d​ ​t​a​s​k​s + * T​h​e​ ​l​i​s​t​ ​t​o​ ​r​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m */ shortDesc: string /** - * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​d​e​l​e​t​e​d​ ​t​a​s​k​s​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​f​r​o​m​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​. */ longDesc: string } - showHidden: { + contactIds: { /** - * S​h​o​w​ ​H​i​d​d​e​n + * C​o​n​t​a​c​t​ ​I​D​s */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​t​a​s​k​s + * T​h​e​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t */ shortDesc: string /** - * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​t​a​s​k​s​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. + * A​n​ ​a​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​.​ ​T​h​e​ ​c​o​n​t​a​c​t​s​ ​w​i​l​l​ ​r​e​m​a​i​n​ ​i​n​ ​y​o​u​r​ ​d​a​t​a​b​a​s​e​ ​b​u​t​ ​w​i​l​l​ ​b​e​ ​u​n​l​i​n​k​e​d​ ​f​r​o​m​ ​t​h​i​s​ ​l​i​s​t​. */ longDesc: string } - updateMin: { + } + } + validate_email: { + groups: { + /** + * D​e​l​i​v​e​r​a​b​i​l​i​t​y + */ + '0': string + } + /** + * V​a​l​i​d​a​t​e​ ​E​m​a​i​l + */ + displayName: string + /** + * V​a​l​i​d​a​t​e​ ​a​n​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​d​e​l​i​v​e​r​a​b​i​l​i​t​y + */ + shortDesc: string + /** + * C​h​e​c​k​ ​i​f​ ​a​n​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​i​s​ ​v​a​l​i​d​ ​a​n​d​ ​l​i​k​e​l​y​ ​t​o​ ​r​e​c​e​i​v​e​ ​e​m​a​i​l​s​.​ ​R​e​t​u​r​n​s​ ​a​ ​v​e​r​d​i​c​t​ ​(​V​a​l​i​d​,​ ​R​i​s​k​y​,​ ​o​r​ ​I​n​v​a​l​i​d​)​ ​a​l​o​n​g​ ​w​i​t​h​ ​d​e​t​a​i​l​e​d​ ​c​h​e​c​k​s​ ​i​n​c​l​u​d​i​n​g​ ​d​o​m​a​i​n​ ​v​a​l​i​d​i​t​y​,​ ​s​u​s​p​e​c​t​e​d​ ​d​i​s​p​o​s​a​b​l​e​ ​a​d​d​r​e​s​s​ ​d​e​t​e​c​t​i​o​n​,​ ​a​n​d​ ​b​o​u​n​c​e​ ​h​i​s​t​o​r​y​. + */ + longDesc: string + options: { + email: { /** - * U​p​d​a​t​e​d​ ​M​i​n​ ​D​a​t​e + * E​m​a​i​l */ displayName: string /** - * L​o​w​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​l​a​s​t​ ​m​o​d​i​f​i​c​a​t​i​o​n​ ​t​i​m​e + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​v​a​l​i​d​a​t​e */ shortDesc: string /** - * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​u​p​d​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​v​a​l​i​d​a​t​e​.​ ​T​h​e​ ​v​a​l​i​d​a​t​i​o​n​ ​w​i​l​l​ ​c​h​e​c​k​ ​s​y​n​t​a​x​,​ ​d​o​m​a​i​n​ ​r​e​c​o​r​d​s​,​ ​a​n​d​ ​h​i​s​t​o​r​i​c​a​l​ ​d​a​t​a​. */ longDesc: string } - showAssigned: { + source: { /** - * S​h​o​w​ ​A​s​s​i​g​n​e​d + * S​o​u​r​c​e */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​s​i​g​n​e​d​ ​t​a​s​k​s + * O​p​t​i​o​n​a​l​ ​s​o​u​r​c​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​r​a​c​k​i​n​g */ shortDesc: string /** - * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​ ​p​e​o​p​l​e​. + * A​n​ ​o​p​t​i​o​n​a​l​ ​s​o​u​r​c​e​ ​s​t​r​i​n​g​ ​t​o​ ​h​e​l​p​ ​y​o​u​ ​t​r​a​c​k​ ​w​h​e​r​e​ ​t​h​e​ ​v​a​l​i​d​a​t​i​o​n​ ​r​e​q​u​e​s​t​ ​o​r​i​g​i​n​a​t​e​d​ ​f​r​o​m​. */ longDesc: string } } } - update_task: { + send_email: { + groups: { + /** + * E​m​a​i​l + */ + '0': string + } /** - * U​p​d​a​t​e​ ​T​a​s​k + * S​e​n​d​ ​E​m​a​i​l */ displayName: string /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​t​a​s​k​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s + * S​e​n​d​ ​a​n​ ​e​m​a​i​l​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * U​p​d​a​t​e​s​ ​t​h​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​t​a​s​k​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​t​i​t​l​e​,​ ​n​o​t​e​s​,​ ​d​u​e​ ​d​a​t​e​,​ ​c​o​m​p​l​e​t​i​o​n​ ​s​t​a​t​u​s​,​ ​a​n​d​ ​h​i​e​r​a​r​c​h​i​c​a​l​ ​p​o​s​i​t​i​o​n​i​n​g​. + * S​e​n​d​ ​a​ ​t​r​a​n​s​a​c​t​i​o​n​a​l​ ​e​m​a​i​l​ ​t​o​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​r​e​c​i​p​i​e​n​t​s​.​ ​Y​o​u​ ​c​a​n​ ​s​e​n​d​ ​p​l​a​i​n​ ​t​e​x​t​,​ ​H​T​M​L​,​ ​o​r​ ​b​o​t​h​.​ ​S​u​p​p​o​r​t​s​ ​C​C​,​ ​B​C​C​,​ ​a​n​d​ ​c​u​s​t​o​m​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s​e​s​. */ longDesc: string - groups: { - /** - * T​a​s​k​s - */ - '0': string - } options: { - taskList: { + toEmail: { /** - * T​a​s​k​ ​L​i​s​t + * T​o​ ​E​m​a​i​l */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​a​s​k + * T​h​e​ ​r​e​c​i​p​i​e​n​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​t​a​s​k​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​p​r​i​m​a​r​y​ ​r​e​c​i​p​i​e​n​t​. */ longDesc: string } - task: { + toName: { /** - * T​a​s​k + * T​o​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​r​e​c​i​p​i​e​n​t​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​. + * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​ ​t​o​ ​p​e​r​s​o​n​a​l​i​z​e​ ​t​h​e​ ​'​T​o​'​ ​f​i​e​l​d​. */ longDesc: string } - parent: { + fromEmail: { /** - * P​a​r​e​n​t​ ​T​a​s​k + * F​r​o​m​ ​E​m​a​i​l */ displayName: string /** - * T​h​e​ ​p​a​r​e​n​t​ ​t​a​s​k​ ​(​t​o​ ​m​a​k​e​ ​t​h​i​s​ ​a​ ​s​u​b​t​a​s​k​) + * T​h​e​ ​s​e​n​d​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​a​ ​p​a​r​e​n​t​ ​t​a​s​k​ ​i​f​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​a​k​e​ ​t​h​i​s​ ​t​a​s​k​ ​a​ ​s​u​b​t​a​s​k​ ​u​n​d​e​r​ ​a​n​o​t​h​e​r​ ​t​a​s​k​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​w​i​l​l​ ​a​p​p​e​a​r​ ​a​s​ ​t​h​e​ ​s​e​n​d​e​r​.​ ​M​u​s​t​ ​b​e​ ​a​ ​v​e​r​i​f​i​e​d​ ​s​e​n​d​e​r​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​. */ longDesc: string } - previous: { + fromName: { /** - * P​r​e​v​i​o​u​s​ ​T​a​s​k + * F​r​o​m​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​t​a​s​k​ ​a​f​t​e​r​ ​w​h​i​c​h​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​i​t​i​o​n​e​d + * T​h​e​ ​s​e​n​d​e​r​ ​n​a​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​a​f​t​e​r​ ​w​h​i​c​h​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​i​t​i​o​n​e​d​ ​i​n​ ​t​h​e​ ​l​i​s​t​. + * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​t​o​ ​d​i​s​p​l​a​y​ ​a​s​ ​t​h​e​ ​s​e​n​d​e​r​ ​i​n​ ​t​h​e​ ​'​F​r​o​m​'​ ​f​i​e​l​d​. */ longDesc: string } - title: { + subject: { /** - * T​i​t​l​e + * S​u​b​j​e​c​t */ displayName: string /** - * T​h​e​ ​n​e​w​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​t​a​s​k + * T​h​e​ ​e​m​a​i​l​ ​s​u​b​j​e​c​t​ ​l​i​n​e */ shortDesc: string /** - * E​n​t​e​r​ ​t​h​e​ ​n​e​w​ ​t​i​t​l​e​ ​o​r​ ​m​a​i​n​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k​. + * T​h​e​ ​s​u​b​j​e​c​t​ ​l​i​n​e​ ​o​f​ ​t​h​e​ ​e​m​a​i​l​. */ longDesc: string } - notes: { + textContent: { /** - * N​o​t​e​s + * T​e​x​t​ ​C​o​n​t​e​n​t */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​n​o​t​e​s​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k + * P​l​a​i​n​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​e​m​a​i​l */ shortDesc: string /** - * U​p​d​a​t​e​ ​a​n​y​ ​a​d​d​i​t​i​o​n​a​l​ ​n​o​t​e​s​,​ ​d​e​t​a​i​l​s​,​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k​. + * T​h​e​ ​p​l​a​i​n​ ​t​e​x​t​ ​v​e​r​s​i​o​n​ ​o​f​ ​t​h​e​ ​e​m​a​i​l​ ​c​o​n​t​e​n​t​.​ ​E​i​t​h​e​r​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​r​ ​H​T​M​L​ ​c​o​n​t​e​n​t​ ​(​o​r​ ​b​o​t​h​)​ ​m​u​s​t​ ​b​e​ ​p​r​o​v​i​d​e​d​. */ longDesc: string } - due: { + htmlContent: { /** - * D​u​e​ ​D​a​t​e + * H​T​M​L​ ​C​o​n​t​e​n​t */ displayName: string /** - * T​h​e​ ​d​u​e​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​t​a​s​k + * H​T​M​L​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​e​m​a​i​l */ shortDesc: string /** - * S​e​t​ ​o​r​ ​u​p​d​a​t​e​ ​t​h​e​ ​d​u​e​ ​d​a​t​e​ ​f​o​r​ ​w​h​e​n​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​c​o​m​p​l​e​t​e​d​. + * T​h​e​ ​H​T​M​L​ ​v​e​r​s​i​o​n​ ​o​f​ ​t​h​e​ ​e​m​a​i​l​ ​c​o​n​t​e​n​t​.​ ​E​i​t​h​e​r​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​r​ ​H​T​M​L​ ​c​o​n​t​e​n​t​ ​(​o​r​ ​b​o​t​h​)​ ​m​u​s​t​ ​b​e​ ​p​r​o​v​i​d​e​d​. */ longDesc: string } - status: { + replyToEmail: { /** - * S​t​a​t​u​s + * R​e​p​l​y​-​T​o​ ​E​m​a​i​l */ displayName: string /** - * T​h​e​ ​c​o​m​p​l​e​t​i​o​n​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​t​a​s​k + * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​r​e​p​l​i​e​s */ shortDesc: string /** - * S​e​t​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​t​a​s​k​ ​i​s​ ​i​n​c​o​m​p​l​e​t​e​ ​(​n​e​e​d​s​ ​a​c​t​i​o​n​)​ ​o​r​ ​c​o​m​p​l​e​t​e​d​. + * O​p​t​i​o​n​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​r​e​c​i​p​i​e​n​t​s​ ​s​h​o​u​l​d​ ​r​e​p​l​y​ ​t​o​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​r​e​p​l​i​e​s​ ​w​i​l​l​ ​g​o​ ​t​o​ ​t​h​e​ ​s​e​n​d​e​r​ ​a​d​d​r​e​s​s​. */ longDesc: string } - } - } - } - } - PayPal: { - /** - * P​a​y​P​a​l - */ - displayName: string - groups: { - /** - * P​a​y​m​e​n​t​ ​P​r​o​c​e​s​s​i​n​g - */ - '0': string - } - /** - * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​P​a​y​P​a​l​ ​t​o​ ​m​a​n​a​g​e​ ​p​a​y​m​e​n​t​s​,​ ​o​r​d​e​r​s​,​ ​i​n​v​o​i​c​e​s​,​ ​d​i​s​p​u​t​e​s​,​ ​a​n​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​h​r​o​u​g​h​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​A​P​I​s​. - */ - shortDesc: string - /** - * T​h​e​ ​P​a​y​P​a​l​ ​i​n​t​e​g​r​a​t​i​o​n​ ​p​r​o​v​i​d​e​s​ ​c​o​m​p​l​e​t​e​ ​a​c​c​e​s​s​ ​t​o​ ​P​a​y​P​a​l​'​s​ ​R​E​S​T​ ​A​P​I​s​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​e​-​c​o​m​m​e​r​c​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​.​ ​C​r​e​a​t​e​ ​a​n​d​ ​c​a​p​t​u​r​e​ ​o​r​d​e​r​s​,​ ​p​r​o​c​e​s​s​ ​p​a​y​m​e​n​t​s​ ​a​n​d​ ​r​e​f​u​n​d​s​,​ ​m​a​n​a​g​e​ ​i​n​v​o​i​c​e​s​ ​a​n​d​ ​b​i​l​l​i​n​g​,​ ​h​a​n​d​l​e​ ​c​u​s​t​o​m​e​r​ ​d​i​s​p​u​t​e​s​,​ ​s​e​t​ ​u​p​ ​r​e​c​u​r​r​i​n​g​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​,​ ​a​n​d​ ​r​e​c​e​i​v​e​ ​r​e​a​l​-​t​i​m​e​ ​w​e​b​h​o​o​k​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​.​ ​P​e​r​f​e​c​t​ ​f​o​r​ ​b​u​s​i​n​e​s​s​e​s​ ​o​f​ ​a​l​l​ ​s​i​z​e​s​ ​l​o​o​k​i​n​g​ ​t​o​ ​a​c​c​e​p​t​ ​p​a​y​m​e​n​t​s​ ​s​e​c​u​r​e​l​y​ ​a​n​d​ ​e​f​f​i​c​i​e​n​t​l​y​. - */ - longDesc: string - actions: { - create_order: { - /** - * C​r​e​a​t​e​ ​O​r​d​e​r - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​a​y​m​e​n​t​ ​o​r​d​e​r​ ​w​i​t​h​ ​p​u​r​c​h​a​s​e​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​P​a​y​P​a​l​ ​o​r​d​e​r​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​p​a​y​m​e​n​t​ ​a​m​o​u​n​t​,​ ​i​t​e​m​s​,​ ​s​h​i​p​p​i​n​g​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​p​r​e​f​e​r​e​n​c​e​s​.​ ​O​r​d​e​r​s​ ​r​e​p​r​e​s​e​n​t​ ​a​ ​p​a​y​m​e​n​t​ ​b​e​t​w​e​e​n​ ​t​w​o​ ​o​r​ ​m​o​r​e​ ​p​a​r​t​i​e​s​ ​a​n​d​ ​c​a​n​ ​b​e​ ​a​u​t​h​o​r​i​z​e​d​ ​i​m​m​e​d​i​a​t​e​l​y​ ​o​r​ ​c​a​p​t​u​r​e​d​ ​l​a​t​e​r​.​ ​S​u​p​p​o​r​t​s​ ​v​a​r​i​o​u​s​ ​p​a​y​m​e​n​t​ ​s​o​u​r​c​e​s​ ​i​n​c​l​u​d​i​n​g​ ​P​a​y​P​a​l​,​ ​c​a​r​d​s​,​ ​a​n​d​ ​a​l​t​e​r​n​a​t​i​v​e​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​s​. - */ - longDesc: string - options: { - intent: { + replyToName: { /** - * P​a​y​m​e​n​t​ ​I​n​t​e​n​t + * R​e​p​l​y​-​T​o​ ​N​a​m​e */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​o​ ​c​a​p​t​u​r​e​ ​p​a​y​m​e​n​t​ ​i​m​m​e​d​i​a​t​e​l​y​ ​o​r​ ​a​u​t​h​o​r​i​z​e​ ​f​o​r​ ​l​a​t​e​r​ ​c​a​p​t​u​r​e + * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * D​e​t​e​r​m​i​n​e​s​ ​w​h​e​n​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​w​i​l​l​ ​b​e​ ​p​r​o​c​e​s​s​e​d​.​ ​C​A​P​T​U​R​E​ ​p​r​o​c​e​s​s​e​s​ ​p​a​y​m​e​n​t​ ​i​m​m​e​d​i​a​t​e​l​y​ ​a​f​t​e​r​ ​a​p​p​r​o​v​a​l​,​ ​w​h​i​l​e​ ​A​U​T​H​O​R​I​Z​E​ ​p​l​a​c​e​s​ ​a​ ​h​o​l​d​ ​o​n​ ​f​u​n​d​s​ ​f​o​r​ ​u​p​ ​t​o​ ​2​9​ ​d​a​y​s​,​ ​a​l​l​o​w​i​n​g​ ​y​o​u​ ​t​o​ ​c​a​p​t​u​r​e​ ​p​a​y​m​e​n​t​ ​w​h​e​n​ ​r​e​a​d​y​ ​t​o​ ​f​u​l​f​i​l​l​ ​t​h​e​ ​o​r​d​e​r​. + * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​t​o​ ​d​i​s​p​l​a​y​ ​f​o​r​ ​t​h​e​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s​. */ longDesc: string } - currency_code: { + ccEmails: { /** - * C​u​r​r​e​n​c​y​ ​C​o​d​e + * C​C​ ​E​m​a​i​l​s */ displayName: string /** - * T​h​r​e​e​-​l​e​t​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n + * C​a​r​b​o​n​ ​c​o​p​y​ ​r​e​c​i​p​i​e​n​t​s */ shortDesc: string /** - * T​h​e​ ​t​h​r​e​e​-​c​h​a​r​a​c​t​e​r​ ​I​S​O​-​4​2​1​7​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​t​h​a​t​ ​i​d​e​n​t​i​f​i​e​s​ ​t​h​e​ ​c​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​.​ ​M​u​s​t​ ​b​e​ ​s​u​p​p​o​r​t​e​d​ ​b​y​ ​P​a​y​P​a​l​ ​a​n​d​ ​m​a​t​c​h​ ​y​o​u​r​ ​b​u​s​i​n​e​s​s​ ​a​c​c​o​u​n​t​ ​s​e​t​t​i​n​g​s​. + * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​ ​C​C​ ​r​e​c​i​p​i​e​n​t​s​. */ longDesc: string } - total_amount: { + bccEmails: { /** - * T​o​t​a​l​ ​A​m​o​u​n​t + * B​C​C​ ​E​m​a​i​l​s */ displayName: string /** - * T​o​t​a​l​ ​p​a​y​m​e​n​t​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g + * B​l​i​n​d​ ​c​a​r​b​o​n​ ​c​o​p​y​ ​r​e​c​i​p​i​e​n​t​s */ shortDesc: string /** - * T​h​e​ ​t​o​t​a​l​ ​a​m​o​u​n​t​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​M​u​s​t​ ​b​e​ ​a​ ​p​o​s​i​t​i​v​e​ ​n​u​m​b​e​r​ ​a​n​d​ ​m​a​t​c​h​ ​t​h​e​ ​s​u​m​ ​o​f​ ​a​l​l​ ​b​r​e​a​k​d​o​w​n​ ​c​o​m​p​o​n​e​n​t​s​ ​i​f​ ​p​r​o​v​i​d​e​d​.​ ​F​o​r​m​a​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​ ​w​i​t​h​ ​a​p​p​r​o​p​r​i​a​t​e​ ​d​e​c​i​m​a​l​ ​p​r​e​c​i​s​i​o​n​ ​f​o​r​ ​t​h​e​ ​c​u​r​r​e​n​c​y​. + * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​ ​B​C​C​ ​r​e​c​i​p​i​e​n​t​s​. */ longDesc: string } - item_total: { + } + } + send_template_email: { + groups: { + /** + * E​m​a​i​l + */ + '0': string + } + /** + * S​e​n​d​ ​T​e​m​p​l​a​t​e​ ​E​m​a​i​l + */ + displayName: string + /** + * S​e​n​d​ ​a​n​ ​e​m​a​i​l​ ​m​e​s​s​a​g​e​ ​u​s​i​n​g​ ​a​ ​S​e​n​d​G​r​i​d​ ​t​e​m​p​l​a​t​e + */ + shortDesc: string + /** + * S​e​n​d​ ​a​ ​t​r​a​n​s​a​c​t​i​o​n​a​l​ ​e​m​a​i​l​ ​u​s​i​n​g​ ​a​ ​p​r​e​d​e​f​i​n​e​d​ ​S​e​n​d​G​r​i​d​ ​d​y​n​a​m​i​c​ ​t​e​m​p​l​a​t​e​.​ ​C​u​s​t​o​m​i​z​e​ ​t​h​e​ ​e​m​a​i​l​ ​c​o​n​t​e​n​t​ ​b​y​ ​p​r​o​v​i​d​i​n​g​ ​d​y​n​a​m​i​c​ ​t​e​m​p​l​a​t​e​ ​d​a​t​a​ ​f​o​r​ ​p​e​r​s​o​n​a​l​i​z​a​t​i​o​n​. + */ + longDesc: string + options: { + toEmail: { /** - * I​t​e​m​ ​T​o​t​a​l + * T​o​ ​E​m​a​i​l */ displayName: string /** - * T​o​t​a​l​ ​c​o​s​t​ ​o​f​ ​a​l​l​ ​i​t​e​m​s​ ​b​e​f​o​r​e​ ​t​a​x​e​s​ ​a​n​d​ ​f​e​e​s + * T​h​e​ ​r​e​c​i​p​i​e​n​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * T​h​e​ ​t​o​t​a​l​ ​c​o​s​t​ ​o​f​ ​a​l​l​ ​i​t​e​m​s​ ​i​n​ ​t​h​e​ ​o​r​d​e​r​ ​b​e​f​o​r​e​ ​a​p​p​l​y​i​n​g​ ​t​a​x​e​s​,​ ​s​h​i​p​p​i​n​g​,​ ​h​a​n​d​l​i​n​g​,​ ​i​n​s​u​r​a​n​c​e​,​ ​o​r​ ​d​i​s​c​o​u​n​t​s​.​ ​S​h​o​u​l​d​ ​e​q​u​a​l​ ​t​h​e​ ​s​u​m​ ​o​f​ ​(​q​u​a​n​t​i​t​y​ ​×​ ​u​n​i​t​_​a​m​o​u​n​t​)​ ​f​o​r​ ​a​l​l​ ​i​t​e​m​s​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​p​r​i​m​a​r​y​ ​r​e​c​i​p​i​e​n​t​. */ longDesc: string } - shipping_amount: { + toName: { /** - * S​h​i​p​p​i​n​g​ ​A​m​o​u​n​t - */ - displayName: string - /** - * C​o​s​t​ ​o​f​ ​s​h​i​p​p​i​n​g​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r - */ - shortDesc: string - /** - * T​h​e​ ​s​h​i​p​p​i​n​g​ ​c​o​s​t​ ​f​o​r​ ​d​e​l​i​v​e​r​i​n​g​ ​t​h​e​ ​i​t​e​m​s​ ​i​n​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​T​h​i​s​ ​a​m​o​u​n​t​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​t​o​t​a​l​ ​o​r​d​e​r​ ​a​m​o​u​n​t​. - */ - longDesc: string - } - handling_amount: { - /** - * H​a​n​d​l​i​n​g​ ​A​m​o​u​n​t + * T​o​ ​N​a​m​e */ displayName: string /** - * H​a​n​d​l​i​n​g​ ​f​e​e​ ​f​o​r​ ​p​r​o​c​e​s​s​i​n​g​ ​t​h​i​s​ ​o​r​d​e​r + * T​h​e​ ​r​e​c​i​p​i​e​n​t​ ​n​a​m​e */ shortDesc: string /** - * A​d​d​i​t​i​o​n​a​l​ ​h​a​n​d​l​i​n​g​ ​f​e​e​ ​c​h​a​r​g​e​d​ ​f​o​r​ ​p​r​o​c​e​s​s​i​n​g​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​T​h​i​s​ ​c​o​v​e​r​s​ ​c​o​s​t​s​ ​l​i​k​e​ ​p​a​c​k​a​g​i​n​g​ ​a​n​d​ ​o​r​d​e​r​ ​p​r​o​c​e​s​s​i​n​g​. + * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​ ​t​o​ ​p​e​r​s​o​n​a​l​i​z​e​ ​t​h​e​ ​'​T​o​'​ ​f​i​e​l​d​. */ longDesc: string } - tax_total: { + fromEmail: { /** - * T​a​x​ ​T​o​t​a​l + * F​r​o​m​ ​E​m​a​i​l */ displayName: string /** - * T​o​t​a​l​ ​t​a​x​ ​a​m​o​u​n​t​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r + * T​h​e​ ​s​e​n​d​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * T​h​e​ ​t​o​t​a​l​ ​t​a​x​ ​a​m​o​u​n​t​ ​f​o​r​ ​a​l​l​ ​i​t​e​m​s​ ​i​n​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​T​h​i​s​ ​i​n​c​l​u​d​e​s​ ​s​a​l​e​s​ ​t​a​x​,​ ​V​A​T​,​ ​o​r​ ​o​t​h​e​r​ ​a​p​p​l​i​c​a​b​l​e​ ​t​a​x​e​s​ ​b​a​s​e​d​ ​o​n​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​ ​a​n​d​ ​l​o​c​a​l​ ​r​e​g​u​l​a​t​i​o​n​s​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​w​i​l​l​ ​a​p​p​e​a​r​ ​a​s​ ​t​h​e​ ​s​e​n​d​e​r​.​ ​M​u​s​t​ ​b​e​ ​a​ ​v​e​r​i​f​i​e​d​ ​s​e​n​d​e​r​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​. */ longDesc: string } - insurance_amount: { + fromName: { /** - * I​n​s​u​r​a​n​c​e​ ​A​m​o​u​n​t + * F​r​o​m​ ​N​a​m​e */ displayName: string /** - * I​n​s​u​r​a​n​c​e​ ​c​o​s​t​ ​f​o​r​ ​t​h​i​s​ ​s​h​i​p​m​e​n​t + * T​h​e​ ​s​e​n​d​e​r​ ​n​a​m​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​i​n​s​u​r​a​n​c​e​ ​a​m​o​u​n​t​ ​t​o​ ​p​r​o​t​e​c​t​ ​t​h​e​ ​s​h​i​p​m​e​n​t​.​ ​T​h​i​s​ ​c​o​v​e​r​s​ ​t​h​e​ ​v​a​l​u​e​ ​o​f​ ​i​t​e​m​s​ ​i​n​ ​c​a​s​e​ ​o​f​ ​l​o​s​s​ ​o​r​ ​d​a​m​a​g​e​ ​d​u​r​i​n​g​ ​s​h​i​p​p​i​n​g​. + * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​t​o​ ​d​i​s​p​l​a​y​ ​a​s​ ​t​h​e​ ​s​e​n​d​e​r​ ​i​n​ ​t​h​e​ ​'​F​r​o​m​'​ ​f​i​e​l​d​. */ longDesc: string } - shipping_discount: { + replyToEmail: { /** - * S​h​i​p​p​i​n​g​ ​D​i​s​c​o​u​n​t + * R​e​p​l​y​-​T​o​ ​E​m​a​i​l */ displayName: string /** - * D​i​s​c​o​u​n​t​ ​a​p​p​l​i​e​d​ ​t​o​ ​s​h​i​p​p​i​n​g​ ​c​o​s​t​s + * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​r​e​p​l​i​e​s */ shortDesc: string /** - * A​n​y​ ​d​i​s​c​o​u​n​t​ ​a​p​p​l​i​e​d​ ​s​p​e​c​i​f​i​c​a​l​l​y​ ​t​o​ ​s​h​i​p​p​i​n​g​ ​c​o​s​t​s​,​ ​s​u​c​h​ ​a​s​ ​f​r​e​e​ ​s​h​i​p​p​i​n​g​ ​p​r​o​m​o​t​i​o​n​s​ ​o​r​ ​r​e​d​u​c​e​d​ ​s​h​i​p​p​i​n​g​ ​f​e​e​s​ ​f​o​r​ ​b​u​l​k​ ​o​r​d​e​r​s​. + * O​p​t​i​o​n​a​l​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​h​a​t​ ​r​e​c​i​p​i​e​n​t​s​ ​s​h​o​u​l​d​ ​r​e​p​l​y​ ​t​o​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​r​e​p​l​i​e​s​ ​w​i​l​l​ ​g​o​ ​t​o​ ​t​h​e​ ​s​e​n​d​e​r​ ​a​d​d​r​e​s​s​. */ longDesc: string } - discount_amount: { + replyToName: { /** - * D​i​s​c​o​u​n​t​ ​A​m​o​u​n​t + * R​e​p​l​y​-​T​o​ ​N​a​m​e */ displayName: string /** - * T​o​t​a​l​ ​d​i​s​c​o​u​n​t​ ​a​p​p​l​i​e​d​ ​t​o​ ​t​h​e​ ​o​r​d​e​r + * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * T​h​e​ ​t​o​t​a​l​ ​d​i​s​c​o​u​n​t​ ​a​m​o​u​n​t​ ​a​p​p​l​i​e​d​ ​t​o​ ​t​h​i​s​ ​o​r​d​e​r​,​ ​i​n​c​l​u​d​i​n​g​ ​c​o​u​p​o​n​ ​c​o​d​e​s​,​ ​p​r​o​m​o​t​i​o​n​s​,​ ​o​r​ ​b​u​l​k​ ​d​i​s​c​o​u​n​t​s​.​ ​T​h​i​s​ ​r​e​d​u​c​e​s​ ​t​h​e​ ​o​v​e​r​a​l​l​ ​o​r​d​e​r​ ​t​o​t​a​l​. + * O​p​t​i​o​n​a​l​ ​n​a​m​e​ ​t​o​ ​d​i​s​p​l​a​y​ ​f​o​r​ ​t​h​e​ ​r​e​p​l​y​-​t​o​ ​a​d​d​r​e​s​s​. */ longDesc: string } - payee_email: { + ccEmails: { /** - * P​a​y​e​e​ ​E​m​a​i​l + * C​C​ ​E​m​a​i​l​s */ displayName: string /** - * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​r​e​c​i​p​i​e​n​t + * C​a​r​b​o​n​ ​c​o​p​y​ ​r​e​c​i​p​i​e​n​t​s */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​m​e​r​c​h​a​n​t​ ​o​r​ ​s​e​l​l​e​r​ ​w​h​o​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​a​y​m​e​n​t​.​ ​R​e​q​u​i​r​e​d​ ​f​o​r​ ​m​a​r​k​e​t​p​l​a​c​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​o​r​ ​w​h​e​n​ ​s​p​e​c​i​f​y​i​n​g​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​r​e​c​i​p​i​e​n​t​. + * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​ ​C​C​ ​r​e​c​i​p​i​e​n​t​s​. */ longDesc: string } - payee_merchant_id: { + bccEmails: { /** - * P​a​y​e​e​ ​M​e​r​c​h​a​n​t​ ​I​D + * B​C​C​ ​E​m​a​i​l​s */ displayName: string /** - * P​a​y​P​a​l​ ​m​e​r​c​h​a​n​t​ ​I​D​ ​o​f​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​r​e​c​i​p​i​e​n​t + * B​l​i​n​d​ ​c​a​r​b​o​n​ ​c​o​p​y​ ​r​e​c​i​p​i​e​n​t​s */ shortDesc: string /** - * T​h​e​ ​P​a​y​P​a​l​ ​m​e​r​c​h​a​n​t​ ​I​D​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​a​y​m​e​n​t​.​ ​U​s​e​d​ ​f​o​r​ ​m​a​r​k​e​t​p​l​a​c​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​o​r​ ​w​h​e​n​ ​r​o​u​t​i​n​g​ ​p​a​y​m​e​n​t​s​ ​t​o​ ​s​p​e​c​i​f​i​c​ ​m​e​r​c​h​a​n​t​s​. + * A​n​ ​a​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​ ​B​C​C​ ​r​e​c​i​p​i​e​n​t​s​. */ longDesc: string } - description: { + templateId: { /** - * O​r​d​e​r​ ​D​e​s​c​r​i​p​t​i​o​n + * T​e​m​p​l​a​t​e​ ​I​D */ displayName: string /** - * D​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​o​r​ ​p​u​r​c​h​a​s​e + * T​h​e​ ​S​e​n​d​G​r​i​d​ ​t​e​m​p​l​a​t​e​ ​t​o​ ​u​s​e */ shortDesc: string /** - * A​ ​b​r​i​e​f​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​v​i​s​i​b​l​e​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​d​u​r​i​n​g​ ​c​h​e​c​k​o​u​t​ ​a​n​d​ ​i​n​ ​t​h​e​i​r​ ​t​r​a​n​s​a​c​t​i​o​n​ ​h​i​s​t​o​r​y​. + * S​e​l​e​c​t​ ​t​h​e​ ​d​y​n​a​m​i​c​ ​t​e​m​p​l​a​t​e​ ​t​o​ ​u​s​e​ ​f​o​r​ ​t​h​i​s​ ​e​m​a​i​l​.​ ​T​h​e​ ​t​e​m​p​l​a​t​e​ ​m​u​s​t​ ​b​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​y​o​u​r​ ​S​e​n​d​G​r​i​d​ ​a​c​c​o​u​n​t​. */ longDesc: string } - custom_id: { + values: { /** - * C​u​s​t​o​m​ ​I​D + * T​e​m​p​l​a​t​e​ ​V​a​l​u​e​s */ displayName: string /** - * Y​o​u​r​ ​c​u​s​t​o​m​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r + * D​y​n​a​m​i​c​ ​d​a​t​a​ ​f​o​r​ ​t​e​m​p​l​a​t​e​ ​p​e​r​s​o​n​a​l​i​z​a​t​i​o​n */ shortDesc: string /** - * A​ ​c​u​s​t​o​m​ ​i​d​e​n​t​i​f​i​e​r​ ​t​h​a​t​ ​y​o​u​ ​c​a​n​ ​u​s​e​ ​t​o​ ​t​r​a​c​k​ ​t​h​i​s​ ​o​r​d​e​r​ ​i​n​ ​y​o​u​r​ ​o​w​n​ ​s​y​s​t​e​m​s​.​ ​T​h​i​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​ ​i​n​ ​w​e​b​h​o​o​k​s​ ​a​n​d​ ​A​P​I​ ​r​e​s​p​o​n​s​e​s​. + * A​ ​J​S​O​N​ ​o​b​j​e​c​t​ ​c​o​n​t​a​i​n​i​n​g​ ​k​e​y​-​v​a​l​u​e​ ​p​a​i​r​s​ ​f​o​r​ ​d​y​n​a​m​i​c​ ​t​e​m​p​l​a​t​e​ ​d​a​t​a​.​ ​T​h​e​s​e​ ​v​a​l​u​e​s​ ​w​i​l​l​ ​r​e​p​l​a​c​e​ ​t​h​e​ ​c​o​r​r​e​s​p​o​n​d​i​n​g​ ​p​l​a​c​e​h​o​l​d​e​r​s​ ​i​n​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​t​e​m​p​l​a​t​e​. */ longDesc: string } - invoice_id: { + } + } + } + } + Brevo: { + /** + * B​r​e​v​o + */ + displayName: string + groups: { + /** + * E​m​a​i​l​ ​&​ ​E​m​a​i​l​ ​M​a​r​k​e​t​i​n​g + */ + '0': string + } + /** + * B​r​e​v​o​ ​i​s​ ​a​ ​m​a​r​k​e​t​i​n​g​ ​p​l​a​t​f​o​r​m​ ​f​o​r​ ​e​m​a​i​l​,​ ​S​M​S​,​ ​a​n​d​ ​a​u​t​o​m​a​t​i​o​n​ ​c​a​m​p​a​i​g​n​s​. + */ + shortDesc: string + /** + * B​r​e​v​o​ ​(​f​o​r​m​e​r​l​y​ ​S​e​n​d​i​n​b​l​u​e​)​ ​i​s​ ​a​ ​m​a​r​k​e​t​i​n​g​ ​a​u​t​o​m​a​t​i​o​n​ ​p​l​a​t​f​o​r​m​ ​t​h​a​t​ ​e​n​a​b​l​e​s​ ​b​u​s​i​n​e​s​s​e​s​ ​t​o​ ​c​o​m​m​u​n​i​c​a​t​e​ ​w​i​t​h​ ​c​u​s​t​o​m​e​r​s​ ​t​h​r​o​u​g​h​ ​e​m​a​i​l​,​ ​S​M​S​,​ ​c​h​a​t​,​ ​a​n​d​ ​m​o​r​e​.​ ​I​t​ ​o​f​f​e​r​s​ ​t​o​o​l​s​ ​f​o​r​ ​c​a​m​p​a​i​g​n​ ​m​a​n​a​g​e​m​e​n​t​,​ ​c​o​n​t​a​c​t​ ​s​e​g​m​e​n​t​a​t​i​o​n​,​ ​t​r​a​n​s​a​c​t​i​o​n​a​l​ ​e​m​a​i​l​s​,​ ​a​n​d​ ​c​u​s​t​o​m​e​r​ ​r​e​l​a​t​i​o​n​s​h​i​p​ ​m​a​n​a​g​e​m​e​n​t​.​ ​B​r​e​v​o​ ​h​e​l​p​s​ ​b​u​s​i​n​e​s​s​e​s​ ​b​u​i​l​d​ ​s​t​r​o​n​g​e​r​ ​r​e​l​a​t​i​o​n​s​h​i​p​s​ ​w​i​t​h​ ​t​h​e​i​r​ ​a​u​d​i​e​n​c​e​ ​b​y​ ​p​r​o​v​i​d​i​n​g​ ​s​c​a​l​a​b​l​e​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​ ​a​n​d​ ​a​u​t​o​m​a​t​i​o​n​ ​s​o​l​u​t​i​o​n​s​. + */ + longDesc: string + connectionMessage: { + /** + * C​o​n​n​e​c​t​ ​t​o​ ​B​r​e​v​o + */ + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​P​I​ ​K​e​y​*​*​.​ + ​ + ​#​#​ ​G​e​t​t​i​n​g​ ​Y​o​u​r​ ​A​P​I​ ​K​e​y​ + ​ + ​1​.​ ​S​i​g​n​ ​i​n​ ​t​o​ ​y​o​u​r​ ​[​B​r​e​v​o​ ​a​c​c​o​u​n​t​]​(​h​t​t​p​s​:​/​/​a​p​p​.​b​r​e​v​o​.​c​o​m​/​)​ + ​2​.​ ​N​a​v​i​g​a​t​e​ ​t​o​ ​*​*​S​e​t​t​i​n​g​s​*​*​ ​→​ ​*​*​S​M​T​P​ ​&​ ​A​P​I​*​*​ ​→​ ​*​*​A​P​I​ ​K​e​y​s​*​*​ + ​3​.​ ​C​l​i​c​k​ ​*​*​G​e​n​e​r​a​t​e​ ​a​ ​n​e​w​ ​A​P​I​ ​k​e​y​*​*​ + ​4​.​ ​G​i​v​e​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​a​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​(​e​.​g​.​,​ ​"​Q​o​r​e​ ​I​n​t​e​g​r​a​t​i​o​n​"​)​ + ​5​.​ ​C​o​p​y​ ​t​h​e​ ​g​e​n​e​r​a​t​e​d​ ​A​P​I​ ​k​e​y​ ​i​m​m​e​d​i​a​t​e​l​y​ ​(​i​t​ ​w​o​n​'​t​ ​b​e​ ​s​h​o​w​n​ ​a​g​a​i​n​)​ + ​ + ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​a​c​c​e​s​s​ ​t​h​e​ ​A​P​I​ ​k​e​y​s​ ​p​a​g​e​ ​d​i​r​e​c​t​l​y​ ​a​t​ ​[​a​p​p​.​b​r​e​v​o​.​c​o​m​/​s​e​t​t​i​n​g​s​/​k​e​y​s​/​a​p​i​]​(​h​t​t​p​s​:​/​/​a​p​p​.​b​r​e​v​o​.​c​o​m​/​s​e​t​t​i​n​g​s​/​k​e​y​s​/​a​p​i​)​ + ​ + ​#​#​ ​C​o​n​n​e​c​t​i​o​n​ ​D​e​t​a​i​l​s​ + ​ + ​#​#​#​ ​A​P​I​ ​K​e​y​ + ​Y​o​u​r​ ​B​r​e​v​o​ ​A​P​I​ ​k​e​y​ ​s​t​a​r​t​i​n​g​ ​w​i​t​h​ ​`​x​k​e​y​s​i​b​-​`​.​ ​T​h​i​s​ ​k​e​y​ ​a​u​t​h​e​n​t​i​c​a​t​e​s​ ​a​l​l​ ​A​P​I​ ​r​e​q​u​e​s​t​s​ ​t​o​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​.​ + ​ + ​*​*​N​o​t​e​:​*​*​ ​K​e​e​p​ ​y​o​u​r​ ​A​P​I​ ​k​e​y​ ​s​e​c​u​r​e​ ​a​n​d​ ​n​e​v​e​r​ ​s​h​a​r​e​ ​i​t​ ​p​u​b​l​i​c​l​y​.​ ​Y​o​u​ ​c​a​n​ ​r​e​v​o​k​e​ ​a​n​d​ ​r​e​g​e​n​e​r​a​t​e​ ​k​e​y​s​ ​a​t​ ​a​n​y​ ​t​i​m​e​ ​f​r​o​m​ ​t​h​e​ ​A​P​I​ ​K​e​y​s​ ​s​e​t​t​i​n​g​s​ ​p​a​g​e​. + */ + content: string + } + actions: { + get_contact: { + /** + * G​e​t​ ​C​o​n​t​a​c​t + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​c​o​n​t​a​c​t​ ​b​y​ ​i​d​e​n​t​i​f​i​e​r + */ + shortDesc: string + /** + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​.​ ​Y​o​u​ ​c​a​n​ ​i​d​e​n​t​i​f​y​ ​c​o​n​t​a​c​t​s​ ​u​s​i​n​g​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​c​o​n​t​a​c​t​ ​I​D​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​e​x​t​e​r​n​a​l​ ​I​D​,​ ​W​h​a​t​s​A​p​p​ ​I​D​,​ ​o​r​ ​l​a​n​d​l​i​n​e​ ​n​u​m​b​e​r​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } + options: { + identifier: { /** - * I​n​v​o​i​c​e​ ​I​D + * C​o​n​t​a​c​t​ ​I​d​e​n​t​i​f​i​e​r */ displayName: string /** - * I​n​v​o​i​c​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r + * C​o​n​t​a​c​t​ ​i​d​e​n​t​i​f​i​e​r​ ​(​e​m​a​i​l​,​ ​I​D​,​ ​p​h​o​n​e​,​ ​e​t​c​.​) */ shortDesc: string /** - * T​h​e​ ​i​n​v​o​i​c​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​H​e​l​p​s​ ​m​a​t​c​h​ ​o​r​d​e​r​s​ ​w​i​t​h​ ​y​o​u​r​ ​a​c​c​o​u​n​t​i​n​g​ ​s​y​s​t​e​m​ ​a​n​d​ ​p​r​e​v​e​n​t​s​ ​d​u​p​l​i​c​a​t​e​ ​p​a​y​m​e​n​t​s​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​.​ ​C​a​n​ ​b​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​c​o​n​t​a​c​t​ ​I​D​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​(​S​M​S​)​,​ ​e​x​t​e​r​n​a​l​ ​I​D​,​ ​W​h​a​t​s​A​p​p​ ​I​D​,​ ​o​r​ ​l​a​n​d​l​i​n​e​ ​n​u​m​b​e​r​. */ longDesc: string } - soft_descriptor: { + } + } + create_contact: { + /** + * C​r​e​a​t​e​ ​C​o​n​t​a​c​t + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​n​ ​B​r​e​v​o​.​ ​C​o​n​t​a​c​t​s​ ​c​a​n​ ​b​e​ ​c​r​e​a​t​e​d​ ​w​i​t​h​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​(​w​i​t​h​ ​c​o​u​n​t​r​y​ ​c​o​d​e​)​,​ ​o​r​ ​e​x​t​e​r​n​a​l​ ​I​D​.​ ​C​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​l​i​s​t​ ​a​s​s​i​g​n​m​e​n​t​s​ ​c​a​n​ ​b​e​ ​i​n​c​l​u​d​e​d​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } + options: { + email: { /** - * S​o​f​t​ ​D​e​s​c​r​i​p​t​o​r + * E​m​a​i​l​ ​A​d​d​r​e​s​s */ displayName: string /** - * T​e​x​t​ ​t​h​a​t​ ​a​p​p​e​a​r​s​ ​o​n​ ​c​u​s​t​o​m​e​r​'​s​ ​c​r​e​d​i​t​ ​c​a​r​d​ ​s​t​a​t​e​m​e​n​t + * C​o​n​t​a​c​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​t​h​a​t​ ​a​p​p​e​a​r​s​ ​o​n​ ​t​h​e​ ​c​u​s​t​o​m​e​r​'​s​ ​c​r​e​d​i​t​ ​c​a​r​d​ ​o​r​ ​b​a​n​k​ ​s​t​a​t​e​m​e​n​t​.​ ​K​e​e​p​ ​i​t​ ​s​h​o​r​t​ ​a​n​d​ ​r​e​c​o​g​n​i​z​a​b​l​e​ ​t​o​ ​a​v​o​i​d​ ​c​h​a​r​g​e​b​a​c​k​s​. + * P​r​i​m​a​r​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​.​ ​R​e​q​u​i​r​e​d​ ​f​o​r​ ​c​r​e​a​t​i​n​g​ ​a​ ​c​o​n​t​a​c​t​. */ longDesc: string } - items: { + extId: { /** - * O​r​d​e​r​ ​I​t​e​m​s + * E​x​t​e​r​n​a​l​ ​I​D */ displayName: string /** - * L​i​s​t​ ​o​f​ ​i​t​e​m​s​ ​b​e​i​n​g​ ​p​u​r​c​h​a​s​e​d + * E​x​t​e​r​n​a​l​ ​i​d​e​n​t​i​f​i​e​r */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​i​t​e​m​s​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​E​a​c​h​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​s​p​e​c​i​f​y​ ​n​a​m​e​,​ ​q​u​a​n​t​i​t​y​,​ ​u​n​i​t​ ​p​r​i​c​e​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​l​y​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​S​K​U​,​ ​c​a​t​e​g​o​r​y​,​ ​a​n​d​ ​t​a​x​ ​a​m​o​u​n​t​. + * C​u​s​t​o​m​ ​e​x​t​e​r​n​a​l​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​s​y​s​t​e​m​. */ longDesc: string - type: { - element_type: { - fields: { - name: { - /** - * I​t​e​m​ ​N​a​m​e - */ - displayName: string - /** - * N​a​m​e​ ​o​f​ ​t​h​e​ ​i​t​e​m - */ - shortDesc: string - /** - * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​h​o​w​n​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​d​u​r​i​n​g​ ​c​h​e​c​k​o​u​t​. - */ - longDesc: string - } - quantity: { - /** - * Q​u​a​n​t​i​t​y - */ - displayName: string - /** - * N​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s - */ - shortDesc: string - /** - * T​h​e​ ​q​u​a​n​t​i​t​y​ ​o​f​ ​t​h​i​s​ ​i​t​e​m​ ​b​e​i​n​g​ ​p​u​r​c​h​a​s​e​d​.​ ​M​u​s​t​ ​b​e​ ​a​ ​p​o​s​i​t​i​v​e​ ​i​n​t​e​g​e​r​. - */ - longDesc: string - } - unit_price: { - /** - * U​n​i​t​ ​P​r​i​c​e - */ - displayName: string - /** - * P​r​i​c​e​ ​p​e​r​ ​i​n​d​i​v​i​d​u​a​l​ ​i​t​e​m - */ - shortDesc: string - /** - * T​h​e​ ​c​o​s​t​ ​p​e​r​ ​i​n​d​i​v​i​d​u​a​l​ ​u​n​i​t​ ​o​f​ ​t​h​i​s​ ​i​t​e​m​,​ ​b​e​f​o​r​e​ ​t​a​x​e​s​ ​a​n​d​ ​d​i​s​c​o​u​n​t​s​. - */ - longDesc: string - } - description: { - /** - * I​t​e​m​ ​D​e​s​c​r​i​p​t​i​o​n - */ - displayName: string - /** - * D​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​i​t​e​m - */ - shortDesc: string - /** - * O​p​t​i​o​n​a​l​ ​d​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​p​r​o​v​i​d​i​n​g​ ​m​o​r​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​i​s​ ​i​t​e​m​. - */ - longDesc: string - } - sku: { - /** - * S​K​U - */ - displayName: string - /** - * S​t​o​c​k​ ​k​e​e​p​i​n​g​ ​u​n​i​t​ ​i​d​e​n​t​i​f​i​e​r - */ - shortDesc: string - /** - * Y​o​u​r​ ​i​n​t​e​r​n​a​l​ ​s​t​o​c​k​ ​k​e​e​p​i​n​g​ ​u​n​i​t​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​i​n​v​e​n​t​o​r​y​ ​t​r​a​c​k​i​n​g​. - */ - longDesc: string - } - url: { - /** - * I​t​e​m​ ​U​R​L - */ - displayName: string - /** - * L​i​n​k​ ​t​o​ ​t​h​e​ ​i​t​e​m​ ​p​a​g​e - */ - shortDesc: string - /** - * O​p​t​i​o​n​a​l​ ​U​R​L​ ​l​i​n​k​i​n​g​ ​t​o​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​p​a​g​e​ ​w​h​e​r​e​ ​c​u​s​t​o​m​e​r​s​ ​c​a​n​ ​v​i​e​w​ ​m​o​r​e​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​i​s​ ​i​t​e​m​. - */ - longDesc: string - } - category: { - /** - * I​t​e​m​ ​C​a​t​e​g​o​r​y - */ - displayName: string - /** - * C​a​t​e​g​o​r​y​ ​t​y​p​e​ ​o​f​ ​t​h​e​ ​i​t​e​m - */ - shortDesc: string - /** - * T​h​e​ ​c​a​t​e​g​o​r​y​ ​c​l​a​s​s​i​f​i​c​a​t​i​o​n​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m​,​ ​w​h​i​c​h​ ​a​f​f​e​c​t​s​ ​p​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​i​n​g​ ​a​n​d​ ​c​o​m​p​l​i​a​n​c​e​ ​r​e​q​u​i​r​e​m​e​n​t​s​. - */ - longDesc: string - } - tax_amount: { - /** - * T​a​x​ ​A​m​o​u​n​t - */ - displayName: string - /** - * T​a​x​ ​a​m​o​u​n​t​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m - */ - shortDesc: string - /** - * T​h​e​ ​t​a​x​ ​a​m​o​u​n​t​ ​s​p​e​c​i​f​i​c​a​l​l​y​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m​,​ ​c​a​l​c​u​l​a​t​e​d​ ​b​a​s​e​d​ ​o​n​ ​q​u​a​n​t​i​t​y​ ​a​n​d​ ​a​p​p​l​i​c​a​b​l​e​ ​t​a​x​ ​r​a​t​e​s​. - */ - longDesc: string - } - } - } - } } - shipping_type: { + listIds: { /** - * S​h​i​p​p​i​n​g​ ​T​y​p​e + * L​i​s​t​ ​I​D​s */ displayName: string /** - * M​e​t​h​o​d​ ​o​f​ ​d​e​l​i​v​e​r​y​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r + * L​i​s​t​s​ ​t​o​ ​a​d​d​ ​c​o​n​t​a​c​t​ ​t​o */ shortDesc: string /** - * S​p​e​c​i​f​i​e​s​ ​h​o​w​ ​t​h​e​ ​i​t​e​m​s​ ​w​i​l​l​ ​b​e​ ​d​e​l​i​v​e​r​e​d​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​A​f​f​e​c​t​s​ ​s​h​i​p​p​i​n​g​ ​c​o​s​t​s​ ​a​n​d​ ​d​e​l​i​v​e​r​y​ ​t​i​m​e​l​i​n​e​. + * A​r​r​a​y​ ​o​f​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​a​d​d​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​u​p​o​n​ ​c​r​e​a​t​i​o​n​. */ longDesc: string } - shipping_name: { + emailBlacklisted: { /** - * S​h​i​p​p​i​n​g​ ​N​a​m​e + * E​m​a​i​l​ ​B​l​a​c​k​l​i​s​t​e​d */ displayName: string /** - * F​u​l​l​ ​n​a​m​e​ ​f​o​r​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s + * B​l​a​c​k​l​i​s​t​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​e​m​a​i​l​s */ shortDesc: string /** - * T​h​e​ ​c​o​m​p​l​e​t​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​e​r​s​o​n​ ​w​h​o​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​s​h​i​p​m​e​n​t​ ​a​t​ ​t​h​e​ ​d​e​l​i​v​e​r​y​ ​a​d​d​r​e​s​s​. + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​b​l​a​c​k​l​i​s​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​r​e​c​e​i​v​i​n​g​ ​e​m​a​i​l​ ​c​a​m​p​a​i​g​n​s​. */ longDesc: string } - shipping_address_line_1: { + smsBlacklisted: { /** - * S​h​i​p​p​i​n​g​ ​A​d​d​r​e​s​s​ ​L​i​n​e​ ​1 + * S​M​S​ ​B​l​a​c​k​l​i​s​t​e​d */ displayName: string /** - * P​r​i​m​a​r​y​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s + * B​l​a​c​k​l​i​s​t​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​S​M​S */ shortDesc: string /** - * T​h​e​ ​f​i​r​s​t​ ​l​i​n​e​ ​o​f​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​,​ ​t​y​p​i​c​a​l​l​y​ ​c​o​n​t​a​i​n​i​n​g​ ​s​t​r​e​e​t​ ​n​u​m​b​e​r​ ​a​n​d​ ​n​a​m​e​. + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​b​l​a​c​k​l​i​s​t​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​r​e​c​e​i​v​i​n​g​ ​S​M​S​ ​c​a​m​p​a​i​g​n​s​. */ longDesc: string } - shipping_address_line_2: { + attributes: { /** - * S​h​i​p​p​i​n​g​ ​A​d​d​r​e​s​s​ ​L​i​n​e​ ​2 + * C​o​n​t​a​c​t​ ​A​t​t​r​i​b​u​t​e​s */ displayName: string /** - * S​e​c​o​n​d​a​r​y​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​ ​l​i​n​e + * C​u​s​t​o​m​ ​c​o​n​t​a​c​t​ ​a​t​t​r​i​b​u​t​e​s */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​s​e​c​o​n​d​ ​l​i​n​e​ ​o​f​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​a​p​a​r​t​m​e​n​t​ ​n​u​m​b​e​r​s​,​ ​s​u​i​t​e​ ​n​u​m​b​e​r​s​,​ ​o​r​ ​a​d​d​i​t​i​o​n​a​l​ ​l​o​c​a​t​i​o​n​ ​d​e​t​a​i​l​s​. + * C​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​c​o​m​p​a​n​y​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​d​e​f​i​n​e​d​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. */ longDesc: string } - shipping_city: { + } + } + update_contact: { + /** + * U​p​d​a​t​e​ ​C​o​n​t​a​c​t + */ + displayName: string + /** + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t + */ + shortDesc: string + /** + * U​p​d​a​t​e​ ​c​o​n​t​a​c​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​i​n​c​l​u​d​i​n​g​ ​a​t​t​r​i​b​u​t​e​s​,​ ​e​m​a​i​l​ ​p​r​e​f​e​r​e​n​c​e​s​,​ ​l​i​s​t​ ​m​e​m​b​e​r​s​h​i​p​s​,​ ​a​n​d​ ​c​u​s​t​o​m​ ​d​a​t​a​.​ ​C​o​n​t​a​c​t​ ​c​a​n​ ​b​e​ ​i​d​e​n​t​i​f​i​e​d​ ​b​y​ ​e​m​a​i​l​,​ ​I​D​,​ ​o​r​ ​o​t​h​e​r​ ​i​d​e​n​t​i​f​i​e​r​s​. + */ + longDesc: string + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } + options: { + identifier: { /** - * S​h​i​p​p​i​n​g​ ​C​i​t​y + * C​o​n​t​a​c​t​ ​I​d​e​n​t​i​f​i​e​r */ displayName: string /** - * C​i​t​y​ ​f​o​r​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s + * C​o​n​t​a​c​t​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * T​h​e​ ​c​i​t​y​ ​w​h​e​r​e​ ​t​h​e​ ​i​t​e​m​s​ ​w​i​l​l​ ​b​e​ ​d​e​l​i​v​e​r​e​d​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​u​p​d​a​t​e​.​ ​C​a​n​ ​b​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​c​o​n​t​a​c​t​ ​I​D​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​e​x​t​e​r​n​a​l​ ​I​D​,​ ​W​h​a​t​s​A​p​p​ ​I​D​,​ ​o​r​ ​l​a​n​d​l​i​n​e​ ​n​u​m​b​e​r​. */ longDesc: string } - shipping_state: { + email: { /** - * S​h​i​p​p​i​n​g​ ​S​t​a​t​e + * N​e​w​ ​E​m​a​i​l​ ​A​d​d​r​e​s​s */ displayName: string /** - * S​t​a​t​e​ ​o​r​ ​p​r​o​v​i​n​c​e​ ​f​o​r​ ​s​h​i​p​p​i​n​g + * U​p​d​a​t​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * T​h​e​ ​s​t​a​t​e​,​ ​p​r​o​v​i​n​c​e​,​ ​o​r​ ​r​e​g​i​o​n​ ​f​o​r​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​.​ ​U​s​e​ ​a​p​p​r​o​p​r​i​a​t​e​ ​c​o​d​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​u​n​t​r​y​. + * N​e​w​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​. */ longDesc: string } - shipping_postal_code: { + extId: { /** - * S​h​i​p​p​i​n​g​ ​P​o​s​t​a​l​ ​C​o​d​e + * E​x​t​e​r​n​a​l​ ​I​D */ displayName: string /** - * Z​I​P​ ​o​r​ ​p​o​s​t​a​l​ ​c​o​d​e​ ​f​o​r​ ​s​h​i​p​p​i​n​g + * E​x​t​e​r​n​a​l​ ​i​d​e​n​t​i​f​i​e​r */ shortDesc: string /** - * T​h​e​ ​Z​I​P​ ​c​o​d​e​,​ ​p​o​s​t​a​l​ ​c​o​d​e​,​ ​o​r​ ​e​q​u​i​v​a​l​e​n​t​ ​f​o​r​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​. + * C​u​s​t​o​m​ ​e​x​t​e​r​n​a​l​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​s​y​s​t​e​m​. */ longDesc: string } - shipping_country_code: { + listIds: { /** - * S​h​i​p​p​i​n​g​ ​C​o​u​n​t​r​y​ ​C​o​d​e + * A​d​d​ ​t​o​ ​L​i​s​t​s */ displayName: string /** - * T​w​o​-​l​e​t​t​e​r​ ​c​o​u​n​t​r​y​ ​c​o​d​e​ ​f​o​r​ ​s​h​i​p​p​i​n​g + * L​i​s​t​s​ ​t​o​ ​a​d​d​ ​c​o​n​t​a​c​t​ ​t​o */ shortDesc: string /** - * T​h​e​ ​t​w​o​-​c​h​a​r​a​c​t​e​r​ ​I​S​O​ ​3​1​6​6​-​1​ ​c​o​u​n​t​r​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​. + * A​r​r​a​y​ ​o​f​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​a​d​d​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​. */ longDesc: string } - platform_fees: { + unlinkListIds: { /** - * P​l​a​t​f​o​r​m​ ​F​e​e​s + * R​e​m​o​v​e​ ​f​r​o​m​ ​L​i​s​t​s */ displayName: string /** - * F​e​e​s​ ​c​o​l​l​e​c​t​e​d​ ​b​y​ ​t​h​e​ ​p​l​a​t​f​o​r​m + * L​i​s​t​s​ ​t​o​ ​r​e​m​o​v​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m */ shortDesc: string /** - * A​r​r​a​y​ ​o​f​ ​p​l​a​t​f​o​r​m​ ​f​e​e​s​ ​t​o​ ​b​e​ ​c​o​l​l​e​c​t​e​d​ ​o​n​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​.​ ​U​s​e​d​ ​b​y​ ​m​a​r​k​e​t​p​l​a​c​e​s​ ​t​o​ ​c​o​l​l​e​c​t​ ​f​e​e​s​ ​f​r​o​m​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​p​r​o​c​e​s​s​e​d​ ​o​n​ ​t​h​e​i​r​ ​p​l​a​t​f​o​r​m​. + * A​r​r​a​y​ ​o​f​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​r​e​m​o​v​e​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​f​r​o​m​. */ longDesc: string - type: { - element_type: { - fields: { - fee_amount: { - /** - * F​e​e​ ​A​m​o​u​n​t - */ - displayName: string - /** - * P​l​a​t​f​o​r​m​ ​f​e​e​ ​a​m​o​u​n​t - */ - shortDesc: string - /** - * T​h​e​ ​a​m​o​u​n​t​ ​o​f​ ​t​h​e​ ​p​l​a​t​f​o​r​m​ ​f​e​e​ ​t​o​ ​b​e​ ​c​o​l​l​e​c​t​e​d​ ​f​r​o​m​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. - */ - longDesc: string - } - payee_email: { - /** - * F​e​e​ ​R​e​c​i​p​i​e​n​t​ ​E​m​a​i​l - */ - displayName: string - /** - * E​m​a​i​l​ ​o​f​ ​f​e​e​ ​r​e​c​i​p​i​e​n​t - */ - shortDesc: string - /** - * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​l​a​t​f​o​r​m​ ​f​e​e​. - */ - longDesc: string - } - payee_merchant_id: { - /** - * F​e​e​ ​R​e​c​i​p​i​e​n​t​ ​M​e​r​c​h​a​n​t​ ​I​D - */ - displayName: string - /** - * M​e​r​c​h​a​n​t​ ​I​D​ ​o​f​ ​f​e​e​ ​r​e​c​i​p​i​e​n​t - */ - shortDesc: string - /** - * P​a​y​P​a​l​ ​m​e​r​c​h​a​n​t​ ​I​D​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​l​a​t​f​o​r​m​ ​f​e​e​. - */ - longDesc: string - } - } - } - } } - disbursement_mode: { + emailBlacklisted: { /** - * D​i​s​b​u​r​s​e​m​e​n​t​ ​M​o​d​e + * E​m​a​i​l​ ​B​l​a​c​k​l​i​s​t​e​d */ displayName: string /** - * W​h​e​n​ ​t​o​ ​r​e​l​e​a​s​e​ ​f​u​n​d​s​ ​t​o​ ​t​h​e​ ​s​e​l​l​e​r + * E​m​a​i​l​ ​b​l​a​c​k​l​i​s​t​ ​s​t​a​t​u​s */ shortDesc: string /** - * C​o​n​t​r​o​l​s​ ​w​h​e​n​ ​c​a​p​t​u​r​e​d​ ​f​u​n​d​s​ ​a​r​e​ ​r​e​l​e​a​s​e​d​ ​t​o​ ​t​h​e​ ​s​e​l​l​e​r​.​ ​I​N​S​T​A​N​T​ ​r​e​l​e​a​s​e​s​ ​f​u​n​d​s​ ​i​m​m​e​d​i​a​t​e​l​y​,​ ​w​h​i​l​e​ ​D​E​L​A​Y​E​D​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​h​o​l​d​ ​f​u​n​d​s​ ​f​o​r​ ​v​e​r​i​f​i​c​a​t​i​o​n​ ​b​e​f​o​r​e​ ​r​e​l​e​a​s​e​. + * S​e​t​ ​e​m​a​i​l​ ​b​l​a​c​k​l​i​s​t​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​. */ longDesc: string } - return_url: { + smsBlacklisted: { /** - * R​e​t​u​r​n​ ​U​R​L + * S​M​S​ ​B​l​a​c​k​l​i​s​t​e​d */ displayName: string /** - * U​R​L​ ​t​o​ ​r​e​d​i​r​e​c​t​ ​a​f​t​e​r​ ​s​u​c​c​e​s​s​f​u​l​ ​p​a​y​m​e​n​t + * S​M​S​ ​b​l​a​c​k​l​i​s​t​ ​s​t​a​t​u​s */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​w​h​e​r​e​ ​c​u​s​t​o​m​e​r​s​ ​w​i​l​l​ ​b​e​ ​r​e​d​i​r​e​c​t​e​d​ ​a​f​t​e​r​ ​s​u​c​c​e​s​s​f​u​l​l​y​ ​c​o​m​p​l​e​t​i​n​g​ ​t​h​e​i​r​ ​p​a​y​m​e​n​t​.​ ​S​h​o​u​l​d​ ​b​e​ ​a​ ​p​a​g​e​ ​c​o​n​f​i​r​m​i​n​g​ ​t​h​e​ ​s​u​c​c​e​s​s​f​u​l​ ​t​r​a​n​s​a​c​t​i​o​n​. + * S​e​t​ ​S​M​S​ ​b​l​a​c​k​l​i​s​t​ ​s​t​a​t​u​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​. */ longDesc: string } - cancel_url: { + attributes: { /** - * C​a​n​c​e​l​ ​U​R​L + * C​o​n​t​a​c​t​ ​A​t​t​r​i​b​u​t​e​s */ displayName: string /** - * U​R​L​ ​t​o​ ​r​e​d​i​r​e​c​t​ ​i​f​ ​p​a​y​m​e​n​t​ ​i​s​ ​c​a​n​c​e​l​l​e​d + * U​p​d​a​t​e​ ​c​o​n​t​a​c​t​ ​a​t​t​r​i​b​u​t​e​s */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​w​h​e​r​e​ ​c​u​s​t​o​m​e​r​s​ ​w​i​l​l​ ​b​e​ ​r​e​d​i​r​e​c​t​e​d​ ​i​f​ ​t​h​e​y​ ​c​a​n​c​e​l​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​.​ ​S​h​o​u​l​d​ ​p​r​o​v​i​d​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​c​a​n​c​e​l​l​e​d​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​n​d​ ​n​e​x​t​ ​s​t​e​p​s​. + * U​p​d​a​t​e​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​c​o​m​p​a​n​y​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​. */ longDesc: string } } } - capture_order: { + list_contacts: { /** - * C​a​p​t​u​r​e​ ​O​r​d​e​r + * L​i​s​t​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * C​a​p​t​u​r​e​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​a​n​ ​a​p​p​r​o​v​e​d​ ​o​r​d​e​r + * G​e​t​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g */ shortDesc: string /** - * C​a​p​t​u​r​e​s​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​a​n​ ​o​r​d​e​r​ ​t​h​a​t​ ​h​a​s​ ​b​e​e​n​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​c​o​m​p​l​e​t​e​s​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​ ​a​n​d​ ​t​r​a​n​s​f​e​r​s​ ​f​u​n​d​s​ ​f​r​o​m​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​t​o​ ​y​o​u​r​ ​a​c​c​o​u​n​t​.​ ​S​h​o​u​l​d​ ​b​e​ ​c​a​l​l​e​d​ ​a​f​t​e​r​ ​r​e​c​e​i​v​i​n​g​ ​o​r​d​e​r​ ​a​p​p​r​o​v​a​l​ ​o​r​ ​f​o​r​ ​i​m​m​e​d​i​a​t​e​ ​c​a​p​t​u​r​e​ ​o​r​d​e​r​s​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​w​i​t​h​ ​p​a​g​i​n​a​t​i​o​n​,​ ​s​o​r​t​i​n​g​,​ ​a​n​d​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​.​ ​F​i​l​t​e​r​ ​b​y​ ​l​i​s​t​s​,​ ​a​t​t​r​i​b​u​t​e​s​,​ ​o​r​ ​o​t​h​e​r​ ​c​r​i​t​e​r​i​a​. */ longDesc: string + groups: { + /** + * C​o​n​t​a​c​t​s + */ + '0': string + } options: { - order_id: { + limit: { /** - * O​r​d​e​r​ ​I​D + * R​e​s​u​l​t​s​ ​L​i​m​i​t */ displayName: string /** - * I​D​ ​o​f​ ​t​h​e​ ​a​p​p​r​o​v​e​d​ ​o​r​d​e​r​ ​t​o​ ​c​a​p​t​u​r​e + * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​t​h​a​t​ ​h​a​s​ ​b​e​e​n​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​a​n​d​ ​i​s​ ​r​e​a​d​y​ ​f​o​r​ ​p​a​y​m​e​n​t​ ​c​a​p​t​u​r​e​. + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​,​ ​m​a​x​i​m​u​m​ ​i​s​ ​1​0​0​. */ longDesc: string } - final_capture: { + offset: { /** - * F​i​n​a​l​ ​C​a​p​t​u​r​e + * P​a​g​e​ ​O​f​f​s​e​t */ displayName: string /** - * W​h​e​t​h​e​r​ ​t​h​i​s​ ​i​s​ ​t​h​e​ ​f​i​n​a​l​ ​c​a​p​t​u​r​e​ ​f​o​r​ ​t​h​e​ ​o​r​d​e​r + * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * I​n​d​i​c​a​t​e​s​ ​w​h​e​t​h​e​r​ ​t​h​i​s​ ​c​a​p​t​u​r​e​ ​c​o​m​p​l​e​t​e​s​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​t​h​e​ ​o​r​d​e​r​.​ ​S​e​t​ ​t​o​ ​t​r​u​e​ ​i​f​ ​t​h​i​s​ ​i​s​ ​t​h​e​ ​c​o​m​p​l​e​t​e​ ​a​m​o​u​n​t​,​ ​o​r​ ​f​a​l​s​e​ ​i​f​ ​y​o​u​ ​p​l​a​n​ ​t​o​ ​m​a​k​e​ ​a​d​d​i​t​i​o​n​a​l​ ​p​a​r​t​i​a​l​ ​c​a​p​t​u​r​e​s​. + * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​.​ ​U​s​e​ ​w​i​t​h​ ​l​i​m​i​t​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​. */ longDesc: string } - payment_instruction: { + sort: { /** - * P​a​y​m​e​n​t​ ​I​n​s​t​r​u​c​t​i​o​n​s + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * A​d​d​i​t​i​o​n​a​l​ ​p​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​i​n​g​ ​i​n​s​t​r​u​c​t​i​o​n​s + * C​o​n​t​a​c​t​ ​s​o​r​t​ ​o​r​d​e​r */ shortDesc: string /** - * S​p​e​c​i​a​l​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​f​o​r​ ​p​r​o​c​e​s​s​i​n​g​ ​t​h​i​s​ ​p​a​y​m​e​n​t​,​ ​s​u​c​h​ ​a​s​ ​d​i​s​b​u​r​s​e​m​e​n​t​ ​t​i​m​i​n​g​ ​o​r​ ​p​l​a​t​f​o​r​m​ ​f​e​e​ ​c​o​l​l​e​c​t​i​o​n​. + * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. + */ + longDesc: string + } + listIds: { + /** + * F​i​l​t​e​r​ ​b​y​ ​L​i​s​t​s + */ + displayName: string + /** + * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​y​ ​l​i​s​t​ ​m​e​m​b​e​r​s​h​i​p + */ + shortDesc: string + /** + * A​r​r​a​y​ ​o​f​ ​l​i​s​t​ ​I​D​s​ ​t​o​ ​f​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​.​ ​O​n​l​y​ ​c​o​n​t​a​c​t​s​ ​b​e​l​o​n​g​i​n​g​ ​t​o​ ​t​h​e​s​e​ ​l​i​s​t​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​. + */ + longDesc: string + } + filter: { + /** + * A​t​t​r​i​b​u​t​e​ ​F​i​l​t​e​r + */ + displayName: string + /** + * F​i​l​t​e​r​ ​b​y​ ​c​o​n​t​a​c​t​ ​a​t​t​r​i​b​u​t​e​s + */ + shortDesc: string + /** + * F​i​l​t​e​r​ ​c​o​n​t​a​c​t​s​ ​b​a​s​e​d​ ​o​n​ ​s​p​e​c​i​f​i​c​ ​a​t​t​r​i​b​u​t​e​ ​v​a​l​u​e​s​ ​u​s​i​n​g​ ​e​q​u​a​l​s​ ​o​p​e​r​a​t​o​r​. */ longDesc: string type: { fields: { - disbursement_mode: { + field: { /** - * D​i​s​b​u​r​s​e​m​e​n​t​ ​M​o​d​e + * A​t​t​r​i​b​u​t​e​ ​F​i​e​l​d */ displayName: string /** - * W​h​e​n​ ​t​o​ ​d​i​s​b​u​r​s​e​ ​f​u​n​d​s + * A​t​t​r​i​b​u​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y */ shortDesc: string /** - * C​o​n​t​r​o​l​s​ ​w​h​e​n​ ​c​a​p​t​u​r​e​d​ ​f​u​n​d​s​ ​a​r​e​ ​d​i​s​b​u​r​s​e​d​ ​t​o​ ​t​h​e​ ​p​a​y​e​e​.​ ​U​s​e​ ​I​N​S​T​A​N​T​ ​f​o​r​ ​i​m​m​e​d​i​a​t​e​ ​d​i​s​b​u​r​s​e​m​e​n​t​ ​o​r​ ​D​E​L​A​Y​E​D​ ​t​o​ ​h​o​l​d​ ​f​u​n​d​s​. + * C​o​n​t​a​c​t​ ​a​t​t​r​i​b​u​t​e​ ​f​i​e​l​d​ ​n​a​m​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y​. + */ + longDesc: string + } + value: { + /** + * F​i​l​t​e​r​ ​V​a​l​u​e + */ + displayName: string + /** + * V​a​l​u​e​ ​t​o​ ​m​a​t​c​h + */ + shortDesc: string + /** + * V​a​l​u​e​ ​t​h​a​t​ ​t​h​e​ ​a​t​t​r​i​b​u​t​e​ ​m​u​s​t​ ​e​q​u​a​l​. */ longDesc: string } @@ -125315,600 +124938,720 @@ type RootTranslation = { } } } - authorize_order: { + get_list: { /** - * A​u​t​h​o​r​i​z​e​ ​O​r​d​e​r + * G​e​t​ ​L​i​s​t */ displayName: string /** - * A​u​t​h​o​r​i​z​e​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​a​n​ ​a​p​p​r​o​v​e​d​ ​o​r​d​e​r + * R​e​t​r​i​e​v​e​ ​l​i​s​t​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * A​u​t​h​o​r​i​z​e​s​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​a​n​ ​o​r​d​e​r​ ​t​h​a​t​ ​h​a​s​ ​b​e​e​n​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​p​l​a​c​e​s​ ​a​ ​h​o​l​d​ ​o​n​ ​t​h​e​ ​f​u​n​d​s​ ​w​i​t​h​o​u​t​ ​c​a​p​t​u​r​i​n​g​ ​t​h​e​m​,​ ​a​l​l​o​w​i​n​g​ ​y​o​u​ ​t​o​ ​c​a​p​t​u​r​e​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​l​a​t​e​r​ ​w​h​e​n​ ​r​e​a​d​y​ ​t​o​ ​f​u​l​f​i​l​l​ ​t​h​e​ ​o​r​d​e​r​.​ ​A​u​t​h​o​r​i​z​a​t​i​o​n​ ​i​s​ ​v​a​l​i​d​ ​f​o​r​ ​u​p​ ​t​o​ ​2​9​ ​d​a​y​s​. + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​i​n​c​l​u​d​i​n​g​ ​s​u​b​s​c​r​i​b​e​r​ ​c​o​u​n​t​s​,​ ​c​a​m​p​a​i​g​n​ ​s​t​a​t​i​s​t​i​c​s​,​ ​a​n​d​ ​f​o​l​d​e​r​ ​i​n​f​o​r​m​a​t​i​o​n​. */ longDesc: string + groups: { + /** + * L​i​s​t​s + */ + '0': string + } options: { - order_id: { + listId: { /** - * O​r​d​e​r​ ​I​D + * L​i​s​t​ ​I​D */ displayName: string /** - * I​D​ ​o​f​ ​t​h​e​ ​a​p​p​r​o​v​e​d​ ​o​r​d​e​r​ ​t​o​ ​a​u​t​h​o​r​i​z​e + * L​i​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​t​h​a​t​ ​h​a​s​ ​b​e​e​n​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​a​n​d​ ​i​s​ ​r​e​a​d​y​ ​f​o​r​ ​p​a​y​m​e​n​t​ ​a​u​t​h​o​r​i​z​a​t​i​o​n​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. */ longDesc: string } } } - get_order: { + create_list: { /** - * G​e​t​ ​O​r​d​e​r + * C​r​e​a​t​e​ ​L​i​s​t */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​o​r​d​e​r​ ​d​e​t​a​i​l​s​ ​b​y​ ​I​D + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​c​o​m​p​l​e​t​e​ ​d​e​t​a​i​l​s​ ​f​o​r​ ​a​n​ ​o​r​d​e​r​ ​b​y​ ​i​t​s​ ​I​D​,​ ​i​n​c​l​u​d​i​n​g​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s​,​ ​p​a​y​m​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​t​r​a​n​s​a​c​t​i​o​n​ ​h​i​s​t​o​r​y​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​c​h​e​c​k​ ​o​r​d​e​r​ ​s​t​a​t​u​s​ ​o​r​ ​r​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​o​r​d​e​r​ ​m​a​n​a​g​e​m​e​n​t​. + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​f​o​l​d​e​r​.​ ​L​i​s​t​s​ ​a​r​e​ ​u​s​e​d​ ​t​o​ ​o​r​g​a​n​i​z​e​ ​a​n​d​ ​s​e​g​m​e​n​t​ ​y​o​u​r​ ​c​o​n​t​a​c​t​s​ ​f​o​r​ ​t​a​r​g​e​t​e​d​ ​c​a​m​p​a​i​g​n​s​. */ longDesc: string + groups: { + /** + * L​i​s​t​s + */ + '0': string + } options: { - order_id: { + name: { /** - * O​r​d​e​r​ ​I​D + * L​i​s​t​ ​N​a​m​e */ displayName: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e + * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​l​i​s​t */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. + * D​i​s​p​l​a​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​. + */ + longDesc: string + } + folderId: { + /** + * F​o​l​d​e​r + */ + displayName: string + /** + * F​o​l​d​e​r​ ​t​o​ ​c​r​e​a​t​e​ ​l​i​s​t​ ​i​n + */ + shortDesc: string + /** + * F​o​l​d​e​r​ ​w​h​e​r​e​ ​t​h​e​ ​l​i​s​t​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​.​ ​R​e​q​u​i​r​e​d​ ​f​o​r​ ​l​i​s​t​ ​o​r​g​a​n​i​z​a​t​i​o​n​. */ longDesc: string } } } - list_transactions: { + update_list: { /** - * L​i​s​t​ ​T​r​a​n​s​a​c​t​i​o​n​s + * U​p​d​a​t​e​ ​L​i​s​t */ displayName: string /** - * G​e​t​ ​t​r​a​n​s​a​c​t​i​o​n​ ​h​i​s​t​o​r​y​ ​f​o​r​ ​y​o​u​r​ ​a​c​c​o​u​n​t + * U​p​d​a​t​e​ ​l​i​s​t​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​f​o​r​ ​y​o​u​r​ ​P​a​y​P​a​l​ ​a​c​c​o​u​n​t​ ​w​i​t​h​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​d​a​t​e​ ​r​a​n​g​e​.​ ​S​u​p​p​o​r​t​s​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​t​y​p​e​,​ ​s​t​a​t​u​s​,​ ​a​m​o​u​n​t​ ​r​a​n​g​e​,​ ​c​u​r​r​e​n​c​y​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​ ​t​o​ ​h​e​l​p​ ​y​o​u​ ​f​i​n​d​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​o​r​ ​g​e​n​e​r​a​t​e​ ​r​e​p​o​r​t​s​. + * U​p​d​a​t​e​ ​t​h​e​ ​n​a​m​e​ ​o​r​ ​f​o​l​d​e​r​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​ ​l​i​s​t​. */ longDesc: string + groups: { + /** + * L​i​s​t​s + */ + '0': string + } options: { - start_date: { + listId: { /** - * S​t​a​r​t​ ​D​a​t​e + * L​i​s​t​ ​I​D */ displayName: string /** - * B​e​g​i​n​n​i​n​g​ ​d​a​t​e​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​e​a​r​c​h + * L​i​s​t​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * T​h​e​ ​e​a​r​l​i​e​s​t​ ​d​a​t​e​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​e​a​r​c​h​.​ ​T​r​a​n​s​a​c​t​i​o​n​s​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​w​i​l​l​ ​b​e​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - end_date: { + name: { /** - * E​n​d​ ​D​a​t​e + * N​e​w​ ​N​a​m​e */ displayName: string /** - * E​n​d​i​n​g​ ​d​a​t​e​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​e​a​r​c​h + * U​p​d​a​t​e​d​ ​l​i​s​t​ ​n​a​m​e */ shortDesc: string /** - * T​h​e​ ​l​a​t​e​s​t​ ​d​a​t​e​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​e​a​r​c​h​.​ ​T​r​a​n​s​a​c​t​i​o​n​s​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​w​i​l​l​ ​b​e​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. + * N​e​w​ ​d​i​s​p​l​a​y​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​. */ longDesc: string } - transaction_type: { + folderId: { /** - * T​r​a​n​s​a​c​t​i​o​n​ ​T​y​p​e + * N​e​w​ ​F​o​l​d​e​r */ displayName: string /** - * T​y​p​e​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​r​e​t​r​i​e​v​e + * M​o​v​e​ ​t​o​ ​d​i​f​f​e​r​e​n​t​ ​f​o​l​d​e​r */ shortDesc: string /** - * F​i​l​t​e​r​ ​r​e​s​u​l​t​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​t​y​p​e​s​ ​s​u​c​h​ ​a​s​ ​p​a​y​m​e​n​t​s​,​ ​r​e​f​u​n​d​s​,​ ​f​e​e​s​,​ ​o​r​ ​o​t​h​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​ ​c​a​t​e​g​o​r​i​e​s​. + * N​e​w​ ​f​o​l​d​e​r​ ​I​D​ ​t​o​ ​m​o​v​e​ ​t​h​e​ ​l​i​s​t​ ​t​o​. */ longDesc: string } - transaction_status: { + } + } + delete_list: { + /** + * D​e​l​e​t​e​ ​L​i​s​t + */ + displayName: string + /** + * D​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t + */ + shortDesc: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​C​o​n​t​a​c​t​s​ ​i​n​ ​t​h​e​ ​l​i​s​t​ ​w​i​l​l​ ​r​e​m​a​i​n​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. + */ + longDesc: string + groups: { + /** + * L​i​s​t​s + */ + '0': string + } + options: { + listId: { /** - * T​r​a​n​s​a​c​t​i​o​n​ ​S​t​a​t​u​s + * L​i​s​t​ ​I​D */ displayName: string /** - * S​t​a​t​u​s​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​i​n​c​l​u​d​e + * L​i​s​t​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​ ​t​h​e​i​r​ ​p​r​o​c​e​s​s​i​n​g​ ​s​t​a​t​u​s​ ​s​u​c​h​ ​a​s​ ​S​u​c​c​e​s​s​,​ ​P​e​n​d​i​n​g​,​ ​D​e​n​i​e​d​,​ ​o​r​ ​R​e​f​u​n​d​e​d​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​t​o​ ​d​e​l​e​t​e​ ​p​e​r​m​a​n​e​n​t​l​y​. */ longDesc: string } - transaction_amount: { + } + } + list_lists: { + /** + * L​i​s​t​ ​A​l​l​ ​L​i​s​t​s + */ + displayName: string + /** + * G​e​t​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​w​i​t​h​ ​p​a​g​i​n​a​t​i​o​n​ ​a​n​d​ ​s​o​r​t​i​n​g​ ​o​p​t​i​o​n​s​.​ ​I​n​c​l​u​d​e​s​ ​s​u​b​s​c​r​i​b​e​r​ ​c​o​u​n​t​s​ ​a​n​d​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​s​. + */ + longDesc: string + groups: { + /** + * L​i​s​t​s + */ + '0': string + } + options: { + limit: { /** - * T​r​a​n​s​a​c​t​i​o​n​ ​A​m​o​u​n​t​ ​R​a​n​g​e + * R​e​s​u​l​t​s​ ​L​i​m​i​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t​ ​r​a​n​g​e + * N​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * S​p​e​c​i​f​y​ ​a​ ​r​a​n​g​e​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t​s​ ​t​o​ ​f​i​l​t​e​r​ ​r​e​s​u​l​t​s​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​f​i​n​d​i​n​g​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​i​n​ ​s​p​e​c​i​f​i​c​ ​v​a​l​u​e​ ​r​a​n​g​e​s​. + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. */ longDesc: string - type: { - fields: { - from: { - /** - * M​i​n​i​m​u​m​ ​A​m​o​u​n​t - */ - displayName: string - /** - * M​i​n​i​m​u​m​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t - */ - shortDesc: string - /** - * T​h​e​ ​m​i​n​i​m​u​m​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​r​e​s​u​l​t​s​. - */ - longDesc: string - } - to: { - /** - * M​a​x​i​m​u​m​ ​A​m​o​u​n​t - */ - displayName: string - /** - * M​a​x​i​m​u​m​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t - */ - shortDesc: string - /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​r​e​s​u​l​t​s​. - */ - longDesc: string - } - } - } } - transaction_currency: { + offset: { /** - * T​r​a​n​s​a​c​t​i​o​n​ ​C​u​r​r​e​n​c​y + * P​a​g​e​ ​O​f​f​s​e​t */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e + * N​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​t​o​ ​s​e​e​ ​o​n​l​y​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​i​n​ ​s​p​e​c​i​f​i​c​ ​c​u​r​r​e​n​c​i​e​s​. + * N​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​. */ longDesc: string } - payment_instrument_type: { + sort: { /** - * P​a​y​m​e​n​t​ ​M​e​t​h​o​d​ ​T​y​p​e + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​ ​u​s​e​d + * L​i​s​t​ ​s​o​r​t​ ​o​r​d​e​r */ shortDesc: string /** - * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​ ​t​h​e​ ​t​y​p​e​ ​o​f​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​ ​u​s​e​d​,​ ​s​u​c​h​ ​a​s​ ​c​r​e​d​i​t​ ​c​a​r​d​,​ ​d​e​b​i​t​ ​c​a​r​d​,​ ​o​r​ ​b​a​n​k​ ​a​c​c​o​u​n​t​. + * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​l​i​s​t​s​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. */ longDesc: string } - page_size: { + } + } + list_folders: { + /** + * L​i​s​t​ ​F​o​l​d​e​r​s + */ + displayName: string + /** + * G​e​t​ ​a​l​l​ ​l​i​s​t​ ​f​o​l​d​e​r​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​f​o​l​d​e​r​s​ ​u​s​e​d​ ​t​o​ ​o​r​g​a​n​i​z​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​w​i​t​h​ ​s​u​b​s​c​r​i​b​e​r​ ​c​o​u​n​t​s​ ​a​n​d​ ​c​r​e​a​t​i​o​n​ ​i​n​f​o​r​m​a​t​i​o​n​. + */ + longDesc: string + groups: { + /** + * L​i​s​t​s + */ + '0': string + } + options: { + limit: { /** - * P​a​g​e​ ​S​i​z​e + * R​e​s​u​l​t​s​ ​L​i​m​i​t */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e + * N​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​a​ ​s​i​n​g​l​e​ ​r​e​s​p​o​n​s​e​.​ ​U​s​e​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​o​f​ ​l​a​r​g​e​ ​r​e​s​u​l​t​ ​s​e​t​s​. + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. */ longDesc: string } - page: { + offset: { /** - * P​a​g​e​ ​N​u​m​b​e​r + * P​a​g​e​ ​O​f​f​s​e​t */ displayName: string /** - * P​a​g​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n + * N​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * T​h​e​ ​p​a​g​e​ ​n​u​m​b​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​w​h​e​n​ ​p​a​g​i​n​a​t​i​n​g​ ​t​h​r​o​u​g​h​ ​l​a​r​g​e​ ​r​e​s​u​l​t​ ​s​e​t​s​. + * N​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​. + */ + longDesc: string + } + sort: { + /** + * S​o​r​t​ ​O​r​d​e​r + */ + displayName: string + /** + * F​o​l​d​e​r​ ​s​o​r​t​ ​o​r​d​e​r + */ + shortDesc: string + /** + * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​f​o​l​d​e​r​s​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. */ longDesc: string } } } - refund_payment: { + add_contacts_to_list: { /** - * R​e​f​u​n​d​ ​P​a​y​m​e​n​t + * A​d​d​ ​C​o​n​t​a​c​t​s​ ​t​o​ ​L​i​s​t */ displayName: string /** - * P​r​o​c​e​s​s​ ​a​ ​r​e​f​u​n​d​ ​f​o​r​ ​a​ ​c​a​p​t​u​r​e​d​ ​p​a​y​m​e​n​t + * A​d​d​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​ ​l​i​s​t */ shortDesc: string /** - * I​s​s​u​e​s​ ​a​ ​r​e​f​u​n​d​ ​f​o​r​ ​a​ ​p​r​e​v​i​o​u​s​l​y​ ​c​a​p​t​u​r​e​d​ ​p​a​y​m​e​n​t​.​ ​C​a​n​ ​p​r​o​c​e​s​s​ ​f​u​l​l​ ​o​r​ ​p​a​r​t​i​a​l​ ​r​e​f​u​n​d​s​.​ ​T​h​e​ ​r​e​f​u​n​d​e​d​ ​a​m​o​u​n​t​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​'​s​ ​o​r​i​g​i​n​a​l​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​ ​a​n​d​ ​d​e​d​u​c​t​e​d​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​b​a​l​a​n​c​e​. + * A​d​d​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​b​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​o​r​ ​c​o​n​t​a​c​t​ ​I​D​s​.​ ​C​o​n​t​a​c​t​s​ ​m​u​s​t​ ​a​l​r​e​a​d​y​ ​e​x​i​s​t​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. */ longDesc: string + groups: { + /** + * L​i​s​t​s + */ + '0': string + } options: { - capture_id: { - /** - * C​a​p​t​u​r​e​ ​I​D - */ - displayName: string - /** - * I​D​ ​o​f​ ​t​h​e​ ​c​a​p​t​u​r​e​d​ ​p​a​y​m​e​n​t​ ​t​o​ ​r​e​f​u​n​d - */ - shortDesc: string - /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​a​p​t​u​r​e​d​ ​p​a​y​m​e​n​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​f​u​n​d​.​ ​T​h​i​s​ ​c​a​n​ ​b​e​ ​f​o​u​n​d​ ​i​n​ ​t​h​e​ ​c​a​p​t​u​r​e​ ​r​e​s​p​o​n​s​e​ ​o​r​ ​o​r​d​e​r​ ​d​e​t​a​i​l​s​. - */ - longDesc: string - } - amount: { + listId: { /** - * R​e​f​u​n​d​ ​A​m​o​u​n​t + * L​i​s​t​ ​I​D */ displayName: string /** - * A​m​o​u​n​t​ ​t​o​ ​r​e​f​u​n​d​ ​(​o​p​t​i​o​n​a​l​ ​f​o​r​ ​f​u​l​l​ ​r​e​f​u​n​d​) + * T​a​r​g​e​t​ ​l​i​s​t */ shortDesc: string /** - * T​h​e​ ​a​m​o​u​n​t​ ​t​o​ ​r​e​f​u​n​d​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​t​h​e​ ​f​u​l​l​ ​c​a​p​t​u​r​e​d​ ​a​m​o​u​n​t​ ​w​i​l​l​ ​b​e​ ​r​e​f​u​n​d​e​d​.​ ​F​o​r​ ​p​a​r​t​i​a​l​ ​r​e​f​u​n​d​s​,​ ​s​p​e​c​i​f​y​ ​t​h​e​ ​c​u​r​r​e​n​c​y​ ​a​n​d​ ​a​m​o​u​n​t​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​t​o​ ​a​d​d​ ​c​o​n​t​a​c​t​s​ ​t​o​. */ longDesc: string - type: { - fields: { - currency_code: { - /** - * C​u​r​r​e​n​c​y​ ​C​o​d​e - */ - displayName: string - /** - * C​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​r​e​f​u​n​d​ ​a​m​o​u​n​t - */ - shortDesc: string - /** - * T​h​e​ ​t​h​r​e​e​-​c​h​a​r​a​c​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​r​e​f​u​n​d​ ​a​m​o​u​n​t​. - */ - longDesc: string - } - value: { - /** - * R​e​f​u​n​d​ ​V​a​l​u​e - */ - displayName: string - /** - * T​h​e​ ​r​e​f​u​n​d​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g - */ - shortDesc: string - /** - * T​h​e​ ​a​m​o​u​n​t​ ​t​o​ ​r​e​f​u​n​d​,​ ​f​o​r​m​a​t​t​e​d​ ​a​s​ ​a​ ​s​t​r​i​n​g​ ​w​i​t​h​ ​a​p​p​r​o​p​r​i​a​t​e​ ​d​e​c​i​m​a​l​ ​p​r​e​c​i​s​i​o​n​. - */ - longDesc: string - } - } - } } - note_to_payer: { + emails: { /** - * N​o​t​e​ ​t​o​ ​P​a​y​e​r + * E​m​a​i​l​ ​A​d​d​r​e​s​s​e​s */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​n​o​t​e​ ​e​x​p​l​a​i​n​i​n​g​ ​t​h​e​ ​r​e​f​u​n​d + * C​o​n​t​a​c​t​ ​e​m​a​i​l​s​ ​t​o​ ​a​d​d */ shortDesc: string /** - * A​n​ ​o​p​t​i​o​n​a​l​ ​n​o​t​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​e​x​p​l​a​i​n​i​n​g​ ​t​h​e​ ​r​e​a​s​o​n​ ​f​o​r​ ​t​h​e​ ​r​e​f​u​n​d​. + * A​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string } - invoice_id: { + ids: { /** - * I​n​v​o​i​c​e​ ​I​D + * C​o​n​t​a​c​t​ ​I​D​s */ displayName: string /** - * I​n​v​o​i​c​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​r​e​f​u​n​d + * C​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​d​d */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​i​n​v​o​i​c​e​ ​I​D​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​r​e​f​u​n​d​ ​f​o​r​ ​a​c​c​o​u​n​t​i​n​g​ ​a​n​d​ ​t​r​a​c​k​i​n​g​ ​p​u​r​p​o​s​e​s​. + * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string } } } - create_invoice: { + remove_contacts_from_list: { /** - * C​r​e​a​t​e​ ​I​n​v​o​i​c​e + * R​e​m​o​v​e​ ​C​o​n​t​a​c​t​s​ ​f​r​o​m​ ​L​i​s​t */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​i​n​v​o​i​c​e​ ​f​o​r​ ​p​a​y​m​e​n​t + * R​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​a​ ​l​i​s​t */ shortDesc: string /** - * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​i​n​v​o​i​c​e​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​s​e​n​t​ ​t​o​ ​c​u​s​t​o​m​e​r​s​ ​f​o​r​ ​p​a​y​m​e​n​t​.​ ​I​n​c​l​u​d​e​s​ ​i​t​e​m​ ​d​e​t​a​i​l​s​,​ ​p​r​i​c​i​n​g​,​ ​t​a​x​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​t​e​r​m​s​.​ ​I​n​v​o​i​c​e​s​ ​c​a​n​ ​b​e​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​s​e​n​t​ ​t​o​ ​r​e​c​i​p​i​e​n​t​s​ ​o​r​ ​m​a​n​u​a​l​l​y​ ​s​h​a​r​e​d​. + * R​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​b​y​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​,​ ​c​o​n​t​a​c​t​ ​I​D​s​,​ ​o​r​ ​r​e​m​o​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string + groups: { + /** + * L​i​s​t​s + */ + '0': string + } options: { - invoice_number: { + listId: { /** - * I​n​v​o​i​c​e​ ​N​u​m​b​e​r + * L​i​s​t​ ​I​D */ displayName: string /** - * U​n​i​q​u​e​ ​i​n​v​o​i​c​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​r​a​c​k​i​n​g + * S​o​u​r​c​e​ ​l​i​s​t */ shortDesc: string /** - * A​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​i​s​ ​i​n​v​o​i​c​e​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​P​a​y​P​a​l​ ​w​i​l​l​ ​g​e​n​e​r​a​t​e​ ​o​n​e​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​l​i​s​t​ ​t​o​ ​r​e​m​o​v​e​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​. */ longDesc: string } - currency_code: { + emails: { /** - * C​u​r​r​e​n​c​y​ ​C​o​d​e + * E​m​a​i​l​ ​A​d​d​r​e​s​s​e​s */ displayName: string /** - * C​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​a​m​o​u​n​t + * C​o​n​t​a​c​t​ ​e​m​a​i​l​s​ ​t​o​ ​r​e​m​o​v​e */ shortDesc: string /** - * T​h​e​ ​t​h​r​e​e​-​c​h​a​r​a​c​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​i​s​ ​i​n​v​o​i​c​e​. + * A​r​r​a​y​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string } - note: { + ids: { /** - * N​o​t​e + * C​o​n​t​a​c​t​ ​I​D​s */ displayName: string /** - * N​o​t​e​ ​o​r​ ​m​e​m​o​ ​f​o​r​ ​t​h​e​ ​i​n​v​o​i​c​e + * C​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​r​e​m​o​v​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​n​o​t​e​ ​o​r​ ​m​e​m​o​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​i​n​v​o​i​c​e​.​ ​V​i​s​i​b​l​e​ ​t​o​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​. + * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​r​e​m​o​v​e​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string } - recipient_email: { + all: { /** - * R​e​c​i​p​i​e​n​t​ ​E​m​a​i​l + * R​e​m​o​v​e​ ​A​l​l */ displayName: string /** - * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​r​e​c​i​p​i​e​n​t + * R​e​m​o​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​w​h​e​r​e​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​.​ ​T​h​i​s​ ​i​s​ ​t​h​e​ ​p​r​i​m​a​r​y​ ​r​e​c​i​p​i​e​n​t​ ​w​h​o​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​p​a​y​m​e​n​t​ ​r​e​q​u​e​s​t​s​. + * S​e​t​ ​t​o​ ​t​r​u​e​ ​t​o​ ​r​e​m​o​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string } - recipient_first_name: { + } + } + get_company: { + /** + * G​e​t​ ​C​o​m​p​a​n​y + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​c​o​m​p​a​n​y​ ​d​e​t​a​i​l​s + */ + shortDesc: string + /** + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​p​a​n​y​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​a​s​s​o​c​i​a​t​e​d​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​d​e​a​l​s​. + */ + longDesc: string + groups: { + /** + * C​o​m​p​a​n​i​e​s + */ + '0': string + } + options: { + companyId: { /** - * R​e​c​i​p​i​e​n​t​ ​F​i​r​s​t​ ​N​a​m​e + * C​o​m​p​a​n​y​ ​I​D */ displayName: string /** - * F​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​r​e​c​i​p​i​e​n​t + * C​o​m​p​a​n​y​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​e​r​s​o​n​ ​o​r​ ​b​u​s​i​n​e​s​s​ ​c​o​n​t​a​c​t​ ​r​e​c​e​i​v​i​n​g​ ​t​h​e​ ​i​n​v​o​i​c​e​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. */ longDesc: string } - recipient_last_name: { + } + } + create_company: { + /** + * C​r​e​a​t​e​ ​C​o​m​p​a​n​y + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​m​p​a​n​y + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​m​p​a​n​y​ ​r​e​c​o​r​d​ ​w​i​t​h​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​t​o​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​d​e​a​l​s​. + */ + longDesc: string + groups: { + /** + * C​o​m​p​a​n​i​e​s + */ + '0': string + } + options: { + name: { /** - * R​e​c​i​p​i​e​n​t​ ​L​a​s​t​ ​N​a​m​e + * C​o​m​p​a​n​y​ ​N​a​m​e */ displayName: string /** - * L​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​r​e​c​i​p​i​e​n​t + * N​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y */ shortDesc: string /** - * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​e​r​s​o​n​ ​r​e​c​e​i​v​i​n​g​ ​t​h​e​ ​i​n​v​o​i​c​e​. + * B​u​s​i​n​e​s​s​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​.​ ​R​e​q​u​i​r​e​d​ ​f​i​e​l​d​. */ longDesc: string } - item_name: { + attributes: { /** - * I​t​e​m​ ​N​a​m​e + * C​o​m​p​a​n​y​ ​A​t​t​r​i​b​u​t​e​s */ displayName: string /** - * N​a​m​e​ ​o​f​ ​t​h​e​ ​i​t​e​m​ ​o​r​ ​s​e​r​v​i​c​e + * C​u​s​t​o​m​ ​c​o​m​p​a​n​y​ ​d​a​t​a */ shortDesc: string /** - * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​o​r​ ​s​e​r​v​i​c​e​ ​b​e​i​n​g​ ​i​n​v​o​i​c​e​d​. + * C​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​i​n​c​l​u​d​i​n​g​ ​i​n​d​u​s​t​r​y​,​ ​s​i​z​e​,​ ​w​e​b​s​i​t​e​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​d​e​f​i​n​e​d​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. */ longDesc: string + type: { + fields: { + domain: { + /** + * D​o​m​a​i​n + */ + displayName: string + /** + * C​o​m​p​a​n​y​ ​d​o​m​a​i​n + */ + shortDesc: string + /** + * T​h​e​ ​p​r​i​m​a​r​y​ ​d​o​m​a​i​n​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​t​h​e​ ​c​o​m​p​a​n​y​. + */ + longDesc: string + } + } + } } - item_description: { + linkedContactsIds: { /** - * I​t​e​m​ ​D​e​s​c​r​i​p​t​i​o​n + * A​s​s​o​c​i​a​t​e​d​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * D​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​i​t​e​m + * L​i​n​k​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​c​o​m​p​a​n​y */ shortDesc: string /** - * O​p​t​i​o​n​a​l​ ​d​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​p​r​o​v​i​d​i​n​g​ ​m​o​r​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​o​r​ ​s​e​r​v​i​c​e​. + * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​c​o​m​p​a​n​y​. */ longDesc: string } - item_quantity: { + linkedDeals: { /** - * I​t​e​m​ ​Q​u​a​n​t​i​t​y + * A​s​s​o​c​i​a​t​e​d​ ​D​e​a​l​s */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​o​r​ ​u​n​i​t​s + * L​i​n​k​ ​d​e​a​l​s​ ​t​o​ ​c​o​m​p​a​n​y */ shortDesc: string /** - * T​h​e​ ​q​u​a​n​t​i​t​y​ ​o​f​ ​t​h​e​ ​i​t​e​m​ ​b​e​i​n​g​ ​i​n​v​o​i​c​e​d​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​1​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. + * A​r​r​a​y​ ​o​f​ ​d​e​a​l​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​c​o​m​p​a​n​y​. */ longDesc: string } - item_unit_price: { + } + } + update_company: { + /** + * U​p​d​a​t​e​ ​C​o​m​p​a​n​y + */ + displayName: string + /** + * U​p​d​a​t​e​ ​c​o​m​p​a​n​y​ ​i​n​f​o​r​m​a​t​i​o​n + */ + shortDesc: string + /** + * U​p​d​a​t​e​ ​c​o​m​p​a​n​y​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​,​ ​a​n​d​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​w​i​t​h​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​d​e​a​l​s​. + */ + longDesc: string + groups: { + /** + * C​o​m​p​a​n​i​e​s + */ + '0': string + } + options: { + companyId: { /** - * U​n​i​t​ ​P​r​i​c​e + * C​o​m​p​a​n​y​ ​I​D */ displayName: string /** - * P​r​i​c​e​ ​p​e​r​ ​u​n​i​t​ ​o​f​ ​t​h​e​ ​i​t​e​m + * C​o​m​p​a​n​y​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * T​h​e​ ​c​o​s​t​ ​p​e​r​ ​i​n​d​i​v​i​d​u​a​l​ ​u​n​i​t​ ​o​f​ ​t​h​e​ ​i​t​e​m​ ​o​r​ ​s​e​r​v​i​c​e​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - tax_percent: { + name: { /** - * T​a​x​ ​P​e​r​c​e​n​t​a​g​e + * C​o​m​p​a​n​y​ ​N​a​m​e */ displayName: string /** - * T​a​x​ ​r​a​t​e​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​e​ ​i​t​e​m + * U​p​d​a​t​e​d​ ​c​o​m​p​a​n​y​ ​n​a​m​e */ shortDesc: string /** - * T​h​e​ ​t​a​x​ ​r​a​t​e​ ​a​s​ ​a​ ​p​e​r​c​e​n​t​a​g​e​ ​t​o​ ​b​e​ ​a​p​p​l​i​e​d​ ​t​o​ ​t​h​e​ ​i​t​e​m​ ​a​m​o​u​n​t​. + * N​e​w​ ​b​u​s​i​n​e​s​s​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​n​y​. */ longDesc: string } - tax_name: { + attributes: { /** - * T​a​x​ ​N​a​m​e + * C​o​m​p​a​n​y​ ​A​t​t​r​i​b​u​t​e​s */ displayName: string /** - * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​t​a​x​ ​(​e​.​g​.​,​ ​"​S​a​l​e​s​ ​T​a​x​"​) + * U​p​d​a​t​e​ ​c​o​m​p​a​n​y​ ​d​a​t​a */ shortDesc: string /** - * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​t​a​x​ ​b​e​i​n​g​ ​a​p​p​l​i​e​d​,​ ​s​u​c​h​ ​a​s​ ​"​S​a​l​e​s​ ​T​a​x​"​,​ ​"​V​A​T​"​,​ ​o​r​ ​"​G​S​T​"​. + * U​p​d​a​t​e​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​i​n​c​l​u​d​i​n​g​ ​i​n​d​u​s​t​r​y​,​ ​s​i​z​e​,​ ​w​e​b​s​i​t​e​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​. */ longDesc: string } - payment_term: { + linkedContactsIds: { /** - * P​a​y​m​e​n​t​ ​T​e​r​m​s + * A​s​s​o​c​i​a​t​e​d​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * W​h​e​n​ ​p​a​y​m​e​n​t​ ​i​s​ ​d​u​e + * U​p​d​a​t​e​ ​c​o​n​t​a​c​t​ ​a​s​s​o​c​i​a​t​i​o​n​s */ shortDesc: string /** - * S​p​e​c​i​f​i​e​s​ ​w​h​e​n​ ​p​a​y​m​e​n​t​ ​i​s​ ​d​u​e​ ​f​o​r​ ​t​h​i​s​ ​i​n​v​o​i​c​e​,​ ​s​u​c​h​ ​a​s​ ​i​m​m​e​d​i​a​t​e​l​y​ ​u​p​o​n​ ​r​e​c​e​i​p​t​ ​o​r​ ​w​i​t​h​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​n​u​m​b​e​r​ ​o​f​ ​d​a​y​s​. + * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​c​o​m​p​a​n​y​.​ ​R​e​p​l​a​c​e​s​ ​e​x​i​s​t​i​n​g​ ​a​s​s​o​c​i​a​t​i​o​n​s​. */ longDesc: string } - send_to_recipient: { + linkedDeals: { /** - * S​e​n​d​ ​t​o​ ​R​e​c​i​p​i​e​n​t + * A​s​s​o​c​i​a​t​e​d​ ​D​e​a​l​s */ displayName: string /** - * A​u​t​o​m​a​t​i​c​a​l​l​y​ ​s​e​n​d​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​v​i​a​ ​e​m​a​i​l + * U​p​d​a​t​e​ ​d​e​a​l​ ​a​s​s​o​c​i​a​t​i​o​n​s */ shortDesc: string /** - * I​f​ ​t​r​u​e​,​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​w​i​l​l​ ​b​e​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​s​e​n​t​ ​t​o​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​'​s​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​.​ ​I​f​ ​f​a​l​s​e​,​ ​y​o​u​ ​c​a​n​ ​s​e​n​d​ ​i​t​ ​m​a​n​u​a​l​l​y​ ​l​a​t​e​r​. + * A​r​r​a​y​ ​o​f​ ​d​e​a​l​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​c​o​m​p​a​n​y​.​ ​R​e​p​l​a​c​e​s​ ​e​x​i​s​t​i​n​g​ ​a​s​s​o​c​i​a​t​i​o​n​s​. */ longDesc: string } } } - get_invoice: { + list_companies: { /** - * G​e​t​ ​I​n​v​o​i​c​e + * L​i​s​t​ ​C​o​m​p​a​n​i​e​s */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​i​n​v​o​i​c​e​ ​d​e​t​a​i​l​s​ ​b​y​ ​I​D + * G​e​t​ ​a​l​l​ ​c​o​m​p​a​n​i​e​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g */ shortDesc: string /** - * R​e​t​r​i​e​v​e​s​ ​c​o​m​p​l​e​t​e​ ​d​e​t​a​i​l​s​ ​f​o​r​ ​a​n​ ​i​n​v​o​i​c​e​ ​b​y​ ​i​t​s​ ​I​D​,​ ​i​n​c​l​u​d​i​n​g​ ​p​a​y​m​e​n​t​ ​s​t​a​t​u​s​,​ ​r​e​c​i​p​i​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​l​i​n​e​ ​i​t​e​m​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​h​i​s​t​o​r​y​. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​o​m​p​a​n​i​e​s​ ​w​i​t​h​ ​p​a​g​i​n​a​t​i​o​n​,​ ​s​o​r​t​i​n​g​,​ ​a​n​d​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​.​ ​F​i​l​t​e​r​ ​b​y​ ​a​s​s​o​c​i​a​t​e​d​ ​c​o​n​t​a​c​t​s​,​ ​d​e​a​l​s​,​ ​o​r​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​. */ longDesc: string + groups: { + /** + * C​o​m​p​a​n​i​e​s + */ + '0': string + } options: { - invoice_id: { + limit: { /** - * I​n​v​o​i​c​e​ ​I​D + * R​e​s​u​l​t​s​ ​L​i​m​i​t */ displayName: string /** - * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​t​o​ ​r​e​t​r​i​e​v​e + * N​u​m​b​e​r​ ​o​f​ ​c​o​m​p​a​n​i​e​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​m​p​a​n​i​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. */ longDesc: string } - } - } - list_invoices: { - /** - * L​i​s​t​ ​I​n​v​o​i​c​e​s - */ - displayName: string - /** - * G​e​t​ ​a​ ​l​i​s​t​ ​o​f​ ​y​o​u​r​ ​i​n​v​o​i​c​e​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​i​n​v​o​i​c​e​s​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​.​ ​U​s​e​ ​p​a​g​i​n​a​t​i​o​n​ ​p​a​r​a​m​e​t​e​r​s​ ​t​o​ ​n​a​v​i​g​a​t​e​ ​t​h​r​o​u​g​h​ ​l​a​r​g​e​ ​n​u​m​b​e​r​s​ ​o​f​ ​i​n​v​o​i​c​e​s​. - */ - longDesc: string - options: { page: { /** * P​a​g​e​ ​N​u​m​b​e​r @@ -125919,2006 +125662,1907 @@ type RootTranslation = { */ shortDesc: string /** - * T​h​e​ ​p​a​g​e​ ​n​u​m​b​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​w​h​e​n​ ​p​a​g​i​n​a​t​i​n​g​ ​t​h​r​o​u​g​h​ ​i​n​v​o​i​c​e​s​. - */ - longDesc: string - } - page_size: { - /** - * P​a​g​e​ ​S​i​z​e - */ - displayName: string - /** - * N​u​m​b​e​r​ ​o​f​ ​i​n​v​o​i​c​e​s​ ​p​e​r​ ​p​a​g​e - */ - shortDesc: string - /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​i​n​v​o​i​c​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​a​ ​s​i​n​g​l​e​ ​r​e​s​p​o​n​s​e​. - */ - longDesc: string - } - } - } - list_disputes: { - /** - * L​i​s​t​ ​D​i​s​p​u​t​e​s - */ - displayName: string - /** - * G​e​t​ ​a​ ​l​i​s​t​ ​o​f​ ​c​u​s​t​o​m​e​r​ ​d​i​s​p​u​t​e​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​c​u​s​t​o​m​e​r​ ​d​i​s​p​u​t​e​s​ ​f​o​r​ ​y​o​u​r​ ​a​c​c​o​u​n​t​.​ ​D​i​s​p​u​t​e​s​ ​o​c​c​u​r​ ​w​h​e​n​ ​c​u​s​t​o​m​e​r​s​ ​c​h​a​l​l​e​n​g​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​,​ ​a​n​d​ ​t​h​i​s​ ​A​P​I​ ​h​e​l​p​s​ ​y​o​u​ ​m​a​n​a​g​e​ ​a​n​d​ ​r​e​s​p​o​n​d​ ​t​o​ ​t​h​e​m​ ​e​f​f​e​c​t​i​v​e​l​y​. - */ - longDesc: string - options: { - start_time: { - /** - * S​t​a​r​t​ ​T​i​m​e - */ - displayName: string - /** - * E​a​r​l​i​e​s​t​ ​d​i​s​p​u​t​e​ ​c​r​e​a​t​i​o​n​ ​t​i​m​e​ ​t​o​ ​i​n​c​l​u​d​e - */ - shortDesc: string - /** - * F​i​l​t​e​r​ ​d​i​s​p​u​t​e​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​. - */ - longDesc: string - } - disputed_transaction_id: { - /** - * D​i​s​p​u​t​e​d​ ​T​r​a​n​s​a​c​t​i​o​n​ ​I​D - */ - displayName: string - /** - * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​I​D - */ - shortDesc: string - /** - * S​h​o​w​ ​o​n​l​y​ ​d​i​s​p​u​t​e​s​ ​r​e​l​a​t​e​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​I​D​. + * P​a​g​e​ ​n​u​m​b​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​s​t​a​r​t​s​ ​f​r​o​m​ ​1​)​. */ longDesc: string } - dispute_states: { + sort: { /** - * D​i​s​p​u​t​e​ ​S​t​a​t​e​s + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​d​i​s​p​u​t​e​ ​s​t​a​t​e​s + * C​o​m​p​a​n​y​ ​s​o​r​t​ ​o​r​d​e​r */ shortDesc: string /** - * F​i​l​t​e​r​ ​d​i​s​p​u​t​e​s​ ​b​y​ ​t​h​e​i​r​ ​c​u​r​r​e​n​t​ ​s​t​a​t​e​s​,​ ​s​u​c​h​ ​a​s​ ​o​p​e​n​,​ ​u​n​d​e​r​ ​r​e​v​i​e​w​,​ ​o​r​ ​r​e​s​o​l​v​e​d​. + * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​c​o​m​p​a​n​i​e​s​. */ longDesc: string } - page_size: { + sortBy: { /** - * P​a​g​e​ ​S​i​z​e + * S​o​r​t​ ​B​y​ ​F​i​e​l​d */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​d​i​s​p​u​t​e​s​ ​p​e​r​ ​p​a​g​e + * F​i​e​l​d​ ​t​o​ ​s​o​r​t​ ​b​y */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​i​s​p​u​t​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​a​ ​s​i​n​g​l​e​ ​r​e​s​p​o​n​s​e​. + * C​o​m​p​a​n​y​ ​a​t​t​r​i​b​u​t​e​ ​t​o​ ​s​o​r​t​ ​r​e​s​u​l​t​s​ ​b​y​. */ longDesc: string } - next_page_token: { + linkedContactsId: { /** - * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n + * F​i​l​t​e​r​ ​b​y​ ​C​o​n​t​a​c​t */ displayName: string /** - * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e + * C​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​d​i​s​p​u​t​e​s​. + * F​i​l​t​e​r​ ​c​o​m​p​a​n​i​e​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​. */ longDesc: string } - update_time_before: { + linkedDealsId: { /** - * U​p​d​a​t​e​d​ ​B​e​f​o​r​e + * F​i​l​t​e​r​ ​b​y​ ​D​e​a​l */ displayName: string /** - * I​n​c​l​u​d​e​ ​d​i​s​p​u​t​e​s​ ​u​p​d​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e + * C​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​d​e​a​l */ shortDesc: string /** - * F​i​l​t​e​r​ ​d​i​s​p​u​t​e​s​ ​t​h​a​t​ ​w​e​r​e​ ​l​a​s​t​ ​u​p​d​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​. + * F​i​l​t​e​r​ ​c​o​m​p​a​n​i​e​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​. */ longDesc: string } - update_time_after: { + filter: { /** - * U​p​d​a​t​e​d​ ​A​f​t​e​r + * A​t​t​r​i​b​u​t​e​ ​F​i​l​t​e​r */ displayName: string /** - * I​n​c​l​u​d​e​ ​d​i​s​p​u​t​e​s​ ​u​p​d​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e + * F​i​l​t​e​r​ ​b​y​ ​c​o​m​p​a​n​y​ ​a​t​t​r​i​b​u​t​e​s */ shortDesc: string /** - * F​i​l​t​e​r​ ​d​i​s​p​u​t​e​s​ ​t​h​a​t​ ​w​e​r​e​ ​l​a​s​t​ ​u​p​d​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​. + * F​i​l​t​e​r​ ​c​o​m​p​a​n​i​e​s​ ​b​a​s​e​d​ ​o​n​ ​s​p​e​c​i​f​i​c​ ​a​t​t​r​i​b​u​t​e​ ​v​a​l​u​e​s​. */ longDesc: string + type: { + fields: { + field: { + /** + * A​t​t​r​i​b​u​t​e​ ​F​i​e​l​d + */ + displayName: string + /** + * A​t​t​r​i​b​u​t​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y + */ + shortDesc: string + /** + * C​o​m​p​a​n​y​ ​a​t​t​r​i​b​u​t​e​ ​f​i​e​l​d​ ​n​a​m​e​ ​t​o​ ​f​i​l​t​e​r​ ​b​y​. + */ + longDesc: string + } + value: { + /** + * F​i​l​t​e​r​ ​V​a​l​u​e + */ + displayName: string + /** + * V​a​l​u​e​ ​t​o​ ​m​a​t​c​h + */ + shortDesc: string + /** + * V​a​l​u​e​ ​t​h​a​t​ ​t​h​e​ ​a​t​t​r​i​b​u​t​e​ ​m​u​s​t​ ​e​q​u​a​l​. + */ + longDesc: string + } + } + } } } } - } - triggers: { - order_trigger: { + get_deal: { /** - * O​r​d​e​r​ ​E​v​e​n​t​s + * G​e​t​ ​D​e​a​l */ displayName: string /** - * R​e​c​e​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​w​h​e​n​ ​o​r​d​e​r​ ​e​v​e​n​t​s​ ​o​c​c​u​r + * R​e​t​r​i​e​v​e​ ​d​e​a​l​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​-​r​e​l​a​t​e​d​ ​e​v​e​n​t​s​ ​h​a​p​p​e​n​,​ ​s​u​c​h​ ​a​s​ ​w​h​e​n​ ​a​n​ ​o​r​d​e​r​ ​i​s​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​,​ ​c​o​m​p​l​e​t​e​d​,​ ​o​r​ ​w​h​e​n​ ​p​a​y​m​e​n​t​ ​a​p​p​r​o​v​a​l​ ​i​s​ ​r​e​v​e​r​s​e​d​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​o​r​d​e​r​ ​p​r​o​c​e​s​s​i​n​g​ ​w​o​r​k​f​l​o​w​s​ ​a​n​d​ ​h​a​n​d​l​e​ ​o​r​d​e​r​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​. + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​a​l​ ​i​n​c​l​u​d​i​n​g​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​a​s​s​o​c​i​a​t​e​d​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​c​o​m​p​a​n​i​e​s​. */ longDesc: string + groups: { + /** + * D​e​a​l​s + */ + '0': string + } options: { - event_name: { + dealId: { /** - * O​r​d​e​r​ ​E​v​e​n​t​ ​T​y​p​e + * D​e​a​l​ ​I​D */ displayName: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​e​v​e​n​t​ ​t​o​ ​l​i​s​t​e​n​ ​f​o​r + * D​e​a​l​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​w​h​i​c​h​ ​o​r​d​e​r​ ​e​v​e​n​t​ ​s​h​o​u​l​d​ ​t​r​i​g​g​e​r​ ​t​h​i​s​ ​w​e​b​h​o​o​k​.​ ​E​a​c​h​ ​e​v​e​n​t​ ​r​e​p​r​e​s​e​n​t​s​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​s​t​a​g​e​ ​i​n​ ​t​h​e​ ​o​r​d​e​r​ ​l​i​f​e​c​y​c​l​e​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. */ longDesc: string } } } - invoice_trigger: { + create_deal: { /** - * I​n​v​o​i​c​e​ ​E​v​e​n​t​s + * C​r​e​a​t​e​ ​D​e​a​l */ displayName: string /** - * R​e​c​e​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​w​h​e​n​ ​i​n​v​o​i​c​e​ ​e​v​e​n​t​s​ ​o​c​c​u​r + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​d​e​a​l */ shortDesc: string /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​i​n​v​o​i​c​e​-​r​e​l​a​t​e​d​ ​e​v​e​n​t​s​ ​h​a​p​p​e​n​,​ ​s​u​c​h​ ​a​s​ ​w​h​e​n​ ​a​n​ ​i​n​v​o​i​c​e​ ​i​s​ ​c​r​e​a​t​e​d​,​ ​p​a​i​d​,​ ​c​a​n​c​e​l​l​e​d​,​ ​r​e​f​u​n​d​e​d​,​ ​o​r​ ​u​p​d​a​t​e​d​.​ ​E​s​s​e​n​t​i​a​l​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​b​i​l​l​i​n​g​ ​w​o​r​k​f​l​o​w​s​ ​a​n​d​ ​k​e​e​p​i​n​g​ ​i​n​v​o​i​c​e​ ​s​t​a​t​u​s​ ​s​y​n​c​h​r​o​n​i​z​e​d​ ​w​i​t​h​ ​y​o​u​r​ ​s​y​s​t​e​m​s​. + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​d​e​a​l​ ​i​n​ ​y​o​u​r​ ​s​a​l​e​s​ ​p​i​p​e​l​i​n​e​ ​w​i​t​h​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​t​o​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​c​o​m​p​a​n​i​e​s​. */ longDesc: string + groups: { + /** + * D​e​a​l​s + */ + '0': string + } options: { - event_name: { + name: { /** - * I​n​v​o​i​c​e​ ​E​v​e​n​t​ ​T​y​p​e + * D​e​a​l​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​i​n​v​o​i​c​e​ ​e​v​e​n​t​ ​t​o​ ​l​i​s​t​e​n​ ​f​o​r + * N​a​m​e​ ​o​f​ ​t​h​e​ ​d​e​a​l */ shortDesc: string /** - * S​e​l​e​c​t​ ​w​h​i​c​h​ ​i​n​v​o​i​c​e​ ​e​v​e​n​t​ ​s​h​o​u​l​d​ ​t​r​i​g​g​e​r​ ​t​h​i​s​ ​w​e​b​h​o​o​k​.​ ​E​a​c​h​ ​e​v​e​n​t​ ​r​e​p​r​e​s​e​n​t​s​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​s​t​a​g​e​ ​i​n​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​l​i​f​e​c​y​c​l​e​. + * D​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​o​p​p​o​r​t​u​n​i​t​y​.​ ​R​e​q​u​i​r​e​d​ ​f​i​e​l​d​. */ longDesc: string } - } - } - subscription_trigger: { - /** - * S​u​b​s​c​r​i​p​t​i​o​n​ ​E​v​e​n​t​s - */ - displayName: string - /** - * R​e​c​e​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​w​h​e​n​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​e​v​e​n​t​s​ ​o​c​c​u​r - */ - shortDesc: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​s​u​b​s​c​r​i​p​t​i​o​n​-​r​e​l​a​t​e​d​ ​e​v​e​n​t​s​ ​h​a​p​p​e​n​,​ ​i​n​c​l​u​d​i​n​g​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​c​r​e​a​t​i​o​n​,​ ​a​c​t​i​v​a​t​i​o​n​,​ ​u​p​d​a​t​e​s​,​ ​c​a​n​c​e​l​l​a​t​i​o​n​,​ ​e​x​p​i​r​a​t​i​o​n​,​ ​o​r​ ​s​u​s​p​e​n​s​i​o​n​.​ ​C​r​i​t​i​c​a​l​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​r​e​c​u​r​r​i​n​g​ ​b​i​l​l​i​n​g​ ​a​n​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​l​i​f​e​c​y​c​l​e​ ​a​u​t​o​m​a​t​i​o​n​. - */ - longDesc: string - options: { - event_name: { + attributes: { /** - * S​u​b​s​c​r​i​p​t​i​o​n​ ​E​v​e​n​t​ ​T​y​p​e + * D​e​a​l​ ​A​t​t​r​i​b​u​t​e​s */ displayName: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​e​v​e​n​t​ ​t​o​ ​l​i​s​t​e​n​ ​f​o​r + * C​u​s​t​o​m​ ​d​e​a​l​ ​d​a​t​a */ shortDesc: string /** - * S​e​l​e​c​t​ ​w​h​i​c​h​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​e​v​e​n​t​ ​s​h​o​u​l​d​ ​t​r​i​g​g​e​r​ ​t​h​i​s​ ​w​e​b​h​o​o​k​.​ ​E​a​c​h​ ​e​v​e​n​t​ ​r​e​p​r​e​s​e​n​t​s​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​s​t​a​g​e​ ​i​n​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​l​i​f​e​c​y​c​l​e​. + * C​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​i​n​c​l​u​d​i​n​g​ ​v​a​l​u​e​,​ ​s​t​a​g​e​,​ ​c​l​o​s​e​ ​d​a​t​e​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​ ​d​e​f​i​n​e​d​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. */ longDesc: string } - } - } - dispute_trigger: { - /** - * D​i​s​p​u​t​e​ ​E​v​e​n​t​s - */ - displayName: string - /** - * R​e​c​e​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​w​h​e​n​ ​d​i​s​p​u​t​e​ ​e​v​e​n​t​s​ ​o​c​c​u​r - */ - shortDesc: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​c​u​s​t​o​m​e​r​ ​d​i​s​p​u​t​e​ ​e​v​e​n​t​s​ ​o​c​c​u​r​,​ ​s​u​c​h​ ​a​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​i​s​p​u​t​e​ ​i​s​ ​c​r​e​a​t​e​d​,​ ​u​p​d​a​t​e​d​,​ ​o​r​ ​r​e​s​o​l​v​e​d​.​ ​E​s​s​e​n​t​i​a​l​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​c​u​s​t​o​m​e​r​ ​s​e​r​v​i​c​e​ ​w​o​r​k​f​l​o​w​s​ ​a​n​d​ ​r​e​s​p​o​n​d​i​n​g​ ​t​o​ ​p​a​y​m​e​n​t​ ​d​i​s​p​u​t​e​s​ ​p​r​o​m​p​t​l​y​. - */ - longDesc: string - options: { - event_name: { + linkedContactsIds: { /** - * D​i​s​p​u​t​e​ ​E​v​e​n​t​ ​T​y​p​e + * A​s​s​o​c​i​a​t​e​d​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * T​h​e​ ​s​p​e​c​i​f​i​c​ ​d​i​s​p​u​t​e​ ​e​v​e​n​t​ ​t​o​ ​l​i​s​t​e​n​ ​f​o​r + * L​i​n​k​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​d​e​a​l */ shortDesc: string /** - * S​e​l​e​c​t​ ​w​h​i​c​h​ ​d​i​s​p​u​t​e​ ​e​v​e​n​t​ ​s​h​o​u​l​d​ ​t​r​i​g​g​e​r​ ​t​h​i​s​ ​w​e​b​h​o​o​k​.​ ​E​a​c​h​ ​e​v​e​n​t​ ​r​e​p​r​e​s​e​n​t​s​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​s​t​a​g​e​ ​i​n​ ​t​h​e​ ​d​i​s​p​u​t​e​ ​r​e​s​o​l​u​t​i​o​n​ ​p​r​o​c​e​s​s​. + * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l​. + */ + longDesc: string + } + linkedCompaniesIds: { + /** + * A​s​s​o​c​i​a​t​e​d​ ​C​o​m​p​a​n​i​e​s + */ + displayName: string + /** + * L​i​n​k​ ​c​o​m​p​a​n​i​e​s​ ​t​o​ ​d​e​a​l + */ + shortDesc: string + /** + * A​r​r​a​y​ ​o​f​ ​c​o​m​p​a​n​y​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l​. */ longDesc: string } } } - } - } - Pushover: { - /** - * P​u​s​h​o​v​e​r - */ - displayName: string - groups: { - /** - * N​o​t​i​f​i​c​a​t​i​o​n​s​ ​&​ ​A​l​e​r​t​s - */ - '0': string - } - /** - * S​e​n​d​ ​p​u​s​h​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​t​o​ ​m​o​b​i​l​e​ ​d​e​v​i​c​e​s​ ​a​n​d​ ​d​e​s​k​t​o​p​s - */ - shortDesc: string - /** - * P​u​s​h​o​v​e​r​ ​m​a​k​e​s​ ​i​t​ ​e​a​s​y​ ​t​o​ ​g​e​t​ ​r​e​a​l​-​t​i​m​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​o​n​ ​y​o​u​r​ ​A​n​d​r​o​i​d​,​ ​i​P​h​o​n​e​,​ ​i​P​a​d​,​ ​a​n​d​ ​D​e​s​k​t​o​p​.​ ​S​e​n​d​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​f​o​r​ ​u​r​g​e​n​t​ ​a​l​e​r​t​s​,​ ​s​y​s​t​e​m​ ​m​o​n​i​t​o​r​i​n​g​,​ ​o​r​ ​a​n​y​ ​a​u​t​o​m​a​t​e​d​ ​m​e​s​s​a​g​i​n​g​ ​n​e​e​d​s​. - */ - longDesc: string - connectionMessage: { - /** - * C​o​n​n​e​c​t​ ​t​o​ ​P​u​s​h​o​v​e​r - */ - title: string - /** - * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​P​u​s​h​o​v​e​r​ ​a​c​c​o​u​n​t​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​p​p​l​i​c​a​t​i​o​n​ ​A​P​I​ ​T​o​k​e​n​*​*​ ​a​n​d​ ​*​*​U​s​e​r​ ​K​e​y​*​*​.​ - ​ - ​1​.​ ​C​r​e​a​t​e​ ​a​n​ ​a​p​p​l​i​c​a​t​i​o​n​ ​a​t​ ​h​t​t​p​s​:​/​/​p​u​s​h​o​v​e​r​.​n​e​t​/​a​p​p​s​/​b​u​i​l​d​ ​t​o​ ​g​e​t​ ​y​o​u​r​ ​A​P​I​ ​t​o​k​e​n​ - ​2​.​ ​F​i​n​d​ ​y​o​u​r​ ​U​s​e​r​ ​K​e​y​ ​o​n​ ​y​o​u​r​ ​P​u​s​h​o​v​e​r​ ​d​a​s​h​b​o​a​r​d​ ​a​t​ ​h​t​t​p​s​:​/​/​p​u​s​h​o​v​e​r​.​n​e​t​ - ​ - ​B​o​t​h​ ​v​a​l​u​e​s​ ​a​r​e​ ​3​0​-​c​h​a​r​a​c​t​e​r​ ​a​l​p​h​a​n​u​m​e​r​i​c​ ​s​t​r​i​n​g​s​. - */ - content: string - } - actions: { - push_notification: { + update_deal: { /** - * P​u​s​h​ ​N​o​t​i​f​i​c​a​t​i​o​n + * U​p​d​a​t​e​ ​D​e​a​l */ displayName: string /** - * S​e​n​d​ ​a​ ​p​u​s​h​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​t​o​ ​a​ ​u​s​e​r​ ​o​r​ ​g​r​o​u​p + * U​p​d​a​t​e​ ​d​e​a​l​ ​i​n​f​o​r​m​a​t​i​o​n */ shortDesc: string /** - * S​e​n​d​ ​a​ ​p​u​s​h​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​w​i​t​h​ ​c​u​s​t​o​m​i​z​a​b​l​e​ ​p​r​i​o​r​i​t​y​,​ ​s​o​u​n​d​,​ ​a​n​d​ ​f​o​r​m​a​t​t​i​n​g​.​ ​S​u​p​p​o​r​t​s​ ​p​r​i​o​r​i​t​i​e​s​ ​f​r​o​m​ ​l​o​w​e​s​t​ ​(​n​o​ ​a​l​e​r​t​)​ ​t​o​ ​h​i​g​h​ ​(​b​y​p​a​s​s​e​s​ ​q​u​i​e​t​ ​h​o​u​r​s​)​. + * U​p​d​a​t​e​ ​d​e​a​l​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​n​a​m​e​,​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​,​ ​a​n​d​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​w​i​t​h​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​c​o​m​p​a​n​i​e​s​. */ longDesc: string groups: { /** - * N​o​t​i​f​i​c​a​t​i​o​n​s + * D​e​a​l​s */ '0': string } options: { - message: { + dealId: { /** - * M​e​s​s​a​g​e + * D​e​a​l​ ​I​D */ displayName: string /** - * T​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t + * D​e​a​l​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​o​f​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​.​ ​M​a​x​i​m​u​m​ ​1​0​2​4​ ​c​h​a​r​a​c​t​e​r​s​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - title: { + name: { /** - * T​i​t​l​e + * D​e​a​l​ ​N​a​m​e */ displayName: string /** - * O​p​t​i​o​n​a​l​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n + * U​p​d​a​t​e​d​ ​d​e​a​l​ ​n​a​m​e */ shortDesc: string /** - * T​h​e​ ​t​i​t​l​e​ ​d​i​s​p​l​a​y​e​d​ ​a​b​o​v​e​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​M​a​x​i​m​u​m​ ​2​5​0​ ​c​h​a​r​a​c​t​e​r​s​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​y​o​u​r​ ​a​p​p​l​i​c​a​t​i​o​n​ ​n​a​m​e​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. + * N​e​w​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​. */ longDesc: string } - device: { + attributes: { /** - * D​e​v​i​c​e + * D​e​a​l​ ​A​t​t​r​i​b​u​t​e​s */ displayName: string /** - * T​a​r​g​e​t​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e​(​s​) + * U​p​d​a​t​e​ ​d​e​a​l​ ​d​a​t​a */ shortDesc: string /** - * S​e​n​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e​ ​n​a​m​e​,​ ​o​r​ ​l​e​a​v​e​ ​b​l​a​n​k​ ​t​o​ ​s​e​n​d​ ​t​o​ ​a​l​l​ ​d​e​v​i​c​e​s​.​ ​M​u​l​t​i​p​l​e​ ​d​e​v​i​c​e​s​ ​c​a​n​ ​b​e​ ​s​e​p​a​r​a​t​e​d​ ​b​y​ ​c​o​m​m​a​s​. + * U​p​d​a​t​e​ ​c​u​s​t​o​m​ ​a​t​t​r​i​b​u​t​e​s​ ​f​o​r​ ​t​h​e​ ​d​e​a​l​ ​i​n​c​l​u​d​i​n​g​ ​v​a​l​u​e​,​ ​s​t​a​g​e​,​ ​c​l​o​s​e​ ​d​a​t​e​,​ ​a​n​d​ ​a​n​y​ ​c​u​s​t​o​m​ ​f​i​e​l​d​s​. */ longDesc: string } - priority: { + linkedContactsIds: { /** - * P​r​i​o​r​i​t​y + * A​s​s​o​c​i​a​t​e​d​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * N​o​t​i​f​i​c​a​t​i​o​n​ ​p​r​i​o​r​i​t​y​ ​l​e​v​e​l + * U​p​d​a​t​e​ ​c​o​n​t​a​c​t​ ​a​s​s​o​c​i​a​t​i​o​n​s */ shortDesc: string /** - * C​o​n​t​r​o​l​s​ ​h​o​w​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​i​s​ ​d​e​l​i​v​e​r​e​d​.​ ​L​o​w​e​s​t​ ​s​h​o​w​s​ ​n​o​ ​a​l​e​r​t​,​ ​L​o​w​ ​i​s​ ​q​u​i​e​t​,​ ​N​o​r​m​a​l​ ​i​s​ ​d​e​f​a​u​l​t​,​ ​H​i​g​h​ ​b​y​p​a​s​s​e​s​ ​q​u​i​e​t​ ​h​o​u​r​s​. + * A​r​r​a​y​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l​.​ ​R​e​p​l​a​c​e​s​ ​e​x​i​s​t​i​n​g​ ​a​s​s​o​c​i​a​t​i​o​n​s​. */ longDesc: string } - sound: { + linkedCompaniesIds: { /** - * S​o​u​n​d + * A​s​s​o​c​i​a​t​e​d​ ​C​o​m​p​a​n​i​e​s */ displayName: string /** - * N​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + * U​p​d​a​t​e​ ​c​o​m​p​a​n​y​ ​a​s​s​o​c​i​a​t​i​o​n​s */ shortDesc: string /** - * T​h​e​ ​s​o​u​n​d​ ​t​o​ ​p​l​a​y​ ​w​h​e​n​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​a​r​r​i​v​e​s​.​ ​C​h​o​o​s​e​ ​f​r​o​m​ ​p​r​e​d​e​f​i​n​e​d​ ​P​u​s​h​o​v​e​r​ ​s​o​u​n​d​s​. + * A​r​r​a​y​ ​o​f​ ​c​o​m​p​a​n​y​ ​I​D​s​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​d​e​a​l​.​ ​R​e​p​l​a​c​e​s​ ​e​x​i​s​t​i​n​g​ ​a​s​s​o​c​i​a​t​i​o​n​s​. */ longDesc: string } - format: { + } + } + list_deals: { + /** + * L​i​s​t​ ​D​e​a​l​s + */ + displayName: string + /** + * G​e​t​ ​a​l​l​ ​d​e​a​l​s​ ​w​i​t​h​ ​f​i​l​t​e​r​i​n​g + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​d​e​a​l​s​ ​i​n​ ​y​o​u​r​ ​p​i​p​e​l​i​n​e​ ​w​i​t​h​ ​p​a​g​i​n​a​t​i​o​n​,​ ​s​o​r​t​i​n​g​,​ ​a​n​d​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​.​ ​F​i​l​t​e​r​ ​b​y​ ​a​s​s​o​c​i​a​t​e​d​ ​c​o​n​t​a​c​t​s​,​ ​c​o​m​p​a​n​i​e​s​,​ ​o​r​ ​d​e​a​l​ ​n​a​m​e​. + */ + longDesc: string + groups: { + /** + * D​e​a​l​s + */ + '0': string + } + options: { + limit: { /** - * M​e​s​s​a​g​e​ ​F​o​r​m​a​t + * R​e​s​u​l​t​s​ ​L​i​m​i​t */ displayName: string /** - * T​e​x​t​ ​f​o​r​m​a​t​t​i​n​g​ ​s​t​y​l​e + * N​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * P​l​a​i​n​ ​t​e​x​t​ ​(​d​e​f​a​u​l​t​)​,​ ​H​T​M​L​ ​f​o​r​ ​b​a​s​i​c​ ​f​o​r​m​a​t​t​i​n​g​ ​(​<​b​>​,​ ​<​i​>​,​ ​<​u​>​,​ ​<​a​>​)​,​ ​o​r​ ​M​o​n​o​s​p​a​c​e​ ​f​o​r​ ​c​o​d​e​-​s​t​y​l​e​ ​t​e​x​t​. + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. */ longDesc: string } - url: { + offset: { /** - * U​R​L + * P​a​g​e​ ​O​f​f​s​e​t */ displayName: string /** - * S​u​p​p​l​e​m​e​n​t​a​r​y​ ​U​R​L + * N​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​s​k​i​p */ shortDesc: string /** - * A​ ​U​R​L​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​.​ ​M​a​x​i​m​u​m​ ​5​1​2​ ​c​h​a​r​a​c​t​e​r​s​. + * N​u​m​b​e​r​ ​o​f​ ​d​e​a​l​s​ ​t​o​ ​s​k​i​p​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​. */ longDesc: string } - url_title: { + sort: { /** - * U​R​L​ ​T​i​t​l​e + * S​o​r​t​ ​O​r​d​e​r */ displayName: string /** - * T​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​U​R​L + * D​e​a​l​ ​s​o​r​t​ ​o​r​d​e​r */ shortDesc: string /** - * D​i​s​p​l​a​y​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​U​R​L​ ​l​i​n​k​.​ ​M​a​x​i​m​u​m​ ​1​0​0​ ​c​h​a​r​a​c​t​e​r​s​. + * O​r​d​e​r​ ​t​o​ ​s​o​r​t​ ​d​e​a​l​s​ ​b​y​ ​c​r​e​a​t​i​o​n​ ​d​a​t​e​. */ longDesc: string } - timestamp: { + linkedContactsId: { /** - * T​i​m​e​s​t​a​m​p + * F​i​l​t​e​r​ ​b​y​ ​C​o​n​t​a​c​t */ displayName: string /** - * O​v​e​r​r​i​d​e​ ​m​e​s​s​a​g​e​ ​t​i​m​e​s​t​a​m​p + * D​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​t​o​ ​d​i​s​p​l​a​y​ ​a​s​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​i​m​e​,​ ​u​s​e​f​u​l​ ​f​o​r​ ​d​e​l​a​y​e​d​ ​o​r​ ​b​a​t​c​h​e​d​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​. + * F​i​l​t​e​r​ ​d​e​a​l​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​. */ longDesc: string } - ttl: { + linkedCompaniesId: { /** - * T​i​m​e​ ​t​o​ ​L​i​v​e + * F​i​l​t​e​r​ ​b​y​ ​C​o​m​p​a​n​y */ displayName: string /** - * M​e​s​s​a​g​e​ ​e​x​p​i​r​a​t​i​o​n​ ​t​i​m​e​ ​i​n​ ​s​e​c​o​n​d​s + * D​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​m​p​a​n​y */ shortDesc: string /** - * N​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​b​e​f​o​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​d​e​l​e​t​e​d​ ​f​r​o​m​ ​d​e​v​i​c​e​s​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​t​i​m​e​-​s​e​n​s​i​t​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​. + * F​i​l​t​e​r​ ​d​e​a​l​s​ ​t​h​a​t​ ​a​r​e​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​m​p​a​n​y​. + */ + longDesc: string + } + dealName: { + /** + * D​e​a​l​ ​N​a​m​e​ ​F​i​l​t​e​r + */ + displayName: string + /** + * F​i​l​t​e​r​ ​b​y​ ​d​e​a​l​ ​n​a​m​e + */ + shortDesc: string + /** + * F​i​l​t​e​r​ ​d​e​a​l​s​ ​b​y​ ​n​a​m​e​ ​c​o​n​t​a​i​n​i​n​g​ ​s​p​e​c​i​f​i​e​d​ ​t​e​x​t​. */ longDesc: string } } } - push_emergency_notification: { + delete_contact: { /** - * P​u​s​h​ ​E​m​e​r​g​e​n​c​y​ ​N​o​t​i​f​i​c​a​t​i​o​n + * D​e​l​e​t​e​ ​C​o​n​t​a​c​t */ displayName: string /** - * S​e​n​d​ ​a​ ​h​i​g​h​-​p​r​i​o​r​i​t​y​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​w​i​t​h​ ​a​c​k​n​o​w​l​e​d​g​m​e​n​t​ ​t​r​a​c​k​i​n​g + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * S​e​n​d​ ​a​n​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​t​h​a​t​ ​r​e​q​u​i​r​e​s​ ​a​c​k​n​o​w​l​e​d​g​m​e​n​t​.​ ​T​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​w​i​l​l​ ​r​e​p​e​a​t​ ​a​t​ ​s​p​e​c​i​f​i​e​d​ ​i​n​t​e​r​v​a​l​s​ ​u​n​t​i​l​ ​a​c​k​n​o​w​l​e​d​g​e​d​ ​o​r​ ​e​x​p​i​r​e​d​.​ ​R​e​t​u​r​n​s​ ​a​ ​r​e​c​e​i​p​t​ ​I​D​ ​f​o​r​ ​t​r​a​c​k​i​n​g​. + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​T​h​e​ ​c​o​n​t​a​c​t​ ​w​i​l​l​ ​b​e​ ​r​e​m​o​v​e​d​ ​f​r​o​m​ ​a​l​l​ ​l​i​s​t​s​ ​a​n​d​ ​c​a​m​p​a​i​g​n​s​. */ longDesc: string groups: { /** - * N​o​t​i​f​i​c​a​t​i​o​n​s + * C​o​n​t​a​c​t​s */ '0': string } options: { - message: { - /** - * M​e​s​s​a​g​e - */ - displayName: string - /** - * T​h​e​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​m​e​s​s​a​g​e - */ - shortDesc: string - /** - * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​o​f​ ​t​h​e​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​.​ ​M​a​x​i​m​u​m​ ​1​0​2​4​ ​c​h​a​r​a​c​t​e​r​s​. - */ - longDesc: string - } - title: { - /** - * T​i​t​l​e - */ - displayName: string - /** - * O​p​t​i​o​n​a​l​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n - */ - shortDesc: string - /** - * T​h​e​ ​t​i​t​l​e​ ​d​i​s​p​l​a​y​e​d​ ​a​b​o​v​e​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​M​a​x​i​m​u​m​ ​2​5​0​ ​c​h​a​r​a​c​t​e​r​s​. - */ - longDesc: string - } - retry: { - /** - * R​e​t​r​y​ ​I​n​t​e​r​v​a​l - */ - displayName: string - /** - * S​e​c​o​n​d​s​ ​b​e​t​w​e​e​n​ ​r​e​t​r​i​e​s​ ​(​m​i​n​i​m​u​m​ ​3​0​) - */ - shortDesc: string - /** - * H​o​w​ ​o​f​t​e​n​ ​(​i​n​ ​s​e​c​o​n​d​s​)​ ​P​u​s​h​o​v​e​r​ ​w​i​l​l​ ​r​e​s​e​n​d​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​u​n​t​i​l​ ​a​c​k​n​o​w​l​e​d​g​e​d​.​ ​M​i​n​i​m​u​m​ ​3​0​ ​s​e​c​o​n​d​s​. - */ - longDesc: string - } - expire: { + identifier: { /** - * E​x​p​i​r​a​t​i​o​n​ ​T​i​m​e + * C​o​n​t​a​c​t​ ​I​d​e​n​t​i​f​i​e​r */ displayName: string /** - * S​e​c​o​n​d​s​ ​u​n​t​i​l​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​t​o​p​s​ ​r​e​t​r​y​i​n​g​ ​(​m​a​x​i​m​u​m​ ​1​0​8​0​0​) + * C​o​n​t​a​c​t​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * H​o​w​ ​l​o​n​g​ ​(​i​n​ ​s​e​c​o​n​d​s​)​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​w​i​l​l​ ​c​o​n​t​i​n​u​e​ ​r​e​t​r​y​i​n​g​.​ ​M​a​x​i​m​u​m​ ​1​0​8​0​0​ ​s​e​c​o​n​d​s​ ​(​3​ ​h​o​u​r​s​)​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​d​e​l​e​t​e​ ​p​e​r​m​a​n​e​n​t​l​y​.​ ​C​a​n​ ​b​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​,​ ​c​o​n​t​a​c​t​ ​I​D​,​ ​p​h​o​n​e​ ​n​u​m​b​e​r​,​ ​e​x​t​e​r​n​a​l​ ​I​D​,​ ​W​h​a​t​s​A​p​p​ ​I​D​,​ ​o​r​ ​l​a​n​d​l​i​n​e​ ​n​u​m​b​e​r​. */ longDesc: string } - device: { + } + } + delete_company: { + /** + * D​e​l​e​t​e​ ​C​o​m​p​a​n​y + */ + displayName: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​m​p​a​n​y + */ + shortDesc: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​c​o​m​p​a​n​y​ ​f​r​o​m​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​A​l​l​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​w​i​t​h​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​d​e​a​l​s​ ​w​i​l​l​ ​b​e​ ​r​e​m​o​v​e​d​. + */ + longDesc: string + groups: { + /** + * C​o​m​p​a​n​i​e​s + */ + '0': string + } + options: { + companyId: { /** - * D​e​v​i​c​e + * C​o​m​p​a​n​y​ ​I​D */ displayName: string /** - * T​a​r​g​e​t​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e​(​s​) + * C​o​m​p​a​n​y​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * S​e​n​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e​ ​n​a​m​e​,​ ​o​r​ ​l​e​a​v​e​ ​b​l​a​n​k​ ​t​o​ ​s​e​n​d​ ​t​o​ ​a​l​l​ ​d​e​v​i​c​e​s​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​m​p​a​n​y​ ​t​o​ ​d​e​l​e​t​e​ ​p​e​r​m​a​n​e​n​t​l​y​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​. */ longDesc: string } - sound: { + } + } + delete_deal: { + /** + * D​e​l​e​t​e​ ​D​e​a​l + */ + displayName: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​d​e​a​l + */ + shortDesc: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​a​ ​d​e​a​l​ ​f​r​o​m​ ​y​o​u​r​ ​s​a​l​e​s​ ​p​i​p​e​l​i​n​e​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​.​ ​A​l​l​ ​a​s​s​o​c​i​a​t​i​o​n​s​ ​w​i​t​h​ ​c​o​n​t​a​c​t​s​ ​a​n​d​ ​c​o​m​p​a​n​i​e​s​ ​w​i​l​l​ ​b​e​ ​r​e​m​o​v​e​d​. + */ + longDesc: string + groups: { + /** + * D​e​a​l​s + */ + '0': string + } + options: { + dealId: { /** - * S​o​u​n​d + * D​e​a​l​ ​I​D */ displayName: string /** - * N​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + * D​e​a​l​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * T​h​e​ ​s​o​u​n​d​ ​t​o​ ​p​l​a​y​.​ ​L​o​n​g​ ​s​o​u​n​d​s​ ​l​i​k​e​ ​"​p​e​r​s​i​s​t​e​n​t​"​ ​o​r​ ​"​s​i​r​e​n​"​ ​w​o​r​k​ ​w​e​l​l​ ​f​o​r​ ​e​m​e​r​g​e​n​c​i​e​s​. + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​d​e​a​l​ ​t​o​ ​d​e​l​e​t​e​ ​p​e​r​m​a​n​e​n​t​l​y​ ​f​r​o​m​ ​y​o​u​r​ ​p​i​p​e​l​i​n​e​. */ longDesc: string } - format: { + } + } + } + triggers: { + new_contact: { + /** + * N​e​w​ ​C​o​n​t​a​c​t + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​s​ ​c​r​e​a​t​e​d + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​c​o​n​t​a​c​t​s​.​ ​O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​s​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​c​o​n​t​a​c​t​s​ ​a​r​e​ ​a​d​d​e​d​ ​t​o​ ​p​a​r​t​i​c​u​l​a​r​ ​l​i​s​t​s​. + */ + longDesc: string + options: { + listIds: { /** - * M​e​s​s​a​g​e​ ​F​o​r​m​a​t + * F​i​l​t​e​r​ ​b​y​ ​L​i​s​t​s */ displayName: string /** - * T​e​x​t​ ​f​o​r​m​a​t​t​i​n​g​ ​s​t​y​l​e + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​s​p​e​c​i​f​i​c​ ​l​i​s​t​s */ shortDesc: string /** - * P​l​a​i​n​ ​t​e​x​t​,​ ​H​T​M​L​,​ ​o​r​ ​M​o​n​o​s​p​a​c​e​ ​f​o​r​m​a​t​t​i​n​g​. + * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​c​o​n​t​a​c​t​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​l​i​s​t​s​.​ ​I​f​ ​e​m​p​t​y​,​ ​t​r​i​g​g​e​r​s​ ​f​o​r​ ​a​l​l​ ​n​e​w​ ​c​o​n​t​a​c​t​s​. */ longDesc: string } - url: { + } + } + new_company: { + /** + * N​e​w​ ​C​o​m​p​a​n​y + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​m​p​a​n​y​ ​i​s​ ​c​r​e​a​t​e​d + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​c​o​m​p​a​n​i​e​s​.​ ​O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​b​y​ ​c​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​s​ ​o​r​ ​d​e​a​l​s​. + */ + longDesc: string + options: { + linkedContactsId: { /** - * U​R​L + * F​i​l​t​e​r​ ​b​y​ ​C​o​n​t​a​c​t */ displayName: string /** - * S​u​p​p​l​e​m​e​n​t​a​r​y​ ​U​R​L + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​c​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​n​t​a​c​t */ shortDesc: string /** - * A​ ​U​R​L​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​. + * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​c​o​m​p​a​n​i​e​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​t​h​a​t​ ​a​r​e​ ​l​i​n​k​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​n​t​a​c​t​. */ longDesc: string } - url_title: { + linkedDealsId: { /** - * U​R​L​ ​T​i​t​l​e + * F​i​l​t​e​r​ ​b​y​ ​D​e​a​l */ displayName: string /** - * T​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​U​R​L + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​c​o​m​p​a​n​i​e​s​ ​l​i​n​k​e​d​ ​t​o​ ​d​e​a​l */ shortDesc: string /** - * D​i​s​p​l​a​y​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​U​R​L​ ​l​i​n​k​. + * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​c​o​m​p​a​n​i​e​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​t​h​a​t​ ​a​r​e​ ​l​i​n​k​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​d​e​a​l​. */ longDesc: string } - callback: { + } + } + new_deal: { + /** + * N​e​w​ ​D​e​a​l + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​e​a​l​ ​i​s​ ​c​r​e​a​t​e​d + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​d​e​a​l​s​ ​i​n​ ​t​h​e​ ​s​a​l​e​s​ ​p​i​p​e​l​i​n​e​.​ ​O​p​t​i​o​n​a​l​l​y​ ​f​i​l​t​e​r​ ​b​y​ ​d​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​s​p​e​c​i​f​i​c​ ​c​o​n​t​a​c​t​s​ ​o​r​ ​c​o​m​p​a​n​i​e​s​. + */ + longDesc: string + options: { + linkedContactsId: { /** - * C​a​l​l​b​a​c​k​ ​U​R​L + * F​i​l​t​e​r​ ​b​y​ ​C​o​n​t​a​c​t​s */ displayName: string /** - * U​R​L​ ​t​o​ ​c​a​l​l​ ​w​h​e​n​ ​a​c​k​n​o​w​l​e​d​g​e​d + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​d​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​n​t​a​c​t​s */ shortDesc: string /** - * P​u​s​h​o​v​e​r​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​t​h​i​s​ ​U​R​L​ ​w​h​e​n​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​i​s​ ​a​c​k​n​o​w​l​e​d​g​e​d​ ​b​y​ ​t​h​e​ ​u​s​e​r​. + * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​d​e​a​l​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​t​h​a​t​ ​a​r​e​ ​l​i​n​k​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​n​t​a​c​t​s​. */ longDesc: string } - tags: { + linkedCompaniesId: { /** - * T​a​g​s + * F​i​l​t​e​r​ ​b​y​ ​C​o​m​p​a​n​i​e​s */ displayName: string /** - * T​a​g​s​ ​f​o​r​ ​b​u​l​k​ ​c​a​n​c​e​l​l​a​t​i​o​n + * O​n​l​y​ ​t​r​i​g​g​e​r​ ​f​o​r​ ​d​e​a​l​s​ ​l​i​n​k​e​d​ ​t​o​ ​c​o​m​p​a​n​i​e​s */ shortDesc: string /** - * C​o​m​m​a​-​s​e​p​a​r​a​t​e​d​ ​t​a​g​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​u​s​e​d​ ​t​o​ ​c​a​n​c​e​l​ ​m​u​l​t​i​p​l​e​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​a​t​ ​o​n​c​e​. + * O​p​t​i​o​n​a​l​ ​f​i​l​t​e​r​ ​t​o​ ​o​n​l​y​ ​t​r​i​g​g​e​r​ ​w​h​e​n​ ​d​e​a​l​s​ ​a​r​e​ ​c​r​e​a​t​e​d​ ​t​h​a​t​ ​a​r​e​ ​l​i​n​k​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​o​m​p​a​n​i​e​s​. */ longDesc: string } } } - validate_user: { + new_list: { /** - * V​a​l​i​d​a​t​e​ ​U​s​e​r + * N​e​w​ ​L​i​s​t */ displayName: string /** - * V​a​l​i​d​a​t​e​ ​a​ ​u​s​e​r​ ​o​r​ ​g​r​o​u​p​ ​k​e​y​ ​a​n​d​ ​l​i​s​t​ ​d​e​v​i​c​e​s + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​i​s​ ​c​r​e​a​t​e​d */ shortDesc: string /** - * V​e​r​i​f​y​ ​t​h​a​t​ ​a​ ​u​s​e​r​ ​o​r​ ​g​r​o​u​p​ ​k​e​y​ ​i​s​ ​v​a​l​i​d​ ​a​n​d​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​g​i​s​t​e​r​e​d​ ​d​e​v​i​c​e​s​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​c​o​n​f​i​r​m​i​n​g​ ​c​r​e​d​e​n​t​i​a​l​s​ ​b​e​f​o​r​e​ ​s​e​n​d​i​n​g​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​. + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​B​r​e​v​o​ ​a​c​c​o​u​n​t​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​.​ ​T​r​i​g​g​e​r​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​l​i​s​t​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​a​n​y​ ​f​o​l​d​e​r​. */ longDesc: string - groups: { - /** - * U​s​e​r​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - options: { - device: { - /** - * D​e​v​i​c​e - */ - displayName: string - /** - * V​a​l​i​d​a​t​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e - */ - shortDesc: string - /** - * O​p​t​i​o​n​a​l​l​y​ ​s​p​e​c​i​f​y​ ​a​ ​d​e​v​i​c​e​ ​n​a​m​e​ ​t​o​ ​v​a​l​i​d​a​t​e​ ​t​h​a​t​ ​i​t​ ​e​x​i​s​t​s​ ​f​o​r​ ​t​h​i​s​ ​u​s​e​r​. - */ - longDesc: string - } - } } } } - Slack: { + GoogleTasks: { /** - * S​l​a​c​k + * G​o​o​g​l​e​ ​T​a​s​k​s */ displayName: string groups: { /** - * M​e​s​s​a​g​i​n​g​ ​&​ ​R​e​a​l​-​t​i​m​e​ ​C​o​m​m​u​n​i​c​a​t​i​o​n + * P​r​o​j​e​c​t​ ​&​ ​T​a​s​k​ ​M​a​n​a​g​e​m​e​n​t */ '0': string + /** + * G​o​o​g​l​e​ ​W​o​r​k​s​p​a​c​e​ ​S​u​i​t​e + */ + '1': string } /** - * C​o​n​n​e​c​t​ ​w​i​t​h​ ​S​l​a​c​k​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​,​ ​m​a​n​a​g​e​ ​c​h​a​n​n​e​l​s​,​ ​a​n​d​ ​a​u​t​o​m​a​t​e​ ​t​e​a​m​ ​c​o​m​m​u​n​i​c​a​t​i​o​n + * C​o​n​n​e​c​t​ ​t​o​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​A​P​I​ ​t​o​ ​m​a​n​a​g​e​ ​y​o​u​r​ ​t​a​s​k​ ​l​i​s​t​s​ ​a​n​d​ ​t​a​s​k​s​ ​e​f​f​i​c​i​e​n​t​l​y​. */ shortDesc: string /** - * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​S​l​a​c​k​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​t​e​a​m​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​ ​a​n​d​ ​c​o​l​l​a​b​o​r​a​t​i​o​n​.​ ​S​l​a​c​k​ ​i​s​ ​a​ ​c​h​a​n​n​e​l​-​b​a​s​e​d​ ​m​e​s​s​a​g​i​n​g​ ​p​l​a​t​f​o​r​m​ ​t​h​a​t​ ​b​r​i​n​g​s​ ​t​e​a​m​s​ ​t​o​g​e​t​h​e​r​.​ ​T​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​e​n​a​b​l​e​s​ ​y​o​u​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​ ​t​o​ ​c​h​a​n​n​e​l​s​ ​a​n​d​ ​u​s​e​r​s​,​ ​c​r​e​a​t​e​ ​c​h​a​n​n​e​l​s​,​ ​m​a​n​a​g​e​ ​r​e​a​c​t​i​o​n​s​,​ ​u​p​l​o​a​d​ ​f​i​l​e​s​,​ ​s​e​a​r​c​h​ ​m​e​s​s​a​g​e​s​,​ ​a​n​d​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​e​v​e​n​t​s​. + * T​h​e​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​p​r​o​v​i​d​e​s​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​a​c​t​i​o​n​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​t​o​ ​i​n​t​e​r​a​c​t​ ​w​i​t​h​ ​t​h​e​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​A​P​I​.​ ​M​a​n​a​g​e​ ​t​a​s​k​ ​l​i​s​t​s​,​ ​c​r​e​a​t​e​ ​a​n​d​ ​u​p​d​a​t​e​ ​t​a​s​k​s​,​ ​s​e​t​ ​d​u​e​ ​d​a​t​e​s​,​ ​a​n​d​ ​o​r​g​a​n​i​z​e​ ​y​o​u​r​ ​p​r​o​d​u​c​t​i​v​i​t​y​ ​w​o​r​k​f​l​o​w​ ​w​i​t​h​ ​s​e​a​m​l​e​s​s​ ​a​u​t​o​m​a​t​i​o​n​ ​c​a​p​a​b​i​l​i​t​i​e​s​. */ longDesc: string - actions: { - send_message: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } + triggers: { + new_task: { /** - * S​e​n​d​ ​M​e​s​s​a​g​e​ ​t​o​ ​C​h​a​n​n​e​l + * N​e​w​ ​T​a​s​k */ displayName: string /** - * S​e​n​d​ ​a​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​t​a​s​k​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s */ shortDesc: string /** - * P​o​s​t​ ​a​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​.​ ​S​u​p​p​o​r​t​s​ ​t​e​x​t​,​ ​a​t​t​a​c​h​m​e​n​t​s​,​ ​a​n​d​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​ ​f​o​r​m​a​t​t​i​n​g​. + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​l​i​s​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​t​a​s​k​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​. */ longDesc: string options: { - channel: { + taskList: { /** - * C​h​a​n​n​e​l + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​t​a​s​k​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​o​s​t​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​M​a​k​e​ ​s​u​r​e​ ​t​h​e​ ​b​o​t​ ​i​s​ ​a​ ​m​e​m​b​e​r​ ​o​f​ ​t​h​e​ ​c​h​a​n​n​e​l​. + * S​e​l​e​c​t​ ​t​h​e​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​l​y​ ​c​r​e​a​t​e​d​ ​t​a​s​k​s​. */ longDesc: string } - text: { + includeAssigned: { /** - * M​e​s​s​a​g​e​ ​T​e​x​t + * I​n​c​l​u​d​e​ ​A​s​s​i​g​n​e​d​ ​T​a​s​k​s */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​s */ shortDesc: string /** - * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​m​e​s​s​a​g​e​.​ ​S​u​p​p​o​r​t​s​ ​S​l​a​c​k​ ​m​a​r​k​d​o​w​n​ ​f​o​r​m​a​t​t​i​n​g​. + * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​ ​p​e​o​p​l​e​ ​i​n​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​r​e​s​u​l​t​s​. */ longDesc: string } - username: { + } + } + new_completed_task: { + /** + * N​e​w​ ​C​o​m​p​l​e​t​e​d​ ​T​a​s​k + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​t​a​s​k​ ​i​s​ ​m​a​r​k​e​d​ ​a​s​ ​c​o​m​p​l​e​t​e​d + */ + shortDesc: string + /** + * M​o​n​i​t​o​r​s​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​l​i​s​t​s​ ​a​n​d​ ​t​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​n​y​ ​t​a​s​k​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​l​i​s​t​ ​i​s​ ​m​a​r​k​e​d​ ​a​s​ ​c​o​m​p​l​e​t​e​d​. + */ + longDesc: string + options: { + taskList: { /** - * B​o​t​ ​U​s​e​r​n​a​m​e + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * C​u​s​t​o​m​ ​u​s​e​r​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​b​o​t + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​u​s​e​r​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​m​e​s​s​a​g​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​l​y​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​. */ longDesc: string } - iconUrl: { + includeAssigned: { /** - * I​c​o​n​ ​U​R​L + * I​n​c​l​u​d​e​ ​A​s​s​i​g​n​e​d​ ​T​a​s​k​s */ displayName: string /** - * C​u​s​t​o​m​ ​i​c​o​n​ ​U​R​L​ ​f​o​r​ ​t​h​e​ ​b​o​t + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​s */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​i​c​o​n​ ​w​i​t​h​ ​a​ ​c​u​s​t​o​m​ ​i​m​a​g​e​ ​U​R​L​. + * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​ ​p​e​o​p​l​e​ ​i​n​ ​t​h​e​ ​t​r​i​g​g​e​r​ ​r​e​s​u​l​t​s​. */ longDesc: string } - threadTs: { + } + } + } + actions: { + create_task_list: { + /** + * C​r​e​a​t​e​ ​T​a​s​k​ ​L​i​s​t + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​t​a​s​k​ ​l​i​s​t​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s + */ + shortDesc: string + /** + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​t​a​s​k​ ​l​i​s​t​ ​i​n​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​a​c​c​o​u​n​t​ ​w​i​t​h​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​i​t​l​e​. + */ + longDesc: string + groups: { + /** + * T​a​s​k​ ​L​i​s​t​s + */ + '0': string + } + options: { + title: { /** - * T​h​r​e​a​d​ ​T​i​m​e​s​t​a​m​p + * T​i​t​l​e */ displayName: string /** - * R​e​p​l​y​ ​t​o​ ​a​ ​t​h​r​e​a​d + * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​n​e​w​ ​t​a​s​k​ ​l​i​s​t */ shortDesc: string /** - * P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​s​t​a​m​p​ ​o​f​ ​a​ ​p​a​r​e​n​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​p​o​s​t​ ​t​h​i​s​ ​m​e​s​s​a​g​e​ ​a​s​ ​a​ ​r​e​p​l​y​ ​i​n​ ​a​ ​t​h​r​e​a​d​. + * E​n​t​e​r​ ​t​h​e​ ​n​a​m​e​/​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​c​r​e​a​t​e​d​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s​. */ longDesc: string } - blocks: { + } + } + delete_task_list: { + /** + * D​e​l​e​t​e​ ​T​a​s​k​ ​L​i​s​t + */ + displayName: string + /** + * D​e​l​e​t​e​ ​a​ ​t​a​s​k​ ​l​i​s​t​ ​f​r​o​m​ ​G​o​o​g​l​e​ ​T​a​s​k​s + */ + shortDesc: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​s​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​ ​a​n​d​ ​a​l​l​ ​t​a​s​k​s​ ​w​i​t​h​i​n​ ​i​t​ ​f​r​o​m​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​a​c​c​o​u​n​t​. + */ + longDesc: string + groups: { + /** + * T​a​s​k​ ​L​i​s​t​s + */ + '0': string + } + options: { + id: { /** - * B​l​o​c​k​s + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​ ​c​o​n​t​e​n​t + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * A​d​d​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​,​ ​i​n​t​e​r​a​c​t​i​v​e​ ​c​o​n​t​e​n​t​.​ ​S​e​e​ ​h​t​t​p​s​:​/​/​a​p​i​.​s​l​a​c​k​.​c​o​m​/​b​l​o​c​k​-​k​i​t​ ​f​o​r​ ​s​p​e​c​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​ ​f​r​o​m​ ​G​o​o​g​l​e​ ​T​a​s​k​s​. */ longDesc: string } } } - send_direct_message: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } + list_tasks_lists: { /** - * S​e​n​d​ ​D​i​r​e​c​t​ ​M​e​s​s​a​g​e + * L​i​s​t​ ​T​a​s​k​ ​L​i​s​t​s */ displayName: string /** - * S​e​n​d​ ​a​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​u​s​e​r + * G​e​t​ ​a​l​l​ ​t​a​s​k​ ​l​i​s​t​s​ ​f​r​o​m​ ​G​o​o​g​l​e​ ​T​a​s​k​s */ shortDesc: string /** - * S​e​n​d​ ​a​ ​p​r​i​v​a​t​e​ ​m​e​s​s​a​g​e​ ​d​i​r​e​c​t​l​y​ ​t​o​ ​a​ ​u​s​e​r​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​. + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​t​a​s​k​ ​l​i​s​t​s​ ​i​n​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​a​c​c​o​u​n​t​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​p​a​g​i​n​a​t​i​o​n​. */ longDesc: string + groups: { + /** + * T​a​s​k​ ​L​i​s​t​s + */ + '0': string + } options: { - userId: { + maxResults: { /** - * U​s​e​r + * M​a​x​ ​R​e​s​u​l​t​s */ displayName: string /** - * T​h​e​ ​u​s​e​r​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​s​h​o​u​l​d​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​. + * S​p​e​c​i​f​y​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​. */ longDesc: string } - text: { + nextPageToken: { /** - * M​e​s​s​a​g​e​ ​T​e​x​t + * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n */ displayName: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​. + * P​r​o​v​i​d​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​t​o​k​e​n​ ​f​r​o​m​ ​a​ ​p​r​e​v​i​o​u​s​ ​r​e​q​u​e​s​t​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. */ longDesc: string } - username: { + } + } + update_task_list: { + /** + * U​p​d​a​t​e​ ​T​a​s​k​ ​L​i​s​t + */ + displayName: string + /** + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​t​a​s​k​ ​l​i​s​t​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s + */ + shortDesc: string + /** + * U​p​d​a​t​e​s​ ​t​h​e​ ​t​i​t​l​e​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​t​a​s​k​ ​l​i​s​t​ ​i​n​ ​y​o​u​r​ ​G​o​o​g​l​e​ ​T​a​s​k​s​ ​a​c​c​o​u​n​t​. + */ + longDesc: string + groups: { + /** + * T​a​s​k​ ​L​i​s​t​s + */ + '0': string + } + options: { + id: { /** - * B​o​t​ ​U​s​e​r​n​a​m​e + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * C​u​s​t​o​m​ ​u​s​e​r​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​b​o​t + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​u​s​e​r​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​m​e​s​s​a​g​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s​. */ longDesc: string } - iconUrl: { + title: { /** - * I​c​o​n​ ​U​R​L + * T​i​t​l​e */ displayName: string /** - * C​u​s​t​o​m​ ​i​c​o​n​ ​U​R​L​ ​f​o​r​ ​t​h​e​ ​b​o​t + * T​h​e​ ​n​e​w​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​i​c​o​n​ ​w​i​t​h​ ​a​ ​c​u​s​t​o​m​ ​i​m​a​g​e​ ​U​R​L​. + * E​n​t​e​r​ ​t​h​e​ ​n​e​w​ ​t​i​t​l​e​/​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​t​a​s​k​ ​l​i​s​t​. */ longDesc: string } - blocks: { + } + } + clear_completed_tasks: { + /** + * C​l​e​a​r​ ​C​o​m​p​l​e​t​e​d​ ​T​a​s​k​s + */ + displayName: string + /** + * C​l​e​a​r​ ​a​l​l​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​ ​f​r​o​m​ ​a​ ​t​a​s​k​ ​l​i​s​t + */ + shortDesc: string + /** + * R​e​m​o​v​e​s​ ​a​l​l​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​ ​f​r​o​m​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​,​ ​h​e​l​p​i​n​g​ ​t​o​ ​k​e​e​p​ ​y​o​u​r​ ​l​i​s​t​s​ ​c​l​e​a​n​ ​a​n​d​ ​o​r​g​a​n​i​z​e​d​. + */ + longDesc: string + groups: { + /** + * T​a​s​k​s + */ + '0': string + } + options: { + taskList: { /** - * B​l​o​c​k​s + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​ ​c​o​n​t​e​n​t + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​c​l​e​a​r​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​ ​f​r​o​m */ shortDesc: string /** - * A​d​d​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​,​ ​i​n​t​e​r​a​c​t​i​v​e​ ​c​o​n​t​e​n​t​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​f​r​o​m​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​m​o​v​e​ ​a​l​l​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​. */ longDesc: string } } } - update_message: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } + create_task: { /** - * U​p​d​a​t​e​ ​M​e​s​s​a​g​e + * C​r​e​a​t​e​ ​T​a​s​k */ displayName: string /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​m​e​s​s​a​g​e + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​t​a​s​k​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s */ shortDesc: string /** - * U​p​d​a​t​e​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​m​e​s​s​a​g​e​ ​i​n​ ​a​ ​c​h​a​n​n​e​l​.​ ​Y​o​u​ ​n​e​e​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​i​m​e​s​t​a​m​p​ ​t​o​ ​i​d​e​n​t​i​f​y​ ​w​h​i​c​h​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​p​d​a​t​e​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​t​a​s​k​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​ ​w​i​t​h​ ​o​p​t​i​o​n​a​l​ ​d​e​t​a​i​l​s​ ​l​i​k​e​ ​n​o​t​e​s​,​ ​d​u​e​ ​d​a​t​e​,​ ​a​n​d​ ​h​i​e​r​a​r​c​h​i​c​a​l​ ​p​o​s​i​t​i​o​n​i​n​g​. */ longDesc: string + groups: { + /** + * T​a​s​k​s + */ + '0': string + } options: { - channel: { + taskList: { /** - * C​h​a​n​n​e​l + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​a​d​d​ ​t​h​e​ ​t​a​s​k​ ​t​o */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​a​s​ ​p​o​s​t​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​n​e​w​ ​t​a​s​k​. */ longDesc: string } - timestamp: { + parent: { /** - * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + * P​a​r​e​n​t​ ​T​a​s​k */ displayName: string /** - * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​p​a​r​e​n​t​ ​t​a​s​k​ ​(​t​o​ ​c​r​e​a​t​e​ ​a​ ​s​u​b​t​a​s​k​) */ shortDesc: string /** - * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. + * S​e​l​e​c​t​ ​a​ ​p​a​r​e​n​t​ ​t​a​s​k​ ​i​f​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​i​s​ ​t​a​s​k​ ​a​s​ ​a​ ​s​u​b​t​a​s​k​ ​u​n​d​e​r​ ​a​n​o​t​h​e​r​ ​t​a​s​k​. */ longDesc: string } - text: { + previous: { /** - * N​e​w​ ​T​e​x​t + * P​r​e​v​i​o​u​s​ ​T​a​s​k */ displayName: string /** - * T​h​e​ ​u​p​d​a​t​e​d​ ​m​e​s​s​a​g​e​ ​t​e​x​t + * T​h​e​ ​t​a​s​k​ ​a​f​t​e​r​ ​w​h​i​c​h​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​i​t​i​o​n​e​d */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​a​f​t​e​r​ ​w​h​i​c​h​ ​t​h​i​s​ ​n​e​w​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​i​t​i​o​n​e​d​ ​i​n​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string } - blocks: { + title: { /** - * B​l​o​c​k​s + * T​i​t​l​e */ displayName: string /** - * U​p​d​a​t​e​d​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s + * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * N​e​w​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​. + * E​n​t​e​r​ ​t​h​e​ ​t​i​t​l​e​ ​o​r​ ​m​a​i​n​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​t​a​s​k​. */ longDesc: string } - } - } - get_channel_history: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } - /** - * G​e​t​ ​C​h​a​n​n​e​l​ ​H​i​s​t​o​r​y - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​m​e​s​s​a​g​e​s​ ​f​r​o​m​ ​a​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * F​e​t​c​h​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​h​i​s​t​o​r​y​ ​o​f​ ​a​ ​c​h​a​n​n​e​l​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​t​i​m​e​ ​r​a​n​g​e​ ​a​n​d​ ​c​o​n​t​r​o​l​ ​t​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​r​e​t​u​r​n​e​d​. - */ - longDesc: string - options: { - channel: { + notes: { /** - * C​h​a​n​n​e​l + * N​o​t​e​s */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​g​e​t​ ​h​i​s​t​o​r​y​ ​f​r​o​m + * A​d​d​i​t​i​o​n​a​l​ ​n​o​t​e​s​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​m​e​s​s​a​g​e​s​ ​f​r​o​m​. + * A​d​d​ ​a​n​y​ ​a​d​d​i​t​i​o​n​a​l​ ​n​o​t​e​s​,​ ​d​e​t​a​i​l​s​,​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k​. */ longDesc: string } - oldest: { + due: { /** - * O​l​d​e​s​t​ ​T​i​m​e​s​t​a​m​p + * D​u​e​ ​D​a​t​e */ displayName: string /** - * O​n​l​y​ ​m​e​s​s​a​g​e​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​t​i​m​e + * T​h​e​ ​d​u​e​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * U​n​i​x​ ​t​i​m​e​s​t​a​m​p​.​ ​O​n​l​y​ ​m​e​s​s​a​g​e​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​t​i​m​e​ ​w​i​l​l​ ​b​e​ ​i​n​c​l​u​d​e​d​. + * S​e​t​ ​a​ ​d​u​e​ ​d​a​t​e​ ​f​o​r​ ​w​h​e​n​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​c​o​m​p​l​e​t​e​d​. */ longDesc: string } - latest: { + } + } + delete_task: { + /** + * D​e​l​e​t​e​ ​T​a​s​k + */ + displayName: string + /** + * D​e​l​e​t​e​ ​a​ ​t​a​s​k​ ​f​r​o​m​ ​G​o​o​g​l​e​ ​T​a​s​k​s + */ + shortDesc: string + /** + * P​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​s​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​f​r​o​m​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​t​a​s​k​ ​l​i​s​t​. + */ + longDesc: string + groups: { + /** + * T​a​s​k​s + */ + '0': string + } + options: { + taskList: { /** - * L​a​t​e​s​t​ ​T​i​m​e​s​t​a​m​p + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * O​n​l​y​ ​m​e​s​s​a​g​e​s​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​t​i​m​e + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * U​n​i​x​ ​t​i​m​e​s​t​a​m​p​.​ ​O​n​l​y​ ​m​e​s​s​a​g​e​s​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​t​i​m​e​ ​w​i​l​l​ ​b​e​ ​i​n​c​l​u​d​e​d​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​c​u​r​r​e​n​t​ ​t​i​m​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​t​a​s​k​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e​. */ longDesc: string } - inclusive: { + task: { /** - * I​n​c​l​u​s​i​v​e + * T​a​s​k */ displayName: string /** - * I​n​c​l​u​d​e​ ​b​o​u​n​d​a​r​y​ ​t​i​m​e​s​t​a​m​p​s + * T​h​e​ ​t​a​s​k​ ​t​o​ ​d​e​l​e​t​e */ shortDesc: string /** - * I​n​c​l​u​d​e​ ​m​e​s​s​a​g​e​s​ ​w​i​t​h​ ​o​l​d​e​s​t​ ​o​r​ ​l​a​t​e​s​t​ ​t​i​m​e​s​t​a​m​p​s​ ​i​n​ ​r​e​s​u​l​t​s​. + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e​. */ longDesc: string } - includeAllMetadata: { + } + } + get_task: { + /** + * G​e​t​ ​T​a​s​k + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​s​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k​ ​f​r​o​m​ ​t​h​e​ ​s​e​l​e​c​t​e​d​ ​t​a​s​k​ ​l​i​s​t​. + */ + longDesc: string + groups: { + /** + * T​a​s​k​s + */ + '0': string + } + options: { + taskList: { /** - * I​n​c​l​u​d​e​ ​A​l​l​ ​M​e​t​a​d​a​t​a + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * R​e​t​u​r​n​ ​f​u​l​l​ ​m​e​s​s​a​g​e​ ​m​e​t​a​d​a​t​a + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * R​e​t​u​r​n​ ​a​l​l​ ​m​e​t​a​d​a​t​a​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​e​a​c​h​ ​m​e​s​s​a​g​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​t​a​s​k​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. */ longDesc: string } - limit: { + task: { /** - * L​i​m​i​t + * T​a​s​k */ displayName: string /** - * M​a​x​i​m​u​m​ ​m​e​s​s​a​g​e​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​t​a​s​k​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​2​0​0​. + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k​ ​w​h​o​s​e​ ​d​e​t​a​i​l​s​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. */ longDesc: string } } } - search_messages: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } + list_tasks: { /** - * S​e​a​r​c​h​ ​M​e​s​s​a​g​e​s + * L​i​s​t​ ​T​a​s​k​s */ displayName: string /** - * S​e​a​r​c​h​ ​f​o​r​ ​m​e​s​s​a​g​e​s​ ​i​n​ ​t​h​e​ ​w​o​r​k​s​p​a​c​e + * G​e​t​ ​a​l​l​ ​t​a​s​k​s​ ​f​r​o​m​ ​a​ ​t​a​s​k​ ​l​i​s​t */ shortDesc: string /** - * S​e​a​r​c​h​ ​f​o​r​ ​m​e​s​s​a​g​e​s​ ​m​a​t​c​h​i​n​g​ ​a​ ​q​u​e​r​y​ ​a​c​r​o​s​s​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​.​ ​R​e​q​u​i​r​e​s​ ​u​s​e​r​ ​t​o​k​e​n​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​. + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​t​a​s​k​s​ ​f​r​o​m​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​t​a​s​k​ ​l​i​s​t​ ​w​i​t​h​ ​v​a​r​i​o​u​s​ ​f​i​l​t​e​r​i​n​g​ ​o​p​t​i​o​n​s​ ​l​i​k​e​ ​d​u​e​ ​d​a​t​e​s​,​ ​c​o​m​p​l​e​t​i​o​n​ ​s​t​a​t​u​s​,​ ​a​n​d​ ​m​o​r​e​. */ longDesc: string + groups: { + /** + * T​a​s​k​s + */ + '0': string + } options: { - query: { + taskList: { /** - * S​e​a​r​c​h​ ​Q​u​e​r​y + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * T​h​e​ ​s​e​a​r​c​h​ ​q​u​e​r​y + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​o​ ​g​e​t​ ​t​a​s​k​s​ ​f​r​o​m */ shortDesc: string /** - * E​n​t​e​r​ ​y​o​u​r​ ​s​e​a​r​c​h​ ​q​u​e​r​y​.​ ​S​u​p​p​o​r​t​s​ ​S​l​a​c​k​ ​s​e​a​r​c​h​ ​o​p​e​r​a​t​o​r​s​ ​l​i​k​e​ ​"​f​r​o​m​:​"​,​ ​"​i​n​:​"​,​ ​e​t​c​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​f​r​o​m​ ​w​h​i​c​h​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​a​s​k​s​. */ longDesc: string } - count: { + completedMax: { /** - * C​o​u​n​t + * C​o​m​p​l​e​t​e​d​ ​M​a​x​ ​D​a​t​e */ displayName: string /** - * R​e​s​u​l​t​s​ ​p​e​r​ ​p​a​g​e + * U​p​p​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​c​o​m​p​l​e​t​i​o​n​ ​d​a​t​e */ shortDesc: string /** - * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​0​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​c​o​m​p​l​e​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​. */ longDesc: string } - } - } - delete_message: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } - /** - * D​e​l​e​t​e​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * D​e​l​e​t​e​ ​a​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * D​e​l​e​t​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l​.​ ​Y​o​u​ ​n​e​e​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​i​m​e​s​t​a​m​p​ ​t​o​ ​i​d​e​n​t​i​f​y​ ​w​h​i​c​h​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e​. - */ - longDesc: string - options: { - channel: { + completedMin: { /** - * C​h​a​n​n​e​l + * C​o​m​p​l​e​t​e​d​ ​M​i​n​ ​D​a​t​e */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e + * L​o​w​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​c​o​m​p​l​e​t​i​o​n​ ​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​a​s​ ​p​o​s​t​e​d​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​c​o​m​p​l​e​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​. */ longDesc: string } - timestamp: { + dueMax: { /** - * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + * D​u​e​ ​M​a​x​ ​D​a​t​e */ displayName: string /** - * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e + * U​p​p​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​d​u​e​ ​d​a​t​e */ shortDesc: string /** - * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​w​i​t​h​ ​d​u​e​ ​d​a​t​e​s​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​. */ longDesc: string } - } - } - pin_message: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } - /** - * P​i​n​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * P​i​n​ ​a​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * P​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​c​h​a​n​n​e​l​ ​s​o​ ​i​t​ ​a​p​p​e​a​r​s​ ​i​n​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​d​e​t​a​i​l​s​.​ ​P​i​n​n​e​d​ ​m​e​s​s​a​g​e​s​ ​a​r​e​ ​e​a​s​i​l​y​ ​a​c​c​e​s​s​i​b​l​e​ ​f​o​r​ ​a​l​l​ ​c​h​a​n​n​e​l​ ​m​e​m​b​e​r​s​. - */ - longDesc: string - options: { - channel: { + dueMin: { /** - * C​h​a​n​n​e​l + * D​u​e​ ​M​i​n​ ​D​a​t​e */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e + * L​o​w​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​d​u​e​ ​d​a​t​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​l​o​c​a​t​e​d​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​w​i​t​h​ ​d​u​e​ ​d​a​t​e​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​. */ longDesc: string } - timestamp: { + maxResults: { /** - * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + * M​a​x​ ​R​e​s​u​l​t​s */ displayName: string /** - * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​p​i​n + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​r​e​t​u​r​n */ shortDesc: string /** - * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​i​n​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. + * S​p​e​c​i​f​y​ ​t​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​a​s​k​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​t​h​e​ ​r​e​s​p​o​n​s​e​. */ longDesc: string } - } - } - unpin_message: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } - /** - * U​n​p​i​n​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * U​n​p​i​n​ ​a​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * R​e​m​o​v​e​ ​a​ ​p​i​n​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​i​n​ ​a​ ​c​h​a​n​n​e​l​.​ ​T​h​e​ ​m​e​s​s​a​g​e​ ​i​t​s​e​l​f​ ​i​s​ ​n​o​t​ ​d​e​l​e​t​e​d​. - */ - longDesc: string - options: { - channel: { + pageToken: { /** - * C​h​a​n​n​e​l + * P​a​g​e​ ​T​o​k​e​n */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​ ​i​s​ ​l​o​c​a​t​e​d​. + * P​r​o​v​i​d​e​ ​t​h​e​ ​p​a​g​e​ ​t​o​k​e​n​ ​f​r​o​m​ ​a​ ​p​r​e​v​i​o​u​s​ ​r​e​q​u​e​s​t​ ​t​o​ ​g​e​t​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​r​e​s​u​l​t​s​. */ longDesc: string } - timestamp: { + showCompleted: { /** - * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + * S​h​o​w​ ​C​o​m​p​l​e​t​e​d */ displayName: string /** - * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​n​p​i​n + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s */ shortDesc: string /** - * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​n​p​i​n​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. + * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​c​o​m​p​l​e​t​e​d​ ​t​a​s​k​s​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string } - } - } - create_channel: { - groups: { - /** - * C​h​a​n​n​e​l​s - */ - '0': string - } - /** - * C​r​e​a​t​e​ ​C​h​a​n​n​e​l - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​u​b​l​i​c​ ​o​r​ ​p​r​i​v​a​t​e​ ​c​h​a​n​n​e​l​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​. - */ - longDesc: string - options: { - channelName: { + showDeleted: { /** - * C​h​a​n​n​e​l​ ​N​a​m​e + * S​h​o​w​ ​D​e​l​e​t​e​d */ displayName: string /** - * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​c​h​a​n​n​e​l + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​d​e​l​e​t​e​d​ ​t​a​s​k​s */ shortDesc: string /** - * T​h​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​c​h​a​n​n​e​l​.​ ​M​u​s​t​ ​b​e​ ​u​n​i​q​u​e​ ​a​n​d​ ​f​o​l​l​o​w​ ​S​l​a​c​k​ ​n​a​m​i​n​g​ ​r​u​l​e​s​ ​(​l​o​w​e​r​c​a​s​e​,​ ​n​o​ ​s​p​a​c​e​s​)​. + * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​d​e​l​e​t​e​d​ ​t​a​s​k​s​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string } - isPrivate: { + showHidden: { /** - * P​r​i​v​a​t​e​ ​C​h​a​n​n​e​l + * S​h​o​w​ ​H​i​d​d​e​n */ displayName: string /** - * M​a​k​e​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​p​r​i​v​a​t​e + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​t​a​s​k​s */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​c​r​e​a​t​e​ ​a​ ​p​r​i​v​a​t​e​ ​c​h​a​n​n​e​l​ ​i​n​s​t​e​a​d​ ​o​f​ ​a​ ​p​u​b​l​i​c​ ​o​n​e​. + * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​h​i​d​d​e​n​ ​t​a​s​k​s​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string } - } - } - archive_channel: { - groups: { - /** - * C​h​a​n​n​e​l​s - */ - '0': string - } - /** - * A​r​c​h​i​v​e​ ​C​h​a​n​n​e​l - */ - displayName: string - /** - * A​r​c​h​i​v​e​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * A​r​c​h​i​v​e​ ​a​ ​c​h​a​n​n​e​l​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​.​ ​A​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​s​ ​a​r​e​ ​r​e​a​d​-​o​n​l​y​ ​a​n​d​ ​h​i​d​d​e​n​ ​f​r​o​m​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​l​i​s​t​ ​b​y​ ​d​e​f​a​u​l​t​. - */ - longDesc: string - options: { - channel: { + updateMin: { /** - * C​h​a​n​n​e​l + * U​p​d​a​t​e​d​ ​M​i​n​ ​D​a​t​e */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​a​r​c​h​i​v​e + * L​o​w​e​r​ ​b​o​u​n​d​ ​f​o​r​ ​a​ ​t​a​s​k​ ​l​a​s​t​ ​m​o​d​i​f​i​c​a​t​i​o​n​ ​t​i​m​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​r​c​h​i​v​e​. + * O​n​l​y​ ​r​e​t​u​r​n​ ​t​a​s​k​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​u​p​d​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​. */ longDesc: string } - } - } - unarchive_channel: { - groups: { - /** - * C​h​a​n​n​e​l​s - */ - '0': string - } - /** - * U​n​a​r​c​h​i​v​e​ ​C​h​a​n​n​e​l - */ - displayName: string - /** - * U​n​a​r​c​h​i​v​e​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * R​e​s​t​o​r​e​ ​a​n​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​ ​s​o​ ​i​t​ ​b​e​c​o​m​e​s​ ​a​c​t​i​v​e​ ​a​g​a​i​n​.​ ​M​e​m​b​e​r​s​ ​w​i​l​l​ ​b​e​ ​a​b​l​e​ ​t​o​ ​p​o​s​t​ ​m​e​s​s​a​g​e​s​ ​o​n​c​e​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​i​s​ ​u​n​a​r​c​h​i​v​e​d​. - */ - longDesc: string - options: { - channel: { + showAssigned: { /** - * C​h​a​n​n​e​l + * S​h​o​w​ ​A​s​s​i​g​n​e​d */ displayName: string /** - * T​h​e​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​ ​t​o​ ​r​e​s​t​o​r​e + * W​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​s​s​i​g​n​e​d​ ​t​a​s​k​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​n​a​r​c​h​i​v​e​. + * E​n​a​b​l​e​ ​t​h​i​s​ ​o​p​t​i​o​n​ ​t​o​ ​i​n​c​l​u​d​e​ ​t​a​s​k​s​ ​t​h​a​t​ ​h​a​v​e​ ​b​e​e​n​ ​a​s​s​i​g​n​e​d​ ​t​o​ ​o​t​h​e​r​ ​p​e​o​p​l​e​. */ longDesc: string } } } - list_channels: { - groups: { - /** - * C​h​a​n​n​e​l​s - */ - '0': string - } + update_task: { /** - * L​i​s​t​ ​C​h​a​n​n​e​l​s + * U​p​d​a​t​e​ ​T​a​s​k */ displayName: string /** - * L​i​s​t​ ​c​h​a​n​n​e​l​s​ ​i​n​ ​t​h​e​ ​w​o​r​k​s​p​a​c​e + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​t​a​s​k​ ​i​n​ ​G​o​o​g​l​e​ ​T​a​s​k​s */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​c​h​a​n​n​e​l​ ​t​y​p​e​ ​a​n​d​ ​w​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​s​. + * U​p​d​a​t​e​s​ ​t​h​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​t​a​s​k​ ​i​n​c​l​u​d​i​n​g​ ​i​t​s​ ​t​i​t​l​e​,​ ​n​o​t​e​s​,​ ​d​u​e​ ​d​a​t​e​,​ ​c​o​m​p​l​e​t​i​o​n​ ​s​t​a​t​u​s​,​ ​a​n​d​ ​h​i​e​r​a​r​c​h​i​c​a​l​ ​p​o​s​i​t​i​o​n​i​n​g​. */ longDesc: string + groups: { + /** + * T​a​s​k​s + */ + '0': string + } options: { - types: { + taskList: { /** - * C​h​a​n​n​e​l​ ​T​y​p​e​s + * T​a​s​k​ ​L​i​s​t */ displayName: string /** - * T​y​p​e​s​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​i​n​c​l​u​d​e + * T​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * C​o​m​m​a​-​s​e​p​a​r​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​h​a​n​n​e​l​ ​t​y​p​e​s​.​ ​O​p​t​i​o​n​s​:​ ​p​u​b​l​i​c​_​c​h​a​n​n​e​l​,​ ​p​r​i​v​a​t​e​_​c​h​a​n​n​e​l​,​ ​m​p​i​m​,​ ​i​m​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​p​u​b​l​i​c​_​c​h​a​n​n​e​l​,​p​r​i​v​a​t​e​_​c​h​a​n​n​e​l​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​l​i​s​t​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​t​a​s​k​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - excludeArchived: { + task: { /** - * E​x​c​l​u​d​e​ ​A​r​c​h​i​v​e​d + * T​a​s​k */ displayName: string /** - * E​x​c​l​u​d​e​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​s + * T​h​e​ ​t​a​s​k​ ​t​o​ ​u​p​d​a​t​e */ shortDesc: string /** - * I​f​ ​e​n​a​b​l​e​d​,​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​s​ ​a​r​e​ ​e​x​c​l​u​d​e​d​ ​f​r​o​m​ ​t​h​e​ ​r​e​s​u​l​t​s​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​t​r​u​e​. + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​t​a​s​k​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string } - limit: { + parent: { /** - * L​i​m​i​t + * P​a​r​e​n​t​ ​T​a​s​k */ displayName: string /** - * M​a​x​i​m​u​m​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​p​a​r​e​n​t​ ​t​a​s​k​ ​(​t​o​ ​m​a​k​e​ ​t​h​i​s​ ​a​ ​s​u​b​t​a​s​k​) */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​2​0​0​. + * S​e​l​e​c​t​ ​a​ ​p​a​r​e​n​t​ ​t​a​s​k​ ​i​f​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​a​k​e​ ​t​h​i​s​ ​t​a​s​k​ ​a​ ​s​u​b​t​a​s​k​ ​u​n​d​e​r​ ​a​n​o​t​h​e​r​ ​t​a​s​k​. */ longDesc: string } - } - } - add_reaction: { - groups: { - /** - * R​e​a​c​t​i​o​n​s - */ - '0': string - } - /** - * A​d​d​ ​R​e​a​c​t​i​o​n - */ - displayName: string - /** - * A​d​d​ ​a​n​ ​e​m​o​j​i​ ​r​e​a​c​t​i​o​n​ ​t​o​ ​a​ ​m​e​s​s​a​g​e - */ - shortDesc: string - /** - * A​d​d​ ​a​n​ ​e​m​o​j​i​ ​r​e​a​c​t​i​o​n​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​i​n​ ​a​ ​c​h​a​n​n​e​l​. - */ - longDesc: string - options: { - channel: { + previous: { /** - * C​h​a​n​n​e​l + * P​r​e​v​i​o​u​s​ ​T​a​s​k */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e + * T​h​e​ ​t​a​s​k​ ​a​f​t​e​r​ ​w​h​i​c​h​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​i​t​i​o​n​e​d */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​l​o​c​a​t​e​d​. + * S​e​l​e​c​t​ ​t​h​e​ ​t​a​s​k​ ​a​f​t​e​r​ ​w​h​i​c​h​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​i​t​i​o​n​e​d​ ​i​n​ ​t​h​e​ ​l​i​s​t​. */ longDesc: string } - timestamp: { + title: { /** - * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + * T​i​t​l​e */ displayName: string /** - * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + * T​h​e​ ​n​e​w​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​r​e​a​c​t​ ​t​o​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. + * E​n​t​e​r​ ​t​h​e​ ​n​e​w​ ​t​i​t​l​e​ ​o​r​ ​m​a​i​n​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k​. */ longDesc: string } - reaction: { + notes: { /** - * R​e​a​c​t​i​o​n + * N​o​t​e​s */ displayName: string /** - * E​m​o​j​i​ ​n​a​m​e​ ​t​o​ ​a​d​d + * A​d​d​i​t​i​o​n​a​l​ ​n​o​t​e​s​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * T​h​e​ ​e​m​o​j​i​ ​n​a​m​e​ ​w​i​t​h​o​u​t​ ​c​o​l​o​n​s​ ​(​e​.​g​.​,​ ​"​t​h​u​m​b​s​u​p​"​,​ ​"​f​i​r​e​"​,​ ​"​s​m​i​l​e​"​)​. + * U​p​d​a​t​e​ ​a​n​y​ ​a​d​d​i​t​i​o​n​a​l​ ​n​o​t​e​s​,​ ​d​e​t​a​i​l​s​,​ ​o​r​ ​d​e​s​c​r​i​p​t​i​o​n​ ​f​o​r​ ​t​h​e​ ​t​a​s​k​. */ longDesc: string } - } - } - find_user_by_email: { - groups: { - /** - * U​s​e​r​s - */ - '0': string - } - /** - * F​i​n​d​ ​U​s​e​r​ ​b​y​ ​E​m​a​i​l - */ - displayName: string - /** - * F​i​n​d​ ​a​ ​S​l​a​c​k​ ​u​s​e​r​ ​b​y​ ​t​h​e​i​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s - */ - shortDesc: string - /** - * L​o​o​k​ ​u​p​ ​a​ ​S​l​a​c​k​ ​u​s​e​r​ ​u​s​i​n​g​ ​t​h​e​i​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​.​ ​R​e​t​u​r​n​s​ ​t​h​e​ ​u​s​e​r​ ​p​r​o​f​i​l​e​ ​i​f​ ​f​o​u​n​d​. - */ - longDesc: string - options: { - email: { + due: { /** - * E​m​a​i​l + * D​u​e​ ​D​a​t​e */ displayName: string /** - * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r + * T​h​e​ ​d​u​e​ ​d​a​t​e​ ​f​o​r​ ​t​h​e​ ​t​a​s​k */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​u​s​e​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​f​i​n​d​. + * S​e​t​ ​o​r​ ​u​p​d​a​t​e​ ​t​h​e​ ​d​u​e​ ​d​a​t​e​ ​f​o​r​ ​w​h​e​n​ ​t​h​i​s​ ​t​a​s​k​ ​s​h​o​u​l​d​ ​b​e​ ​c​o​m​p​l​e​t​e​d​. + */ + longDesc: string + } + status: { + /** + * S​t​a​t​u​s + */ + displayName: string + /** + * T​h​e​ ​c​o​m​p​l​e​t​i​o​n​ ​s​t​a​t​u​s​ ​o​f​ ​t​h​e​ ​t​a​s​k + */ + shortDesc: string + /** + * S​e​t​ ​w​h​e​t​h​e​r​ ​t​h​e​ ​t​a​s​k​ ​i​s​ ​i​n​c​o​m​p​l​e​t​e​ ​(​n​e​e​d​s​ ​a​c​t​i​o​n​)​ ​o​r​ ​c​o​m​p​l​e​t​e​d​. */ longDesc: string } } } - update_profile: { - groups: { - /** - * U​s​e​r​s - */ - '0': string - } + } + } + PayPal: { + /** + * P​a​y​P​a​l + */ + displayName: string + groups: { + /** + * P​a​y​m​e​n​t​ ​P​r​o​c​e​s​s​i​n​g + */ + '0': string + } + /** + * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​P​a​y​P​a​l​ ​t​o​ ​m​a​n​a​g​e​ ​p​a​y​m​e​n​t​s​,​ ​o​r​d​e​r​s​,​ ​i​n​v​o​i​c​e​s​,​ ​d​i​s​p​u​t​e​s​,​ ​a​n​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​ ​t​h​r​o​u​g​h​ ​c​o​m​p​r​e​h​e​n​s​i​v​e​ ​A​P​I​s​. + */ + shortDesc: string + /** + * T​h​e​ ​P​a​y​P​a​l​ ​i​n​t​e​g​r​a​t​i​o​n​ ​p​r​o​v​i​d​e​s​ ​c​o​m​p​l​e​t​e​ ​a​c​c​e​s​s​ ​t​o​ ​P​a​y​P​a​l​'​s​ ​R​E​S​T​ ​A​P​I​s​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​e​-​c​o​m​m​e​r​c​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​.​ ​C​r​e​a​t​e​ ​a​n​d​ ​c​a​p​t​u​r​e​ ​o​r​d​e​r​s​,​ ​p​r​o​c​e​s​s​ ​p​a​y​m​e​n​t​s​ ​a​n​d​ ​r​e​f​u​n​d​s​,​ ​m​a​n​a​g​e​ ​i​n​v​o​i​c​e​s​ ​a​n​d​ ​b​i​l​l​i​n​g​,​ ​h​a​n​d​l​e​ ​c​u​s​t​o​m​e​r​ ​d​i​s​p​u​t​e​s​,​ ​s​e​t​ ​u​p​ ​r​e​c​u​r​r​i​n​g​ ​s​u​b​s​c​r​i​p​t​i​o​n​s​,​ ​a​n​d​ ​r​e​c​e​i​v​e​ ​r​e​a​l​-​t​i​m​e​ ​w​e​b​h​o​o​k​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​.​ ​P​e​r​f​e​c​t​ ​f​o​r​ ​b​u​s​i​n​e​s​s​e​s​ ​o​f​ ​a​l​l​ ​s​i​z​e​s​ ​l​o​o​k​i​n​g​ ​t​o​ ​a​c​c​e​p​t​ ​p​a​y​m​e​n​t​s​ ​s​e​c​u​r​e​l​y​ ​a​n​d​ ​e​f​f​i​c​i​e​n​t​l​y​. + */ + longDesc: string + actions: { + create_order: { /** - * U​p​d​a​t​e​ ​P​r​o​f​i​l​e + * C​r​e​a​t​e​ ​O​r​d​e​r */ displayName: string /** - * U​p​d​a​t​e​ ​u​s​e​r​ ​p​r​o​f​i​l​e​ ​i​n​f​o​r​m​a​t​i​o​n + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​a​y​m​e​n​t​ ​o​r​d​e​r​ ​w​i​t​h​ ​p​u​r​c​h​a​s​e​ ​d​e​t​a​i​l​s */ shortDesc: string /** - * U​p​d​a​t​e​ ​b​a​s​i​c​ ​p​r​o​f​i​l​e​ ​f​i​e​l​d​s​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​ ​o​r​ ​t​i​t​l​e​.​ ​R​e​q​u​i​r​e​s​ ​u​s​e​r​ ​t​o​k​e​n​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​. + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​P​a​y​P​a​l​ ​o​r​d​e​r​ ​w​i​t​h​ ​s​p​e​c​i​f​i​e​d​ ​p​a​y​m​e​n​t​ ​a​m​o​u​n​t​,​ ​i​t​e​m​s​,​ ​s​h​i​p​p​i​n​g​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​p​r​e​f​e​r​e​n​c​e​s​.​ ​O​r​d​e​r​s​ ​r​e​p​r​e​s​e​n​t​ ​a​ ​p​a​y​m​e​n​t​ ​b​e​t​w​e​e​n​ ​t​w​o​ ​o​r​ ​m​o​r​e​ ​p​a​r​t​i​e​s​ ​a​n​d​ ​c​a​n​ ​b​e​ ​a​u​t​h​o​r​i​z​e​d​ ​i​m​m​e​d​i​a​t​e​l​y​ ​o​r​ ​c​a​p​t​u​r​e​d​ ​l​a​t​e​r​.​ ​S​u​p​p​o​r​t​s​ ​v​a​r​i​o​u​s​ ​p​a​y​m​e​n​t​ ​s​o​u​r​c​e​s​ ​i​n​c​l​u​d​i​n​g​ ​P​a​y​P​a​l​,​ ​c​a​r​d​s​,​ ​a​n​d​ ​a​l​t​e​r​n​a​t​i​v​e​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​s​. */ longDesc: string options: { - firstName: { - /** - * F​i​r​s​t​ ​N​a​m​e - */ - displayName: string - /** - * U​s​e​r​ ​f​i​r​s​t​ ​n​a​m​e - */ - shortDesc: string - /** - * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​t​o​ ​s​e​t​ ​i​n​ ​t​h​e​ ​p​r​o​f​i​l​e​. - */ - longDesc: string - } - lastName: { + intent: { /** - * L​a​s​t​ ​N​a​m​e + * P​a​y​m​e​n​t​ ​I​n​t​e​n​t */ displayName: string /** - * U​s​e​r​ ​l​a​s​t​ ​n​a​m​e + * W​h​e​t​h​e​r​ ​t​o​ ​c​a​p​t​u​r​e​ ​p​a​y​m​e​n​t​ ​i​m​m​e​d​i​a​t​e​l​y​ ​o​r​ ​a​u​t​h​o​r​i​z​e​ ​f​o​r​ ​l​a​t​e​r​ ​c​a​p​t​u​r​e */ shortDesc: string /** - * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​t​o​ ​s​e​t​ ​i​n​ ​t​h​e​ ​p​r​o​f​i​l​e​. + * D​e​t​e​r​m​i​n​e​s​ ​w​h​e​n​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​w​i​l​l​ ​b​e​ ​p​r​o​c​e​s​s​e​d​.​ ​C​A​P​T​U​R​E​ ​p​r​o​c​e​s​s​e​s​ ​p​a​y​m​e​n​t​ ​i​m​m​e​d​i​a​t​e​l​y​ ​a​f​t​e​r​ ​a​p​p​r​o​v​a​l​,​ ​w​h​i​l​e​ ​A​U​T​H​O​R​I​Z​E​ ​p​l​a​c​e​s​ ​a​ ​h​o​l​d​ ​o​n​ ​f​u​n​d​s​ ​f​o​r​ ​u​p​ ​t​o​ ​2​9​ ​d​a​y​s​,​ ​a​l​l​o​w​i​n​g​ ​y​o​u​ ​t​o​ ​c​a​p​t​u​r​e​ ​p​a​y​m​e​n​t​ ​w​h​e​n​ ​r​e​a​d​y​ ​t​o​ ​f​u​l​f​i​l​l​ ​t​h​e​ ​o​r​d​e​r​. */ longDesc: string } - email: { + currency_code: { /** - * E​m​a​i​l + * C​u​r​r​e​n​c​y​ ​C​o​d​e */ displayName: string /** - * U​s​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * T​h​r​e​e​-​l​e​t​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​s​e​t​.​ ​C​h​a​n​g​i​n​g​ ​e​m​a​i​l​ ​w​i​l​l​ ​s​e​n​d​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​t​o​ ​b​o​t​h​ ​o​l​d​ ​a​n​d​ ​n​e​w​ ​a​d​d​r​e​s​s​e​s​. + * T​h​e​ ​t​h​r​e​e​-​c​h​a​r​a​c​t​e​r​ ​I​S​O​-​4​2​1​7​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​t​h​a​t​ ​i​d​e​n​t​i​f​i​e​s​ ​t​h​e​ ​c​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​.​ ​M​u​s​t​ ​b​e​ ​s​u​p​p​o​r​t​e​d​ ​b​y​ ​P​a​y​P​a​l​ ​a​n​d​ ​m​a​t​c​h​ ​y​o​u​r​ ​b​u​s​i​n​e​s​s​ ​a​c​c​o​u​n​t​ ​s​e​t​t​i​n​g​s​. */ longDesc: string } - userId: { + total_amount: { /** - * U​s​e​r​ ​I​D + * T​o​t​a​l​ ​A​m​o​u​n​t */ displayName: string /** - * T​a​r​g​e​t​ ​u​s​e​r​ ​(​a​d​m​i​n​ ​o​n​l​y​) + * T​o​t​a​l​ ​p​a​y​m​e​n​t​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g */ shortDesc: string /** - * I​D​ ​o​f​ ​u​s​e​r​ ​t​o​ ​u​p​d​a​t​e​.​ ​O​n​l​y​ ​a​d​m​i​n​s​ ​o​n​ ​p​a​i​d​ ​t​e​a​m​s​ ​c​a​n​ ​u​p​d​a​t​e​ ​o​t​h​e​r​ ​u​s​e​r​s​. + * T​h​e​ ​t​o​t​a​l​ ​a​m​o​u​n​t​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​M​u​s​t​ ​b​e​ ​a​ ​p​o​s​i​t​i​v​e​ ​n​u​m​b​e​r​ ​a​n​d​ ​m​a​t​c​h​ ​t​h​e​ ​s​u​m​ ​o​f​ ​a​l​l​ ​b​r​e​a​k​d​o​w​n​ ​c​o​m​p​o​n​e​n​t​s​ ​i​f​ ​p​r​o​v​i​d​e​d​.​ ​F​o​r​m​a​t​ ​a​s​ ​a​ ​s​t​r​i​n​g​ ​w​i​t​h​ ​a​p​p​r​o​p​r​i​a​t​e​ ​d​e​c​i​m​a​l​ ​p​r​e​c​i​s​i​o​n​ ​f​o​r​ ​t​h​e​ ​c​u​r​r​e​n​c​y​. */ longDesc: string } - } - } - list_users: { - groups: { - /** - * U​s​e​r​s - */ - '0': string - } - /** - * L​i​s​t​ ​U​s​e​r​s - */ - displayName: string - /** - * L​i​s​t​ ​u​s​e​r​s​ ​i​n​ ​t​h​e​ ​w​o​r​k​s​p​a​c​e - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​u​s​e​r​s​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​ ​i​n​c​l​u​d​i​n​g​ ​t​h​e​i​r​ ​p​r​o​f​i​l​e​ ​i​n​f​o​r​m​a​t​i​o​n​. - */ - longDesc: string - options: { - limit: { + item_total: { /** - * L​i​m​i​t + * I​t​e​m​ ​T​o​t​a​l */ displayName: string /** - * M​a​x​i​m​u​m​ ​u​s​e​r​s​ ​t​o​ ​r​e​t​u​r​n + * T​o​t​a​l​ ​c​o​s​t​ ​o​f​ ​a​l​l​ ​i​t​e​m​s​ ​b​e​f​o​r​e​ ​t​a​x​e​s​ ​a​n​d​ ​f​e​e​s */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​2​0​0​. + * T​h​e​ ​t​o​t​a​l​ ​c​o​s​t​ ​o​f​ ​a​l​l​ ​i​t​e​m​s​ ​i​n​ ​t​h​e​ ​o​r​d​e​r​ ​b​e​f​o​r​e​ ​a​p​p​l​y​i​n​g​ ​t​a​x​e​s​,​ ​s​h​i​p​p​i​n​g​,​ ​h​a​n​d​l​i​n​g​,​ ​i​n​s​u​r​a​n​c​e​,​ ​o​r​ ​d​i​s​c​o​u​n​t​s​.​ ​S​h​o​u​l​d​ ​e​q​u​a​l​ ​t​h​e​ ​s​u​m​ ​o​f​ ​(​q​u​a​n​t​i​t​y​ ​×​ ​u​n​i​t​_​a​m​o​u​n​t​)​ ​f​o​r​ ​a​l​l​ ​i​t​e​m​s​. */ longDesc: string } - } - } - get_user_info: { - groups: { - /** - * U​s​e​r​s - */ - '0': string - } - /** - * G​e​t​ ​U​s​e​r​ ​I​n​f​o - */ - displayName: string - /** - * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​u​s​e​r - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​p​r​o​f​i​l​e​ ​a​n​d​ ​a​c​c​o​u​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​S​l​a​c​k​ ​u​s​e​r​ ​b​y​ ​t​h​e​i​r​ ​u​s​e​r​ ​I​D​. - */ - longDesc: string - options: { - userId: { + shipping_amount: { /** - * U​s​e​r + * S​h​i​p​p​i​n​g​ ​A​m​o​u​n​t */ displayName: string /** - * T​h​e​ ​u​s​e​r​ ​t​o​ ​g​e​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * C​o​s​t​ ​o​f​ ​s​h​i​p​p​i​n​g​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​s​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. + * T​h​e​ ​s​h​i​p​p​i​n​g​ ​c​o​s​t​ ​f​o​r​ ​d​e​l​i​v​e​r​i​n​g​ ​t​h​e​ ​i​t​e​m​s​ ​i​n​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​T​h​i​s​ ​a​m​o​u​n​t​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​t​h​e​ ​t​o​t​a​l​ ​o​r​d​e​r​ ​a​m​o​u​n​t​. */ longDesc: string } - } - } - upload_file: { - groups: { - /** - * F​i​l​e​s - */ - '0': string - } - /** - * U​p​l​o​a​d​ ​F​i​l​e - */ - displayName: string - /** - * U​p​l​o​a​d​ ​a​ ​f​i​l​e​ ​t​o​ ​S​l​a​c​k - */ - shortDesc: string - /** - * U​p​l​o​a​d​ ​a​ ​f​i​l​e​ ​t​o​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l​.​ ​S​u​p​p​o​r​t​s​ ​v​a​r​i​o​u​s​ ​f​i​l​e​ ​t​y​p​e​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​i​n​i​t​i​a​l​ ​c​o​m​m​e​n​t​. - */ - longDesc: string - options: { - channel: { + handling_amount: { /** - * C​h​a​n​n​e​l + * H​a​n​d​l​i​n​g​ ​A​m​o​u​n​t */ displayName: string /** - * C​h​a​n​n​e​l​ ​t​o​ ​u​p​l​o​a​d​ ​t​o + * H​a​n​d​l​i​n​g​ ​f​e​e​ ​f​o​r​ ​p​r​o​c​e​s​s​i​n​g​ ​t​h​i​s​ ​o​r​d​e​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​l​e​ ​s​h​o​u​l​d​ ​b​e​ ​u​p​l​o​a​d​e​d​. + * A​d​d​i​t​i​o​n​a​l​ ​h​a​n​d​l​i​n​g​ ​f​e​e​ ​c​h​a​r​g​e​d​ ​f​o​r​ ​p​r​o​c​e​s​s​i​n​g​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​T​h​i​s​ ​c​o​v​e​r​s​ ​c​o​s​t​s​ ​l​i​k​e​ ​p​a​c​k​a​g​i​n​g​ ​a​n​d​ ​o​r​d​e​r​ ​p​r​o​c​e​s​s​i​n​g​. */ longDesc: string } - file: { + tax_total: { /** - * F​i​l​e + * T​a​x​ ​T​o​t​a​l */ displayName: string /** - * T​h​e​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d + * T​o​t​a​l​ ​t​a​x​ ​a​m​o​u​n​t​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r */ shortDesc: string /** - * T​h​e​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d​ ​t​o​ ​t​h​e​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l​. + * T​h​e​ ​t​o​t​a​l​ ​t​a​x​ ​a​m​o​u​n​t​ ​f​o​r​ ​a​l​l​ ​i​t​e​m​s​ ​i​n​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​T​h​i​s​ ​i​n​c​l​u​d​e​s​ ​s​a​l​e​s​ ​t​a​x​,​ ​V​A​T​,​ ​o​r​ ​o​t​h​e​r​ ​a​p​p​l​i​c​a​b​l​e​ ​t​a​x​e​s​ ​b​a​s​e​d​ ​o​n​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​ ​a​n​d​ ​l​o​c​a​l​ ​r​e​g​u​l​a​t​i​o​n​s​. */ longDesc: string } - filename: { + insurance_amount: { /** - * F​i​l​e​n​a​m​e + * I​n​s​u​r​a​n​c​e​ ​A​m​o​u​n​t */ displayName: string /** - * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​f​i​l​e + * I​n​s​u​r​a​n​c​e​ ​c​o​s​t​ ​f​o​r​ ​t​h​i​s​ ​s​h​i​p​m​e​n​t */ shortDesc: string /** - * T​h​e​ ​f​i​l​e​n​a​m​e​ ​t​o​ ​u​s​e​ ​w​h​e​n​ ​u​p​l​o​a​d​i​n​g​. + * O​p​t​i​o​n​a​l​ ​i​n​s​u​r​a​n​c​e​ ​a​m​o​u​n​t​ ​t​o​ ​p​r​o​t​e​c​t​ ​t​h​e​ ​s​h​i​p​m​e​n​t​.​ ​T​h​i​s​ ​c​o​v​e​r​s​ ​t​h​e​ ​v​a​l​u​e​ ​o​f​ ​i​t​e​m​s​ ​i​n​ ​c​a​s​e​ ​o​f​ ​l​o​s​s​ ​o​r​ ​d​a​m​a​g​e​ ​d​u​r​i​n​g​ ​s​h​i​p​p​i​n​g​. */ longDesc: string } - comment: { + shipping_discount: { /** - * I​n​i​t​i​a​l​ ​C​o​m​m​e​n​t + * S​h​i​p​p​i​n​g​ ​D​i​s​c​o​u​n​t */ displayName: string /** - * C​o​m​m​e​n​t​ ​w​i​t​h​ ​t​h​e​ ​f​i​l​e + * D​i​s​c​o​u​n​t​ ​a​p​p​l​i​e​d​ ​t​o​ ​s​h​i​p​p​i​n​g​ ​c​o​s​t​s */ shortDesc: string /** - * A​n​ ​o​p​t​i​o​n​a​l​ ​c​o​m​m​e​n​t​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​h​e​n​ ​s​h​a​r​i​n​g​ ​t​h​e​ ​f​i​l​e​. + * A​n​y​ ​d​i​s​c​o​u​n​t​ ​a​p​p​l​i​e​d​ ​s​p​e​c​i​f​i​c​a​l​l​y​ ​t​o​ ​s​h​i​p​p​i​n​g​ ​c​o​s​t​s​,​ ​s​u​c​h​ ​a​s​ ​f​r​e​e​ ​s​h​i​p​p​i​n​g​ ​p​r​o​m​o​t​i​o​n​s​ ​o​r​ ​r​e​d​u​c​e​d​ ​s​h​i​p​p​i​n​g​ ​f​e​e​s​ ​f​o​r​ ​b​u​l​k​ ​o​r​d​e​r​s​. */ longDesc: string } - } - } - request_action_message: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } - /** - * S​e​n​d​ ​A​c​t​i​o​n​ ​M​e​s​s​a​g​e​ ​t​o​ ​C​h​a​n​n​e​l - */ - displayName: string - /** - * S​e​n​d​ ​a​ ​m​e​s​s​a​g​e​ ​w​i​t​h​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s - */ - shortDesc: string - /** - * S​e​n​d​ ​a​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​c​h​a​n​n​e​l​ ​w​i​t​h​ ​i​n​t​e​r​a​c​t​i​v​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​ ​t​h​a​t​ ​l​i​n​k​ ​t​o​ ​U​R​L​s​. - */ - longDesc: string - options: { - channel: { + discount_amount: { /** - * C​h​a​n​n​e​l + * D​i​s​c​o​u​n​t​ ​A​m​o​u​n​t */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​s​e​n​d​ ​t​o + * T​o​t​a​l​ ​d​i​s​c​o​u​n​t​ ​a​p​p​l​i​e​d​ ​t​o​ ​t​h​e​ ​o​r​d​e​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​t​e​d​. + * T​h​e​ ​t​o​t​a​l​ ​d​i​s​c​o​u​n​t​ ​a​m​o​u​n​t​ ​a​p​p​l​i​e​d​ ​t​o​ ​t​h​i​s​ ​o​r​d​e​r​,​ ​i​n​c​l​u​d​i​n​g​ ​c​o​u​p​o​n​ ​c​o​d​e​s​,​ ​p​r​o​m​o​t​i​o​n​s​,​ ​o​r​ ​b​u​l​k​ ​d​i​s​c​o​u​n​t​s​.​ ​T​h​i​s​ ​r​e​d​u​c​e​s​ ​t​h​e​ ​o​v​e​r​a​l​l​ ​o​r​d​e​r​ ​t​o​t​a​l​. */ longDesc: string } - text: { + payee_email: { /** - * M​e​s​s​a​g​e​ ​T​e​x​t + * P​a​y​e​e​ ​E​m​a​i​l */ displayName: string /** - * T​h​e​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t + * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​r​e​c​i​p​i​e​n​t */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​d​i​s​p​l​a​y​e​d​ ​a​b​o​v​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​. + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​m​e​r​c​h​a​n​t​ ​o​r​ ​s​e​l​l​e​r​ ​w​h​o​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​a​y​m​e​n​t​.​ ​R​e​q​u​i​r​e​d​ ​f​o​r​ ​m​a​r​k​e​t​p​l​a​c​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​o​r​ ​w​h​e​n​ ​s​p​e​c​i​f​y​i​n​g​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​r​e​c​i​p​i​e​n​t​. */ longDesc: string } - actions: { + payee_merchant_id: { /** - * A​c​t​i​o​n​ ​B​u​t​t​o​n​s + * P​a​y​e​e​ ​M​e​r​c​h​a​n​t​ ​I​D */ displayName: string /** - * B​u​t​t​o​n​s​ ​t​o​ ​d​i​s​p​l​a​y + * P​a​y​P​a​l​ ​m​e​r​c​h​a​n​t​ ​I​D​ ​o​f​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​r​e​c​i​p​i​e​n​t */ shortDesc: string /** - * D​e​f​i​n​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​ ​w​i​t​h​ ​t​i​t​l​e​s​ ​a​n​d​ ​U​R​L​s​.​ ​E​a​c​h​ ​b​u​t​t​o​n​ ​l​i​n​k​s​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​U​R​L​ ​w​h​e​n​ ​c​l​i​c​k​e​d​. + * T​h​e​ ​P​a​y​P​a​l​ ​m​e​r​c​h​a​n​t​ ​I​D​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​a​y​m​e​n​t​.​ ​U​s​e​d​ ​f​o​r​ ​m​a​r​k​e​t​p​l​a​c​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​o​r​ ​w​h​e​n​ ​r​o​u​t​i​n​g​ ​p​a​y​m​e​n​t​s​ ​t​o​ ​s​p​e​c​i​f​i​c​ ​m​e​r​c​h​a​n​t​s​. */ longDesc: string - type: { - element_type: { - fields: { - title: { - /** - * B​u​t​t​o​n​ ​T​i​t​l​e - */ - displayName: string - /** - * T​e​x​t​ ​d​i​s​p​l​a​y​e​d​ ​o​n​ ​t​h​e​ ​b​u​t​t​o​n - */ - shortDesc: string - /** - * T​h​e​ ​t​e​x​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​h​o​w​n​ ​o​n​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​. - */ - longDesc: string - } - url: { - /** - * B​u​t​t​o​n​ ​U​R​L - */ - displayName: string - /** - * U​R​L​ ​t​h​e​ ​b​u​t​t​o​n​ ​l​i​n​k​s​ ​t​o - */ - shortDesc: string - /** - * T​h​e​ ​U​R​L​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​o​p​e​n​e​d​ ​w​h​e​n​ ​t​h​e​ ​b​u​t​t​o​n​ ​i​s​ ​c​l​i​c​k​e​d​. - */ - longDesc: string - } - } - } - } } - username: { + description: { /** - * B​o​t​ ​U​s​e​r​n​a​m​e + * O​r​d​e​r​ ​D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * C​u​s​t​o​m​ ​b​o​t​ ​n​a​m​e + * D​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​o​r​ ​p​u​r​c​h​a​s​e */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​u​s​e​r​n​a​m​e​. + * A​ ​b​r​i​e​f​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​v​i​s​i​b​l​e​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​d​u​r​i​n​g​ ​c​h​e​c​k​o​u​t​ ​a​n​d​ ​i​n​ ​t​h​e​i​r​ ​t​r​a​n​s​a​c​t​i​o​n​ ​h​i​s​t​o​r​y​. */ longDesc: string } - iconUrl: { + custom_id: { /** - * I​c​o​n​ ​U​R​L + * C​u​s​t​o​m​ ​I​D */ displayName: string /** - * C​u​s​t​o​m​ ​b​o​t​ ​i​c​o​n + * Y​o​u​r​ ​c​u​s​t​o​m​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​i​c​o​n​. + * A​ ​c​u​s​t​o​m​ ​i​d​e​n​t​i​f​i​e​r​ ​t​h​a​t​ ​y​o​u​ ​c​a​n​ ​u​s​e​ ​t​o​ ​t​r​a​c​k​ ​t​h​i​s​ ​o​r​d​e​r​ ​i​n​ ​y​o​u​r​ ​o​w​n​ ​s​y​s​t​e​m​s​.​ ​T​h​i​s​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​ ​i​n​ ​w​e​b​h​o​o​k​s​ ​a​n​d​ ​A​P​I​ ​r​e​s​p​o​n​s​e​s​. */ longDesc: string } - } - } - request_action_dm: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } - /** - * S​e​n​d​ ​A​c​t​i​o​n​ ​M​e​s​s​a​g​e​ ​t​o​ ​U​s​e​r - */ - displayName: string - /** - * S​e​n​d​ ​a​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​ ​w​i​t​h​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s - */ - shortDesc: string - /** - * S​e​n​d​ ​a​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​u​s​e​r​ ​w​i​t​h​ ​i​n​t​e​r​a​c​t​i​v​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​ ​t​h​a​t​ ​l​i​n​k​ ​t​o​ ​U​R​L​s​. - */ - longDesc: string - options: { - userId: { + invoice_id: { /** - * U​s​e​r + * I​n​v​o​i​c​e​ ​I​D */ displayName: string /** - * T​h​e​ ​u​s​e​r​ ​t​o​ ​m​e​s​s​a​g​e + * I​n​v​o​i​c​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​t​o​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​m​e​s​s​a​g​e​. + * T​h​e​ ​i​n​v​o​i​c​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​H​e​l​p​s​ ​m​a​t​c​h​ ​o​r​d​e​r​s​ ​w​i​t​h​ ​y​o​u​r​ ​a​c​c​o​u​n​t​i​n​g​ ​s​y​s​t​e​m​ ​a​n​d​ ​p​r​e​v​e​n​t​s​ ​d​u​p​l​i​c​a​t​e​ ​p​a​y​m​e​n​t​s​. */ longDesc: string } - text: { + soft_descriptor: { /** - * M​e​s​s​a​g​e​ ​T​e​x​t + * S​o​f​t​ ​D​e​s​c​r​i​p​t​o​r */ displayName: string /** - * T​h​e​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t + * T​e​x​t​ ​t​h​a​t​ ​a​p​p​e​a​r​s​ ​o​n​ ​c​u​s​t​o​m​e​r​'​s​ ​c​r​e​d​i​t​ ​c​a​r​d​ ​s​t​a​t​e​m​e​n​t */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​d​i​s​p​l​a​y​e​d​ ​a​b​o​v​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​. + * T​h​e​ ​t​e​x​t​ ​t​h​a​t​ ​a​p​p​e​a​r​s​ ​o​n​ ​t​h​e​ ​c​u​s​t​o​m​e​r​'​s​ ​c​r​e​d​i​t​ ​c​a​r​d​ ​o​r​ ​b​a​n​k​ ​s​t​a​t​e​m​e​n​t​.​ ​K​e​e​p​ ​i​t​ ​s​h​o​r​t​ ​a​n​d​ ​r​e​c​o​g​n​i​z​a​b​l​e​ ​t​o​ ​a​v​o​i​d​ ​c​h​a​r​g​e​b​a​c​k​s​. */ longDesc: string } - actions: { + items: { /** - * A​c​t​i​o​n​ ​B​u​t​t​o​n​s + * O​r​d​e​r​ ​I​t​e​m​s */ displayName: string /** - * B​u​t​t​o​n​s​ ​t​o​ ​d​i​s​p​l​a​y + * L​i​s​t​ ​o​f​ ​i​t​e​m​s​ ​b​e​i​n​g​ ​p​u​r​c​h​a​s​e​d */ shortDesc: string /** - * D​e​f​i​n​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​ ​w​i​t​h​ ​t​i​t​l​e​s​ ​a​n​d​ ​U​R​L​s​. + * A​r​r​a​y​ ​o​f​ ​i​t​e​m​s​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​i​s​ ​o​r​d​e​r​.​ ​E​a​c​h​ ​i​t​e​m​ ​s​h​o​u​l​d​ ​s​p​e​c​i​f​y​ ​n​a​m​e​,​ ​q​u​a​n​t​i​t​y​,​ ​u​n​i​t​ ​p​r​i​c​e​,​ ​a​n​d​ ​o​p​t​i​o​n​a​l​l​y​ ​d​e​s​c​r​i​p​t​i​o​n​,​ ​S​K​U​,​ ​c​a​t​e​g​o​r​y​,​ ​a​n​d​ ​t​a​x​ ​a​m​o​u​n​t​. */ longDesc: string type: { element_type: { fields: { - title: { + name: { /** - * B​u​t​t​o​n​ ​T​i​t​l​e + * I​t​e​m​ ​N​a​m​e */ displayName: string /** - * T​e​x​t​ ​d​i​s​p​l​a​y​e​d​ ​o​n​ ​t​h​e​ ​b​u​t​t​o​n + * N​a​m​e​ ​o​f​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * T​h​e​ ​t​e​x​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​h​o​w​n​ ​o​n​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​. + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​h​o​w​n​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​d​u​r​i​n​g​ ​c​h​e​c​k​o​u​t​. + */ + longDesc: string + } + quantity: { + /** + * Q​u​a​n​t​i​t​y + */ + displayName: string + /** + * N​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s + */ + shortDesc: string + /** + * T​h​e​ ​q​u​a​n​t​i​t​y​ ​o​f​ ​t​h​i​s​ ​i​t​e​m​ ​b​e​i​n​g​ ​p​u​r​c​h​a​s​e​d​.​ ​M​u​s​t​ ​b​e​ ​a​ ​p​o​s​i​t​i​v​e​ ​i​n​t​e​g​e​r​. + */ + longDesc: string + } + unit_price: { + /** + * U​n​i​t​ ​P​r​i​c​e + */ + displayName: string + /** + * P​r​i​c​e​ ​p​e​r​ ​i​n​d​i​v​i​d​u​a​l​ ​i​t​e​m + */ + shortDesc: string + /** + * T​h​e​ ​c​o​s​t​ ​p​e​r​ ​i​n​d​i​v​i​d​u​a​l​ ​u​n​i​t​ ​o​f​ ​t​h​i​s​ ​i​t​e​m​,​ ​b​e​f​o​r​e​ ​t​a​x​e​s​ ​a​n​d​ ​d​i​s​c​o​u​n​t​s​. + */ + longDesc: string + } + description: { + /** + * I​t​e​m​ ​D​e​s​c​r​i​p​t​i​o​n + */ + displayName: string + /** + * D​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​i​t​e​m + */ + shortDesc: string + /** + * O​p​t​i​o​n​a​l​ ​d​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​p​r​o​v​i​d​i​n​g​ ​m​o​r​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​i​s​ ​i​t​e​m​. + */ + longDesc: string + } + sku: { + /** + * S​K​U + */ + displayName: string + /** + * S​t​o​c​k​ ​k​e​e​p​i​n​g​ ​u​n​i​t​ ​i​d​e​n​t​i​f​i​e​r + */ + shortDesc: string + /** + * Y​o​u​r​ ​i​n​t​e​r​n​a​l​ ​s​t​o​c​k​ ​k​e​e​p​i​n​g​ ​u​n​i​t​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​i​n​v​e​n​t​o​r​y​ ​t​r​a​c​k​i​n​g​. */ longDesc: string } url: { /** - * B​u​t​t​o​n​ ​U​R​L + * I​t​e​m​ ​U​R​L */ displayName: string /** - * U​R​L​ ​t​h​e​ ​b​u​t​t​o​n​ ​l​i​n​k​s​ ​t​o + * L​i​n​k​ ​t​o​ ​t​h​e​ ​i​t​e​m​ ​p​a​g​e */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​o​p​e​n​e​d​ ​w​h​e​n​ ​t​h​e​ ​b​u​t​t​o​n​ ​i​s​ ​c​l​i​c​k​e​d​. + * O​p​t​i​o​n​a​l​ ​U​R​L​ ​l​i​n​k​i​n​g​ ​t​o​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​p​a​g​e​ ​w​h​e​r​e​ ​c​u​s​t​o​m​e​r​s​ ​c​a​n​ ​v​i​e​w​ ​m​o​r​e​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​i​s​ ​i​t​e​m​. + */ + longDesc: string + } + category: { + /** + * I​t​e​m​ ​C​a​t​e​g​o​r​y + */ + displayName: string + /** + * C​a​t​e​g​o​r​y​ ​t​y​p​e​ ​o​f​ ​t​h​e​ ​i​t​e​m + */ + shortDesc: string + /** + * T​h​e​ ​c​a​t​e​g​o​r​y​ ​c​l​a​s​s​i​f​i​c​a​t​i​o​n​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m​,​ ​w​h​i​c​h​ ​a​f​f​e​c​t​s​ ​p​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​i​n​g​ ​a​n​d​ ​c​o​m​p​l​i​a​n​c​e​ ​r​e​q​u​i​r​e​m​e​n​t​s​. + */ + longDesc: string + } + tax_amount: { + /** + * T​a​x​ ​A​m​o​u​n​t + */ + displayName: string + /** + * T​a​x​ ​a​m​o​u​n​t​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m + */ + shortDesc: string + /** + * T​h​e​ ​t​a​x​ ​a​m​o​u​n​t​ ​s​p​e​c​i​f​i​c​a​l​l​y​ ​f​o​r​ ​t​h​i​s​ ​i​t​e​m​,​ ​c​a​l​c​u​l​a​t​e​d​ ​b​a​s​e​d​ ​o​n​ ​q​u​a​n​t​i​t​y​ ​a​n​d​ ​a​p​p​l​i​c​a​b​l​e​ ​t​a​x​ ​r​a​t​e​s​. */ longDesc: string } @@ -127926,5286 +127570,6455 @@ type RootTranslation = { } } } - username: { + shipping_type: { /** - * B​o​t​ ​U​s​e​r​n​a​m​e + * S​h​i​p​p​i​n​g​ ​T​y​p​e */ displayName: string /** - * C​u​s​t​o​m​ ​b​o​t​ ​n​a​m​e + * M​e​t​h​o​d​ ​o​f​ ​d​e​l​i​v​e​r​y​ ​f​o​r​ ​t​h​i​s​ ​o​r​d​e​r */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​u​s​e​r​n​a​m​e​. + * S​p​e​c​i​f​i​e​s​ ​h​o​w​ ​t​h​e​ ​i​t​e​m​s​ ​w​i​l​l​ ​b​e​ ​d​e​l​i​v​e​r​e​d​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​A​f​f​e​c​t​s​ ​s​h​i​p​p​i​n​g​ ​c​o​s​t​s​ ​a​n​d​ ​d​e​l​i​v​e​r​y​ ​t​i​m​e​l​i​n​e​. */ longDesc: string } - iconUrl: { + shipping_name: { /** - * I​c​o​n​ ​U​R​L + * S​h​i​p​p​i​n​g​ ​N​a​m​e */ displayName: string /** - * C​u​s​t​o​m​ ​b​o​t​ ​i​c​o​n + * F​u​l​l​ ​n​a​m​e​ ​f​o​r​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​i​c​o​n​. + * T​h​e​ ​c​o​m​p​l​e​t​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​e​r​s​o​n​ ​w​h​o​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​s​h​i​p​m​e​n​t​ ​a​t​ ​t​h​e​ ​d​e​l​i​v​e​r​y​ ​a​d​d​r​e​s​s​. */ longDesc: string } - } - } - } - triggers: { - new_message: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } - /** - * N​e​w​ ​M​e​s​s​a​g​e - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​i​s​ ​p​o​s​t​e​d​ ​t​o​ ​a​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​i​s​ ​p​o​s​t​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​h​a​n​n​e​l​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​r​e​a​c​t​ ​t​o​ ​i​n​c​o​m​i​n​g​ ​m​e​s​s​a​g​e​s​. - */ - longDesc: string - options: { - channel: { + shipping_address_line_1: { /** - * C​h​a​n​n​e​l + * S​h​i​p​p​i​n​g​ ​A​d​d​r​e​s​s​ ​L​i​n​e​ ​1 */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r + * P​r​i​m​a​r​y​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​m​e​s​s​a​g​e​s​.​ ​M​a​k​e​ ​s​u​r​e​ ​t​h​e​ ​b​o​t​ ​i​s​ ​a​ ​m​e​m​b​e​r​ ​o​f​ ​t​h​e​ ​c​h​a​n​n​e​l​. + * T​h​e​ ​f​i​r​s​t​ ​l​i​n​e​ ​o​f​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​,​ ​t​y​p​i​c​a​l​l​y​ ​c​o​n​t​a​i​n​i​n​g​ ​s​t​r​e​e​t​ ​n​u​m​b​e​r​ ​a​n​d​ ​n​a​m​e​. */ longDesc: string } - } - } - new_reaction: { - groups: { - /** - * R​e​a​c​t​i​o​n​s - */ - '0': string - } - /** - * N​e​w​ ​R​e​a​c​t​i​o​n - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​r​e​a​c​t​i​o​n​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​m​e​s​s​a​g​e - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​r​e​a​c​t​i​o​n​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​n​y​ ​m​e​s​s​a​g​e​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​e​m​o​j​i​s​ ​o​r​ ​c​h​a​n​n​e​l​s​. - */ - longDesc: string - options: { - emojis: { + shipping_address_line_2: { /** - * E​m​o​j​i​s + * S​h​i​p​p​i​n​g​ ​A​d​d​r​e​s​s​ ​L​i​n​e​ ​2 */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​e​m​o​j​i​s + * S​e​c​o​n​d​a​r​y​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​ ​l​i​n​e */ shortDesc: string /** - * O​p​t​i​o​n​a​l​l​y​ ​s​p​e​c​i​f​y​ ​e​m​o​j​i​ ​n​a​m​e​s​ ​t​o​ ​t​r​i​g​g​e​r​ ​o​n​ ​(​e​.​g​.​,​ ​"​f​i​r​e​"​,​ ​"​t​h​u​m​b​s​u​p​"​)​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​f​o​r​ ​a​l​l​ ​r​e​a​c​t​i​o​n​s​. + * O​p​t​i​o​n​a​l​ ​s​e​c​o​n​d​ ​l​i​n​e​ ​o​f​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​a​p​a​r​t​m​e​n​t​ ​n​u​m​b​e​r​s​,​ ​s​u​i​t​e​ ​n​u​m​b​e​r​s​,​ ​o​r​ ​a​d​d​i​t​i​o​n​a​l​ ​l​o​c​a​t​i​o​n​ ​d​e​t​a​i​l​s​. */ longDesc: string } - channel: { + shipping_city: { /** - * C​h​a​n​n​e​l + * S​h​i​p​p​i​n​g​ ​C​i​t​y */ displayName: string /** - * F​i​l​t​e​r​ ​b​y​ ​c​h​a​n​n​e​l + * C​i​t​y​ ​f​o​r​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s */ shortDesc: string /** - * O​p​t​i​o​n​a​l​l​y​ ​s​e​l​e​c​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​a​l​l​ ​c​h​a​n​n​e​l​s​. + * T​h​e​ ​c​i​t​y​ ​w​h​e​r​e​ ​t​h​e​ ​i​t​e​m​s​ ​w​i​l​l​ ​b​e​ ​d​e​l​i​v​e​r​e​d​. */ longDesc: string } - } - } - channel_created: { - groups: { - /** - * C​h​a​n​n​e​l​s - */ - '0': string - } - /** - * C​h​a​n​n​e​l​ ​C​r​e​a​t​e​d - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​h​a​n​n​e​l​ ​i​s​ ​c​r​e​a​t​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​p​u​b​l​i​c​ ​o​r​ ​p​r​i​v​a​t​e​ ​c​h​a​n​n​e​l​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​t​h​e​ ​w​o​r​k​s​p​a​c​e​. - */ - longDesc: string - options: { - } - } - app_mention: { - groups: { - /** - * M​e​s​s​a​g​e​s - */ - '0': string - } - /** - * A​p​p​ ​M​e​n​t​i​o​n - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​t​h​e​ ​b​o​t​ ​i​s​ ​m​e​n​t​i​o​n​e​d​ ​i​n​ ​a​ ​c​h​a​n​n​e​l - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​s​o​m​e​o​n​e​ ​m​e​n​t​i​o​n​s​ ​t​h​e​ ​b​o​t​ ​i​n​ ​a​ ​m​e​s​s​a​g​e​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​h​a​n​n​e​l​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​r​e​s​p​o​n​d​ ​t​o​ ​d​i​r​e​c​t​ ​r​e​q​u​e​s​t​s​. - */ - longDesc: string - options: { - channel: { + shipping_state: { /** - * C​h​a​n​n​e​l + * S​h​i​p​p​i​n​g​ ​S​t​a​t​e */ displayName: string /** - * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​m​e​n​t​i​o​n​s + * S​t​a​t​e​ ​o​r​ ​p​r​o​v​i​n​c​e​ ​f​o​r​ ​s​h​i​p​p​i​n​g */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​b​o​t​ ​m​e​n​t​i​o​n​s​.​ ​M​a​k​e​ ​s​u​r​e​ ​t​h​e​ ​b​o​t​ ​i​s​ ​a​ ​m​e​m​b​e​r​ ​o​f​ ​t​h​e​ ​c​h​a​n​n​e​l​. + * T​h​e​ ​s​t​a​t​e​,​ ​p​r​o​v​i​n​c​e​,​ ​o​r​ ​r​e​g​i​o​n​ ​f​o​r​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​.​ ​U​s​e​ ​a​p​p​r​o​p​r​i​a​t​e​ ​c​o​d​e​s​ ​f​o​r​ ​t​h​e​ ​c​o​u​n​t​r​y​. */ longDesc: string } - } - } - } - } - SurveyMonkey: { - /** - * S​u​r​v​e​y​M​o​n​k​e​y - */ - displayName: string - groups: { - /** - * F​o​r​m​s​,​ ​S​u​r​v​e​y​s​ ​&​ ​S​c​h​e​d​u​l​i​n​g - */ - '0': string - } - /** - * O​n​l​i​n​e​ ​s​u​r​v​e​y​ ​p​l​a​t​f​o​r​m​ ​f​o​r​ ​c​o​l​l​e​c​t​i​n​g​ ​f​e​e​d​b​a​c​k​ ​a​n​d​ ​r​e​s​p​o​n​s​e​s - */ - shortDesc: string - /** - * C​o​n​n​e​c​t​ ​y​o​u​r​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​a​c​c​o​u​n​t​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​s​u​r​v​e​y​ ​m​a​n​a​g​e​m​e​n​t​,​ ​c​o​l​l​e​c​t​ ​r​e​s​p​o​n​s​e​s​,​ ​a​n​d​ ​m​a​n​a​g​e​ ​c​o​n​t​a​c​t​s​.​ ​C​r​e​a​t​e​ ​c​o​l​l​e​c​t​o​r​s​,​ ​s​e​n​d​ ​s​u​r​v​e​y​s​,​ ​r​e​t​r​i​e​v​e​ ​r​e​s​p​o​n​s​e​s​,​ ​a​n​d​ ​s​e​t​ ​u​p​ ​w​e​b​h​o​o​k​s​ ​f​o​r​ ​r​e​a​l​-​t​i​m​e​ ​r​e​s​p​o​n​s​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​a​l​l​ ​f​r​o​m​ ​w​i​t​h​i​n​ ​Q​o​r​e​. - */ - longDesc: string - triggers: { - new_response: { - /** - * N​e​w​ ​R​e​s​p​o​n​s​e - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​ ​i​s​ ​c​o​m​p​l​e​t​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​r​e​s​p​o​n​d​e​n​t​ ​c​o​m​p​l​e​t​e​s​ ​a​ ​s​u​r​v​e​y​.​ ​T​h​e​ ​w​e​b​h​o​o​k​ ​p​a​y​l​o​a​d​ ​i​n​c​l​u​d​e​s​ ​b​a​s​i​c​ ​r​e​s​p​o​n​s​e​ ​i​n​f​o​r​m​a​t​i​o​n​.​ ​U​s​e​ ​t​h​e​ ​"​G​e​t​ ​R​e​s​p​o​n​s​e​"​ ​a​c​t​i​o​n​ ​t​o​ ​f​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​r​e​s​p​o​n​s​e​ ​d​a​t​a​ ​i​n​c​l​u​d​i​n​g​ ​a​n​s​w​e​r​s​. - */ - longDesc: string - options: { - survey_id: { + shipping_postal_code: { /** - * S​u​r​v​e​y + * S​h​i​p​p​i​n​g​ ​P​o​s​t​a​l​ ​C​o​d​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​r​e​s​p​o​n​s​e​s + * Z​I​P​ ​o​r​ ​p​o​s​t​a​l​ ​c​o​d​e​ ​f​o​r​ ​s​h​i​p​p​i​n​g */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​p​l​e​t​e​d​ ​r​e​s​p​o​n​s​e​s + * T​h​e​ ​Z​I​P​ ​c​o​d​e​,​ ​p​o​s​t​a​l​ ​c​o​d​e​,​ ​o​r​ ​e​q​u​i​v​a​l​e​n​t​ ​f​o​r​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​. */ longDesc: string } - } - } - response_disqualified: { - /** - * R​e​s​p​o​n​s​e​ ​D​i​s​q​u​a​l​i​f​i​e​d - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​r​e​s​p​o​n​d​e​n​t​ ​i​s​ ​d​i​s​q​u​a​l​i​f​i​e​d​ ​f​r​o​m​ ​a​ ​s​u​r​v​e​y - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​r​e​s​p​o​n​d​e​n​t​ ​i​s​ ​s​c​r​e​e​n​e​d​ ​o​u​t​ ​o​r​ ​d​i​s​q​u​a​l​i​f​i​e​d​ ​f​r​o​m​ ​a​ ​s​u​r​v​e​y​ ​b​a​s​e​d​ ​o​n​ ​t​h​e​i​r​ ​a​n​s​w​e​r​s​ ​t​o​ ​q​u​a​l​i​f​y​i​n​g​ ​q​u​e​s​t​i​o​n​s​. - */ - longDesc: string - options: { - survey_id: { + shipping_country_code: { /** - * S​u​r​v​e​y + * S​h​i​p​p​i​n​g​ ​C​o​u​n​t​r​y​ ​C​o​d​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​d​i​s​q​u​a​l​i​f​i​e​d​ ​r​e​s​p​o​n​s​e​s + * T​w​o​-​l​e​t​t​e​r​ ​c​o​u​n​t​r​y​ ​c​o​d​e​ ​f​o​r​ ​s​h​i​p​p​i​n​g */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​d​i​s​q​u​a​l​i​f​i​e​d​ ​r​e​s​p​o​n​s​e​s + * T​h​e​ ​t​w​o​-​c​h​a​r​a​c​t​e​r​ ​I​S​O​ ​3​1​6​6​-​1​ ​c​o​u​n​t​r​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​s​h​i​p​p​i​n​g​ ​a​d​d​r​e​s​s​. */ longDesc: string } - } - } - response_updated: { - /** - * R​e​s​p​o​n​s​e​ ​U​p​d​a​t​e​d - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​ ​i​s​ ​u​p​d​a​t​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​ ​i​s​ ​m​o​d​i​f​i​e​d​ ​o​r​ ​u​p​d​a​t​e​d​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​t​r​a​c​k​i​n​g​ ​p​a​r​t​i​a​l​ ​r​e​s​p​o​n​s​e​s​ ​o​r​ ​r​e​s​p​o​n​s​e​ ​e​d​i​t​s​. - */ - longDesc: string - options: { - survey_id: { + platform_fees: { /** - * S​u​r​v​e​y + * P​l​a​t​f​o​r​m​ ​F​e​e​s */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​u​p​d​a​t​e​d​ ​r​e​s​p​o​n​s​e​s + * F​e​e​s​ ​c​o​l​l​e​c​t​e​d​ ​b​y​ ​t​h​e​ ​p​l​a​t​f​o​r​m */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​u​p​d​a​t​e​d​ ​r​e​s​p​o​n​s​e​s + * A​r​r​a​y​ ​o​f​ ​p​l​a​t​f​o​r​m​ ​f​e​e​s​ ​t​o​ ​b​e​ ​c​o​l​l​e​c​t​e​d​ ​o​n​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​.​ ​U​s​e​d​ ​b​y​ ​m​a​r​k​e​t​p​l​a​c​e​s​ ​t​o​ ​c​o​l​l​e​c​t​ ​f​e​e​s​ ​f​r​o​m​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​p​r​o​c​e​s​s​e​d​ ​o​n​ ​t​h​e​i​r​ ​p​l​a​t​f​o​r​m​. */ longDesc: string + type: { + element_type: { + fields: { + fee_amount: { + /** + * F​e​e​ ​A​m​o​u​n​t + */ + displayName: string + /** + * P​l​a​t​f​o​r​m​ ​f​e​e​ ​a​m​o​u​n​t + */ + shortDesc: string + /** + * T​h​e​ ​a​m​o​u​n​t​ ​o​f​ ​t​h​e​ ​p​l​a​t​f​o​r​m​ ​f​e​e​ ​t​o​ ​b​e​ ​c​o​l​l​e​c​t​e​d​ ​f​r​o​m​ ​t​h​i​s​ ​t​r​a​n​s​a​c​t​i​o​n​. + */ + longDesc: string + } + payee_email: { + /** + * F​e​e​ ​R​e​c​i​p​i​e​n​t​ ​E​m​a​i​l + */ + displayName: string + /** + * E​m​a​i​l​ ​o​f​ ​f​e​e​ ​r​e​c​i​p​i​e​n​t + */ + shortDesc: string + /** + * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​l​a​t​f​o​r​m​ ​f​e​e​. + */ + longDesc: string + } + payee_merchant_id: { + /** + * F​e​e​ ​R​e​c​i​p​i​e​n​t​ ​M​e​r​c​h​a​n​t​ ​I​D + */ + displayName: string + /** + * M​e​r​c​h​a​n​t​ ​I​D​ ​o​f​ ​f​e​e​ ​r​e​c​i​p​i​e​n​t + */ + shortDesc: string + /** + * P​a​y​P​a​l​ ​m​e​r​c​h​a​n​t​ ​I​D​ ​o​f​ ​t​h​e​ ​a​c​c​o​u​n​t​ ​t​h​a​t​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​p​l​a​t​f​o​r​m​ ​f​e​e​. + */ + longDesc: string + } + } + } + } } - } - } - collector_updated: { - /** - * C​o​l​l​e​c​t​o​r​ ​U​p​d​a​t​e​d - */ - displayName: string - /** - * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​i​s​ ​u​p​d​a​t​e​d - */ - shortDesc: string - /** - * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​(​d​i​s​t​r​i​b​u​t​i​o​n​ ​m​e​t​h​o​d​)​ ​f​o​r​ ​a​ ​s​u​r​v​e​y​ ​i​s​ ​m​o​d​i​f​i​e​d​,​ ​s​u​c​h​ ​a​s​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​ ​o​r​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​u​p​d​a​t​e​s​. - */ - longDesc: string - options: { - survey_id: { + disbursement_mode: { /** - * S​u​r​v​e​y + * D​i​s​b​u​r​s​e​m​e​n​t​ ​M​o​d​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​l​l​e​c​t​o​r​ ​u​p​d​a​t​e​s + * W​h​e​n​ ​t​o​ ​r​e​l​e​a​s​e​ ​f​u​n​d​s​ ​t​o​ ​t​h​e​ ​s​e​l​l​e​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​l​l​e​c​t​o​r​ ​c​h​a​n​g​e​s + * C​o​n​t​r​o​l​s​ ​w​h​e​n​ ​c​a​p​t​u​r​e​d​ ​f​u​n​d​s​ ​a​r​e​ ​r​e​l​e​a​s​e​d​ ​t​o​ ​t​h​e​ ​s​e​l​l​e​r​.​ ​I​N​S​T​A​N​T​ ​r​e​l​e​a​s​e​s​ ​f​u​n​d​s​ ​i​m​m​e​d​i​a​t​e​l​y​,​ ​w​h​i​l​e​ ​D​E​L​A​Y​E​D​ ​a​l​l​o​w​s​ ​y​o​u​ ​t​o​ ​h​o​l​d​ ​f​u​n​d​s​ ​f​o​r​ ​v​e​r​i​f​i​c​a​t​i​o​n​ ​b​e​f​o​r​e​ ​r​e​l​e​a​s​e​. + */ + longDesc: string + } + return_url: { + /** + * R​e​t​u​r​n​ ​U​R​L + */ + displayName: string + /** + * U​R​L​ ​t​o​ ​r​e​d​i​r​e​c​t​ ​a​f​t​e​r​ ​s​u​c​c​e​s​s​f​u​l​ ​p​a​y​m​e​n​t + */ + shortDesc: string + /** + * T​h​e​ ​U​R​L​ ​w​h​e​r​e​ ​c​u​s​t​o​m​e​r​s​ ​w​i​l​l​ ​b​e​ ​r​e​d​i​r​e​c​t​e​d​ ​a​f​t​e​r​ ​s​u​c​c​e​s​s​f​u​l​l​y​ ​c​o​m​p​l​e​t​i​n​g​ ​t​h​e​i​r​ ​p​a​y​m​e​n​t​.​ ​S​h​o​u​l​d​ ​b​e​ ​a​ ​p​a​g​e​ ​c​o​n​f​i​r​m​i​n​g​ ​t​h​e​ ​s​u​c​c​e​s​s​f​u​l​ ​t​r​a​n​s​a​c​t​i​o​n​. + */ + longDesc: string + } + cancel_url: { + /** + * C​a​n​c​e​l​ ​U​R​L + */ + displayName: string + /** + * U​R​L​ ​t​o​ ​r​e​d​i​r​e​c​t​ ​i​f​ ​p​a​y​m​e​n​t​ ​i​s​ ​c​a​n​c​e​l​l​e​d + */ + shortDesc: string + /** + * T​h​e​ ​U​R​L​ ​w​h​e​r​e​ ​c​u​s​t​o​m​e​r​s​ ​w​i​l​l​ ​b​e​ ​r​e​d​i​r​e​c​t​e​d​ ​i​f​ ​t​h​e​y​ ​c​a​n​c​e​l​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​.​ ​S​h​o​u​l​d​ ​p​r​o​v​i​d​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​c​a​n​c​e​l​l​e​d​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​n​d​ ​n​e​x​t​ ​s​t​e​p​s​. */ longDesc: string } } } - } - actions: { - create_contact: { - groups: { - /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } + capture_order: { /** - * C​r​e​a​t​e​ ​C​o​n​t​a​c​t + * C​a​p​t​u​r​e​ ​O​r​d​e​r */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t + * C​a​p​t​u​r​e​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​a​n​ ​a​p​p​r​o​v​e​d​ ​o​r​d​e​r */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​w​i​t​h​ ​f​i​r​s​t​ ​n​a​m​e​,​ ​l​a​s​t​ ​n​a​m​e​,​ ​e​m​a​i​l​,​ ​o​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * C​a​p​t​u​r​e​s​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​a​n​ ​o​r​d​e​r​ ​t​h​a​t​ ​h​a​s​ ​b​e​e​n​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​c​o​m​p​l​e​t​e​s​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​ ​a​n​d​ ​t​r​a​n​s​f​e​r​s​ ​f​u​n​d​s​ ​f​r​o​m​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​t​o​ ​y​o​u​r​ ​a​c​c​o​u​n​t​.​ ​S​h​o​u​l​d​ ​b​e​ ​c​a​l​l​e​d​ ​a​f​t​e​r​ ​r​e​c​e​i​v​i​n​g​ ​o​r​d​e​r​ ​a​p​p​r​o​v​a​l​ ​o​r​ ​f​o​r​ ​i​m​m​e​d​i​a​t​e​ ​c​a​p​t​u​r​e​ ​o​r​d​e​r​s​. */ longDesc: string options: { - first_name: { + order_id: { /** - * F​i​r​s​t​ ​N​a​m​e + * O​r​d​e​r​ ​I​D */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​f​i​r​s​t​ ​n​a​m​e + * I​D​ ​o​f​ ​t​h​e​ ​a​p​p​r​o​v​e​d​ ​o​r​d​e​r​ ​t​o​ ​c​a​p​t​u​r​e */ shortDesc: string /** - * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​t​h​a​t​ ​h​a​s​ ​b​e​e​n​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​a​n​d​ ​i​s​ ​r​e​a​d​y​ ​f​o​r​ ​p​a​y​m​e​n​t​ ​c​a​p​t​u​r​e​. */ longDesc: string } - last_name: { + final_capture: { /** - * L​a​s​t​ ​N​a​m​e + * F​i​n​a​l​ ​C​a​p​t​u​r​e */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​l​a​s​t​ ​n​a​m​e + * W​h​e​t​h​e​r​ ​t​h​i​s​ ​i​s​ ​t​h​e​ ​f​i​n​a​l​ ​c​a​p​t​u​r​e​ ​f​o​r​ ​t​h​e​ ​o​r​d​e​r */ shortDesc: string /** - * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t + * I​n​d​i​c​a​t​e​s​ ​w​h​e​t​h​e​r​ ​t​h​i​s​ ​c​a​p​t​u​r​e​ ​c​o​m​p​l​e​t​e​s​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​t​h​e​ ​o​r​d​e​r​.​ ​S​e​t​ ​t​o​ ​t​r​u​e​ ​i​f​ ​t​h​i​s​ ​i​s​ ​t​h​e​ ​c​o​m​p​l​e​t​e​ ​a​m​o​u​n​t​,​ ​o​r​ ​f​a​l​s​e​ ​i​f​ ​y​o​u​ ​p​l​a​n​ ​t​o​ ​m​a​k​e​ ​a​d​d​i​t​i​o​n​a​l​ ​p​a​r​t​i​a​l​ ​c​a​p​t​u​r​e​s​. */ longDesc: string } - email: { + payment_instruction: { /** - * E​m​a​i​l + * P​a​y​m​e​n​t​ ​I​n​s​t​r​u​c​t​i​o​n​s */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * A​d​d​i​t​i​o​n​a​l​ ​p​a​y​m​e​n​t​ ​p​r​o​c​e​s​s​i​n​g​ ​i​n​s​t​r​u​c​t​i​o​n​s */ shortDesc: string /** - * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​(​e​i​t​h​e​r​ ​e​m​a​i​l​ ​o​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​i​s​ ​r​e​q​u​i​r​e​d​) + * S​p​e​c​i​a​l​ ​i​n​s​t​r​u​c​t​i​o​n​s​ ​f​o​r​ ​p​r​o​c​e​s​s​i​n​g​ ​t​h​i​s​ ​p​a​y​m​e​n​t​,​ ​s​u​c​h​ ​a​s​ ​d​i​s​b​u​r​s​e​m​e​n​t​ ​t​i​m​i​n​g​ ​o​r​ ​p​l​a​t​f​o​r​m​ ​f​e​e​ ​c​o​l​l​e​c​t​i​o​n​. */ longDesc: string + type: { + fields: { + disbursement_mode: { + /** + * D​i​s​b​u​r​s​e​m​e​n​t​ ​M​o​d​e + */ + displayName: string + /** + * W​h​e​n​ ​t​o​ ​d​i​s​b​u​r​s​e​ ​f​u​n​d​s + */ + shortDesc: string + /** + * C​o​n​t​r​o​l​s​ ​w​h​e​n​ ​c​a​p​t​u​r​e​d​ ​f​u​n​d​s​ ​a​r​e​ ​d​i​s​b​u​r​s​e​d​ ​t​o​ ​t​h​e​ ​p​a​y​e​e​.​ ​U​s​e​ ​I​N​S​T​A​N​T​ ​f​o​r​ ​i​m​m​e​d​i​a​t​e​ ​d​i​s​b​u​r​s​e​m​e​n​t​ ​o​r​ ​D​E​L​A​Y​E​D​ ​t​o​ ​h​o​l​d​ ​f​u​n​d​s​. + */ + longDesc: string + } + } + } } - phone_number: { + } + } + authorize_order: { + /** + * A​u​t​h​o​r​i​z​e​ ​O​r​d​e​r + */ + displayName: string + /** + * A​u​t​h​o​r​i​z​e​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​a​n​ ​a​p​p​r​o​v​e​d​ ​o​r​d​e​r + */ + shortDesc: string + /** + * A​u​t​h​o​r​i​z​e​s​ ​p​a​y​m​e​n​t​ ​f​o​r​ ​a​n​ ​o​r​d​e​r​ ​t​h​a​t​ ​h​a​s​ ​b​e​e​n​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​.​ ​T​h​i​s​ ​p​l​a​c​e​s​ ​a​ ​h​o​l​d​ ​o​n​ ​t​h​e​ ​f​u​n​d​s​ ​w​i​t​h​o​u​t​ ​c​a​p​t​u​r​i​n​g​ ​t​h​e​m​,​ ​a​l​l​o​w​i​n​g​ ​y​o​u​ ​t​o​ ​c​a​p​t​u​r​e​ ​t​h​e​ ​p​a​y​m​e​n​t​ ​l​a​t​e​r​ ​w​h​e​n​ ​r​e​a​d​y​ ​t​o​ ​f​u​l​f​i​l​l​ ​t​h​e​ ​o​r​d​e​r​.​ ​A​u​t​h​o​r​i​z​a​t​i​o​n​ ​i​s​ ​v​a​l​i​d​ ​f​o​r​ ​u​p​ ​t​o​ ​2​9​ ​d​a​y​s​. + */ + longDesc: string + options: { + order_id: { /** - * P​h​o​n​e​ ​N​u​m​b​e​r + * O​r​d​e​r​ ​I​D */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * I​D​ ​o​f​ ​t​h​e​ ​a​p​p​r​o​v​e​d​ ​o​r​d​e​r​ ​t​o​ ​a​u​t​h​o​r​i​z​e */ shortDesc: string /** - * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​(​e​i​t​h​e​r​ ​e​m​a​i​l​ ​o​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​i​s​ ​r​e​q​u​i​r​e​d​) + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​t​h​a​t​ ​h​a​s​ ​b​e​e​n​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​a​n​d​ ​i​s​ ​r​e​a​d​y​ ​f​o​r​ ​p​a​y​m​e​n​t​ ​a​u​t​h​o​r​i​z​a​t​i​o​n​. */ longDesc: string } } } - list_contacts: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + get_order: { /** - * L​i​s​t​ ​C​o​n​t​a​c​t​s + * G​e​t​ ​O​r​d​e​r */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​s + * R​e​t​r​i​e​v​e​ ​o​r​d​e​r​ ​d​e​t​a​i​l​s​ ​b​y​ ​I​D */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​S​u​r​v​e​y​M​o​n​k​e​y + * R​e​t​r​i​e​v​e​s​ ​c​o​m​p​l​e​t​e​ ​d​e​t​a​i​l​s​ ​f​o​r​ ​a​n​ ​o​r​d​e​r​ ​b​y​ ​i​t​s​ ​I​D​,​ ​i​n​c​l​u​d​i​n​g​ ​c​u​r​r​e​n​t​ ​s​t​a​t​u​s​,​ ​p​a​y​m​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​c​u​s​t​o​m​e​r​ ​d​e​t​a​i​l​s​,​ ​a​n​d​ ​t​r​a​n​s​a​c​t​i​o​n​ ​h​i​s​t​o​r​y​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​c​h​e​c​k​ ​o​r​d​e​r​ ​s​t​a​t​u​s​ ​o​r​ ​r​e​t​r​i​e​v​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​o​r​d​e​r​ ​m​a​n​a​g​e​m​e​n​t​. */ longDesc: string options: { - page: { + order_id: { /** - * P​a​g​e + * O​r​d​e​r​ ​I​D */ displayName: string /** - * P​a​g​e​ ​n​u​m​b​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * T​h​e​ ​p​a​g​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​(​s​t​a​r​t​s​ ​a​t​ ​1​) + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​o​r​d​e​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. */ longDesc: string } - per_page: { + } + } + list_transactions: { + /** + * L​i​s​t​ ​T​r​a​n​s​a​c​t​i​o​n​s + */ + displayName: string + /** + * G​e​t​ ​t​r​a​n​s​a​c​t​i​o​n​ ​h​i​s​t​o​r​y​ ​f​o​r​ ​y​o​u​r​ ​a​c​c​o​u​n​t + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​f​o​r​ ​y​o​u​r​ ​P​a​y​P​a​l​ ​a​c​c​o​u​n​t​ ​w​i​t​h​i​n​ ​a​ ​s​p​e​c​i​f​i​e​d​ ​d​a​t​e​ ​r​a​n​g​e​.​ ​S​u​p​p​o​r​t​s​ ​f​i​l​t​e​r​i​n​g​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​t​y​p​e​,​ ​s​t​a​t​u​s​,​ ​a​m​o​u​n​t​ ​r​a​n​g​e​,​ ​c​u​r​r​e​n​c​y​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​ ​t​o​ ​h​e​l​p​ ​y​o​u​ ​f​i​n​d​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​o​r​ ​g​e​n​e​r​a​t​e​ ​r​e​p​o​r​t​s​. + */ + longDesc: string + options: { + start_date: { /** - * P​e​r​ ​P​a​g​e + * S​t​a​r​t​ ​D​a​t​e */ displayName: string /** - * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​p​e​r​ ​p​a​g​e + * B​e​g​i​n​n​i​n​g​ ​d​a​t​e​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​e​a​r​c​h */ shortDesc: string /** - * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​1​0​0​) + * T​h​e​ ​e​a​r​l​i​e​s​t​ ​d​a​t​e​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​e​a​r​c​h​.​ ​T​r​a​n​s​a​c​t​i​o​n​s​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​w​i​l​l​ ​b​e​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string } - limit: { + end_date: { /** - * L​i​m​i​t + * E​n​d​ ​D​a​t​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n + * E​n​d​i​n​g​ ​d​a​t​e​ ​f​o​r​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​e​a​r​c​h */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​a​c​r​o​s​s​ ​a​l​l​ ​p​a​g​e​s​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) + * T​h​e​ ​l​a​t​e​s​t​ ​d​a​t​e​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​t​h​e​ ​t​r​a​n​s​a​c​t​i​o​n​ ​s​e​a​r​c​h​.​ ​T​r​a​n​s​a​c​t​i​o​n​s​ ​o​n​ ​o​r​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​w​i​l​l​ ​b​e​ ​i​n​c​l​u​d​e​d​ ​i​n​ ​t​h​e​ ​r​e​s​u​l​t​s​. */ longDesc: string } - } - } - create_collector: { - groups: { - /** - * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - /** - * C​r​e​a​t​e​ ​C​o​l​l​e​c​t​o​r - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​o​r​ ​a​ ​s​u​r​v​e​y - */ - shortDesc: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​l​l​e​c​t​o​r​ ​(​d​i​s​t​r​i​b​u​t​i​o​n​ ​m​e​t​h​o​d​)​ ​f​o​r​ ​a​ ​s​u​r​v​e​y​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y - */ - longDesc: string - options: { - survey_id: { + transaction_type: { /** - * S​u​r​v​e​y + * T​r​a​n​s​a​c​t​i​o​n​ ​T​y​p​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​o​r + * T​y​p​e​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​r​e​t​r​i​e​v​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​o​r + * F​i​l​t​e​r​ ​r​e​s​u​l​t​s​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​t​y​p​e​s​ ​s​u​c​h​ ​a​s​ ​p​a​y​m​e​n​t​s​,​ ​r​e​f​u​n​d​s​,​ ​f​e​e​s​,​ ​o​r​ ​o​t​h​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​ ​c​a​t​e​g​o​r​i​e​s​. */ longDesc: string } - type: { + transaction_status: { /** - * C​o​l​l​e​c​t​o​r​ ​T​y​p​e + * T​r​a​n​s​a​c​t​i​o​n​ ​S​t​a​t​u​s */ displayName: string /** - * T​h​e​ ​t​y​p​e​ ​o​f​ ​c​o​l​l​e​c​t​o​r + * S​t​a​t​u​s​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​i​n​c​l​u​d​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​t​y​p​e​ ​o​f​ ​c​o​l​l​e​c​t​o​r​ ​(​e​m​a​i​l​,​ ​w​e​b​l​i​n​k​,​ ​f​a​c​e​b​o​o​k​,​ ​o​r​ ​e​m​b​e​d​) + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​ ​t​h​e​i​r​ ​p​r​o​c​e​s​s​i​n​g​ ​s​t​a​t​u​s​ ​s​u​c​h​ ​a​s​ ​S​u​c​c​e​s​s​,​ ​P​e​n​d​i​n​g​,​ ​D​e​n​i​e​d​,​ ​o​r​ ​R​e​f​u​n​d​e​d​. */ longDesc: string } - name: { + transaction_amount: { /** - * C​o​l​l​e​c​t​o​r​ ​N​a​m​e + * T​r​a​n​s​a​c​t​i​o​n​ ​A​m​o​u​n​t​ ​R​a​n​g​e */ displayName: string /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * F​i​l​t​e​r​ ​b​y​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t​ ​r​a​n​g​e */ shortDesc: string /** - * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * S​p​e​c​i​f​y​ ​a​ ​r​a​n​g​e​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t​s​ ​t​o​ ​f​i​l​t​e​r​ ​r​e​s​u​l​t​s​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​f​i​n​d​i​n​g​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​w​i​t​h​i​n​ ​s​p​e​c​i​f​i​c​ ​v​a​l​u​e​ ​r​a​n​g​e​s​. */ longDesc: string + type: { + fields: { + from: { + /** + * M​i​n​i​m​u​m​ ​A​m​o​u​n​t + */ + displayName: string + /** + * M​i​n​i​m​u​m​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t + */ + shortDesc: string + /** + * T​h​e​ ​m​i​n​i​m​u​m​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​r​e​s​u​l​t​s​. + */ + longDesc: string + } + to: { + /** + * M​a​x​i​m​u​m​ ​A​m​o​u​n​t + */ + displayName: string + /** + * M​a​x​i​m​u​m​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t + */ + shortDesc: string + /** + * T​h​e​ ​m​a​x​i​m​u​m​ ​t​r​a​n​s​a​c​t​i​o​n​ ​a​m​o​u​n​t​ ​t​o​ ​i​n​c​l​u​d​e​ ​i​n​ ​r​e​s​u​l​t​s​. + */ + longDesc: string + } + } + } } - } - } - list_collectors: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * L​i​s​t​ ​C​o​l​l​e​c​t​o​r​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​c​o​l​l​e​c​t​o​r​s​ ​f​o​r​ ​a​ ​s​u​r​v​e​y - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​l​l​e​c​t​o​r​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y - */ - longDesc: string - options: { - survey_id: { + transaction_currency: { /** - * S​u​r​v​e​y + * T​r​a​n​s​a​c​t​i​o​n​ ​C​u​r​r​e​n​c​y */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​l​i​s​t​ ​c​o​l​l​e​c​t​o​r​s​ ​f​o​r + * F​i​l​t​e​r​ ​b​y​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​c​o​l​l​e​c​t​o​r​s​ ​f​r​o​m + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​t​o​ ​s​e​e​ ​o​n​l​y​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​i​n​ ​s​p​e​c​i​f​i​c​ ​c​u​r​r​e​n​c​i​e​s​. */ longDesc: string } - limit: { + payment_instrument_type: { /** - * L​i​m​i​t + * P​a​y​m​e​n​t​ ​M​e​t​h​o​d​ ​T​y​p​e */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​l​l​e​c​t​o​r​s​ ​t​o​ ​r​e​t​u​r​n + * F​i​l​t​e​r​ ​b​y​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​ ​u​s​e​d */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​l​l​e​c​t​o​r​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) + * F​i​l​t​e​r​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​b​y​ ​t​h​e​ ​t​y​p​e​ ​o​f​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​ ​u​s​e​d​,​ ​s​u​c​h​ ​a​s​ ​c​r​e​d​i​t​ ​c​a​r​d​,​ ​d​e​b​i​t​ ​c​a​r​d​,​ ​o​r​ ​b​a​n​k​ ​a​c​c​o​u​n​t​. */ longDesc: string } - } - } - list_responses: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * L​i​s​t​ ​R​e​s​p​o​n​s​e​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y - */ - longDesc: string - options: { - survey_id: { + page_size: { /** - * S​u​r​v​e​y + * P​a​g​e​ ​S​i​z​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​l​i​s​t​ ​r​e​s​p​o​n​s​e​s​ ​f​o​r + * N​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​r​e​s​p​o​n​s​e​s​ ​f​r​o​m + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​t​r​a​n​s​a​c​t​i​o​n​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​a​ ​s​i​n​g​l​e​ ​r​e​s​p​o​n​s​e​.​ ​U​s​e​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​o​f​ ​l​a​r​g​e​ ​r​e​s​u​l​t​ ​s​e​t​s​. */ longDesc: string } - limit: { + page: { /** - * L​i​m​i​t + * P​a​g​e​ ​N​u​m​b​e​r */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​t​o​ ​r​e​t​u​r​n + * P​a​g​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) + * T​h​e​ ​p​a​g​e​ ​n​u​m​b​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​w​h​e​n​ ​p​a​g​i​n​a​t​i​n​g​ ​t​h​r​o​u​g​h​ ​l​a​r​g​e​ ​r​e​s​u​l​t​ ​s​e​t​s​. */ longDesc: string } } } - get_response: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + refund_payment: { /** - * G​e​t​ ​R​e​s​p​o​n​s​e + * R​e​f​u​n​d​ ​P​a​y​m​e​n​t */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e + * P​r​o​c​e​s​s​ ​a​ ​r​e​f​u​n​d​ ​f​o​r​ ​a​ ​c​a​p​t​u​r​e​d​ ​p​a​y​m​e​n​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​,​ ​o​p​t​i​o​n​a​l​l​y​ ​i​n​c​l​u​d​i​n​g​ ​f​u​l​l​ ​a​n​s​w​e​r​ ​d​e​t​a​i​l​s + * I​s​s​u​e​s​ ​a​ ​r​e​f​u​n​d​ ​f​o​r​ ​a​ ​p​r​e​v​i​o​u​s​l​y​ ​c​a​p​t​u​r​e​d​ ​p​a​y​m​e​n​t​.​ ​C​a​n​ ​p​r​o​c​e​s​s​ ​f​u​l​l​ ​o​r​ ​p​a​r​t​i​a​l​ ​r​e​f​u​n​d​s​.​ ​T​h​e​ ​r​e​f​u​n​d​e​d​ ​a​m​o​u​n​t​ ​w​i​l​l​ ​b​e​ ​r​e​t​u​r​n​e​d​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​'​s​ ​o​r​i​g​i​n​a​l​ ​p​a​y​m​e​n​t​ ​m​e​t​h​o​d​ ​a​n​d​ ​d​e​d​u​c​t​e​d​ ​f​r​o​m​ ​y​o​u​r​ ​a​c​c​o​u​n​t​ ​b​a​l​a​n​c​e​. */ longDesc: string options: { - survey_id: { + capture_id: { /** - * S​u​r​v​e​y + * C​a​p​t​u​r​e​ ​I​D */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​r​e​s​p​o​n​s​e + * I​D​ ​o​f​ ​t​h​e​ ​c​a​p​t​u​r​e​d​ ​p​a​y​m​e​n​t​ ​t​o​ ​r​e​f​u​n​d */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​r​e​s​p​o​n​s​e + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​a​p​t​u​r​e​d​ ​p​a​y​m​e​n​t​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​f​u​n​d​.​ ​T​h​i​s​ ​c​a​n​ ​b​e​ ​f​o​u​n​d​ ​i​n​ ​t​h​e​ ​c​a​p​t​u​r​e​ ​r​e​s​p​o​n​s​e​ ​o​r​ ​o​r​d​e​r​ ​d​e​t​a​i​l​s​. */ longDesc: string } - response_id: { + amount: { /** - * R​e​s​p​o​n​s​e​ ​I​D + * R​e​f​u​n​d​ ​A​m​o​u​n​t */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​r​e​s​p​o​n​s​e​ ​t​o​ ​r​e​t​r​i​e​v​e + * A​m​o​u​n​t​ ​t​o​ ​r​e​f​u​n​d​ ​(​o​p​t​i​o​n​a​l​ ​f​o​r​ ​f​u​l​l​ ​r​e​f​u​n​d​) */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​s​p​o​n​s​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e + * T​h​e​ ​a​m​o​u​n​t​ ​t​o​ ​r​e​f​u​n​d​.​ ​I​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​,​ ​t​h​e​ ​f​u​l​l​ ​c​a​p​t​u​r​e​d​ ​a​m​o​u​n​t​ ​w​i​l​l​ ​b​e​ ​r​e​f​u​n​d​e​d​.​ ​F​o​r​ ​p​a​r​t​i​a​l​ ​r​e​f​u​n​d​s​,​ ​s​p​e​c​i​f​y​ ​t​h​e​ ​c​u​r​r​e​n​c​y​ ​a​n​d​ ​a​m​o​u​n​t​. */ longDesc: string + type: { + fields: { + currency_code: { + /** + * C​u​r​r​e​n​c​y​ ​C​o​d​e + */ + displayName: string + /** + * C​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​r​e​f​u​n​d​ ​a​m​o​u​n​t + */ + shortDesc: string + /** + * T​h​e​ ​t​h​r​e​e​-​c​h​a​r​a​c​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​r​e​f​u​n​d​ ​a​m​o​u​n​t​. + */ + longDesc: string + } + value: { + /** + * R​e​f​u​n​d​ ​V​a​l​u​e + */ + displayName: string + /** + * T​h​e​ ​r​e​f​u​n​d​ ​a​m​o​u​n​t​ ​a​s​ ​a​ ​s​t​r​i​n​g + */ + shortDesc: string + /** + * T​h​e​ ​a​m​o​u​n​t​ ​t​o​ ​r​e​f​u​n​d​,​ ​f​o​r​m​a​t​t​e​d​ ​a​s​ ​a​ ​s​t​r​i​n​g​ ​w​i​t​h​ ​a​p​p​r​o​p​r​i​a​t​e​ ​d​e​c​i​m​a​l​ ​p​r​e​c​i​s​i​o​n​. + */ + longDesc: string + } + } + } } - include_answers: { + note_to_payer: { /** - * I​n​c​l​u​d​e​ ​A​n​s​w​e​r​s + * N​o​t​e​ ​t​o​ ​P​a​y​e​r */ displayName: string /** - * I​n​c​l​u​d​e​ ​d​e​t​a​i​l​e​d​ ​a​n​s​w​e​r​ ​d​a​t​a + * O​p​t​i​o​n​a​l​ ​n​o​t​e​ ​e​x​p​l​a​i​n​i​n​g​ ​t​h​e​ ​r​e​f​u​n​d */ shortDesc: string /** - * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​r​e​t​r​i​e​v​e​s​ ​t​h​e​ ​f​u​l​l​ ​r​e​s​p​o​n​s​e​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​a​l​l​ ​q​u​e​s​t​i​o​n​ ​a​n​s​w​e​r​s + * A​n​ ​o​p​t​i​o​n​a​l​ ​n​o​t​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​ ​t​o​ ​t​h​e​ ​c​u​s​t​o​m​e​r​ ​e​x​p​l​a​i​n​i​n​g​ ​t​h​e​ ​r​e​a​s​o​n​ ​f​o​r​ ​t​h​e​ ​r​e​f​u​n​d​. + */ + longDesc: string + } + invoice_id: { + /** + * I​n​v​o​i​c​e​ ​I​D + */ + displayName: string + /** + * I​n​v​o​i​c​e​ ​I​D​ ​f​o​r​ ​t​h​e​ ​r​e​f​u​n​d + */ + shortDesc: string + /** + * O​p​t​i​o​n​a​l​ ​i​n​v​o​i​c​e​ ​I​D​ ​t​o​ ​a​s​s​o​c​i​a​t​e​ ​w​i​t​h​ ​t​h​i​s​ ​r​e​f​u​n​d​ ​f​o​r​ ​a​c​c​o​u​n​t​i​n​g​ ​a​n​d​ ​t​r​a​c​k​i​n​g​ ​p​u​r​p​o​s​e​s​. */ longDesc: string } } } - get_collector: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } + create_invoice: { /** - * G​e​t​ ​C​o​l​l​e​c​t​o​r + * C​r​e​a​t​e​ ​I​n​v​o​i​c​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​c​o​l​l​e​c​t​o​r​ ​d​e​t​a​i​l​s + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​i​n​v​o​i​c​e​ ​f​o​r​ ​p​a​y​m​e​n​t */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​l​l​e​c​t​o​r + * C​r​e​a​t​e​s​ ​a​ ​n​e​w​ ​i​n​v​o​i​c​e​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​s​e​n​t​ ​t​o​ ​c​u​s​t​o​m​e​r​s​ ​f​o​r​ ​p​a​y​m​e​n​t​.​ ​I​n​c​l​u​d​e​s​ ​i​t​e​m​ ​d​e​t​a​i​l​s​,​ ​p​r​i​c​i​n​g​,​ ​t​a​x​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​t​e​r​m​s​.​ ​I​n​v​o​i​c​e​s​ ​c​a​n​ ​b​e​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​s​e​n​t​ ​t​o​ ​r​e​c​i​p​i​e​n​t​s​ ​o​r​ ​m​a​n​u​a​l​l​y​ ​s​h​a​r​e​d​. */ longDesc: string options: { - survey_id: { + invoice_number: { /** - * S​u​r​v​e​y + * I​n​v​o​i​c​e​ ​N​u​m​b​e​r */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * U​n​i​q​u​e​ ​i​n​v​o​i​c​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​r​a​c​k​i​n​g */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * A​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​f​o​r​ ​t​h​i​s​ ​i​n​v​o​i​c​e​.​ ​I​f​ ​n​o​t​ ​p​r​o​v​i​d​e​d​,​ ​P​a​y​P​a​l​ ​w​i​l​l​ ​g​e​n​e​r​a​t​e​ ​o​n​e​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​. */ longDesc: string } - collector_id: { + currency_code: { /** - * C​o​l​l​e​c​t​o​r + * C​u​r​r​e​n​c​y​ ​C​o​d​e */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​r​e​t​r​i​e​v​e + * C​u​r​r​e​n​c​y​ ​f​o​r​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​a​m​o​u​n​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * T​h​e​ ​t​h​r​e​e​-​c​h​a​r​a​c​t​e​r​ ​I​S​O​ ​c​u​r​r​e​n​c​y​ ​c​o​d​e​ ​f​o​r​ ​t​h​i​s​ ​i​n​v​o​i​c​e​. */ longDesc: string } - } - } - get_survey: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * G​e​t​ ​S​u​r​v​e​y - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​s​u​r​v​e​y​ ​d​e​t​a​i​l​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​i​n​c​l​u​d​i​n​g​ ​p​a​g​e​s​ ​a​n​d​ ​q​u​e​s​t​i​o​n​s - */ - longDesc: string - options: { - survey_id: { + note: { /** - * S​u​r​v​e​y + * N​o​t​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​r​e​t​r​i​e​v​e + * N​o​t​e​ ​o​r​ ​m​e​m​o​ ​f​o​r​ ​t​h​e​ ​i​n​v​o​i​c​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r + * O​p​t​i​o​n​a​l​ ​n​o​t​e​ ​o​r​ ​m​e​m​o​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​i​n​v​o​i​c​e​.​ ​V​i​s​i​b​l​e​ ​t​o​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​. */ longDesc: string } - } - } - list_surveys: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string - } - /** - * L​i​s​t​ ​S​u​r​v​e​y​s - */ - displayName: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​s​u​r​v​e​y​s - */ - shortDesc: string - /** - * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​s​u​r​v​e​y​s​ ​i​n​ ​y​o​u​r​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​a​c​c​o​u​n​t - */ - longDesc: string - options: { - limit: { + recipient_email: { /** - * L​i​m​i​t + * R​e​c​i​p​i​e​n​t​ ​E​m​a​i​l */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​r​v​e​y​s​ ​t​o​ ​r​e​t​u​r​n + * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​r​e​c​i​p​i​e​n​t */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​r​v​e​y​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​w​h​e​r​e​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​w​i​l​l​ ​b​e​ ​s​e​n​t​.​ ​T​h​i​s​ ​i​s​ ​t​h​e​ ​p​r​i​m​a​r​y​ ​r​e​c​i​p​i​e​n​t​ ​w​h​o​ ​w​i​l​l​ ​r​e​c​e​i​v​e​ ​p​a​y​m​e​n​t​ ​r​e​q​u​e​s​t​s​. */ longDesc: string } - } - } - send_survey: { - groups: { - /** - * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - /** - * S​e​n​d​ ​S​u​r​v​e​y - */ - displayName: string - /** - * S​e​n​d​ ​s​u​r​v​e​y​ ​i​n​v​i​t​a​t​i​o​n​ ​v​i​a​ ​c​o​l​l​e​c​t​o​r - */ - shortDesc: string - /** - * S​e​n​d​ ​a​ ​s​u​r​v​e​y​ ​i​n​v​i​t​a​t​i​o​n​ ​t​o​ ​r​e​c​i​p​i​e​n​t​s​ ​v​i​a​ ​a​n​ ​e​m​a​i​l​ ​c​o​l​l​e​c​t​o​r - */ - longDesc: string - options: { - survey_id: { + recipient_first_name: { /** - * S​u​r​v​e​y + * R​e​c​i​p​i​e​n​t​ ​F​i​r​s​t​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​s​e​n​d + * F​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​r​e​c​i​p​i​e​n​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d + * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​e​r​s​o​n​ ​o​r​ ​b​u​s​i​n​e​s​s​ ​c​o​n​t​a​c​t​ ​r​e​c​e​i​v​i​n​g​ ​t​h​e​ ​i​n​v​o​i​c​e​. */ longDesc: string } - collector_id: { + recipient_last_name: { /** - * C​o​l​l​e​c​t​o​r + * R​e​c​i​p​i​e​n​t​ ​L​a​s​t​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​e​m​a​i​l​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​u​s​e + * L​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​r​e​c​i​p​i​e​n​t */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​e​m​a​i​l​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​r​o​u​g​h + * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​p​e​r​s​o​n​ ​r​e​c​e​i​v​i​n​g​ ​t​h​e​ ​i​n​v​o​i​c​e​. */ longDesc: string } - subject: { + item_name: { /** - * E​m​a​i​l​ ​S​u​b​j​e​c​t + * I​t​e​m​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​s​u​b​j​e​c​t​ ​l​i​n​e​ ​f​o​r​ ​t​h​e​ ​i​n​v​i​t​a​t​i​o​n​ ​e​m​a​i​l + * N​a​m​e​ ​o​f​ ​t​h​e​ ​i​t​e​m​ ​o​r​ ​s​e​r​v​i​c​e */ shortDesc: string /** - * T​h​e​ ​s​u​b​j​e​c​t​ ​l​i​n​e​ ​t​h​a​t​ ​w​i​l​l​ ​a​p​p​e​a​r​ ​i​n​ ​t​h​e​ ​i​n​v​i​t​a​t​i​o​n​ ​e​m​a​i​l + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​o​r​ ​s​e​r​v​i​c​e​ ​b​e​i​n​g​ ​i​n​v​o​i​c​e​d​. */ longDesc: string } - body_text: { + item_description: { /** - * E​m​a​i​l​ ​B​o​d​y + * I​t​e​m​ ​D​e​s​c​r​i​p​t​i​o​n */ displayName: string /** - * T​h​e​ ​b​o​d​y​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​i​n​v​i​t​a​t​i​o​n​ ​e​m​a​i​l + * D​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * T​h​e​ ​m​e​s​s​a​g​e​ ​b​o​d​y​ ​t​h​a​t​ ​w​i​l​l​ ​a​p​p​e​a​r​ ​i​n​ ​t​h​e​ ​i​n​v​i​t​a​t​i​o​n​ ​e​m​a​i​l + * O​p​t​i​o​n​a​l​ ​d​e​t​a​i​l​e​d​ ​d​e​s​c​r​i​p​t​i​o​n​ ​p​r​o​v​i​d​i​n​g​ ​m​o​r​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​t​h​e​ ​p​r​o​d​u​c​t​ ​o​r​ ​s​e​r​v​i​c​e​. */ longDesc: string } - recipient_emails: { + item_quantity: { /** - * R​e​c​i​p​i​e​n​t​ ​E​m​a​i​l​s + * I​t​e​m​ ​Q​u​a​n​t​i​t​y */ displayName: string /** - * L​i​s​t​ ​o​f​ ​r​e​c​i​p​i​e​n​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s + * N​u​m​b​e​r​ ​o​f​ ​i​t​e​m​s​ ​o​r​ ​u​n​i​t​s */ shortDesc: string /** - * A​ ​l​i​s​t​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​s​u​r​v​e​y​ ​i​n​v​i​t​a​t​i​o​n​ ​t​o + * T​h​e​ ​q​u​a​n​t​i​t​y​ ​o​f​ ​t​h​e​ ​i​t​e​m​ ​b​e​i​n​g​ ​i​n​v​o​i​c​e​d​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​1​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. */ longDesc: string } - } - } - create_survey: { - groups: { - /** - * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } - /** - * C​r​e​a​t​e​ ​S​u​r​v​e​y - */ - displayName: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​u​r​v​e​y - */ - shortDesc: string - /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​u​r​v​e​y​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​f​r​o​m​ ​s​c​r​a​t​c​h​ ​o​r​ ​f​r​o​m​ ​a​ ​t​e​m​p​l​a​t​e - */ - longDesc: string - options: { - title: { + item_unit_price: { /** - * T​i​t​l​e + * U​n​i​t​ ​P​r​i​c​e */ displayName: string /** - * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​s​u​r​v​e​y + * P​r​i​c​e​ ​p​e​r​ ​u​n​i​t​ ​o​f​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * T​h​e​ ​t​i​t​l​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​d​i​s​p​l​a​y​e​d​ ​f​o​r​ ​t​h​e​ ​s​u​r​v​e​y + * T​h​e​ ​c​o​s​t​ ​p​e​r​ ​i​n​d​i​v​i​d​u​a​l​ ​u​n​i​t​ ​o​f​ ​t​h​e​ ​i​t​e​m​ ​o​r​ ​s​e​r​v​i​c​e​. */ longDesc: string } - nickname: { + tax_percent: { /** - * N​i​c​k​n​a​m​e + * T​a​x​ ​P​e​r​c​e​n​t​a​g​e */ displayName: string /** - * I​n​t​e​r​n​a​l​ ​n​i​c​k​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​s​u​r​v​e​y + * T​a​x​ ​r​a​t​e​ ​t​o​ ​a​p​p​l​y​ ​t​o​ ​t​h​e​ ​i​t​e​m */ shortDesc: string /** - * A​n​ ​o​p​t​i​o​n​a​l​ ​i​n​t​e​r​n​a​l​ ​n​i​c​k​n​a​m​e​ ​t​o​ ​h​e​l​p​ ​i​d​e​n​t​i​f​y​ ​t​h​e​ ​s​u​r​v​e​y + * T​h​e​ ​t​a​x​ ​r​a​t​e​ ​a​s​ ​a​ ​p​e​r​c​e​n​t​a​g​e​ ​t​o​ ​b​e​ ​a​p​p​l​i​e​d​ ​t​o​ ​t​h​e​ ​i​t​e​m​ ​a​m​o​u​n​t​. */ longDesc: string } - language: { + tax_name: { /** - * L​a​n​g​u​a​g​e + * T​a​x​ ​N​a​m​e */ displayName: string /** - * T​h​e​ ​l​a​n​g​u​a​g​e​ ​o​f​ ​t​h​e​ ​s​u​r​v​e​y + * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​t​a​x​ ​(​e​.​g​.​,​ ​"​S​a​l​e​s​ ​T​a​x​"​) */ shortDesc: string /** - * T​h​e​ ​l​a​n​g​u​a​g​e​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​s​u​r​v​e​y​ ​(​e​.​g​.​,​ ​e​n​,​ ​e​s​,​ ​f​r​)​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​e​n​. + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​t​a​x​ ​b​e​i​n​g​ ​a​p​p​l​i​e​d​,​ ​s​u​c​h​ ​a​s​ ​"​S​a​l​e​s​ ​T​a​x​"​,​ ​"​V​A​T​"​,​ ​o​r​ ​"​G​S​T​"​. */ longDesc: string } - folder_id: { + payment_term: { /** - * F​o​l​d​e​r​ ​I​D + * P​a​y​m​e​n​t​ ​T​e​r​m​s */ displayName: string /** - * T​h​e​ ​f​o​l​d​e​r​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​s​u​r​v​e​y​ ​i​n + * W​h​e​n​ ​p​a​y​m​e​n​t​ ​i​s​ ​d​u​e */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​f​o​l​d​e​r​ ​w​h​e​r​e​ ​t​h​e​ ​s​u​r​v​e​y​ ​s​h​o​u​l​d​ ​b​e​ ​c​r​e​a​t​e​d + * S​p​e​c​i​f​i​e​s​ ​w​h​e​n​ ​p​a​y​m​e​n​t​ ​i​s​ ​d​u​e​ ​f​o​r​ ​t​h​i​s​ ​i​n​v​o​i​c​e​,​ ​s​u​c​h​ ​a​s​ ​i​m​m​e​d​i​a​t​e​l​y​ ​u​p​o​n​ ​r​e​c​e​i​p​t​ ​o​r​ ​w​i​t​h​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​n​u​m​b​e​r​ ​o​f​ ​d​a​y​s​. */ longDesc: string } - from_template_id: { + send_to_recipient: { /** - * T​e​m​p​l​a​t​e​ ​I​D + * S​e​n​d​ ​t​o​ ​R​e​c​i​p​i​e​n​t */ displayName: string /** - * T​e​m​p​l​a​t​e​ ​t​o​ ​c​r​e​a​t​e​ ​s​u​r​v​e​y​ ​f​r​o​m + * A​u​t​o​m​a​t​i​c​a​l​l​y​ ​s​e​n​d​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​v​i​a​ ​e​m​a​i​l */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​a​ ​t​e​m​p​l​a​t​e​ ​t​o​ ​u​s​e​ ​a​s​ ​t​h​e​ ​b​a​s​i​s​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​s​u​r​v​e​y + * I​f​ ​t​r​u​e​,​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​w​i​l​l​ ​b​e​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​s​e​n​t​ ​t​o​ ​t​h​e​ ​r​e​c​i​p​i​e​n​t​'​s​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​.​ ​I​f​ ​f​a​l​s​e​,​ ​y​o​u​ ​c​a​n​ ​s​e​n​d​ ​i​t​ ​m​a​n​u​a​l​l​y​ ​l​a​t​e​r​. */ longDesc: string } } } - copy_survey: { - groups: { - /** - * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string + get_invoice: { + /** + * G​e​t​ ​I​n​v​o​i​c​e + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​i​n​v​o​i​c​e​ ​d​e​t​a​i​l​s​ ​b​y​ ​I​D + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​s​ ​c​o​m​p​l​e​t​e​ ​d​e​t​a​i​l​s​ ​f​o​r​ ​a​n​ ​i​n​v​o​i​c​e​ ​b​y​ ​i​t​s​ ​I​D​,​ ​i​n​c​l​u​d​i​n​g​ ​p​a​y​m​e​n​t​ ​s​t​a​t​u​s​,​ ​r​e​c​i​p​i​e​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​,​ ​l​i​n​e​ ​i​t​e​m​s​,​ ​a​n​d​ ​p​a​y​m​e​n​t​ ​h​i​s​t​o​r​y​. + */ + longDesc: string + options: { + invoice_id: { + /** + * I​n​v​o​i​c​e​ ​I​D + */ + displayName: string + /** + * U​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​t​o​ ​r​e​t​r​i​e​v​e + */ + shortDesc: string + /** + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​f​o​r​. + */ + longDesc: string + } } + } + list_invoices: { /** - * C​o​p​y​ ​S​u​r​v​e​y + * L​i​s​t​ ​I​n​v​o​i​c​e​s */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​c​o​p​y​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​s​u​r​v​e​y + * G​e​t​ ​a​ ​l​i​s​t​ ​o​f​ ​y​o​u​r​ ​i​n​v​o​i​c​e​s */ shortDesc: string /** - * C​l​o​n​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​s​u​r​v​e​y​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​u​r​v​e​y​ ​w​i​t​h​ ​t​h​e​ ​s​a​m​e​ ​s​t​r​u​c​t​u​r​e​ ​a​n​d​ ​q​u​e​s​t​i​o​n​s + * R​e​t​r​i​e​v​e​s​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​i​n​v​o​i​c​e​s​ ​i​n​ ​y​o​u​r​ ​a​c​c​o​u​n​t​.​ ​U​s​e​ ​p​a​g​i​n​a​t​i​o​n​ ​p​a​r​a​m​e​t​e​r​s​ ​t​o​ ​n​a​v​i​g​a​t​e​ ​t​h​r​o​u​g​h​ ​l​a​r​g​e​ ​n​u​m​b​e​r​s​ ​o​f​ ​i​n​v​o​i​c​e​s​. */ longDesc: string options: { - survey_id: { + page: { /** - * S​u​r​v​e​y + * P​a​g​e​ ​N​u​m​b​e​r */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​c​o​p​y + * P​a​g​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​c​o​p​y​ ​o​f + * T​h​e​ ​p​a​g​e​ ​n​u​m​b​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​w​h​e​n​ ​p​a​g​i​n​a​t​i​n​g​ ​t​h​r​o​u​g​h​ ​i​n​v​o​i​c​e​s​. */ longDesc: string } - title: { + page_size: { /** - * T​i​t​l​e + * P​a​g​e​ ​S​i​z​e */ displayName: string /** - * T​h​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​s​u​r​v​e​y + * N​u​m​b​e​r​ ​o​f​ ​i​n​v​o​i​c​e​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * T​h​e​ ​t​i​t​l​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​d​i​s​p​l​a​y​e​d​ ​f​o​r​ ​t​h​e​ ​c​o​p​i​e​d​ ​s​u​r​v​e​y + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​i​n​v​o​i​c​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​a​ ​s​i​n​g​l​e​ ​r​e​s​p​o​n​s​e​. */ longDesc: string } } } - update_collector: { - groups: { - /** - * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } + list_disputes: { /** - * U​p​d​a​t​e​ ​C​o​l​l​e​c​t​o​r + * L​i​s​t​ ​D​i​s​p​u​t​e​s */ displayName: string /** - * U​p​d​a​t​e​ ​c​o​l​l​e​c​t​o​r​ ​s​e​t​t​i​n​g​s + * G​e​t​ ​a​ ​l​i​s​t​ ​o​f​ ​c​u​s​t​o​m​e​r​ ​d​i​s​p​u​t​e​s */ shortDesc: string /** - * M​o​d​i​f​y​ ​t​h​e​ ​s​e​t​t​i​n​g​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​l​l​e​c​t​o​r​ ​s​u​c​h​ ​a​s​ ​s​t​a​t​u​s​,​ ​c​l​o​s​e​ ​d​a​t​e​,​ ​o​r​ ​r​e​d​i​r​e​c​t​ ​U​R​L + * R​e​t​r​i​e​v​e​s​ ​a​ ​l​i​s​t​ ​o​f​ ​c​u​s​t​o​m​e​r​ ​d​i​s​p​u​t​e​s​ ​f​o​r​ ​y​o​u​r​ ​a​c​c​o​u​n​t​.​ ​D​i​s​p​u​t​e​s​ ​o​c​c​u​r​ ​w​h​e​n​ ​c​u​s​t​o​m​e​r​s​ ​c​h​a​l​l​e​n​g​e​ ​t​r​a​n​s​a​c​t​i​o​n​s​,​ ​a​n​d​ ​t​h​i​s​ ​A​P​I​ ​h​e​l​p​s​ ​y​o​u​ ​m​a​n​a​g​e​ ​a​n​d​ ​r​e​s​p​o​n​d​ ​t​o​ ​t​h​e​m​ ​e​f​f​e​c​t​i​v​e​l​y​. */ longDesc: string options: { - survey_id: { + start_time: { /** - * S​u​r​v​e​y + * S​t​a​r​t​ ​T​i​m​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * E​a​r​l​i​e​s​t​ ​d​i​s​p​u​t​e​ ​c​r​e​a​t​i​o​n​ ​t​i​m​e​ ​t​o​ ​i​n​c​l​u​d​e */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * F​i​l​t​e​r​ ​d​i​s​p​u​t​e​s​ ​c​r​e​a​t​e​d​ ​o​n​ ​o​r​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​. */ longDesc: string } - collector_id: { + disputed_transaction_id: { /** - * C​o​l​l​e​c​t​o​r + * D​i​s​p​u​t​e​d​ ​T​r​a​n​s​a​c​t​i​o​n​ ​I​D */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​u​p​d​a​t​e + * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​I​D */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​d​i​f​y + * S​h​o​w​ ​o​n​l​y​ ​d​i​s​p​u​t​e​s​ ​r​e​l​a​t​e​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​t​r​a​n​s​a​c​t​i​o​n​ ​I​D​. */ longDesc: string } - name: { + dispute_states: { /** - * N​a​m​e + * D​i​s​p​u​t​e​ ​S​t​a​t​e​s */ displayName: string /** - * N​e​w​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * F​i​l​t​e​r​ ​b​y​ ​d​i​s​p​u​t​e​ ​s​t​a​t​e​s */ shortDesc: string /** - * A​ ​n​e​w​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * F​i​l​t​e​r​ ​d​i​s​p​u​t​e​s​ ​b​y​ ​t​h​e​i​r​ ​c​u​r​r​e​n​t​ ​s​t​a​t​e​s​,​ ​s​u​c​h​ ​a​s​ ​o​p​e​n​,​ ​u​n​d​e​r​ ​r​e​v​i​e​w​,​ ​o​r​ ​r​e​s​o​l​v​e​d​. */ longDesc: string } - status: { + page_size: { /** - * S​t​a​t​u​s + * P​a​g​e​ ​S​i​z​e */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​o​r​ ​s​t​a​t​u​s + * N​u​m​b​e​r​ ​o​f​ ​d​i​s​p​u​t​e​s​ ​p​e​r​ ​p​a​g​e */ shortDesc: string /** - * S​e​t​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​o​p​e​n​ ​o​r​ ​c​l​o​s​e​d + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​d​i​s​p​u​t​e​s​ ​t​o​ ​r​e​t​u​r​n​ ​i​n​ ​a​ ​s​i​n​g​l​e​ ​r​e​s​p​o​n​s​e​. */ longDesc: string } - close_date: { + next_page_token: { /** - * C​l​o​s​e​ ​D​a​t​e + * N​e​x​t​ ​P​a​g​e​ ​T​o​k​e​n */ displayName: string /** - * W​h​e​n​ ​t​o​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​c​l​o​s​e​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * T​o​k​e​n​ ​f​o​r​ ​r​e​t​r​i​e​v​i​n​g​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e */ shortDesc: string /** - * T​h​e​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​ ​w​h​e​n​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​s​h​o​u​l​d​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​c​l​o​s​e​ ​(​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​) + * T​o​k​e​n​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​n​e​x​t​ ​p​a​g​e​ ​o​f​ ​d​i​s​p​u​t​e​s​. */ longDesc: string } - redirect_url: { + update_time_before: { /** - * R​e​d​i​r​e​c​t​ ​U​R​L + * U​p​d​a​t​e​d​ ​B​e​f​o​r​e */ displayName: string /** - * U​R​L​ ​t​o​ ​r​e​d​i​r​e​c​t​ ​r​e​s​p​o​n​d​e​n​t​s​ ​a​f​t​e​r​ ​c​o​m​p​l​e​t​i​o​n + * I​n​c​l​u​d​e​ ​d​i​s​p​u​t​e​s​ ​u​p​d​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e */ shortDesc: string /** - * T​h​e​ ​U​R​L​ ​w​h​e​r​e​ ​r​e​s​p​o​n​d​e​n​t​s​ ​w​i​l​l​ ​b​e​ ​r​e​d​i​r​e​c​t​e​d​ ​a​f​t​e​r​ ​c​o​m​p​l​e​t​i​n​g​ ​t​h​e​ ​s​u​r​v​e​y + * F​i​l​t​e​r​ ​d​i​s​p​u​t​e​s​ ​t​h​a​t​ ​w​e​r​e​ ​l​a​s​t​ ​u​p​d​a​t​e​d​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​. */ longDesc: string } - response_limit: { + update_time_after: { /** - * R​e​s​p​o​n​s​e​ ​L​i​m​i​t + * U​p​d​a​t​e​d​ ​A​f​t​e​r */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s + * I​n​c​l​u​d​e​ ​d​i​s​p​u​t​e​s​ ​u​p​d​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​t​o​ ​a​c​c​e​p​t​ ​b​e​f​o​r​e​ ​c​l​o​s​i​n​g​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * F​i​l​t​e​r​ ​d​i​s​p​u​t​e​s​ ​t​h​a​t​ ​w​e​r​e​ ​l​a​s​t​ ​u​p​d​a​t​e​d​ ​a​f​t​e​r​ ​t​h​i​s​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​. */ longDesc: string } } } - delete_collector: { - groups: { - /** - * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t - */ - '0': string - } + } + triggers: { + order_trigger: { /** - * D​e​l​e​t​e​ ​C​o​l​l​e​c​t​o​r + * O​r​d​e​r​ ​E​v​e​n​t​s */ displayName: string /** - * D​e​l​e​t​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​r​o​m​ ​a​ ​s​u​r​v​e​y + * R​e​c​e​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​w​h​e​n​ ​o​r​d​e​r​ ​e​v​e​n​t​s​ ​o​c​c​u​r */ shortDesc: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​r​o​m​ ​a​ ​s​u​r​v​e​y​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​-​r​e​l​a​t​e​d​ ​e​v​e​n​t​s​ ​h​a​p​p​e​n​,​ ​s​u​c​h​ ​a​s​ ​w​h​e​n​ ​a​n​ ​o​r​d​e​r​ ​i​s​ ​a​p​p​r​o​v​e​d​ ​b​y​ ​t​h​e​ ​c​u​s​t​o​m​e​r​,​ ​c​o​m​p​l​e​t​e​d​,​ ​o​r​ ​w​h​e​n​ ​p​a​y​m​e​n​t​ ​a​p​p​r​o​v​a​l​ ​i​s​ ​r​e​v​e​r​s​e​d​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​o​r​d​e​r​ ​p​r​o​c​e​s​s​i​n​g​ ​w​o​r​k​f​l​o​w​s​ ​a​n​d​ ​h​a​n​d​l​e​ ​o​r​d​e​r​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​. */ longDesc: string options: { - survey_id: { + event_name: { /** - * S​u​r​v​e​y + * O​r​d​e​r​ ​E​v​e​n​t​ ​T​y​p​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​o​r​d​e​r​ ​e​v​e​n​t​ ​t​o​ ​l​i​s​t​e​n​ ​f​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + * S​e​l​e​c​t​ ​w​h​i​c​h​ ​o​r​d​e​r​ ​e​v​e​n​t​ ​s​h​o​u​l​d​ ​t​r​i​g​g​e​r​ ​t​h​i​s​ ​w​e​b​h​o​o​k​.​ ​E​a​c​h​ ​e​v​e​n​t​ ​r​e​p​r​e​s​e​n​t​s​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​s​t​a​g​e​ ​i​n​ ​t​h​e​ ​o​r​d​e​r​ ​l​i​f​e​c​y​c​l​e​. */ longDesc: string } - collector_id: { + } + } + invoice_trigger: { + /** + * I​n​v​o​i​c​e​ ​E​v​e​n​t​s + */ + displayName: string + /** + * R​e​c​e​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​w​h​e​n​ ​i​n​v​o​i​c​e​ ​e​v​e​n​t​s​ ​o​c​c​u​r + */ + shortDesc: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​i​n​v​o​i​c​e​-​r​e​l​a​t​e​d​ ​e​v​e​n​t​s​ ​h​a​p​p​e​n​,​ ​s​u​c​h​ ​a​s​ ​w​h​e​n​ ​a​n​ ​i​n​v​o​i​c​e​ ​i​s​ ​c​r​e​a​t​e​d​,​ ​p​a​i​d​,​ ​c​a​n​c​e​l​l​e​d​,​ ​r​e​f​u​n​d​e​d​,​ ​o​r​ ​u​p​d​a​t​e​d​.​ ​E​s​s​e​n​t​i​a​l​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​b​i​l​l​i​n​g​ ​w​o​r​k​f​l​o​w​s​ ​a​n​d​ ​k​e​e​p​i​n​g​ ​i​n​v​o​i​c​e​ ​s​t​a​t​u​s​ ​s​y​n​c​h​r​o​n​i​z​e​d​ ​w​i​t​h​ ​y​o​u​r​ ​s​y​s​t​e​m​s​. + */ + longDesc: string + options: { + event_name: { /** - * C​o​l​l​e​c​t​o​r + * I​n​v​o​i​c​e​ ​E​v​e​n​t​ ​T​y​p​e */ displayName: string /** - * T​h​e​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​d​e​l​e​t​e + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​i​n​v​o​i​c​e​ ​e​v​e​n​t​ ​t​o​ ​l​i​s​t​e​n​ ​f​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e + * S​e​l​e​c​t​ ​w​h​i​c​h​ ​i​n​v​o​i​c​e​ ​e​v​e​n​t​ ​s​h​o​u​l​d​ ​t​r​i​g​g​e​r​ ​t​h​i​s​ ​w​e​b​h​o​o​k​.​ ​E​a​c​h​ ​e​v​e​n​t​ ​r​e​p​r​e​s​e​n​t​s​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​s​t​a​g​e​ ​i​n​ ​t​h​e​ ​i​n​v​o​i​c​e​ ​l​i​f​e​c​y​c​l​e​. */ longDesc: string } } } - get_response_counts: { - groups: { - /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l - */ - '0': string + subscription_trigger: { + /** + * S​u​b​s​c​r​i​p​t​i​o​n​ ​E​v​e​n​t​s + */ + displayName: string + /** + * R​e​c​e​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​w​h​e​n​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​e​v​e​n​t​s​ ​o​c​c​u​r + */ + shortDesc: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​s​u​b​s​c​r​i​p​t​i​o​n​-​r​e​l​a​t​e​d​ ​e​v​e​n​t​s​ ​h​a​p​p​e​n​,​ ​i​n​c​l​u​d​i​n​g​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​c​r​e​a​t​i​o​n​,​ ​a​c​t​i​v​a​t​i​o​n​,​ ​u​p​d​a​t​e​s​,​ ​c​a​n​c​e​l​l​a​t​i​o​n​,​ ​e​x​p​i​r​a​t​i​o​n​,​ ​o​r​ ​s​u​s​p​e​n​s​i​o​n​.​ ​C​r​i​t​i​c​a​l​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​r​e​c​u​r​r​i​n​g​ ​b​i​l​l​i​n​g​ ​a​n​d​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​l​i​f​e​c​y​c​l​e​ ​a​u​t​o​m​a​t​i​o​n​. + */ + longDesc: string + options: { + event_name: { + /** + * S​u​b​s​c​r​i​p​t​i​o​n​ ​E​v​e​n​t​ ​T​y​p​e + */ + displayName: string + /** + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​e​v​e​n​t​ ​t​o​ ​l​i​s​t​e​n​ ​f​o​r + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​w​h​i​c​h​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​e​v​e​n​t​ ​s​h​o​u​l​d​ ​t​r​i​g​g​e​r​ ​t​h​i​s​ ​w​e​b​h​o​o​k​.​ ​E​a​c​h​ ​e​v​e​n​t​ ​r​e​p​r​e​s​e​n​t​s​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​s​t​a​g​e​ ​i​n​ ​t​h​e​ ​s​u​b​s​c​r​i​p​t​i​o​n​ ​l​i​f​e​c​y​c​l​e​. + */ + longDesc: string + } } + } + dispute_trigger: { /** - * G​e​t​ ​R​e​s​p​o​n​s​e​ ​C​o​u​n​t​s + * D​i​s​p​u​t​e​ ​E​v​e​n​t​s */ displayName: string /** - * G​e​t​ ​t​o​t​a​l​ ​r​e​s​p​o​n​s​e​ ​c​o​u​n​t​ ​f​o​r​ ​a​ ​s​u​r​v​e​y + * R​e​c​e​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​w​h​e​n​ ​d​i​s​p​u​t​e​ ​e​v​e​n​t​s​ ​o​c​c​u​r */ shortDesc: string /** - * Q​u​i​c​k​l​y​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​f​o​r​ ​a​ ​s​u​r​v​e​y​ ​w​i​t​h​o​u​t​ ​f​e​t​c​h​i​n​g​ ​a​l​l​ ​r​e​s​p​o​n​s​e​ ​d​a​t​a + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​c​u​s​t​o​m​e​r​ ​d​i​s​p​u​t​e​ ​e​v​e​n​t​s​ ​o​c​c​u​r​,​ ​s​u​c​h​ ​a​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​d​i​s​p​u​t​e​ ​i​s​ ​c​r​e​a​t​e​d​,​ ​u​p​d​a​t​e​d​,​ ​o​r​ ​r​e​s​o​l​v​e​d​.​ ​E​s​s​e​n​t​i​a​l​ ​f​o​r​ ​m​a​n​a​g​i​n​g​ ​c​u​s​t​o​m​e​r​ ​s​e​r​v​i​c​e​ ​w​o​r​k​f​l​o​w​s​ ​a​n​d​ ​r​e​s​p​o​n​d​i​n​g​ ​t​o​ ​p​a​y​m​e​n​t​ ​d​i​s​p​u​t​e​s​ ​p​r​o​m​p​t​l​y​. */ longDesc: string options: { - survey_id: { + event_name: { /** - * S​u​r​v​e​y + * D​i​s​p​u​t​e​ ​E​v​e​n​t​ ​T​y​p​e */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​g​e​t​ ​c​o​u​n​t​s​ ​f​o​r + * T​h​e​ ​s​p​e​c​i​f​i​c​ ​d​i​s​p​u​t​e​ ​e​v​e​n​t​ ​t​o​ ​l​i​s​t​e​n​ ​f​o​r */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​r​e​s​p​o​n​s​e​ ​c​o​u​n​t​s​ ​f​o​r + * S​e​l​e​c​t​ ​w​h​i​c​h​ ​d​i​s​p​u​t​e​ ​e​v​e​n​t​ ​s​h​o​u​l​d​ ​t​r​i​g​g​e​r​ ​t​h​i​s​ ​w​e​b​h​o​o​k​.​ ​E​a​c​h​ ​e​v​e​n​t​ ​r​e​p​r​e​s​e​n​t​s​ ​a​ ​d​i​f​f​e​r​e​n​t​ ​s​t​a​g​e​ ​i​n​ ​t​h​e​ ​d​i​s​p​u​t​e​ ​r​e​s​o​l​u​t​i​o​n​ ​p​r​o​c​e​s​s​. */ longDesc: string } } } - update_contact: { + } + } + Pushover: { + /** + * P​u​s​h​o​v​e​r + */ + displayName: string + groups: { + /** + * N​o​t​i​f​i​c​a​t​i​o​n​s​ ​&​ ​A​l​e​r​t​s + */ + '0': string + } + /** + * S​e​n​d​ ​p​u​s​h​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​t​o​ ​m​o​b​i​l​e​ ​d​e​v​i​c​e​s​ ​a​n​d​ ​d​e​s​k​t​o​p​s + */ + shortDesc: string + /** + * P​u​s​h​o​v​e​r​ ​m​a​k​e​s​ ​i​t​ ​e​a​s​y​ ​t​o​ ​g​e​t​ ​r​e​a​l​-​t​i​m​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​o​n​ ​y​o​u​r​ ​A​n​d​r​o​i​d​,​ ​i​P​h​o​n​e​,​ ​i​P​a​d​,​ ​a​n​d​ ​D​e​s​k​t​o​p​.​ ​S​e​n​d​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​f​o​r​ ​u​r​g​e​n​t​ ​a​l​e​r​t​s​,​ ​s​y​s​t​e​m​ ​m​o​n​i​t​o​r​i​n​g​,​ ​o​r​ ​a​n​y​ ​a​u​t​o​m​a​t​e​d​ ​m​e​s​s​a​g​i​n​g​ ​n​e​e​d​s​. + */ + longDesc: string + connectionMessage: { + /** + * C​o​n​n​e​c​t​ ​t​o​ ​P​u​s​h​o​v​e​r + */ + title: string + /** + * T​o​ ​c​o​n​n​e​c​t​ ​y​o​u​r​ ​P​u​s​h​o​v​e​r​ ​a​c​c​o​u​n​t​,​ ​y​o​u​ ​w​i​l​l​ ​n​e​e​d​ ​y​o​u​r​ ​*​*​A​p​p​l​i​c​a​t​i​o​n​ ​A​P​I​ ​T​o​k​e​n​*​*​ ​a​n​d​ ​*​*​U​s​e​r​ ​K​e​y​*​*​.​ + ​ + ​1​.​ ​C​r​e​a​t​e​ ​a​n​ ​a​p​p​l​i​c​a​t​i​o​n​ ​a​t​ ​h​t​t​p​s​:​/​/​p​u​s​h​o​v​e​r​.​n​e​t​/​a​p​p​s​/​b​u​i​l​d​ ​t​o​ ​g​e​t​ ​y​o​u​r​ ​A​P​I​ ​t​o​k​e​n​ + ​2​.​ ​F​i​n​d​ ​y​o​u​r​ ​U​s​e​r​ ​K​e​y​ ​o​n​ ​y​o​u​r​ ​P​u​s​h​o​v​e​r​ ​d​a​s​h​b​o​a​r​d​ ​a​t​ ​h​t​t​p​s​:​/​/​p​u​s​h​o​v​e​r​.​n​e​t​ + ​ + ​B​o​t​h​ ​v​a​l​u​e​s​ ​a​r​e​ ​3​0​-​c​h​a​r​a​c​t​e​r​ ​a​l​p​h​a​n​u​m​e​r​i​c​ ​s​t​r​i​n​g​s​. + */ + content: string + } + actions: { + push_notification: { + /** + * P​u​s​h​ ​N​o​t​i​f​i​c​a​t​i​o​n + */ + displayName: string + /** + * S​e​n​d​ ​a​ ​p​u​s​h​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​t​o​ ​a​ ​u​s​e​r​ ​o​r​ ​g​r​o​u​p + */ + shortDesc: string + /** + * S​e​n​d​ ​a​ ​p​u​s​h​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​w​i​t​h​ ​c​u​s​t​o​m​i​z​a​b​l​e​ ​p​r​i​o​r​i​t​y​,​ ​s​o​u​n​d​,​ ​a​n​d​ ​f​o​r​m​a​t​t​i​n​g​.​ ​S​u​p​p​o​r​t​s​ ​p​r​i​o​r​i​t​i​e​s​ ​f​r​o​m​ ​l​o​w​e​s​t​ ​(​n​o​ ​a​l​e​r​t​)​ ​t​o​ ​h​i​g​h​ ​(​b​y​p​a​s​s​e​s​ ​q​u​i​e​t​ ​h​o​u​r​s​)​. + */ + longDesc: string groups: { /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + * N​o​t​i​f​i​c​a​t​i​o​n​s */ '0': string } + options: { + message: { + /** + * M​e​s​s​a​g​e + */ + displayName: string + /** + * T​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t + */ + shortDesc: string + /** + * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​o​f​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​.​ ​M​a​x​i​m​u​m​ ​1​0​2​4​ ​c​h​a​r​a​c​t​e​r​s​. + */ + longDesc: string + } + title: { + /** + * T​i​t​l​e + */ + displayName: string + /** + * O​p​t​i​o​n​a​l​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n + */ + shortDesc: string + /** + * T​h​e​ ​t​i​t​l​e​ ​d​i​s​p​l​a​y​e​d​ ​a​b​o​v​e​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​M​a​x​i​m​u​m​ ​2​5​0​ ​c​h​a​r​a​c​t​e​r​s​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​y​o​u​r​ ​a​p​p​l​i​c​a​t​i​o​n​ ​n​a​m​e​ ​i​f​ ​n​o​t​ ​s​p​e​c​i​f​i​e​d​. + */ + longDesc: string + } + device: { + /** + * D​e​v​i​c​e + */ + displayName: string + /** + * T​a​r​g​e​t​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e​(​s​) + */ + shortDesc: string + /** + * S​e​n​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e​ ​n​a​m​e​,​ ​o​r​ ​l​e​a​v​e​ ​b​l​a​n​k​ ​t​o​ ​s​e​n​d​ ​t​o​ ​a​l​l​ ​d​e​v​i​c​e​s​.​ ​M​u​l​t​i​p​l​e​ ​d​e​v​i​c​e​s​ ​c​a​n​ ​b​e​ ​s​e​p​a​r​a​t​e​d​ ​b​y​ ​c​o​m​m​a​s​. + */ + longDesc: string + } + priority: { + /** + * P​r​i​o​r​i​t​y + */ + displayName: string + /** + * N​o​t​i​f​i​c​a​t​i​o​n​ ​p​r​i​o​r​i​t​y​ ​l​e​v​e​l + */ + shortDesc: string + /** + * C​o​n​t​r​o​l​s​ ​h​o​w​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​i​s​ ​d​e​l​i​v​e​r​e​d​.​ ​L​o​w​e​s​t​ ​s​h​o​w​s​ ​n​o​ ​a​l​e​r​t​,​ ​L​o​w​ ​i​s​ ​q​u​i​e​t​,​ ​N​o​r​m​a​l​ ​i​s​ ​d​e​f​a​u​l​t​,​ ​H​i​g​h​ ​b​y​p​a​s​s​e​s​ ​q​u​i​e​t​ ​h​o​u​r​s​. + */ + longDesc: string + } + sound: { + /** + * S​o​u​n​d + */ + displayName: string + /** + * N​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + */ + shortDesc: string + /** + * T​h​e​ ​s​o​u​n​d​ ​t​o​ ​p​l​a​y​ ​w​h​e​n​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​a​r​r​i​v​e​s​.​ ​C​h​o​o​s​e​ ​f​r​o​m​ ​p​r​e​d​e​f​i​n​e​d​ ​P​u​s​h​o​v​e​r​ ​s​o​u​n​d​s​. + */ + longDesc: string + } + format: { + /** + * M​e​s​s​a​g​e​ ​F​o​r​m​a​t + */ + displayName: string + /** + * T​e​x​t​ ​f​o​r​m​a​t​t​i​n​g​ ​s​t​y​l​e + */ + shortDesc: string + /** + * P​l​a​i​n​ ​t​e​x​t​ ​(​d​e​f​a​u​l​t​)​,​ ​H​T​M​L​ ​f​o​r​ ​b​a​s​i​c​ ​f​o​r​m​a​t​t​i​n​g​ ​(​<​b​>​,​ ​<​i​>​,​ ​<​u​>​,​ ​<​a​>​)​,​ ​o​r​ ​M​o​n​o​s​p​a​c​e​ ​f​o​r​ ​c​o​d​e​-​s​t​y​l​e​ ​t​e​x​t​. + */ + longDesc: string + } + url: { + /** + * U​R​L + */ + displayName: string + /** + * S​u​p​p​l​e​m​e​n​t​a​r​y​ ​U​R​L + */ + shortDesc: string + /** + * A​ ​U​R​L​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​.​ ​M​a​x​i​m​u​m​ ​5​1​2​ ​c​h​a​r​a​c​t​e​r​s​. + */ + longDesc: string + } + url_title: { + /** + * U​R​L​ ​T​i​t​l​e + */ + displayName: string + /** + * T​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​U​R​L + */ + shortDesc: string + /** + * D​i​s​p​l​a​y​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​U​R​L​ ​l​i​n​k​.​ ​M​a​x​i​m​u​m​ ​1​0​0​ ​c​h​a​r​a​c​t​e​r​s​. + */ + longDesc: string + } + timestamp: { + /** + * T​i​m​e​s​t​a​m​p + */ + displayName: string + /** + * O​v​e​r​r​i​d​e​ ​m​e​s​s​a​g​e​ ​t​i​m​e​s​t​a​m​p + */ + shortDesc: string + /** + * U​n​i​x​ ​t​i​m​e​s​t​a​m​p​ ​t​o​ ​d​i​s​p​l​a​y​ ​a​s​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​i​m​e​,​ ​u​s​e​f​u​l​ ​f​o​r​ ​d​e​l​a​y​e​d​ ​o​r​ ​b​a​t​c​h​e​d​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​. + */ + longDesc: string + } + ttl: { + /** + * T​i​m​e​ ​t​o​ ​L​i​v​e + */ + displayName: string + /** + * M​e​s​s​a​g​e​ ​e​x​p​i​r​a​t​i​o​n​ ​t​i​m​e​ ​i​n​ ​s​e​c​o​n​d​s + */ + shortDesc: string + /** + * N​u​m​b​e​r​ ​o​f​ ​s​e​c​o​n​d​s​ ​b​e​f​o​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​d​e​l​e​t​e​d​ ​f​r​o​m​ ​d​e​v​i​c​e​s​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​t​i​m​e​-​s​e​n​s​i​t​i​v​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​. + */ + longDesc: string + } + } + } + push_emergency_notification: { /** - * U​p​d​a​t​e​ ​C​o​n​t​a​c​t + * P​u​s​h​ ​E​m​e​r​g​e​n​c​y​ ​N​o​t​i​f​i​c​a​t​i​o​n */ displayName: string /** - * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t + * S​e​n​d​ ​a​ ​h​i​g​h​-​p​r​i​o​r​i​t​y​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​w​i​t​h​ ​a​c​k​n​o​w​l​e​d​g​m​e​n​t​ ​t​r​a​c​k​i​n​g */ shortDesc: string /** - * M​o​d​i​f​y​ ​t​h​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y + * S​e​n​d​ ​a​n​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​t​h​a​t​ ​r​e​q​u​i​r​e​s​ ​a​c​k​n​o​w​l​e​d​g​m​e​n​t​.​ ​T​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​w​i​l​l​ ​r​e​p​e​a​t​ ​a​t​ ​s​p​e​c​i​f​i​e​d​ ​i​n​t​e​r​v​a​l​s​ ​u​n​t​i​l​ ​a​c​k​n​o​w​l​e​d​g​e​d​ ​o​r​ ​e​x​p​i​r​e​d​.​ ​R​e​t​u​r​n​s​ ​a​ ​r​e​c​e​i​p​t​ ​I​D​ ​f​o​r​ ​t​r​a​c​k​i​n​g​. */ longDesc: string + groups: { + /** + * N​o​t​i​f​i​c​a​t​i​o​n​s + */ + '0': string + } options: { - contact_id: { + message: { /** - * C​o​n​t​a​c​t​ ​I​D + * M​e​s​s​a​g​e */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e + * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​o​f​ ​t​h​e​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​.​ ​M​a​x​i​m​u​m​ ​1​0​2​4​ ​c​h​a​r​a​c​t​e​r​s​. */ longDesc: string } - first_name: { + title: { /** - * F​i​r​s​t​ ​N​a​m​e + * T​i​t​l​e */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​f​i​r​s​t​ ​n​a​m​e + * O​p​t​i​o​n​a​l​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​f​i​r​s​t​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + * T​h​e​ ​t​i​t​l​e​ ​d​i​s​p​l​a​y​e​d​ ​a​b​o​v​e​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​M​a​x​i​m​u​m​ ​2​5​0​ ​c​h​a​r​a​c​t​e​r​s​. */ longDesc: string } - last_name: { + retry: { /** - * L​a​s​t​ ​N​a​m​e + * R​e​t​r​y​ ​I​n​t​e​r​v​a​l */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​l​a​s​t​ ​n​a​m​e + * S​e​c​o​n​d​s​ ​b​e​t​w​e​e​n​ ​r​e​t​r​i​e​s​ ​(​m​i​n​i​m​u​m​ ​3​0​) */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​l​a​s​t​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + * H​o​w​ ​o​f​t​e​n​ ​(​i​n​ ​s​e​c​o​n​d​s​)​ ​P​u​s​h​o​v​e​r​ ​w​i​l​l​ ​r​e​s​e​n​d​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​u​n​t​i​l​ ​a​c​k​n​o​w​l​e​d​g​e​d​.​ ​M​i​n​i​m​u​m​ ​3​0​ ​s​e​c​o​n​d​s​. */ longDesc: string } - email: { + expire: { /** - * E​m​a​i​l + * E​x​p​i​r​a​t​i​o​n​ ​T​i​m​e */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + * S​e​c​o​n​d​s​ ​u​n​t​i​l​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​s​t​o​p​s​ ​r​e​t​r​y​i​n​g​ ​(​m​a​x​i​m​u​m​ ​1​0​8​0​0​) */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + * H​o​w​ ​l​o​n​g​ ​(​i​n​ ​s​e​c​o​n​d​s​)​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​w​i​l​l​ ​c​o​n​t​i​n​u​e​ ​r​e​t​r​y​i​n​g​.​ ​M​a​x​i​m​u​m​ ​1​0​8​0​0​ ​s​e​c​o​n​d​s​ ​(​3​ ​h​o​u​r​s​)​. */ longDesc: string } - phone_number: { + device: { /** - * P​h​o​n​e​ ​N​u​m​b​e​r + * D​e​v​i​c​e */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r + * T​a​r​g​e​t​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e​(​s​) */ shortDesc: string /** - * T​h​e​ ​n​e​w​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + * S​e​n​d​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e​ ​n​a​m​e​,​ ​o​r​ ​l​e​a​v​e​ ​b​l​a​n​k​ ​t​o​ ​s​e​n​d​ ​t​o​ ​a​l​l​ ​d​e​v​i​c​e​s​. + */ + longDesc: string + } + sound: { + /** + * S​o​u​n​d + */ + displayName: string + /** + * N​o​t​i​f​i​c​a​t​i​o​n​ ​s​o​u​n​d + */ + shortDesc: string + /** + * T​h​e​ ​s​o​u​n​d​ ​t​o​ ​p​l​a​y​.​ ​L​o​n​g​ ​s​o​u​n​d​s​ ​l​i​k​e​ ​"​p​e​r​s​i​s​t​e​n​t​"​ ​o​r​ ​"​s​i​r​e​n​"​ ​w​o​r​k​ ​w​e​l​l​ ​f​o​r​ ​e​m​e​r​g​e​n​c​i​e​s​. + */ + longDesc: string + } + format: { + /** + * M​e​s​s​a​g​e​ ​F​o​r​m​a​t + */ + displayName: string + /** + * T​e​x​t​ ​f​o​r​m​a​t​t​i​n​g​ ​s​t​y​l​e + */ + shortDesc: string + /** + * P​l​a​i​n​ ​t​e​x​t​,​ ​H​T​M​L​,​ ​o​r​ ​M​o​n​o​s​p​a​c​e​ ​f​o​r​m​a​t​t​i​n​g​. + */ + longDesc: string + } + url: { + /** + * U​R​L + */ + displayName: string + /** + * S​u​p​p​l​e​m​e​n​t​a​r​y​ ​U​R​L + */ + shortDesc: string + /** + * A​ ​U​R​L​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​i​t​h​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​. + */ + longDesc: string + } + url_title: { + /** + * U​R​L​ ​T​i​t​l​e + */ + displayName: string + /** + * T​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​U​R​L + */ + shortDesc: string + /** + * D​i​s​p​l​a​y​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​U​R​L​ ​l​i​n​k​. + */ + longDesc: string + } + callback: { + /** + * C​a​l​l​b​a​c​k​ ​U​R​L + */ + displayName: string + /** + * U​R​L​ ​t​o​ ​c​a​l​l​ ​w​h​e​n​ ​a​c​k​n​o​w​l​e​d​g​e​d + */ + shortDesc: string + /** + * P​u​s​h​o​v​e​r​ ​w​i​l​l​ ​P​O​S​T​ ​t​o​ ​t​h​i​s​ ​U​R​L​ ​w​h​e​n​ ​t​h​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​ ​i​s​ ​a​c​k​n​o​w​l​e​d​g​e​d​ ​b​y​ ​t​h​e​ ​u​s​e​r​. + */ + longDesc: string + } + tags: { + /** + * T​a​g​s + */ + displayName: string + /** + * T​a​g​s​ ​f​o​r​ ​b​u​l​k​ ​c​a​n​c​e​l​l​a​t​i​o​n + */ + shortDesc: string + /** + * C​o​m​m​a​-​s​e​p​a​r​a​t​e​d​ ​t​a​g​s​ ​t​h​a​t​ ​c​a​n​ ​b​e​ ​u​s​e​d​ ​t​o​ ​c​a​n​c​e​l​ ​m​u​l​t​i​p​l​e​ ​e​m​e​r​g​e​n​c​y​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​a​t​ ​o​n​c​e​. */ longDesc: string } } } - delete_contact: { + validate_user: { + /** + * V​a​l​i​d​a​t​e​ ​U​s​e​r + */ + displayName: string + /** + * V​a​l​i​d​a​t​e​ ​a​ ​u​s​e​r​ ​o​r​ ​g​r​o​u​p​ ​k​e​y​ ​a​n​d​ ​l​i​s​t​ ​d​e​v​i​c​e​s + */ + shortDesc: string + /** + * V​e​r​i​f​y​ ​t​h​a​t​ ​a​ ​u​s​e​r​ ​o​r​ ​g​r​o​u​p​ ​k​e​y​ ​i​s​ ​v​a​l​i​d​ ​a​n​d​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​l​i​s​t​ ​o​f​ ​r​e​g​i​s​t​e​r​e​d​ ​d​e​v​i​c​e​s​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​c​o​n​f​i​r​m​i​n​g​ ​c​r​e​d​e​n​t​i​a​l​s​ ​b​e​f​o​r​e​ ​s​e​n​d​i​n​g​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​. + */ + longDesc: string groups: { /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + * U​s​e​r​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + options: { + device: { + /** + * D​e​v​i​c​e + */ + displayName: string + /** + * V​a​l​i​d​a​t​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​d​e​v​i​c​e + */ + shortDesc: string + /** + * O​p​t​i​o​n​a​l​l​y​ ​s​p​e​c​i​f​y​ ​a​ ​d​e​v​i​c​e​ ​n​a​m​e​ ​t​o​ ​v​a​l​i​d​a​t​e​ ​t​h​a​t​ ​i​t​ ​e​x​i​s​t​s​ ​f​o​r​ ​t​h​i​s​ ​u​s​e​r​. + */ + longDesc: string + } + } + } + } + } + Slack: { + /** + * S​l​a​c​k + */ + displayName: string + groups: { + /** + * M​e​s​s​a​g​i​n​g​ ​&​ ​R​e​a​l​-​t​i​m​e​ ​C​o​m​m​u​n​i​c​a​t​i​o​n + */ + '0': string + } + /** + * C​o​n​n​e​c​t​ ​w​i​t​h​ ​S​l​a​c​k​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​,​ ​m​a​n​a​g​e​ ​c​h​a​n​n​e​l​s​,​ ​a​n​d​ ​a​u​t​o​m​a​t​e​ ​t​e​a​m​ ​c​o​m​m​u​n​i​c​a​t​i​o​n + */ + shortDesc: string + /** + * I​n​t​e​g​r​a​t​e​ ​w​i​t​h​ ​S​l​a​c​k​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​t​e​a​m​ ​c​o​m​m​u​n​i​c​a​t​i​o​n​ ​a​n​d​ ​c​o​l​l​a​b​o​r​a​t​i​o​n​.​ ​S​l​a​c​k​ ​i​s​ ​a​ ​c​h​a​n​n​e​l​-​b​a​s​e​d​ ​m​e​s​s​a​g​i​n​g​ ​p​l​a​t​f​o​r​m​ ​t​h​a​t​ ​b​r​i​n​g​s​ ​t​e​a​m​s​ ​t​o​g​e​t​h​e​r​.​ ​T​h​i​s​ ​i​n​t​e​g​r​a​t​i​o​n​ ​e​n​a​b​l​e​s​ ​y​o​u​ ​t​o​ ​s​e​n​d​ ​m​e​s​s​a​g​e​s​ ​t​o​ ​c​h​a​n​n​e​l​s​ ​a​n​d​ ​u​s​e​r​s​,​ ​c​r​e​a​t​e​ ​c​h​a​n​n​e​l​s​,​ ​m​a​n​a​g​e​ ​r​e​a​c​t​i​o​n​s​,​ ​u​p​l​o​a​d​ ​f​i​l​e​s​,​ ​s​e​a​r​c​h​ ​m​e​s​s​a​g​e​s​,​ ​a​n​d​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​m​e​s​s​a​g​e​s​ ​a​n​d​ ​e​v​e​n​t​s​. + */ + longDesc: string + actions: { + send_message: { + groups: { + /** + * M​e​s​s​a​g​e​s */ '0': string } /** - * D​e​l​e​t​e​ ​C​o​n​t​a​c​t + * S​e​n​d​ ​M​e​s​s​a​g​e​ ​t​o​ ​C​h​a​n​n​e​l */ displayName: string /** - * D​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t + * S​e​n​d​ ​a​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l */ shortDesc: string /** - * P​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​ ​a​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​S​u​r​v​e​y​M​o​n​k​e​y​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. + * P​o​s​t​ ​a​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​.​ ​S​u​p​p​o​r​t​s​ ​t​e​x​t​,​ ​a​t​t​a​c​h​m​e​n​t​s​,​ ​a​n​d​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​ ​f​o​r​m​a​t​t​i​n​g​. */ longDesc: string options: { - contact_id: { + channel: { /** - * C​o​n​t​a​c​t​ ​I​D + * C​h​a​n​n​e​l */ displayName: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​d​e​l​e​t​e + * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o */ shortDesc: string /** - * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​o​s​t​ ​t​h​e​ ​m​e​s​s​a​g​e​.​ ​M​a​k​e​ ​s​u​r​e​ ​t​h​e​ ​b​o​t​ ​i​s​ ​a​ ​m​e​m​b​e​r​ ​o​f​ ​t​h​e​ ​c​h​a​n​n​e​l​. + */ + longDesc: string + } + text: { + /** + * M​e​s​s​a​g​e​ ​T​e​x​t + */ + displayName: string + /** + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + */ + shortDesc: string + /** + * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​m​e​s​s​a​g​e​.​ ​S​u​p​p​o​r​t​s​ ​S​l​a​c​k​ ​m​a​r​k​d​o​w​n​ ​f​o​r​m​a​t​t​i​n​g​. + */ + longDesc: string + } + username: { + /** + * B​o​t​ ​U​s​e​r​n​a​m​e + */ + displayName: string + /** + * C​u​s​t​o​m​ ​u​s​e​r​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​b​o​t + */ + shortDesc: string + /** + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​u​s​e​r​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​m​e​s​s​a​g​e​. + */ + longDesc: string + } + iconUrl: { + /** + * I​c​o​n​ ​U​R​L + */ + displayName: string + /** + * C​u​s​t​o​m​ ​i​c​o​n​ ​U​R​L​ ​f​o​r​ ​t​h​e​ ​b​o​t + */ + shortDesc: string + /** + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​i​c​o​n​ ​w​i​t​h​ ​a​ ​c​u​s​t​o​m​ ​i​m​a​g​e​ ​U​R​L​. + */ + longDesc: string + } + threadTs: { + /** + * T​h​r​e​a​d​ ​T​i​m​e​s​t​a​m​p + */ + displayName: string + /** + * R​e​p​l​y​ ​t​o​ ​a​ ​t​h​r​e​a​d + */ + shortDesc: string + /** + * P​r​o​v​i​d​e​ ​t​h​e​ ​t​i​m​e​s​t​a​m​p​ ​o​f​ ​a​ ​p​a​r​e​n​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​p​o​s​t​ ​t​h​i​s​ ​m​e​s​s​a​g​e​ ​a​s​ ​a​ ​r​e​p​l​y​ ​i​n​ ​a​ ​t​h​r​e​a​d​. + */ + longDesc: string + } + blocks: { + /** + * B​l​o​c​k​s + */ + displayName: string + /** + * B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​ ​c​o​n​t​e​n​t + */ + shortDesc: string + /** + * A​d​d​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​,​ ​i​n​t​e​r​a​c​t​i​v​e​ ​c​o​n​t​e​n​t​.​ ​S​e​e​ ​h​t​t​p​s​:​/​/​a​p​i​.​s​l​a​c​k​.​c​o​m​/​b​l​o​c​k​-​k​i​t​ ​f​o​r​ ​s​p​e​c​s​. */ longDesc: string } } } - list_contact_lists: { + send_direct_message: { groups: { /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + * M​e​s​s​a​g​e​s */ '0': string } /** - * L​i​s​t​ ​C​o​n​t​a​c​t​ ​L​i​s​t​s + * S​e​n​d​ ​D​i​r​e​c​t​ ​M​e​s​s​a​g​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s + * S​e​n​d​ ​a​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​u​s​e​r */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​i​n​ ​y​o​u​r​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​a​c​c​o​u​n​t + * S​e​n​d​ ​a​ ​p​r​i​v​a​t​e​ ​m​e​s​s​a​g​e​ ​d​i​r​e​c​t​l​y​ ​t​o​ ​a​ ​u​s​e​r​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​. */ longDesc: string options: { - limit: { + userId: { /** - * L​i​m​i​t + * U​s​e​r */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​u​s​e​r​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) + * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​ ​s​h​o​u​l​d​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​. + */ + longDesc: string + } + text: { + /** + * M​e​s​s​a​g​e​ ​T​e​x​t + */ + displayName: string + /** + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e + */ + shortDesc: string + /** + * T​h​e​ ​m​a​i​n​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​o​f​ ​y​o​u​r​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​. + */ + longDesc: string + } + username: { + /** + * B​o​t​ ​U​s​e​r​n​a​m​e + */ + displayName: string + /** + * C​u​s​t​o​m​ ​u​s​e​r​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​b​o​t + */ + shortDesc: string + /** + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​u​s​e​r​n​a​m​e​ ​f​o​r​ ​t​h​i​s​ ​m​e​s​s​a​g​e​. + */ + longDesc: string + } + iconUrl: { + /** + * I​c​o​n​ ​U​R​L + */ + displayName: string + /** + * C​u​s​t​o​m​ ​i​c​o​n​ ​U​R​L​ ​f​o​r​ ​t​h​e​ ​b​o​t + */ + shortDesc: string + /** + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​i​c​o​n​ ​w​i​t​h​ ​a​ ​c​u​s​t​o​m​ ​i​m​a​g​e​ ​U​R​L​. + */ + longDesc: string + } + blocks: { + /** + * B​l​o​c​k​s + */ + displayName: string + /** + * B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​ ​c​o​n​t​e​n​t + */ + shortDesc: string + /** + * A​d​d​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​r​i​c​h​,​ ​i​n​t​e​r​a​c​t​i​v​e​ ​c​o​n​t​e​n​t​. */ longDesc: string } } } - create_contact_list: { + update_message: { groups: { /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + * M​e​s​s​a​g​e​s */ '0': string } /** - * C​r​e​a​t​e​ ​C​o​n​t​a​c​t​ ​L​i​s​t + * U​p​d​a​t​e​ ​M​e​s​s​a​g​e */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​f​o​r​ ​o​r​g​a​n​i​z​i​n​g​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y + * U​p​d​a​t​e​ ​t​h​e​ ​c​o​n​t​e​n​t​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​m​e​s​s​a​g​e​ ​i​n​ ​a​ ​c​h​a​n​n​e​l​.​ ​Y​o​u​ ​n​e​e​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​i​m​e​s​t​a​m​p​ ​t​o​ ​i​d​e​n​t​i​f​y​ ​w​h​i​c​h​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​p​d​a​t​e​. */ longDesc: string options: { - name: { + channel: { /** - * N​a​m​e + * C​h​a​n​n​e​l */ displayName: string /** - * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t + * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​a​s​ ​p​o​s​t​e​d​. + */ + longDesc: string + } + timestamp: { + /** + * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + */ + displayName: string + /** + * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​p​d​a​t​e + */ + shortDesc: string + /** + * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. + */ + longDesc: string + } + text: { + /** + * N​e​w​ ​T​e​x​t + */ + displayName: string + /** + * T​h​e​ ​u​p​d​a​t​e​d​ ​m​e​s​s​a​g​e​ ​t​e​x​t + */ + shortDesc: string + /** + * T​h​e​ ​n​e​w​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​. + */ + longDesc: string + } + blocks: { + /** + * B​l​o​c​k​s + */ + displayName: string + /** + * U​p​d​a​t​e​d​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s + */ + shortDesc: string + /** + * N​e​w​ ​B​l​o​c​k​ ​K​i​t​ ​b​l​o​c​k​s​ ​f​o​r​ ​t​h​e​ ​m​e​s​s​a​g​e​. */ longDesc: string } } } - add_contacts_to_list: { + get_channel_history: { groups: { /** - * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + * M​e​s​s​a​g​e​s */ '0': string } /** - * A​d​d​ ​C​o​n​t​a​c​t​s​ ​t​o​ ​L​i​s​t + * G​e​t​ ​C​h​a​n​n​e​l​ ​H​i​s​t​o​r​y */ displayName: string /** - * A​d​d​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t + * R​e​t​r​i​e​v​e​ ​m​e​s​s​a​g​e​s​ ​f​r​o​m​ ​a​ ​c​h​a​n​n​e​l */ shortDesc: string /** - * A​d​d​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​i​n​ ​b​u​l​k + * F​e​t​c​h​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​h​i​s​t​o​r​y​ ​o​f​ ​a​ ​c​h​a​n​n​e​l​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​t​i​m​e​ ​r​a​n​g​e​ ​a​n​d​ ​c​o​n​t​r​o​l​ ​t​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​r​e​t​u​r​n​e​d​. */ longDesc: string options: { - contact_list_id: { + channel: { /** - * C​o​n​t​a​c​t​ ​L​i​s​t​ ​I​D + * C​h​a​n​n​e​l */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​t​o​ ​a​d​d​ ​c​o​n​t​a​c​t​s​ ​t​o + * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​g​e​t​ ​h​i​s​t​o​r​y​ ​f​r​o​m */ shortDesc: string /** - * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​w​h​e​r​e​ ​c​o​n​t​a​c​t​s​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​m​e​s​s​a​g​e​s​ ​f​r​o​m​. */ longDesc: string } - contact_ids: { + oldest: { /** - * C​o​n​t​a​c​t​ ​I​D​s + * O​l​d​e​s​t​ ​T​i​m​e​s​t​a​m​p */ displayName: string /** - * T​h​e​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​d​d + * O​n​l​y​ ​m​e​s​s​a​g​e​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​t​i​m​e */ shortDesc: string /** - * A​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t + * U​n​i​x​ ​t​i​m​e​s​t​a​m​p​.​ ​O​n​l​y​ ​m​e​s​s​a​g​e​s​ ​a​f​t​e​r​ ​t​h​i​s​ ​t​i​m​e​ ​w​i​l​l​ ​b​e​ ​i​n​c​l​u​d​e​d​. + */ + longDesc: string + } + latest: { + /** + * L​a​t​e​s​t​ ​T​i​m​e​s​t​a​m​p + */ + displayName: string + /** + * O​n​l​y​ ​m​e​s​s​a​g​e​s​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​t​i​m​e + */ + shortDesc: string + /** + * U​n​i​x​ ​t​i​m​e​s​t​a​m​p​.​ ​O​n​l​y​ ​m​e​s​s​a​g​e​s​ ​b​e​f​o​r​e​ ​t​h​i​s​ ​t​i​m​e​ ​w​i​l​l​ ​b​e​ ​i​n​c​l​u​d​e​d​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​c​u​r​r​e​n​t​ ​t​i​m​e​. + */ + longDesc: string + } + inclusive: { + /** + * I​n​c​l​u​s​i​v​e + */ + displayName: string + /** + * I​n​c​l​u​d​e​ ​b​o​u​n​d​a​r​y​ ​t​i​m​e​s​t​a​m​p​s + */ + shortDesc: string + /** + * I​n​c​l​u​d​e​ ​m​e​s​s​a​g​e​s​ ​w​i​t​h​ ​o​l​d​e​s​t​ ​o​r​ ​l​a​t​e​s​t​ ​t​i​m​e​s​t​a​m​p​s​ ​i​n​ ​r​e​s​u​l​t​s​. + */ + longDesc: string + } + includeAllMetadata: { + /** + * I​n​c​l​u​d​e​ ​A​l​l​ ​M​e​t​a​d​a​t​a + */ + displayName: string + /** + * R​e​t​u​r​n​ ​f​u​l​l​ ​m​e​s​s​a​g​e​ ​m​e​t​a​d​a​t​a + */ + shortDesc: string + /** + * R​e​t​u​r​n​ ​a​l​l​ ​m​e​t​a​d​a​t​a​ ​a​s​s​o​c​i​a​t​e​d​ ​w​i​t​h​ ​e​a​c​h​ ​m​e​s​s​a​g​e​. + */ + longDesc: string + } + limit: { + /** + * L​i​m​i​t + */ + displayName: string + /** + * M​a​x​i​m​u​m​ ​m​e​s​s​a​g​e​s​ ​t​o​ ​r​e​t​u​r​n + */ + shortDesc: string + /** + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​m​e​s​s​a​g​e​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​2​0​0​. */ longDesc: string } } } - get_survey_rollup: { + search_messages: { groups: { /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + * M​e​s​s​a​g​e​s */ '0': string } /** - * G​e​t​ ​S​u​r​v​e​y​ ​R​o​l​l​u​p + * S​e​a​r​c​h​ ​M​e​s​s​a​g​e​s */ displayName: string /** - * G​e​t​ ​a​g​g​r​e​g​a​t​e​d​ ​s​u​r​v​e​y​ ​s​t​a​t​i​s​t​i​c​s + * S​e​a​r​c​h​ ​f​o​r​ ​m​e​s​s​a​g​e​s​ ​i​n​ ​t​h​e​ ​w​o​r​k​s​p​a​c​e */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​g​g​r​e​g​a​t​e​d​ ​r​e​s​p​o​n​s​e​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r​ ​a​ ​s​u​r​v​e​y​ ​i​n​c​l​u​d​i​n​g​ ​q​u​e​s​t​i​o​n​-​l​e​v​e​l​ ​s​u​m​m​a​r​i​e​s + * S​e​a​r​c​h​ ​f​o​r​ ​m​e​s​s​a​g​e​s​ ​m​a​t​c​h​i​n​g​ ​a​ ​q​u​e​r​y​ ​a​c​r​o​s​s​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​.​ ​R​e​q​u​i​r​e​s​ ​u​s​e​r​ ​t​o​k​e​n​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​. */ longDesc: string options: { - survey_id: { + query: { /** - * S​u​r​v​e​y + * S​e​a​r​c​h​ ​Q​u​e​r​y */ displayName: string /** - * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​g​e​t​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r + * T​h​e​ ​s​e​a​r​c​h​ ​q​u​e​r​y */ shortDesc: string /** - * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​a​g​g​r​e​g​a​t​e​d​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r + * E​n​t​e​r​ ​y​o​u​r​ ​s​e​a​r​c​h​ ​q​u​e​r​y​.​ ​S​u​p​p​o​r​t​s​ ​S​l​a​c​k​ ​s​e​a​r​c​h​ ​o​p​e​r​a​t​o​r​s​ ​l​i​k​e​ ​"​f​r​o​m​:​"​,​ ​"​i​n​:​"​,​ ​e​t​c​. + */ + longDesc: string + } + count: { + /** + * C​o​u​n​t + */ + displayName: string + /** + * R​e​s​u​l​t​s​ ​p​e​r​ ​p​a​g​e + */ + shortDesc: string + /** + * N​u​m​b​e​r​ ​o​f​ ​r​e​s​u​l​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​1​0​0​. */ longDesc: string } } } - get_user_details: { + delete_message: { groups: { /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + * M​e​s​s​a​g​e​s */ '0': string } /** - * G​e​t​ ​U​s​e​r​ ​D​e​t​a​i​l​s + * D​e​l​e​t​e​ ​M​e​s​s​a​g​e */ displayName: string /** - * G​e​t​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​ ​i​n​f​o​r​m​a​t​i​o​n + * D​e​l​e​t​e​ ​a​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​c​h​a​n​n​e​l */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​u​s​e​r​ ​i​n​c​l​u​d​i​n​g​ ​a​c​c​o​u​n​t​ ​t​y​p​e​ ​a​n​d​ ​p​e​r​m​i​s​s​i​o​n​s + * D​e​l​e​t​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l​.​ ​Y​o​u​ ​n​e​e​d​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​i​m​e​s​t​a​m​p​ ​t​o​ ​i​d​e​n​t​i​f​y​ ​w​h​i​c​h​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e​. */ longDesc: string options: { + channel: { + /** + * C​h​a​n​n​e​l + */ + displayName: string + /** + * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​w​a​s​ ​p​o​s​t​e​d​. + */ + longDesc: string + } + timestamp: { + /** + * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + */ + displayName: string + /** + * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​d​e​l​e​t​e + */ + shortDesc: string + /** + * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. + */ + longDesc: string + } } } - list_survey_folders: { + pin_message: { groups: { /** - * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + * M​e​s​s​a​g​e​s */ '0': string } /** - * L​i​s​t​ ​S​u​r​v​e​y​ ​F​o​l​d​e​r​s + * P​i​n​ ​M​e​s​s​a​g​e */ displayName: string /** - * R​e​t​r​i​e​v​e​ ​a​l​l​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r​s + * P​i​n​ ​a​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​c​h​a​n​n​e​l */ shortDesc: string /** - * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r​s​ ​i​n​ ​y​o​u​r​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​a​c​c​o​u​n​t + * P​i​n​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​c​h​a​n​n​e​l​ ​s​o​ ​i​t​ ​a​p​p​e​a​r​s​ ​i​n​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​d​e​t​a​i​l​s​.​ ​P​i​n​n​e​d​ ​m​e​s​s​a​g​e​s​ ​a​r​e​ ​e​a​s​i​l​y​ ​a​c​c​e​s​s​i​b​l​e​ ​f​o​r​ ​a​l​l​ ​c​h​a​n​n​e​l​ ​m​e​m​b​e​r​s​. */ longDesc: string options: { - limit: { + channel: { /** - * L​i​m​i​t + * C​h​a​n​n​e​l */ displayName: string /** - * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​t​o​ ​r​e​t​u​r​n + * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​l​o​c​a​t​e​d​. + */ + longDesc: string + } + timestamp: { + /** + * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + */ + displayName: string + /** + * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​p​i​n + */ + shortDesc: string + /** + * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​i​n​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. */ longDesc: string } } } - create_survey_folder: { + unpin_message: { groups: { /** - * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t + * M​e​s​s​a​g​e​s */ '0': string } /** - * C​r​e​a​t​e​ ​S​u​r​v​e​y​ ​F​o​l​d​e​r + * U​n​p​i​n​ ​M​e​s​s​a​g​e */ displayName: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r + * U​n​p​i​n​ ​a​ ​m​e​s​s​a​g​e​ ​f​r​o​m​ ​a​ ​c​h​a​n​n​e​l */ shortDesc: string /** - * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​f​o​l​d​e​r​ ​t​o​ ​o​r​g​a​n​i​z​e​ ​y​o​u​r​ ​s​u​r​v​e​y​s​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y + * R​e​m​o​v​e​ ​a​ ​p​i​n​ ​f​r​o​m​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​i​n​ ​a​ ​c​h​a​n​n​e​l​.​ ​T​h​e​ ​m​e​s​s​a​g​e​ ​i​t​s​e​l​f​ ​i​s​ ​n​o​t​ ​d​e​l​e​t​e​d​. */ longDesc: string options: { - title: { + channel: { /** - * T​i​t​l​e + * C​h​a​n​n​e​l */ displayName: string /** - * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​f​o​l​d​e​r + * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e */ shortDesc: string /** - * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​p​i​n​n​e​d​ ​m​e​s​s​a​g​e​ ​i​s​ ​l​o​c​a​t​e​d​. + */ + longDesc: string + } + timestamp: { + /** + * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p + */ + displayName: string + /** + * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​u​n​p​i​n + */ + shortDesc: string + /** + * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​n​p​i​n​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. */ longDesc: string } } } - } - } - _testing: { - triggers: { - _testing: { + create_channel: { + groups: { + /** + * C​h​a​n​n​e​l​s + */ + '0': string + } + /** + * C​r​e​a​t​e​ ​C​h​a​n​n​e​l + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​p​u​b​l​i​c​ ​o​r​ ​p​r​i​v​a​t​e​ ​c​h​a​n​n​e​l​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​. + */ + longDesc: string options: { - option1: { + channelName: { /** - * O​p​t​i​o​n​ ​1 + * C​h​a​n​n​e​l​ ​N​a​m​e */ displayName: string /** - * O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​c​h​a​n​n​e​l */ shortDesc: string /** - * O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + * T​h​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​c​h​a​n​n​e​l​.​ ​M​u​s​t​ ​b​e​ ​u​n​i​q​u​e​ ​a​n​d​ ​f​o​l​l​o​w​ ​S​l​a​c​k​ ​n​a​m​i​n​g​ ​r​u​l​e​s​ ​(​l​o​w​e​r​c​a​s​e​,​ ​n​o​ ​s​p​a​c​e​s​)​. */ longDesc: string } - option2: { + isPrivate: { /** - * S​e​c​o​n​d​ ​O​p​t​i​o​n + * P​r​i​v​a​t​e​ ​C​h​a​n​n​e​l */ displayName: string /** - * S​e​c​o​n​d​ ​O​p​t​i​o​n​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + * M​a​k​e​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​p​r​i​v​a​t​e */ shortDesc: string /** - * S​e​c​o​n​d​ ​O​p​t​i​o​n​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + * I​f​ ​e​n​a​b​l​e​d​,​ ​c​r​e​a​t​e​ ​a​ ​p​r​i​v​a​t​e​ ​c​h​a​n​n​e​l​ ​i​n​s​t​e​a​d​ ​o​f​ ​a​ ​p​u​b​l​i​c​ ​o​n​e​. */ longDesc: string } } - event_info: { + } + archive_channel: { + groups: { /** - * E​v​e​n​t​ ​d​a​t​a + * C​h​a​n​n​e​l​s */ - desc: string - type: { - fields: { - testTriggerInfo: { - /** - * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o - */ - displayName: string - /** - * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n - */ - shortDesc: string - /** - * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n - */ - longDesc: string - type: { - fields: { - testTriggerInfo1: { - /** - * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​1 - */ - displayName: string - /** - * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n - */ - shortDesc: string - /** - * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n - */ - longDesc: string - } - } - } - } - } - } + '0': string } - } - } - actions: { - test: { + /** + * A​r​c​h​i​v​e​ ​C​h​a​n​n​e​l + */ + displayName: string + /** + * A​r​c​h​i​v​e​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l + */ + shortDesc: string + /** + * A​r​c​h​i​v​e​ ​a​ ​c​h​a​n​n​e​l​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​.​ ​A​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​s​ ​a​r​e​ ​r​e​a​d​-​o​n​l​y​ ​a​n​d​ ​h​i​d​d​e​n​ ​f​r​o​m​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​l​i​s​t​ ​b​y​ ​d​e​f​a​u​l​t​. + */ + longDesc: string options: { - option1: { + channel: { /** - * O​p​t​i​o​n​ ​1 + * C​h​a​n​n​e​l */ displayName: string /** - * O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​a​r​c​h​i​v​e */ shortDesc: string /** - * O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​a​r​c​h​i​v​e​. */ longDesc: string - type: { - fields: { - subOption1: { - /** - * S​u​b​ ​O​p​t​i​o​n​ ​1​ ​o​f​ ​o​p​t​i​o​n​ ​1 - */ - displayName: string - /** - * S​u​b​ ​O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n - */ - shortDesc: string - /** - * S​u​b​ ​O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n - */ - longDesc: string - } - subOption2: { - /** - * S​u​b​ ​O​p​t​i​o​n​ ​2​ ​o​f​ ​o​p​t​i​o​n​ ​1 - */ - displayName: string - /** - * S​u​b​ ​O​p​t​i​o​n​ ​2​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n - */ - shortDesc: string - /** - * S​u​b​ ​O​p​t​i​o​n​ ​2​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n - */ - longDesc: string - type: { - fields: { - subSubOption1: { - /** - * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1 - */ - displayName: string - /** - * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n - */ - shortDesc: string - /** - * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n - */ - longDesc: string - } - } - } - } - subOption3: { - /** - * S​u​b​ ​O​p​t​i​o​n​ ​3​ ​o​f​ ​o​p​t​i​o​n​ ​1 - */ - displayName: string - /** - * S​u​b​ ​O​p​t​i​o​n​ ​3​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n - */ - shortDesc: string - /** - * S​u​b​ ​O​p​t​i​o​n​ ​3​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n - */ - longDesc: string - type: { - element_type: { - type: { - fields: { - subSubOption1: { - /** - * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1 - */ - displayName: string - /** - * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n - */ - shortDesc: string - /** - * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n - */ - longDesc: string - } - } - } - } - } - } - } - } - } - option2: { - /** - * S​e​c​o​n​d​ ​O​p​t​i​o​n - */ - displayName: string } } } - } - } - } -} - -export type TranslationFunctions = { - common: { - } - apps: { - CopperCrm: { - /** - * CopperCRM - */ - displayName: () => LocalizedString - groups: { - /** - * CRM & Sales Management - */ - '0': () => LocalizedString - } - /** - * Connect to CopperCRM to manage your sales pipeline, contacts, and customer relationships. - */ - shortDesc: () => LocalizedString - /** - * The CopperCRM integration provides comprehensive access to your CRM data with actions and triggers for managing leads, people, companies, opportunities, and tasks. Built specifically for Google Workspace users, CopperCRM helps you track customer interactions, manage your sales pipeline, and automate your workflow. This integration enables you to create, retrieve, update, delete, and search across all major CopperCRM entities, while triggers keep you informed of new records as they are created in your CRM. - */ - longDesc: () => LocalizedString - actions: { - create_company: { + unarchive_channel: { groups: { /** - * Companies + * C​h​a​n​n​e​l​s */ - '0': () => LocalizedString + '0': string } /** - * Create Company + * U​n​a​r​c​h​i​v​e​ ​C​h​a​n​n​e​l */ - displayName: () => LocalizedString + displayName: string /** - * Create a new company in CopperCRM + * U​n​a​r​c​h​i​v​e​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Create a new company record in CopperCRM with details like name, address, contact information, and custom fields. Companies represent organizations in your CRM. + * R​e​s​t​o​r​e​ ​a​n​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​ ​s​o​ ​i​t​ ​b​e​c​o​m​e​s​ ​a​c​t​i​v​e​ ​a​g​a​i​n​.​ ​M​e​m​b​e​r​s​ ​w​i​l​l​ ​b​e​ ​a​b​l​e​ ​t​o​ ​p​o​s​t​ ​m​e​s​s​a​g​e​s​ ​o​n​c​e​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​i​s​ ​u​n​a​r​c​h​i​v​e​d​. */ - longDesc: () => LocalizedString + longDesc: string options: { - name: { + channel: { /** - * Company Name + * C​h​a​n​n​e​l */ - displayName: () => LocalizedString + displayName: string /** - * The name of the company + * T​h​e​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​ ​t​o​ ​r​e​s​t​o​r​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The official name of the company you want to create in CopperCRM + * S​e​l​e​c​t​ ​t​h​e​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​n​a​r​c​h​i​v​e​. */ - longDesc: () => LocalizedString + longDesc: string } - address: { + } + } + list_channels: { + groups: { + /** + * C​h​a​n​n​e​l​s + */ + '0': string + } + /** + * L​i​s​t​ ​C​h​a​n​n​e​l​s + */ + displayName: string + /** + * L​i​s​t​ ​c​h​a​n​n​e​l​s​ ​i​n​ ​t​h​e​ ​w​o​r​k​s​p​a​c​e + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​c​h​a​n​n​e​l​ ​t​y​p​e​ ​a​n​d​ ​w​h​e​t​h​e​r​ ​t​o​ ​i​n​c​l​u​d​e​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​s​. + */ + longDesc: string + options: { + types: { /** - * Address + * C​h​a​n​n​e​l​ ​T​y​p​e​s */ - displayName: () => LocalizedString + displayName: string /** - * Company address details + * T​y​p​e​s​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​i​n​c​l​u​d​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The physical address of the company including street, city, state, postal code, and country + * C​o​m​m​a​-​s​e​p​a​r​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​h​a​n​n​e​l​ ​t​y​p​e​s​.​ ​O​p​t​i​o​n​s​:​ ​p​u​b​l​i​c​_​c​h​a​n​n​e​l​,​ ​p​r​i​v​a​t​e​_​c​h​a​n​n​e​l​,​ ​m​p​i​m​,​ ​i​m​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​p​u​b​l​i​c​_​c​h​a​n​n​e​l​,​p​r​i​v​a​t​e​_​c​h​a​n​n​e​l​. */ - longDesc: () => LocalizedString - type: { - fields: { - street: { - /** - * Street - */ - displayName: () => LocalizedString - /** - * Street address - */ - shortDesc: () => LocalizedString - /** - * The street address of the company - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * City name - */ - shortDesc: () => LocalizedString - /** - * The city where the company is located - */ - longDesc: () => LocalizedString - } - state: { - /** - * State - */ - displayName: () => LocalizedString - /** - * State or province - */ - shortDesc: () => LocalizedString - /** - * The state or province where the company is located - */ - longDesc: () => LocalizedString - } - postal_code: { - /** - * Postal Code - */ - displayName: () => LocalizedString - /** - * ZIP or postal code - */ - shortDesc: () => LocalizedString - /** - * The postal code or ZIP code of the company address - */ - longDesc: () => LocalizedString - } - country: { - /** - * Country - */ - displayName: () => LocalizedString - /** - * Country name - */ - shortDesc: () => LocalizedString - /** - * The country where the company is located - */ - longDesc: () => LocalizedString - } - } - } + longDesc: string } - assignee_id: { + excludeArchived: { /** - * Assignee + * E​x​c​l​u​d​e​ ​A​r​c​h​i​v​e​d */ - displayName: () => LocalizedString + displayName: string /** - * User assigned to this company + * E​x​c​l​u​d​e​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The CopperCRM user who will be assigned to manage this company + * I​f​ ​e​n​a​b​l​e​d​,​ ​a​r​c​h​i​v​e​d​ ​c​h​a​n​n​e​l​s​ ​a​r​e​ ​e​x​c​l​u​d​e​d​ ​f​r​o​m​ ​t​h​e​ ​r​e​s​u​l​t​s​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​t​r​u​e​. */ - longDesc: () => LocalizedString + longDesc: string } - contact_type_id: { + limit: { /** - * Contact Type + * L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Type of contact relationship + * M​a​x​i​m​u​m​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​r​e​t​u​r​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The type of contact relationship this company has with your organization + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​h​a​n​n​e​l​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​2​0​0​. */ - longDesc: () => LocalizedString + longDesc: string } - details: { + } + } + add_reaction: { + groups: { + /** + * R​e​a​c​t​i​o​n​s + */ + '0': string + } + /** + * A​d​d​ ​R​e​a​c​t​i​o​n + */ + displayName: string + /** + * A​d​d​ ​a​n​ ​e​m​o​j​i​ ​r​e​a​c​t​i​o​n​ ​t​o​ ​a​ ​m​e​s​s​a​g​e + */ + shortDesc: string + /** + * A​d​d​ ​a​n​ ​e​m​o​j​i​ ​r​e​a​c​t​i​o​n​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​m​e​s​s​a​g​e​ ​i​n​ ​a​ ​c​h​a​n​n​e​l​. + */ + longDesc: string + options: { + channel: { /** - * Details + * C​h​a​n​n​e​l */ - displayName: () => LocalizedString + displayName: string /** - * Additional notes or description + * T​h​e​ ​c​h​a​n​n​e​l​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​m​e​s​s​a​g​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Additional notes, description, or important details about the company + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​i​s​ ​l​o​c​a​t​e​d​. */ - longDesc: () => LocalizedString + longDesc: string } - email_domain: { + timestamp: { /** - * Email Domain + * M​e​s​s​a​g​e​ ​T​i​m​e​s​t​a​m​p */ - displayName: () => LocalizedString + displayName: string /** - * Company email domain + * T​i​m​e​s​t​a​m​p​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The primary email domain used by the company (e.g., example.com) + * T​h​e​ ​t​i​m​e​s​t​a​m​p​ ​(​t​s​)​ ​o​f​ ​t​h​e​ ​m​e​s​s​a​g​e​ ​t​o​ ​r​e​a​c​t​ ​t​o​.​ ​Y​o​u​ ​c​a​n​ ​a​l​s​o​ ​p​a​s​t​e​ ​a​ ​S​l​a​c​k​ ​m​e​s​s​a​g​e​ ​l​i​n​k​. */ - longDesc: () => LocalizedString + longDesc: string } - phone_numbers: { + reaction: { /** - * Phone Numbers + * R​e​a​c​t​i​o​n */ - displayName: () => LocalizedString + displayName: string /** - * Company phone numbers + * E​m​o​j​i​ ​n​a​m​e​ ​t​o​ ​a​d​d */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of phone numbers associated with the company + * T​h​e​ ​e​m​o​j​i​ ​n​a​m​e​ ​w​i​t​h​o​u​t​ ​c​o​l​o​n​s​ ​(​e​.​g​.​,​ ​"​t​h​u​m​b​s​u​p​"​,​ ​"​f​i​r​e​"​,​ ​"​s​m​i​l​e​"​)​. */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - number: { - /** - * Phone Number - */ - displayName: () => LocalizedString - /** - * The phone number - */ - shortDesc: () => LocalizedString - /** - * The phone number in any format - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of phone number - */ - shortDesc: () => LocalizedString - /** - * The category or type of this phone number (work, mobile, home, or other) - */ - longDesc: () => LocalizedString - } - } - } - } + longDesc: string } - primary_contact_id: { + } + } + find_user_by_email: { + groups: { + /** + * U​s​e​r​s + */ + '0': string + } + /** + * F​i​n​d​ ​U​s​e​r​ ​b​y​ ​E​m​a​i​l + */ + displayName: string + /** + * F​i​n​d​ ​a​ ​S​l​a​c​k​ ​u​s​e​r​ ​b​y​ ​t​h​e​i​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + */ + shortDesc: string + /** + * L​o​o​k​ ​u​p​ ​a​ ​S​l​a​c​k​ ​u​s​e​r​ ​u​s​i​n​g​ ​t​h​e​i​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​.​ ​R​e​t​u​r​n​s​ ​t​h​e​ ​u​s​e​r​ ​p​r​o​f​i​l​e​ ​i​f​ ​f​o​u​n​d​. + */ + longDesc: string + options: { + email: { /** - * Primary Contact + * E​m​a​i​l */ - displayName: () => LocalizedString + displayName: string /** - * Main contact person + * E​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​s​e​a​r​c​h​ ​f​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The primary contact person associated with this company + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​o​f​ ​t​h​e​ ​u​s​e​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​f​i​n​d​. */ - longDesc: () => LocalizedString + longDesc: string } - socials: { + } + } + update_profile: { + groups: { + /** + * U​s​e​r​s + */ + '0': string + } + /** + * U​p​d​a​t​e​ ​P​r​o​f​i​l​e + */ + displayName: string + /** + * U​p​d​a​t​e​ ​u​s​e​r​ ​p​r​o​f​i​l​e​ ​i​n​f​o​r​m​a​t​i​o​n + */ + shortDesc: string + /** + * U​p​d​a​t​e​ ​b​a​s​i​c​ ​p​r​o​f​i​l​e​ ​f​i​e​l​d​s​ ​s​u​c​h​ ​a​s​ ​n​a​m​e​ ​o​r​ ​t​i​t​l​e​.​ ​R​e​q​u​i​r​e​s​ ​u​s​e​r​ ​t​o​k​e​n​ ​a​u​t​h​e​n​t​i​c​a​t​i​o​n​. + */ + longDesc: string + options: { + firstName: { /** - * Social Media + * F​i​r​s​t​ ​N​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Social media profiles + * U​s​e​r​ ​f​i​r​s​t​ ​n​a​m​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of social media profiles for the company + * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​t​o​ ​s​e​t​ ​i​n​ ​t​h​e​ ​p​r​o​f​i​l​e​. */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Social media profile URL - */ - shortDesc: () => LocalizedString - /** - * The full URL to the social media profile - */ - longDesc: () => LocalizedString - } - category: { - /** - * Platform - */ - displayName: () => LocalizedString - /** - * Social media platform - */ - shortDesc: () => LocalizedString - /** - * The social media platform (LinkedIn, Twitter, Facebook, YouTube, Quora, Instagram, Pinterest, or Other) - */ - longDesc: () => LocalizedString - } - } - } - } + longDesc: string } - tags: { + lastName: { /** - * Tags + * L​a​s​t​ ​N​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Company tags + * U​s​e​r​ ​l​a​s​t​ ​n​a​m​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Tags to categorize and organize the company. You can create new tags or select from existing ones. + * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​t​o​ ​s​e​t​ ​i​n​ ​t​h​e​ ​p​r​o​f​i​l​e​. */ - longDesc: () => LocalizedString + longDesc: string } - websites: { + email: { /** - * Websites + * E​m​a​i​l */ - displayName: () => LocalizedString + displayName: string /** - * Company websites + * U​s​e​r​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of websites associated with the company + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​t​o​ ​s​e​t​.​ ​C​h​a​n​g​i​n​g​ ​e​m​a​i​l​ ​w​i​l​l​ ​s​e​n​d​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​t​o​ ​b​o​t​h​ ​o​l​d​ ​a​n​d​ ​n​e​w​ ​a​d​d​r​e​s​s​e​s​. */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Website URL - */ - shortDesc: () => LocalizedString - /** - * The full URL of the website - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of website - */ - shortDesc: () => LocalizedString - /** - * The category or purpose of this website (work, personal, or other) - */ - longDesc: () => LocalizedString - } - } - } - } + longDesc: string } - custom_fields: { + userId: { /** - * Custom Fields + * U​s​e​r​ ​I​D */ - displayName: () => LocalizedString + displayName: string /** - * Custom field values + * T​a​r​g​e​t​ ​u​s​e​r​ ​(​a​d​m​i​n​ ​o​n​l​y​) */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Custom field values specific to your CopperCRM company configuration + * I​D​ ​o​f​ ​u​s​e​r​ ​t​o​ ​u​p​d​a​t​e​.​ ​O​n​l​y​ ​a​d​m​i​n​s​ ​o​n​ ​p​a​i​d​ ​t​e​a​m​s​ ​c​a​n​ ​u​p​d​a​t​e​ ​o​t​h​e​r​ ​u​s​e​r​s​. */ - longDesc: () => LocalizedString + longDesc: string } } } - create_lead: { + list_users: { groups: { /** - * Leads + * U​s​e​r​s */ - '0': () => LocalizedString + '0': string } /** - * Create Lead + * L​i​s​t​ ​U​s​e​r​s */ - displayName: () => LocalizedString + displayName: string /** - * Create a new lead in CopperCRM + * L​i​s​t​ ​u​s​e​r​s​ ​i​n​ ​t​h​e​ ​w​o​r​k​s​p​a​c​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Create a new lead record in CopperCRM with contact information and details. Leads represent potential customers who have shown interest in your products or services. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​u​s​e​r​s​ ​i​n​ ​y​o​u​r​ ​S​l​a​c​k​ ​w​o​r​k​s​p​a​c​e​ ​i​n​c​l​u​d​i​n​g​ ​t​h​e​i​r​ ​p​r​o​f​i​l​e​ ​i​n​f​o​r​m​a​t​i​o​n​. */ - longDesc: () => LocalizedString + longDesc: string options: { - first_name: { - /** - * First Name - */ - displayName: () => LocalizedString - /** - * Lead's first name - */ - shortDesc: () => LocalizedString - /** - * The first name of the lead - */ - longDesc: () => LocalizedString - } - last_name: { + limit: { /** - * Last Name + * L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Lead's last name + * M​a​x​i​m​u​m​ ​u​s​e​r​s​ ​t​o​ ​r​e​t​u​r​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The last name of the lead + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​u​s​e​r​s​ ​t​o​ ​r​e​t​r​i​e​v​e​.​ ​D​e​f​a​u​l​t​ ​i​s​ ​2​0​0​. */ - longDesc: () => LocalizedString + longDesc: string } - middle_name: { + } + } + get_user_info: { + groups: { + /** + * U​s​e​r​s + */ + '0': string + } + /** + * G​e​t​ ​U​s​e​r​ ​I​n​f​o + */ + displayName: string + /** + * G​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​u​s​e​r + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​p​r​o​f​i​l​e​ ​a​n​d​ ​a​c​c​o​u​n​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​S​l​a​c​k​ ​u​s​e​r​ ​b​y​ ​t​h​e​i​r​ ​u​s​e​r​ ​I​D​. + */ + longDesc: string + options: { + userId: { /** - * Middle Name + * U​s​e​r */ - displayName: () => LocalizedString + displayName: string /** - * Lead's middle name + * T​h​e​ ​u​s​e​r​ ​t​o​ ​g​e​t​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The middle name or initial of the lead + * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​w​h​o​s​e​ ​i​n​f​o​r​m​a​t​i​o​n​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e​. */ - longDesc: () => LocalizedString + longDesc: string } - suffix: { + } + } + upload_file: { + groups: { + /** + * F​i​l​e​s + */ + '0': string + } + /** + * U​p​l​o​a​d​ ​F​i​l​e + */ + displayName: string + /** + * U​p​l​o​a​d​ ​a​ ​f​i​l​e​ ​t​o​ ​S​l​a​c​k + */ + shortDesc: string + /** + * U​p​l​o​a​d​ ​a​ ​f​i​l​e​ ​t​o​ ​a​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l​.​ ​S​u​p​p​o​r​t​s​ ​v​a​r​i​o​u​s​ ​f​i​l​e​ ​t​y​p​e​s​ ​a​n​d​ ​o​p​t​i​o​n​a​l​ ​i​n​i​t​i​a​l​ ​c​o​m​m​e​n​t​. + */ + longDesc: string + options: { + channel: { /** - * Suffix + * C​h​a​n​n​e​l */ - displayName: () => LocalizedString + displayName: string /** - * Name suffix + * C​h​a​n​n​e​l​ ​t​o​ ​u​p​l​o​a​d​ ​t​o */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Name suffix such as Jr., Sr., III, etc. + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​f​i​l​e​ ​s​h​o​u​l​d​ ​b​e​ ​u​p​l​o​a​d​e​d​. */ - longDesc: () => LocalizedString + longDesc: string } - assignee_id: { + file: { /** - * Assignee + * F​i​l​e */ - displayName: () => LocalizedString + displayName: string /** - * User assigned to this lead + * T​h​e​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The CopperCRM user who will be assigned to manage this lead + * T​h​e​ ​f​i​l​e​ ​t​o​ ​u​p​l​o​a​d​ ​t​o​ ​t​h​e​ ​S​l​a​c​k​ ​c​h​a​n​n​e​l​. */ - longDesc: () => LocalizedString + longDesc: string } - company_name: { + filename: { /** - * Company Name + * F​i​l​e​n​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Lead's company name + * N​a​m​e​ ​f​o​r​ ​t​h​e​ ​f​i​l​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The name of the company where the lead works + * T​h​e​ ​f​i​l​e​n​a​m​e​ ​t​o​ ​u​s​e​ ​w​h​e​n​ ​u​p​l​o​a​d​i​n​g​. */ - longDesc: () => LocalizedString + longDesc: string } - tags: { + comment: { /** - * Tags + * I​n​i​t​i​a​l​ ​C​o​m​m​e​n​t */ - displayName: () => LocalizedString + displayName: string /** - * Lead tags + * C​o​m​m​e​n​t​ ​w​i​t​h​ ​t​h​e​ ​f​i​l​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Tags to categorize and organize the lead. You can create new tags or select from existing ones. + * A​n​ ​o​p​t​i​o​n​a​l​ ​c​o​m​m​e​n​t​ ​t​o​ ​i​n​c​l​u​d​e​ ​w​h​e​n​ ​s​h​a​r​i​n​g​ ​t​h​e​ ​f​i​l​e​. */ - longDesc: () => LocalizedString + longDesc: string } - title: { + } + } + request_action_message: { + groups: { + /** + * M​e​s​s​a​g​e​s + */ + '0': string + } + /** + * S​e​n​d​ ​A​c​t​i​o​n​ ​M​e​s​s​a​g​e​ ​t​o​ ​C​h​a​n​n​e​l + */ + displayName: string + /** + * S​e​n​d​ ​a​ ​m​e​s​s​a​g​e​ ​w​i​t​h​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s + */ + shortDesc: string + /** + * S​e​n​d​ ​a​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​c​h​a​n​n​e​l​ ​w​i​t​h​ ​i​n​t​e​r​a​c​t​i​v​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​ ​t​h​a​t​ ​l​i​n​k​ ​t​o​ ​U​R​L​s​. + */ + longDesc: string + options: { + channel: { /** - * Title + * C​h​a​n​n​e​l */ - displayName: () => LocalizedString + displayName: string /** - * Job title + * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​s​e​n​d​ ​t​o */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The job title or position of the lead + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​w​h​e​r​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​m​e​s​s​a​g​e​ ​s​h​o​u​l​d​ ​b​e​ ​p​o​s​t​e​d​. */ - longDesc: () => LocalizedString + longDesc: string } - details: { + text: { /** - * Details + * M​e​s​s​a​g​e​ ​T​e​x​t */ - displayName: () => LocalizedString + displayName: string /** - * Additional notes + * T​h​e​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Additional notes, description, or important details about the lead + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​d​i​s​p​l​a​y​e​d​ ​a​b​o​v​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​. */ - longDesc: () => LocalizedString + longDesc: string } - websites: { + actions: { /** - * Websites + * A​c​t​i​o​n​ ​B​u​t​t​o​n​s */ - displayName: () => LocalizedString + displayName: string /** - * Associated websites + * B​u​t​t​o​n​s​ ​t​o​ ​d​i​s​p​l​a​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of websites associated with the lead + * D​e​f​i​n​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​ ​w​i​t​h​ ​t​i​t​l​e​s​ ​a​n​d​ ​U​R​L​s​.​ ​E​a​c​h​ ​b​u​t​t​o​n​ ​l​i​n​k​s​ ​t​o​ ​a​ ​s​p​e​c​i​f​i​c​ ​U​R​L​ ​w​h​e​n​ ​c​l​i​c​k​e​d​. */ - longDesc: () => LocalizedString + longDesc: string type: { element_type: { fields: { - url: { + title: { /** - * URL + * B​u​t​t​o​n​ ​T​i​t​l​e */ - displayName: () => LocalizedString + displayName: string /** - * Website URL + * T​e​x​t​ ​d​i​s​p​l​a​y​e​d​ ​o​n​ ​t​h​e​ ​b​u​t​t​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The full URL of the website + * T​h​e​ ​t​e​x​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​h​o​w​n​ ​o​n​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​. */ - longDesc: () => LocalizedString + longDesc: string } - category: { + url: { /** - * Category + * B​u​t​t​o​n​ ​U​R​L */ - displayName: () => LocalizedString + displayName: string /** - * Type of website + * U​R​L​ ​t​h​e​ ​b​u​t​t​o​n​ ​l​i​n​k​s​ ​t​o */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The category or purpose of this website (work, personal, or other) + * T​h​e​ ​U​R​L​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​o​p​e​n​e​d​ ​w​h​e​n​ ​t​h​e​ ​b​u​t​t​o​n​ ​i​s​ ​c​l​i​c​k​e​d​. */ - longDesc: () => LocalizedString + longDesc: string } } } } } - socials: { + username: { /** - * Social Media + * B​o​t​ ​U​s​e​r​n​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Social media profiles + * C​u​s​t​o​m​ ​b​o​t​ ​n​a​m​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of social media profiles for the lead + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​u​s​e​r​n​a​m​e​. */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Social media profile URL - */ - shortDesc: () => LocalizedString - /** - * The full URL to the social media profile - */ - longDesc: () => LocalizedString - } - category: { - /** - * Platform - */ - displayName: () => LocalizedString - /** - * Social media platform - */ - shortDesc: () => LocalizedString - /** - * The social media platform (LinkedIn, Twitter, Facebook, YouTube, Quora, Instagram, Pinterest, or Other) - */ - longDesc: () => LocalizedString - } - } - } - } + longDesc: string } - email: { + iconUrl: { /** - * Email + * I​c​o​n​ ​U​R​L */ - displayName: () => LocalizedString + displayName: string /** - * Email address + * C​u​s​t​o​m​ ​b​o​t​ ​i​c​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The email address of the lead + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​i​c​o​n​. */ - longDesc: () => LocalizedString - type: { - fields: { - email: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * The email address - */ - shortDesc: () => LocalizedString - /** - * The email address of the lead - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of email - */ - shortDesc: () => LocalizedString - /** - * The category or type of this email (work, personal, or other) - */ - longDesc: () => LocalizedString - } - } - } + longDesc: string } - phone_numbers: { + } + } + request_action_dm: { + groups: { + /** + * M​e​s​s​a​g​e​s + */ + '0': string + } + /** + * S​e​n​d​ ​A​c​t​i​o​n​ ​M​e​s​s​a​g​e​ ​t​o​ ​U​s​e​r + */ + displayName: string + /** + * S​e​n​d​ ​a​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​ ​w​i​t​h​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s + */ + shortDesc: string + /** + * S​e​n​d​ ​a​ ​d​i​r​e​c​t​ ​m​e​s​s​a​g​e​ ​t​o​ ​a​ ​u​s​e​r​ ​w​i​t​h​ ​i​n​t​e​r​a​c​t​i​v​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​ ​t​h​a​t​ ​l​i​n​k​ ​t​o​ ​U​R​L​s​. + */ + longDesc: string + options: { + userId: { /** - * Phone Numbers + * U​s​e​r */ - displayName: () => LocalizedString + displayName: string /** - * Contact phone numbers + * T​h​e​ ​u​s​e​r​ ​t​o​ ​m​e​s​s​a​g​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of phone numbers for the lead + * S​e​l​e​c​t​ ​t​h​e​ ​u​s​e​r​ ​t​o​ ​r​e​c​e​i​v​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​m​e​s​s​a​g​e​. */ - longDesc: () => LocalizedString + longDesc: string + } + text: { + /** + * M​e​s​s​a​g​e​ ​T​e​x​t + */ + displayName: string + /** + * T​h​e​ ​m​e​s​s​a​g​e​ ​c​o​n​t​e​n​t + */ + shortDesc: string + /** + * T​h​e​ ​t​e​x​t​ ​c​o​n​t​e​n​t​ ​d​i​s​p​l​a​y​e​d​ ​a​b​o​v​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​. + */ + longDesc: string + } + actions: { + /** + * A​c​t​i​o​n​ ​B​u​t​t​o​n​s + */ + displayName: string + /** + * B​u​t​t​o​n​s​ ​t​o​ ​d​i​s​p​l​a​y + */ + shortDesc: string + /** + * D​e​f​i​n​e​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​s​ ​w​i​t​h​ ​t​i​t​l​e​s​ ​a​n​d​ ​U​R​L​s​. + */ + longDesc: string type: { element_type: { fields: { - number: { + title: { /** - * Phone Number + * B​u​t​t​o​n​ ​T​i​t​l​e */ - displayName: () => LocalizedString + displayName: string /** - * The phone number + * T​e​x​t​ ​d​i​s​p​l​a​y​e​d​ ​o​n​ ​t​h​e​ ​b​u​t​t​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The phone number in any format + * T​h​e​ ​t​e​x​t​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​s​h​o​w​n​ ​o​n​ ​t​h​e​ ​a​c​t​i​o​n​ ​b​u​t​t​o​n​. */ - longDesc: () => LocalizedString + longDesc: string } - category: { + url: { /** - * Category + * B​u​t​t​o​n​ ​U​R​L */ - displayName: () => LocalizedString + displayName: string /** - * Type of phone number + * U​R​L​ ​t​h​e​ ​b​u​t​t​o​n​ ​l​i​n​k​s​ ​t​o */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The category or type of this phone number + * T​h​e​ ​U​R​L​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​o​p​e​n​e​d​ ​w​h​e​n​ ​t​h​e​ ​b​u​t​t​o​n​ ​i​s​ ​c​l​i​c​k​e​d​. */ - longDesc: () => LocalizedString + longDesc: string } } } } } - address: { + username: { /** - * Address + * B​o​t​ ​U​s​e​r​n​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Contact address + * C​u​s​t​o​m​ ​b​o​t​ ​n​a​m​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The physical address of the lead including street, city, state, postal code, and country + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​u​s​e​r​n​a​m​e​. */ - longDesc: () => LocalizedString - type: { - fields: { - street: { - /** - * Street - */ - displayName: () => LocalizedString - /** - * Street address - */ - shortDesc: () => LocalizedString - /** - * The street address - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * City name - */ - shortDesc: () => LocalizedString - /** - * The city where the lead is located - */ - longDesc: () => LocalizedString - } - state: { - /** - * State - */ - displayName: () => LocalizedString - /** - * State or province - */ - shortDesc: () => LocalizedString - /** - * The state or province - */ - longDesc: () => LocalizedString - } - postal_code: { - /** - * Postal Code - */ - displayName: () => LocalizedString - /** - * ZIP or postal code - */ - shortDesc: () => LocalizedString - /** - * The postal code or ZIP code - */ - longDesc: () => LocalizedString - } - country: { - /** - * Country - */ - displayName: () => LocalizedString - /** - * Country name - */ - shortDesc: () => LocalizedString - /** - * The country - */ - longDesc: () => LocalizedString - } - } - } + longDesc: string } - customer_source_id: { + iconUrl: { /** - * Customer Source + * I​c​o​n​ ​U​R​L */ - displayName: () => LocalizedString + displayName: string /** - * How the lead was acquired + * C​u​s​t​o​m​ ​b​o​t​ ​i​c​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The source or channel through which this lead was acquired + * O​v​e​r​r​i​d​e​ ​t​h​e​ ​d​e​f​a​u​l​t​ ​b​o​t​ ​i​c​o​n​. */ - longDesc: () => LocalizedString + longDesc: string } - custom_fields: { + } + } + } + triggers: { + new_message: { + groups: { + /** + * M​e​s​s​a​g​e​s + */ + '0': string + } + /** + * N​e​w​ ​M​e​s​s​a​g​e + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​i​s​ ​p​o​s​t​e​d​ ​t​o​ ​a​ ​c​h​a​n​n​e​l + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​m​e​s​s​a​g​e​ ​i​s​ ​p​o​s​t​e​d​ ​t​o​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​h​a​n​n​e​l​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​r​e​a​c​t​ ​t​o​ ​i​n​c​o​m​i​n​g​ ​m​e​s​s​a​g​e​s​. + */ + longDesc: string + options: { + channel: { /** - * Custom Fields + * C​h​a​n​n​e​l */ - displayName: () => LocalizedString + displayName: string /** - * Custom field values + * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Custom field values specific to your CopperCRM lead configuration + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​m​e​s​s​a​g​e​s​.​ ​M​a​k​e​ ​s​u​r​e​ ​t​h​e​ ​b​o​t​ ​i​s​ ​a​ ​m​e​m​b​e​r​ ​o​f​ ​t​h​e​ ​c​h​a​n​n​e​l​. */ - longDesc: () => LocalizedString + longDesc: string } } } - create_opportunity: { + new_reaction: { groups: { /** - * Opportunities + * R​e​a​c​t​i​o​n​s */ - '0': () => LocalizedString + '0': string } /** - * Create Opportunity + * N​e​w​ ​R​e​a​c​t​i​o​n */ - displayName: () => LocalizedString + displayName: string /** - * Create a new opportunity in CopperCRM + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​r​e​a​c​t​i​o​n​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​ ​m​e​s​s​a​g​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Create a new sales opportunity in CopperCRM with details like value, stage, and associated contacts. Opportunities represent potential deals in your sales pipeline. + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​r​e​a​c​t​i​o​n​ ​i​s​ ​a​d​d​e​d​ ​t​o​ ​a​n​y​ ​m​e​s​s​a​g​e​.​ ​Y​o​u​ ​c​a​n​ ​f​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​e​m​o​j​i​s​ ​o​r​ ​c​h​a​n​n​e​l​s​. */ - longDesc: () => LocalizedString + longDesc: string options: { - name: { + emojis: { /** - * Opportunity Name + * E​m​o​j​i​s */ - displayName: () => LocalizedString + displayName: string /** - * Name of the opportunity + * F​i​l​t​e​r​ ​b​y​ ​s​p​e​c​i​f​i​c​ ​e​m​o​j​i​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * A descriptive name for the sales opportunity + * O​p​t​i​o​n​a​l​l​y​ ​s​p​e​c​i​f​y​ ​e​m​o​j​i​ ​n​a​m​e​s​ ​t​o​ ​t​r​i​g​g​e​r​ ​o​n​ ​(​e​.​g​.​,​ ​"​f​i​r​e​"​,​ ​"​t​h​u​m​b​s​u​p​"​)​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​f​o​r​ ​a​l​l​ ​r​e​a​c​t​i​o​n​s​. */ - longDesc: () => LocalizedString + longDesc: string } - primary_contact_id: { + channel: { /** - * Primary Contact + * C​h​a​n​n​e​l */ - displayName: () => LocalizedString + displayName: string /** - * Main contact person + * F​i​l​t​e​r​ ​b​y​ ​c​h​a​n​n​e​l */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The primary contact person associated with this opportunity + * O​p​t​i​o​n​a​l​l​y​ ​s​e​l​e​c​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​.​ ​L​e​a​v​e​ ​e​m​p​t​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​a​l​l​ ​c​h​a​n​n​e​l​s​. */ - longDesc: () => LocalizedString + longDesc: string } - assignee_id: { + } + } + channel_created: { + groups: { + /** + * C​h​a​n​n​e​l​s + */ + '0': string + } + /** + * C​h​a​n​n​e​l​ ​C​r​e​a​t​e​d + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​c​h​a​n​n​e​l​ ​i​s​ ​c​r​e​a​t​e​d + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​a​ ​n​e​w​ ​p​u​b​l​i​c​ ​o​r​ ​p​r​i​v​a​t​e​ ​c​h​a​n​n​e​l​ ​i​s​ ​c​r​e​a​t​e​d​ ​i​n​ ​t​h​e​ ​w​o​r​k​s​p​a​c​e​. + */ + longDesc: string + options: { + } + } + app_mention: { + groups: { + /** + * M​e​s​s​a​g​e​s + */ + '0': string + } + /** + * A​p​p​ ​M​e​n​t​i​o​n + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​t​h​e​ ​b​o​t​ ​i​s​ ​m​e​n​t​i​o​n​e​d​ ​i​n​ ​a​ ​c​h​a​n​n​e​l + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​e​v​e​r​ ​s​o​m​e​o​n​e​ ​m​e​n​t​i​o​n​s​ ​t​h​e​ ​b​o​t​ ​i​n​ ​a​ ​m​e​s​s​a​g​e​ ​i​n​ ​t​h​e​ ​s​p​e​c​i​f​i​e​d​ ​c​h​a​n​n​e​l​.​ ​U​s​e​ ​t​h​i​s​ ​t​o​ ​r​e​s​p​o​n​d​ ​t​o​ ​d​i​r​e​c​t​ ​r​e​q​u​e​s​t​s​. + */ + longDesc: string + options: { + channel: { /** - * Assignee + * C​h​a​n​n​e​l */ - displayName: () => LocalizedString + displayName: string /** - * User assigned to this opportunity + * T​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​m​e​n​t​i​o​n​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The CopperCRM user who will be assigned to manage this opportunity + * S​e​l​e​c​t​ ​t​h​e​ ​c​h​a​n​n​e​l​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​b​o​t​ ​m​e​n​t​i​o​n​s​.​ ​M​a​k​e​ ​s​u​r​e​ ​t​h​e​ ​b​o​t​ ​i​s​ ​a​ ​m​e​m​b​e​r​ ​o​f​ ​t​h​e​ ​c​h​a​n​n​e​l​. */ - longDesc: () => LocalizedString + longDesc: string } - close_date: { + } + } + } + } + SurveyMonkey: { + /** + * S​u​r​v​e​y​M​o​n​k​e​y + */ + displayName: string + groups: { + /** + * F​o​r​m​s​,​ ​S​u​r​v​e​y​s​ ​&​ ​S​c​h​e​d​u​l​i​n​g + */ + '0': string + } + /** + * O​n​l​i​n​e​ ​s​u​r​v​e​y​ ​p​l​a​t​f​o​r​m​ ​f​o​r​ ​c​o​l​l​e​c​t​i​n​g​ ​f​e​e​d​b​a​c​k​ ​a​n​d​ ​r​e​s​p​o​n​s​e​s + */ + shortDesc: string + /** + * C​o​n​n​e​c​t​ ​y​o​u​r​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​a​c​c​o​u​n​t​ ​t​o​ ​a​u​t​o​m​a​t​e​ ​s​u​r​v​e​y​ ​m​a​n​a​g​e​m​e​n​t​,​ ​c​o​l​l​e​c​t​ ​r​e​s​p​o​n​s​e​s​,​ ​a​n​d​ ​m​a​n​a​g​e​ ​c​o​n​t​a​c​t​s​.​ ​C​r​e​a​t​e​ ​c​o​l​l​e​c​t​o​r​s​,​ ​s​e​n​d​ ​s​u​r​v​e​y​s​,​ ​r​e​t​r​i​e​v​e​ ​r​e​s​p​o​n​s​e​s​,​ ​a​n​d​ ​s​e​t​ ​u​p​ ​w​e​b​h​o​o​k​s​ ​f​o​r​ ​r​e​a​l​-​t​i​m​e​ ​r​e​s​p​o​n​s​e​ ​n​o​t​i​f​i​c​a​t​i​o​n​s​ ​a​l​l​ ​f​r​o​m​ ​w​i​t​h​i​n​ ​Q​o​r​e​. + */ + longDesc: string + triggers: { + new_response: { + /** + * N​e​w​ ​R​e​s​p​o​n​s​e + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​n​e​w​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​ ​i​s​ ​c​o​m​p​l​e​t​e​d + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​r​e​s​p​o​n​d​e​n​t​ ​c​o​m​p​l​e​t​e​s​ ​a​ ​s​u​r​v​e​y​.​ ​T​h​e​ ​w​e​b​h​o​o​k​ ​p​a​y​l​o​a​d​ ​i​n​c​l​u​d​e​s​ ​b​a​s​i​c​ ​r​e​s​p​o​n​s​e​ ​i​n​f​o​r​m​a​t​i​o​n​.​ ​U​s​e​ ​t​h​e​ ​"​G​e​t​ ​R​e​s​p​o​n​s​e​"​ ​a​c​t​i​o​n​ ​t​o​ ​f​e​t​c​h​ ​d​e​t​a​i​l​e​d​ ​r​e​s​p​o​n​s​e​ ​d​a​t​a​ ​i​n​c​l​u​d​i​n​g​ ​a​n​s​w​e​r​s​. + */ + longDesc: string + options: { + survey_id: { /** - * Close Date + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Expected close date + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​n​e​w​ ​r​e​s​p​o​n​s​e​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The expected date when this opportunity will be closed or won + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​m​p​l​e​t​e​d​ ​r​e​s​p​o​n​s​e​s */ - longDesc: () => LocalizedString + longDesc: string } - company_id: { + } + } + response_disqualified: { + /** + * R​e​s​p​o​n​s​e​ ​D​i​s​q​u​a​l​i​f​i​e​d + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​r​e​s​p​o​n​d​e​n​t​ ​i​s​ ​d​i​s​q​u​a​l​i​f​i​e​d​ ​f​r​o​m​ ​a​ ​s​u​r​v​e​y + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​r​e​s​p​o​n​d​e​n​t​ ​i​s​ ​s​c​r​e​e​n​e​d​ ​o​u​t​ ​o​r​ ​d​i​s​q​u​a​l​i​f​i​e​d​ ​f​r​o​m​ ​a​ ​s​u​r​v​e​y​ ​b​a​s​e​d​ ​o​n​ ​t​h​e​i​r​ ​a​n​s​w​e​r​s​ ​t​o​ ​q​u​a​l​i​f​y​i​n​g​ ​q​u​e​s​t​i​o​n​s​. + */ + longDesc: string + options: { + survey_id: { /** - * Company + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Associated company + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​d​i​s​q​u​a​l​i​f​i​e​d​ ​r​e​s​p​o​n​s​e​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The company associated with this opportunity + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​d​i​s​q​u​a​l​i​f​i​e​d​ ​r​e​s​p​o​n​s​e​s */ - longDesc: () => LocalizedString + longDesc: string } - customer_source_id: { + } + } + response_updated: { + /** + * R​e​s​p​o​n​s​e​ ​U​p​d​a​t​e​d + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​ ​i​s​ ​u​p​d​a​t​e​d + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​ ​i​s​ ​m​o​d​i​f​i​e​d​ ​o​r​ ​u​p​d​a​t​e​d​.​ ​U​s​e​f​u​l​ ​f​o​r​ ​t​r​a​c​k​i​n​g​ ​p​a​r​t​i​a​l​ ​r​e​s​p​o​n​s​e​s​ ​o​r​ ​r​e​s​p​o​n​s​e​ ​e​d​i​t​s​. + */ + longDesc: string + options: { + survey_id: { /** - * Customer Source + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * How the opportunity was acquired + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​u​p​d​a​t​e​d​ ​r​e​s​p​o​n​s​e​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The source or channel through which this opportunity was acquired + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​u​p​d​a​t​e​d​ ​r​e​s​p​o​n​s​e​s */ - longDesc: () => LocalizedString + longDesc: string } - details: { + } + } + collector_updated: { + /** + * C​o​l​l​e​c​t​o​r​ ​U​p​d​a​t​e​d + */ + displayName: string + /** + * T​r​i​g​g​e​r​s​ ​w​h​e​n​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​i​s​ ​u​p​d​a​t​e​d + */ + shortDesc: string + /** + * T​h​i​s​ ​t​r​i​g​g​e​r​ ​f​i​r​e​s​ ​w​h​e​n​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​(​d​i​s​t​r​i​b​u​t​i​o​n​ ​m​e​t​h​o​d​)​ ​f​o​r​ ​a​ ​s​u​r​v​e​y​ ​i​s​ ​m​o​d​i​f​i​e​d​,​ ​s​u​c​h​ ​a​s​ ​s​t​a​t​u​s​ ​c​h​a​n​g​e​s​ ​o​r​ ​c​o​n​f​i​g​u​r​a​t​i​o​n​ ​u​p​d​a​t​e​s​. + */ + longDesc: string + options: { + survey_id: { /** - * Details + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Additional notes + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​l​l​e​c​t​o​r​ ​u​p​d​a​t​e​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Additional notes, description, or important details about the opportunity + * S​e​l​e​c​t​ ​t​h​e​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​n​i​t​o​r​ ​f​o​r​ ​c​o​l​l​e​c​t​o​r​ ​c​h​a​n​g​e​s */ - longDesc: () => LocalizedString + longDesc: string } - loss_reason_id: { + } + } + } + actions: { + create_contact: { + groups: { + /** + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * C​r​e​a​t​e​ ​C​o​n​t​a​c​t + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​w​i​t​h​ ​f​i​r​s​t​ ​n​a​m​e​,​ ​l​a​s​t​ ​n​a​m​e​,​ ​e​m​a​i​l​,​ ​o​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r + */ + longDesc: string + options: { + first_name: { /** - * Loss Reason + * F​i​r​s​t​ ​N​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Reason for losing + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​f​i​r​s​t​ ​n​a​m​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The reason why this opportunity was lost (if applicable) + * T​h​e​ ​f​i​r​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ - longDesc: () => LocalizedString + longDesc: string } - monetary_value: { + last_name: { /** - * Monetary Value + * L​a​s​t​ ​N​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Deal value + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​l​a​s​t​ ​n​a​m​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The monetary value of the opportunity in your default currency + * T​h​e​ ​l​a​s​t​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t */ - longDesc: () => LocalizedString + longDesc: string } - pipeline_id: { + email: { /** - * Pipeline + * E​m​a​i​l */ - displayName: () => LocalizedString + displayName: string /** - * Sales pipeline + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The sales pipeline this opportunity belongs to + * T​h​e​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​(​e​i​t​h​e​r​ ​e​m​a​i​l​ ​o​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​i​s​ ​r​e​q​u​i​r​e​d​) */ - longDesc: () => LocalizedString + longDesc: string } - pipeline_stage_id: { + phone_number: { /** - * Pipeline Stage + * P​h​o​n​e​ ​N​u​m​b​e​r */ - displayName: () => LocalizedString + displayName: string /** - * Current stage + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The current stage of the opportunity in the sales pipeline + * T​h​e​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​(​e​i​t​h​e​r​ ​e​m​a​i​l​ ​o​r​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​i​s​ ​r​e​q​u​i​r​e​d​) */ - longDesc: () => LocalizedString + longDesc: string } - priority: { + } + } + list_contacts: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * L​i​s​t​ ​C​o​n​t​a​c​t​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​f​r​o​m​ ​S​u​r​v​e​y​M​o​n​k​e​y + */ + longDesc: string + options: { + page: { /** - * Priority + * P​a​g​e */ - displayName: () => LocalizedString + displayName: string /** - * Opportunity priority + * P​a​g​e​ ​n​u​m​b​e​r​ ​t​o​ ​r​e​t​r​i​e​v​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The priority level of this opportunity (None, Low, Medium, or High) + * T​h​e​ ​p​a​g​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​p​a​g​i​n​a​t​i​o​n​ ​(​s​t​a​r​t​s​ ​a​t​ ​1​) */ - longDesc: () => LocalizedString + longDesc: string } - status: { + per_page: { /** - * Status + * P​e​r​ ​P​a​g​e */ - displayName: () => LocalizedString + displayName: string /** - * Opportunity status + * N​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​p​e​r​ ​p​a​g​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The current status of the opportunity (Open, Won, Lost, or Abandoned) + * T​h​e​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n​ ​p​e​r​ ​p​a​g​e​ ​(​d​e​f​a​u​l​t​:​ ​1​0​0​) */ - longDesc: () => LocalizedString + longDesc: string } - tags: { + limit: { /** - * Tags + * L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Opportunity tags + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​u​r​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Tags to categorize and organize the opportunity. You can create new tags or select from existing ones. + * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​a​c​r​o​s​s​ ​a​l​l​ ​p​a​g​e​s​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) */ - longDesc: () => LocalizedString + longDesc: string } - win_probability: { + } + } + create_collector: { + groups: { + /** + * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * C​r​e​a​t​e​ ​C​o​l​l​e​c​t​o​r + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​o​r​ ​a​ ​s​u​r​v​e​y + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​l​l​e​c​t​o​r​ ​(​d​i​s​t​r​i​b​u​t​i​o​n​ ​m​e​t​h​o​d​)​ ​f​o​r​ ​a​ ​s​u​r​v​e​y​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y + */ + longDesc: string + options: { + survey_id: { /** - * Win Probability + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Probability of winning + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The estimated probability (0-100) of winning this opportunity + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​o​r */ - longDesc: () => LocalizedString + longDesc: string } - custom_fields: { + type: { /** - * Custom Fields + * C​o​l​l​e​c​t​o​r​ ​T​y​p​e */ - displayName: () => LocalizedString + displayName: string /** - * Custom field values + * T​h​e​ ​t​y​p​e​ ​o​f​ ​c​o​l​l​e​c​t​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Custom field values specific to your CopperCRM opportunity configuration + * S​e​l​e​c​t​ ​t​h​e​ ​t​y​p​e​ ​o​f​ ​c​o​l​l​e​c​t​o​r​ ​(​e​m​a​i​l​,​ ​w​e​b​l​i​n​k​,​ ​f​a​c​e​b​o​o​k​,​ ​o​r​ ​e​m​b​e​d​) */ - longDesc: () => LocalizedString + longDesc: string + } + name: { + /** + * C​o​l​l​e​c​t​o​r​ ​N​a​m​e + */ + displayName: string + /** + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + */ + shortDesc: string + /** + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r + */ + longDesc: string } } } - create_person: { + list_collectors: { groups: { /** - * People + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ - '0': () => LocalizedString + '0': string } /** - * Create Person + * L​i​s​t​ ​C​o​l​l​e​c​t​o​r​s */ - displayName: () => LocalizedString + displayName: string /** - * Create a new person contact in CopperCRM + * R​e​t​r​i​e​v​e​ ​c​o​l​l​e​c​t​o​r​s​ ​f​o​r​ ​a​ ​s​u​r​v​e​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Create a new person contact in CopperCRM with complete contact information. People represent individual contacts in your CRM. + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​c​o​l​l​e​c​t​o​r​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y */ - longDesc: () => LocalizedString + longDesc: string options: { - name: { + survey_id: { /** - * Name + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Full name of the person + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​l​i​s​t​ ​c​o​l​l​e​c​t​o​r​s​ ​f​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The full name of the person contact + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​c​o​l​l​e​c​t​o​r​s​ ​f​r​o​m */ - longDesc: () => LocalizedString + longDesc: string } - prefix: { + limit: { /** - * Prefix + * L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Name prefix + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​l​l​e​c​t​o​r​s​ ​t​o​ ​r​e​t​u​r​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Name prefix such as Mr., Mrs., Dr., etc. + * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​l​l​e​c​t​o​r​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) */ - longDesc: () => LocalizedString + longDesc: string } - first_name: { + } + } + list_responses: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * L​i​s​t​ ​R​e​s​p​o​n​s​e​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​f​o​r​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y + */ + longDesc: string + options: { + survey_id: { /** - * First Name + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * First name + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​l​i​s​t​ ​r​e​s​p​o​n​s​e​s​ ​f​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The first name of the person + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​r​e​s​p​o​n​s​e​s​ ​f​r​o​m */ - longDesc: () => LocalizedString + longDesc: string } - middle_name: { + limit: { /** - * Middle Name + * L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Middle name + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​t​o​ ​r​e​t​u​r​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The middle name or initial of the person + * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) */ - longDesc: () => LocalizedString + longDesc: string } - last_name: { + } + } + get_response: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * G​e​t​ ​R​e​s​p​o​n​s​e + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​r​e​s​p​o​n​s​e​,​ ​o​p​t​i​o​n​a​l​l​y​ ​i​n​c​l​u​d​i​n​g​ ​f​u​l​l​ ​a​n​s​w​e​r​ ​d​e​t​a​i​l​s + */ + longDesc: string + options: { + survey_id: { /** - * Last Name + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Last name + * T​h​e​ ​s​u​r​v​e​y​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​r​e​s​p​o​n​s​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The last name of the person + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​r​e​s​p​o​n​s​e */ - longDesc: () => LocalizedString + longDesc: string } - suffix: { + response_id: { /** - * Suffix + * R​e​s​p​o​n​s​e​ ​I​D */ - displayName: () => LocalizedString + displayName: string /** - * Name suffix + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​r​e​s​p​o​n​s​e​ ​t​o​ ​r​e​t​r​i​e​v​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Name suffix such as Jr., Sr., III, etc. + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​r​e​s​p​o​n​s​e​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​r​e​t​r​i​e​v​e */ - longDesc: () => LocalizedString + longDesc: string } - street: { + include_answers: { /** - * Street + * I​n​c​l​u​d​e​ ​A​n​s​w​e​r​s */ - displayName: () => LocalizedString + displayName: string /** - * Street address + * I​n​c​l​u​d​e​ ​d​e​t​a​i​l​e​d​ ​a​n​s​w​e​r​ ​d​a​t​a */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The street address of the person + * W​h​e​n​ ​e​n​a​b​l​e​d​,​ ​r​e​t​r​i​e​v​e​s​ ​t​h​e​ ​f​u​l​l​ ​r​e​s​p​o​n​s​e​ ​d​e​t​a​i​l​s​ ​i​n​c​l​u​d​i​n​g​ ​a​l​l​ ​q​u​e​s​t​i​o​n​ ​a​n​s​w​e​r​s */ - longDesc: () => LocalizedString + longDesc: string } - city: { + } + } + get_collector: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * G​e​t​ ​C​o​l​l​e​c​t​o​r + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​c​o​l​l​e​c​t​o​r​ ​d​e​t​a​i​l​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​c​o​l​l​e​c​t​o​r + */ + longDesc: string + options: { + survey_id: { /** - * City + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * City name + * T​h​e​ ​s​u​r​v​e​y​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The city where the person is located + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - longDesc: () => LocalizedString + longDesc: string } - state: { + collector_id: { /** - * State + * C​o​l​l​e​c​t​o​r */ - displayName: () => LocalizedString + displayName: string /** - * State or province + * T​h​e​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​r​e​t​r​i​e​v​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The state or province + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ - longDesc: () => LocalizedString + longDesc: string } - postal_code: { + } + } + get_survey: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * G​e​t​ ​S​u​r​v​e​y + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​s​u​r​v​e​y​ ​d​e​t​a​i​l​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​a​b​o​u​t​ ​a​ ​s​p​e​c​i​f​i​c​ ​s​u​r​v​e​y​ ​i​n​c​l​u​d​i​n​g​ ​p​a​g​e​s​ ​a​n​d​ ​q​u​e​s​t​i​o​n​s + */ + longDesc: string + options: { + survey_id: { /** - * Postal Code + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * ZIP or postal code + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​r​e​t​r​i​e​v​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The postal code or ZIP code + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​d​e​t​a​i​l​e​d​ ​i​n​f​o​r​m​a​t​i​o​n​ ​f​o​r */ - longDesc: () => LocalizedString + longDesc: string } - country: { + } + } + list_surveys: { + groups: { + /** + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l + */ + '0': string + } + /** + * L​i​s​t​ ​S​u​r​v​e​y​s + */ + displayName: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​s​u​r​v​e​y​s + */ + shortDesc: string + /** + * R​e​t​r​i​e​v​e​ ​a​ ​p​a​g​i​n​a​t​e​d​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​s​u​r​v​e​y​s​ ​i​n​ ​y​o​u​r​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​a​c​c​o​u​n​t + */ + longDesc: string + options: { + limit: { /** - * Country + * L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Country name + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​r​v​e​y​s​ ​t​o​ ​r​e​t​u​r​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The country + * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​r​v​e​y​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) */ - longDesc: () => LocalizedString + longDesc: string } - assignee_id: { + } + } + send_survey: { + groups: { + /** + * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * S​e​n​d​ ​S​u​r​v​e​y + */ + displayName: string + /** + * S​e​n​d​ ​s​u​r​v​e​y​ ​i​n​v​i​t​a​t​i​o​n​ ​v​i​a​ ​c​o​l​l​e​c​t​o​r + */ + shortDesc: string + /** + * S​e​n​d​ ​a​ ​s​u​r​v​e​y​ ​i​n​v​i​t​a​t​i​o​n​ ​t​o​ ​r​e​c​i​p​i​e​n​t​s​ ​v​i​a​ ​a​n​ ​e​m​a​i​l​ ​c​o​l​l​e​c​t​o​r + */ + longDesc: string + options: { + survey_id: { /** - * Assignee + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * User assigned to this person + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​s​e​n​d */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The CopperCRM user who will be assigned to manage this contact + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​s​e​n​d */ - longDesc: () => LocalizedString + longDesc: string } - company_id: { + collector_id: { /** - * Company + * C​o​l​l​e​c​t​o​r */ - displayName: () => LocalizedString + displayName: string /** - * Associated company + * T​h​e​ ​e​m​a​i​l​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​u​s​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The company where this person works + * S​e​l​e​c​t​ ​t​h​e​ ​e​m​a​i​l​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​r​o​u​g​h */ - longDesc: () => LocalizedString + longDesc: string } - contact_type_id: { + subject: { /** - * Contact Type + * E​m​a​i​l​ ​S​u​b​j​e​c​t */ - displayName: () => LocalizedString + displayName: string /** - * Type of contact relationship + * T​h​e​ ​s​u​b​j​e​c​t​ ​l​i​n​e​ ​f​o​r​ ​t​h​e​ ​i​n​v​i​t​a​t​i​o​n​ ​e​m​a​i​l */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The type of contact relationship this person has with your organization + * T​h​e​ ​s​u​b​j​e​c​t​ ​l​i​n​e​ ​t​h​a​t​ ​w​i​l​l​ ​a​p​p​e​a​r​ ​i​n​ ​t​h​e​ ​i​n​v​i​t​a​t​i​o​n​ ​e​m​a​i​l */ - longDesc: () => LocalizedString + longDesc: string } - details: { + body_text: { /** - * Details + * E​m​a​i​l​ ​B​o​d​y */ - displayName: () => LocalizedString + displayName: string /** - * Additional notes + * T​h​e​ ​b​o​d​y​ ​t​e​x​t​ ​f​o​r​ ​t​h​e​ ​i​n​v​i​t​a​t​i​o​n​ ​e​m​a​i​l */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Additional notes, description, or important details about the person + * T​h​e​ ​m​e​s​s​a​g​e​ ​b​o​d​y​ ​t​h​a​t​ ​w​i​l​l​ ​a​p​p​e​a​r​ ​i​n​ ​t​h​e​ ​i​n​v​i​t​a​t​i​o​n​ ​e​m​a​i​l */ - longDesc: () => LocalizedString + longDesc: string } - emails: { + recipient_emails: { /** - * Email Addresses + * R​e​c​i​p​i​e​n​t​ ​E​m​a​i​l​s */ - displayName: () => LocalizedString + displayName: string /** - * Email addresses + * L​i​s​t​ ​o​f​ ​r​e​c​i​p​i​e​n​t​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of email addresses for the person + * A​ ​l​i​s​t​ ​o​f​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​e​s​ ​t​o​ ​s​e​n​d​ ​t​h​e​ ​s​u​r​v​e​y​ ​i​n​v​i​t​a​t​i​o​n​ ​t​o */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - email: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * The email address - */ - shortDesc: () => LocalizedString - /** - * Email address - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of email - */ - shortDesc: () => LocalizedString - /** - * The category or type of this email (work, personal, or other) - */ - longDesc: () => LocalizedString - } - } - } - } + longDesc: string } - phone_numbers: { + } + } + create_survey: { + groups: { + /** + * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * C​r​e​a​t​e​ ​S​u​r​v​e​y + */ + displayName: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​u​r​v​e​y + */ + shortDesc: string + /** + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​u​r​v​e​y​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​f​r​o​m​ ​s​c​r​a​t​c​h​ ​o​r​ ​f​r​o​m​ ​a​ ​t​e​m​p​l​a​t​e + */ + longDesc: string + options: { + title: { /** - * Phone Numbers + * T​i​t​l​e */ - displayName: () => LocalizedString + displayName: string /** - * Contact phone numbers + * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​s​u​r​v​e​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of phone numbers for the person + * T​h​e​ ​t​i​t​l​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​d​i​s​p​l​a​y​e​d​ ​f​o​r​ ​t​h​e​ ​s​u​r​v​e​y */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - number: { - /** - * Phone Number - */ - displayName: () => LocalizedString - /** - * The phone number - */ - shortDesc: () => LocalizedString - /** - * Phone number - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of phone number - */ - shortDesc: () => LocalizedString - /** - * The category or type of this phone number (work, mobile, home, or other) - */ - longDesc: () => LocalizedString - } - } - } - } - } - socials: { - /** - * Social Media - */ - displayName: () => LocalizedString - /** - * Social media profiles - */ - shortDesc: () => LocalizedString - /** - * List of social media profiles for the person - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Social profile URL - */ - shortDesc: () => LocalizedString - /** - * Social profile URL - */ - longDesc: () => LocalizedString - } - category: { - /** - * Platform - */ - displayName: () => LocalizedString - /** - * Social media platform - */ - shortDesc: () => LocalizedString - /** - * Social platform - */ - longDesc: () => LocalizedString - } - } - } - } + longDesc: string } - tags: { + nickname: { /** - * Tags + * N​i​c​k​n​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Person tags + * I​n​t​e​r​n​a​l​ ​n​i​c​k​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​s​u​r​v​e​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Tags to categorize and organize the person. You can create new tags or select from existing ones. + * A​n​ ​o​p​t​i​o​n​a​l​ ​i​n​t​e​r​n​a​l​ ​n​i​c​k​n​a​m​e​ ​t​o​ ​h​e​l​p​ ​i​d​e​n​t​i​f​y​ ​t​h​e​ ​s​u​r​v​e​y */ - longDesc: () => LocalizedString + longDesc: string } - title: { + language: { /** - * Title + * L​a​n​g​u​a​g​e */ - displayName: () => LocalizedString + displayName: string /** - * Job title + * T​h​e​ ​l​a​n​g​u​a​g​e​ ​o​f​ ​t​h​e​ ​s​u​r​v​e​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The job title or position of the person + * T​h​e​ ​l​a​n​g​u​a​g​e​ ​c​o​d​e​ ​f​o​r​ ​t​h​e​ ​s​u​r​v​e​y​ ​(​e​.​g​.​,​ ​e​n​,​ ​e​s​,​ ​f​r​)​.​ ​D​e​f​a​u​l​t​s​ ​t​o​ ​e​n​. */ - longDesc: () => LocalizedString + longDesc: string } - websites: { + folder_id: { /** - * Websites + * F​o​l​d​e​r​ ​I​D */ - displayName: () => LocalizedString + displayName: string /** - * Associated websites + * T​h​e​ ​f​o​l​d​e​r​ ​t​o​ ​c​r​e​a​t​e​ ​t​h​e​ ​s​u​r​v​e​y​ ​i​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of websites associated with the person + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​f​o​l​d​e​r​ ​w​h​e​r​e​ ​t​h​e​ ​s​u​r​v​e​y​ ​s​h​o​u​l​d​ ​b​e​ ​c​r​e​a​t​e​d */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Website URL - */ - shortDesc: () => LocalizedString - /** - * Website URL - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of website - */ - shortDesc: () => LocalizedString - /** - * The category or purpose of this website (work, personal, or other) - */ - longDesc: () => LocalizedString - } - } - } - } + longDesc: string } - custom_fields: { + from_template_id: { /** - * Custom Fields + * T​e​m​p​l​a​t​e​ ​I​D */ - displayName: () => LocalizedString + displayName: string /** - * Custom field values + * T​e​m​p​l​a​t​e​ ​t​o​ ​c​r​e​a​t​e​ ​s​u​r​v​e​y​ ​f​r​o​m */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Custom field values specific to your CopperCRM person configuration + * T​h​e​ ​I​D​ ​o​f​ ​a​ ​t​e​m​p​l​a​t​e​ ​t​o​ ​u​s​e​ ​a​s​ ​t​h​e​ ​b​a​s​i​s​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​s​u​r​v​e​y */ - longDesc: () => LocalizedString + longDesc: string } } } - create_task: { + copy_survey: { groups: { /** - * Tasks + * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t */ - '0': () => LocalizedString + '0': string } /** - * Create Task + * C​o​p​y​ ​S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Create a new task in CopperCRM + * C​r​e​a​t​e​ ​a​ ​c​o​p​y​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​s​u​r​v​e​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Create a new task in CopperCRM with details, due dates, and assignments. Tasks help you track action items and follow-ups. + * C​l​o​n​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​s​u​r​v​e​y​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​u​r​v​e​y​ ​w​i​t​h​ ​t​h​e​ ​s​a​m​e​ ​s​t​r​u​c​t​u​r​e​ ​a​n​d​ ​q​u​e​s​t​i​o​n​s */ - longDesc: () => LocalizedString + longDesc: string options: { - name: { - /** - * Task Name - */ - displayName: () => LocalizedString - /** - * Name of the task - */ - shortDesc: () => LocalizedString - /** - * A descriptive name for the task - */ - longDesc: () => LocalizedString - } - related_resource: { + survey_id: { /** - * Related Resource + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Associated record + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​c​o​p​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The CRM record (lead, person, company, opportunity, or project) this task is related to + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​c​r​e​a​t​e​ ​a​ ​c​o​p​y​ ​o​f */ - longDesc: () => LocalizedString - type: { - fields: { - id: { - /** - * Resource ID - */ - displayName: () => LocalizedString - /** - * ID of the related record - */ - shortDesc: () => LocalizedString - /** - * The ID of the related CRM record - */ - longDesc: () => LocalizedString - } - type: { - /** - * Resource Type - */ - displayName: () => LocalizedString - /** - * Type of related record - */ - shortDesc: () => LocalizedString - /** - * The type of CRM record this task is related to (lead, person, company, opportunity, or project) - */ - longDesc: () => LocalizedString - } - } - } + longDesc: string } - assignee_id: { + title: { /** - * Assignee + * T​i​t​l​e */ - displayName: () => LocalizedString + displayName: string /** - * User assigned to this task + * T​h​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​s​u​r​v​e​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The CopperCRM user who will be assigned to complete this task + * T​h​e​ ​t​i​t​l​e​ ​t​h​a​t​ ​w​i​l​l​ ​b​e​ ​d​i​s​p​l​a​y​e​d​ ​f​o​r​ ​t​h​e​ ​c​o​p​i​e​d​ ​s​u​r​v​e​y */ - longDesc: () => LocalizedString + longDesc: string } - due_date: { + } + } + update_collector: { + groups: { + /** + * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t + */ + '0': string + } + /** + * U​p​d​a​t​e​ ​C​o​l​l​e​c​t​o​r + */ + displayName: string + /** + * U​p​d​a​t​e​ ​c​o​l​l​e​c​t​o​r​ ​s​e​t​t​i​n​g​s + */ + shortDesc: string + /** + * M​o​d​i​f​y​ ​t​h​e​ ​s​e​t​t​i​n​g​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​l​l​e​c​t​o​r​ ​s​u​c​h​ ​a​s​ ​s​t​a​t​u​s​,​ ​c​l​o​s​e​ ​d​a​t​e​,​ ​o​r​ ​r​e​d​i​r​e​c​t​ ​U​R​L + */ + longDesc: string + options: { + survey_id: { /** - * Due Date + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * When the task is due + * T​h​e​ ​s​u​r​v​e​y​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The date when this task should be completed + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - longDesc: () => LocalizedString + longDesc: string } - reminder_date: { + collector_id: { /** - * Reminder Date + * C​o​l​l​e​c​t​o​r */ - displayName: () => LocalizedString + displayName: string /** - * When to send reminder + * T​h​e​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​u​p​d​a​t​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The date when a reminder should be sent for this task + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​m​o​d​i​f​y */ - longDesc: () => LocalizedString + longDesc: string } - priority: { + name: { /** - * Priority + * N​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Task priority + * N​e​w​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The priority level of this task (None, Low, Medium, or High) + * A​ ​n​e​w​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - longDesc: () => LocalizedString + longDesc: string } status: { /** - * Status + * S​t​a​t​u​s */ - displayName: () => LocalizedString + displayName: string /** - * Task status + * T​h​e​ ​c​o​l​l​e​c​t​o​r​ ​s​t​a​t​u​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The current status of the task (Open or Completed) + * S​e​t​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​o​p​e​n​ ​o​r​ ​c​l​o​s​e​d */ - longDesc: () => LocalizedString + longDesc: string } - details: { + close_date: { /** - * Details + * C​l​o​s​e​ ​D​a​t​e */ - displayName: () => LocalizedString + displayName: string /** - * Task description + * W​h​e​n​ ​t​o​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​c​l​o​s​e​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Additional details or description of what needs to be done + * T​h​e​ ​d​a​t​e​ ​a​n​d​ ​t​i​m​e​ ​w​h​e​n​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​s​h​o​u​l​d​ ​a​u​t​o​m​a​t​i​c​a​l​l​y​ ​c​l​o​s​e​ ​(​I​S​O​ ​8​6​0​1​ ​f​o​r​m​a​t​) */ - longDesc: () => LocalizedString + longDesc: string } - tags: { + redirect_url: { /** - * Tags + * R​e​d​i​r​e​c​t​ ​U​R​L */ - displayName: () => LocalizedString + displayName: string /** - * Task tags + * U​R​L​ ​t​o​ ​r​e​d​i​r​e​c​t​ ​r​e​s​p​o​n​d​e​n​t​s​ ​a​f​t​e​r​ ​c​o​m​p​l​e​t​i​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Tags to categorize and organize the task. You can create new tags or select from existing ones. + * T​h​e​ ​U​R​L​ ​w​h​e​r​e​ ​r​e​s​p​o​n​d​e​n​t​s​ ​w​i​l​l​ ​b​e​ ​r​e​d​i​r​e​c​t​e​d​ ​a​f​t​e​r​ ​c​o​m​p​l​e​t​i​n​g​ ​t​h​e​ ​s​u​r​v​e​y */ - longDesc: () => LocalizedString + longDesc: string } - custom_fields: { + response_limit: { /** - * Custom Fields + * R​e​s​p​o​n​s​e​ ​L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Custom field values + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Custom field values specific to your CopperCRM task configuration + * T​h​e​ ​m​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​t​o​ ​a​c​c​e​p​t​ ​b​e​f​o​r​e​ ​c​l​o​s​i​n​g​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - longDesc: () => LocalizedString + longDesc: string } } } - delete_company: { + delete_collector: { groups: { /** - * Companies + * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t */ - '0': () => LocalizedString + '0': string } /** - * Delete Company + * D​e​l​e​t​e​ ​C​o​l​l​e​c​t​o​r */ - displayName: () => LocalizedString + displayName: string /** - * Delete a company from CopperCRM + * D​e​l​e​t​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​r​o​m​ ​a​ ​s​u​r​v​e​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Permanently delete a company record from CopperCRM. This action cannot be undone. + * P​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​ ​a​ ​c​o​l​l​e​c​t​o​r​ ​f​r​o​m​ ​a​ ​s​u​r​v​e​y​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. */ - longDesc: () => LocalizedString + longDesc: string options: { - company_id: { + survey_id: { /** - * Company + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Company to delete + * T​h​e​ ​s​u​r​v​e​y​ ​c​o​n​t​a​i​n​i​n​g​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the company you want to delete from CopperCRM + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​t​h​a​t​ ​c​o​n​t​a​i​n​s​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r */ - longDesc: () => LocalizedString + longDesc: string + } + collector_id: { + /** + * C​o​l​l​e​c​t​o​r + */ + displayName: string + /** + * T​h​e​ ​c​o​l​l​e​c​t​o​r​ ​t​o​ ​d​e​l​e​t​e + */ + shortDesc: string + /** + * S​e​l​e​c​t​ ​t​h​e​ ​c​o​l​l​e​c​t​o​r​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​p​e​r​m​a​n​e​n​t​l​y​ ​d​e​l​e​t​e + */ + longDesc: string } } } - delete_lead: { + get_response_counts: { groups: { /** - * Leads + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ - '0': () => LocalizedString + '0': string } /** - * Delete Lead + * G​e​t​ ​R​e​s​p​o​n​s​e​ ​C​o​u​n​t​s */ - displayName: () => LocalizedString + displayName: string /** - * Delete a lead from CopperCRM + * G​e​t​ ​t​o​t​a​l​ ​r​e​s​p​o​n​s​e​ ​c​o​u​n​t​ ​f​o​r​ ​a​ ​s​u​r​v​e​y */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Permanently delete a lead record from CopperCRM. This action cannot be undone. + * Q​u​i​c​k​l​y​ ​r​e​t​r​i​e​v​e​ ​t​h​e​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​r​e​s​p​o​n​s​e​s​ ​f​o​r​ ​a​ ​s​u​r​v​e​y​ ​w​i​t​h​o​u​t​ ​f​e​t​c​h​i​n​g​ ​a​l​l​ ​r​e​s​p​o​n​s​e​ ​d​a​t​a */ - longDesc: () => LocalizedString + longDesc: string options: { - lead_id: { + survey_id: { /** - * Lead + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Lead to delete + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​g​e​t​ ​c​o​u​n​t​s​ ​f​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the lead you want to delete from CopperCRM + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​r​e​s​p​o​n​s​e​ ​c​o​u​n​t​s​ ​f​o​r */ - longDesc: () => LocalizedString + longDesc: string } } } - delete_opportunity: { + update_contact: { groups: { /** - * Opportunities + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t */ - '0': () => LocalizedString + '0': string } /** - * Delete Opportunity + * U​p​d​a​t​e​ ​C​o​n​t​a​c​t */ - displayName: () => LocalizedString + displayName: string /** - * Delete an opportunity from CopperCRM + * U​p​d​a​t​e​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Permanently delete an opportunity record from CopperCRM. This action cannot be undone. + * M​o​d​i​f​y​ ​t​h​e​ ​d​e​t​a​i​l​s​ ​o​f​ ​a​n​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y */ - longDesc: () => LocalizedString + longDesc: string options: { - opportunity_id: { + contact_id: { /** - * Opportunity + * C​o​n​t​a​c​t​ ​I​D */ - displayName: () => LocalizedString + displayName: string /** - * Opportunity to delete + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​u​p​d​a​t​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the opportunity you want to delete from CopperCRM + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​u​p​d​a​t​e */ - longDesc: () => LocalizedString + longDesc: string + } + first_name: { + /** + * F​i​r​s​t​ ​N​a​m​e + */ + displayName: string + /** + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​f​i​r​s​t​ ​n​a​m​e + */ + shortDesc: string + /** + * T​h​e​ ​n​e​w​ ​f​i​r​s​t​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + */ + longDesc: string + } + last_name: { + /** + * L​a​s​t​ ​N​a​m​e + */ + displayName: string + /** + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​l​a​s​t​ ​n​a​m​e + */ + shortDesc: string + /** + * T​h​e​ ​n​e​w​ ​l​a​s​t​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + */ + longDesc: string + } + email: { + /** + * E​m​a​i​l + */ + displayName: string + /** + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s + */ + shortDesc: string + /** + * T​h​e​ ​n​e​w​ ​e​m​a​i​l​ ​a​d​d​r​e​s​s​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + */ + longDesc: string + } + phone_number: { + /** + * P​h​o​n​e​ ​N​u​m​b​e​r + */ + displayName: string + /** + * T​h​e​ ​c​o​n​t​a​c​t​'​s​ ​p​h​o​n​e​ ​n​u​m​b​e​r + */ + shortDesc: string + /** + * T​h​e​ ​n​e​w​ ​p​h​o​n​e​ ​n​u​m​b​e​r​ ​f​o​r​ ​t​h​e​ ​c​o​n​t​a​c​t + */ + longDesc: string } } } - delete_person: { + delete_contact: { groups: { /** - * People + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t */ - '0': () => LocalizedString + '0': string } /** - * Delete Person + * D​e​l​e​t​e​ ​C​o​n​t​a​c​t */ - displayName: () => LocalizedString + displayName: string /** - * Delete a person contact from CopperCRM + * D​e​l​e​t​e​ ​a​ ​c​o​n​t​a​c​t */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Permanently delete a person contact record from CopperCRM. This action cannot be undone. + * P​e​r​m​a​n​e​n​t​l​y​ ​r​e​m​o​v​e​ ​a​ ​c​o​n​t​a​c​t​ ​f​r​o​m​ ​S​u​r​v​e​y​M​o​n​k​e​y​.​ ​T​h​i​s​ ​a​c​t​i​o​n​ ​c​a​n​n​o​t​ ​b​e​ ​u​n​d​o​n​e​. */ - longDesc: () => LocalizedString + longDesc: string options: { - person_id: { + contact_id: { /** - * Person + * C​o​n​t​a​c​t​ ​I​D */ - displayName: () => LocalizedString + displayName: string /** - * Person to delete + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​t​o​ ​d​e​l​e​t​e */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the person contact you want to delete from CopperCRM + * T​h​e​ ​u​n​i​q​u​e​ ​i​d​e​n​t​i​f​i​e​r​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​d​e​l​e​t​e */ - longDesc: () => LocalizedString + longDesc: string } } } - delete_task: { + list_contact_lists: { groups: { /** - * Tasks + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ - '0': () => LocalizedString + '0': string } /** - * Delete Task + * L​i​s​t​ ​C​o​n​t​a​c​t​ ​L​i​s​t​s */ - displayName: () => LocalizedString + displayName: string /** - * Delete a task from CopperCRM + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Permanently delete a task from CopperCRM. This action cannot be undone. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​i​n​ ​y​o​u​r​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​a​c​c​o​u​n​t */ - longDesc: () => LocalizedString + longDesc: string options: { - task_id: { + limit: { /** - * Task + * L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Task to delete + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​u​r​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the task you want to delete from CopperCRM + * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​c​o​n​t​a​c​t​ ​l​i​s​t​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) */ - longDesc: () => LocalizedString + longDesc: string } } } - get_company: { + create_contact_list: { groups: { /** - * Companies + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t */ - '0': () => LocalizedString + '0': string } /** - * Get Company + * C​r​e​a​t​e​ ​C​o​n​t​a​c​t​ ​L​i​s​t */ - displayName: () => LocalizedString + displayName: string /** - * Retrieve a company from CopperCRM + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Retrieve detailed information about a specific company record from CopperCRM including all fields and custom data. + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​f​o​r​ ​o​r​g​a​n​i​z​i​n​g​ ​c​o​n​t​a​c​t​s​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y */ - longDesc: () => LocalizedString + longDesc: string options: { - company_id: { + name: { /** - * Company + * N​a​m​e */ - displayName: () => LocalizedString + displayName: string /** - * Company to retrieve + * T​h​e​ ​n​a​m​e​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the company you want to retrieve from CopperCRM + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​n​a​m​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​c​o​n​t​a​c​t​ ​l​i​s​t */ - longDesc: () => LocalizedString + longDesc: string } } } - get_lead: { + add_contacts_to_list: { groups: { /** - * Leads + * C​o​n​t​a​c​t​ ​M​a​n​a​g​e​m​e​n​t */ - '0': () => LocalizedString + '0': string } /** - * Get Lead + * A​d​d​ ​C​o​n​t​a​c​t​s​ ​t​o​ ​L​i​s​t */ - displayName: () => LocalizedString + displayName: string /** - * Retrieve a lead from CopperCRM + * A​d​d​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Retrieve detailed information about a specific lead record from CopperCRM including all fields and custom data. + * A​d​d​ ​o​n​e​ ​o​r​ ​m​o​r​e​ ​e​x​i​s​t​i​n​g​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​i​n​ ​b​u​l​k */ - longDesc: () => LocalizedString + longDesc: string options: { - lead_id: { + contact_list_id: { /** - * Lead + * C​o​n​t​a​c​t​ ​L​i​s​t​ ​I​D */ - displayName: () => LocalizedString + displayName: string /** - * Lead to retrieve + * T​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​t​o​ ​a​d​d​ ​c​o​n​t​a​c​t​s​ ​t​o */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the lead you want to retrieve from CopperCRM + * T​h​e​ ​I​D​ ​o​f​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t​ ​w​h​e​r​e​ ​c​o​n​t​a​c​t​s​ ​w​i​l​l​ ​b​e​ ​a​d​d​e​d */ - longDesc: () => LocalizedString + longDesc: string + } + contact_ids: { + /** + * C​o​n​t​a​c​t​ ​I​D​s + */ + displayName: string + /** + * T​h​e​ ​c​o​n​t​a​c​t​s​ ​t​o​ ​a​d​d + */ + shortDesc: string + /** + * A​ ​l​i​s​t​ ​o​f​ ​c​o​n​t​a​c​t​ ​I​D​s​ ​t​o​ ​a​d​d​ ​t​o​ ​t​h​e​ ​c​o​n​t​a​c​t​ ​l​i​s​t + */ + longDesc: string } } } - get_opportunity: { + get_survey_rollup: { groups: { /** - * Opportunities + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ - '0': () => LocalizedString + '0': string } /** - * Get Opportunity + * G​e​t​ ​S​u​r​v​e​y​ ​R​o​l​l​u​p */ - displayName: () => LocalizedString + displayName: string /** - * Retrieve an opportunity from CopperCRM + * G​e​t​ ​a​g​g​r​e​g​a​t​e​d​ ​s​u​r​v​e​y​ ​s​t​a​t​i​s​t​i​c​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Retrieve detailed information about a specific opportunity record from CopperCRM including all fields and custom data. + * R​e​t​r​i​e​v​e​ ​a​g​g​r​e​g​a​t​e​d​ ​r​e​s​p​o​n​s​e​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r​ ​a​ ​s​u​r​v​e​y​ ​i​n​c​l​u​d​i​n​g​ ​q​u​e​s​t​i​o​n​-​l​e​v​e​l​ ​s​u​m​m​a​r​i​e​s */ - longDesc: () => LocalizedString + longDesc: string options: { - opportunity_id: { + survey_id: { /** - * Opportunity + * S​u​r​v​e​y */ - displayName: () => LocalizedString + displayName: string /** - * Opportunity to retrieve + * T​h​e​ ​s​u​r​v​e​y​ ​t​o​ ​g​e​t​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the opportunity you want to retrieve from CopperCRM + * S​e​l​e​c​t​ ​t​h​e​ ​s​u​r​v​e​y​ ​y​o​u​ ​w​a​n​t​ ​t​o​ ​g​e​t​ ​a​g​g​r​e​g​a​t​e​d​ ​s​t​a​t​i​s​t​i​c​s​ ​f​o​r */ - longDesc: () => LocalizedString + longDesc: string } } } - get_person: { + get_user_details: { groups: { /** - * People + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ - '0': () => LocalizedString + '0': string } /** - * Get Person + * G​e​t​ ​U​s​e​r​ ​D​e​t​a​i​l​s */ - displayName: () => LocalizedString + displayName: string /** - * Retrieve a person contact from CopperCRM + * G​e​t​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​u​s​e​r​ ​i​n​f​o​r​m​a​t​i​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Retrieve detailed information about a specific person contact record from CopperCRM including all fields and custom data. + * R​e​t​r​i​e​v​e​ ​d​e​t​a​i​l​s​ ​a​b​o​u​t​ ​t​h​e​ ​a​u​t​h​e​n​t​i​c​a​t​e​d​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​u​s​e​r​ ​i​n​c​l​u​d​i​n​g​ ​a​c​c​o​u​n​t​ ​t​y​p​e​ ​a​n​d​ ​p​e​r​m​i​s​s​i​o​n​s */ - longDesc: () => LocalizedString + longDesc: string options: { - person_id: { - /** - * Person - */ - displayName: () => LocalizedString - /** - * Person to retrieve - */ - shortDesc: () => LocalizedString - /** - * Select the person contact you want to retrieve from CopperCRM - */ - longDesc: () => LocalizedString - } } } - get_task: { + list_survey_folders: { groups: { /** - * Tasks + * D​a​t​a​ ​R​e​t​r​i​e​v​a​l */ - '0': () => LocalizedString + '0': string } /** - * Get Task + * L​i​s​t​ ​S​u​r​v​e​y​ ​F​o​l​d​e​r​s */ - displayName: () => LocalizedString + displayName: string /** - * Retrieve a task from CopperCRM + * R​e​t​r​i​e​v​e​ ​a​l​l​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r​s */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Retrieve detailed information about a specific task from CopperCRM including all fields and custom data. + * R​e​t​r​i​e​v​e​ ​a​ ​l​i​s​t​ ​o​f​ ​a​l​l​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r​s​ ​i​n​ ​y​o​u​r​ ​S​u​r​v​e​y​M​o​n​k​e​y​ ​a​c​c​o​u​n​t */ - longDesc: () => LocalizedString + longDesc: string options: { - task_id: { + limit: { /** - * Task + * L​i​m​i​t */ - displayName: () => LocalizedString + displayName: string /** - * Task to retrieve + * M​a​x​i​m​u​m​ ​n​u​m​b​e​r​ ​o​f​ ​f​o​l​d​e​r​s​ ​t​o​ ​r​e​t​u​r​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Select the task you want to retrieve from CopperCRM + * T​h​e​ ​m​a​x​i​m​u​m​ ​t​o​t​a​l​ ​n​u​m​b​e​r​ ​o​f​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r​s​ ​t​o​ ​r​e​t​r​i​e​v​e​ ​(​d​e​f​a​u​l​t​:​ ​5​0​0​) */ - longDesc: () => LocalizedString + longDesc: string } } } - search_companies: { + create_survey_folder: { groups: { /** - * Companies + * S​u​r​v​e​y​ ​M​a​n​a​g​e​m​e​n​t */ - '0': () => LocalizedString + '0': string } /** - * Search Companies + * C​r​e​a​t​e​ ​S​u​r​v​e​y​ ​F​o​l​d​e​r */ - displayName: () => LocalizedString + displayName: string /** - * Search for companies in CopperCRM + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * Search and filter companies in CopperCRM using various criteria including name, location, tags, and custom fields. Returns a list of matching companies. + * C​r​e​a​t​e​ ​a​ ​n​e​w​ ​f​o​l​d​e​r​ ​t​o​ ​o​r​g​a​n​i​z​e​ ​y​o​u​r​ ​s​u​r​v​e​y​s​ ​i​n​ ​S​u​r​v​e​y​M​o​n​k​e​y */ - longDesc: () => LocalizedString + longDesc: string options: { - ids: { + title: { /** - * Company IDs + * T​i​t​l​e */ - displayName: () => LocalizedString + displayName: string /** - * Specific companies to retrieve + * T​h​e​ ​t​i​t​l​e​ ​o​f​ ​t​h​e​ ​f​o​l​d​e​r */ - shortDesc: () => LocalizedString + shortDesc: string /** - * List of specific company IDs to retrieve + * A​ ​d​e​s​c​r​i​p​t​i​v​e​ ​t​i​t​l​e​ ​f​o​r​ ​t​h​e​ ​n​e​w​ ​s​u​r​v​e​y​ ​f​o​l​d​e​r */ - longDesc: () => LocalizedString + longDesc: string } - page_number: { + } + } + } + } + _testing: { + triggers: { + _testing: { + options: { + option1: { /** - * Page Number + * O​p​t​i​o​n​ ​1 */ - displayName: () => LocalizedString + displayName: string /** - * Which page of results + * O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The page number of results to retrieve for pagination + * O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n */ - longDesc: () => LocalizedString + longDesc: string } - page_size: { + option2: { /** - * Page Size + * S​e​c​o​n​d​ ​O​p​t​i​o​n */ - displayName: () => LocalizedString + displayName: string /** - * Results per page + * S​e​c​o​n​d​ ​O​p​t​i​o​n​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The number of results to return per page + * S​e​c​o​n​d​ ​O​p​t​i​o​n​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n */ - longDesc: () => LocalizedString + longDesc: string } - sort_by: { - /** - * Sort By - */ - displayName: () => LocalizedString - /** - * Field to sort by - */ - shortDesc: () => LocalizedString - /** - * The field to use for sorting the results - */ - longDesc: () => LocalizedString + } + event_info: { + /** + * E​v​e​n​t​ ​d​a​t​a + */ + desc: string + type: { + fields: { + testTriggerInfo: { + /** + * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o + */ + displayName: string + /** + * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + */ + shortDesc: string + /** + * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + */ + longDesc: string + type: { + fields: { + testTriggerInfo1: { + /** + * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​1 + */ + displayName: string + /** + * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + */ + shortDesc: string + /** + * T​e​s​t​ ​T​r​i​g​g​e​r​ ​I​n​f​o​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + */ + longDesc: string + } + } + } + } + } } - sort_direction: { + } + } + } + actions: { + test: { + options: { + option1: { /** - * Sort Direction + * O​p​t​i​o​n​ ​1 */ - displayName: () => LocalizedString + displayName: string /** - * Sort order + * O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n */ - shortDesc: () => LocalizedString + shortDesc: string /** - * The direction to sort results (ascending or descending) + * O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n */ - longDesc: () => LocalizedString + longDesc: string + type: { + fields: { + subOption1: { + /** + * S​u​b​ ​O​p​t​i​o​n​ ​1​ ​o​f​ ​o​p​t​i​o​n​ ​1 + */ + displayName: string + /** + * S​u​b​ ​O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + */ + shortDesc: string + /** + * S​u​b​ ​O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + */ + longDesc: string + } + subOption2: { + /** + * S​u​b​ ​O​p​t​i​o​n​ ​2​ ​o​f​ ​o​p​t​i​o​n​ ​1 + */ + displayName: string + /** + * S​u​b​ ​O​p​t​i​o​n​ ​2​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + */ + shortDesc: string + /** + * S​u​b​ ​O​p​t​i​o​n​ ​2​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + */ + longDesc: string + type: { + fields: { + subSubOption1: { + /** + * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1 + */ + displayName: string + /** + * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + */ + shortDesc: string + /** + * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + */ + longDesc: string + } + } + } + } + subOption3: { + /** + * S​u​b​ ​O​p​t​i​o​n​ ​3​ ​o​f​ ​o​p​t​i​o​n​ ​1 + */ + displayName: string + /** + * S​u​b​ ​O​p​t​i​o​n​ ​3​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + */ + shortDesc: string + /** + * S​u​b​ ​O​p​t​i​o​n​ ​3​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + */ + longDesc: string + type: { + element_type: { + type: { + fields: { + subSubOption1: { + /** + * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1 + */ + displayName: string + /** + * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1​ ​S​h​o​r​t​ ​D​e​s​c​r​i​p​t​i​o​n + */ + shortDesc: string + /** + * S​u​b​ ​S​u​b​ ​O​p​t​i​o​n​ ​1​ ​L​o​n​g​ ​D​e​s​c​r​i​p​t​i​o​n + */ + longDesc: string + } + } + } + } + } + } + } + } } - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * Company name to search - */ - shortDesc: () => LocalizedString + option2: { /** - * Search for companies with names matching this value + * S​e​c​o​n​d​ ​O​p​t​i​o​n */ - longDesc: () => LocalizedString + displayName: string } - assignee_ids: { - /** - * Assignees - */ - displayName: () => LocalizedString - /** - * Assigned users - */ - shortDesc: () => LocalizedString - /** - * Filter companies by assigned users - */ - longDesc: () => LocalizedString - } - contact_type_ids: { + } + } + } + } + } +} + +export type TranslationFunctions = { + common: { + } + apps: { + CopperCrm: { + /** + * CopperCRM + */ + displayName: () => LocalizedString + groups: { + /** + * CRM & Sales Management + */ + '0': () => LocalizedString + } + /** + * Connect to CopperCRM to manage your sales pipeline, contacts, and customer relationships. + */ + shortDesc: () => LocalizedString + /** + * The CopperCRM integration provides comprehensive access to your CRM data with actions and triggers for managing leads, people, companies, opportunities, and tasks. Built specifically for Google Workspace users, CopperCRM helps you track customer interactions, manage your sales pipeline, and automate your workflow. This integration enables you to create, retrieve, update, delete, and search across all major CopperCRM entities, while triggers keep you informed of new records as they are created in your CRM. + */ + longDesc: () => LocalizedString + actions: { + create_company: { + groups: { + /** + * Companies + */ + '0': () => LocalizedString + } + /** + * Create Company + */ + displayName: () => LocalizedString + /** + * Create a new company in CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Create a new company record in CopperCRM with details like name, address, contact information, and custom fields. Companies represent organizations in your CRM. + */ + longDesc: () => LocalizedString + options: { + name: { /** - * Contact Types + * Company Name */ displayName: () => LocalizedString /** - * Contact type filter + * The name of the company */ shortDesc: () => LocalizedString /** - * Filter companies by contact type + * The official name of the company you want to create in CopperCRM */ longDesc: () => LocalizedString } - city: { + address: { /** - * City + * Address */ displayName: () => LocalizedString /** - * City location + * Company address details */ shortDesc: () => LocalizedString /** - * Filter companies by city + * The physical address of the company including street, city, state, postal code, and country */ longDesc: () => LocalizedString + type: { + fields: { + street: { + /** + * Street + */ + displayName: () => LocalizedString + /** + * Street address + */ + shortDesc: () => LocalizedString + /** + * The street address of the company + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * City name + */ + shortDesc: () => LocalizedString + /** + * The city where the company is located + */ + longDesc: () => LocalizedString + } + state: { + /** + * State + */ + displayName: () => LocalizedString + /** + * State or province + */ + shortDesc: () => LocalizedString + /** + * The state or province where the company is located + */ + longDesc: () => LocalizedString + } + postal_code: { + /** + * Postal Code + */ + displayName: () => LocalizedString + /** + * ZIP or postal code + */ + shortDesc: () => LocalizedString + /** + * The postal code or ZIP code of the company address + */ + longDesc: () => LocalizedString + } + country: { + /** + * Country + */ + displayName: () => LocalizedString + /** + * Country name + */ + shortDesc: () => LocalizedString + /** + * The country where the company is located + */ + longDesc: () => LocalizedString + } + } + } } - state: { + assignee_id: { /** - * State + * Assignee */ displayName: () => LocalizedString /** - * State or province + * User assigned to this company */ shortDesc: () => LocalizedString /** - * Filter companies by state or province + * The CopperCRM user who will be assigned to manage this company */ longDesc: () => LocalizedString } - postal_code: { + contact_type_id: { /** - * Postal Code + * Contact Type */ displayName: () => LocalizedString /** - * ZIP or postal code + * Type of contact relationship */ shortDesc: () => LocalizedString /** - * Filter companies by postal code + * The type of contact relationship this company has with your organization */ longDesc: () => LocalizedString } - country: { + details: { /** - * Country + * Details */ displayName: () => LocalizedString /** - * Country location + * Additional notes or description */ shortDesc: () => LocalizedString /** - * Filter companies by country + * Additional notes, description, or important details about the company */ longDesc: () => LocalizedString } - tags: { + email_domain: { /** - * Tags + * Email Domain */ displayName: () => LocalizedString /** - * Filter by tags + * Company email domain */ shortDesc: () => LocalizedString /** - * Filter companies that have any of these tags + * The primary email domain used by the company (e.g., example.com) */ longDesc: () => LocalizedString } - socials: { + phone_numbers: { /** - * Social Media + * Phone Numbers */ displayName: () => LocalizedString /** - * Social media filter + * Company phone numbers */ shortDesc: () => LocalizedString /** - * Filter companies by social media profiles + * List of phone numbers associated with the company */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + number: { + /** + * Phone Number + */ + displayName: () => LocalizedString + /** + * The phone number + */ + shortDesc: () => LocalizedString + /** + * The phone number in any format + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of phone number + */ + shortDesc: () => LocalizedString + /** + * The category or type of this phone number (work, mobile, home, or other) + */ + longDesc: () => LocalizedString + } + } + } + } } - followed: { + primary_contact_id: { /** - * Followed + * Primary Contact */ displayName: () => LocalizedString /** - * Following status + * Main contact person */ shortDesc: () => LocalizedString /** - * Filter companies by whether they are followed or not + * The primary contact person associated with this company */ longDesc: () => LocalizedString } - minimum_interaction_count: { + socials: { /** - * Minimum Interactions + * Social Media */ displayName: () => LocalizedString /** - * Minimum interaction count + * Social media profiles */ shortDesc: () => LocalizedString /** - * Filter companies with at least this many interactions + * List of social media profiles for the company */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Social media profile URL + */ + shortDesc: () => LocalizedString + /** + * The full URL to the social media profile + */ + longDesc: () => LocalizedString + } + category: { + /** + * Platform + */ + displayName: () => LocalizedString + /** + * Social media platform + */ + shortDesc: () => LocalizedString + /** + * The social media platform (LinkedIn, Twitter, Facebook, YouTube, Quora, Instagram, Pinterest, or Other) + */ + longDesc: () => LocalizedString + } + } + } + } } - maximum_interaction_count: { + tags: { /** - * Maximum Interactions + * Tags */ displayName: () => LocalizedString /** - * Maximum interaction count + * Company tags */ shortDesc: () => LocalizedString /** - * Filter companies with no more than this many interactions + * Tags to categorize and organize the company. You can create new tags or select from existing ones. */ longDesc: () => LocalizedString } - minimum_inactive_days: { + websites: { /** - * Minimum Inactive Days + * Websites */ displayName: () => LocalizedString /** - * Minimum days inactive + * Company websites */ shortDesc: () => LocalizedString /** - * Filter companies inactive for at least this many days + * List of websites associated with the company */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Website URL + */ + shortDesc: () => LocalizedString + /** + * The full URL of the website + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of website + */ + shortDesc: () => LocalizedString + /** + * The category or purpose of this website (work, personal, or other) + */ + longDesc: () => LocalizedString + } + } + } + } } - maximum_inactive_days: { + custom_fields: { /** - * Maximum Inactive Days + * Custom Fields */ displayName: () => LocalizedString /** - * Maximum days inactive + * Custom field values */ shortDesc: () => LocalizedString /** - * Filter companies inactive for no more than this many days + * Custom field values specific to your CopperCRM company configuration */ longDesc: () => LocalizedString } - minimum_created_date: { + } + } + create_lead: { + groups: { + /** + * Leads + */ + '0': () => LocalizedString + } + /** + * Create Lead + */ + displayName: () => LocalizedString + /** + * Create a new lead in CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Create a new lead record in CopperCRM with contact information and details. Leads represent potential customers who have shown interest in your products or services. + */ + longDesc: () => LocalizedString + options: { + first_name: { /** - * Created After + * First Name */ displayName: () => LocalizedString /** - * Earliest creation date + * Lead's first name */ shortDesc: () => LocalizedString /** - * Filter companies created on or after this date + * The first name of the lead */ longDesc: () => LocalizedString } - maximum_created_date: { + last_name: { /** - * Created Before + * Last Name */ displayName: () => LocalizedString /** - * Latest creation date + * Lead's last name */ shortDesc: () => LocalizedString /** - * Filter companies created on or before this date + * The last name of the lead */ longDesc: () => LocalizedString } - minimum_modified_date: { + middle_name: { /** - * Modified After + * Middle Name */ displayName: () => LocalizedString /** - * Earliest modification date + * Lead's middle name */ shortDesc: () => LocalizedString /** - * Filter companies modified on or after this date + * The middle name or initial of the lead */ longDesc: () => LocalizedString } - maximum_modified_date: { + suffix: { /** - * Modified Before + * Suffix */ displayName: () => LocalizedString /** - * Latest modification date + * Name suffix */ shortDesc: () => LocalizedString /** - * Filter companies modified on or before this date + * Name suffix such as Jr., Sr., III, etc. */ longDesc: () => LocalizedString } - } - } - search_leads: { - groups: { - /** - * Leads - */ - '0': () => LocalizedString - } - /** - * Search Leads - */ - displayName: () => LocalizedString - /** - * Search for leads in CopperCRM - */ - shortDesc: () => LocalizedString - /** - * Search and filter leads in CopperCRM using various criteria including name, email, phone, status, and custom fields. Returns a list of matching leads. - */ - longDesc: () => LocalizedString - options: { - ids: { + assignee_id: { /** - * Lead IDs + * Assignee */ displayName: () => LocalizedString /** - * Specific leads to retrieve + * User assigned to this lead */ shortDesc: () => LocalizedString /** - * List of specific lead IDs to retrieve + * The CopperCRM user who will be assigned to manage this lead */ longDesc: () => LocalizedString } - page_number: { + company_name: { /** - * Page Number + * Company Name */ displayName: () => LocalizedString /** - * Which page of results + * Lead's company name */ shortDesc: () => LocalizedString /** - * The page number of results to retrieve for pagination + * The name of the company where the lead works */ longDesc: () => LocalizedString } - page_size: { + tags: { /** - * Page Size + * Tags */ displayName: () => LocalizedString /** - * Results per page + * Lead tags */ shortDesc: () => LocalizedString /** - * The number of results to return per page + * Tags to categorize and organize the lead. You can create new tags or select from existing ones. */ longDesc: () => LocalizedString } - sort_by: { + title: { /** - * Sort By + * Title */ displayName: () => LocalizedString /** - * Field to sort by + * Job title */ shortDesc: () => LocalizedString /** - * The field to use for sorting the results + * The job title or position of the lead */ longDesc: () => LocalizedString } - sort_direction: { + details: { /** - * Sort Direction + * Details */ displayName: () => LocalizedString /** - * Sort order + * Additional notes */ shortDesc: () => LocalizedString /** - * The direction to sort results (ascending or descending) + * Additional notes, description, or important details about the lead */ longDesc: () => LocalizedString } - name: { + websites: { /** - * Name + * Websites */ displayName: () => LocalizedString /** - * Lead name to search + * Associated websites */ shortDesc: () => LocalizedString /** - * Search for leads with names matching this value + * List of websites associated with the lead */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Website URL + */ + shortDesc: () => LocalizedString + /** + * The full URL of the website + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of website + */ + shortDesc: () => LocalizedString + /** + * The category or purpose of this website (work, personal, or other) + */ + longDesc: () => LocalizedString + } + } + } + } } - phone_number: { + socials: { /** - * Phone Number + * Social Media */ displayName: () => LocalizedString /** - * Phone number to search + * Social media profiles */ shortDesc: () => LocalizedString /** - * Search for leads with this phone number + * List of social media profiles for the lead */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Social media profile URL + */ + shortDesc: () => LocalizedString + /** + * The full URL to the social media profile + */ + longDesc: () => LocalizedString + } + category: { + /** + * Platform + */ + displayName: () => LocalizedString + /** + * Social media platform + */ + shortDesc: () => LocalizedString + /** + * The social media platform (LinkedIn, Twitter, Facebook, YouTube, Quora, Instagram, Pinterest, or Other) + */ + longDesc: () => LocalizedString + } + } + } + } } - emails: { + email: { /** * Email */ displayName: () => LocalizedString /** - * Email to search + * Email address */ shortDesc: () => LocalizedString /** - * Search for leads with this email address + * The email address of the lead */ longDesc: () => LocalizedString + type: { + fields: { + email: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * The email address + */ + shortDesc: () => LocalizedString + /** + * The email address of the lead + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of email + */ + shortDesc: () => LocalizedString + /** + * The category or type of this email (work, personal, or other) + */ + longDesc: () => LocalizedString + } + } + } } - assignee_ids: { + phone_numbers: { /** - * Assignees + * Phone Numbers */ displayName: () => LocalizedString /** - * Assigned users + * Contact phone numbers */ shortDesc: () => LocalizedString /** - * Filter leads by assigned users + * List of phone numbers for the lead */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + number: { + /** + * Phone Number + */ + displayName: () => LocalizedString + /** + * The phone number + */ + shortDesc: () => LocalizedString + /** + * The phone number in any format + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of phone number + */ + shortDesc: () => LocalizedString + /** + * The category or type of this phone number + */ + longDesc: () => LocalizedString + } + } + } + } } - status_ids: { + address: { /** - * Statuses + * Address */ displayName: () => LocalizedString /** - * Lead statuses + * Contact address */ shortDesc: () => LocalizedString /** - * Filter leads by status + * The physical address of the lead including street, city, state, postal code, and country */ longDesc: () => LocalizedString + type: { + fields: { + street: { + /** + * Street + */ + displayName: () => LocalizedString + /** + * Street address + */ + shortDesc: () => LocalizedString + /** + * The street address + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * City name + */ + shortDesc: () => LocalizedString + /** + * The city where the lead is located + */ + longDesc: () => LocalizedString + } + state: { + /** + * State + */ + displayName: () => LocalizedString + /** + * State or province + */ + shortDesc: () => LocalizedString + /** + * The state or province + */ + longDesc: () => LocalizedString + } + postal_code: { + /** + * Postal Code + */ + displayName: () => LocalizedString + /** + * ZIP or postal code + */ + shortDesc: () => LocalizedString + /** + * The postal code or ZIP code + */ + longDesc: () => LocalizedString + } + country: { + /** + * Country + */ + displayName: () => LocalizedString + /** + * Country name + */ + shortDesc: () => LocalizedString + /** + * The country + */ + longDesc: () => LocalizedString + } + } + } } - customer_source_ids: { + customer_source_id: { /** - * Customer Sources + * Customer Source */ displayName: () => LocalizedString /** - * Lead sources + * How the lead was acquired */ shortDesc: () => LocalizedString /** - * Filter leads by customer source + * The source or channel through which this lead was acquired */ longDesc: () => LocalizedString } - city: { + custom_fields: { /** - * City + * Custom Fields */ displayName: () => LocalizedString /** - * City location + * Custom field values */ shortDesc: () => LocalizedString /** - * Filter leads by city + * Custom field values specific to your CopperCRM lead configuration */ longDesc: () => LocalizedString } - state: { + } + } + create_opportunity: { + groups: { + /** + * Opportunities + */ + '0': () => LocalizedString + } + /** + * Create Opportunity + */ + displayName: () => LocalizedString + /** + * Create a new opportunity in CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Create a new sales opportunity in CopperCRM with details like value, stage, and associated contacts. Opportunities represent potential deals in your sales pipeline. + */ + longDesc: () => LocalizedString + options: { + name: { /** - * State + * Opportunity Name */ displayName: () => LocalizedString /** - * State or province + * Name of the opportunity */ shortDesc: () => LocalizedString /** - * Filter leads by state or province + * A descriptive name for the sales opportunity */ longDesc: () => LocalizedString } - postal_code: { + primary_contact_id: { /** - * Postal Code + * Primary Contact */ displayName: () => LocalizedString /** - * ZIP or postal code + * Main contact person */ shortDesc: () => LocalizedString /** - * Filter leads by postal code + * The primary contact person associated with this opportunity */ longDesc: () => LocalizedString } - country: { + assignee_id: { /** - * Country + * Assignee */ displayName: () => LocalizedString /** - * Country location + * User assigned to this opportunity */ shortDesc: () => LocalizedString /** - * Filter leads by country + * The CopperCRM user who will be assigned to manage this opportunity */ longDesc: () => LocalizedString } - tags: { + close_date: { /** - * Tags + * Close Date */ displayName: () => LocalizedString /** - * Filter by tags + * Expected close date */ shortDesc: () => LocalizedString /** - * Filter leads that have any of these tags + * The expected date when this opportunity will be closed or won */ longDesc: () => LocalizedString } - socials: { + company_id: { /** - * Social Media + * Company */ displayName: () => LocalizedString /** - * Social media filter + * Associated company */ shortDesc: () => LocalizedString /** - * Filter leads by social media profiles + * The company associated with this opportunity */ longDesc: () => LocalizedString } - followed: { + customer_source_id: { /** - * Followed + * Customer Source */ displayName: () => LocalizedString /** - * Following status + * How the opportunity was acquired */ shortDesc: () => LocalizedString /** - * Filter leads by whether they are followed or not + * The source or channel through which this opportunity was acquired */ longDesc: () => LocalizedString } - age: { + details: { /** - * Age + * Details */ displayName: () => LocalizedString /** - * Lead age in days + * Additional notes */ shortDesc: () => LocalizedString /** - * Filter leads by their age in days + * Additional notes, description, or important details about the opportunity */ longDesc: () => LocalizedString } - minimum_monetary_value: { + loss_reason_id: { /** - * Minimum Value + * Loss Reason */ displayName: () => LocalizedString /** - * Minimum monetary value + * Reason for losing */ shortDesc: () => LocalizedString /** - * Filter leads with at least this monetary value + * The reason why this opportunity was lost (if applicable) */ longDesc: () => LocalizedString } - maximum_monetary_value: { + monetary_value: { /** - * Maximum Value + * Monetary Value */ displayName: () => LocalizedString /** - * Maximum monetary value + * Deal value */ shortDesc: () => LocalizedString /** - * Filter leads with no more than this monetary value + * The monetary value of the opportunity in your default currency */ longDesc: () => LocalizedString } - minimum_interaction_count: { + pipeline_id: { /** - * Minimum Interactions + * Pipeline */ displayName: () => LocalizedString /** - * Minimum interaction count + * Sales pipeline */ shortDesc: () => LocalizedString /** - * Filter leads with at least this many interactions + * The sales pipeline this opportunity belongs to */ longDesc: () => LocalizedString } - maximum_interaction_count: { + pipeline_stage_id: { /** - * Maximum Interactions + * Pipeline Stage */ displayName: () => LocalizedString /** - * Maximum interaction count + * Current stage */ shortDesc: () => LocalizedString /** - * Filter leads with no more than this many interactions + * The current stage of the opportunity in the sales pipeline */ longDesc: () => LocalizedString } - include_converted_leads: { + priority: { /** - * Include Converted Leads + * Priority */ displayName: () => LocalizedString /** - * Include converted leads + * Opportunity priority */ shortDesc: () => LocalizedString /** - * Whether to include leads that have been converted to opportunities + * The priority level of this opportunity (None, Low, Medium, or High) */ longDesc: () => LocalizedString } - } - } - search_opportunities: { - groups: { - /** - * Opportunities - */ - '0': () => LocalizedString - } - /** - * Search Opportunities - */ - displayName: () => LocalizedString - /** - * Search for opportunities in CopperCRM - */ - shortDesc: () => LocalizedString - /** - * Search and filter opportunities in CopperCRM using various criteria including name, pipeline, status, value, and custom fields. Returns a list of matching opportunities. - */ - longDesc: () => LocalizedString - options: { - ids: { + status: { /** - * Opportunity IDs + * Status */ displayName: () => LocalizedString /** - * Specific opportunities to retrieve + * Opportunity status */ shortDesc: () => LocalizedString /** - * List of specific opportunity IDs to retrieve + * The current status of the opportunity (Open, Won, Lost, or Abandoned) */ longDesc: () => LocalizedString } - page_number: { + tags: { /** - * Page Number + * Tags */ displayName: () => LocalizedString /** - * Which page of results + * Opportunity tags */ shortDesc: () => LocalizedString /** - * The page number of results to retrieve for pagination + * Tags to categorize and organize the opportunity. You can create new tags or select from existing ones. */ longDesc: () => LocalizedString } - page_size: { + win_probability: { /** - * Page Size + * Win Probability */ displayName: () => LocalizedString /** - * Results per page + * Probability of winning */ shortDesc: () => LocalizedString /** - * The number of results to return per page + * The estimated probability (0-100) of winning this opportunity */ longDesc: () => LocalizedString } - sort_by: { + custom_fields: { /** - * Sort By + * Custom Fields */ displayName: () => LocalizedString /** - * Field to sort by + * Custom field values */ shortDesc: () => LocalizedString /** - * The field to use for sorting the results + * Custom field values specific to your CopperCRM opportunity configuration */ longDesc: () => LocalizedString } - sort_direction: { + } + } + create_person: { + groups: { + /** + * People + */ + '0': () => LocalizedString + } + /** + * Create Person + */ + displayName: () => LocalizedString + /** + * Create a new person contact in CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Create a new person contact in CopperCRM with complete contact information. People represent individual contacts in your CRM. + */ + longDesc: () => LocalizedString + options: { + name: { /** - * Sort Direction + * Name */ displayName: () => LocalizedString /** - * Sort order + * Full name of the person */ shortDesc: () => LocalizedString /** - * The direction to sort results (ascending or descending) + * The full name of the person contact */ longDesc: () => LocalizedString } - name: { + prefix: { /** - * Name + * Prefix */ displayName: () => LocalizedString /** - * Opportunity name to search + * Name prefix */ shortDesc: () => LocalizedString /** - * Search for opportunities with names matching this value + * Name prefix such as Mr., Mrs., Dr., etc. */ longDesc: () => LocalizedString } - assignee_ids: { + first_name: { /** - * Assignees + * First Name */ displayName: () => LocalizedString /** - * Assigned users + * First name */ shortDesc: () => LocalizedString /** - * Filter opportunities by assigned users + * The first name of the person */ longDesc: () => LocalizedString } - company_ids: { + middle_name: { /** - * Companies + * Middle Name */ displayName: () => LocalizedString /** - * Associated companies + * Middle name */ shortDesc: () => LocalizedString /** - * Filter opportunities by associated companies + * The middle name or initial of the person */ longDesc: () => LocalizedString } - customer_source_ids: { + last_name: { /** - * Customer Sources + * Last Name */ displayName: () => LocalizedString /** - * Opportunity sources + * Last name */ shortDesc: () => LocalizedString /** - * Filter opportunities by customer source + * The last name of the person */ longDesc: () => LocalizedString } - loss_reason_ids: { + suffix: { /** - * Loss Reasons + * Suffix */ displayName: () => LocalizedString /** - * Reasons for loss + * Name suffix */ shortDesc: () => LocalizedString /** - * Filter opportunities by loss reason + * Name suffix such as Jr., Sr., III, etc. */ longDesc: () => LocalizedString } - pipeline_ids: { + street: { /** - * Pipelines + * Street */ displayName: () => LocalizedString /** - * Sales pipelines + * Street address */ shortDesc: () => LocalizedString /** - * Filter opportunities by pipeline + * The street address of the person */ longDesc: () => LocalizedString } - pipeline_stage_ids: { + city: { /** - * Pipeline Stages + * City */ displayName: () => LocalizedString /** - * Current stages + * City name */ shortDesc: () => LocalizedString /** - * Filter opportunities by pipeline stage + * The city where the person is located */ longDesc: () => LocalizedString } - primary_contact_ids: { + state: { /** - * Primary Contacts + * State */ displayName: () => LocalizedString /** - * Main contacts + * State or province */ shortDesc: () => LocalizedString /** - * Filter opportunities by primary contact + * The state or province */ longDesc: () => LocalizedString } - priorities: { + postal_code: { /** - * Priorities + * Postal Code */ displayName: () => LocalizedString /** - * Priority levels + * ZIP or postal code */ shortDesc: () => LocalizedString /** - * Filter opportunities by priority level + * The postal code or ZIP code */ longDesc: () => LocalizedString } - statuses: { + country: { /** - * Statuses + * Country */ displayName: () => LocalizedString /** - * Opportunity statuses + * Country name */ shortDesc: () => LocalizedString /** - * Filter opportunities by status (Open, Won, Lost, Abandoned) + * The country */ longDesc: () => LocalizedString } - tags: { + assignee_id: { /** - * Tags + * Assignee */ displayName: () => LocalizedString /** - * Filter by tags + * User assigned to this person */ shortDesc: () => LocalizedString /** - * Filter opportunities that have any of these tags + * The CopperCRM user who will be assigned to manage this contact */ longDesc: () => LocalizedString } - followed: { + company_id: { /** - * Followed + * Company */ displayName: () => LocalizedString /** - * Following status + * Associated company */ shortDesc: () => LocalizedString /** - * Filter opportunities by whether they are followed or not + * The company where this person works */ longDesc: () => LocalizedString } - minimum_monetary_value: { + contact_type_id: { /** - * Minimum Value + * Contact Type */ displayName: () => LocalizedString /** - * Minimum deal value + * Type of contact relationship */ shortDesc: () => LocalizedString /** - * Filter opportunities with at least this monetary value + * The type of contact relationship this person has with your organization */ longDesc: () => LocalizedString } - maximum_monetary_value: { + details: { /** - * Maximum Value + * Details */ displayName: () => LocalizedString /** - * Maximum deal value + * Additional notes */ shortDesc: () => LocalizedString /** - * Filter opportunities with no more than this monetary value + * Additional notes, description, or important details about the person */ longDesc: () => LocalizedString } - minimum_win_probability: { + emails: { /** - * Minimum Win Probability + * Email Addresses */ displayName: () => LocalizedString /** - * Minimum win chance + * Email addresses */ shortDesc: () => LocalizedString /** - * Filter opportunities with at least this win probability - */ - longDesc: () => LocalizedString - } - maximum_win_probability: { - /** - * Maximum Win Probability - */ - displayName: () => LocalizedString - /** - * Maximum win chance - */ - shortDesc: () => LocalizedString - /** - * Filter opportunities with no more than this win probability - */ - longDesc: () => LocalizedString - } - minimum_interaction_count: { - /** - * Minimum Interactions - */ - displayName: () => LocalizedString - /** - * Minimum interaction count - */ - shortDesc: () => LocalizedString - /** - * Filter opportunities with at least this many interactions - */ - longDesc: () => LocalizedString - } - maximum_interaction_count: { - /** - * Maximum Interactions - */ - displayName: () => LocalizedString - /** - * Maximum interaction count - */ - shortDesc: () => LocalizedString - /** - * Filter opportunities with no more than this many interactions - */ - longDesc: () => LocalizedString - } - minimum_close_date: { - /** - * Close Date After - */ - displayName: () => LocalizedString - /** - * Earliest close date - */ - shortDesc: () => LocalizedString - /** - * Filter opportunities with close date on or after this date - */ - longDesc: () => LocalizedString - } - maximum_close_date: { - /** - * Close Date Before - */ - displayName: () => LocalizedString - /** - * Latest close date - */ - shortDesc: () => LocalizedString - /** - * Filter opportunities with close date on or before this date + * List of email addresses for the person */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + email: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * The email address + */ + shortDesc: () => LocalizedString + /** + * Email address + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of email + */ + shortDesc: () => LocalizedString + /** + * The category or type of this email (work, personal, or other) + */ + longDesc: () => LocalizedString + } + } + } + } } - minimum_created_date: { + phone_numbers: { /** - * Created After + * Phone Numbers */ displayName: () => LocalizedString /** - * Earliest creation date + * Contact phone numbers */ shortDesc: () => LocalizedString /** - * Filter opportunities created on or after this date + * List of phone numbers for the person */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + number: { + /** + * Phone Number + */ + displayName: () => LocalizedString + /** + * The phone number + */ + shortDesc: () => LocalizedString + /** + * Phone number + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of phone number + */ + shortDesc: () => LocalizedString + /** + * The category or type of this phone number (work, mobile, home, or other) + */ + longDesc: () => LocalizedString + } + } + } + } } - maximum_created_date: { + socials: { /** - * Created Before + * Social Media */ displayName: () => LocalizedString /** - * Latest creation date + * Social media profiles */ shortDesc: () => LocalizedString /** - * Filter opportunities created on or before this date + * List of social media profiles for the person */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Social profile URL + */ + shortDesc: () => LocalizedString + /** + * Social profile URL + */ + longDesc: () => LocalizedString + } + category: { + /** + * Platform + */ + displayName: () => LocalizedString + /** + * Social media platform + */ + shortDesc: () => LocalizedString + /** + * Social platform + */ + longDesc: () => LocalizedString + } + } + } + } } - minimum_modified_date: { + tags: { /** - * Modified After + * Tags */ displayName: () => LocalizedString /** - * Earliest modification date + * Person tags */ shortDesc: () => LocalizedString /** - * Filter opportunities modified on or after this date + * Tags to categorize and organize the person. You can create new tags or select from existing ones. */ longDesc: () => LocalizedString } - maximum_modified_date: { + title: { /** - * Modified Before + * Title */ displayName: () => LocalizedString /** - * Latest modification date + * Job title */ shortDesc: () => LocalizedString /** - * Filter opportunities modified on or before this date + * The job title or position of the person */ longDesc: () => LocalizedString } - minimum_stage_change_date: { + websites: { /** - * Stage Changed After + * Websites */ displayName: () => LocalizedString /** - * Earliest stage change + * Associated websites */ shortDesc: () => LocalizedString /** - * Filter opportunities with stage changed on or after this date + * List of websites associated with the person */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Website URL + */ + shortDesc: () => LocalizedString + /** + * Website URL + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of website + */ + shortDesc: () => LocalizedString + /** + * The category or purpose of this website (work, personal, or other) + */ + longDesc: () => LocalizedString + } + } + } + } } - maximum_stage_change_date: { + custom_fields: { /** - * Stage Changed Before + * Custom Fields */ displayName: () => LocalizedString /** - * Latest stage change + * Custom field values */ shortDesc: () => LocalizedString /** - * Filter opportunities with stage changed on or before this date + * Custom field values specific to your CopperCRM person configuration */ longDesc: () => LocalizedString } } } - search_people: { + create_task: { groups: { /** - * People + * Tasks */ '0': () => LocalizedString } /** - * Search People + * Create Task */ displayName: () => LocalizedString /** - * Search for person contacts in CopperCRM + * Create a new task in CopperCRM */ shortDesc: () => LocalizedString /** - * Search and filter people in CopperCRM using various criteria including name, email, phone, company, and custom fields. Returns a list of matching person contacts. + * Create a new task in CopperCRM with details, due dates, and assignments. Tasks help you track action items and follow-ups. */ longDesc: () => LocalizedString options: { - ids: { - /** - * Person IDs - */ - displayName: () => LocalizedString - /** - * Specific people to retrieve - */ - shortDesc: () => LocalizedString - /** - * List of specific person IDs to retrieve - */ - longDesc: () => LocalizedString - } name: { /** - * Name - */ - displayName: () => LocalizedString - /** - * Person name to search - */ - shortDesc: () => LocalizedString - /** - * Search for people with names matching this value - */ - longDesc: () => LocalizedString - } - title: { - /** - * Title - */ - displayName: () => LocalizedString - /** - * Job title to search - */ - shortDesc: () => LocalizedString - /** - * Search for people with this job title - */ - longDesc: () => LocalizedString - } - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * Email to search - */ - shortDesc: () => LocalizedString - /** - * Search for people with this email address - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone + * Task Name */ displayName: () => LocalizedString /** - * Phone number to search + * Name of the task */ shortDesc: () => LocalizedString /** - * Search for people with this phone number + * A descriptive name for the task */ longDesc: () => LocalizedString } - city: { + related_resource: { /** - * City + * Related Resource */ displayName: () => LocalizedString /** - * City location + * Associated record */ shortDesc: () => LocalizedString /** - * Filter people by city + * The CRM record (lead, person, company, opportunity, or project) this task is related to */ longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Resource ID + */ + displayName: () => LocalizedString + /** + * ID of the related record + */ + shortDesc: () => LocalizedString + /** + * The ID of the related CRM record + */ + longDesc: () => LocalizedString + } + type: { + /** + * Resource Type + */ + displayName: () => LocalizedString + /** + * Type of related record + */ + shortDesc: () => LocalizedString + /** + * The type of CRM record this task is related to (lead, person, company, opportunity, or project) + */ + longDesc: () => LocalizedString + } + } + } } - state: { + assignee_id: { /** - * State + * Assignee */ displayName: () => LocalizedString /** - * State or province + * User assigned to this task */ shortDesc: () => LocalizedString /** - * Filter people by state or province + * The CopperCRM user who will be assigned to complete this task */ longDesc: () => LocalizedString } - postal_code: { + due_date: { /** - * Postal Code + * Due Date */ displayName: () => LocalizedString /** - * ZIP or postal code + * When the task is due */ shortDesc: () => LocalizedString /** - * Filter people by postal code + * The date when this task should be completed */ longDesc: () => LocalizedString } - country: { + reminder_date: { /** - * Country + * Reminder Date */ displayName: () => LocalizedString /** - * Country location + * When to send reminder */ shortDesc: () => LocalizedString /** - * Filter people by country + * The date when a reminder should be sent for this task */ longDesc: () => LocalizedString } - assignee_ids: { + priority: { /** - * Assignees + * Priority */ displayName: () => LocalizedString /** - * Assigned users + * Task priority */ shortDesc: () => LocalizedString /** - * Filter people by assigned users + * The priority level of this task (None, Low, Medium, or High) */ longDesc: () => LocalizedString } - contact_type_ids: { + status: { /** - * Contact Types + * Status */ displayName: () => LocalizedString /** - * Contact type filter + * Task status */ shortDesc: () => LocalizedString /** - * Filter people by contact type + * The current status of the task (Open or Completed) */ longDesc: () => LocalizedString } - company_ids: { + details: { /** - * Companies + * Details */ displayName: () => LocalizedString /** - * Associated companies + * Task description */ shortDesc: () => LocalizedString /** - * Filter people by associated companies + * Additional details or description of what needs to be done */ longDesc: () => LocalizedString } @@ -133215,201 +134028,421 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Filter by tags + * Task tags */ shortDesc: () => LocalizedString /** - * Filter people that have any of these tags + * Tags to categorize and organize the task. You can create new tags or select from existing ones. */ longDesc: () => LocalizedString } - socials: { + custom_fields: { /** - * Social Media + * Custom Fields */ displayName: () => LocalizedString /** - * Social media profiles + * Custom field values */ shortDesc: () => LocalizedString /** - * Filter people by social media profiles + * Custom field values specific to your CopperCRM task configuration */ longDesc: () => LocalizedString } - minimum_interaction_count: { + } + } + delete_company: { + groups: { + /** + * Companies + */ + '0': () => LocalizedString + } + /** + * Delete Company + */ + displayName: () => LocalizedString + /** + * Delete a company from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Permanently delete a company record from CopperCRM. This action cannot be undone. + */ + longDesc: () => LocalizedString + options: { + company_id: { /** - * Minimum Interactions + * Company */ displayName: () => LocalizedString /** - * Minimum interaction count + * Company to delete */ shortDesc: () => LocalizedString /** - * Filter people with at least this many interactions + * Select the company you want to delete from CopperCRM */ longDesc: () => LocalizedString } - maximum_interaction_count: { + } + } + delete_lead: { + groups: { + /** + * Leads + */ + '0': () => LocalizedString + } + /** + * Delete Lead + */ + displayName: () => LocalizedString + /** + * Delete a lead from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Permanently delete a lead record from CopperCRM. This action cannot be undone. + */ + longDesc: () => LocalizedString + options: { + lead_id: { /** - * Maximum Interactions + * Lead */ displayName: () => LocalizedString /** - * Maximum interaction count + * Lead to delete */ shortDesc: () => LocalizedString /** - * Filter people with no more than this many interactions + * Select the lead you want to delete from CopperCRM */ longDesc: () => LocalizedString } - minimum_created_date: { + } + } + delete_opportunity: { + groups: { + /** + * Opportunities + */ + '0': () => LocalizedString + } + /** + * Delete Opportunity + */ + displayName: () => LocalizedString + /** + * Delete an opportunity from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Permanently delete an opportunity record from CopperCRM. This action cannot be undone. + */ + longDesc: () => LocalizedString + options: { + opportunity_id: { /** - * Created After + * Opportunity */ displayName: () => LocalizedString /** - * Earliest creation date + * Opportunity to delete */ shortDesc: () => LocalizedString /** - * Filter people created on or after this date + * Select the opportunity you want to delete from CopperCRM */ longDesc: () => LocalizedString } - maximum_created_date: { + } + } + delete_person: { + groups: { + /** + * People + */ + '0': () => LocalizedString + } + /** + * Delete Person + */ + displayName: () => LocalizedString + /** + * Delete a person contact from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Permanently delete a person contact record from CopperCRM. This action cannot be undone. + */ + longDesc: () => LocalizedString + options: { + person_id: { /** - * Created Before + * Person */ displayName: () => LocalizedString /** - * Latest creation date + * Person to delete */ shortDesc: () => LocalizedString /** - * Filter people created on or before this date + * Select the person contact you want to delete from CopperCRM */ longDesc: () => LocalizedString } - minimum_modified_date: { + } + } + delete_task: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + /** + * Delete Task + */ + displayName: () => LocalizedString + /** + * Delete a task from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Permanently delete a task from CopperCRM. This action cannot be undone. + */ + longDesc: () => LocalizedString + options: { + task_id: { /** - * Modified After + * Task */ displayName: () => LocalizedString /** - * Earliest modification date + * Task to delete */ shortDesc: () => LocalizedString /** - * Filter people modified on or after this date + * Select the task you want to delete from CopperCRM */ longDesc: () => LocalizedString } - maximum_modified_date: { + } + } + get_company: { + groups: { + /** + * Companies + */ + '0': () => LocalizedString + } + /** + * Get Company + */ + displayName: () => LocalizedString + /** + * Retrieve a company from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Retrieve detailed information about a specific company record from CopperCRM including all fields and custom data. + */ + longDesc: () => LocalizedString + options: { + company_id: { /** - * Modified Before + * Company */ displayName: () => LocalizedString /** - * Latest modification date + * Company to retrieve */ shortDesc: () => LocalizedString /** - * Filter people modified on or before this date + * Select the company you want to retrieve from CopperCRM */ longDesc: () => LocalizedString } - sort_by: { + } + } + get_lead: { + groups: { + /** + * Leads + */ + '0': () => LocalizedString + } + /** + * Get Lead + */ + displayName: () => LocalizedString + /** + * Retrieve a lead from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Retrieve detailed information about a specific lead record from CopperCRM including all fields and custom data. + */ + longDesc: () => LocalizedString + options: { + lead_id: { /** - * Sort By + * Lead */ displayName: () => LocalizedString /** - * Field to sort by + * Lead to retrieve */ shortDesc: () => LocalizedString /** - * Field to sort results by + * Select the lead you want to retrieve from CopperCRM */ longDesc: () => LocalizedString } - sort_direction: { + } + } + get_opportunity: { + groups: { + /** + * Opportunities + */ + '0': () => LocalizedString + } + /** + * Get Opportunity + */ + displayName: () => LocalizedString + /** + * Retrieve an opportunity from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Retrieve detailed information about a specific opportunity record from CopperCRM including all fields and custom data. + */ + longDesc: () => LocalizedString + options: { + opportunity_id: { /** - * Sort Direction + * Opportunity */ displayName: () => LocalizedString /** - * Sort order + * Opportunity to retrieve */ shortDesc: () => LocalizedString /** - * The direction to sort results (ascending or descending) + * Select the opportunity you want to retrieve from CopperCRM */ longDesc: () => LocalizedString } - page_number: { + } + } + get_person: { + groups: { + /** + * People + */ + '0': () => LocalizedString + } + /** + * Get Person + */ + displayName: () => LocalizedString + /** + * Retrieve a person contact from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Retrieve detailed information about a specific person contact record from CopperCRM including all fields and custom data. + */ + longDesc: () => LocalizedString + options: { + person_id: { /** - * Page Number + * Person */ displayName: () => LocalizedString /** - * Which page of results + * Person to retrieve */ shortDesc: () => LocalizedString /** - * The page number of results to retrieve for pagination + * Select the person contact you want to retrieve from CopperCRM */ longDesc: () => LocalizedString } - page_size: { + } + } + get_task: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + /** + * Get Task + */ + displayName: () => LocalizedString + /** + * Retrieve a task from CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Retrieve detailed information about a specific task from CopperCRM including all fields and custom data. + */ + longDesc: () => LocalizedString + options: { + task_id: { /** - * Page Size + * Task */ displayName: () => LocalizedString /** - * Results per page + * Task to retrieve */ shortDesc: () => LocalizedString /** - * The number of results to return per page + * Select the task you want to retrieve from CopperCRM */ longDesc: () => LocalizedString } } } - search_tasks: { + search_companies: { groups: { /** - * Tasks + * Companies */ '0': () => LocalizedString } /** - * Search Tasks + * Search Companies */ displayName: () => LocalizedString /** - * Search for tasks in CopperCRM + * Search for companies in CopperCRM */ shortDesc: () => LocalizedString /** - * Search and filter tasks in CopperCRM using various criteria including assignee, status, priority, due date, and custom fields. Returns a list of matching tasks. + * Search and filter companies in CopperCRM using various criteria including name, location, tags, and custom fields. Returns a list of matching companies. */ longDesc: () => LocalizedString options: { ids: { /** - * Task IDs + * Company IDs */ displayName: () => LocalizedString /** - * Specific tasks to retrieve + * Specific companies to retrieve */ shortDesc: () => LocalizedString /** - * List of specific task IDs to retrieve + * List of specific company IDs to retrieve */ longDesc: () => LocalizedString } @@ -133469,6 +134502,20 @@ export type TranslationFunctions = { */ longDesc: () => LocalizedString } + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * Company name to search + */ + shortDesc: () => LocalizedString + /** + * Search for companies with names matching this value + */ + longDesc: () => LocalizedString + } assignee_ids: { /** * Assignees @@ -133479,147 +134526,175 @@ export type TranslationFunctions = { */ shortDesc: () => LocalizedString /** - * Filter tasks by assigned users + * Filter companies by assigned users */ longDesc: () => LocalizedString } - statuses: { + contact_type_ids: { /** - * Statuses + * Contact Types */ displayName: () => LocalizedString /** - * Task statuses + * Contact type filter */ shortDesc: () => LocalizedString /** - * Filter tasks by status (Open or Completed) + * Filter companies by contact type */ longDesc: () => LocalizedString } - priorities: { + city: { /** - * Priorities + * City */ displayName: () => LocalizedString /** - * Priority levels + * City location */ shortDesc: () => LocalizedString /** - * Filter tasks by priority level + * Filter companies by city */ longDesc: () => LocalizedString } - tags: { + state: { /** - * Tags + * State */ displayName: () => LocalizedString /** - * Filter by tags + * State or province */ shortDesc: () => LocalizedString /** - * Filter tasks that have any of these tags + * Filter companies by state or province */ longDesc: () => LocalizedString } - followed: { + postal_code: { /** - * Followed + * Postal Code */ displayName: () => LocalizedString /** - * Following status + * ZIP or postal code */ shortDesc: () => LocalizedString /** - * Filter tasks by whether they are followed or not + * Filter companies by postal code */ longDesc: () => LocalizedString } - minimum_due_date: { + country: { /** - * Due Date After + * Country */ displayName: () => LocalizedString /** - * Earliest due date + * Country location */ shortDesc: () => LocalizedString /** - * Filter tasks with due date on or after this date + * Filter companies by country */ longDesc: () => LocalizedString } - maximum_due_date: { + tags: { /** - * Due Date Before + * Tags */ displayName: () => LocalizedString /** - * Latest due date + * Filter by tags */ shortDesc: () => LocalizedString /** - * Filter tasks with due date on or before this date + * Filter companies that have any of these tags */ longDesc: () => LocalizedString } - minimum_reminder_date: { + socials: { /** - * Reminder After + * Social Media */ displayName: () => LocalizedString /** - * Earliest reminder date + * Social media filter */ shortDesc: () => LocalizedString /** - * Filter tasks with reminder date on or after this date + * Filter companies by social media profiles */ longDesc: () => LocalizedString } - maximum_reminder_date: { + followed: { /** - * Reminder Before + * Followed */ displayName: () => LocalizedString /** - * Latest reminder date + * Following status */ shortDesc: () => LocalizedString /** - * Filter tasks with reminder date on or before this date + * Filter companies by whether they are followed or not */ longDesc: () => LocalizedString } - minimum_completed_date: { + minimum_interaction_count: { /** - * Completed After + * Minimum Interactions */ displayName: () => LocalizedString /** - * Earliest completion date + * Minimum interaction count */ shortDesc: () => LocalizedString /** - * Filter tasks completed on or after this date + * Filter companies with at least this many interactions */ longDesc: () => LocalizedString } - maximum_completed_date: { + maximum_interaction_count: { /** - * Completed Before + * Maximum Interactions */ displayName: () => LocalizedString /** - * Latest completion date + * Maximum interaction count */ shortDesc: () => LocalizedString /** - * Filter tasks completed on or before this date + * Filter companies with no more than this many interactions + */ + longDesc: () => LocalizedString + } + minimum_inactive_days: { + /** + * Minimum Inactive Days + */ + displayName: () => LocalizedString + /** + * Minimum days inactive + */ + shortDesc: () => LocalizedString + /** + * Filter companies inactive for at least this many days + */ + longDesc: () => LocalizedString + } + maximum_inactive_days: { + /** + * Maximum Inactive Days + */ + displayName: () => LocalizedString + /** + * Maximum days inactive + */ + shortDesc: () => LocalizedString + /** + * Filter companies inactive for no more than this many days */ longDesc: () => LocalizedString } @@ -133633,7 +134708,7 @@ export type TranslationFunctions = { */ shortDesc: () => LocalizedString /** - * Filter tasks created on or after this date + * Filter companies created on or after this date */ longDesc: () => LocalizedString } @@ -133647,7 +134722,7 @@ export type TranslationFunctions = { */ shortDesc: () => LocalizedString /** - * Filter tasks created on or before this date + * Filter companies created on or before this date */ longDesc: () => LocalizedString } @@ -133661,7 +134736,7 @@ export type TranslationFunctions = { */ shortDesc: () => LocalizedString /** - * Filter tasks modified on or after this date + * Filter companies modified on or after this date */ longDesc: () => LocalizedString } @@ -133675,1507 +134750,1013 @@ export type TranslationFunctions = { */ shortDesc: () => LocalizedString /** - * Filter tasks modified on or before this date + * Filter companies modified on or before this date */ longDesc: () => LocalizedString } } } - update_company: { + search_leads: { groups: { /** - * Companies + * Leads */ '0': () => LocalizedString } /** - * Update Company + * Search Leads */ displayName: () => LocalizedString /** - * Update an existing company in CopperCRM + * Search for leads in CopperCRM */ shortDesc: () => LocalizedString /** - * Update the details of an existing company record in CopperCRM including name, address, contact information, and custom fields. + * Search and filter leads in CopperCRM using various criteria including name, email, phone, status, and custom fields. Returns a list of matching leads. */ longDesc: () => LocalizedString options: { - company_id: { + ids: { /** - * Company + * Lead IDs */ displayName: () => LocalizedString /** - * Company to update + * Specific leads to retrieve */ shortDesc: () => LocalizedString /** - * Select the company you want to update + * List of specific lead IDs to retrieve */ longDesc: () => LocalizedString } - name: { + page_number: { /** - * Company Name + * Page Number */ displayName: () => LocalizedString /** - * Updated company name + * Which page of results */ shortDesc: () => LocalizedString /** - * The new name for the company + * The page number of results to retrieve for pagination */ longDesc: () => LocalizedString } - address: { + page_size: { /** - * Address + * Page Size */ displayName: () => LocalizedString /** - * Updated address + * Results per page */ shortDesc: () => LocalizedString /** - * The updated physical address of the company + * The number of results to return per page */ longDesc: () => LocalizedString - type: { - fields: { - street: { - /** - * Street - */ - displayName: () => LocalizedString - /** - * Street address - */ - shortDesc: () => LocalizedString - /** - * The street address of the company - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * City name - */ - shortDesc: () => LocalizedString - /** - * The city where the company is located - */ - longDesc: () => LocalizedString - } - state: { - /** - * State - */ - displayName: () => LocalizedString - /** - * State or province - */ - shortDesc: () => LocalizedString - /** - * The state or province where the company is located - */ - longDesc: () => LocalizedString - } - postal_code: { - /** - * Postal Code - */ - displayName: () => LocalizedString - /** - * ZIP or postal code - */ - shortDesc: () => LocalizedString - /** - * The postal code or ZIP code of the company address - */ - longDesc: () => LocalizedString - } - country: { - /** - * Country - */ - displayName: () => LocalizedString - /** - * Country name - */ - shortDesc: () => LocalizedString - /** - * The country where the company is located - */ - longDesc: () => LocalizedString - } - } - } } - assignee_id: { + sort_by: { /** - * Assignee + * Sort By */ displayName: () => LocalizedString /** - * Updated assignee + * Field to sort by */ shortDesc: () => LocalizedString /** - * The new CopperCRM user to assign to this company + * The field to use for sorting the results */ longDesc: () => LocalizedString } - contact_type_id: { + sort_direction: { /** - * Contact Type + * Sort Direction */ displayName: () => LocalizedString /** - * Updated contact type + * Sort order */ shortDesc: () => LocalizedString /** - * The updated type of contact relationship + * The direction to sort results (ascending or descending) */ longDesc: () => LocalizedString } - details: { + name: { /** - * Details + * Name */ displayName: () => LocalizedString /** - * Updated notes + * Lead name to search */ shortDesc: () => LocalizedString /** - * Updated notes, description, or important details + * Search for leads with names matching this value */ longDesc: () => LocalizedString } - email_domain: { + phone_number: { /** - * Email Domain + * Phone Number */ displayName: () => LocalizedString /** - * Updated email domain + * Phone number to search */ shortDesc: () => LocalizedString /** - * The updated primary email domain + * Search for leads with this phone number */ longDesc: () => LocalizedString } - phone_numbers: { + emails: { /** - * Phone Numbers + * Email */ displayName: () => LocalizedString /** - * Updated phone numbers + * Email to search */ shortDesc: () => LocalizedString /** - * Updated list of phone numbers + * Search for leads with this email address */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - number: { - /** - * Phone Number - */ - displayName: () => LocalizedString - /** - * The phone number - */ - shortDesc: () => LocalizedString - /** - * The phone number in any format - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of phone number - */ - shortDesc: () => LocalizedString - /** - * The category or type of this phone number - */ - longDesc: () => LocalizedString - } - } - } - } } - primary_contact_id: { + assignee_ids: { /** - * Primary Contact + * Assignees */ displayName: () => LocalizedString /** - * Updated primary contact + * Assigned users */ shortDesc: () => LocalizedString /** - * The new primary contact person for this company + * Filter leads by assigned users */ longDesc: () => LocalizedString } - socials: { + status_ids: { /** - * Social Media + * Statuses */ displayName: () => LocalizedString /** - * Updated social profiles + * Lead statuses */ shortDesc: () => LocalizedString /** - * Updated list of social media profiles + * Filter leads by status */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Social media profile URL - */ - shortDesc: () => LocalizedString - /** - * The full URL to the social media profile - */ - longDesc: () => LocalizedString - } - category: { - /** - * Platform - */ - displayName: () => LocalizedString - /** - * Social media platform - */ - shortDesc: () => LocalizedString - /** - * The social media platform - */ - longDesc: () => LocalizedString - } - } - } - } } - tags: { + customer_source_ids: { /** - * Tags + * Customer Sources */ displayName: () => LocalizedString /** - * Updated tags + * Lead sources */ shortDesc: () => LocalizedString /** - * Updated tags to categorize and organize the company + * Filter leads by customer source */ longDesc: () => LocalizedString } - websites: { + city: { /** - * Websites + * City */ displayName: () => LocalizedString /** - * Updated websites + * City location */ shortDesc: () => LocalizedString /** - * Updated list of websites + * Filter leads by city */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Website URL - */ - shortDesc: () => LocalizedString - /** - * The full URL of the website - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of website - */ - shortDesc: () => LocalizedString - /** - * The category or purpose of this website - */ - longDesc: () => LocalizedString - } - } - } - } } - custom_fields: { + state: { /** - * Custom Fields + * State */ displayName: () => LocalizedString /** - * Updated custom fields + * State or province */ shortDesc: () => LocalizedString /** - * Updated custom field values + * Filter leads by state or province */ longDesc: () => LocalizedString } - } - } - update_lead: { - groups: { - /** - * Leads - */ - '0': () => LocalizedString - } - /** - * Update Lead - */ - displayName: () => LocalizedString - /** - * Update an existing lead in CopperCRM - */ - shortDesc: () => LocalizedString - /** - * Update the details of an existing lead record in CopperCRM including contact information, status, and custom fields. - */ - longDesc: () => LocalizedString - options: { - lead_id: { + postal_code: { /** - * Lead + * Postal Code */ displayName: () => LocalizedString /** - * Lead to update + * ZIP or postal code */ shortDesc: () => LocalizedString /** - * Select the lead you want to update + * Filter leads by postal code */ longDesc: () => LocalizedString } - first_name: { + country: { /** - * First Name + * Country */ displayName: () => LocalizedString /** - * Updated first name + * Country location */ shortDesc: () => LocalizedString /** - * The updated first name of the lead + * Filter leads by country */ longDesc: () => LocalizedString } - last_name: { + tags: { /** - * Last Name + * Tags */ displayName: () => LocalizedString /** - * Updated last name + * Filter by tags */ shortDesc: () => LocalizedString /** - * The updated last name of the lead + * Filter leads that have any of these tags */ longDesc: () => LocalizedString } - middle_name: { + socials: { /** - * Middle Name + * Social Media */ displayName: () => LocalizedString /** - * Updated middle name + * Social media filter */ shortDesc: () => LocalizedString /** - * The updated middle name or initial + * Filter leads by social media profiles */ longDesc: () => LocalizedString } - suffix: { + followed: { /** - * Suffix + * Followed */ displayName: () => LocalizedString /** - * Updated suffix + * Following status */ shortDesc: () => LocalizedString /** - * Updated name suffix + * Filter leads by whether they are followed or not */ longDesc: () => LocalizedString } - assignee_id: { + age: { /** - * Assignee + * Age */ displayName: () => LocalizedString /** - * Updated assignee + * Lead age in days */ shortDesc: () => LocalizedString /** - * The new CopperCRM user to assign to this lead + * Filter leads by their age in days */ longDesc: () => LocalizedString } - company_name: { + minimum_monetary_value: { /** - * Company Name + * Minimum Value */ displayName: () => LocalizedString /** - * Updated company name + * Minimum monetary value */ shortDesc: () => LocalizedString /** - * The updated company name where the lead works + * Filter leads with at least this monetary value */ longDesc: () => LocalizedString } - tags: { + maximum_monetary_value: { /** - * Tags + * Maximum Value */ displayName: () => LocalizedString /** - * Updated tags + * Maximum monetary value */ shortDesc: () => LocalizedString /** - * Updated tags to categorize and organize the lead + * Filter leads with no more than this monetary value */ longDesc: () => LocalizedString } - title: { + minimum_interaction_count: { /** - * Title + * Minimum Interactions */ displayName: () => LocalizedString /** - * Updated job title + * Minimum interaction count */ shortDesc: () => LocalizedString /** - * The updated job title or position + * Filter leads with at least this many interactions */ longDesc: () => LocalizedString } - details: { + maximum_interaction_count: { /** - * Details + * Maximum Interactions */ displayName: () => LocalizedString /** - * Updated notes + * Maximum interaction count */ shortDesc: () => LocalizedString /** - * Updated notes, description, or important details + * Filter leads with no more than this many interactions */ longDesc: () => LocalizedString } - websites: { + include_converted_leads: { /** - * Websites + * Include Converted Leads */ displayName: () => LocalizedString /** - * Updated websites + * Include converted leads */ shortDesc: () => LocalizedString /** - * Updated list of associated websites + * Whether to include leads that have been converted to opportunities */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Website URL - */ - shortDesc: () => LocalizedString - /** - * The full URL of the website - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of website - */ - shortDesc: () => LocalizedString - /** - * The category or purpose of this website - */ - longDesc: () => LocalizedString - } - } - } - } } - socials: { + } + } + search_opportunities: { + groups: { + /** + * Opportunities + */ + '0': () => LocalizedString + } + /** + * Search Opportunities + */ + displayName: () => LocalizedString + /** + * Search for opportunities in CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Search and filter opportunities in CopperCRM using various criteria including name, pipeline, status, value, and custom fields. Returns a list of matching opportunities. + */ + longDesc: () => LocalizedString + options: { + ids: { /** - * Social Media + * Opportunity IDs */ displayName: () => LocalizedString /** - * Updated social profiles + * Specific opportunities to retrieve */ shortDesc: () => LocalizedString /** - * Updated list of social media profiles + * List of specific opportunity IDs to retrieve */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Social media profile URL - */ - shortDesc: () => LocalizedString - /** - * The full URL to the social media profile - */ - longDesc: () => LocalizedString - } - category: { - /** - * Platform - */ - displayName: () => LocalizedString - /** - * Social media platform - */ - shortDesc: () => LocalizedString - /** - * The social media platform - */ - longDesc: () => LocalizedString - } - } - } - } } - email: { + page_number: { /** - * Email + * Page Number */ displayName: () => LocalizedString /** - * Updated email + * Which page of results */ shortDesc: () => LocalizedString /** - * The updated email address + * The page number of results to retrieve for pagination */ longDesc: () => LocalizedString - type: { - fields: { - email: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * The email address - */ - shortDesc: () => LocalizedString - /** - * The email address of the lead - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of email - */ - shortDesc: () => LocalizedString - /** - * The category or type of this email - */ - longDesc: () => LocalizedString - } - } - } } - phone_numbers: { + page_size: { /** - * Phone Numbers + * Page Size */ displayName: () => LocalizedString /** - * Updated phone numbers + * Results per page */ shortDesc: () => LocalizedString /** - * Updated list of phone numbers + * The number of results to return per page */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - number: { - /** - * Phone Number - */ - displayName: () => LocalizedString - /** - * The phone number - */ - shortDesc: () => LocalizedString - /** - * The phone number in any format - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of phone number - */ - shortDesc: () => LocalizedString - /** - * The category or type of this phone number - */ - longDesc: () => LocalizedString - } - } - } - } } - address: { + sort_by: { /** - * Address + * Sort By */ displayName: () => LocalizedString /** - * Updated address + * Field to sort by */ shortDesc: () => LocalizedString /** - * The updated physical address + * The field to use for sorting the results */ longDesc: () => LocalizedString - type: { - fields: { - street: { - /** - * Street - */ - displayName: () => LocalizedString - /** - * Street address - */ - shortDesc: () => LocalizedString - /** - * The street address - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * City name - */ - shortDesc: () => LocalizedString - /** - * The city - */ - longDesc: () => LocalizedString - } - state: { - /** - * State - */ - displayName: () => LocalizedString - /** - * State or province - */ - shortDesc: () => LocalizedString - /** - * The state or province - */ - longDesc: () => LocalizedString - } - postal_code: { - /** - * Postal Code - */ - displayName: () => LocalizedString - /** - * ZIP or postal code - */ - shortDesc: () => LocalizedString - /** - * The postal code or ZIP code - */ - longDesc: () => LocalizedString - } - country: { - /** - * Country - */ - displayName: () => LocalizedString - /** - * Country name - */ - shortDesc: () => LocalizedString - /** - * The country - */ - longDesc: () => LocalizedString - } - } - } } - customer_source_id: { + sort_direction: { /** - * Customer Source + * Sort Direction */ displayName: () => LocalizedString /** - * Updated source + * Sort order */ shortDesc: () => LocalizedString /** - * The updated source or channel + * The direction to sort results (ascending or descending) */ longDesc: () => LocalizedString } - custom_fields: { + name: { /** - * Custom Fields + * Name */ displayName: () => LocalizedString /** - * Updated custom fields + * Opportunity name to search */ shortDesc: () => LocalizedString /** - * Updated custom field values + * Search for opportunities with names matching this value */ longDesc: () => LocalizedString } - } - } - update_opportunity: { - groups: { - /** - * Opportunities - */ - '0': () => LocalizedString - } - /** - * Update Opportunity - */ - displayName: () => LocalizedString - /** - * Update an existing opportunity in CopperCRM - */ - shortDesc: () => LocalizedString - /** - * Update the details of an existing sales opportunity in CopperCRM including value, stage, status, and custom fields. - */ - longDesc: () => LocalizedString - options: { - opportunity_id: { + assignee_ids: { /** - * Opportunity + * Assignees */ displayName: () => LocalizedString /** - * Opportunity to update + * Assigned users */ shortDesc: () => LocalizedString /** - * Select the opportunity you want to update + * Filter opportunities by assigned users */ longDesc: () => LocalizedString } - name: { + company_ids: { /** - * Opportunity Name + * Companies */ displayName: () => LocalizedString /** - * Updated name + * Associated companies */ shortDesc: () => LocalizedString /** - * The updated name for the opportunity + * Filter opportunities by associated companies */ longDesc: () => LocalizedString } - primary_contact_id: { + customer_source_ids: { /** - * Primary Contact + * Customer Sources */ displayName: () => LocalizedString /** - * Updated primary contact + * Opportunity sources */ shortDesc: () => LocalizedString /** - * The updated primary contact person + * Filter opportunities by customer source */ longDesc: () => LocalizedString } - assignee_id: { + loss_reason_ids: { /** - * Assignee + * Loss Reasons */ displayName: () => LocalizedString /** - * Updated assignee + * Reasons for loss */ shortDesc: () => LocalizedString /** - * The new CopperCRM user to assign to this opportunity + * Filter opportunities by loss reason */ longDesc: () => LocalizedString } - close_date: { + pipeline_ids: { /** - * Close Date + * Pipelines */ displayName: () => LocalizedString /** - * Updated close date + * Sales pipelines */ shortDesc: () => LocalizedString /** - * The updated expected close date + * Filter opportunities by pipeline */ longDesc: () => LocalizedString } - company_id: { + pipeline_stage_ids: { /** - * Company + * Pipeline Stages */ displayName: () => LocalizedString /** - * Updated company + * Current stages */ shortDesc: () => LocalizedString /** - * The updated associated company + * Filter opportunities by pipeline stage */ longDesc: () => LocalizedString } - customer_source_id: { + primary_contact_ids: { /** - * Customer Source + * Primary Contacts */ displayName: () => LocalizedString /** - * Updated source + * Main contacts */ shortDesc: () => LocalizedString /** - * The updated source or channel + * Filter opportunities by primary contact */ longDesc: () => LocalizedString } - details: { + priorities: { /** - * Details + * Priorities */ displayName: () => LocalizedString /** - * Updated notes + * Priority levels */ shortDesc: () => LocalizedString /** - * Updated notes, description, or important details + * Filter opportunities by priority level */ longDesc: () => LocalizedString } - loss_reason_id: { + statuses: { /** - * Loss Reason + * Statuses */ displayName: () => LocalizedString /** - * Updated loss reason + * Opportunity statuses */ shortDesc: () => LocalizedString /** - * The updated reason for losing + * Filter opportunities by status (Open, Won, Lost, Abandoned) */ longDesc: () => LocalizedString } - monetary_value: { + tags: { /** - * Monetary Value + * Tags */ displayName: () => LocalizedString /** - * Updated value + * Filter by tags */ shortDesc: () => LocalizedString /** - * The updated monetary value + * Filter opportunities that have any of these tags */ longDesc: () => LocalizedString } - pipeline_id: { + followed: { /** - * Pipeline + * Followed */ displayName: () => LocalizedString /** - * Updated pipeline + * Following status */ shortDesc: () => LocalizedString /** - * The updated sales pipeline + * Filter opportunities by whether they are followed or not */ longDesc: () => LocalizedString } - pipeline_stage_id: { + minimum_monetary_value: { /** - * Pipeline Stage + * Minimum Value */ displayName: () => LocalizedString /** - * Updated stage + * Minimum deal value */ shortDesc: () => LocalizedString /** - * The updated current stage + * Filter opportunities with at least this monetary value */ longDesc: () => LocalizedString } - priority: { + maximum_monetary_value: { /** - * Priority + * Maximum Value */ displayName: () => LocalizedString /** - * Updated priority + * Maximum deal value */ shortDesc: () => LocalizedString /** - * The updated priority level + * Filter opportunities with no more than this monetary value */ longDesc: () => LocalizedString } - status: { + minimum_win_probability: { /** - * Status + * Minimum Win Probability */ displayName: () => LocalizedString /** - * Updated status + * Minimum win chance */ shortDesc: () => LocalizedString /** - * The updated opportunity status + * Filter opportunities with at least this win probability */ longDesc: () => LocalizedString } - tags: { + maximum_win_probability: { /** - * Tags + * Maximum Win Probability */ displayName: () => LocalizedString /** - * Updated tags + * Maximum win chance */ shortDesc: () => LocalizedString /** - * Updated tags to categorize and organize the opportunity + * Filter opportunities with no more than this win probability */ longDesc: () => LocalizedString } - win_probability: { + minimum_interaction_count: { /** - * Win Probability + * Minimum Interactions */ displayName: () => LocalizedString /** - * Updated win probability + * Minimum interaction count */ shortDesc: () => LocalizedString /** - * The updated estimated probability of winning + * Filter opportunities with at least this many interactions */ longDesc: () => LocalizedString } - custom_fields: { + maximum_interaction_count: { /** - * Custom Fields + * Maximum Interactions */ displayName: () => LocalizedString /** - * Updated custom fields + * Maximum interaction count */ shortDesc: () => LocalizedString /** - * Updated custom field values + * Filter opportunities with no more than this many interactions */ longDesc: () => LocalizedString } - } - } - update_person: { - groups: { - /** - * People - */ - '0': () => LocalizedString - } - /** - * Update Person - */ - displayName: () => LocalizedString - /** - * Update an existing person contact in CopperCRM - */ - shortDesc: () => LocalizedString - /** - * Update the details of an existing person contact in CopperCRM including contact information, company, and custom fields. - */ - longDesc: () => LocalizedString - options: { - person_id: { + minimum_close_date: { /** - * Person + * Close Date After */ displayName: () => LocalizedString /** - * Person to update + * Earliest close date */ shortDesc: () => LocalizedString /** - * Select the person you want to update + * Filter opportunities with close date on or after this date */ longDesc: () => LocalizedString } - name: { + maximum_close_date: { /** - * Name + * Close Date Before */ displayName: () => LocalizedString /** - * Updated full name + * Latest close date */ shortDesc: () => LocalizedString /** - * The updated full name + * Filter opportunities with close date on or before this date */ longDesc: () => LocalizedString } - prefix: { + minimum_created_date: { /** - * Prefix + * Created After */ displayName: () => LocalizedString /** - * Updated prefix + * Earliest creation date */ shortDesc: () => LocalizedString /** - * Updated name prefix + * Filter opportunities created on or after this date */ longDesc: () => LocalizedString } - first_name: { + maximum_created_date: { /** - * First Name + * Created Before */ displayName: () => LocalizedString /** - * Updated first name + * Latest creation date */ shortDesc: () => LocalizedString /** - * The updated first name + * Filter opportunities created on or before this date */ longDesc: () => LocalizedString } - middle_name: { + minimum_modified_date: { /** - * Middle Name + * Modified After */ displayName: () => LocalizedString /** - * Updated middle name + * Earliest modification date */ shortDesc: () => LocalizedString /** - * The updated middle name or initial + * Filter opportunities modified on or after this date */ longDesc: () => LocalizedString } - last_name: { + maximum_modified_date: { /** - * Last Name + * Modified Before */ displayName: () => LocalizedString /** - * Updated last name + * Latest modification date */ shortDesc: () => LocalizedString /** - * The updated last name + * Filter opportunities modified on or before this date */ longDesc: () => LocalizedString } - suffix: { + minimum_stage_change_date: { /** - * Suffix + * Stage Changed After */ displayName: () => LocalizedString /** - * Updated suffix + * Earliest stage change */ shortDesc: () => LocalizedString /** - * Updated name suffix + * Filter opportunities with stage changed on or after this date */ longDesc: () => LocalizedString } - street: { + maximum_stage_change_date: { /** - * Street + * Stage Changed Before */ displayName: () => LocalizedString /** - * Updated street + * Latest stage change */ shortDesc: () => LocalizedString /** - * The updated street address + * Filter opportunities with stage changed on or before this date */ longDesc: () => LocalizedString } - city: { + } + } + search_people: { + groups: { + /** + * People + */ + '0': () => LocalizedString + } + /** + * Search People + */ + displayName: () => LocalizedString + /** + * Search for person contacts in CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Search and filter people in CopperCRM using various criteria including name, email, phone, company, and custom fields. Returns a list of matching person contacts. + */ + longDesc: () => LocalizedString + options: { + ids: { /** - * City + * Person IDs */ displayName: () => LocalizedString /** - * Updated city + * Specific people to retrieve */ shortDesc: () => LocalizedString /** - * The updated city + * List of specific person IDs to retrieve */ longDesc: () => LocalizedString } - state: { + name: { /** - * State + * Name */ displayName: () => LocalizedString /** - * Updated state + * Person name to search */ shortDesc: () => LocalizedString /** - * The updated state or province + * Search for people with names matching this value */ longDesc: () => LocalizedString } - postal_code: { + title: { /** - * Postal Code + * Title */ displayName: () => LocalizedString /** - * Updated postal code + * Job title to search */ shortDesc: () => LocalizedString /** - * The updated postal code or ZIP code + * Search for people with this job title */ longDesc: () => LocalizedString } - country: { + email: { /** - * Country + * Email */ displayName: () => LocalizedString /** - * Updated country + * Email to search */ shortDesc: () => LocalizedString /** - * The updated country + * Search for people with this email address */ longDesc: () => LocalizedString } - assignee_id: { + phone: { /** - * Assignee + * Phone */ displayName: () => LocalizedString /** - * Updated assignee + * Phone number to search */ shortDesc: () => LocalizedString /** - * The new CopperCRM user to assign to this contact + * Search for people with this phone number */ longDesc: () => LocalizedString } - company_id: { + city: { /** - * Company + * City */ displayName: () => LocalizedString /** - * Updated company + * City location */ shortDesc: () => LocalizedString /** - * The updated company where this person works + * Filter people by city */ longDesc: () => LocalizedString } - contact_type_id: { + state: { /** - * Contact Type + * State */ displayName: () => LocalizedString /** - * Updated contact type + * State or province */ shortDesc: () => LocalizedString /** - * The updated type of contact relationship + * Filter people by state or province */ longDesc: () => LocalizedString } - details: { + postal_code: { /** - * Details + * Postal Code */ displayName: () => LocalizedString /** - * Updated notes + * ZIP or postal code */ shortDesc: () => LocalizedString /** - * Updated notes, description, or important details + * Filter people by postal code */ longDesc: () => LocalizedString } - emails: { + country: { /** - * Email Addresses + * Country */ displayName: () => LocalizedString /** - * Updated emails + * Country location */ shortDesc: () => LocalizedString /** - * Updated list of email addresses + * Filter people by country */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - email: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * The email address - */ - shortDesc: () => LocalizedString - /** - * Email address - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of email - */ - shortDesc: () => LocalizedString - /** - * The category or type of this email - */ - longDesc: () => LocalizedString - } - } - } - } } - phone_numbers: { + assignee_ids: { /** - * Phone Numbers + * Assignees */ displayName: () => LocalizedString /** - * Updated phone numbers + * Assigned users */ shortDesc: () => LocalizedString /** - * Updated list of phone numbers + * Filter people by assigned users */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - number: { - /** - * Phone Number - */ - displayName: () => LocalizedString - /** - * The phone number - */ - shortDesc: () => LocalizedString - /** - * Phone number - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of phone number - */ - shortDesc: () => LocalizedString - /** - * The category or type of this phone number - */ - longDesc: () => LocalizedString - } - } - } - } } - socials: { + contact_type_ids: { /** - * Social Media + * Contact Types */ displayName: () => LocalizedString /** - * Updated social profiles + * Contact type filter */ shortDesc: () => LocalizedString /** - * Updated list of social media profiles + * Filter people by contact type + */ + longDesc: () => LocalizedString + } + company_ids: { + /** + * Companies + */ + displayName: () => LocalizedString + /** + * Associated companies + */ + shortDesc: () => LocalizedString + /** + * Filter people by associated companies */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Social profile URL - */ - shortDesc: () => LocalizedString - /** - * Social profile URL - */ - longDesc: () => LocalizedString - } - category: { - /** - * Platform - */ - displayName: () => LocalizedString - /** - * Social media platform - */ - shortDesc: () => LocalizedString - /** - * Social platform - */ - longDesc: () => LocalizedString - } - } - } - } } tags: { /** @@ -135183,327 +135764,201 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Updated tags + * Filter by tags */ shortDesc: () => LocalizedString /** - * Updated tags to categorize and organize the person + * Filter people that have any of these tags */ longDesc: () => LocalizedString } - title: { + socials: { /** - * Title + * Social Media */ displayName: () => LocalizedString /** - * Updated job title + * Social media profiles */ shortDesc: () => LocalizedString /** - * The updated job title or position + * Filter people by social media profiles */ longDesc: () => LocalizedString } - websites: { + minimum_interaction_count: { /** - * Websites + * Minimum Interactions */ displayName: () => LocalizedString /** - * Updated websites + * Minimum interaction count */ shortDesc: () => LocalizedString /** - * Updated list of associated websites - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Website URL - */ - shortDesc: () => LocalizedString - /** - * Website URL - */ - longDesc: () => LocalizedString - } - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * Type of website - */ - shortDesc: () => LocalizedString - /** - * The category or purpose of this website - */ - longDesc: () => LocalizedString - } - } - } - } - } - custom_fields: { - /** - * Custom Fields - */ - displayName: () => LocalizedString - /** - * Updated custom fields - */ - shortDesc: () => LocalizedString - /** - * Updated custom field values - */ - longDesc: () => LocalizedString - } - } - } - update_task: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - /** - * Update Task - */ - displayName: () => LocalizedString - /** - * Update an existing task in CopperCRM - */ - shortDesc: () => LocalizedString - /** - * Update the details of an existing task in CopperCRM including name, due dates, status, priority, and custom fields. - */ - longDesc: () => LocalizedString - options: { - task_id: { - /** - * Task - */ - displayName: () => LocalizedString - /** - * Task to update - */ - shortDesc: () => LocalizedString - /** - * Select the task you want to update + * Filter people with at least this many interactions */ longDesc: () => LocalizedString } - name: { - /** - * Task Name - */ - displayName: () => LocalizedString - /** - * Updated name - */ - shortDesc: () => LocalizedString - /** - * The updated name for the task - */ - longDesc: () => LocalizedString - } - related_resource: { + maximum_interaction_count: { /** - * Related Resource + * Maximum Interactions */ displayName: () => LocalizedString /** - * Updated related record + * Maximum interaction count */ shortDesc: () => LocalizedString /** - * The updated CRM record this task is related to + * Filter people with no more than this many interactions */ longDesc: () => LocalizedString - type: { - fields: { - id: { - /** - * Resource ID - */ - displayName: () => LocalizedString - /** - * ID of the related record - */ - shortDesc: () => LocalizedString - /** - * The ID of the related CRM record - */ - longDesc: () => LocalizedString - } - type: { - /** - * Resource Type - */ - displayName: () => LocalizedString - /** - * Type of related record - */ - shortDesc: () => LocalizedString - /** - * The type of CRM record this task is related to - */ - longDesc: () => LocalizedString - } - } - } } - assignee_id: { + minimum_created_date: { /** - * Assignee + * Created After */ displayName: () => LocalizedString /** - * Updated assignee + * Earliest creation date */ shortDesc: () => LocalizedString /** - * The new CopperCRM user to assign to this task + * Filter people created on or after this date */ longDesc: () => LocalizedString } - due_date: { + maximum_created_date: { /** - * Due Date + * Created Before */ displayName: () => LocalizedString /** - * Updated due date + * Latest creation date */ shortDesc: () => LocalizedString /** - * The updated date when this task should be completed + * Filter people created on or before this date */ longDesc: () => LocalizedString } - reminder_date: { + minimum_modified_date: { /** - * Reminder Date + * Modified After */ displayName: () => LocalizedString /** - * Updated reminder date + * Earliest modification date */ shortDesc: () => LocalizedString /** - * The updated date when a reminder should be sent + * Filter people modified on or after this date */ longDesc: () => LocalizedString } - priority: { + maximum_modified_date: { /** - * Priority + * Modified Before */ displayName: () => LocalizedString /** - * Updated priority + * Latest modification date */ shortDesc: () => LocalizedString /** - * The updated priority level + * Filter people modified on or before this date */ longDesc: () => LocalizedString } - status: { + sort_by: { /** - * Status + * Sort By */ displayName: () => LocalizedString /** - * Updated status + * Field to sort by */ shortDesc: () => LocalizedString /** - * The updated task status + * Field to sort results by */ longDesc: () => LocalizedString } - details: { + sort_direction: { /** - * Details + * Sort Direction */ displayName: () => LocalizedString /** - * Updated description + * Sort order */ shortDesc: () => LocalizedString /** - * Updated details or description of what needs to be done + * The direction to sort results (ascending or descending) */ longDesc: () => LocalizedString } - tags: { + page_number: { /** - * Tags + * Page Number */ displayName: () => LocalizedString /** - * Updated tags + * Which page of results */ shortDesc: () => LocalizedString /** - * Updated tags to categorize and organize the task + * The page number of results to retrieve for pagination */ longDesc: () => LocalizedString } - custom_fields: { + page_size: { /** - * Custom Fields + * Page Size */ displayName: () => LocalizedString /** - * Updated custom fields + * Results per page */ shortDesc: () => LocalizedString /** - * Updated custom field values + * The number of results to return per page */ longDesc: () => LocalizedString } } } - } - triggers: { - new_company: { + search_tasks: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } /** - * New Company + * Search Tasks */ displayName: () => LocalizedString /** - * Triggered when a new company is created + * Search for tasks in CopperCRM */ shortDesc: () => LocalizedString /** - * Triggers when a new company is created in CopperCRM. You can filter which companies trigger this event using various criteria like assignee, location, tags, and more. + * Search and filter tasks in CopperCRM using various criteria including assignee, status, priority, due date, and custom fields. Returns a list of matching tasks. */ longDesc: () => LocalizedString options: { ids: { /** - * Company IDs + * Task IDs */ displayName: () => LocalizedString /** - * Specific companies to watch + * Specific tasks to retrieve */ shortDesc: () => LocalizedString /** - * Only trigger for these specific company IDs + * List of specific task IDs to retrieve */ longDesc: () => LocalizedString } @@ -135563,919 +136018,1357 @@ export type TranslationFunctions = { */ longDesc: () => LocalizedString } - name: { + assignee_ids: { /** - * Name + * Assignees */ displayName: () => LocalizedString /** - * Company name filter + * Assigned users */ shortDesc: () => LocalizedString /** - * Only trigger for companies with names matching this value + * Filter tasks by assigned users */ longDesc: () => LocalizedString } - assignee_ids: { + statuses: { /** - * Assignees + * Statuses */ displayName: () => LocalizedString /** - * Filter by assignee + * Task statuses */ shortDesc: () => LocalizedString /** - * Only trigger for companies assigned to these users + * Filter tasks by status (Open or Completed) */ longDesc: () => LocalizedString } - contact_type_ids: { + priorities: { /** - * Contact Types + * Priorities */ displayName: () => LocalizedString /** - * Filter by contact type + * Priority levels */ shortDesc: () => LocalizedString /** - * Only trigger for companies with these contact types + * Filter tasks by priority level */ longDesc: () => LocalizedString } - city: { + tags: { /** - * City + * Tags */ displayName: () => LocalizedString /** - * City filter + * Filter by tags */ shortDesc: () => LocalizedString /** - * Only trigger for companies in this city + * Filter tasks that have any of these tags */ longDesc: () => LocalizedString } - state: { + followed: { /** - * State + * Followed */ displayName: () => LocalizedString /** - * State or province filter + * Following status */ shortDesc: () => LocalizedString /** - * Only trigger for companies in this state or province + * Filter tasks by whether they are followed or not */ longDesc: () => LocalizedString } - postal_code: { + minimum_due_date: { /** - * Postal Code + * Due Date After */ displayName: () => LocalizedString /** - * Postal code filter + * Earliest due date */ shortDesc: () => LocalizedString /** - * Only trigger for companies with this postal code + * Filter tasks with due date on or after this date */ longDesc: () => LocalizedString } - country: { + maximum_due_date: { /** - * Country + * Due Date Before */ displayName: () => LocalizedString /** - * Country filter + * Latest due date */ shortDesc: () => LocalizedString /** - * Only trigger for companies in this country + * Filter tasks with due date on or before this date */ longDesc: () => LocalizedString } - tags: { + minimum_reminder_date: { /** - * Tags + * Reminder After */ displayName: () => LocalizedString /** - * Filter by tags + * Earliest reminder date */ shortDesc: () => LocalizedString /** - * Only trigger for companies that have any of these tags + * Filter tasks with reminder date on or after this date */ longDesc: () => LocalizedString } - socials: { + maximum_reminder_date: { /** - * Social Media + * Reminder Before */ displayName: () => LocalizedString /** - * Social media filter + * Latest reminder date */ shortDesc: () => LocalizedString /** - * Only trigger for companies with matching social media profiles + * Filter tasks with reminder date on or before this date */ longDesc: () => LocalizedString } - followed: { + minimum_completed_date: { /** - * Followed + * Completed After */ displayName: () => LocalizedString /** - * Following status filter + * Earliest completion date */ shortDesc: () => LocalizedString /** - * Only trigger for companies that are followed or not followed + * Filter tasks completed on or after this date */ longDesc: () => LocalizedString } - minimum_interaction_count: { + maximum_completed_date: { /** - * Minimum Interactions + * Completed Before */ displayName: () => LocalizedString /** - * Minimum interaction count + * Latest completion date */ shortDesc: () => LocalizedString /** - * Only trigger for companies with at least this many interactions + * Filter tasks completed on or before this date */ longDesc: () => LocalizedString } - maximum_interaction_count: { + minimum_created_date: { /** - * Maximum Interactions + * Created After */ displayName: () => LocalizedString /** - * Maximum interaction count + * Earliest creation date */ shortDesc: () => LocalizedString /** - * Only trigger for companies with no more than this many interactions + * Filter tasks created on or after this date */ longDesc: () => LocalizedString } - minimum_inactive_days: { + maximum_created_date: { /** - * Minimum Inactive Days + * Created Before */ displayName: () => LocalizedString /** - * Minimum days inactive + * Latest creation date */ shortDesc: () => LocalizedString /** - * Only trigger for companies inactive for at least this many days + * Filter tasks created on or before this date */ longDesc: () => LocalizedString } - maximum_inactive_days: { + minimum_modified_date: { /** - * Maximum Inactive Days + * Modified After */ displayName: () => LocalizedString /** - * Maximum days inactive + * Earliest modification date */ shortDesc: () => LocalizedString /** - * Only trigger for companies inactive for no more than this many days + * Filter tasks modified on or after this date + */ + longDesc: () => LocalizedString + } + maximum_modified_date: { + /** + * Modified Before + */ + displayName: () => LocalizedString + /** + * Latest modification date + */ + shortDesc: () => LocalizedString + /** + * Filter tasks modified on or before this date */ longDesc: () => LocalizedString } } } - new_lead: { + update_company: { + groups: { + /** + * Companies + */ + '0': () => LocalizedString + } /** - * New Lead + * Update Company */ displayName: () => LocalizedString /** - * Triggered when a new lead is created + * Update an existing company in CopperCRM */ shortDesc: () => LocalizedString /** - * Triggers when a new lead is created in CopperCRM. You can filter which leads trigger this event using various criteria like assignee, status, location, and more. + * Update the details of an existing company record in CopperCRM including name, address, contact information, and custom fields. */ longDesc: () => LocalizedString options: { - ids: { + company_id: { /** - * Lead IDs + * Company */ displayName: () => LocalizedString /** - * Specific leads to watch + * Company to update */ shortDesc: () => LocalizedString /** - * Only trigger for these specific lead IDs + * Select the company you want to update */ longDesc: () => LocalizedString } - page_number: { + name: { /** - * Page Number + * Company Name */ displayName: () => LocalizedString /** - * Which page of results + * Updated company name */ shortDesc: () => LocalizedString /** - * The page number of results to retrieve for pagination + * The new name for the company */ longDesc: () => LocalizedString } - page_size: { + address: { /** - * Page Size + * Address */ displayName: () => LocalizedString /** - * Results per page + * Updated address */ shortDesc: () => LocalizedString /** - * The number of results to return per page + * The updated physical address of the company */ longDesc: () => LocalizedString + type: { + fields: { + street: { + /** + * Street + */ + displayName: () => LocalizedString + /** + * Street address + */ + shortDesc: () => LocalizedString + /** + * The street address of the company + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * City name + */ + shortDesc: () => LocalizedString + /** + * The city where the company is located + */ + longDesc: () => LocalizedString + } + state: { + /** + * State + */ + displayName: () => LocalizedString + /** + * State or province + */ + shortDesc: () => LocalizedString + /** + * The state or province where the company is located + */ + longDesc: () => LocalizedString + } + postal_code: { + /** + * Postal Code + */ + displayName: () => LocalizedString + /** + * ZIP or postal code + */ + shortDesc: () => LocalizedString + /** + * The postal code or ZIP code of the company address + */ + longDesc: () => LocalizedString + } + country: { + /** + * Country + */ + displayName: () => LocalizedString + /** + * Country name + */ + shortDesc: () => LocalizedString + /** + * The country where the company is located + */ + longDesc: () => LocalizedString + } + } + } } - sort_by: { + assignee_id: { /** - * Sort By + * Assignee */ displayName: () => LocalizedString /** - * Field to sort by + * Updated assignee */ shortDesc: () => LocalizedString /** - * The field to use for sorting the results + * The new CopperCRM user to assign to this company */ longDesc: () => LocalizedString } - sort_direction: { + contact_type_id: { /** - * Sort Direction + * Contact Type */ displayName: () => LocalizedString /** - * Sort order + * Updated contact type */ shortDesc: () => LocalizedString /** - * The direction to sort results (ascending or descending) + * The updated type of contact relationship */ longDesc: () => LocalizedString } - name: { + details: { /** - * Name + * Details */ displayName: () => LocalizedString /** - * Lead name filter + * Updated notes */ shortDesc: () => LocalizedString /** - * Only trigger for leads with names matching this value + * Updated notes, description, or important details */ longDesc: () => LocalizedString } - phone_number: { + email_domain: { /** - * Phone Number + * Email Domain */ displayName: () => LocalizedString /** - * Phone number filter + * Updated email domain */ shortDesc: () => LocalizedString /** - * Only trigger for leads with this phone number + * The updated primary email domain */ longDesc: () => LocalizedString } - emails: { + phone_numbers: { /** - * Email + * Phone Numbers */ displayName: () => LocalizedString /** - * Email filter + * Updated phone numbers */ shortDesc: () => LocalizedString /** - * Only trigger for leads with this email address + * Updated list of phone numbers */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + number: { + /** + * Phone Number + */ + displayName: () => LocalizedString + /** + * The phone number + */ + shortDesc: () => LocalizedString + /** + * The phone number in any format + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of phone number + */ + shortDesc: () => LocalizedString + /** + * The category or type of this phone number + */ + longDesc: () => LocalizedString + } + } + } + } } - assignee_ids: { + primary_contact_id: { /** - * Assignees + * Primary Contact */ displayName: () => LocalizedString /** - * Filter by assignee + * Updated primary contact */ shortDesc: () => LocalizedString /** - * Only trigger for leads assigned to these users + * The new primary contact person for this company */ longDesc: () => LocalizedString } - status_ids: { + socials: { /** - * Statuses + * Social Media */ displayName: () => LocalizedString /** - * Filter by status + * Updated social profiles */ shortDesc: () => LocalizedString /** - * Only trigger for leads with these statuses + * Updated list of social media profiles */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Social media profile URL + */ + shortDesc: () => LocalizedString + /** + * The full URL to the social media profile + */ + longDesc: () => LocalizedString + } + category: { + /** + * Platform + */ + displayName: () => LocalizedString + /** + * Social media platform + */ + shortDesc: () => LocalizedString + /** + * The social media platform + */ + longDesc: () => LocalizedString + } + } + } + } } - customer_source_ids: { + tags: { /** - * Customer Sources + * Tags */ displayName: () => LocalizedString /** - * Filter by source + * Updated tags */ shortDesc: () => LocalizedString /** - * Only trigger for leads from these customer sources + * Updated tags to categorize and organize the company */ longDesc: () => LocalizedString } - city: { + websites: { /** - * City + * Websites */ displayName: () => LocalizedString /** - * City filter + * Updated websites */ shortDesc: () => LocalizedString /** - * Only trigger for leads in this city + * Updated list of websites */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Website URL + */ + shortDesc: () => LocalizedString + /** + * The full URL of the website + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of website + */ + shortDesc: () => LocalizedString + /** + * The category or purpose of this website + */ + longDesc: () => LocalizedString + } + } + } + } } - state: { + custom_fields: { /** - * State + * Custom Fields */ displayName: () => LocalizedString /** - * State or province filter + * Updated custom fields */ shortDesc: () => LocalizedString /** - * Only trigger for leads in this state or province + * Updated custom field values */ longDesc: () => LocalizedString } - postal_code: { + } + } + update_lead: { + groups: { + /** + * Leads + */ + '0': () => LocalizedString + } + /** + * Update Lead + */ + displayName: () => LocalizedString + /** + * Update an existing lead in CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Update the details of an existing lead record in CopperCRM including contact information, status, and custom fields. + */ + longDesc: () => LocalizedString + options: { + lead_id: { /** - * Postal Code + * Lead */ displayName: () => LocalizedString /** - * Postal code filter + * Lead to update */ shortDesc: () => LocalizedString /** - * Only trigger for leads with this postal code + * Select the lead you want to update */ longDesc: () => LocalizedString } - country: { + first_name: { /** - * Country + * First Name */ displayName: () => LocalizedString /** - * Country filter + * Updated first name */ shortDesc: () => LocalizedString /** - * Only trigger for leads in this country + * The updated first name of the lead */ longDesc: () => LocalizedString } - tags: { + last_name: { /** - * Tags + * Last Name */ displayName: () => LocalizedString /** - * Filter by tags + * Updated last name */ shortDesc: () => LocalizedString /** - * Only trigger for leads that have any of these tags + * The updated last name of the lead */ longDesc: () => LocalizedString } - socials: { + middle_name: { /** - * Social Media + * Middle Name */ displayName: () => LocalizedString /** - * Social media filter + * Updated middle name */ shortDesc: () => LocalizedString /** - * Only trigger for leads with matching social media profiles + * The updated middle name or initial */ longDesc: () => LocalizedString } - followed: { + suffix: { /** - * Followed + * Suffix */ displayName: () => LocalizedString /** - * Following status filter + * Updated suffix */ shortDesc: () => LocalizedString /** - * Only trigger for leads that are followed or not followed + * Updated name suffix */ longDesc: () => LocalizedString } - age: { + assignee_id: { /** - * Age + * Assignee */ displayName: () => LocalizedString /** - * Lead age filter + * Updated assignee */ shortDesc: () => LocalizedString /** - * Only trigger for leads of this age in days + * The new CopperCRM user to assign to this lead */ longDesc: () => LocalizedString } - minimum_monetary_value: { + company_name: { /** - * Minimum Value + * Company Name */ displayName: () => LocalizedString /** - * Minimum monetary value + * Updated company name */ shortDesc: () => LocalizedString /** - * Only trigger for leads with at least this monetary value + * The updated company name where the lead works */ longDesc: () => LocalizedString } - maximum_monetary_value: { + tags: { /** - * Maximum Value + * Tags */ displayName: () => LocalizedString /** - * Maximum monetary value + * Updated tags */ shortDesc: () => LocalizedString /** - * Only trigger for leads with no more than this monetary value + * Updated tags to categorize and organize the lead */ longDesc: () => LocalizedString } - minimum_interaction_count: { + title: { /** - * Minimum Interactions + * Title */ displayName: () => LocalizedString /** - * Minimum interaction count + * Updated job title */ shortDesc: () => LocalizedString /** - * Only trigger for leads with at least this many interactions + * The updated job title or position */ longDesc: () => LocalizedString } - maximum_interaction_count: { + details: { /** - * Maximum Interactions + * Details */ displayName: () => LocalizedString /** - * Maximum interaction count + * Updated notes */ shortDesc: () => LocalizedString /** - * Only trigger for leads with no more than this many interactions + * Updated notes, description, or important details */ longDesc: () => LocalizedString } - include_converted_leads: { + websites: { /** - * Include Converted Leads + * Websites */ displayName: () => LocalizedString /** - * Include converted leads + * Updated websites */ shortDesc: () => LocalizedString /** - * Whether to trigger for leads that have been converted to opportunities + * Updated list of associated websites */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Website URL + */ + shortDesc: () => LocalizedString + /** + * The full URL of the website + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of website + */ + shortDesc: () => LocalizedString + /** + * The category or purpose of this website + */ + longDesc: () => LocalizedString + } + } + } + } } - } - } - new_opportunity: { - /** - * New Opportunity - */ - displayName: () => LocalizedString - /** - * Triggered when a new opportunity is created - */ - shortDesc: () => LocalizedString - /** - * Triggers when a new opportunity is created in CopperCRM. You can filter which opportunities trigger this event using various criteria like pipeline, stage, status, value, and more. - */ - longDesc: () => LocalizedString - options: { - ids: { + socials: { /** - * Opportunity IDs + * Social Media */ displayName: () => LocalizedString /** - * Specific opportunities to watch + * Updated social profiles */ shortDesc: () => LocalizedString /** - * Only trigger for these specific opportunity IDs + * Updated list of social media profiles */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Social media profile URL + */ + shortDesc: () => LocalizedString + /** + * The full URL to the social media profile + */ + longDesc: () => LocalizedString + } + category: { + /** + * Platform + */ + displayName: () => LocalizedString + /** + * Social media platform + */ + shortDesc: () => LocalizedString + /** + * The social media platform + */ + longDesc: () => LocalizedString + } + } + } + } } - page_number: { + email: { /** - * Page Number + * Email */ displayName: () => LocalizedString /** - * Which page of results + * Updated email */ shortDesc: () => LocalizedString /** - * The page number of results to retrieve for pagination + * The updated email address */ longDesc: () => LocalizedString + type: { + fields: { + email: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * The email address + */ + shortDesc: () => LocalizedString + /** + * The email address of the lead + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of email + */ + shortDesc: () => LocalizedString + /** + * The category or type of this email + */ + longDesc: () => LocalizedString + } + } + } } - page_size: { + phone_numbers: { /** - * Page Size + * Phone Numbers */ displayName: () => LocalizedString /** - * Results per page + * Updated phone numbers */ shortDesc: () => LocalizedString /** - * The number of results to return per page + * Updated list of phone numbers */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + number: { + /** + * Phone Number + */ + displayName: () => LocalizedString + /** + * The phone number + */ + shortDesc: () => LocalizedString + /** + * The phone number in any format + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of phone number + */ + shortDesc: () => LocalizedString + /** + * The category or type of this phone number + */ + longDesc: () => LocalizedString + } + } + } + } } - sort_by: { + address: { /** - * Sort By + * Address */ displayName: () => LocalizedString /** - * Field to sort by + * Updated address */ shortDesc: () => LocalizedString /** - * The field to use for sorting the results + * The updated physical address */ longDesc: () => LocalizedString + type: { + fields: { + street: { + /** + * Street + */ + displayName: () => LocalizedString + /** + * Street address + */ + shortDesc: () => LocalizedString + /** + * The street address + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * City name + */ + shortDesc: () => LocalizedString + /** + * The city + */ + longDesc: () => LocalizedString + } + state: { + /** + * State + */ + displayName: () => LocalizedString + /** + * State or province + */ + shortDesc: () => LocalizedString + /** + * The state or province + */ + longDesc: () => LocalizedString + } + postal_code: { + /** + * Postal Code + */ + displayName: () => LocalizedString + /** + * ZIP or postal code + */ + shortDesc: () => LocalizedString + /** + * The postal code or ZIP code + */ + longDesc: () => LocalizedString + } + country: { + /** + * Country + */ + displayName: () => LocalizedString + /** + * Country name + */ + shortDesc: () => LocalizedString + /** + * The country + */ + longDesc: () => LocalizedString + } + } + } } - sort_direction: { + customer_source_id: { /** - * Sort Direction + * Customer Source */ displayName: () => LocalizedString /** - * Sort order + * Updated source */ shortDesc: () => LocalizedString /** - * The direction to sort results (ascending or descending) + * The updated source or channel */ longDesc: () => LocalizedString } - name: { + custom_fields: { /** - * Name + * Custom Fields */ displayName: () => LocalizedString /** - * Opportunity name filter + * Updated custom fields */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with names matching this value + * Updated custom field values */ longDesc: () => LocalizedString } - assignee_ids: { - /** - * Assignees + } + } + update_opportunity: { + groups: { + /** + * Opportunities + */ + '0': () => LocalizedString + } + /** + * Update Opportunity + */ + displayName: () => LocalizedString + /** + * Update an existing opportunity in CopperCRM + */ + shortDesc: () => LocalizedString + /** + * Update the details of an existing sales opportunity in CopperCRM including value, stage, status, and custom fields. + */ + longDesc: () => LocalizedString + options: { + opportunity_id: { + /** + * Opportunity */ displayName: () => LocalizedString /** - * Filter by assignee + * Opportunity to update */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities assigned to these users + * Select the opportunity you want to update */ longDesc: () => LocalizedString } - company_ids: { + name: { /** - * Companies + * Opportunity Name */ displayName: () => LocalizedString /** - * Filter by company + * Updated name */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities associated with these companies + * The updated name for the opportunity */ longDesc: () => LocalizedString } - customer_source_ids: { + primary_contact_id: { /** - * Customer Sources + * Primary Contact */ displayName: () => LocalizedString /** - * Filter by source + * Updated primary contact */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities from these customer sources + * The updated primary contact person */ longDesc: () => LocalizedString } - loss_reason_ids: { + assignee_id: { /** - * Loss Reasons + * Assignee */ displayName: () => LocalizedString /** - * Filter by loss reason + * Updated assignee */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with these loss reasons + * The new CopperCRM user to assign to this opportunity */ longDesc: () => LocalizedString } - pipeline_ids: { + close_date: { /** - * Pipelines + * Close Date */ displayName: () => LocalizedString /** - * Filter by pipeline + * Updated close date */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities in these pipelines + * The updated expected close date */ longDesc: () => LocalizedString } - pipeline_stage_ids: { + company_id: { /** - * Pipeline Stages + * Company */ displayName: () => LocalizedString /** - * Filter by stage + * Updated company */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities in these pipeline stages + * The updated associated company */ longDesc: () => LocalizedString } - primary_contact_ids: { + customer_source_id: { /** - * Primary Contacts + * Customer Source */ displayName: () => LocalizedString /** - * Filter by primary contact + * Updated source */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with these primary contacts + * The updated source or channel */ longDesc: () => LocalizedString } - priorities: { + details: { /** - * Priorities + * Details */ displayName: () => LocalizedString /** - * Filter by priority + * Updated notes */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with these priority levels + * Updated notes, description, or important details */ longDesc: () => LocalizedString } - statuses: { + loss_reason_id: { /** - * Statuses + * Loss Reason */ displayName: () => LocalizedString /** - * Filter by status + * Updated loss reason */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with these statuses + * The updated reason for losing */ longDesc: () => LocalizedString } - tags: { + monetary_value: { /** - * Tags + * Monetary Value */ displayName: () => LocalizedString /** - * Filter by tags + * Updated value */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities that have any of these tags + * The updated monetary value */ longDesc: () => LocalizedString } - followed: { + pipeline_id: { /** - * Followed + * Pipeline */ displayName: () => LocalizedString /** - * Following status filter + * Updated pipeline */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities that are followed or not followed + * The updated sales pipeline */ longDesc: () => LocalizedString } - minimum_monetary_value: { + pipeline_stage_id: { /** - * Minimum Value + * Pipeline Stage */ displayName: () => LocalizedString /** - * Minimum deal value + * Updated stage */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with at least this monetary value + * The updated current stage */ longDesc: () => LocalizedString } - maximum_monetary_value: { + priority: { /** - * Maximum Value + * Priority */ displayName: () => LocalizedString /** - * Maximum deal value + * Updated priority */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with no more than this monetary value + * The updated priority level */ longDesc: () => LocalizedString } - minimum_win_probability: { + status: { /** - * Minimum Win Probability + * Status */ displayName: () => LocalizedString /** - * Minimum win chance + * Updated status */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with at least this win probability + * The updated opportunity status */ longDesc: () => LocalizedString } - maximum_win_probability: { + tags: { /** - * Maximum Win Probability + * Tags */ displayName: () => LocalizedString /** - * Maximum win chance + * Updated tags */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with no more than this win probability + * Updated tags to categorize and organize the opportunity */ longDesc: () => LocalizedString } - minimum_interaction_count: { + win_probability: { /** - * Minimum Interactions + * Win Probability */ displayName: () => LocalizedString /** - * Minimum interaction count + * Updated win probability */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with at least this many interactions + * The updated estimated probability of winning */ longDesc: () => LocalizedString } - maximum_interaction_count: { + custom_fields: { /** - * Maximum Interactions + * Custom Fields */ displayName: () => LocalizedString /** - * Maximum interaction count + * Updated custom fields */ shortDesc: () => LocalizedString /** - * Only trigger for opportunities with no more than this many interactions + * Updated custom field values */ longDesc: () => LocalizedString } } } - new_person: { + update_person: { + groups: { + /** + * People + */ + '0': () => LocalizedString + } /** - * New Person + * Update Person */ displayName: () => LocalizedString /** - * Triggered when a new person contact is created + * Update an existing person contact in CopperCRM */ shortDesc: () => LocalizedString /** - * Triggers when a new person contact is created in CopperCRM. You can filter which people trigger this event using various criteria like assignee, company, location, and more. + * Update the details of an existing person contact in CopperCRM including contact information, company, and custom fields. */ longDesc: () => LocalizedString options: { - ids: { + person_id: { /** - * Person IDs + * Person */ displayName: () => LocalizedString /** - * Specific people to watch + * Person to update */ shortDesc: () => LocalizedString /** - * Only trigger for these specific person IDs + * Select the person you want to update */ longDesc: () => LocalizedString } @@ -136485,53 +137378,95 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Person name filter + * Updated full name */ shortDesc: () => LocalizedString /** - * Only trigger for people with names matching this value + * The updated full name */ longDesc: () => LocalizedString } - title: { + prefix: { /** - * Title + * Prefix */ displayName: () => LocalizedString /** - * Job title filter + * Updated prefix */ shortDesc: () => LocalizedString /** - * Only trigger for people with this job title + * Updated name prefix */ longDesc: () => LocalizedString } - email: { + first_name: { /** - * Email + * First Name */ displayName: () => LocalizedString /** - * Email filter + * Updated first name */ shortDesc: () => LocalizedString /** - * Only trigger for people with this email address + * The updated first name */ longDesc: () => LocalizedString } - phone: { + middle_name: { /** - * Phone + * Middle Name */ displayName: () => LocalizedString /** - * Phone number filter + * Updated middle name */ shortDesc: () => LocalizedString /** - * Only trigger for people with this phone number + * The updated middle name or initial + */ + longDesc: () => LocalizedString + } + last_name: { + /** + * Last Name + */ + displayName: () => LocalizedString + /** + * Updated last name + */ + shortDesc: () => LocalizedString + /** + * The updated last name + */ + longDesc: () => LocalizedString + } + suffix: { + /** + * Suffix + */ + displayName: () => LocalizedString + /** + * Updated suffix + */ + shortDesc: () => LocalizedString + /** + * Updated name suffix + */ + longDesc: () => LocalizedString + } + street: { + /** + * Street + */ + displayName: () => LocalizedString + /** + * Updated street + */ + shortDesc: () => LocalizedString + /** + * The updated street address */ longDesc: () => LocalizedString } @@ -136541,11 +137476,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * City filter + * Updated city */ shortDesc: () => LocalizedString /** - * Only trigger for people in this city + * The updated city */ longDesc: () => LocalizedString } @@ -136555,11 +137490,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * State or province filter + * Updated state */ shortDesc: () => LocalizedString /** - * Only trigger for people in this state or province + * The updated state or province */ longDesc: () => LocalizedString } @@ -136569,11 +137504,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Postal code filter + * Updated postal code */ shortDesc: () => LocalizedString /** - * Only trigger for people with this postal code + * The updated postal code or ZIP code */ longDesc: () => LocalizedString } @@ -136583,293 +137518,481 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Country filter + * Updated country */ shortDesc: () => LocalizedString /** - * Only trigger for people in this country + * The updated country */ longDesc: () => LocalizedString } - assignee_ids: { + assignee_id: { /** - * Assignees + * Assignee */ displayName: () => LocalizedString /** - * Filter by assignee + * Updated assignee */ shortDesc: () => LocalizedString /** - * Only trigger for people assigned to these users + * The new CopperCRM user to assign to this contact */ longDesc: () => LocalizedString } - contact_type_ids: { + company_id: { /** - * Contact Types + * Company */ displayName: () => LocalizedString /** - * Filter by contact type + * Updated company */ shortDesc: () => LocalizedString /** - * Only trigger for people with these contact types + * The updated company where this person works */ longDesc: () => LocalizedString } - company_ids: { + contact_type_id: { /** - * Companies + * Contact Type */ displayName: () => LocalizedString /** - * Filter by company + * Updated contact type */ shortDesc: () => LocalizedString /** - * Only trigger for people associated with these companies + * The updated type of contact relationship */ longDesc: () => LocalizedString } - tags: { + details: { /** - * Tags + * Details */ displayName: () => LocalizedString /** - * Filter by tags + * Updated notes */ shortDesc: () => LocalizedString /** - * Only trigger for people that have any of these tags + * Updated notes, description, or important details */ longDesc: () => LocalizedString } - socials: { + emails: { /** - * Social Media + * Email Addresses */ displayName: () => LocalizedString /** - * Social media filter + * Updated emails */ shortDesc: () => LocalizedString /** - * Only trigger for people with these social media profiles + * Updated list of email addresses */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + email: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * The email address + */ + shortDesc: () => LocalizedString + /** + * Email address + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of email + */ + shortDesc: () => LocalizedString + /** + * The category or type of this email + */ + longDesc: () => LocalizedString + } + } + } + } } - minimum_interaction_count: { + phone_numbers: { /** - * Minimum Interactions + * Phone Numbers */ displayName: () => LocalizedString /** - * Minimum interaction count + * Updated phone numbers */ shortDesc: () => LocalizedString /** - * Only trigger for people with at least this many interactions + * Updated list of phone numbers */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + number: { + /** + * Phone Number + */ + displayName: () => LocalizedString + /** + * The phone number + */ + shortDesc: () => LocalizedString + /** + * Phone number + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of phone number + */ + shortDesc: () => LocalizedString + /** + * The category or type of this phone number + */ + longDesc: () => LocalizedString + } + } + } + } } - maximum_interaction_count: { + socials: { /** - * Maximum Interactions + * Social Media */ displayName: () => LocalizedString /** - * Maximum interaction count + * Updated social profiles */ shortDesc: () => LocalizedString /** - * Only trigger for people with no more than this many interactions + * Updated list of social media profiles */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Social profile URL + */ + shortDesc: () => LocalizedString + /** + * Social profile URL + */ + longDesc: () => LocalizedString + } + category: { + /** + * Platform + */ + displayName: () => LocalizedString + /** + * Social media platform + */ + shortDesc: () => LocalizedString + /** + * Social platform + */ + longDesc: () => LocalizedString + } + } + } + } } - page_number: { + tags: { /** - * Page Number + * Tags */ displayName: () => LocalizedString /** - * Which page of results + * Updated tags */ shortDesc: () => LocalizedString /** - * The page number of results to retrieve for pagination + * Updated tags to categorize and organize the person */ longDesc: () => LocalizedString } - page_size: { + title: { /** - * Page Size + * Title */ displayName: () => LocalizedString /** - * Results per page + * Updated job title */ shortDesc: () => LocalizedString /** - * The number of results to return per page + * The updated job title or position */ longDesc: () => LocalizedString } - sort_by: { + websites: { /** - * Sort By + * Websites */ displayName: () => LocalizedString /** - * Field to sort by + * Updated websites */ shortDesc: () => LocalizedString /** - * The field to use for sorting the results + * Updated list of associated websites */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Website URL + */ + shortDesc: () => LocalizedString + /** + * Website URL + */ + longDesc: () => LocalizedString + } + category: { + /** + * Category + */ + displayName: () => LocalizedString + /** + * Type of website + */ + shortDesc: () => LocalizedString + /** + * The category or purpose of this website + */ + longDesc: () => LocalizedString + } + } + } + } } - sort_direction: { + custom_fields: { /** - * Sort Direction + * Custom Fields */ displayName: () => LocalizedString /** - * Sort order + * Updated custom fields */ shortDesc: () => LocalizedString /** - * The direction to sort results (ascending or descending) + * Updated custom field values */ longDesc: () => LocalizedString } } } - new_task: { + update_task: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } /** - * New Task + * Update Task */ displayName: () => LocalizedString /** - * Triggered when a new task is created + * Update an existing task in CopperCRM */ shortDesc: () => LocalizedString /** - * Triggers when a new task is created in CopperCRM. You can filter which tasks trigger this event using various criteria like assignee, status, priority, and more. + * Update the details of an existing task in CopperCRM including name, due dates, status, priority, and custom fields. */ longDesc: () => LocalizedString options: { - ids: { + task_id: { /** - * Task IDs + * Task */ displayName: () => LocalizedString /** - * Specific tasks to watch + * Task to update */ shortDesc: () => LocalizedString /** - * Only trigger for these specific task IDs + * Select the task you want to update */ longDesc: () => LocalizedString } - page_number: { + name: { /** - * Page Number + * Task Name */ displayName: () => LocalizedString /** - * Which page of results + * Updated name */ shortDesc: () => LocalizedString /** - * The page number of results to retrieve for pagination + * The updated name for the task */ longDesc: () => LocalizedString } - page_size: { + related_resource: { /** - * Page Size + * Related Resource */ displayName: () => LocalizedString /** - * Results per page + * Updated related record */ shortDesc: () => LocalizedString /** - * The number of results to return per page + * The updated CRM record this task is related to */ longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Resource ID + */ + displayName: () => LocalizedString + /** + * ID of the related record + */ + shortDesc: () => LocalizedString + /** + * The ID of the related CRM record + */ + longDesc: () => LocalizedString + } + type: { + /** + * Resource Type + */ + displayName: () => LocalizedString + /** + * Type of related record + */ + shortDesc: () => LocalizedString + /** + * The type of CRM record this task is related to + */ + longDesc: () => LocalizedString + } + } + } } - sort_by: { + assignee_id: { /** - * Sort By + * Assignee */ displayName: () => LocalizedString /** - * Field to sort by + * Updated assignee */ shortDesc: () => LocalizedString /** - * The field to use for sorting the results + * The new CopperCRM user to assign to this task */ longDesc: () => LocalizedString } - sort_direction: { + due_date: { /** - * Sort Direction + * Due Date */ displayName: () => LocalizedString /** - * Sort order + * Updated due date */ shortDesc: () => LocalizedString /** - * The direction to sort results (ascending or descending) + * The updated date when this task should be completed */ longDesc: () => LocalizedString } - assignee_ids: { + reminder_date: { /** - * Assignees + * Reminder Date */ displayName: () => LocalizedString /** - * Filter by assignee + * Updated reminder date */ shortDesc: () => LocalizedString /** - * Only trigger for tasks assigned to these users + * The updated date when a reminder should be sent */ longDesc: () => LocalizedString } - statuses: { + priority: { /** - * Statuses + * Priority */ displayName: () => LocalizedString /** - * Filter by status + * Updated priority */ shortDesc: () => LocalizedString /** - * Only trigger for tasks with these statuses + * The updated priority level */ longDesc: () => LocalizedString } - priorities: { + status: { /** - * Priorities + * Status */ displayName: () => LocalizedString /** - * Filter by priority + * Updated status */ shortDesc: () => LocalizedString /** - * Only trigger for tasks with these priority levels + * The updated task status + */ + longDesc: () => LocalizedString + } + details: { + /** + * Details + */ + displayName: () => LocalizedString + /** + * Updated description + */ + shortDesc: () => LocalizedString + /** + * Updated details or description of what needs to be done */ longDesc: () => LocalizedString } @@ -136879,6236 +138002,5715 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Filter by tags + * Updated tags */ shortDesc: () => LocalizedString /** - * Only trigger for tasks that have any of these tags + * Updated tags to categorize and organize the task */ longDesc: () => LocalizedString } - followed: { + custom_fields: { /** - * Followed + * Custom Fields */ displayName: () => LocalizedString /** - * Following status filter + * Updated custom fields */ shortDesc: () => LocalizedString /** - * Only trigger for tasks that are followed or not followed + * Updated custom field values */ longDesc: () => LocalizedString } } } } - } - SeaTable: { - /** - * SeaTable - */ - displayName: () => LocalizedString - groups: { - /** - * Spreadsheets & Data Tables - */ - '0': () => LocalizedString - /** - * Databases & Backend Services - */ - '1': () => LocalizedString - } - /** - * Connect to SeaTable to manage your database tables and records with powerful automation - */ - shortDesc: () => LocalizedString - /** - * The SeaTable integration provides comprehensive access to your SeaTable database operations. Create, read, update, and delete records in your tables, execute SQL queries, and monitor new entries with real-time triggers. Whether you need to manage data, filter results with SQL, or track new records, this integration streamlines your SeaTable workflow automation and database management. - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to SeaTable - */ - title: () => LocalizedString - /** - * To connect to SeaTable, you will need your **SeaTable Server URL** and an **API Token**. - - ## Getting Your API Token - - 1. Log in to your SeaTable instance - 2. Open the base you want to connect to - 3. Click on the **dropdown arrow** next to the base name - 4. Select **API Token** from the menu - 5. Create a new token with the desired permissions (read or read/write) - - For detailed instructions, see the [SeaTable API Token Guide](https://seatable.com/help/create-api-tokens/). - - ## Connection Details - - ### SeaTable Server URL - The base URL of your SeaTable instance: - - **SeaTable Cloud**: Use `https://cloud.seatable.io` - - **Self-hosted**: Use your instance URL (e.g., `https://seatable.yourcompany.com`) - - ### API Token - Your API token grants access to a specific base. Each token can have read-only or read-write permissions. - - **Note:** API tokens are scoped to a single base. If you need to access multiple bases, you'll need to create separate connections for each one. - */ - content: () => LocalizedString - } triggers: { - new_document: { + new_company: { /** - * New Row + * New Company */ displayName: () => LocalizedString /** - * Trigger when a new row is added to a SeaTable table + * Triggered when a new company is created */ shortDesc: () => LocalizedString /** - * Monitors a SeaTable table for new rows and triggers when new records are detected. The trigger polls for changes and fires when new rows are found. + * Triggers when a new company is created in CopperCRM. You can filter which companies trigger this event using various criteria like assignee, location, tags, and more. */ longDesc: () => LocalizedString options: { - table: { + ids: { /** - * Table + * Company IDs */ displayName: () => LocalizedString /** - * The table to monitor for new rows + * Specific companies to watch */ shortDesc: () => LocalizedString /** - * Select the SeaTable table to monitor. The trigger will fire when new rows are added to this table. + * Only trigger for these specific company IDs */ longDesc: () => LocalizedString } - } - } - } - searchOptions: { - orderBy: { - /** - * Order By - */ - displayName: () => LocalizedString - /** - * Sort results by a specific field - */ - shortDesc: () => LocalizedString - /** - * Define the field and direction to sort search results - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to use for sorting results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort results (ascending or descending) - */ - longDesc: () => LocalizedString - } + page_number: { + /** + * Page Number + */ + displayName: () => LocalizedString + /** + * Which page of results + */ + shortDesc: () => LocalizedString + /** + * The page number of results to retrieve for pagination + */ + longDesc: () => LocalizedString } - } - } - } - actions: { - run_sql: { - /** - * Run SQL Query - */ - displayName: () => LocalizedString - /** - * Execute a SQL query on the SeaTable base - */ - shortDesc: () => LocalizedString - /** - * Executes a SQL query on your SeaTable base and returns the results. Supports SELECT, INSERT, UPDATE, and DELETE statements. Maximum of 10,000 rows can be returned for SELECT queries. - */ - longDesc: () => LocalizedString - options: { - sql: { + page_size: { /** - * SQL Query + * Page Size */ displayName: () => LocalizedString /** - * The SQL query to execute + * Results per page */ shortDesc: () => LocalizedString /** - * Enter your SQL query. Use backticks around column names with special characters (e.g., `My Column`). Example: SELECT * FROM `Table1` WHERE `Status` = 'Active' LIMIT 100 + * The number of results to return per page */ longDesc: () => LocalizedString } - } - } - } - } - Craft: { - groups: { - /** - * Documents & Documentation - */ - '0': () => LocalizedString - /** - * Project & Task Management - */ - '1': () => LocalizedString - } - /** - * Craft - */ - displayName: () => LocalizedString - /** - * Connect to Craft to manage documents, collections, tasks, and blocks seamlessly. - */ - shortDesc: () => LocalizedString - /** - * - The Craft integration provides comprehensive actions and triggers to interact with the Craft API. Manage your documents, collections, tasks, and blocks with powerful automation capabilities for your note-taking and document management workflows. - - - ## API Configuration Requirements - - - ### For Tasks and Daily Notes Actions - - - To use **List Tasks**, **Create Task**, **Update Task**, **Delete Tasks**, and **Get Daily Note Blocks** actions, you must create the **Daily notes & Tasks** API in the **Imagine** tab within Craft. - - - - ### For All Other Actions - - To use **Documents**, **Collections**, and **Blocks** actions, you need to connect **Selected Documents** in your Craft API configuration. - - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to Craft - */ - title: () => LocalizedString - /** - * To connect to Craft, you will need to create an **API connection** in the Craft app. - - ## Creating Your API Connection - - 1. Open the **Craft** app on your Mac or iOS device - 2. Navigate to the **Imagine** tab (AI features section) - 3. Click **Add Your First API Connection** or **+ Add API** - 4. Choose the type of API you want to create: - - **Daily notes & Tasks**: For task management and daily note operations - - **Selected Documents**: For document, collection, and block operations - 5. Follow the prompts to configure your API connection - 6. Copy the generated **API URL** and **Token** (if provided) - - ## Connection Details - - ### API URL - The URL provided by Craft for your API connection. This URL is specific to your account and the type of API you created. - - ### API Token (Optional) - Some API configurations may include a token for additional authentication. If provided, include it in your connection settings. - - ## API Types and Capabilities - - ### Daily Notes & Tasks API - Required for: - - List Tasks, Create Task, Update Task, Delete Tasks - - Get Daily Note Blocks - - ### Selected Documents API - Required for: - - Documents: List Documents - - Collections: List Collections, Create/Update/Delete Collection Items - - Blocks: List Blocks, Insert Block, Delete Blocks - - **Note:** You may need to create multiple API connections if you want to use both task-related actions and document-related actions. Each API type provides access to different sets of functionality. - */ - content: () => LocalizedString - } - triggers: { - new_collection_item: { - /** - * New Collection Item - */ - displayName: () => LocalizedString - /** - * Triggers when a new item is added to a collection - */ - shortDesc: () => LocalizedString - /** - * This trigger activates when a new item is created in the specified Craft collection, allowing you to automate workflows based on new collection entries. - */ - longDesc: () => LocalizedString - options: { - collectionId: { + sort_by: { /** - * Collection + * Sort By */ displayName: () => LocalizedString /** - * The collection to monitor for new items + * Field to sort by */ shortDesc: () => LocalizedString /** - * Select the Craft collection you want to monitor for new items. When a new item is added to this collection, the trigger will fire. + * The field to use for sorting the results */ longDesc: () => LocalizedString } - maxDepth: { + sort_direction: { /** - * Maximum Depth + * Sort Direction */ displayName: () => LocalizedString /** - * Maximum depth for nested content retrieval + * Sort order */ shortDesc: () => LocalizedString /** - * The maximum depth of nested content to fetch for each collection item. Default is -1 (all descendants). With a depth of 0, only the item properties are fetched without nested content. + * The direction to sort results (ascending or descending) */ longDesc: () => LocalizedString } - } - } - } - actions: { - get_blocks: { - groups: { - /** - * Daily Note Blocks (Daily Tasks & Notes API) - */ - '0': () => LocalizedString - } - /** - * Get Daily Note Blocks - */ - displayName: () => LocalizedString - /** - * Retrieve blocks from a daily note - */ - shortDesc: () => LocalizedString - /** - * Fetch all blocks from a Craft daily note for a specific date. You can retrieve blocks from today, yesterday, tomorrow, or any custom date, with control over the depth and metadata of the returned content. - */ - longDesc: () => LocalizedString - options: { - date: { + name: { /** - * Date + * Name */ displayName: () => LocalizedString /** - * Specific date for the daily note + * Company name filter */ shortDesc: () => LocalizedString /** - * Select a specific date to retrieve the daily note blocks. If not provided, you can use the "Day" option to select relative dates like today, yesterday, or tomorrow. + * Only trigger for companies with names matching this value */ longDesc: () => LocalizedString } - day: { + assignee_ids: { /** - * Day + * Assignees */ displayName: () => LocalizedString /** - * Relative day selector + * Filter by assignee */ shortDesc: () => LocalizedString /** - * Choose a relative day option such as today, yesterday, or tomorrow to retrieve the corresponding daily note blocks. + * Only trigger for companies assigned to these users */ longDesc: () => LocalizedString } - maxDepth: { + contact_type_ids: { /** - * Maximum Depth + * Contact Types */ displayName: () => LocalizedString /** - * Maximum depth for nested blocks + * Filter by contact type */ shortDesc: () => LocalizedString /** - * Specify the maximum depth for retrieving nested blocks. Use -1 for unlimited depth, or provide a positive number to limit how deep the nested block structure should be retrieved. + * Only trigger for companies with these contact types */ longDesc: () => LocalizedString } - fetchMetadata: { + city: { /** - * Fetch Metadata + * City */ displayName: () => LocalizedString /** - * Include metadata in the response + * City filter */ shortDesc: () => LocalizedString /** - * Enable this option to include additional metadata such as creation date, last modified date, and author information for each block in the response. + * Only trigger for companies in this city */ longDesc: () => LocalizedString } - } - } - list_documents: { - groups: { - /** - * Documents (Selected Documents API) - */ - '0': () => LocalizedString - } - /** - * List Documents - */ - displayName: () => LocalizedString - /** - * Retrieve all documents - */ - shortDesc: () => LocalizedString - /** - * Get a list of all documents in your Craft workspace. This includes document IDs, titles, and their deletion status, providing a complete overview of your document library. - */ - longDesc: () => LocalizedString - options: { - } - } - list_collections: { - groups: { - /** - * Collections (Selected Documents API) - */ - '0': () => LocalizedString - } - /** - * List Collections - */ - displayName: () => LocalizedString - /** - * Retrieve all collections - */ - shortDesc: () => LocalizedString - /** - * Get a list of all collections in your Craft workspace. You can optionally filter collections by specific documents using include or exclude modes. - */ - longDesc: () => LocalizedString - options: { - documentIds: { + state: { /** - * Document IDs + * State */ displayName: () => LocalizedString /** - * Filter collections by documents + * State or province filter */ shortDesc: () => LocalizedString /** - * The document IDs to filter. If not provided, collections in all documents will be listed. + * Only trigger for companies in this state or province */ longDesc: () => LocalizedString } - documentFilterMode: { + postal_code: { /** - * Document Filter Mode + * Postal Code */ displayName: () => LocalizedString /** - * How to filter by documents + * Postal code filter */ shortDesc: () => LocalizedString /** - * Choose whether to include or exclude collections based on the provided document IDs. Select "Include" to only show collections from the specified documents, or "Exclude" to hide collections from those documents. + * Only trigger for companies with this postal code */ longDesc: () => LocalizedString } - } - } - create_collection_item: { - groups: { - /** - * Collections (Selected Documents API) - */ - '0': () => LocalizedString - } - /** - * Create Collection Item - */ - displayName: () => LocalizedString - /** - * Add a new item to a collection - */ - shortDesc: () => LocalizedString - /** - * Create a new item in a Craft collection with a title and optional custom properties. This allows you to programmatically add entries to your structured collections. - */ - longDesc: () => LocalizedString - options: { - collectionId: { - /** - * Collection - */ - displayName: () => LocalizedString - /** - * The collection to add the item to - */ - shortDesc: () => LocalizedString - /** - * Select the Craft collection where you want to create the new item. The collection must exist before you can add items to it. - */ - longDesc: () => LocalizedString - } - title: { + country: { /** - * Title + * Country */ displayName: () => LocalizedString /** - * Title of the new collection item + * Country filter */ shortDesc: () => LocalizedString /** - * Provide a title for the new collection item. This is the main identifier for the item within the collection. + * Only trigger for companies in this country */ longDesc: () => LocalizedString } - properties: { + tags: { /** - * Properties + * Tags */ displayName: () => LocalizedString /** - * Custom properties for the item + * Filter by tags */ shortDesc: () => LocalizedString /** - * Add custom properties to the collection item. The available properties are dynamically determined based on the schema of the selected collection. + * Only trigger for companies that have any of these tags */ longDesc: () => LocalizedString } - } - } - delete_collection_items: { - groups: { - /** - * Collections (Selected Documents API) - */ - '0': () => LocalizedString - } - /** - * Delete Collection Items - */ - displayName: () => LocalizedString - /** - * Remove items from a collection - */ - shortDesc: () => LocalizedString - /** - * Delete one or more items from a Craft collection by providing their IDs. This action permanently removes the specified items from the collection. - */ - longDesc: () => LocalizedString - options: { - collectionId: { + socials: { /** - * Collection + * Social Media */ displayName: () => LocalizedString /** - * The collection containing the items + * Social media filter */ shortDesc: () => LocalizedString /** - * Select the Craft collection that contains the items you want to delete. + * Only trigger for companies with matching social media profiles */ longDesc: () => LocalizedString } - itemIds: { + followed: { /** - * Item IDs + * Followed */ displayName: () => LocalizedString /** - * IDs of items to delete + * Following status filter */ shortDesc: () => LocalizedString /** - * Provide a list of item IDs that you want to remove from the collection. You can select multiple items to delete in a single operation. + * Only trigger for companies that are followed or not followed */ longDesc: () => LocalizedString } - } - } - update_collection_item: { - groups: { - /** - * Collections (Selected Documents API) - */ - '0': () => LocalizedString - } - /** - * Update Collection Item - */ - displayName: () => LocalizedString - /** - * Modify an existing collection item - */ - shortDesc: () => LocalizedString - /** - * Update the title and properties of an existing item in a Craft collection. You can modify any custom properties that are part of the collection schema. - */ - longDesc: () => LocalizedString - options: { - collectionId: { + minimum_interaction_count: { /** - * Collection + * Minimum Interactions */ displayName: () => LocalizedString /** - * The collection containing the item + * Minimum interaction count */ shortDesc: () => LocalizedString /** - * Select the Craft collection that contains the item you want to update. + * Only trigger for companies with at least this many interactions */ longDesc: () => LocalizedString } - itemId: { + maximum_interaction_count: { /** - * Item + * Maximum Interactions */ displayName: () => LocalizedString /** - * The item to update + * Maximum interaction count */ shortDesc: () => LocalizedString /** - * Select the specific collection item you want to modify. The available items are dynamically populated based on the selected collection. + * Only trigger for companies with no more than this many interactions */ longDesc: () => LocalizedString } - title: { + minimum_inactive_days: { /** - * Title + * Minimum Inactive Days */ displayName: () => LocalizedString /** - * New title for the item + * Minimum days inactive */ shortDesc: () => LocalizedString /** - * Provide a new title for the collection item. Leave empty to keep the existing title unchanged. + * Only trigger for companies inactive for at least this many days */ longDesc: () => LocalizedString } - properties: { + maximum_inactive_days: { /** - * Properties + * Maximum Inactive Days */ displayName: () => LocalizedString /** - * Updated properties for the item + * Maximum days inactive */ shortDesc: () => LocalizedString /** - * Update the custom properties of the collection item. Only the properties you specify will be updated; others will remain unchanged. + * Only trigger for companies inactive for no more than this many days */ longDesc: () => LocalizedString } } } - list_collection_items: { - groups: { - /** - * Collections (Selected Documents API) - */ - '0': () => LocalizedString - } + new_lead: { /** - * List Collection Items + * New Lead */ displayName: () => LocalizedString /** - * Retrieve all items in a collection + * Triggered when a new lead is created */ shortDesc: () => LocalizedString /** - * Get a list of all items in a specific Craft collection, including their IDs, titles, properties, and content blocks. You can control the depth of nested content retrieval. + * Triggers when a new lead is created in CopperCRM. You can filter which leads trigger this event using various criteria like assignee, status, location, and more. */ longDesc: () => LocalizedString options: { - collectionId: { + ids: { /** - * Collection + * Lead IDs */ displayName: () => LocalizedString /** - * The collection to retrieve items from + * Specific leads to watch */ shortDesc: () => LocalizedString /** - * Select the Craft collection whose items you want to list. All items in the collection will be returned. + * Only trigger for these specific lead IDs */ longDesc: () => LocalizedString } - maxDepth: { + page_number: { /** - * Maximum Depth + * Page Number */ displayName: () => LocalizedString /** - * Maximum depth for nested content + * Which page of results */ shortDesc: () => LocalizedString /** - * The maximum depth of nested content to fetch for each collection item. Default is -1 (all descendants). With a depth of 0, only the item properties are fetched without nested content. + * The page number of results to retrieve for pagination */ longDesc: () => LocalizedString } - } - } - list_blocks: { - groups: { - /** - * Blocks (Selected Documents API) - */ - '0': () => LocalizedString - } - /** - * List Blocks - */ - displayName: () => LocalizedString - /** - * Retrieve blocks from a document - */ - shortDesc: () => LocalizedString - /** - * Fetch all blocks from a specific Craft document or page. This allows you to access the structured content of your documents, including nested blocks, with control over depth and metadata. - */ - longDesc: () => LocalizedString - options: { - id: { + page_size: { /** - * Document/Page ID + * Page Size */ displayName: () => LocalizedString /** - * The document or page to retrieve blocks from + * Results per page */ shortDesc: () => LocalizedString /** - * The ID of the page block to fetch. Required for multi-document operations. Accepts IDs for documents, pages and blocks. + * The number of results to return per page */ longDesc: () => LocalizedString } - maxDepth: { + sort_by: { /** - * Maximum Depth + * Sort By */ displayName: () => LocalizedString /** - * Maximum depth for nested blocks + * Field to sort by */ shortDesc: () => LocalizedString /** - * Specify the maximum depth for retrieving nested blocks. Use -1 for unlimited depth, or provide a positive number to limit the nesting level. + * The field to use for sorting the results */ longDesc: () => LocalizedString } - fetchMetadata: { + sort_direction: { /** - * Fetch Metadata + * Sort Direction */ displayName: () => LocalizedString /** - * Include metadata in the response + * Sort order */ shortDesc: () => LocalizedString /** - * Whether to fetch metadata (comments, createdBy, lastModifiedBy, lastModifiedAt, createdAt) for the blocks. + * The direction to sort results (ascending or descending) */ longDesc: () => LocalizedString } - getMarkdownString: { + name: { /** - * Get Markdown String + * Name */ displayName: () => LocalizedString /** - * Retrieve the markdown string representation of blocks + * Lead name filter */ shortDesc: () => LocalizedString /** - * Whether to retrieve the markdown string representation of the blocks. + * Only trigger for leads with names matching this value */ longDesc: () => LocalizedString } - } - } - insert_block: { - groups: { - /** - * Blocks (Selected Documents API) - */ - '0': () => LocalizedString - } - /** - * Insert Block - */ - displayName: () => LocalizedString - /** - * Add a new block to a document - */ - shortDesc: () => LocalizedString - /** - * Insert a new block with markdown content into a Craft document. You can specify whether to insert the block at the start or end of the target page. - */ - longDesc: () => LocalizedString - options: { - markdown: { + phone_number: { /** - * Markdown Content + * Phone Number */ displayName: () => LocalizedString /** - * The markdown content for the block + * Phone number filter */ shortDesc: () => LocalizedString /** - * - The Markdown content to insert. Separate each paragraph and heading with two newlines. Separate each list item with one newline. The first item in any list cannot be empty. Craft-specific tokens are HTML tags.: - - - - - for callouts. Can be used to wrap multiple paragraphs/images/etc. - - - for caption text style. Can be used to wrap a paragraph. - - - for highlights - color is optional. Can only be used inline. - + * Only trigger for leads with this phone number */ longDesc: () => LocalizedString } - position: { + emails: { /** - * Position + * Email */ displayName: () => LocalizedString /** - * Where to insert the block + * Email filter */ shortDesc: () => LocalizedString /** - * Specify the position where the block should be inserted within the document. + * Only trigger for leads with this email address */ longDesc: () => LocalizedString - type: { - fields: { - position: { - /** - * Insert Position - */ - displayName: () => LocalizedString - /** - * Insert at start or end - */ - shortDesc: () => LocalizedString - /** - * Choose whether to insert the block at the start or end of the target page. - */ - longDesc: () => LocalizedString - } - pageId: { - /** - * Page ID - */ - displayName: () => LocalizedString - /** - * The page to insert into - */ - shortDesc: () => LocalizedString - /** - * ID of the block to insert children into. Required for multi-document operations. Only page, text, and card type blocks can be parent blocks. Text blocks are auto-converted to page type when they receive children. Collection items are implicitly pages. - */ - longDesc: () => LocalizedString - } - } - } } - } - } - delete_blocks: { - groups: { - /** - * Blocks (Selected Documents API) - */ - '0': () => LocalizedString - } - /** - * Delete Blocks - */ - displayName: () => LocalizedString - /** - * Remove blocks from a document - */ - shortDesc: () => LocalizedString - /** - * Delete one or more blocks from a Craft document by providing their block IDs. This action permanently removes the specified blocks. - */ - longDesc: () => LocalizedString - options: { - blockIds: { + assignee_ids: { /** - * Block IDs + * Assignees */ displayName: () => LocalizedString /** - * IDs of blocks to delete + * Filter by assignee */ shortDesc: () => LocalizedString /** - * Provide a list of block IDs that you want to remove from the document. You can delete multiple blocks in a single operation. + * Only trigger for leads assigned to these users */ longDesc: () => LocalizedString } - } - } - list_tasks: { - groups: { - /** - * Tasks (Daily Tasks & Notes API) - */ - '0': () => LocalizedString - } - /** - * List Tasks - */ - displayName: () => LocalizedString - /** - * Retrieve tasks based on scope - */ - shortDesc: () => LocalizedString - /** - * Get a list of tasks from your Craft workspace filtered by scope. You can retrieve active tasks, upcoming tasks, inbox tasks, or tasks from your logbook. - */ - longDesc: () => LocalizedString - options: { - scope: { + status_ids: { /** - * Scope + * Statuses */ displayName: () => LocalizedString /** - * Filter tasks by scope + * Filter by status */ shortDesc: () => LocalizedString /** - * Filter tasks by scope: - 'active': Active tasks from inbox and other documents (tasks due before now that are not completed/cancelled) - 'upcoming': Upcoming tasks from inbox and other documents (tasks scheduled after now) - 'inbox': Only tasks in the task inbox - 'logbook': Only tasks in the task logbook (completed and cancelled tasks) + * Only trigger for leads with these statuses */ longDesc: () => LocalizedString } - } - } - create_task: { - groups: { - /** - * Tasks (Daily Tasks & Notes API) - */ - '0': () => LocalizedString - } - /** - * Create Task - */ - displayName: () => LocalizedString - /** - * Add a new task - */ - shortDesc: () => LocalizedString - /** - * Create a new task in Craft with markdown content, optional task information (state, schedule, deadline), and a location (inbox or daily note). - */ - longDesc: () => LocalizedString - options: { - markdown: { + customer_source_ids: { /** - * Task Content + * Customer Sources */ displayName: () => LocalizedString /** - * The markdown content for the task + * Filter by source */ shortDesc: () => LocalizedString /** - * The task content in markdown format. This will be the task's text. + * Only trigger for leads from these customer sources */ longDesc: () => LocalizedString } - taskInfo: { + city: { /** - * Task Information + * City */ displayName: () => LocalizedString /** - * Additional task details + * City filter */ shortDesc: () => LocalizedString /** - * Optional task metadata including state, schedule date, and deadline date + * Only trigger for leads in this city */ longDesc: () => LocalizedString - type: { - fields: { - state: { - /** - * State - */ - displayName: () => LocalizedString - /** - * Current state of the task - */ - shortDesc: () => LocalizedString - /** - * Set the initial state of the task: To Do (pending), Done (completed), or Canceled (abandoned). - */ - longDesc: () => LocalizedString - } - scheduleDate: { - /** - * Schedule Date - */ - displayName: () => LocalizedString - /** - * When the task is scheduled - */ - shortDesc: () => LocalizedString - /** - * Planned execution date of the task. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday' - */ - longDesc: () => LocalizedString - } - deadlineDate: { - /** - * Deadline Date - */ - displayName: () => LocalizedString - /** - * When the task is due - */ - shortDesc: () => LocalizedString - /** - * Due date of the task. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday' - */ - longDesc: () => LocalizedString - } - } - } } - location: { + state: { /** - * Location + * State */ displayName: () => LocalizedString /** - * Where to create the task + * State or province filter */ shortDesc: () => LocalizedString /** - * Where to create the task: in the task inbox or a specific daily note + * Only trigger for leads in this state or province */ longDesc: () => LocalizedString - type: { - fields: { - type: { - /** - * Location Type - */ - displayName: () => LocalizedString - /** - * Type of location - */ - shortDesc: () => LocalizedString - /** - * Choose whether to create the task in your inbox (for unscheduled tasks) or in a daily note (for a specific date). - */ - longDesc: () => LocalizedString - } - date: { - /** - * Date - */ - displayName: () => LocalizedString - /** - * Date for daily note - */ - shortDesc: () => LocalizedString - /** - * The daily note date where the task is located. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday'. Defaults to 'today' if not provided. - */ - longDesc: () => LocalizedString - } - } - } } - } - } - update_task: { - groups: { - /** - * Tasks (Daily Tasks & Notes API) - */ - '0': () => LocalizedString - } - /** - * Update Task - */ - displayName: () => LocalizedString - /** - * Modify an existing task - */ - shortDesc: () => LocalizedString - /** - * Update an existing task in Craft by changing its markdown content, state, schedule date, or deadline date. - */ - longDesc: () => LocalizedString - options: { - id: { + postal_code: { /** - * Task + * Postal Code */ displayName: () => LocalizedString /** - * The task to update + * Postal code filter */ shortDesc: () => LocalizedString /** - * Select the task you want to modify. Only active tasks are available for selection. + * Only trigger for leads with this postal code */ longDesc: () => LocalizedString } - markdown: { + country: { /** - * Task Content + * Country */ displayName: () => LocalizedString /** - * Updated markdown content + * Country filter */ shortDesc: () => LocalizedString /** - * Provide new markdown-formatted content for the task. Leave empty to keep the existing content. + * Only trigger for leads in this country */ longDesc: () => LocalizedString } - state: { + tags: { /** - * State + * Tags */ displayName: () => LocalizedString /** - * Updated task state + * Filter by tags */ shortDesc: () => LocalizedString /** - * Change the state of the task to To Do, Done, or Canceled. Leave empty to keep the current state. + * Only trigger for leads that have any of these tags */ longDesc: () => LocalizedString } - scheduleDate: { + socials: { /** - * Schedule Date + * Social Media */ displayName: () => LocalizedString /** - * Updated schedule date + * Social media filter */ shortDesc: () => LocalizedString /** - * Updated planned execution date. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday'. Leave empty to keep the existing schedule. + * Only trigger for leads with matching social media profiles */ longDesc: () => LocalizedString } - deadlineDate: { + followed: { /** - * Deadline Date + * Followed */ displayName: () => LocalizedString /** - * Updated deadline date + * Following status filter */ shortDesc: () => LocalizedString /** - * Updated due date of the task. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday'. Leave empty to keep the existing deadline. + * Only trigger for leads that are followed or not followed */ longDesc: () => LocalizedString } - } - } - delete_tasks: { - groups: { - /** - * Tasks (Daily Tasks & Notes API) - */ - '0': () => LocalizedString - } - /** - * Delete Tasks - */ - displayName: () => LocalizedString - /** - * Remove tasks - */ - shortDesc: () => LocalizedString - /** - * Delete one or more tasks from your Craft workspace by providing their task IDs. This action permanently removes the specified tasks. - */ - longDesc: () => LocalizedString - options: { - ids: { + age: { /** - * Task IDs + * Age */ displayName: () => LocalizedString /** - * IDs of tasks to delete + * Lead age filter */ shortDesc: () => LocalizedString /** - * Provide a list of task IDs that you want to remove. You can delete multiple tasks in a single operation. + * Only trigger for leads of this age in days */ longDesc: () => LocalizedString } - } - } - } - } - Monday: { - /** - * Monday.com - */ - displayName: () => LocalizedString - groups: { - /** - * Project & Task Management - */ - '0': () => LocalizedString - } - /** - * Connect to Monday.com to automate work management with boards, items, columns, and updates. - */ - shortDesc: () => LocalizedString - /** - * The Monday.com integration provides comprehensive access to your work operating system. Create and manage boards, items, groups, and columns. Track work progress, update item statuses, manage column values, and monitor board changes. Automate workflows by creating items, updating records, moving items between groups, and receiving notifications when boards or items are modified. Perfect for project management, task tracking, team collaboration, and workflow automation across your organization. - */ - longDesc: () => LocalizedString - actions: { - archive_record: { - /** - * Archive Record - */ - displayName: () => LocalizedString - /** - * Move a record to the archive. - */ - shortDesc: () => LocalizedString - /** - * This action allows you to archive a specific record (item) on a Monday.com board, helping you keep your workspace organized by removing completed or inactive items from view without permanently deleting them. - */ - longDesc: () => LocalizedString - options: { - board_id: { + minimum_monetary_value: { /** - * Board ID + * Minimum Value */ displayName: () => LocalizedString /** - * The ID of the board containing the record to archive. + * Minimum monetary value */ shortDesc: () => LocalizedString /** - * The unique identifier of the board containing the record you want to archive. + * Only trigger for leads with at least this monetary value */ longDesc: () => LocalizedString } - record_id: { + maximum_monetary_value: { /** - * Record ID + * Maximum Value */ displayName: () => LocalizedString /** - * The ID of the record to archive. + * Maximum monetary value */ shortDesc: () => LocalizedString /** - * The unique identifier of the record you want to archive. + * Only trigger for leads with no more than this monetary value */ longDesc: () => LocalizedString } - } - } - clear_column_value: { - /** - * Clear Column Value - */ - displayName: () => LocalizedString - /** - * Remove data from a column in a record. - */ - shortDesc: () => LocalizedString - /** - * Use this action to clear the content of a specified column within a record, resetting its value to empty. - */ - longDesc: () => LocalizedString - options: { - board_id: { + minimum_interaction_count: { /** - * Board ID + * Minimum Interactions */ displayName: () => LocalizedString /** - * The ID of the board containing the record. + * Minimum interaction count */ shortDesc: () => LocalizedString /** - * The unique identifier of the board containing the record you want to modify. + * Only trigger for leads with at least this many interactions */ longDesc: () => LocalizedString } - record_id: { + maximum_interaction_count: { /** - * Record ID + * Maximum Interactions */ displayName: () => LocalizedString /** - * The ID of the record to modify. + * Maximum interaction count */ shortDesc: () => LocalizedString /** - * The unique identifier of the record you want to modify. + * Only trigger for leads with no more than this many interactions */ longDesc: () => LocalizedString } - column_id: { + include_converted_leads: { /** - * Column ID + * Include Converted Leads */ displayName: () => LocalizedString /** - * The ID of the column to clear. + * Include converted leads */ shortDesc: () => LocalizedString /** - * The unique identifier of the column you want to clear. + * Whether to trigger for leads that have been converted to opportunities */ longDesc: () => LocalizedString } } } - create_record: { + new_opportunity: { /** - * Create Record + * New Opportunity */ displayName: () => LocalizedString /** - * Add a new record to a board. + * Triggered when a new opportunity is created */ shortDesc: () => LocalizedString /** - * This action enables you to create a new record (item) in a specified board, allowing you to define initial column values upon creation. + * Triggers when a new opportunity is created in CopperCRM. You can filter which opportunities trigger this event using various criteria like pipeline, stage, status, value, and more. */ longDesc: () => LocalizedString options: { - board_id: { + ids: { /** - * Board ID + * Opportunity IDs */ displayName: () => LocalizedString /** - * The ID of the board where the record will be created. + * Specific opportunities to watch */ shortDesc: () => LocalizedString /** - * The unique identifier of the board where you want to create a new record. + * Only trigger for these specific opportunity IDs */ longDesc: () => LocalizedString } - group_id: { + page_number: { /** - * Group ID + * Page Number */ displayName: () => LocalizedString /** - * The ID of the group where the record will be created. + * Which page of results */ shortDesc: () => LocalizedString /** - * The unique identifier of the group where you want to create a new record. + * The page number of results to retrieve for pagination */ longDesc: () => LocalizedString } - item_name: { + page_size: { /** - * Item Name + * Page Size */ displayName: () => LocalizedString /** - * The name of the new record. + * Results per page */ shortDesc: () => LocalizedString /** - * The name of the new record you want to create. + * The number of results to return per page */ longDesc: () => LocalizedString } - column_values: { + sort_by: { /** - * Column Values + * Sort By */ displayName: () => LocalizedString /** - * The values to set for the record columns. + * Field to sort by */ shortDesc: () => LocalizedString /** - * The values to set for the columns of the record you want to create. + * The field to use for sorting the results */ longDesc: () => LocalizedString } - } - } - custom_action: { - /** - * Custom Action - */ - displayName: () => LocalizedString - /** - * Perform a user-defined operation. - */ - shortDesc: () => LocalizedString - /** - * This action allows you to execute a custom operation defined by your integration or automation setup, providing flexibility for various tasks. - */ - longDesc: () => LocalizedString - options: { - payload: { + sort_direction: { /** - * Payload + * Sort Direction */ displayName: () => LocalizedString /** - * Payload for your custom action + * Sort order */ shortDesc: () => LocalizedString /** - * The payload for your custom action + * The direction to sort results (ascending or descending) */ longDesc: () => LocalizedString } - actionName: { + name: { /** - * Action Name + * Name */ displayName: () => LocalizedString /** - * The name of the custom action to execute + * Opportunity name filter */ shortDesc: () => LocalizedString /** - * The name of the custom action to execute + * Only trigger for opportunities with names matching this value */ longDesc: () => LocalizedString } - } - } - delete_record: { - /** - * Delete Record - */ - displayName: () => LocalizedString - /** - * Permanently remove a record. - */ - shortDesc: () => LocalizedString - /** - * Use this action to permanently delete a specific record from a board, removing all associated data. - */ - longDesc: () => LocalizedString - options: { - board_id: { + assignee_ids: { /** - * Board ID + * Assignees */ displayName: () => LocalizedString /** - * The ID of the board containing the record to delete. + * Filter by assignee */ shortDesc: () => LocalizedString /** - * The unique identifier of the board containing the record you want to delete. + * Only trigger for opportunities assigned to these users */ longDesc: () => LocalizedString } - record_id: { + company_ids: { /** - * Record ID + * Companies */ displayName: () => LocalizedString /** - * The ID of the record to delete. + * Filter by company */ shortDesc: () => LocalizedString /** - * The unique identifier of the record you want to delete. + * Only trigger for opportunities associated with these companies */ longDesc: () => LocalizedString } - } - } - get_record: { - /** - * Get Record - */ - displayName: () => LocalizedString - /** - * Retrieve details of a specific record. - */ - shortDesc: () => LocalizedString - /** - * This action fetches the details of a specified record, including all column values and associated metadata. - */ - longDesc: () => LocalizedString - options: { - board_id: { + customer_source_ids: { /** - * Board ID + * Customer Sources */ displayName: () => LocalizedString /** - * The ID of the board containing the record to get. + * Filter by source */ shortDesc: () => LocalizedString /** - * The unique identifier of the board containing the record you want to get. + * Only trigger for opportunities from these customer sources */ longDesc: () => LocalizedString } - record_id: { + loss_reason_ids: { /** - * Record ID + * Loss Reasons */ displayName: () => LocalizedString /** - * The ID of the record to get. + * Filter by loss reason */ shortDesc: () => LocalizedString /** - * The unique identifier of the record you want to get. + * Only trigger for opportunities with these loss reasons */ longDesc: () => LocalizedString } - } - } - move_record: { - /** - * Move Record - */ - displayName: () => LocalizedString - /** - * Transfer a record to another group or board. - */ - shortDesc: () => LocalizedString - /** - * Use this action to move a record from its current group or board to another specified group or board, maintaining its data and history. - */ - longDesc: () => LocalizedString - options: { - board_id: { + pipeline_ids: { /** - * Board ID + * Pipelines */ displayName: () => LocalizedString /** - * The ID of the board containing the record to move. + * Filter by pipeline */ shortDesc: () => LocalizedString /** - * The unique identifier of the board containing the record you want to move. + * Only trigger for opportunities in these pipelines */ longDesc: () => LocalizedString } - record_id: { + pipeline_stage_ids: { /** - * Record ID + * Pipeline Stages */ displayName: () => LocalizedString /** - * The ID of the record to move. + * Filter by stage */ shortDesc: () => LocalizedString /** - * The unique identifier of the record you want to move. + * Only trigger for opportunities in these pipeline stages */ longDesc: () => LocalizedString } - destination_group_id: { + primary_contact_ids: { /** - * Destination Group ID + * Primary Contacts */ displayName: () => LocalizedString /** - * The ID of the group to move the record to. + * Filter by primary contact */ shortDesc: () => LocalizedString /** - * The unique identifier of the group you want to move the record to. + * Only trigger for opportunities with these primary contacts */ longDesc: () => LocalizedString } - } - } - search_records: { - /** - * Search Records - */ - displayName: () => LocalizedString - /** - * Find records matching specific criteria. - */ - shortDesc: () => LocalizedString - /** - * This action allows you to search for records that meet defined criteria, such as specific column values or statuses, and returns a list of matching records. - */ - longDesc: () => LocalizedString - options: { - board_id: { + priorities: { /** - * Board ID + * Priorities */ displayName: () => LocalizedString /** - * The ID of the board to search for records in. + * Filter by priority */ shortDesc: () => LocalizedString /** - * The unique identifier of the board containing the records you want to search for. + * Only trigger for opportunities with these priority levels */ longDesc: () => LocalizedString } - query_text: { + statuses: { /** - * Query + * Statuses */ displayName: () => LocalizedString /** - * The search query to use. + * Filter by status */ shortDesc: () => LocalizedString /** - * The search query to use to find records. + * Only trigger for opportunities with these statuses */ longDesc: () => LocalizedString } - columnId: { + tags: { /** - * Column ID + * Tags */ displayName: () => LocalizedString /** - * The ID of the column to search in. + * Filter by tags */ shortDesc: () => LocalizedString /** - * The unique identifier of the column to search in. + * Only trigger for opportunities that have any of these tags */ longDesc: () => LocalizedString } - limit: { + followed: { /** - * Limit + * Followed */ displayName: () => LocalizedString /** - * The maximum number of records to return. + * Following status filter */ shortDesc: () => LocalizedString /** - * The maximum number of records to return. + * Only trigger for opportunities that are followed or not followed */ longDesc: () => LocalizedString } - cursor: { + minimum_monetary_value: { /** - * Cursor + * Minimum Value */ displayName: () => LocalizedString /** - * The cursor to use for pagination. + * Minimum deal value */ shortDesc: () => LocalizedString /** - * The cursor to use for pagination. + * Only trigger for opportunities with at least this monetary value */ longDesc: () => LocalizedString } - } - } - update_record: { - /** - * Update Record - */ - displayName: () => LocalizedString - /** - * Modify the values of a record's columns. - */ - shortDesc: () => LocalizedString - /** - * Use this action to update one or more column values of a specific record, allowing you to change its data as needed. - */ - longDesc: () => LocalizedString - options: { - board_id: { + maximum_monetary_value: { /** - * Board ID + * Maximum Value */ displayName: () => LocalizedString /** - * The ID of the board containing the record to update. + * Maximum deal value */ shortDesc: () => LocalizedString /** - * The unique identifier of the board containing the record you want to update. + * Only trigger for opportunities with no more than this monetary value */ longDesc: () => LocalizedString } - record_id: { + minimum_win_probability: { /** - * Record ID + * Minimum Win Probability */ displayName: () => LocalizedString /** - * The ID of the record to update. + * Minimum win chance */ shortDesc: () => LocalizedString /** - * The unique identifier of the record you want to update. + * Only trigger for opportunities with at least this win probability */ longDesc: () => LocalizedString } - column_values: { + maximum_win_probability: { /** - * Column Values + * Maximum Win Probability */ displayName: () => LocalizedString /** - * The values to set for the record columns. + * Maximum win chance */ shortDesc: () => LocalizedString /** - * The values to set for the columns of the record you want to update. + * Only trigger for opportunities with no more than this win probability */ longDesc: () => LocalizedString } - } - } - } - triggers: { - new_record: { - /** - * New Record - */ - displayName: () => LocalizedString - /** - * Triggered when a new item is created. - */ - shortDesc: () => LocalizedString - /** - * Triggered when a new record is created. - */ - longDesc: () => LocalizedString - options: { - board_id: { + minimum_interaction_count: { /** - * Board ID + * Minimum Interactions */ displayName: () => LocalizedString /** - * The ID of the board to check for new records. + * Minimum interaction count */ shortDesc: () => LocalizedString /** - * The unique identifier of the board that should be checked for new records. + * Only trigger for opportunities with at least this many interactions */ longDesc: () => LocalizedString } - group_id: { + maximum_interaction_count: { /** - * Group ID + * Maximum Interactions */ displayName: () => LocalizedString /** - * The ID of the group to check for new records. + * Maximum interaction count */ shortDesc: () => LocalizedString /** - * The unique identifier of the group you want to check for new records in. + * Only trigger for opportunities with no more than this many interactions */ longDesc: () => LocalizedString } } } - new_record_moved_to_group: { + new_person: { /** - * New Record Moved To Group + * New Person */ displayName: () => LocalizedString /** - * Triggered when an item was moved to a group. + * Triggered when a new person contact is created */ shortDesc: () => LocalizedString /** - * Triggered when a new record is created. + * Triggers when a new person contact is created in CopperCRM. You can filter which people trigger this event using various criteria like assignee, company, location, and more. */ longDesc: () => LocalizedString options: { - board_id: { + ids: { /** - * Board ID + * Person IDs */ displayName: () => LocalizedString /** - * The ID of the board to check for new records. + * Specific people to watch */ shortDesc: () => LocalizedString /** - * The unique identifier of the board that should be checked for new records. + * Only trigger for these specific person IDs */ longDesc: () => LocalizedString } - group_id: { + name: { /** - * Group ID + * Name */ displayName: () => LocalizedString /** - * The ID of the group to check for new records. + * Person name filter */ shortDesc: () => LocalizedString /** - * The unique identifier of the group you want to check for new records in. + * Only trigger for people with names matching this value */ longDesc: () => LocalizedString } - } - } - record_column_value_updated: { - /** - * Record Column Value Updated - */ - displayName: () => LocalizedString - /** - * Triggered when a record column value is updated. - */ - shortDesc: () => LocalizedString - /** - * Triggered when a record column value is updated. - */ - longDesc: () => LocalizedString - options: { - board_id: { + title: { /** - * Board ID + * Title */ displayName: () => LocalizedString /** - * The ID of the board to check for record field updates. + * Job title filter */ shortDesc: () => LocalizedString /** - * The unique identifier of the board that should be checked for record field updates. + * Only trigger for people with this job title */ longDesc: () => LocalizedString } - column_id: { + email: { /** - * Column ID + * Email */ displayName: () => LocalizedString /** - * The ID of the column to check for new value. + * Email filter */ shortDesc: () => LocalizedString /** - * The unique identifier of the column that should be checked for new value. + * Only trigger for people with this email address */ longDesc: () => LocalizedString } - } - } - updated_record: { - /** - * Updated Record - */ - displayName: () => LocalizedString - /** - * Triggered when an item is updated. - */ - shortDesc: () => LocalizedString - /** - * Triggered when an item on the board is updated. - */ - longDesc: () => LocalizedString - options: { - board_id: { + phone: { /** - * Board ID + * Phone */ displayName: () => LocalizedString /** - * The ID of the board to check for updated records. + * Phone number filter */ shortDesc: () => LocalizedString /** - * The unique identifier of the board that should be checked for updated records. + * Only trigger for people with this phone number */ longDesc: () => LocalizedString } - group_id: { + city: { /** - * Group ID + * City */ displayName: () => LocalizedString /** - * The ID of the group to check for new records. + * City filter */ shortDesc: () => LocalizedString /** - * The unique identifier of the group you want to check for new records in. + * Only trigger for people in this city */ longDesc: () => LocalizedString } - } - } - } - expressions: { - '&&': { - /** - * and (&&) - */ - displayName: () => LocalizedString - /** - * Returns True if all arguments are True - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if all arguments are `True` with logic short-circuiting - */ - longDesc: () => LocalizedString - args: { - '0': { + state: { /** - * Condition + * State */ displayName: () => LocalizedString /** - * Boolean condition to evaluate + * State or province filter */ shortDesc: () => LocalizedString /** - * A boolean expression or condition that evaluates to True or False + * Only trigger for people in this state or province */ longDesc: () => LocalizedString } - } - } - '||': { - /** - * or (||) - */ - displayName: () => LocalizedString - /** - * Returns True if any argument is True - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if any argument is `True` with logic short-circuiting - */ - longDesc: () => LocalizedString - args: { - '0': { + postal_code: { /** - * Condition + * Postal Code */ displayName: () => LocalizedString /** - * Boolean condition to evaluate + * Postal code filter */ shortDesc: () => LocalizedString /** - * A boolean expression or condition that evaluates to True or False + * Only trigger for people with this postal code */ longDesc: () => LocalizedString } - } - } - '==': { - /** - * equal (==) - */ - displayName: () => LocalizedString - /** - * Equality comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value equals the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + country: { /** - * Field + * Country */ displayName: () => LocalizedString /** - * Field to compare + * Country filter */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Only trigger for people in this country */ longDesc: () => LocalizedString } - '1': { + assignee_ids: { /** - * Value + * Assignees */ displayName: () => LocalizedString /** - * Value to compare against + * Filter by assignee */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Only trigger for people assigned to these users */ longDesc: () => LocalizedString } - } - } - '!=': { - /** - * not equal (!=) - */ - displayName: () => LocalizedString - /** - * Inequality comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value does not equal the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + contact_type_ids: { /** - * Field + * Contact Types */ displayName: () => LocalizedString /** - * Field to compare + * Filter by contact type */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Only trigger for people with these contact types */ longDesc: () => LocalizedString } - '1': { + company_ids: { /** - * Value + * Companies */ displayName: () => LocalizedString /** - * Value to compare against + * Filter by company */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Only trigger for people associated with these companies */ longDesc: () => LocalizedString } - } - } - '>': { - /** - * higher than (>) - */ - displayName: () => LocalizedString - /** - * Greater than comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is greater than the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + tags: { /** - * Field + * Tags */ displayName: () => LocalizedString /** - * Field to compare + * Filter by tags */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Only trigger for people that have any of these tags */ longDesc: () => LocalizedString } - '1': { + socials: { /** - * Value + * Social Media */ displayName: () => LocalizedString /** - * Value to compare against + * Social media filter */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Only trigger for people with these social media profiles */ longDesc: () => LocalizedString } - } - } - '>=': { - /** - * higher than or equal (>=) - */ - displayName: () => LocalizedString - /** - * Greater than or equal comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is greater than or equal to the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + minimum_interaction_count: { /** - * Field + * Minimum Interactions */ displayName: () => LocalizedString /** - * Field to compare + * Minimum interaction count */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Only trigger for people with at least this many interactions */ longDesc: () => LocalizedString } - '1': { + maximum_interaction_count: { /** - * Value + * Maximum Interactions */ displayName: () => LocalizedString /** - * Value to compare against + * Maximum interaction count */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Only trigger for people with no more than this many interactions */ longDesc: () => LocalizedString } - } - } - '<': { - /** - * lower than (<) - */ - displayName: () => LocalizedString - /** - * Less than comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is less than the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + page_number: { /** - * Field + * Page Number */ displayName: () => LocalizedString /** - * Field to compare + * Which page of results */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * The page number of results to retrieve for pagination */ longDesc: () => LocalizedString } - '1': { + page_size: { /** - * Value + * Page Size */ displayName: () => LocalizedString /** - * Value to compare against + * Results per page */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * The number of results to return per page */ longDesc: () => LocalizedString } - } - } - '<=': { - /** - * lower than or equal (<=) - */ - displayName: () => LocalizedString - /** - * Less than or equal comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is less than or equal to the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + sort_by: { /** - * Field + * Sort By */ displayName: () => LocalizedString /** - * Field to compare + * Field to sort by */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * The field to use for sorting the results */ longDesc: () => LocalizedString } - '1': { + sort_direction: { /** - * Value + * Sort Direction */ displayName: () => LocalizedString /** - * Value to compare against + * Sort order */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * The direction to sort results (ascending or descending) */ longDesc: () => LocalizedString } } } - 'in': { + new_task: { /** - * in + * New Task */ displayName: () => LocalizedString /** - * Value is in list + * Triggered when a new task is created */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is in the specified list of values + * Triggers when a new task is created in CopperCRM. You can filter which tasks trigger this event using various criteria like assignee, status, priority, and more. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + ids: { /** - * Field + * Task IDs */ displayName: () => LocalizedString /** - * Field to check + * Specific tasks to watch */ shortDesc: () => LocalizedString /** - * The field whose value will be checked + * Only trigger for these specific task IDs */ longDesc: () => LocalizedString } - '1': { + page_number: { /** - * Values + * Page Number */ displayName: () => LocalizedString /** - * List of values + * Which page of results */ shortDesc: () => LocalizedString /** - * The list of values to check against + * The page number of results to retrieve for pagination */ longDesc: () => LocalizedString } - } - } - 'not-in': { - /** - * not in - */ - displayName: () => LocalizedString - /** - * Value is not in list - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is not in the specified list of values - */ - longDesc: () => LocalizedString - args: { - '0': { + page_size: { /** - * Field + * Page Size */ displayName: () => LocalizedString /** - * Field to check + * Results per page */ shortDesc: () => LocalizedString /** - * The field whose value will be checked + * The number of results to return per page */ longDesc: () => LocalizedString } - '1': { + sort_by: { /** - * Values + * Sort By */ displayName: () => LocalizedString /** - * List of values + * Field to sort by */ shortDesc: () => LocalizedString /** - * The list of values to check against + * The field to use for sorting the results + */ + longDesc: () => LocalizedString + } + sort_direction: { + /** + * Sort Direction + */ + displayName: () => LocalizedString + /** + * Sort order + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } + assignee_ids: { + /** + * Assignees + */ + displayName: () => LocalizedString + /** + * Filter by assignee + */ + shortDesc: () => LocalizedString + /** + * Only trigger for tasks assigned to these users + */ + longDesc: () => LocalizedString + } + statuses: { + /** + * Statuses + */ + displayName: () => LocalizedString + /** + * Filter by status + */ + shortDesc: () => LocalizedString + /** + * Only trigger for tasks with these statuses + */ + longDesc: () => LocalizedString + } + priorities: { + /** + * Priorities + */ + displayName: () => LocalizedString + /** + * Filter by priority + */ + shortDesc: () => LocalizedString + /** + * Only trigger for tasks with these priority levels + */ + longDesc: () => LocalizedString + } + tags: { + /** + * Tags + */ + displayName: () => LocalizedString + /** + * Filter by tags + */ + shortDesc: () => LocalizedString + /** + * Only trigger for tasks that have any of these tags + */ + longDesc: () => LocalizedString + } + followed: { + /** + * Followed + */ + displayName: () => LocalizedString + /** + * Following status filter + */ + shortDesc: () => LocalizedString + /** + * Only trigger for tasks that are followed or not followed */ longDesc: () => LocalizedString } } } - 'is-empty': { + } + } + SeaTable: { + /** + * SeaTable + */ + displayName: () => LocalizedString + groups: { + /** + * Spreadsheets & Data Tables + */ + '0': () => LocalizedString + /** + * Databases & Backend Services + */ + '1': () => LocalizedString + } + /** + * Connect to SeaTable to manage your database tables and records with powerful automation + */ + shortDesc: () => LocalizedString + /** + * The SeaTable integration provides comprehensive access to your SeaTable database operations. Create, read, update, and delete records in your tables, execute SQL queries, and monitor new entries with real-time triggers. Whether you need to manage data, filter results with SQL, or track new records, this integration streamlines your SeaTable workflow automation and database management. + */ + longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to SeaTable + */ + title: () => LocalizedString + /** + * To connect to SeaTable, you will need your **SeaTable Server URL** and an **API Token**. + + ## Getting Your API Token + + 1. Log in to your SeaTable instance + 2. Open the base you want to connect to + 3. Click on the **dropdown arrow** next to the base name + 4. Select **API Token** from the menu + 5. Create a new token with the desired permissions (read or read/write) + + For detailed instructions, see the [SeaTable API Token Guide](https://seatable.com/help/create-api-tokens/). + + ## Connection Details + + ### SeaTable Server URL + The base URL of your SeaTable instance: + - **SeaTable Cloud**: Use `https://cloud.seatable.io` + - **Self-hosted**: Use your instance URL (e.g., `https://seatable.yourcompany.com`) + + ### API Token + Your API token grants access to a specific base. Each token can have read-only or read-write permissions. + + **Note:** API tokens are scoped to a single base. If you need to access multiple bases, you'll need to create separate connections for each one. + */ + content: () => LocalizedString + } + triggers: { + new_document: { /** - * is empty + * New Row */ displayName: () => LocalizedString /** - * Field is empty + * Trigger when a new row is added to a SeaTable table */ shortDesc: () => LocalizedString /** - * Returns `True` if the field is empty or has no value + * Monitors a SeaTable table for new rows and triggers when new records are detected. The trigger polls for changes and fires when new rows are found. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + table: { /** - * Field + * Table */ displayName: () => LocalizedString /** - * Field to check + * The table to monitor for new rows */ shortDesc: () => LocalizedString /** - * The field to check for emptiness + * Select the SeaTable table to monitor. The trigger will fire when new rows are added to this table. */ longDesc: () => LocalizedString } } } - 'is-not-empty': { + } + searchOptions: { + orderBy: { /** - * is not empty + * Order By */ displayName: () => LocalizedString /** - * Field is not empty + * Sort results by a specific field */ shortDesc: () => LocalizedString /** - * Returns `True` if the field has a value + * Define the field and direction to sort search results */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to check - */ - shortDesc: () => LocalizedString - /** - * The field to check for a value - */ - longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for sorting results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } } } } - between: { + } + actions: { + run_sql: { /** - * between + * Run SQL Query */ displayName: () => LocalizedString /** - * Value is between two values + * Execute a SQL query on the SeaTable base */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is between two specified values (inclusive) + * Executes a SQL query on your SeaTable base and returns the results. Supports SELECT, INSERT, UPDATE, and DELETE statements. Maximum of 10,000 rows can be returned for SELECT queries. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + sql: { /** - * Field + * SQL Query */ displayName: () => LocalizedString /** - * Field to check + * The SQL query to execute */ shortDesc: () => LocalizedString /** - * The field whose value will be checked + * Enter your SQL query. Use backticks around column names with special characters (e.g., `My Column`). Example: SELECT * FROM `Table1` WHERE `Status` = 'Active' LIMIT 100 */ longDesc: () => LocalizedString } - '1': { + } + } + } + } + Craft: { + groups: { + /** + * Documents & Documentation + */ + '0': () => LocalizedString + /** + * Project & Task Management + */ + '1': () => LocalizedString + } + /** + * Craft + */ + displayName: () => LocalizedString + /** + * Connect to Craft to manage documents, collections, tasks, and blocks seamlessly. + */ + shortDesc: () => LocalizedString + /** + * + The Craft integration provides comprehensive actions and triggers to interact with the Craft API. Manage your documents, collections, tasks, and blocks with powerful automation capabilities for your note-taking and document management workflows. + + + ## API Configuration Requirements + + + ### For Tasks and Daily Notes Actions + + + To use **List Tasks**, **Create Task**, **Update Task**, **Delete Tasks**, and **Get Daily Note Blocks** actions, you must create the **Daily notes & Tasks** API in the **Imagine** tab within Craft. + + + + ### For All Other Actions + + To use **Documents**, **Collections**, and **Blocks** actions, you need to connect **Selected Documents** in your Craft API configuration. + + */ + longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to Craft + */ + title: () => LocalizedString + /** + * To connect to Craft, you will need to create an **API connection** in the Craft app. + + ## Creating Your API Connection + + 1. Open the **Craft** app on your Mac or iOS device + 2. Navigate to the **Imagine** tab (AI features section) + 3. Click **Add Your First API Connection** or **+ Add API** + 4. Choose the type of API you want to create: + - **Daily notes & Tasks**: For task management and daily note operations + - **Selected Documents**: For document, collection, and block operations + 5. Follow the prompts to configure your API connection + 6. Copy the generated **API URL** and **Token** (if provided) + + ## Connection Details + + ### API URL + The URL provided by Craft for your API connection. This URL is specific to your account and the type of API you created. + + ### API Token (Optional) + Some API configurations may include a token for additional authentication. If provided, include it in your connection settings. + + ## API Types and Capabilities + + ### Daily Notes & Tasks API + Required for: + - List Tasks, Create Task, Update Task, Delete Tasks + - Get Daily Note Blocks + + ### Selected Documents API + Required for: + - Documents: List Documents + - Collections: List Collections, Create/Update/Delete Collection Items + - Blocks: List Blocks, Insert Block, Delete Blocks + + **Note:** You may need to create multiple API connections if you want to use both task-related actions and document-related actions. Each API type provides access to different sets of functionality. + */ + content: () => LocalizedString + } + triggers: { + new_collection_item: { + /** + * New Collection Item + */ + displayName: () => LocalizedString + /** + * Triggers when a new item is added to a collection + */ + shortDesc: () => LocalizedString + /** + * This trigger activates when a new item is created in the specified Craft collection, allowing you to automate workflows based on new collection entries. + */ + longDesc: () => LocalizedString + options: { + collectionId: { /** - * Lower Value + * Collection */ displayName: () => LocalizedString /** - * Lower bound + * The collection to monitor for new items */ shortDesc: () => LocalizedString /** - * The lower bound value + * Select the Craft collection you want to monitor for new items. When a new item is added to this collection, the trigger will fire. */ longDesc: () => LocalizedString } - '2': { + maxDepth: { /** - * Upper Value + * Maximum Depth */ displayName: () => LocalizedString /** - * Upper bound + * Maximum depth for nested content retrieval */ shortDesc: () => LocalizedString /** - * The upper bound value + * The maximum depth of nested content to fetch for each collection item. Default is -1 (all descendants). With a depth of 0, only the item properties are fetched without nested content. */ longDesc: () => LocalizedString } } } - 'contains-text': { + } + actions: { + get_blocks: { + groups: { + /** + * Daily Note Blocks (Daily Tasks & Notes API) + */ + '0': () => LocalizedString + } /** - * contains text + * Get Daily Note Blocks */ displayName: () => LocalizedString /** - * Contains text + * Retrieve blocks from a daily note */ shortDesc: () => LocalizedString /** - * Returns `True` if the field contains the specified text + * Fetch all blocks from a Craft daily note for a specific date. You can retrieve blocks from today, yesterday, tomorrow, or any custom date, with control over the depth and metadata of the returned content. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + date: { /** - * Field + * Date */ displayName: () => LocalizedString /** - * Text field to search + * Specific date for the daily note */ shortDesc: () => LocalizedString /** - * The text field to search within + * Select a specific date to retrieve the daily note blocks. If not provided, you can use the "Day" option to select relative dates like today, yesterday, or tomorrow. */ longDesc: () => LocalizedString } - '1': { + day: { /** - * Text + * Day */ displayName: () => LocalizedString /** - * Text to search for + * Relative day selector */ shortDesc: () => LocalizedString /** - * The text string to search for within the field + * Choose a relative day option such as today, yesterday, or tomorrow to retrieve the corresponding daily note blocks. */ longDesc: () => LocalizedString } - } - } - 'not-contains-text': { - /** - * does not contain text - */ - displayName: () => LocalizedString - /** - * Does not contain text - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field does not contain the specified text - */ - longDesc: () => LocalizedString - args: { - '0': { + maxDepth: { /** - * Field + * Maximum Depth */ displayName: () => LocalizedString /** - * Text field to search + * Maximum depth for nested blocks */ shortDesc: () => LocalizedString /** - * The text field to search within + * Specify the maximum depth for retrieving nested blocks. Use -1 for unlimited depth, or provide a positive number to limit how deep the nested block structure should be retrieved. */ longDesc: () => LocalizedString } - '1': { + fetchMetadata: { /** - * Text + * Fetch Metadata */ displayName: () => LocalizedString /** - * Text to exclude + * Include metadata in the response */ shortDesc: () => LocalizedString /** - * The text string that should not be present in the field + * Enable this option to include additional metadata such as creation date, last modified date, and author information for each block in the response. */ longDesc: () => LocalizedString } } } - 'contains-terms': { + list_documents: { + groups: { + /** + * Documents (Selected Documents API) + */ + '0': () => LocalizedString + } /** - * contains terms + * List Documents */ displayName: () => LocalizedString /** - * Contains search terms + * Retrieve all documents */ shortDesc: () => LocalizedString /** - * Returns `True` if the field contains any of the specified search terms + * Get a list of all documents in your Craft workspace. This includes document IDs, titles, and their deletion status, providing a complete overview of your document library. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + } + } + list_collections: { + groups: { + /** + * Collections (Selected Documents API) + */ + '0': () => LocalizedString + } + /** + * List Collections + */ + displayName: () => LocalizedString + /** + * Retrieve all collections + */ + shortDesc: () => LocalizedString + /** + * Get a list of all collections in your Craft workspace. You can optionally filter collections by specific documents using include or exclude modes. + */ + longDesc: () => LocalizedString + options: { + documentIds: { /** - * Field + * Document IDs */ displayName: () => LocalizedString /** - * Text field to search + * Filter collections by documents */ shortDesc: () => LocalizedString /** - * The text field to search within + * The document IDs to filter. If not provided, collections in all documents will be listed. */ longDesc: () => LocalizedString } - '1': { + documentFilterMode: { /** - * Terms + * Document Filter Mode */ displayName: () => LocalizedString /** - * Search terms + * How to filter by documents */ shortDesc: () => LocalizedString /** - * The search terms to look for within the field + * Choose whether to include or exclude collections based on the provided document IDs. Select "Include" to only show collections from the specified documents, or "Exclude" to hide collections from those documents. */ longDesc: () => LocalizedString } } } - 'starts-with': { + create_collection_item: { + groups: { + /** + * Collections (Selected Documents API) + */ + '0': () => LocalizedString + } /** - * starts with + * Create Collection Item */ displayName: () => LocalizedString /** - * Starts with text + * Add a new item to a collection */ shortDesc: () => LocalizedString /** - * Returns `True` if the field starts with the specified text + * Create a new item in a Craft collection with a title and optional custom properties. This allows you to programmatically add entries to your structured collections. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + collectionId: { /** - * Field + * Collection */ displayName: () => LocalizedString /** - * Text field to check + * The collection to add the item to */ shortDesc: () => LocalizedString /** - * The text field to check + * Select the Craft collection where you want to create the new item. The collection must exist before you can add items to it. */ longDesc: () => LocalizedString } - '1': { + title: { /** - * Text + * Title */ displayName: () => LocalizedString /** - * Starting text + * Title of the new collection item */ shortDesc: () => LocalizedString /** - * The text that the field should start with + * Provide a title for the new collection item. This is the main identifier for the item within the collection. + */ + longDesc: () => LocalizedString + } + properties: { + /** + * Properties + */ + displayName: () => LocalizedString + /** + * Custom properties for the item + */ + shortDesc: () => LocalizedString + /** + * Add custom properties to the collection item. The available properties are dynamically determined based on the schema of the selected collection. */ longDesc: () => LocalizedString } } } - 'ends-with': { + delete_collection_items: { + groups: { + /** + * Collections (Selected Documents API) + */ + '0': () => LocalizedString + } /** - * ends with + * Delete Collection Items */ displayName: () => LocalizedString /** - * Ends with text + * Remove items from a collection */ shortDesc: () => LocalizedString /** - * Returns `True` if the field ends with the specified text + * Delete one or more items from a Craft collection by providing their IDs. This action permanently removes the specified items from the collection. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + collectionId: { /** - * Field + * Collection */ displayName: () => LocalizedString /** - * Text field to check + * The collection containing the items */ shortDesc: () => LocalizedString /** - * The text field to check + * Select the Craft collection that contains the items you want to delete. */ longDesc: () => LocalizedString } - '1': { + itemIds: { /** - * Text + * Item IDs */ displayName: () => LocalizedString /** - * Ending text + * IDs of items to delete */ shortDesc: () => LocalizedString /** - * The text that the field should end with + * Provide a list of item IDs that you want to remove from the collection. You can select multiple items to delete in a single operation. */ longDesc: () => LocalizedString } } } - 'within-the-next': { + update_collection_item: { + groups: { + /** + * Collections (Selected Documents API) + */ + '0': () => LocalizedString + } /** - * within the next + * Update Collection Item */ displayName: () => LocalizedString /** - * Date is within the next N days + * Modify an existing collection item */ shortDesc: () => LocalizedString /** - * Returns `True` if the date field falls within the specified number of days in the future + * Update the title and properties of an existing item in a Craft collection. You can modify any custom properties that are part of the collection schema. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + collectionId: { /** - * Field + * Collection */ displayName: () => LocalizedString /** - * Date field to check + * The collection containing the item */ shortDesc: () => LocalizedString /** - * The date field to check + * Select the Craft collection that contains the item you want to update. */ longDesc: () => LocalizedString } - '1': { + itemId: { /** - * Days + * Item */ displayName: () => LocalizedString /** - * Number of days + * The item to update */ shortDesc: () => LocalizedString /** - * The number of days in the future to check + * Select the specific collection item you want to modify. The available items are dynamically populated based on the selected collection. + */ + longDesc: () => LocalizedString + } + title: { + /** + * Title + */ + displayName: () => LocalizedString + /** + * New title for the item + */ + shortDesc: () => LocalizedString + /** + * Provide a new title for the collection item. Leave empty to keep the existing title unchanged. + */ + longDesc: () => LocalizedString + } + properties: { + /** + * Properties + */ + displayName: () => LocalizedString + /** + * Updated properties for the item + */ + shortDesc: () => LocalizedString + /** + * Update the custom properties of the collection item. Only the properties you specify will be updated; others will remain unchanged. */ longDesc: () => LocalizedString } } } - 'within-the-last': { + list_collection_items: { + groups: { + /** + * Collections (Selected Documents API) + */ + '0': () => LocalizedString + } /** - * within the last + * List Collection Items */ displayName: () => LocalizedString /** - * Date is within the last N days + * Retrieve all items in a collection */ shortDesc: () => LocalizedString /** - * Returns `True` if the date field falls within the specified number of days in the past + * Get a list of all items in a specific Craft collection, including their IDs, titles, properties, and content blocks. You can control the depth of nested content retrieval. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + collectionId: { /** - * Field + * Collection */ displayName: () => LocalizedString /** - * Date field to check + * The collection to retrieve items from */ shortDesc: () => LocalizedString /** - * The date field to check + * Select the Craft collection whose items you want to list. All items in the collection will be returned. */ longDesc: () => LocalizedString } - '1': { + maxDepth: { /** - * Days + * Maximum Depth */ displayName: () => LocalizedString /** - * Number of days + * Maximum depth for nested content */ shortDesc: () => LocalizedString /** - * The number of days in the past to check + * The maximum depth of nested content to fetch for each collection item. Default is -1 (all descendants). With a depth of 0, only the item properties are fetched without nested content. */ longDesc: () => LocalizedString } } } - } - searchOptions: { - orderBy: { + list_blocks: { + groups: { + /** + * Blocks (Selected Documents API) + */ + '0': () => LocalizedString + } /** - * Order By + * List Blocks */ displayName: () => LocalizedString /** - * Sort results by a specific field + * Retrieve blocks from a document */ shortDesc: () => LocalizedString /** - * Define the field and direction to sort search results + * Fetch all blocks from a specific Craft document or page. This allows you to access the structured content of your documents, including nested blocks, with control over depth and metadata. */ longDesc: () => LocalizedString - type: { - fields: { - column: { - /** - * Column - */ - displayName: () => LocalizedString - /** - * The column to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the column to use for sorting results - */ - longDesc: () => LocalizedString - } - ascending: { - /** - * Ascending - */ - displayName: () => LocalizedString - /** - * Sort in ascending order - */ - shortDesc: () => LocalizedString - /** - * When enabled, results are sorted in ascending order (A-Z, 0-9) - */ - longDesc: () => LocalizedString - } + options: { + id: { + /** + * Document/Page ID + */ + displayName: () => LocalizedString + /** + * The document or page to retrieve blocks from + */ + shortDesc: () => LocalizedString + /** + * The ID of the page block to fetch. Required for multi-document operations. Accepts IDs for documents, pages and blocks. + */ + longDesc: () => LocalizedString + } + maxDepth: { + /** + * Maximum Depth + */ + displayName: () => LocalizedString + /** + * Maximum depth for nested blocks + */ + shortDesc: () => LocalizedString + /** + * Specify the maximum depth for retrieving nested blocks. Use -1 for unlimited depth, or provide a positive number to limit the nesting level. + */ + longDesc: () => LocalizedString + } + fetchMetadata: { + /** + * Fetch Metadata + */ + displayName: () => LocalizedString + /** + * Include metadata in the response + */ + shortDesc: () => LocalizedString + /** + * Whether to fetch metadata (comments, createdBy, lastModifiedBy, lastModifiedAt, createdAt) for the blocks. + */ + longDesc: () => LocalizedString + } + getMarkdownString: { + /** + * Get Markdown String + */ + displayName: () => LocalizedString + /** + * Retrieve the markdown string representation of blocks + */ + shortDesc: () => LocalizedString + /** + * Whether to retrieve the markdown string representation of the blocks. + */ + longDesc: () => LocalizedString } } } - group_id: { - /** - * Group - */ - displayName: () => LocalizedString - /** - * The group to filter items by - */ - shortDesc: () => LocalizedString - /** - * Select a group within the board to filter items - */ - longDesc: () => LocalizedString - } - } - createOptions: { - group_id: { + insert_block: { + groups: { + /** + * Blocks (Selected Documents API) + */ + '0': () => LocalizedString + } /** - * Group + * Insert Block */ displayName: () => LocalizedString /** - * The group to create the item in + * Add a new block to a document */ shortDesc: () => LocalizedString /** - * Select a group within the board where the new item will be created + * Insert a new block with markdown content into a Craft document. You can specify whether to insert the block at the start or end of the target page. */ longDesc: () => LocalizedString + options: { + markdown: { + /** + * Markdown Content + */ + displayName: () => LocalizedString + /** + * The markdown content for the block + */ + shortDesc: () => LocalizedString + /** + * + The Markdown content to insert. Separate each paragraph and heading with two newlines. Separate each list item with one newline. The first item in any list cannot be empty. Craft-specific tokens are HTML tags.: + + + + - for callouts. Can be used to wrap multiple paragraphs/images/etc. + + - for caption text style. Can be used to wrap a paragraph. + + - for highlights - color is optional. Can only be used inline. + + */ + longDesc: () => LocalizedString + } + position: { + /** + * Position + */ + displayName: () => LocalizedString + /** + * Where to insert the block + */ + shortDesc: () => LocalizedString + /** + * Specify the position where the block should be inserted within the document. + */ + longDesc: () => LocalizedString + type: { + fields: { + position: { + /** + * Insert Position + */ + displayName: () => LocalizedString + /** + * Insert at start or end + */ + shortDesc: () => LocalizedString + /** + * Choose whether to insert the block at the start or end of the target page. + */ + longDesc: () => LocalizedString + } + pageId: { + /** + * Page ID + */ + displayName: () => LocalizedString + /** + * The page to insert into + */ + shortDesc: () => LocalizedString + /** + * ID of the block to insert children into. Required for multi-document operations. Only page, text, and card type blocks can be parent blocks. Text blocks are auto-converted to page type when they receive children. Collection items are implicitly pages. + */ + longDesc: () => LocalizedString + } + } + } + } + } } - } - } - ZohoCRM: { - /** - * Zoho CRM - */ - displayName: () => LocalizedString - groups: { - /** - * CRM & Sales Management - */ - '0': () => LocalizedString - } - /** - * Connect to Zoho CRM to automate customer relationship management across all global data centers. - */ - shortDesc: () => LocalizedString - /** - * The Zoho CRM integration provides comprehensive actions and triggers to interact with the Zoho CRM API across all seven global data centers (US, AU, EU, IN, CN, JP, CA). Manage modules, records, users, and roles efficiently while automating your CRM workflows with support for custom modules, bulk operations, and real-time triggers. - */ - longDesc: () => LocalizedString - expressions: { - '&&': { + delete_blocks: { + groups: { + /** + * Blocks (Selected Documents API) + */ + '0': () => LocalizedString + } /** - * and (&&) + * Delete Blocks */ displayName: () => LocalizedString /** - * Returns True if all arguments are True + * Remove blocks from a document */ shortDesc: () => LocalizedString /** - * Returns `True` if all arguments are `True` with logic short-circuiting + * Delete one or more blocks from a Craft document by providing their block IDs. This action permanently removes the specified blocks. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + blockIds: { /** - * Condition + * Block IDs */ displayName: () => LocalizedString /** - * Boolean condition to evaluate + * IDs of blocks to delete */ shortDesc: () => LocalizedString /** - * A boolean expression or condition that evaluates to True or False + * Provide a list of block IDs that you want to remove from the document. You can delete multiple blocks in a single operation. */ longDesc: () => LocalizedString } } } - '||': { + list_tasks: { + groups: { + /** + * Tasks (Daily Tasks & Notes API) + */ + '0': () => LocalizedString + } /** - * or (||) + * List Tasks */ displayName: () => LocalizedString /** - * Returns True if any argument is True + * Retrieve tasks based on scope */ shortDesc: () => LocalizedString /** - * Returns `True` if any argument is `True` with logic short-circuiting + * Get a list of tasks from your Craft workspace filtered by scope. You can retrieve active tasks, upcoming tasks, inbox tasks, or tasks from your logbook. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + scope: { /** - * Condition + * Scope */ displayName: () => LocalizedString /** - * Boolean condition to evaluate + * Filter tasks by scope */ shortDesc: () => LocalizedString /** - * A boolean expression or condition that evaluates to True or False + * Filter tasks by scope: - 'active': Active tasks from inbox and other documents (tasks due before now that are not completed/cancelled) - 'upcoming': Upcoming tasks from inbox and other documents (tasks scheduled after now) - 'inbox': Only tasks in the task inbox - 'logbook': Only tasks in the task logbook (completed and cancelled tasks) */ longDesc: () => LocalizedString } } } - '==': { + create_task: { + groups: { + /** + * Tasks (Daily Tasks & Notes API) + */ + '0': () => LocalizedString + } /** - * equal (==) + * Create Task */ displayName: () => LocalizedString /** - * Equality comparison + * Add a new task */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value equals the specified value + * Create a new task in Craft with markdown content, optional task information (state, schedule, deadline), and a location (inbox or daily note). */ longDesc: () => LocalizedString - args: { - '0': { + options: { + markdown: { /** - * Field + * Task Content */ displayName: () => LocalizedString /** - * Field to compare + * The markdown content for the task */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * The task content in markdown format. This will be the task's text. */ longDesc: () => LocalizedString } - '1': { + taskInfo: { /** - * Value + * Task Information */ displayName: () => LocalizedString /** - * Value to compare against + * Additional task details */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Optional task metadata including state, schedule date, and deadline date + */ + longDesc: () => LocalizedString + type: { + fields: { + state: { + /** + * State + */ + displayName: () => LocalizedString + /** + * Current state of the task + */ + shortDesc: () => LocalizedString + /** + * Set the initial state of the task: To Do (pending), Done (completed), or Canceled (abandoned). + */ + longDesc: () => LocalizedString + } + scheduleDate: { + /** + * Schedule Date + */ + displayName: () => LocalizedString + /** + * When the task is scheduled + */ + shortDesc: () => LocalizedString + /** + * Planned execution date of the task. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday' + */ + longDesc: () => LocalizedString + } + deadlineDate: { + /** + * Deadline Date + */ + displayName: () => LocalizedString + /** + * When the task is due + */ + shortDesc: () => LocalizedString + /** + * Due date of the task. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday' + */ + longDesc: () => LocalizedString + } + } + } + } + location: { + /** + * Location + */ + displayName: () => LocalizedString + /** + * Where to create the task + */ + shortDesc: () => LocalizedString + /** + * Where to create the task: in the task inbox or a specific daily note */ longDesc: () => LocalizedString + type: { + fields: { + type: { + /** + * Location Type + */ + displayName: () => LocalizedString + /** + * Type of location + */ + shortDesc: () => LocalizedString + /** + * Choose whether to create the task in your inbox (for unscheduled tasks) or in a daily note (for a specific date). + */ + longDesc: () => LocalizedString + } + date: { + /** + * Date + */ + displayName: () => LocalizedString + /** + * Date for daily note + */ + shortDesc: () => LocalizedString + /** + * The daily note date where the task is located. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday'. Defaults to 'today' if not provided. + */ + longDesc: () => LocalizedString + } + } + } } } } - '!=': { + update_task: { + groups: { + /** + * Tasks (Daily Tasks & Notes API) + */ + '0': () => LocalizedString + } /** - * not equal (!=) + * Update Task */ displayName: () => LocalizedString /** - * Inequality comparison + * Modify an existing task */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value does not equal the specified value + * Update an existing task in Craft by changing its markdown content, state, schedule date, or deadline date. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + id: { /** - * Field + * Task */ displayName: () => LocalizedString /** - * Field to compare + * The task to update */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Select the task you want to modify. Only active tasks are available for selection. */ longDesc: () => LocalizedString } - '1': { + markdown: { /** - * Value + * Task Content */ displayName: () => LocalizedString /** - * Value to compare against + * Updated markdown content */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Provide new markdown-formatted content for the task. Leave empty to keep the existing content. */ longDesc: () => LocalizedString } - } - } - '>': { - /** - * greater than (>) - */ - displayName: () => LocalizedString - /** - * Greater than comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is greater than the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + state: { /** - * Field + * State */ displayName: () => LocalizedString /** - * Field to compare + * Updated task state */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Change the state of the task to To Do, Done, or Canceled. Leave empty to keep the current state. */ longDesc: () => LocalizedString } - '1': { + scheduleDate: { /** - * Value + * Schedule Date */ displayName: () => LocalizedString /** - * Value to compare against + * Updated schedule date */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Updated planned execution date. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday'. Leave empty to keep the existing schedule. + */ + longDesc: () => LocalizedString + } + deadlineDate: { + /** + * Deadline Date + */ + displayName: () => LocalizedString + /** + * Updated deadline date + */ + shortDesc: () => LocalizedString + /** + * Updated due date of the task. Accepts ISO format YYYY-MM-DD or relative dates: 'today', 'tomorrow', 'yesterday'. Leave empty to keep the existing deadline. */ longDesc: () => LocalizedString } } } - '>=': { + delete_tasks: { + groups: { + /** + * Tasks (Daily Tasks & Notes API) + */ + '0': () => LocalizedString + } /** - * greater than or equal (>=) + * Delete Tasks */ displayName: () => LocalizedString /** - * Greater than or equal comparison + * Remove tasks */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is greater than or equal to the specified value + * Delete one or more tasks from your Craft workspace by providing their task IDs. This action permanently removes the specified tasks. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { + options: { + ids: { /** - * Value + * Task IDs */ displayName: () => LocalizedString /** - * Value to compare against + * IDs of tasks to delete */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Provide a list of task IDs that you want to remove. You can delete multiple tasks in a single operation. */ longDesc: () => LocalizedString } } } - '<': { + } + } + Monday: { + /** + * Monday.com + */ + displayName: () => LocalizedString + groups: { + /** + * Project & Task Management + */ + '0': () => LocalizedString + } + /** + * Connect to Monday.com to automate work management with boards, items, columns, and updates. + */ + shortDesc: () => LocalizedString + /** + * The Monday.com integration provides comprehensive access to your work operating system. Create and manage boards, items, groups, and columns. Track work progress, update item statuses, manage column values, and monitor board changes. Automate workflows by creating items, updating records, moving items between groups, and receiving notifications when boards or items are modified. Perfect for project management, task tracking, team collaboration, and workflow automation across your organization. + */ + longDesc: () => LocalizedString + actions: { + archive_record: { /** - * less than (<) + * Archive Record */ displayName: () => LocalizedString /** - * Less than comparison + * Move a record to the archive. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is less than the specified value + * This action allows you to archive a specific record (item) on a Monday.com board, helping you keep your workspace organized by removing completed or inactive items from view without permanently deleting them. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + board_id: { /** - * Field + * Board ID */ displayName: () => LocalizedString /** - * Field to compare + * The ID of the board containing the record to archive. */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * The unique identifier of the board containing the record you want to archive. */ longDesc: () => LocalizedString } - '1': { + record_id: { /** - * Value + * Record ID */ displayName: () => LocalizedString /** - * Value to compare against + * The ID of the record to archive. */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * The unique identifier of the record you want to archive. */ longDesc: () => LocalizedString } } } - '<=': { + clear_column_value: { /** - * less than or equal (<=) + * Clear Column Value */ displayName: () => LocalizedString /** - * Less than or equal comparison + * Remove data from a column in a record. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is less than or equal to the specified value + * Use this action to clear the content of a specified column within a record, resetting its value to empty. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + board_id: { /** - * Field + * Board ID */ displayName: () => LocalizedString /** - * Field to compare + * The ID of the board containing the record. */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * The unique identifier of the board containing the record you want to modify. */ longDesc: () => LocalizedString } - '1': { + record_id: { /** - * Value + * Record ID */ displayName: () => LocalizedString /** - * Value to compare against + * The ID of the record to modify. */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * The unique identifier of the record you want to modify. + */ + longDesc: () => LocalizedString + } + column_id: { + /** + * Column ID + */ + displayName: () => LocalizedString + /** + * The ID of the column to clear. + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the column you want to clear. */ longDesc: () => LocalizedString } } } - like: { + create_record: { /** - * like + * Create Record */ displayName: () => LocalizedString /** - * Contains text pattern + * Add a new record to a board. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value contains the specified text pattern + * This action enables you to create a new record (item) in a specified board, allowing you to define initial column values upon creation. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + board_id: { /** - * Field + * Board ID */ displayName: () => LocalizedString /** - * Text field to search + * The ID of the board where the record will be created. */ shortDesc: () => LocalizedString /** - * The text field to search within + * The unique identifier of the board where you want to create a new record. */ longDesc: () => LocalizedString } - '1': { + group_id: { /** - * Pattern + * Group ID */ displayName: () => LocalizedString /** - * Text pattern to search for + * The ID of the group where the record will be created. */ shortDesc: () => LocalizedString /** - * The text pattern to search for within the field + * The unique identifier of the group where you want to create a new record. + */ + longDesc: () => LocalizedString + } + item_name: { + /** + * Item Name + */ + displayName: () => LocalizedString + /** + * The name of the new record. + */ + shortDesc: () => LocalizedString + /** + * The name of the new record you want to create. + */ + longDesc: () => LocalizedString + } + column_values: { + /** + * Column Values + */ + displayName: () => LocalizedString + /** + * The values to set for the record columns. + */ + shortDesc: () => LocalizedString + /** + * The values to set for the columns of the record you want to create. */ longDesc: () => LocalizedString } } } - 'not-like': { + custom_action: { /** - * not like + * Custom Action */ displayName: () => LocalizedString /** - * Does not contain text pattern + * Perform a user-defined operation. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value does not contain the specified text pattern + * This action allows you to execute a custom operation defined by your integration or automation setup, providing flexibility for various tasks. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + payload: { /** - * Field + * Payload */ displayName: () => LocalizedString /** - * Text field to search + * Payload for your custom action */ shortDesc: () => LocalizedString /** - * The text field to search within + * The payload for your custom action */ longDesc: () => LocalizedString } - '1': { + actionName: { /** - * Pattern + * Action Name */ displayName: () => LocalizedString /** - * Text pattern to exclude + * The name of the custom action to execute */ shortDesc: () => LocalizedString /** - * The text pattern that should not be present in the field + * The name of the custom action to execute */ longDesc: () => LocalizedString } } } - 'in': { + delete_record: { /** - * in + * Delete Record */ displayName: () => LocalizedString /** - * Value is in list + * Permanently remove a record. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value matches any value in the provided list + * Use this action to permanently delete a specific record from a board, removing all associated data. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + board_id: { /** - * Field + * Board ID */ displayName: () => LocalizedString /** - * Field to check + * The ID of the board containing the record to delete. */ shortDesc: () => LocalizedString /** - * The field whose value will be checked + * The unique identifier of the board containing the record you want to delete. */ longDesc: () => LocalizedString } - '1': { + record_id: { /** - * Values + * Record ID */ displayName: () => LocalizedString /** - * List of values to match + * The ID of the record to delete. */ shortDesc: () => LocalizedString /** - * List of values to compare against + * The unique identifier of the record you want to delete. */ longDesc: () => LocalizedString } } } - 'not-in': { + get_record: { /** - * not in + * Get Record */ displayName: () => LocalizedString /** - * Value is not in list + * Retrieve details of a specific record. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value does not match any value in the provided list + * This action fetches the details of a specified record, including all column values and associated metadata. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + board_id: { /** - * Field + * Board ID */ displayName: () => LocalizedString /** - * Field to check + * The ID of the board containing the record to get. */ shortDesc: () => LocalizedString /** - * The field whose value will be checked + * The unique identifier of the board containing the record you want to get. */ longDesc: () => LocalizedString } - '1': { + record_id: { /** - * Values + * Record ID */ displayName: () => LocalizedString /** - * List of values to exclude + * The ID of the record to get. */ shortDesc: () => LocalizedString /** - * List of values that should not match + * The unique identifier of the record you want to get. */ longDesc: () => LocalizedString } } } - between: { + move_record: { /** - * between + * Move Record */ displayName: () => LocalizedString /** - * Value is between two values + * Transfer a record to another group or board. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is between two specified values (inclusive) + * Use this action to move a record from its current group or board to another specified group or board, maintaining its data and history. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + board_id: { /** - * Field + * Board ID */ displayName: () => LocalizedString /** - * Field to check + * The ID of the board containing the record to move. */ shortDesc: () => LocalizedString /** - * The field whose value will be checked + * The unique identifier of the board containing the record you want to move. */ longDesc: () => LocalizedString } - '1': { + record_id: { /** - * Lower bound + * Record ID */ displayName: () => LocalizedString /** - * Minimum value + * The ID of the record to move. */ shortDesc: () => LocalizedString /** - * The minimum value (inclusive) + * The unique identifier of the record you want to move. */ longDesc: () => LocalizedString } - '2': { + destination_group_id: { /** - * Upper bound + * Destination Group ID */ displayName: () => LocalizedString /** - * Maximum value + * The ID of the group to move the record to. */ shortDesc: () => LocalizedString /** - * The maximum value (inclusive) + * The unique identifier of the group you want to move the record to. */ longDesc: () => LocalizedString } } } - 'not-between': { + search_records: { /** - * not between + * Search Records */ displayName: () => LocalizedString /** - * Value is not between two values + * Find records matching specific criteria. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is not between two specified values + * This action allows you to search for records that meet defined criteria, such as specific column values or statuses, and returns a list of matching records. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + board_id: { /** - * Field + * Board ID */ displayName: () => LocalizedString /** - * Field to check + * The ID of the board to search for records in. */ shortDesc: () => LocalizedString /** - * The field whose value will be checked + * The unique identifier of the board containing the records you want to search for. */ longDesc: () => LocalizedString } - '1': { + query_text: { /** - * Lower bound + * Query */ displayName: () => LocalizedString /** - * Minimum value to exclude + * The search query to use. */ shortDesc: () => LocalizedString /** - * The lower boundary for exclusion + * The search query to use to find records. */ longDesc: () => LocalizedString } - '2': { + columnId: { /** - * Upper bound + * Column ID */ displayName: () => LocalizedString /** - * Maximum value to exclude + * The ID of the column to search in. */ shortDesc: () => LocalizedString /** - * The upper boundary for exclusion + * The unique identifier of the column to search in. */ longDesc: () => LocalizedString } - } - } - 'is-null': { - /** - * is null - */ - displayName: () => LocalizedString - /** - * Field is null - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is null or empty - */ - longDesc: () => LocalizedString - args: { - '0': { + limit: { /** - * Field + * Limit */ displayName: () => LocalizedString /** - * Field to check + * The maximum number of records to return. */ shortDesc: () => LocalizedString /** - * The field to check for null value + * The maximum number of records to return. */ longDesc: () => LocalizedString } - } - } - 'is-not-null': { - /** - * is not null - */ - displayName: () => LocalizedString - /** - * Field is not null - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is not null or empty - */ - longDesc: () => LocalizedString - args: { - '0': { + cursor: { /** - * Field + * Cursor */ displayName: () => LocalizedString /** - * Field to check + * The cursor to use for pagination. */ shortDesc: () => LocalizedString /** - * The field to check for non-null value + * The cursor to use for pagination. */ longDesc: () => LocalizedString } } } - } - triggers: { - new_record: { + update_record: { /** - * New Record + * Update Record */ displayName: () => LocalizedString /** - * Triggers when a new record is created in a Zoho CRM module + * Modify the values of a record's columns. */ shortDesc: () => LocalizedString /** - * Monitors a specified Zoho CRM module for newly created records and fires when a new record is detected. The trigger polls for records sorted by Created Time in descending order. You can optionally filter records by phone, email, keywords, or specific field values to only trigger for records matching your criteria. + * Use this action to update one or more column values of a specific record, allowing you to change its data as needed. */ longDesc: () => LocalizedString options: { - module: { + board_id: { /** - * Module + * Board ID */ displayName: () => LocalizedString /** - * The Zoho CRM module to monitor for new records + * The ID of the board containing the record to update. */ shortDesc: () => LocalizedString /** - * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) where you want to monitor for newly created records. Use the module API name as returned by the Modules Metadata API. + * The unique identifier of the board containing the record you want to update. */ longDesc: () => LocalizedString } - phone: { + record_id: { /** - * Phone Filter + * Record ID */ displayName: () => LocalizedString /** - * Filter records by phone number + * The ID of the record to update. */ shortDesc: () => LocalizedString /** - * Optional phone number to search for in records. When specified, only records containing this phone number will trigger the event. This uses the Zoho CRM search API to find matching records. + * The unique identifier of the record you want to update. */ longDesc: () => LocalizedString } - email: { + column_values: { /** - * Email Filter + * Column Values */ displayName: () => LocalizedString /** - * Filter records by email address + * The values to set for the record columns. */ shortDesc: () => LocalizedString /** - * Optional email address to search for in records. When specified, only records containing this email address will trigger the event. This uses the Zoho CRM search API to find matching records. + * The values to set for the columns of the record you want to update. */ longDesc: () => LocalizedString } - word: { + } + } + } + triggers: { + new_record: { + /** + * New Record + */ + displayName: () => LocalizedString + /** + * Triggered when a new item is created. + */ + shortDesc: () => LocalizedString + /** + * Triggered when a new record is created. + */ + longDesc: () => LocalizedString + options: { + board_id: { /** - * Keyword Search + * Board ID */ displayName: () => LocalizedString /** - * Filter records by keyword + * The ID of the board to check for new records. */ shortDesc: () => LocalizedString /** - * Optional keyword to search for across all searchable fields in records. When specified, only records containing this keyword will trigger the event. This uses the Zoho CRM search API to perform a comprehensive text search. + * The unique identifier of the board that should be checked for new records. */ longDesc: () => LocalizedString } - field_filter: { + group_id: { /** - * Field Filters + * Group ID */ displayName: () => LocalizedString /** - * Filter records by specific field values + * The ID of the group to check for new records. */ shortDesc: () => LocalizedString /** - * Optional list of field-value pairs to create search criteria. When specified, only records where ALL specified fields match their corresponding values will trigger the event. Uses the "equals" operator for each field comparison. + * The unique identifier of the group you want to check for new records in. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - field: { - /** - * Field Name - */ - displayName: () => LocalizedString - /** - * The API name of the field to filter on - */ - shortDesc: () => LocalizedString - /** - * Select or enter the field API name from the module. Available field names can be retrieved using the Fields Metadata API. The field must be searchable to be used in filtering. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Field Value - */ - displayName: () => LocalizedString - /** - * The value that the field must equal - */ - shortDesc: () => LocalizedString - /** - * Enter the exact value that the field must equal for the record to match. The comparison uses the "equals" operator, so the field value must match this value exactly. - */ - longDesc: () => LocalizedString - } - } - } - } } } } - } - actions: { - create_record: { + new_record_moved_to_group: { /** - * Create Record + * New Record Moved To Group */ displayName: () => LocalizedString /** - * Create a new record in a Zoho CRM module + * Triggered when an item was moved to a group. */ shortDesc: () => LocalizedString /** - * Creates a new record in the specified Zoho CRM module with the provided field values. Returns the record ID along with timestamps for creation and modification. The Created_By and Modified_By fields contain the user information who created the record. Supports all standard and custom modules except Documents and Projects. + * Triggered when a new record is created. */ longDesc: () => LocalizedString options: { - module: { + board_id: { /** - * Module + * Board ID */ displayName: () => LocalizedString /** - * The Zoho CRM module where the record will be created + * The ID of the board to check for new records. */ shortDesc: () => LocalizedString /** - * Select the target Zoho CRM module (such as Leads, Contacts, Deals, Accounts, Products, Vendors, or custom modules) where you want to create the new record. Use the Modules API to get the list of available modules and their API names. + * The unique identifier of the board that should be checked for new records. */ longDesc: () => LocalizedString } - properties: { + group_id: { /** - * Record Properties + * Group ID */ displayName: () => LocalizedString /** - * Field values for the new record + * The ID of the group to check for new records. */ shortDesc: () => LocalizedString /** - * Provide the field values for the new record as key-value pairs where keys are field API names. Available fields and their types are dynamically loaded based on the selected module. Required fields must be included, and field values must match their expected data types (text, number, date, picklist, lookup, etc.). + * The unique identifier of the group you want to check for new records in. */ longDesc: () => LocalizedString } } } - update_record: { + record_column_value_updated: { /** - * Update Record + * Record Column Value Updated */ displayName: () => LocalizedString /** - * Update an existing record in a Zoho CRM module + * Triggered when a record column value is updated. */ shortDesc: () => LocalizedString /** - * Updates an existing record in the specified Zoho CRM module with the provided field values. Returns the record ID along with updated timestamps for modification. Only the fields you specify will be updated; other fields will remain unchanged. The record must exist and the user must have update permissions for the module. + * Triggered when a record column value is updated. */ longDesc: () => LocalizedString options: { - module: { - /** - * Module - */ - displayName: () => LocalizedString - /** - * The Zoho CRM module containing the record - */ - shortDesc: () => LocalizedString - /** - * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) that contains the record you want to update. The module must support API operations and the user must have appropriate permissions. - */ - longDesc: () => LocalizedString - } - record_id: { + board_id: { /** - * Record ID + * Board ID */ displayName: () => LocalizedString /** - * The unique identifier of the record to update + * The ID of the board to check for record field updates. */ shortDesc: () => LocalizedString /** - * Enter or select the unique record ID of the record you want to update. Record IDs can be retrieved using the Get Records API or from webhook notifications. The record must exist in the specified module. + * The unique identifier of the board that should be checked for record field updates. */ longDesc: () => LocalizedString } - properties: { + column_id: { /** - * Updated Properties + * Column ID */ displayName: () => LocalizedString /** - * Field values to update on the record + * The ID of the column to check for new value. */ shortDesc: () => LocalizedString /** - * Provide the field values you want to update as key-value pairs where keys are field API names. Only include the fields you want to change; unspecified fields will retain their current values. Field values must match their expected data types and validation rules. + * The unique identifier of the column that should be checked for new value. */ longDesc: () => LocalizedString } } } - delete_record: { + updated_record: { /** - * Delete Record + * Updated Record */ displayName: () => LocalizedString /** - * Delete a record from a Zoho CRM module + * Triggered when an item is updated. */ shortDesc: () => LocalizedString /** - * Permanently deletes a specific record from the specified Zoho CRM module using its unique record ID. If the module has the Recycle Bin feature enabled, the deleted record will be moved to the Recycle Bin and can be restored. Otherwise, the deletion is permanent. The user must have delete permissions for the module. + * Triggered when an item on the board is updated. */ longDesc: () => LocalizedString options: { - module: { + board_id: { /** - * Module + * Board ID */ displayName: () => LocalizedString /** - * The Zoho CRM module containing the record + * The ID of the board to check for updated records. */ shortDesc: () => LocalizedString /** - * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) that contains the record you want to delete. The module must support API operations and the user must have delete permissions. + * The unique identifier of the board that should be checked for updated records. */ longDesc: () => LocalizedString } - record_id: { + group_id: { /** - * Record ID + * Group ID */ displayName: () => LocalizedString /** - * The unique identifier of the record to delete + * The ID of the group to check for new records. */ shortDesc: () => LocalizedString /** - * Enter or select the unique record ID of the record you want to delete. Record IDs can be retrieved using the Get Records API. Deleting a record that has already been deleted will result in an error. + * The unique identifier of the group you want to check for new records in. */ longDesc: () => LocalizedString } } } - get_record: { + } + expressions: { + '&&': { /** - * Get Record + * and (&&) */ displayName: () => LocalizedString /** - * Retrieve a single record from a Zoho CRM module + * Returns True if all arguments are True */ shortDesc: () => LocalizedString /** - * Fetches detailed information about a specific record from the specified Zoho CRM module using its unique record ID. Returns all field values for the record including standard fields (Created_Time, Modified_Time, Created_By, Modified_By) and custom fields. Subform data, multi-select lookup fields, and multi-user lookup fields are also included in the response. + * Returns `True` if all arguments are `True` with logic short-circuiting */ longDesc: () => LocalizedString - options: { - module: { + args: { + '0': { /** - * Module + * Condition */ displayName: () => LocalizedString /** - * The Zoho CRM module containing the record + * Boolean condition to evaluate */ shortDesc: () => LocalizedString /** - * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) that contains the record you want to retrieve. The module must support API operations and the user must have read permissions. + * A boolean expression or condition that evaluates to True or False */ longDesc: () => LocalizedString } - record_id: { - /** - * Record ID + } + } + '||': { + /** + * or (||) + */ + displayName: () => LocalizedString + /** + * Returns True if any argument is True + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if any argument is `True` with logic short-circuiting + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Condition */ displayName: () => LocalizedString /** - * The unique identifier of the record to retrieve + * Boolean condition to evaluate */ shortDesc: () => LocalizedString /** - * Enter or select the unique record ID of the record you want to fetch. Record IDs can be obtained from the Get Records API, search results, or webhook notifications. The record must exist in the specified module. + * A boolean expression or condition that evaluates to True or False */ longDesc: () => LocalizedString } } } - list_records: { + '==': { /** - * List Records + * equal (==) */ displayName: () => LocalizedString /** - * Retrieve multiple records from a Zoho CRM module + * Equality comparison */ shortDesc: () => LocalizedString /** - * Fetches a list of records from the specified Zoho CRM module with support for field selection, pagination, sorting, and filtering. You can specify which fields to return (maximum 50 field API names), sort records by a field in ascending or descending order, and navigate through pages using tokens. Returns both the records data and pagination tokens for retrieving subsequent pages. + * Returns `True` if the field value equals the specified value */ longDesc: () => LocalizedString - options: { - module: { + args: { + '0': { /** - * Module + * Field */ displayName: () => LocalizedString /** - * The Zoho CRM module to retrieve records from + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) from which you want to retrieve records. The module must support API operations and the user must have read permissions. + * The field whose value will be compared */ longDesc: () => LocalizedString } - fields: { + '1': { /** - * Fields to Return + * Value */ displayName: () => LocalizedString /** - * Specify which fields to include in the response + * Value to compare against */ shortDesc: () => LocalizedString /** - * Select the field API names you want to retrieve for each record. You can include a maximum of 50 field API names. Use the Fields Metadata API to get the list of available fields. By default, only the ID field is returned. Add fields like Last_Name, Email, Created_Time, or custom field names as needed. + * The value to compare the field against */ longDesc: () => LocalizedString } - per_page: { + } + } + '!=': { + /** + * not equal (!=) + */ + displayName: () => LocalizedString + /** + * Inequality comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value does not equal the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Records Per Page + * Field */ displayName: () => LocalizedString /** - * Number of records to return per page + * Field to compare */ shortDesc: () => LocalizedString /** - * Specify how many records to return in a single API request. Valid values are 1 to 200. The default value is 20. Use this parameter along with page_token for pagination through large result sets. + * The field whose value will be compared */ longDesc: () => LocalizedString } - page_token: { + '1': { /** - * Page Token + * Value */ displayName: () => LocalizedString /** - * Token for retrieving the next page of results + * Value to compare against */ shortDesc: () => LocalizedString /** - * Use the next_page_token value from a previous response to retrieve the next page of records. Leave this empty for the first page. The page_token is bound to the parameters used in the request, so do not change other parameters when using a token. + * The value to compare the field against */ longDesc: () => LocalizedString } - ids: { + } + } + '>': { + /** + * higher than (>) + */ + displayName: () => LocalizedString + /** + * Greater than comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is greater than the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Record IDs + * Field */ displayName: () => LocalizedString /** - * Filter by specific record IDs + * Field to compare */ shortDesc: () => LocalizedString /** - * Optional list of specific record IDs to retrieve. When provided, only records with these IDs will be returned. This is useful for fetching a specific set of records rather than paginating through all records. + * The field whose value will be compared */ longDesc: () => LocalizedString } - sort: { + '1': { /** - * Sort Configuration + * Value */ displayName: () => LocalizedString /** - * Configure how to sort the returned records + * Value to compare against */ shortDesc: () => LocalizedString /** - * Specify how records should be sorted in the response. You can sort by fields like id, Created_Time, or Modified_Time in either ascending (oldest first) or descending (newest first) order. + * The value to compare the field against */ longDesc: () => LocalizedString - type: { - fields: { - sort_by: { - /** - * Sort By Field - */ - displayName: () => LocalizedString - /** - * The field to use for sorting records - */ - shortDesc: () => LocalizedString - /** - * Select or enter the field API name to sort records by. Common options include id, Created_Time, and Modified_Time. You can also use custom field API names that support sorting. - */ - longDesc: () => LocalizedString - } - order: { - /** - * Sort Order - */ - displayName: () => LocalizedString - /** - * Sort in ascending or descending order - */ - shortDesc: () => LocalizedString - /** - * Choose whether to sort records in ascending order (asc - oldest first) or descending order (desc - newest first). The default value is descending. - */ - longDesc: () => LocalizedString - } - } - } } } } - list_modules: { + '>=': { /** - * List Modules + * higher than or equal (>=) */ displayName: () => LocalizedString /** - * Retrieve all available modules in Zoho CRM + * Greater than or equal comparison */ shortDesc: () => LocalizedString /** - * Fetches metadata for all modules in your Zoho CRM organization, including both standard modules (Leads, Contacts, Deals, Accounts, etc.) and custom modules. Returns comprehensive details including module permissions, API names, display labels, and capabilities like whether the module is creatable, editable, deletable, or supports features like global search and quick create. + * Returns `True` if the field value is greater than or equal to the specified value */ longDesc: () => LocalizedString - options: { - status: { + args: { + '0': { /** - * Module Status Filter + * Field */ displayName: () => LocalizedString /** - * Filter modules by their status + * Field to compare */ shortDesc: () => LocalizedString /** - * Optional filter to retrieve only modules with specific statuses. Options include: visible (active modules shown in the UI), user_hidden (modules hidden by users), system_hidden (modules hidden by the system), and scheduled_for_deletion (modules marked for deletion). When not specified, all modules are returned. + * The field whose value will be compared */ longDesc: () => LocalizedString } - } - } - list_fields: { - /** - * List Module Fields - */ - displayName: () => LocalizedString - /** - * Retrieve field metadata for a Zoho CRM module - */ - shortDesc: () => LocalizedString - /** - * Fetches comprehensive metadata about all fields in a specific Zoho CRM module including field types, labels, API names, data types, validation rules, picklist values, lookup configurations, and permissions. This information is essential for understanding module structure, building dynamic forms, or validating data before creating or updating records. - */ - longDesc: () => LocalizedString - options: { - module: { + '1': { /** - * Module + * Value */ displayName: () => LocalizedString /** - * The Zoho CRM module to retrieve fields from + * Value to compare against */ shortDesc: () => LocalizedString /** - * Select the Zoho CRM module whose field metadata you want to retrieve. The API returns detailed information about all fields including standard fields (system-defined) and custom fields (user-defined) in the module. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - list_users: { + '<': { /** - * List Users + * lower than (<) */ displayName: () => LocalizedString /** - * Retrieve users from your Zoho CRM organization + * Less than comparison */ shortDesc: () => LocalizedString /** - * Fetches a list of users in your Zoho CRM organization with support for pagination and filtering by user type. Returns comprehensive user information including name, email, role, profile, timezone, locale settings, customization preferences, and account status. Use the type parameter to filter users based on their profile and status. + * Returns `True` if the field value is less than the specified value */ longDesc: () => LocalizedString - options: { - per_page: { - /** - * Users Per Page - */ - displayName: () => LocalizedString - /** - * Number of users to return per page - */ - shortDesc: () => LocalizedString - /** - * Specify how many users to return in a single API request. Valid values are 1 to 200. The default value is 20. Use this parameter along with the page parameter for pagination through large result sets. - */ - longDesc: () => LocalizedString - } - page: { + args: { + '0': { /** - * Page Number + * Field */ displayName: () => LocalizedString /** - * The page number for pagination + * Field to compare */ shortDesc: () => LocalizedString /** - * Specify which page of results to retrieve, starting from 1 for the first page. Use this parameter along with per_page to navigate through multiple pages of user data. + * The field whose value will be compared */ longDesc: () => LocalizedString } - type: { + '1': { /** - * User Type Filter + * Value */ displayName: () => LocalizedString /** - * Filter users by type or status + * Value to compare against */ shortDesc: () => LocalizedString /** - * Optional filter to retrieve specific categories of users. Options include: AllUsers (both active and inactive), ActiveUsers (only active users), DeactiveUsers (deactivated users), ConfirmedUsers (users who confirmed their accounts), NotConfirmedUsers (unconfirmed users), DeletedUsers (deleted users), ActiveConfirmedUsers (active and confirmed), AdminUsers (users with Administrator privileges), ActiveConfirmedAdmins (active confirmed administrators), and CurrentUser (the currently authenticated CRM user). + * The value to compare the field against */ longDesc: () => LocalizedString } } } - list_tags: { + '<=': { /** - * List Tags + * lower than or equal (<=) */ displayName: () => LocalizedString /** - * Retrieve tags available in a Zoho CRM module + * Less than or equal comparison */ shortDesc: () => LocalizedString /** - * Fetches all tags that have been created for a specific Zoho CRM module. Tags are labels used to categorize and organize records within a module for easier searching and filtering. Each tag includes its name, ID, color code, and metadata about when it was created and modified. You can add a maximum of 100 tags per module and 10 tags per record. + * Returns `True` if the field value is less than or equal to the specified value */ longDesc: () => LocalizedString - options: { - module: { + args: { + '0': { /** - * Module + * Field */ displayName: () => LocalizedString /** - * The Zoho CRM module to retrieve tags from + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Zoho CRM module (such as Leads, Contacts, Deals, or custom modules) whose tags you want to retrieve. Each module maintains its own set of tags. + * The field whose value will be compared */ longDesc: () => LocalizedString } - my_tags: { + '1': { /** - * My Tags Only + * Value */ displayName: () => LocalizedString /** - * Retrieve only tags created by you + * Value to compare against */ shortDesc: () => LocalizedString /** - * When set to true, only tags created by the current user will be returned. When set to false or not specified, all tags in the module will be returned regardless of who created them. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - add_tags_to_records: { + 'in': { /** - * Add Tags to Records + * in */ displayName: () => LocalizedString /** - * Add tags to one or more records in a module + * Value is in list */ shortDesc: () => LocalizedString /** - * Adds one or more tags to specified records in a Zoho CRM module. Tags are labels that help categorize and organize records for easier management, filtering, and searching. You can add up to 10 tags per record and a maximum of 100 tags can exist per module. Returns the count of successfully tagged records and locked records that could not be tagged. + * Returns `True` if the field value is in the specified list of values */ longDesc: () => LocalizedString - options: { - module: { + args: { + '0': { /** - * Module + * Field */ displayName: () => LocalizedString /** - * The Zoho CRM module containing the records + * Field to check */ shortDesc: () => LocalizedString /** - * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) that contains the records you want to tag. Tags are module-specific and must exist in the module before they can be added to records. + * The field whose value will be checked */ longDesc: () => LocalizedString } - tags: { + '1': { /** - * Tags to Add + * Values */ displayName: () => LocalizedString /** - * List of tags to add to the records + * List of values */ shortDesc: () => LocalizedString /** - * Specify the tags you want to add to the records. Each tag should include an ID and name. The tag ID takes precedence over the name if both are provided. You can optionally include a color_code (hex value). Use the List Tags action to retrieve available tags and their IDs. + * The list of values to check against */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - id: { - /** - * Tag ID - */ - displayName: () => LocalizedString - /** - * The unique identifier of the tag - */ - shortDesc: () => LocalizedString - /** - * The unique ID of an existing tag in the module. This ID takes precedence over the name field. Use the List Tags action to retrieve tag IDs. The tag must already exist in the module. - */ - longDesc: () => LocalizedString - } - name: { - /** - * Tag Name - */ - displayName: () => LocalizedString - /** - * The display name of the tag - */ - shortDesc: () => LocalizedString - /** - * The display name of the tag. When both ID and name are provided, the ID takes precedence. If only the name is provided, the system will look up the tag by name. - */ - longDesc: () => LocalizedString - } - color_code: { - /** - * Color Code - */ - displayName: () => LocalizedString - /** - * Optional hexadecimal color code for the tag - */ - shortDesc: () => LocalizedString - /** - * Optional hexadecimal color code for visual identification of the tag (e.g., #F17574, #57B1FD). The allowed color codes are predefined in Zoho CRM. If not specified or set to null, the tag will use its default color. - */ - longDesc: () => LocalizedString - } - } - } - } } - records: { + } + } + 'not-in': { + /** + * not in + */ + displayName: () => LocalizedString + /** + * Value is not in list + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is not in the specified list of values + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Record IDs + * Field */ displayName: () => LocalizedString /** - * IDs of the records to tag + * Field to check */ shortDesc: () => LocalizedString /** - * List of unique record IDs to which you want to add tags. You can specify a maximum of 500 record IDs per API call. Use the Get Records API or search API to retrieve valid record IDs. + * The field whose value will be checked */ longDesc: () => LocalizedString } - over_write: { + '1': { /** - * Overwrite Existing Tags + * Values */ displayName: () => LocalizedString /** - * Replace all existing tags on the records + * List of values */ shortDesc: () => LocalizedString /** - * When set to true, replaces all existing tags on the specified records with the new tags. When set to false (default), adds the new tags while keeping existing tags. Use this option carefully as setting it to true will remove all current tags. + * The list of values to check against */ longDesc: () => LocalizedString } } } - } - searchOptions: { - orderBy: { + 'is-empty': { /** - * Order By + * is empty */ displayName: () => LocalizedString /** - * Sort results by a specific field + * Field is empty */ shortDesc: () => LocalizedString /** - * Define the field and direction to sort search results + * Returns `True` if the field is empty or has no value */ longDesc: () => LocalizedString - type: { - fields: { - column: { - /** - * Column - */ - displayName: () => LocalizedString - /** - * The column to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the column to use for sorting results - */ - longDesc: () => LocalizedString - } - ascending: { - /** - * Ascending - */ - displayName: () => LocalizedString - /** - * Sort in ascending order - */ - shortDesc: () => LocalizedString - /** - * When enabled, results are sorted in ascending order (A-Z, 0-9) - */ - longDesc: () => LocalizedString - } + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to check + */ + shortDesc: () => LocalizedString + /** + * The field to check for emptiness + */ + longDesc: () => LocalizedString } } } - } - upsertOptions: { - duplicate_check_fields: { + 'is-not-empty': { /** - * Duplicate Check Fields + * is not empty */ displayName: () => LocalizedString /** - * Fields to check for duplicate records + * Field is not empty */ shortDesc: () => LocalizedString /** - * A list of field API names used to check for duplicate records during upsert. If a record with matching values for these fields exists, it will be updated; otherwise, a new record will be created. + * Returns `True` if the field has a value */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to check + */ + shortDesc: () => LocalizedString + /** + * The field to check for a value + */ + longDesc: () => LocalizedString + } + } } - } - } - Firebase: { - /** - * Firebase - */ - displayName: () => LocalizedString - groups: { - /** - * Databases & Backend Services - */ - '0': () => LocalizedString - } - /** - * Connect to Firebase to manage files, users and push notifications - */ - shortDesc: () => LocalizedString - /** - * The Firebase integration provides comprehensive access to Firebase services including Cloud Storage for file management, Authentication for user management, and Firebase Cloud Messaging for push notifications. Automate file uploads, user account operations, and notification delivery across your Firebase projects. - */ - longDesc: () => LocalizedString - actions: { - list_users: { + between: { /** - * List Users + * between */ displayName: () => LocalizedString /** - * Retrieve a list of users from Firebase Authentication + * Value is between two values */ shortDesc: () => LocalizedString /** - * Fetches users from Firebase Authentication with support for pagination. Returns user details including email, display name, verification status, and authentication metadata. Use pagination parameters to retrieve large user lists efficiently. + * Returns `True` if the field value is between two specified values (inclusive) */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Firebase project to query + * Field to check */ shortDesc: () => LocalizedString /** - * Select the Firebase project from which you want to retrieve users. The project must have Firebase Authentication enabled. + * The field whose value will be checked */ longDesc: () => LocalizedString } - max_results: { + '1': { /** - * Max Results + * Lower Value */ displayName: () => LocalizedString /** - * Maximum number of users to return + * Lower bound */ shortDesc: () => LocalizedString /** - * Specify the maximum number of users to retrieve in a single request. Defaults to 100 if not specified. Use pagination for larger datasets. + * The lower bound value */ longDesc: () => LocalizedString } - next_page_token: { + '2': { /** - * Next Page Token + * Upper Value */ displayName: () => LocalizedString /** - * Token for retrieving the next page of results + * Upper bound */ shortDesc: () => LocalizedString /** - * Provide the pagination token from a previous response to retrieve the next set of users. Leave empty for the first page. + * The upper bound value */ longDesc: () => LocalizedString } } } - get_user: { + 'contains-text': { /** - * Get User + * contains text */ displayName: () => LocalizedString /** - * Retrieve detailed information about a specific Firebase user + * Contains text */ shortDesc: () => LocalizedString /** - * Fetches comprehensive details for a specific user from Firebase Authentication including email, display name, photo URL, verification status, account creation date, and custom attributes. Useful for user profile lookups and account verification. + * Returns `True` if the field contains the specified text */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Firebase project containing the user + * Text field to search */ shortDesc: () => LocalizedString /** - * Select the Firebase project where the user account exists. The project must have Firebase Authentication enabled. + * The text field to search within */ longDesc: () => LocalizedString } - user_id: { + '1': { /** - * User ID + * Text */ displayName: () => LocalizedString /** - * The unique identifier of the user + * Text to search for */ shortDesc: () => LocalizedString /** - * Specify the Firebase user ID (localId) of the user whose details you want to retrieve. This is the unique identifier assigned by Firebase Authentication. + * The text string to search for within the field */ longDesc: () => LocalizedString } } } - send_push_notification: { + 'not-contains-text': { /** - * Send Push Notification + * does not contain text */ displayName: () => LocalizedString /** - * Send a push notification via Firebase Cloud Messaging + * Does not contain text */ shortDesc: () => LocalizedString /** - * Sends push notifications to specific device tokens or topics using Firebase Cloud Messaging (FCM). Supports rich notifications with titles, body text, images, and custom data payloads. Configure priority levels for Android and iOS delivery. + * Returns `True` if the field does not contain the specified text */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Firebase project for sending notifications - */ - shortDesc: () => LocalizedString - /** - * Select the Firebase project that will send the push notification. The project must have Firebase Cloud Messaging configured. - */ - longDesc: () => LocalizedString - } - token_or_topic: { + args: { + '0': { /** - * Token or Topic + * Field */ displayName: () => LocalizedString /** - * Device token or topic name + * Text field to search */ shortDesc: () => LocalizedString /** - * Specify either a device registration token for sending to a specific device, or a topic name (prefixed with /topics/) for sending to all devices subscribed to that topic. + * The text field to search within */ longDesc: () => LocalizedString } - title: { + '1': { /** - * Title + * Text */ displayName: () => LocalizedString /** - * Notification title + * Text to exclude */ shortDesc: () => LocalizedString /** - * The title text that will be displayed in the notification. Keep it concise and informative. + * The text string that should not be present in the field */ longDesc: () => LocalizedString } - body: { + } + } + 'contains-terms': { + /** + * contains terms + */ + displayName: () => LocalizedString + /** + * Contains search terms + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field contains any of the specified search terms + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Body + * Field */ displayName: () => LocalizedString /** - * Notification message body + * Text field to search */ shortDesc: () => LocalizedString /** - * The main content of the notification message. This text appears below the title in the notification display. + * The text field to search within */ longDesc: () => LocalizedString } - image: { + '1': { /** - * Image + * Terms */ displayName: () => LocalizedString /** - * Optional image URL for the notification + * Search terms */ shortDesc: () => LocalizedString /** - * Provide a URL to an image that will be displayed in the notification. The image should be publicly accessible and in a supported format (JPEG, PNG). + * The search terms to look for within the field */ longDesc: () => LocalizedString } - data: { + } + } + 'starts-with': { + /** + * starts with + */ + displayName: () => LocalizedString + /** + * Starts with text + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field starts with the specified text + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Data + * Field */ displayName: () => LocalizedString /** - * Custom data payload + * Text field to check */ shortDesc: () => LocalizedString /** - * Additional custom key-value pairs to include with the notification. This data can be accessed by your app when the notification is received. + * The text field to check */ longDesc: () => LocalizedString } - priority: { + '1': { /** - * Priority + * Text */ displayName: () => LocalizedString /** - * Notification delivery priority + * Starting text */ shortDesc: () => LocalizedString /** - * Set the priority level for notification delivery. High priority notifications are delivered immediately and may wake the device. Normal priority allows for more battery-efficient delivery. + * The text that the field should start with */ longDesc: () => LocalizedString } } } - upload_file: { + 'ends-with': { /** - * Upload File + * ends with */ displayName: () => LocalizedString /** - * Upload a file to Firebase Cloud Storage + * Ends with text */ shortDesc: () => LocalizedString /** - * Uploads a file to a specified bucket in Firebase Cloud Storage. Returns metadata including file path, content type, size, and generation information. Optionally include custom metadata key-value pairs with the upload. + * Returns `True` if the field ends with the specified text */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Firebase project for storage - */ - shortDesc: () => LocalizedString - /** - * Select the Firebase project where the file will be stored. The project must have Firebase Cloud Storage enabled. - */ - longDesc: () => LocalizedString - } - file_path: { + args: { + '0': { /** - * File Path + * Field */ displayName: () => LocalizedString /** - * Destination path in storage + * Text field to check */ shortDesc: () => LocalizedString /** - * Specify the full path where the file should be stored in the bucket, including the filename and any directory structure (e.g., "images/profile/avatar.jpg"). + * The text field to check */ longDesc: () => LocalizedString } - bucket: { + '1': { /** - * Bucket + * Text */ displayName: () => LocalizedString /** - * Storage bucket name + * Ending text */ shortDesc: () => LocalizedString /** - * Select the Cloud Storage bucket where the file will be uploaded. The bucket must exist in the selected Firebase project. + * The text that the field should end with */ longDesc: () => LocalizedString } - file: { + } + } + 'within-the-next': { + /** + * within the next + */ + displayName: () => LocalizedString + /** + * Date is within the next N days + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the date field falls within the specified number of days in the future + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * File + * Field */ displayName: () => LocalizedString /** - * The file to upload + * Date field to check */ shortDesc: () => LocalizedString /** - * Select or provide the file to upload. The file will be transferred to Firebase Cloud Storage at the specified path. + * The date field to check */ longDesc: () => LocalizedString } - metadata: { + '1': { /** - * Metadata + * Days */ displayName: () => LocalizedString /** - * Custom metadata key-value pairs + * Number of days */ shortDesc: () => LocalizedString /** - * Optional custom metadata to associate with the uploaded file. Provide as key-value pairs that can be retrieved later with the file information. + * The number of days in the future to check */ longDesc: () => LocalizedString } } } - get_file_metadata: { + 'within-the-last': { /** - * Get File Metadata + * within the last */ displayName: () => LocalizedString /** - * Retrieve metadata for a specific file in Cloud Storage + * Date is within the last N days */ shortDesc: () => LocalizedString /** - * Fetches comprehensive metadata for a file stored in Firebase Cloud Storage including content type, size, creation date, update date, MD5 hash, custom metadata, and cache control settings. Useful for file verification and management. + * Returns `True` if the date field falls within the specified number of days in the past */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Firebase project containing the file + * Date field to check */ shortDesc: () => LocalizedString /** - * Select the Firebase project where the file is stored. The project must have Firebase Cloud Storage enabled. + * The date field to check */ longDesc: () => LocalizedString } - bucket: { + '1': { /** - * Bucket + * Days */ displayName: () => LocalizedString /** - * Storage bucket containing the file + * Number of days */ shortDesc: () => LocalizedString /** - * Select the Cloud Storage bucket where the file is located. The bucket must exist in the selected Firebase project. + * The number of days in the past to check */ longDesc: () => LocalizedString } - file_path: { + } + } + } + searchOptions: { + orderBy: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + column: { + /** + * Column + */ + displayName: () => LocalizedString + /** + * The column to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the column to use for sorting results + */ + longDesc: () => LocalizedString + } + ascending: { + /** + * Ascending + */ + displayName: () => LocalizedString + /** + * Sort in ascending order + */ + shortDesc: () => LocalizedString + /** + * When enabled, results are sorted in ascending order (A-Z, 0-9) + */ + longDesc: () => LocalizedString + } + } + } + } + group_id: { + /** + * Group + */ + displayName: () => LocalizedString + /** + * The group to filter items by + */ + shortDesc: () => LocalizedString + /** + * Select a group within the board to filter items + */ + longDesc: () => LocalizedString + } + } + createOptions: { + group_id: { + /** + * Group + */ + displayName: () => LocalizedString + /** + * The group to create the item in + */ + shortDesc: () => LocalizedString + /** + * Select a group within the board where the new item will be created + */ + longDesc: () => LocalizedString + } + } + } + ZohoCRM: { + /** + * Zoho CRM + */ + displayName: () => LocalizedString + groups: { + /** + * CRM & Sales Management + */ + '0': () => LocalizedString + } + /** + * Connect to Zoho CRM to automate customer relationship management across all global data centers. + */ + shortDesc: () => LocalizedString + /** + * The Zoho CRM integration provides comprehensive actions and triggers to interact with the Zoho CRM API across all seven global data centers (US, AU, EU, IN, CN, JP, CA). Manage modules, records, users, and roles efficiently while automating your CRM workflows with support for custom modules, bulk operations, and real-time triggers. + */ + longDesc: () => LocalizedString + expressions: { + '&&': { + /** + * and (&&) + */ + displayName: () => LocalizedString + /** + * Returns True if all arguments are True + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if all arguments are `True` with logic short-circuiting + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * File Path + * Condition */ displayName: () => LocalizedString /** - * Path to the file in storage + * Boolean condition to evaluate */ shortDesc: () => LocalizedString /** - * Specify the full path to the file in the bucket, including the filename and any directory structure. + * A boolean expression or condition that evaluates to True or False */ longDesc: () => LocalizedString } } } - list_files_in_bucket: { + '||': { /** - * List Files in Bucket + * or (||) */ displayName: () => LocalizedString /** - * List all files in a Cloud Storage bucket + * Returns True if any argument is True */ shortDesc: () => LocalizedString /** - * Retrieves a list of files from a Firebase Cloud Storage bucket with support for filtering by prefix and pagination. Returns file metadata including paths, content types, sizes, and timestamps. Useful for browsing and managing stored files. + * Returns `True` if any argument is `True` with logic short-circuiting */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Condition */ displayName: () => LocalizedString /** - * The Firebase project containing the bucket + * Boolean condition to evaluate */ shortDesc: () => LocalizedString /** - * Select the Firebase project where the storage bucket exists. The project must have Firebase Cloud Storage enabled. + * A boolean expression or condition that evaluates to True or False */ longDesc: () => LocalizedString } - bucket: { + } + } + '==': { + /** + * equal (==) + */ + displayName: () => LocalizedString + /** + * Equality comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value equals the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Bucket + * Field */ displayName: () => LocalizedString /** - * Storage bucket to list files from + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Cloud Storage bucket whose files you want to list. The bucket must exist in the selected Firebase project. + * The field whose value will be compared */ longDesc: () => LocalizedString } - prefix: { + '1': { /** - * Prefix + * Value */ displayName: () => LocalizedString /** - * Optional prefix to filter files + * Value to compare against */ shortDesc: () => LocalizedString /** - * Filter results to only include files whose paths start with this prefix. Useful for listing files in a specific directory or with a specific naming pattern. + * The value to compare the field against */ longDesc: () => LocalizedString } - max_results: { + } + } + '!=': { + /** + * not equal (!=) + */ + displayName: () => LocalizedString + /** + * Inequality comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value does not equal the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Max Results + * Field */ displayName: () => LocalizedString /** - * Maximum number of files to return + * Field to compare */ shortDesc: () => LocalizedString /** - * Specify the maximum number of files to retrieve in a single request. Defaults to 100 if not specified. Use pagination for larger result sets. + * The field whose value will be compared */ longDesc: () => LocalizedString } - page_token: { + '1': { /** - * Page Token + * Value */ displayName: () => LocalizedString /** - * Token for retrieving the next page + * Value to compare against */ shortDesc: () => LocalizedString /** - * Provide the pagination token from a previous response to retrieve the next set of files. Leave empty for the first page. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - list_buckets: { + '>': { /** - * List Buckets + * greater than (>) */ displayName: () => LocalizedString /** - * List all Cloud Storage buckets in a Firebase project + * Greater than comparison */ shortDesc: () => LocalizedString /** - * Retrieves all Cloud Storage buckets configured for a Firebase project. Returns bucket details including names, locations, storage classes, creation dates, and update timestamps. Useful for bucket management and discovery. + * Returns `True` if the field value is greater than the specified value */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Firebase project to query + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Firebase project whose storage buckets you want to list. The project must have Firebase Cloud Storage enabled. + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against */ longDesc: () => LocalizedString } } } - delete_file: { + '>=': { /** - * Delete File + * greater than or equal (>=) */ displayName: () => LocalizedString /** - * Delete a file from Cloud Storage + * Greater than or equal comparison */ shortDesc: () => LocalizedString /** - * Permanently removes a file from Firebase Cloud Storage. This operation is irreversible, so use with caution. Returns confirmation of the deletion including the file path and bucket name. + * Returns `True` if the field value is greater than or equal to the specified value */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Firebase project containing the file - */ - shortDesc: () => LocalizedString - /** - * Select the Firebase project where the file is stored. The project must have Firebase Cloud Storage enabled. - */ - longDesc: () => LocalizedString - } - bucket: { + args: { + '0': { /** - * Bucket + * Field */ displayName: () => LocalizedString /** - * Storage bucket containing the file + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Cloud Storage bucket where the file to be deleted is located. The bucket must exist in the selected Firebase project. + * The field whose value will be compared */ longDesc: () => LocalizedString } - file_path: { + '1': { /** - * File Path + * Value */ displayName: () => LocalizedString /** - * Path to the file to delete + * Value to compare against */ shortDesc: () => LocalizedString /** - * Specify the full path to the file in the bucket that should be deleted, including the filename and any directory structure. This operation is permanent and cannot be undone. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - } - triggers: { - new_user: { + '<': { /** - * New User + * less than (<) */ displayName: () => LocalizedString /** - * Triggers when a new user is created in Firebase Authentication + * Less than comparison */ shortDesc: () => LocalizedString /** - * Monitors Firebase Authentication for new user registrations and triggers when new accounts are created. Captures user details including email, display name, verification status, and authentication provider information. Useful for user onboarding workflows, welcome emails, and account setup automation. + * Returns `True` if the field value is less than the specified value */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Firebase project to monitor + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Firebase project whose Authentication service you want to monitor for new user registrations. The project must have Firebase Authentication enabled. + * The field whose value will be compared */ longDesc: () => LocalizedString } - } - } - } - } - Supabase: { - /** - * Supabase - */ - displayName: () => LocalizedString - groups: { - /** - * Databases & Backend Services - */ - '0': () => LocalizedString - } - /** - * Connect to Supabase to manage your database tables, storage buckets, and real-time data - */ - shortDesc: () => LocalizedString - /** - * The Supabase integration provides comprehensive access to your Supabase backend services. Manage database tables with full CRUD operations, monitor real-time changes with triggers, and handle file storage through buckets. Whether you need to query data, insert records, filter results, or track new entries, this integration streamlines your Supabase workflow automation and backend management. - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to Supabase - */ - title: () => LocalizedString - /** - * To connect to Supabase, you will need your **Project ID** (or Project URL) and a **service_role API Key**. - - ## Finding Your Project ID - - 1. Log in to the [Supabase Dashboard](https://supabase.com/dashboard) - 2. Select your project - 3. Go to **Project Settings** (gear icon) → **General** - 4. Find your **Reference ID** (this is your Project ID) - - Alternatively, your Project URL format is: `https://.supabase.co` - - ## Getting Your API Key - - 1. In your project dashboard, go to **Project Settings** → **API** - 2. Find the **Project API keys** section - 3. Copy the **service_role** key (labeled "secret") - - ⚠️ **Important**: Use the `service_role` key, NOT the `anon` key. The service_role key bypasses Row Level Security (RLS) and has full access to your database. - - ## Connection Details - - ### Project ID / Project URL - Either your project's Reference ID or the full project URL: - - Reference ID: `abcdefghijklmnop` - - Project URL: `https://abcdefghijklmnop.supabase.co` - - ### API Key (service_role) - The `service_role` secret key from your project's API settings. This key: - - Bypasses Row Level Security (RLS) - - Has full access to all database operations - - Should only be used server-side, never in client applications - - ## API Key Types - - | Key Type | Use Case | - |----------|----------| - | `anon` (public) | Client-side apps, respects RLS | - | `service_role` (secret) | Server-side operations, bypasses RLS | - - **Note:** The `service_role` key is extremely powerful and should be kept secure. Never expose it in client-side code or public repositories. For this integration, the service_role key is required to perform administrative operations. - */ - content: () => LocalizedString - } - actions: { - get_table: { - groups: { - /** - * Tables - */ - '0': () => LocalizedString - } - /** - * Get Table - */ - displayName: () => LocalizedString - /** - * Retrieve detailed schema information about a specific Supabase table - */ - shortDesc: () => LocalizedString - /** - * Fetches comprehensive metadata for a specific table including column definitions, data types, required fields, and descriptions. This action helps you understand the structure of your database tables. - */ - longDesc: () => LocalizedString - options: { - tableName: { + '1': { /** - * Table Name + * Value */ displayName: () => LocalizedString /** - * The name of the table to retrieve + * Value to compare against */ shortDesc: () => LocalizedString /** - * Select the Supabase table whose schema information you want to fetch. The table must exist in your Supabase project. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - list_tables: { - groups: { - /** - * Tables - */ - '0': () => LocalizedString - } + '<=': { /** - * List Tables + * less than or equal (<=) */ displayName: () => LocalizedString /** - * Get a list of all tables in your Supabase database + * Less than or equal comparison */ shortDesc: () => LocalizedString /** - * Retrieves all tables from your Supabase database with their basic metadata including column information and descriptions. Optionally include system tables in the results. + * Returns `True` if the field value is less than or equal to the specified value */ longDesc: () => LocalizedString - options: { - include_system_tables: { + args: { + '0': { /** - * Include System Tables + * Field */ displayName: () => LocalizedString /** - * Include internal Supabase system tables in the results + * Field to compare */ shortDesc: () => LocalizedString /** - * When enabled, the response will include system tables (those starting with underscore). System tables contain Supabase internal data and are typically hidden from regular queries. + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against */ longDesc: () => LocalizedString } } } - create_row: { - groups: { - /** - * Rows - */ - '0': () => LocalizedString - } + like: { /** - * Create Row + * like */ displayName: () => LocalizedString /** - * Insert a new row into a Supabase table + * Contains text pattern */ shortDesc: () => LocalizedString /** - * Creates a new record in the specified Supabase table. The action dynamically presents the table schema, allowing you to provide values for each column. Returns the newly created row with all its data. + * Returns `True` if the field value contains the specified text pattern */ longDesc: () => LocalizedString - options: { - tableName: { + args: { + '0': { /** - * Table Name + * Field */ displayName: () => LocalizedString /** - * The table where the row will be inserted + * Text field to search */ shortDesc: () => LocalizedString /** - * Select the target Supabase table for inserting the new row. The available fields will be dynamically loaded based on the selected table schema. + * The text field to search within */ longDesc: () => LocalizedString } - values: { + '1': { /** - * Row Values + * Pattern */ displayName: () => LocalizedString /** - * The data to insert into the new row + * Text pattern to search for */ shortDesc: () => LocalizedString /** - * Provide values for the table columns. The structure is dynamically generated based on the selected table schema, showing all available columns with their data types and constraints. + * The text pattern to search for within the field */ longDesc: () => LocalizedString } } } - list_rows: { - groups: { - /** - * Rows - */ - '0': () => LocalizedString - } + 'not-like': { /** - * List Rows + * not like */ displayName: () => LocalizedString /** - * Query and retrieve rows from a Supabase table + * Does not contain text pattern */ shortDesc: () => LocalizedString /** - * Fetches rows from a Supabase table with support for filtering, sorting, pagination, and ordering. Returns a list of records matching your query criteria along with total count information. + * Returns `True` if the field value does not contain the specified text pattern */ longDesc: () => LocalizedString - options: { - tableName: { - /** - * Table Name - */ - displayName: () => LocalizedString - /** - * The table to query - */ - shortDesc: () => LocalizedString - /** - * Select the Supabase table from which you want to retrieve rows. The available columns for filtering and ordering will be loaded based on this selection. - */ - longDesc: () => LocalizedString - } - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * Maximum number of rows to return - */ - shortDesc: () => LocalizedString - /** - * Specify the maximum number of rows to retrieve in a single query. Useful for pagination and performance optimization. Defaults to 20 if not specified. - */ - longDesc: () => LocalizedString - } - offset: { - /** - * Offset - */ - displayName: () => LocalizedString - /** - * Number of rows to skip - */ - shortDesc: () => LocalizedString - /** - * Skip this many rows before starting to return results. Used in combination with limit for pagination through large datasets. - */ - longDesc: () => LocalizedString - } - orderBy: { + args: { + '0': { /** - * Order By + * Field */ displayName: () => LocalizedString /** - * Sort the results by a specific column + * Text field to search */ shortDesc: () => LocalizedString /** - * Define how to sort the retrieved rows by specifying a column and sort direction (ascending or descending). + * The text field to search within */ longDesc: () => LocalizedString - type: { - fields: { - column: { - /** - * Column - */ - displayName: () => LocalizedString - /** - * The column to sort by - */ - shortDesc: () => LocalizedString - /** - * Select the table column used for sorting the results. - */ - longDesc: () => LocalizedString - } - ascending: { - /** - * Ascending - */ - displayName: () => LocalizedString - /** - * Sort in ascending order - */ - shortDesc: () => LocalizedString - /** - * When enabled, sorts in ascending order (A-Z, 0-9, oldest first). When disabled, sorts in descending order (Z-A, 9-0, newest first). - */ - longDesc: () => LocalizedString - } - } - } } - filter: { + '1': { /** - * Filter + * Pattern */ displayName: () => LocalizedString /** - * Filter rows based on a condition + * Text pattern to exclude */ shortDesc: () => LocalizedString /** - * Apply a filter condition to retrieve only rows that match specific criteria. Supports various comparison operators for flexible querying. + * The text pattern that should not be present in the field */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The column to filter on - */ - shortDesc: () => LocalizedString - /** - * Select the table column to apply the filter condition to. - */ - longDesc: () => LocalizedString - } - operator: { - /** - * Operator - */ - displayName: () => LocalizedString - /** - * The comparison operator - */ - shortDesc: () => LocalizedString - /** - * Choose the comparison operator for the filter (equals, greater than, contains, etc.). - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the column against using the selected operator. For "in" operator, provide comma-separated values. - */ - longDesc: () => LocalizedString - } - } - } } } } - delete_rows: { - groups: { - /** - * Rows - */ - '0': () => LocalizedString - } + 'in': { /** - * Delete Rows + * in */ displayName: () => LocalizedString /** - * Delete rows from a Supabase table based on a filter + * Value is in list */ shortDesc: () => LocalizedString /** - * Removes rows from a Supabase table that match the specified filter criteria. Returns the count of deleted rows and their data. Use with caution as this operation is irreversible. + * Returns `True` if the field value matches any value in the provided list */ longDesc: () => LocalizedString - options: { - tableName: { + args: { + '0': { /** - * Table Name + * Field */ displayName: () => LocalizedString /** - * The table to delete rows from + * Field to check */ shortDesc: () => LocalizedString /** - * Select the Supabase table from which you want to delete rows. Ensure you have proper permissions for delete operations on this table. + * The field whose value will be checked */ longDesc: () => LocalizedString } - filter: { + '1': { /** - * Filter + * Values */ displayName: () => LocalizedString /** - * Condition to identify rows to delete + * List of values to match */ shortDesc: () => LocalizedString /** - * Define the filter criteria to identify which rows should be deleted. Only rows matching this condition will be removed from the table. + * List of values to compare against */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The column to filter on - */ - shortDesc: () => LocalizedString - /** - * Select the table column to use for identifying rows to delete. - */ - longDesc: () => LocalizedString - } - operator: { - /** - * Operator - */ - displayName: () => LocalizedString - /** - * The comparison operator - */ - shortDesc: () => LocalizedString - /** - * Choose the comparison operator for the delete filter condition. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value to match - */ - shortDesc: () => LocalizedString - /** - * The value to compare against. Rows matching this condition will be deleted. - */ - longDesc: () => LocalizedString - } - } - } } } } - upsert_row: { - groups: { - /** - * Rows - */ - '0': () => LocalizedString - } + 'not-in': { /** - * Upsert Row + * not in */ displayName: () => LocalizedString /** - * Insert a new row or update an existing one + * Value is not in list */ shortDesc: () => LocalizedString /** - * Performs an upsert operation (insert or update) on a Supabase table. If a row with the specified unique constraint exists, it will be updated; otherwise, a new row is inserted. + * Returns `True` if the field value does not match any value in the provided list */ longDesc: () => LocalizedString - options: { - tableName: { - /** - * Table Name - */ - displayName: () => LocalizedString - /** - * The table for the upsert operation - */ - shortDesc: () => LocalizedString - /** - * Select the target Supabase table. The available fields will be dynamically loaded based on the table schema. - */ - longDesc: () => LocalizedString - } - values: { - /** - * Row Values - */ - displayName: () => LocalizedString - /** - * The data to upsert - */ - shortDesc: () => LocalizedString - /** - * Provide values for the table columns. If a row with matching unique constraints exists, these values will update it; otherwise, a new row is created. - */ - longDesc: () => LocalizedString - } - onConflict: { + args: { + '0': { /** - * On Conflict + * Field */ displayName: () => LocalizedString /** - * The column(s) used to detect conflicts + * Field to check */ shortDesc: () => LocalizedString /** - * Specify the column or comma-separated list of columns that should be used to detect conflicts. If not specified, uses the table's primary key. + * The field whose value will be checked */ longDesc: () => LocalizedString } - ignoreDuplicates: { + '1': { /** - * Ignore Duplicates + * Values */ displayName: () => LocalizedString /** - * Skip the operation if a duplicate exists + * List of values to exclude */ shortDesc: () => LocalizedString /** - * When enabled, if a conflicting row exists, the operation is silently ignored. When disabled (default), conflicting rows are updated with the new values. + * List of values that should not match */ longDesc: () => LocalizedString } } } - create_bucket: { - groups: { - /** - * Storage - */ - '0': () => LocalizedString - } + between: { /** - * Create Storage Bucket + * between */ displayName: () => LocalizedString /** - * Create a new storage bucket in Supabase + * Value is between two values */ shortDesc: () => LocalizedString /** - * Creates a new storage bucket in Supabase Storage for organizing and storing files. Configure access permissions, file size limits, and allowed MIME types. + * Returns `True` if the field value is between two specified values (inclusive) */ longDesc: () => LocalizedString - options: { - name: { - /** - * Bucket Name - */ - displayName: () => LocalizedString - /** - * The name for the new bucket - */ - shortDesc: () => LocalizedString - /** - * Specify a unique name for the storage bucket. The name must be URL-safe and unique within your Supabase project. - */ - longDesc: () => LocalizedString - } - public_access: { + args: { + '0': { /** - * Public Access + * Field */ displayName: () => LocalizedString /** - * Allow public access to bucket contents + * Field to check */ shortDesc: () => LocalizedString /** - * When enabled, files in this bucket can be accessed publicly without authentication. When disabled (default), files require authentication to access. + * The field whose value will be checked */ longDesc: () => LocalizedString } - file_size_limit: { + '1': { /** - * File Size Limit + * Lower bound */ displayName: () => LocalizedString /** - * Maximum file size in bytes + * Minimum value */ shortDesc: () => LocalizedString /** - * Set the maximum file size that can be uploaded to this bucket, specified in bytes. Leave empty for no limit. + * The minimum value (inclusive) */ longDesc: () => LocalizedString } - allowed_mime_types: { + '2': { /** - * Allowed MIME Types + * Upper bound */ displayName: () => LocalizedString /** - * List of allowed file MIME types + * Maximum value */ shortDesc: () => LocalizedString /** - * Specify which file types can be uploaded to this bucket by providing a list of MIME types (e.g., image/png, application/pdf). Leave empty to allow all file types. + * The maximum value (inclusive) */ longDesc: () => LocalizedString } } } - list_buckets: { - groups: { - /** - * Storage - */ - '0': () => LocalizedString - } - /** - * List Storage Buckets - */ - displayName: () => LocalizedString - /** - * Get all storage buckets in your Supabase project - */ - shortDesc: () => LocalizedString - /** - * Retrieves a list of all storage buckets in your Supabase project with their configurations including access permissions, file size limits, and allowed MIME types. - */ - longDesc: () => LocalizedString - } - get_bucket: { - groups: { - /** - * Storage - */ - '0': () => LocalizedString - } + 'not-between': { /** - * Get Storage Bucket + * not between */ displayName: () => LocalizedString /** - * Retrieve details of a specific storage bucket + * Value is not between two values */ shortDesc: () => LocalizedString /** - * Fetches detailed information about a specific Supabase storage bucket including its configuration, creation date, access permissions, and file restrictions. + * Returns `True` if the field value is not between two specified values */ longDesc: () => LocalizedString - options: { - bucket_id: { + args: { + '0': { /** - * Bucket ID + * Field */ displayName: () => LocalizedString /** - * The ID of the bucket to retrieve + * Field to check */ shortDesc: () => LocalizedString /** - * Select the storage bucket whose details you want to fetch from your Supabase project. + * The field whose value will be checked */ longDesc: () => LocalizedString } - } - } - } - triggers: { - new_table_row: { - /** - * New Table Row - */ - displayName: () => LocalizedString - /** - * Triggers when a new row is added to a Supabase table - */ - shortDesc: () => LocalizedString - /** - * Monitors a Supabase table for new rows and triggers when new records are inserted. Supports optional filtering to trigger only for rows matching specific criteria. - */ - longDesc: () => LocalizedString - options: { - tableName: { + '1': { /** - * Table Name + * Lower bound */ displayName: () => LocalizedString /** - * The table to monitor for new rows + * Minimum value to exclude */ shortDesc: () => LocalizedString /** - * Select the Supabase table you want to monitor. The trigger will fire whenever new rows are inserted into this table. + * The lower boundary for exclusion */ longDesc: () => LocalizedString } - filter: { + '2': { /** - * Filter + * Upper bound */ displayName: () => LocalizedString /** - * Optional condition to filter new rows + * Maximum value to exclude */ shortDesc: () => LocalizedString /** - * Apply a filter to trigger only for new rows matching specific criteria. Leave empty to trigger for all new rows. + * The upper boundary for exclusion */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The column to filter on - */ - shortDesc: () => LocalizedString - /** - * Select the table column to apply the filter condition to. - */ - longDesc: () => LocalizedString - } - operator: { - /** - * Operator - */ - displayName: () => LocalizedString - /** - * The comparison operator - */ - shortDesc: () => LocalizedString - /** - * Choose the comparison operator for filtering new rows. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value to match - */ - shortDesc: () => LocalizedString - /** - * The value to compare against. Only new rows matching this condition will trigger the event. - */ - longDesc: () => LocalizedString - } - } - } } } } - } - expressions: { - '&&': { + 'is-null': { /** - * and (&&) + * is null */ displayName: () => LocalizedString /** - * Returns True if all arguments are True + * Field is null */ shortDesc: () => LocalizedString /** - * Returns `True` if all arguments are `True` with logic short-circuiting + * Returns `True` if the field value is null or empty */ longDesc: () => LocalizedString args: { '0': { /** - * Condition + * Field */ displayName: () => LocalizedString /** - * Boolean condition to evaluate + * Field to check */ shortDesc: () => LocalizedString /** - * A boolean expression or condition that evaluates to True or False + * The field to check for null value */ longDesc: () => LocalizedString } } } - '||': { + 'is-not-null': { /** - * or (||) + * is not null */ displayName: () => LocalizedString /** - * Returns True if any argument is True + * Field is not null */ shortDesc: () => LocalizedString /** - * Returns `True` if any argument is `True` with logic short-circuiting + * Returns `True` if the field value is not null or empty */ longDesc: () => LocalizedString args: { '0': { /** - * Condition + * Field */ displayName: () => LocalizedString /** - * Boolean condition to evaluate + * Field to check */ shortDesc: () => LocalizedString /** - * A boolean expression or condition that evaluates to True or False + * The field to check for non-null value */ longDesc: () => LocalizedString } } } - NOT: { + } + triggers: { + new_record: { /** - * not (!) + * New Record */ displayName: () => LocalizedString /** - * Logical negation + * Triggers when a new record is created in a Zoho CRM module */ shortDesc: () => LocalizedString /** - * Returns the logical negation of the argument + * Monitors a specified Zoho CRM module for newly created records and fires when a new record is detected. The trigger polls for records sorted by Created Time in descending order. You can optionally filter records by phone, email, keywords, or specific field values to only trigger for records matching your criteria. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + module: { /** - * Condition + * Module */ displayName: () => LocalizedString /** - * Boolean condition to negate + * The Zoho CRM module to monitor for new records */ shortDesc: () => LocalizedString /** - * A boolean expression or condition to negate + * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) where you want to monitor for newly created records. Use the module API name as returned by the Modules Metadata API. */ longDesc: () => LocalizedString } - } - } - '==': { - /** - * equals (==) - */ - displayName: () => LocalizedString - /** - * Equality comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value equals the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + phone: { /** - * Field + * Phone Filter */ displayName: () => LocalizedString /** - * Field to compare + * Filter records by phone number */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Optional phone number to search for in records. When specified, only records containing this phone number will trigger the event. This uses the Zoho CRM search API to find matching records. */ longDesc: () => LocalizedString } - '1': { + email: { /** - * Value + * Email Filter */ displayName: () => LocalizedString /** - * Value to compare against + * Filter records by email address */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Optional email address to search for in records. When specified, only records containing this email address will trigger the event. This uses the Zoho CRM search API to find matching records. */ longDesc: () => LocalizedString } - } - } - '!=': { - /** - * not equals (!=) - */ - displayName: () => LocalizedString - /** - * Inequality comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value does not equal the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + word: { /** - * Field + * Keyword Search */ displayName: () => LocalizedString /** - * Field to compare + * Filter records by keyword */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Optional keyword to search for across all searchable fields in records. When specified, only records containing this keyword will trigger the event. This uses the Zoho CRM search API to perform a comprehensive text search. */ longDesc: () => LocalizedString } - '1': { + field_filter: { /** - * Value + * Field Filters */ displayName: () => LocalizedString /** - * Value to compare against + * Filter records by specific field values */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Optional list of field-value pairs to create search criteria. When specified, only records where ALL specified fields match their corresponding values will trigger the event. Uses the "equals" operator for each field comparison. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + field: { + /** + * Field Name + */ + displayName: () => LocalizedString + /** + * The API name of the field to filter on + */ + shortDesc: () => LocalizedString + /** + * Select or enter the field API name from the module. Available field names can be retrieved using the Fields Metadata API. The field must be searchable to be used in filtering. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Field Value + */ + displayName: () => LocalizedString + /** + * The value that the field must equal + */ + shortDesc: () => LocalizedString + /** + * Enter the exact value that the field must equal for the record to match. The comparison uses the "equals" operator, so the field value must match this value exactly. + */ + longDesc: () => LocalizedString + } + } + } + } } } } - '>': { + } + actions: { + create_record: { /** - * greater than (>) + * Create Record */ displayName: () => LocalizedString /** - * Greater than comparison + * Create a new record in a Zoho CRM module */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is greater than the specified value + * Creates a new record in the specified Zoho CRM module with the provided field values. Returns the record ID along with timestamps for creation and modification. The Created_By and Modified_By fields contain the user information who created the record. Supports all standard and custom modules except Documents and Projects. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + module: { /** - * Field + * Module */ displayName: () => LocalizedString /** - * Field to compare + * The Zoho CRM module where the record will be created */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Select the target Zoho CRM module (such as Leads, Contacts, Deals, Accounts, Products, Vendors, or custom modules) where you want to create the new record. Use the Modules API to get the list of available modules and their API names. */ longDesc: () => LocalizedString } - '1': { + properties: { /** - * Value + * Record Properties */ displayName: () => LocalizedString /** - * Value to compare against + * Field values for the new record */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Provide the field values for the new record as key-value pairs where keys are field API names. Available fields and their types are dynamically loaded based on the selected module. Required fields must be included, and field values must match their expected data types (text, number, date, picklist, lookup, etc.). */ longDesc: () => LocalizedString } } } - '>=': { + update_record: { /** - * greater than or equal (>=) + * Update Record */ displayName: () => LocalizedString /** - * Greater than or equal comparison + * Update an existing record in a Zoho CRM module */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is greater than or equal to the specified value + * Updates an existing record in the specified Zoho CRM module with the provided field values. Returns the record ID along with updated timestamps for modification. Only the fields you specify will be updated; other fields will remain unchanged. The record must exist and the user must have update permissions for the module. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { + options: { + module: { /** - * Value + * Module */ displayName: () => LocalizedString /** - * Value to compare against + * The Zoho CRM module containing the record */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) that contains the record you want to update. The module must support API operations and the user must have appropriate permissions. */ longDesc: () => LocalizedString } - } - } - '<': { - /** - * less than (<) - */ - displayName: () => LocalizedString - /** - * Less than comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is less than the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + record_id: { /** - * Field + * Record ID */ displayName: () => LocalizedString /** - * Field to compare + * The unique identifier of the record to update */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Enter or select the unique record ID of the record you want to update. Record IDs can be retrieved using the Get Records API or from webhook notifications. The record must exist in the specified module. */ longDesc: () => LocalizedString } - '1': { + properties: { /** - * Value + * Updated Properties */ displayName: () => LocalizedString /** - * Value to compare against + * Field values to update on the record */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Provide the field values you want to update as key-value pairs where keys are field API names. Only include the fields you want to change; unspecified fields will retain their current values. Field values must match their expected data types and validation rules. */ longDesc: () => LocalizedString } } } - '<=': { + delete_record: { /** - * less than or equal (<=) + * Delete Record */ displayName: () => LocalizedString /** - * Less than or equal comparison + * Delete a record from a Zoho CRM module */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is less than or equal to the specified value + * Permanently deletes a specific record from the specified Zoho CRM module using its unique record ID. If the module has the Recycle Bin feature enabled, the deleted record will be moved to the Recycle Bin and can be restored. Otherwise, the deletion is permanent. The user must have delete permissions for the module. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + module: { /** - * Field + * Module */ displayName: () => LocalizedString /** - * Field to compare + * The Zoho CRM module containing the record */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) that contains the record you want to delete. The module must support API operations and the user must have delete permissions. */ longDesc: () => LocalizedString } - '1': { + record_id: { /** - * Value + * Record ID */ displayName: () => LocalizedString /** - * Value to compare against + * The unique identifier of the record to delete */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Enter or select the unique record ID of the record you want to delete. Record IDs can be retrieved using the Get Records API. Deleting a record that has already been deleted will result in an error. */ longDesc: () => LocalizedString } } } - like: { + get_record: { /** - * like + * Get Record */ displayName: () => LocalizedString /** - * Pattern matching (case-sensitive) + * Retrieve a single record from a Zoho CRM module */ shortDesc: () => LocalizedString /** - * Returns `True` if the field matches the pattern with % as wildcard + * Fetches detailed information about a specific record from the specified Zoho CRM module using its unique record ID. Returns all field values for the record including standard fields (Created_Time, Modified_Time, Created_By, Modified_By) and custom fields. Subform data, multi-select lookup fields, and multi-user lookup fields are also included in the response. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + module: { /** - * Field + * Module */ displayName: () => LocalizedString /** - * Text field to match + * The Zoho CRM module containing the record */ shortDesc: () => LocalizedString /** - * The text field to match against the pattern + * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) that contains the record you want to retrieve. The module must support API operations and the user must have read permissions. */ longDesc: () => LocalizedString } - '1': { + record_id: { /** - * Pattern + * Record ID */ displayName: () => LocalizedString /** - * Pattern to match + * The unique identifier of the record to retrieve */ shortDesc: () => LocalizedString /** - * The pattern to match with (use % as wildcard, e.g., "%example%") + * Enter or select the unique record ID of the record you want to fetch. Record IDs can be obtained from the Get Records API, search results, or webhook notifications. The record must exist in the specified module. */ longDesc: () => LocalizedString } } } - ilike: { + list_records: { /** - * ilike + * List Records */ displayName: () => LocalizedString /** - * Pattern matching (case-insensitive) + * Retrieve multiple records from a Zoho CRM module */ shortDesc: () => LocalizedString /** - * Returns `True` if the field matches the pattern (case-insensitive) with % as wildcard + * Fetches a list of records from the specified Zoho CRM module with support for field selection, pagination, sorting, and filtering. You can specify which fields to return (maximum 50 field API names), sort records by a field in ascending or descending order, and navigate through pages using tokens. Returns both the records data and pagination tokens for retrieving subsequent pages. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + module: { /** - * Field + * Module */ displayName: () => LocalizedString /** - * Text field to match + * The Zoho CRM module to retrieve records from */ shortDesc: () => LocalizedString /** - * The text field to match against the pattern + * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) from which you want to retrieve records. The module must support API operations and the user must have read permissions. */ longDesc: () => LocalizedString } - '1': { + fields: { /** - * Pattern + * Fields to Return */ displayName: () => LocalizedString /** - * Pattern to match + * Specify which fields to include in the response */ shortDesc: () => LocalizedString /** - * The pattern to match with, case-insensitive (use % as wildcard, e.g., "%example%") + * Select the field API names you want to retrieve for each record. You can include a maximum of 50 field API names. Use the Fields Metadata API to get the list of available fields. By default, only the ID field is returned. Add fields like Last_Name, Email, Created_Time, or custom field names as needed. */ longDesc: () => LocalizedString } - } - } - 'in': { - /** - * in - */ - displayName: () => LocalizedString - /** - * In list - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is in the provided list - */ - longDesc: () => LocalizedString - args: { - '0': { + per_page: { /** - * Field + * Records Per Page */ displayName: () => LocalizedString /** - * Field to check + * Number of records to return per page */ shortDesc: () => LocalizedString /** - * The field whose value will be checked + * Specify how many records to return in a single API request. Valid values are 1 to 200. The default value is 20. Use this parameter along with page_token for pagination through large result sets. */ longDesc: () => LocalizedString } - '1': { + page_token: { /** - * Values + * Page Token */ displayName: () => LocalizedString /** - * List of values + * Token for retrieving the next page of results */ shortDesc: () => LocalizedString /** - * The list of values to check the field against + * Use the next_page_token value from a previous response to retrieve the next page of records. Leave this empty for the first page. The page_token is bound to the parameters used in the request, so do not change other parameters when using a token. */ longDesc: () => LocalizedString } - } - } - contains: { - /** - * contains (@>) - */ - displayName: () => LocalizedString - /** - * Array contains elements - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the array field contains all the specified elements - */ - longDesc: () => LocalizedString - args: { - '0': { + ids: { /** - * Field + * Record IDs */ displayName: () => LocalizedString /** - * Array field to check + * Filter by specific record IDs */ shortDesc: () => LocalizedString /** - * The array field to check for contained elements + * Optional list of specific record IDs to retrieve. When provided, only records with these IDs will be returned. This is useful for fetching a specific set of records rather than paginating through all records. */ longDesc: () => LocalizedString } - '1': { + sort: { /** - * Elements + * Sort Configuration */ displayName: () => LocalizedString /** - * Elements to find + * Configure how to sort the returned records */ shortDesc: () => LocalizedString /** - * The list of elements that should be contained in the array + * Specify how records should be sorted in the response. You can sort by fields like id, Created_Time, or Modified_Time in either ascending (oldest first) or descending (newest first) order. */ longDesc: () => LocalizedString - } - } - } - } - searchOptions: { + type: { + fields: { + sort_by: { + /** + * Sort By Field + */ + displayName: () => LocalizedString + /** + * The field to use for sorting records + */ + shortDesc: () => LocalizedString + /** + * Select or enter the field API name to sort records by. Common options include id, Created_Time, and Modified_Time. You can also use custom field API names that support sorting. + */ + longDesc: () => LocalizedString + } + order: { + /** + * Sort Order + */ + displayName: () => LocalizedString + /** + * Sort in ascending or descending order + */ + shortDesc: () => LocalizedString + /** + * Choose whether to sort records in ascending order (asc - oldest first) or descending order (desc - newest first). The default value is descending. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + list_modules: { + /** + * List Modules + */ + displayName: () => LocalizedString + /** + * Retrieve all available modules in Zoho CRM + */ + shortDesc: () => LocalizedString + /** + * Fetches metadata for all modules in your Zoho CRM organization, including both standard modules (Leads, Contacts, Deals, Accounts, etc.) and custom modules. Returns comprehensive details including module permissions, API names, display labels, and capabilities like whether the module is creatable, editable, deletable, or supports features like global search and quick create. + */ + longDesc: () => LocalizedString + options: { + status: { + /** + * Module Status Filter + */ + displayName: () => LocalizedString + /** + * Filter modules by their status + */ + shortDesc: () => LocalizedString + /** + * Optional filter to retrieve only modules with specific statuses. Options include: visible (active modules shown in the UI), user_hidden (modules hidden by users), system_hidden (modules hidden by the system), and scheduled_for_deletion (modules marked for deletion). When not specified, all modules are returned. + */ + longDesc: () => LocalizedString + } + } + } + list_fields: { + /** + * List Module Fields + */ + displayName: () => LocalizedString + /** + * Retrieve field metadata for a Zoho CRM module + */ + shortDesc: () => LocalizedString + /** + * Fetches comprehensive metadata about all fields in a specific Zoho CRM module including field types, labels, API names, data types, validation rules, picklist values, lookup configurations, and permissions. This information is essential for understanding module structure, building dynamic forms, or validating data before creating or updating records. + */ + longDesc: () => LocalizedString + options: { + module: { + /** + * Module + */ + displayName: () => LocalizedString + /** + * The Zoho CRM module to retrieve fields from + */ + shortDesc: () => LocalizedString + /** + * Select the Zoho CRM module whose field metadata you want to retrieve. The API returns detailed information about all fields including standard fields (system-defined) and custom fields (user-defined) in the module. + */ + longDesc: () => LocalizedString + } + } + } + list_users: { + /** + * List Users + */ + displayName: () => LocalizedString + /** + * Retrieve users from your Zoho CRM organization + */ + shortDesc: () => LocalizedString + /** + * Fetches a list of users in your Zoho CRM organization with support for pagination and filtering by user type. Returns comprehensive user information including name, email, role, profile, timezone, locale settings, customization preferences, and account status. Use the type parameter to filter users based on their profile and status. + */ + longDesc: () => LocalizedString + options: { + per_page: { + /** + * Users Per Page + */ + displayName: () => LocalizedString + /** + * Number of users to return per page + */ + shortDesc: () => LocalizedString + /** + * Specify how many users to return in a single API request. Valid values are 1 to 200. The default value is 20. Use this parameter along with the page parameter for pagination through large result sets. + */ + longDesc: () => LocalizedString + } + page: { + /** + * Page Number + */ + displayName: () => LocalizedString + /** + * The page number for pagination + */ + shortDesc: () => LocalizedString + /** + * Specify which page of results to retrieve, starting from 1 for the first page. Use this parameter along with per_page to navigate through multiple pages of user data. + */ + longDesc: () => LocalizedString + } + type: { + /** + * User Type Filter + */ + displayName: () => LocalizedString + /** + * Filter users by type or status + */ + shortDesc: () => LocalizedString + /** + * Optional filter to retrieve specific categories of users. Options include: AllUsers (both active and inactive), ActiveUsers (only active users), DeactiveUsers (deactivated users), ConfirmedUsers (users who confirmed their accounts), NotConfirmedUsers (unconfirmed users), DeletedUsers (deleted users), ActiveConfirmedUsers (active and confirmed), AdminUsers (users with Administrator privileges), ActiveConfirmedAdmins (active confirmed administrators), and CurrentUser (the currently authenticated CRM user). + */ + longDesc: () => LocalizedString + } + } + } + list_tags: { + /** + * List Tags + */ + displayName: () => LocalizedString + /** + * Retrieve tags available in a Zoho CRM module + */ + shortDesc: () => LocalizedString + /** + * Fetches all tags that have been created for a specific Zoho CRM module. Tags are labels used to categorize and organize records within a module for easier searching and filtering. Each tag includes its name, ID, color code, and metadata about when it was created and modified. You can add a maximum of 100 tags per module and 10 tags per record. + */ + longDesc: () => LocalizedString + options: { + module: { + /** + * Module + */ + displayName: () => LocalizedString + /** + * The Zoho CRM module to retrieve tags from + */ + shortDesc: () => LocalizedString + /** + * Select the Zoho CRM module (such as Leads, Contacts, Deals, or custom modules) whose tags you want to retrieve. Each module maintains its own set of tags. + */ + longDesc: () => LocalizedString + } + my_tags: { + /** + * My Tags Only + */ + displayName: () => LocalizedString + /** + * Retrieve only tags created by you + */ + shortDesc: () => LocalizedString + /** + * When set to true, only tags created by the current user will be returned. When set to false or not specified, all tags in the module will be returned regardless of who created them. + */ + longDesc: () => LocalizedString + } + } + } + add_tags_to_records: { + /** + * Add Tags to Records + */ + displayName: () => LocalizedString + /** + * Add tags to one or more records in a module + */ + shortDesc: () => LocalizedString + /** + * Adds one or more tags to specified records in a Zoho CRM module. Tags are labels that help categorize and organize records for easier management, filtering, and searching. You can add up to 10 tags per record and a maximum of 100 tags can exist per module. Returns the count of successfully tagged records and locked records that could not be tagged. + */ + longDesc: () => LocalizedString + options: { + module: { + /** + * Module + */ + displayName: () => LocalizedString + /** + * The Zoho CRM module containing the records + */ + shortDesc: () => LocalizedString + /** + * Select the Zoho CRM module (such as Leads, Contacts, Deals, Accounts, or custom modules) that contains the records you want to tag. Tags are module-specific and must exist in the module before they can be added to records. + */ + longDesc: () => LocalizedString + } + tags: { + /** + * Tags to Add + */ + displayName: () => LocalizedString + /** + * List of tags to add to the records + */ + shortDesc: () => LocalizedString + /** + * Specify the tags you want to add to the records. Each tag should include an ID and name. The tag ID takes precedence over the name if both are provided. You can optionally include a color_code (hex value). Use the List Tags action to retrieve available tags and their IDs. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + id: { + /** + * Tag ID + */ + displayName: () => LocalizedString + /** + * The unique identifier of the tag + */ + shortDesc: () => LocalizedString + /** + * The unique ID of an existing tag in the module. This ID takes precedence over the name field. Use the List Tags action to retrieve tag IDs. The tag must already exist in the module. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Tag Name + */ + displayName: () => LocalizedString + /** + * The display name of the tag + */ + shortDesc: () => LocalizedString + /** + * The display name of the tag. When both ID and name are provided, the ID takes precedence. If only the name is provided, the system will look up the tag by name. + */ + longDesc: () => LocalizedString + } + color_code: { + /** + * Color Code + */ + displayName: () => LocalizedString + /** + * Optional hexadecimal color code for the tag + */ + shortDesc: () => LocalizedString + /** + * Optional hexadecimal color code for visual identification of the tag (e.g., #F17574, #57B1FD). The allowed color codes are predefined in Zoho CRM. If not specified or set to null, the tag will use its default color. + */ + longDesc: () => LocalizedString + } + } + } + } + } + records: { + /** + * Record IDs + */ + displayName: () => LocalizedString + /** + * IDs of the records to tag + */ + shortDesc: () => LocalizedString + /** + * List of unique record IDs to which you want to add tags. You can specify a maximum of 500 record IDs per API call. Use the Get Records API or search API to retrieve valid record IDs. + */ + longDesc: () => LocalizedString + } + over_write: { + /** + * Overwrite Existing Tags + */ + displayName: () => LocalizedString + /** + * Replace all existing tags on the records + */ + shortDesc: () => LocalizedString + /** + * When set to true, replaces all existing tags on the specified records with the new tags. When set to false (default), adds the new tags while keeping existing tags. Use this option carefully as setting it to true will remove all current tags. + */ + longDesc: () => LocalizedString + } + } + } + } + searchOptions: { orderBy: { /** * Order By @@ -143155,1805 +143757,1902 @@ export type TranslationFunctions = { } } } - limit: { + } + upsertOptions: { + duplicate_check_fields: { /** - * Limit + * Duplicate Check Fields */ displayName: () => LocalizedString /** - * Maximum number of records to return + * Fields to check for duplicate records */ shortDesc: () => LocalizedString /** - * Set the maximum total number of records to retrieve from the search + * A list of field API names used to check for duplicate records during upsert. If a record with matching values for these fields exists, it will be updated; otherwise, a new record will be created. */ longDesc: () => LocalizedString } } } - BambooHR: { + Firebase: { /** - * BambooHR + * Firebase */ displayName: () => LocalizedString groups: { /** - * HR & People Management + * Databases & Backend Services */ '0': () => LocalizedString } /** - * Connect to BambooHR to manage employee data with powerful automation + * Connect to Firebase to manage files, users and push notifications */ shortDesc: () => LocalizedString /** - * The BambooHR integration provides comprehensive access to your HR operations. Create, read, update, and list employees with dynamic field support. The integration automatically discovers available fields in your BambooHR account, including custom fields, and provides intelligent type handling for dates, lists, and other field types. + * The Firebase integration provides comprehensive access to Firebase services including Cloud Storage for file management, Authentication for user management, and Firebase Cloud Messaging for push notifications. Automate file uploads, user account operations, and notification delivery across your Firebase projects. */ longDesc: () => LocalizedString actions: { - get_employee: { - groups: { - /** - * Employees - */ - '0': () => LocalizedString - } + list_users: { /** - * Get Employee + * List Users */ displayName: () => LocalizedString /** - * Retrieve a single employee by ID + * Retrieve a list of users from Firebase Authentication */ shortDesc: () => LocalizedString /** - * Fetches detailed data for a single employee in BambooHR by their ID. Returns all requested fields with dynamically loaded field types. You can specify which fields to retrieve or fetch all available fields. + * Fetches users from Firebase Authentication with support for pagination. Returns user details including email, display name, verification status, and authentication metadata. Use pagination parameters to retrieve large user lists efficiently. */ longDesc: () => LocalizedString options: { - employee_id: { + project_id: { /** - * Employee ID + * Project ID */ displayName: () => LocalizedString /** - * The ID of the employee to retrieve + * The Firebase project to query */ shortDesc: () => LocalizedString /** - * Enter the unique identifier of the employee you want to fetch. Use 0 to retrieve the employee associated with your API key. + * Select the Firebase project from which you want to retrieve users. The project must have Firebase Authentication enabled. */ longDesc: () => LocalizedString } - fields: { + max_results: { /** - * Fields + * Max Results */ displayName: () => LocalizedString /** - * Specific fields to retrieve + * Maximum number of users to return */ shortDesc: () => LocalizedString /** - * Select which fields to retrieve for the employee. Leave empty to retrieve all available fields (up to 400 fields). + * Specify the maximum number of users to retrieve in a single request. Defaults to 100 if not specified. Use pagination for larger datasets. */ longDesc: () => LocalizedString } - } - } - create_employee: { - groups: { - /** - * Employees - */ - '0': () => LocalizedString - } - /** - * Create Employee - */ - displayName: () => LocalizedString - /** - * Create a new employee in BambooHR - */ - shortDesc: () => LocalizedString - /** - * Creates a new employee record in BambooHR. At minimum, firstName and lastName are required. The action dynamically presents all available fields based on your BambooHR configuration, including custom fields. - */ - longDesc: () => LocalizedString - options: { - employee_data: { + next_page_token: { /** - * Employee Data + * Next Page Token */ displayName: () => LocalizedString /** - * The data for the new employee + * Token for retrieving the next page of results */ shortDesc: () => LocalizedString /** - * Provide values for the employee fields. The available fields are dynamically loaded from your BambooHR account and include both standard and custom fields. firstName and lastName are required. + * Provide the pagination token from a previous response to retrieve the next set of users. Leave empty for the first page. */ longDesc: () => LocalizedString } } } - update_employee: { - groups: { - /** - * Employees - */ - '0': () => LocalizedString - } + get_user: { /** - * Update Employee + * Get User */ displayName: () => LocalizedString /** - * Update an existing employee in BambooHR + * Retrieve detailed information about a specific Firebase user */ shortDesc: () => LocalizedString /** - * Updates an existing employee record in BambooHR. The action dynamically presents all available fields based on your BambooHR configuration. Only provide the fields you want to update. + * Fetches comprehensive details for a specific user from Firebase Authentication including email, display name, photo URL, verification status, account creation date, and custom attributes. Useful for user profile lookups and account verification. */ longDesc: () => LocalizedString options: { - employee_id: { + project_id: { /** - * Employee ID + * Project ID */ displayName: () => LocalizedString /** - * The ID of the employee to update + * The Firebase project containing the user */ shortDesc: () => LocalizedString /** - * Enter the unique identifier of the employee you want to update. + * Select the Firebase project where the user account exists. The project must have Firebase Authentication enabled. */ longDesc: () => LocalizedString } - employee_data: { + user_id: { /** - * Employee Data + * User ID */ displayName: () => LocalizedString /** - * The data to update + * The unique identifier of the user */ shortDesc: () => LocalizedString /** - * Provide new values for the employee fields you want to update. The available fields are dynamically loaded from your BambooHR account. + * Specify the Firebase user ID (localId) of the user whose details you want to retrieve. This is the unique identifier assigned by Firebase Authentication. */ longDesc: () => LocalizedString } } } - list_employees: { - groups: { - /** - * Employees - */ - '0': () => LocalizedString - } + send_push_notification: { /** - * List Employees + * Send Push Notification */ displayName: () => LocalizedString /** - * Retrieve a list of all employees + * Send a push notification via Firebase Cloud Messaging */ shortDesc: () => LocalizedString /** - * Fetches a list of all employees from BambooHR. You can specify which fields to retrieve for each employee. Uses the custom report endpoint for efficient bulk retrieval. + * Sends push notifications to specific device tokens or topics using Firebase Cloud Messaging (FCM). Supports rich notifications with titles, body text, images, and custom data payloads. Configure priority levels for Android and iOS delivery. */ longDesc: () => LocalizedString options: { - fields: { + project_id: { /** - * Fields + * Project ID */ displayName: () => LocalizedString /** - * Specific fields to retrieve for each employee + * The Firebase project for sending notifications */ shortDesc: () => LocalizedString /** - * Select which fields to retrieve for each employee. Leave empty to retrieve a default set of common fields (id, name, email, department, job title). + * Select the Firebase project that will send the push notification. The project must have Firebase Cloud Messaging configured. */ longDesc: () => LocalizedString } - } - } - get_whos_out: { - groups: { - /** - * Time Off - */ - '0': () => LocalizedString - } - /** - * Get Who's Out - */ - displayName: () => LocalizedString - /** - * Get a summary of employees who are out - */ - shortDesc: () => LocalizedString - /** - * Retrieves a list of employees who are out (vacation, sick leave, etc.) and company holidays for a given date range. If no dates are specified, returns the current day plus the next 14 days. - */ - longDesc: () => LocalizedString - options: { - start_date: { + token_or_topic: { /** - * Start Date + * Token or Topic */ displayName: () => LocalizedString /** - * Start of the date range + * Device token or topic name */ shortDesc: () => LocalizedString /** - * The start date for the query. Defaults to today if not specified. + * Specify either a device registration token for sending to a specific device, or a topic name (prefixed with /topics/) for sending to all devices subscribed to that topic. */ longDesc: () => LocalizedString } - end_date: { + title: { /** - * End Date + * Title */ displayName: () => LocalizedString /** - * End of the date range + * Notification title */ shortDesc: () => LocalizedString /** - * The end date for the query. Defaults to 14 days from the start date if not specified. + * The title text that will be displayed in the notification. Keep it concise and informative. + */ + longDesc: () => LocalizedString + } + body: { + /** + * Body + */ + displayName: () => LocalizedString + /** + * Notification message body + */ + shortDesc: () => LocalizedString + /** + * The main content of the notification message. This text appears below the title in the notification display. + */ + longDesc: () => LocalizedString + } + image: { + /** + * Image + */ + displayName: () => LocalizedString + /** + * Optional image URL for the notification + */ + shortDesc: () => LocalizedString + /** + * Provide a URL to an image that will be displayed in the notification. The image should be publicly accessible and in a supported format (JPEG, PNG). + */ + longDesc: () => LocalizedString + } + data: { + /** + * Data + */ + displayName: () => LocalizedString + /** + * Custom data payload + */ + shortDesc: () => LocalizedString + /** + * Additional custom key-value pairs to include with the notification. This data can be accessed by your app when the notification is received. + */ + longDesc: () => LocalizedString + } + priority: { + /** + * Priority + */ + displayName: () => LocalizedString + /** + * Notification delivery priority + */ + shortDesc: () => LocalizedString + /** + * Set the priority level for notification delivery. High priority notifications are delivered immediately and may wake the device. Normal priority allows for more battery-efficient delivery. */ longDesc: () => LocalizedString } } } - search_time_off_requests: { - groups: { - /** - * Time Off - */ - '0': () => LocalizedString - } + upload_file: { /** - * Search Time Off Requests + * Upload File */ displayName: () => LocalizedString /** - * Search and filter time off requests + * Upload a file to Firebase Cloud Storage */ shortDesc: () => LocalizedString /** - * Searches time off requests in BambooHR with various filters. Returns requests matching the specified criteria including date range, employee, status, and time off type. + * Uploads a file to a specified bucket in Firebase Cloud Storage. Returns metadata including file path, content type, size, and generation information. Optionally include custom metadata key-value pairs with the upload. */ longDesc: () => LocalizedString options: { - start_date: { + project_id: { /** - * Start Date + * Project ID */ displayName: () => LocalizedString /** - * Filter by start date + * The Firebase project for storage */ shortDesc: () => LocalizedString /** - * Only show time off requests on or after this date. + * Select the Firebase project where the file will be stored. The project must have Firebase Cloud Storage enabled. */ longDesc: () => LocalizedString } - end_date: { + file_path: { /** - * End Date + * File Path */ displayName: () => LocalizedString /** - * Filter by end date + * Destination path in storage */ shortDesc: () => LocalizedString /** - * Only show time off requests on or before this date. + * Specify the full path where the file should be stored in the bucket, including the filename and any directory structure (e.g., "images/profile/avatar.jpg"). */ longDesc: () => LocalizedString } - employee_id: { + bucket: { /** - * Employee ID + * Bucket */ displayName: () => LocalizedString /** - * Filter by employee + * Storage bucket name */ shortDesc: () => LocalizedString /** - * Limit results to a specific employee by their ID. + * Select the Cloud Storage bucket where the file will be uploaded. The bucket must exist in the selected Firebase project. */ longDesc: () => LocalizedString } - status: { + file: { /** - * Status + * File */ displayName: () => LocalizedString /** - * Filter by request status + * The file to upload */ shortDesc: () => LocalizedString /** - * Filter by one or more statuses: approved, denied, requested, canceled, superceded. + * Select or provide the file to upload. The file will be transferred to Firebase Cloud Storage at the specified path. */ longDesc: () => LocalizedString } - type: { + metadata: { /** - * Time Off Type + * Metadata */ displayName: () => LocalizedString /** - * Filter by time off type + * Custom metadata key-value pairs */ shortDesc: () => LocalizedString /** - * Filter by one or more time off types configured in your BambooHR account. + * Optional custom metadata to associate with the uploaded file. Provide as key-value pairs that can be retrieved later with the file information. */ longDesc: () => LocalizedString } } } - get_all_employee_files: { - groups: { - /** - * Employee Files - */ - '0': () => LocalizedString - } + get_file_metadata: { /** - * Get All Employee Files + * Get File Metadata */ displayName: () => LocalizedString /** - * List all files for an employee + * Retrieve metadata for a specific file in Cloud Storage */ shortDesc: () => LocalizedString /** - * Retrieves all files associated with a specific employee, organized by category. Returns file metadata including name, size, upload date, and sharing status. + * Fetches comprehensive metadata for a file stored in Firebase Cloud Storage including content type, size, creation date, update date, MD5 hash, custom metadata, and cache control settings. Useful for file verification and management. */ longDesc: () => LocalizedString options: { - employee_id: { + project_id: { /** - * Employee ID + * Project ID */ displayName: () => LocalizedString /** - * The employee to get files for + * The Firebase project containing the file */ shortDesc: () => LocalizedString /** - * The ID of the employee whose files you want to retrieve. + * Select the Firebase project where the file is stored. The project must have Firebase Cloud Storage enabled. */ longDesc: () => LocalizedString } - } - } - download_employee_file: { - groups: { - /** - * Employee Files - */ - '0': () => LocalizedString - } - /** - * Download Employee File - */ - displayName: () => LocalizedString - /** - * Download an employee file - */ - shortDesc: () => LocalizedString - /** - * Downloads a specific file from an employee record. Returns the file content as base64-encoded binary along with the MIME type. - */ - longDesc: () => LocalizedString - options: { - employee_id: { + bucket: { /** - * Employee ID + * Bucket */ displayName: () => LocalizedString /** - * The employee who owns the file + * Storage bucket containing the file */ shortDesc: () => LocalizedString /** - * The ID of the employee whose file you want to download. + * Select the Cloud Storage bucket where the file is located. The bucket must exist in the selected Firebase project. */ longDesc: () => LocalizedString } - file_id: { + file_path: { /** - * File ID + * File Path */ displayName: () => LocalizedString /** - * The file to download + * Path to the file in storage */ shortDesc: () => LocalizedString /** - * The ID of the file to download. + * Specify the full path to the file in the bucket, including the filename and any directory structure. */ longDesc: () => LocalizedString } } } - upload_employee_file: { - groups: { - /** - * Employee Files - */ - '0': () => LocalizedString - } + list_files_in_bucket: { /** - * Upload Employee File + * List Files in Bucket */ displayName: () => LocalizedString /** - * Upload a file to an employee + * List all files in a Cloud Storage bucket */ shortDesc: () => LocalizedString /** - * Uploads a new file to an employee record in BambooHR. The file will be placed in the specified category. + * Retrieves a list of files from a Firebase Cloud Storage bucket with support for filtering by prefix and pagination. Returns file metadata including paths, content types, sizes, and timestamps. Useful for browsing and managing stored files. */ longDesc: () => LocalizedString options: { - employee_id: { + project_id: { /** - * Employee ID + * Project ID */ displayName: () => LocalizedString /** - * The employee to upload the file to + * The Firebase project containing the bucket */ shortDesc: () => LocalizedString /** - * The ID of the employee to associate the file with. + * Select the Firebase project where the storage bucket exists. The project must have Firebase Cloud Storage enabled. */ longDesc: () => LocalizedString } - category: { + bucket: { /** - * Category + * Bucket */ displayName: () => LocalizedString /** - * File category + * Storage bucket to list files from */ shortDesc: () => LocalizedString /** - * The category to place the file in. Categories are configured in BambooHR. + * Select the Cloud Storage bucket whose files you want to list. The bucket must exist in the selected Firebase project. */ longDesc: () => LocalizedString } - file: { + prefix: { /** - * File + * Prefix */ displayName: () => LocalizedString /** - * The file to upload + * Optional prefix to filter files */ shortDesc: () => LocalizedString /** - * The file to upload. Must include name, MIME type, and base64-encoded content. + * Filter results to only include files whose paths start with this prefix. Useful for listing files in a specific directory or with a specific naming pattern. */ longDesc: () => LocalizedString } - share_with_employee: { + max_results: { /** - * Share with Employee + * Max Results */ displayName: () => LocalizedString /** - * Make file visible to employee + * Maximum number of files to return */ shortDesc: () => LocalizedString /** - * Whether to make this file visible to the employee in their self-service portal. + * Specify the maximum number of files to retrieve in a single request. Defaults to 100 if not specified. Use pagination for larger result sets. + */ + longDesc: () => LocalizedString + } + page_token: { + /** + * Page Token + */ + displayName: () => LocalizedString + /** + * Token for retrieving the next page + */ + shortDesc: () => LocalizedString + /** + * Provide the pagination token from a previous response to retrieve the next set of files. Leave empty for the first page. */ longDesc: () => LocalizedString } } } - update_employee_file: { - groups: { - /** - * Employee Files - */ - '0': () => LocalizedString - } + list_buckets: { /** - * Update Employee File + * List Buckets */ displayName: () => LocalizedString /** - * Update employee file metadata + * List all Cloud Storage buckets in a Firebase project */ shortDesc: () => LocalizedString /** - * Updates the metadata for an existing employee file, such as name, category, or sharing settings. + * Retrieves all Cloud Storage buckets configured for a Firebase project. Returns bucket details including names, locations, storage classes, creation dates, and update timestamps. Useful for bucket management and discovery. */ longDesc: () => LocalizedString options: { - employee_id: { - /** - * Employee ID - */ - displayName: () => LocalizedString - /** - * The employee who owns the file - */ - shortDesc: () => LocalizedString - /** - * The ID of the employee whose file you want to update. - */ - longDesc: () => LocalizedString - } - file_id: { + project_id: { /** - * File ID + * Project ID */ displayName: () => LocalizedString /** - * The file to update + * The Firebase project to query */ shortDesc: () => LocalizedString /** - * The ID of the file to update. + * Select the Firebase project whose storage buckets you want to list. The project must have Firebase Cloud Storage enabled. */ longDesc: () => LocalizedString } - name: { + } + } + delete_file: { + /** + * Delete File + */ + displayName: () => LocalizedString + /** + * Delete a file from Cloud Storage + */ + shortDesc: () => LocalizedString + /** + * Permanently removes a file from Firebase Cloud Storage. This operation is irreversible, so use with caution. Returns confirmation of the deletion including the file path and bucket name. + */ + longDesc: () => LocalizedString + options: { + project_id: { /** - * Name + * Project ID */ displayName: () => LocalizedString /** - * New file name + * The Firebase project containing the file */ shortDesc: () => LocalizedString /** - * The new name for the file. + * Select the Firebase project where the file is stored. The project must have Firebase Cloud Storage enabled. */ longDesc: () => LocalizedString } - category: { + bucket: { /** - * Category + * Bucket */ displayName: () => LocalizedString /** - * New category + * Storage bucket containing the file */ shortDesc: () => LocalizedString /** - * Move the file to a different category. + * Select the Cloud Storage bucket where the file to be deleted is located. The bucket must exist in the selected Firebase project. */ longDesc: () => LocalizedString } - share_with_employee: { + file_path: { /** - * Share with Employee + * File Path */ displayName: () => LocalizedString /** - * Update sharing setting + * Path to the file to delete */ shortDesc: () => LocalizedString /** - * Whether to make this file visible to the employee. + * Specify the full path to the file in the bucket that should be deleted, including the filename and any directory structure. This operation is permanent and cannot be undone. */ longDesc: () => LocalizedString } } } - delete_employee_file: { - groups: { - /** - * Employee Files - */ - '0': () => LocalizedString - } + } + triggers: { + new_user: { /** - * Delete Employee File + * New User */ displayName: () => LocalizedString /** - * Delete an employee file + * Triggers when a new user is created in Firebase Authentication */ shortDesc: () => LocalizedString /** - * Permanently deletes a file from an employee record. This action cannot be undone. + * Monitors Firebase Authentication for new user registrations and triggers when new accounts are created. Captures user details including email, display name, verification status, and authentication provider information. Useful for user onboarding workflows, welcome emails, and account setup automation. */ longDesc: () => LocalizedString options: { - employee_id: { - /** - * Employee ID - */ - displayName: () => LocalizedString - /** - * The employee who owns the file - */ - shortDesc: () => LocalizedString - /** - * The ID of the employee whose file you want to delete. - */ - longDesc: () => LocalizedString - } - file_id: { + project_id: { /** - * File ID + * Project ID */ displayName: () => LocalizedString /** - * The file to delete + * The Firebase project to monitor */ shortDesc: () => LocalizedString /** - * The ID of the file to delete. + * Select the Firebase project whose Authentication service you want to monitor for new user registrations. The project must have Firebase Authentication enabled. */ longDesc: () => LocalizedString } } } - get_all_company_files: { + } + } + Supabase: { + /** + * Supabase + */ + displayName: () => LocalizedString + groups: { + /** + * Databases & Backend Services + */ + '0': () => LocalizedString + } + /** + * Connect to Supabase to manage your database tables, storage buckets, and real-time data + */ + shortDesc: () => LocalizedString + /** + * The Supabase integration provides comprehensive access to your Supabase backend services. Manage database tables with full CRUD operations, monitor real-time changes with triggers, and handle file storage through buckets. Whether you need to query data, insert records, filter results, or track new entries, this integration streamlines your Supabase workflow automation and backend management. + */ + longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to Supabase + */ + title: () => LocalizedString + /** + * To connect to Supabase, you will need your **Project ID** (or Project URL) and a **service_role API Key**. + + ## Finding Your Project ID + + 1. Log in to the [Supabase Dashboard](https://supabase.com/dashboard) + 2. Select your project + 3. Go to **Project Settings** (gear icon) → **General** + 4. Find your **Reference ID** (this is your Project ID) + + Alternatively, your Project URL format is: `https://.supabase.co` + + ## Getting Your API Key + + 1. In your project dashboard, go to **Project Settings** → **API** + 2. Find the **Project API keys** section + 3. Copy the **service_role** key (labeled "secret") + + ⚠️ **Important**: Use the `service_role` key, NOT the `anon` key. The service_role key bypasses Row Level Security (RLS) and has full access to your database. + + ## Connection Details + + ### Project ID / Project URL + Either your project's Reference ID or the full project URL: + - Reference ID: `abcdefghijklmnop` + - Project URL: `https://abcdefghijklmnop.supabase.co` + + ### API Key (service_role) + The `service_role` secret key from your project's API settings. This key: + - Bypasses Row Level Security (RLS) + - Has full access to all database operations + - Should only be used server-side, never in client applications + + ## API Key Types + + | Key Type | Use Case | + |----------|----------| + | `anon` (public) | Client-side apps, respects RLS | + | `service_role` (secret) | Server-side operations, bypasses RLS | + + **Note:** The `service_role` key is extremely powerful and should be kept secure. Never expose it in client-side code or public repositories. For this integration, the service_role key is required to perform administrative operations. + */ + content: () => LocalizedString + } + actions: { + get_table: { groups: { /** - * Company Files + * Tables */ '0': () => LocalizedString } /** - * Get All Company Files + * Get Table */ displayName: () => LocalizedString /** - * List all company files + * Retrieve detailed schema information about a specific Supabase table */ shortDesc: () => LocalizedString /** - * Retrieves all company files organized by category. Returns file metadata including name, size, upload date, and sharing status. + * Fetches comprehensive metadata for a specific table including column definitions, data types, required fields, and descriptions. This action helps you understand the structure of your database tables. */ longDesc: () => LocalizedString options: { + tableName: { + /** + * Table Name + */ + displayName: () => LocalizedString + /** + * The name of the table to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select the Supabase table whose schema information you want to fetch. The table must exist in your Supabase project. + */ + longDesc: () => LocalizedString + } } } - download_company_file: { + list_tables: { groups: { /** - * Company Files + * Tables */ '0': () => LocalizedString } /** - * Download Company File + * List Tables */ displayName: () => LocalizedString /** - * Download a company file + * Get a list of all tables in your Supabase database */ shortDesc: () => LocalizedString /** - * Downloads a specific company file. Returns the file content as base64-encoded binary along with the MIME type. + * Retrieves all tables from your Supabase database with their basic metadata including column information and descriptions. Optionally include system tables in the results. */ longDesc: () => LocalizedString options: { - file_id: { + include_system_tables: { /** - * File ID + * Include System Tables */ displayName: () => LocalizedString /** - * The file to download + * Include internal Supabase system tables in the results */ shortDesc: () => LocalizedString /** - * The ID of the company file to download. + * When enabled, the response will include system tables (those starting with underscore). System tables contain Supabase internal data and are typically hidden from regular queries. */ longDesc: () => LocalizedString } } } - upload_company_file: { + create_row: { groups: { /** - * Company Files + * Rows */ '0': () => LocalizedString } /** - * Upload Company File + * Create Row */ displayName: () => LocalizedString /** - * Upload a company file + * Insert a new row into a Supabase table */ shortDesc: () => LocalizedString /** - * Uploads a new file to the company files in BambooHR. The file will be placed in the specified category. + * Creates a new record in the specified Supabase table. The action dynamically presents the table schema, allowing you to provide values for each column. Returns the newly created row with all its data. */ longDesc: () => LocalizedString options: { - category: { - /** - * Category - */ - displayName: () => LocalizedString - /** - * File category - */ - shortDesc: () => LocalizedString - /** - * The category to place the file in. Categories are configured in BambooHR. - */ - longDesc: () => LocalizedString - } - file: { + tableName: { /** - * File + * Table Name */ displayName: () => LocalizedString /** - * The file to upload + * The table where the row will be inserted */ shortDesc: () => LocalizedString /** - * The file to upload. Must include name, MIME type, and base64-encoded content. + * Select the target Supabase table for inserting the new row. The available fields will be dynamically loaded based on the selected table schema. */ longDesc: () => LocalizedString } - share_with_employees: { + values: { /** - * Share with Employees + * Row Values */ displayName: () => LocalizedString /** - * Make file visible to employees + * The data to insert into the new row */ shortDesc: () => LocalizedString /** - * Whether to make this file visible to all employees. + * Provide values for the table columns. The structure is dynamically generated based on the selected table schema, showing all available columns with their data types and constraints. */ longDesc: () => LocalizedString } } } - update_company_file: { + list_rows: { groups: { /** - * Company Files + * Rows */ '0': () => LocalizedString } /** - * Update Company File + * List Rows */ displayName: () => LocalizedString /** - * Update company file metadata + * Query and retrieve rows from a Supabase table */ shortDesc: () => LocalizedString /** - * Updates the metadata for an existing company file, such as name, category, or sharing settings. + * Fetches rows from a Supabase table with support for filtering, sorting, pagination, and ordering. Returns a list of records matching your query criteria along with total count information. */ longDesc: () => LocalizedString options: { - file_id: { + tableName: { /** - * File ID + * Table Name */ displayName: () => LocalizedString /** - * The file to update + * The table to query */ shortDesc: () => LocalizedString /** - * The ID of the company file to update. + * Select the Supabase table from which you want to retrieve rows. The available columns for filtering and ordering will be loaded based on this selection. */ longDesc: () => LocalizedString } - name: { + limit: { /** - * Name + * Limit */ displayName: () => LocalizedString /** - * New file name + * Maximum number of rows to return */ shortDesc: () => LocalizedString /** - * The new name for the file. + * Specify the maximum number of rows to retrieve in a single query. Useful for pagination and performance optimization. Defaults to 20 if not specified. */ longDesc: () => LocalizedString } - category: { + offset: { /** - * Category + * Offset */ displayName: () => LocalizedString /** - * New category + * Number of rows to skip */ shortDesc: () => LocalizedString /** - * Move the file to a different category. + * Skip this many rows before starting to return results. Used in combination with limit for pagination through large datasets. */ longDesc: () => LocalizedString } - share_with_employees: { + orderBy: { /** - * Share with Employees + * Order By */ displayName: () => LocalizedString /** - * Update sharing setting + * Sort the results by a specific column */ shortDesc: () => LocalizedString /** - * Whether to make this file visible to all employees. + * Define how to sort the retrieved rows by specifying a column and sort direction (ascending or descending). + */ + longDesc: () => LocalizedString + type: { + fields: { + column: { + /** + * Column + */ + displayName: () => LocalizedString + /** + * The column to sort by + */ + shortDesc: () => LocalizedString + /** + * Select the table column used for sorting the results. + */ + longDesc: () => LocalizedString + } + ascending: { + /** + * Ascending + */ + displayName: () => LocalizedString + /** + * Sort in ascending order + */ + shortDesc: () => LocalizedString + /** + * When enabled, sorts in ascending order (A-Z, 0-9, oldest first). When disabled, sorts in descending order (Z-A, 9-0, newest first). + */ + longDesc: () => LocalizedString + } + } + } + } + filter: { + /** + * Filter + */ + displayName: () => LocalizedString + /** + * Filter rows based on a condition + */ + shortDesc: () => LocalizedString + /** + * Apply a filter condition to retrieve only rows that match specific criteria. Supports various comparison operators for flexible querying. */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The column to filter on + */ + shortDesc: () => LocalizedString + /** + * Select the table column to apply the filter condition to. + */ + longDesc: () => LocalizedString + } + operator: { + /** + * Operator + */ + displayName: () => LocalizedString + /** + * The comparison operator + */ + shortDesc: () => LocalizedString + /** + * Choose the comparison operator for the filter (equals, greater than, contains, etc.). + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * The value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the column against using the selected operator. For "in" operator, provide comma-separated values. + */ + longDesc: () => LocalizedString + } + } + } } } } - delete_company_file: { + delete_rows: { groups: { /** - * Company Files + * Rows */ '0': () => LocalizedString } /** - * Delete Company File + * Delete Rows */ displayName: () => LocalizedString /** - * Delete a company file + * Delete rows from a Supabase table based on a filter */ shortDesc: () => LocalizedString /** - * Permanently deletes a company file. This action cannot be undone. + * Removes rows from a Supabase table that match the specified filter criteria. Returns the count of deleted rows and their data. Use with caution as this operation is irreversible. */ longDesc: () => LocalizedString options: { - file_id: { + tableName: { /** - * File ID + * Table Name */ displayName: () => LocalizedString /** - * The file to delete + * The table to delete rows from */ shortDesc: () => LocalizedString /** - * The ID of the company file to delete. + * Select the Supabase table from which you want to delete rows. Ensure you have proper permissions for delete operations on this table. + */ + longDesc: () => LocalizedString + } + filter: { + /** + * Filter + */ + displayName: () => LocalizedString + /** + * Condition to identify rows to delete + */ + shortDesc: () => LocalizedString + /** + * Define the filter criteria to identify which rows should be deleted. Only rows matching this condition will be removed from the table. */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The column to filter on + */ + shortDesc: () => LocalizedString + /** + * Select the table column to use for identifying rows to delete. + */ + longDesc: () => LocalizedString + } + operator: { + /** + * Operator + */ + displayName: () => LocalizedString + /** + * The comparison operator + */ + shortDesc: () => LocalizedString + /** + * Choose the comparison operator for the delete filter condition. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * The value to match + */ + shortDesc: () => LocalizedString + /** + * The value to compare against. Rows matching this condition will be deleted. + */ + longDesc: () => LocalizedString + } + } + } } } } - } - expressions: { - '&&': { - /** - * And - */ - displayName: () => LocalizedString - /** - * Logical AND operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where all must be true - */ - longDesc: () => LocalizedString - } - '||': { - /** - * Or - */ - displayName: () => LocalizedString - /** - * Logical OR operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where at least one must be true - */ - longDesc: () => LocalizedString - } - '==': { - /** - * Equals - */ - displayName: () => LocalizedString - /** - * Field equals value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field equals the specified value - */ - longDesc: () => LocalizedString - } - '!=': { - /** - * Not Equals - */ - displayName: () => LocalizedString - /** - * Field does not equal value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field does not equal the specified value - */ - longDesc: () => LocalizedString - } - '>': { - /** - * Greater Than - */ - displayName: () => LocalizedString - /** - * Field is greater than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than the specified value - */ - longDesc: () => LocalizedString - } - '>=': { - /** - * Greater Than or Equal - */ - displayName: () => LocalizedString - /** - * Field is greater than or equal to value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than or equal to the specified value - */ - longDesc: () => LocalizedString - } - '<': { - /** - * Less Than - */ - displayName: () => LocalizedString - /** - * Field is less than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is less than the specified value - */ - longDesc: () => LocalizedString - } - '<=': { + upsert_row: { + groups: { + /** + * Rows + */ + '0': () => LocalizedString + } /** - * Less Than or Equal + * Upsert Row */ displayName: () => LocalizedString /** - * Field is less than or equal to value + * Insert a new row or update an existing one */ shortDesc: () => LocalizedString /** - * Matches records where the field value is less than or equal to the specified value + * Performs an upsert operation (insert or update) on a Supabase table. If a row with the specified unique constraint exists, it will be updated; otherwise, a new row is inserted. */ longDesc: () => LocalizedString + options: { + tableName: { + /** + * Table Name + */ + displayName: () => LocalizedString + /** + * The table for the upsert operation + */ + shortDesc: () => LocalizedString + /** + * Select the target Supabase table. The available fields will be dynamically loaded based on the table schema. + */ + longDesc: () => LocalizedString + } + values: { + /** + * Row Values + */ + displayName: () => LocalizedString + /** + * The data to upsert + */ + shortDesc: () => LocalizedString + /** + * Provide values for the table columns. If a row with matching unique constraints exists, these values will update it; otherwise, a new row is created. + */ + longDesc: () => LocalizedString + } + onConflict: { + /** + * On Conflict + */ + displayName: () => LocalizedString + /** + * The column(s) used to detect conflicts + */ + shortDesc: () => LocalizedString + /** + * Specify the column or comma-separated list of columns that should be used to detect conflicts. If not specified, uses the table's primary key. + */ + longDesc: () => LocalizedString + } + ignoreDuplicates: { + /** + * Ignore Duplicates + */ + displayName: () => LocalizedString + /** + * Skip the operation if a duplicate exists + */ + shortDesc: () => LocalizedString + /** + * When enabled, if a conflicting row exists, the operation is silently ignored. When disabled (default), conflicting rows are updated with the new values. + */ + longDesc: () => LocalizedString + } + } } - contains: { + create_bucket: { + groups: { + /** + * Storage + */ + '0': () => LocalizedString + } /** - * Contains + * Create Storage Bucket */ displayName: () => LocalizedString /** - * Field contains value + * Create a new storage bucket in Supabase */ shortDesc: () => LocalizedString /** - * Matches records where the field contains the specified text (case-insensitive) + * Creates a new storage bucket in Supabase Storage for organizing and storing files. Configure access permissions, file size limits, and allowed MIME types. */ longDesc: () => LocalizedString + options: { + name: { + /** + * Bucket Name + */ + displayName: () => LocalizedString + /** + * The name for the new bucket + */ + shortDesc: () => LocalizedString + /** + * Specify a unique name for the storage bucket. The name must be URL-safe and unique within your Supabase project. + */ + longDesc: () => LocalizedString + } + public_access: { + /** + * Public Access + */ + displayName: () => LocalizedString + /** + * Allow public access to bucket contents + */ + shortDesc: () => LocalizedString + /** + * When enabled, files in this bucket can be accessed publicly without authentication. When disabled (default), files require authentication to access. + */ + longDesc: () => LocalizedString + } + file_size_limit: { + /** + * File Size Limit + */ + displayName: () => LocalizedString + /** + * Maximum file size in bytes + */ + shortDesc: () => LocalizedString + /** + * Set the maximum file size that can be uploaded to this bucket, specified in bytes. Leave empty for no limit. + */ + longDesc: () => LocalizedString + } + allowed_mime_types: { + /** + * Allowed MIME Types + */ + displayName: () => LocalizedString + /** + * List of allowed file MIME types + */ + shortDesc: () => LocalizedString + /** + * Specify which file types can be uploaded to this bucket by providing a list of MIME types (e.g., image/png, application/pdf). Leave empty to allow all file types. + */ + longDesc: () => LocalizedString + } + } } - 'is-set': { + list_buckets: { + groups: { + /** + * Storage + */ + '0': () => LocalizedString + } /** - * Is Set + * List Storage Buckets */ displayName: () => LocalizedString /** - * Field has a value + * Get all storage buckets in your Supabase project */ shortDesc: () => LocalizedString /** - * Matches records where the field has a value (is not empty) + * Retrieves a list of all storage buckets in your Supabase project with their configurations including access permissions, file size limits, and allowed MIME types. */ longDesc: () => LocalizedString } - 'is-not-set': { + get_bucket: { + groups: { + /** + * Storage + */ + '0': () => LocalizedString + } /** - * Is Not Set + * Get Storage Bucket */ displayName: () => LocalizedString /** - * Field has no value + * Retrieve details of a specific storage bucket */ shortDesc: () => LocalizedString /** - * Matches records where the field has no value (is empty) + * Fetches detailed information about a specific Supabase storage bucket including its configuration, creation date, access permissions, and file restrictions. */ longDesc: () => LocalizedString + options: { + bucket_id: { + /** + * Bucket ID + */ + displayName: () => LocalizedString + /** + * The ID of the bucket to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select the storage bucket whose details you want to fetch from your Supabase project. + */ + longDesc: () => LocalizedString + } + } } } triggers: { - new_time_off_request: { + new_table_row: { /** - * New Time Off Request + * New Table Row */ displayName: () => LocalizedString /** - * Triggers when a new time off request is submitted + * Triggers when a new row is added to a Supabase table */ shortDesc: () => LocalizedString /** - * Fires when a new time off request is created in BambooHR with status "requested". Useful for building approval workflows or notifications. + * Monitors a Supabase table for new rows and triggers when new records are inserted. Supports optional filtering to trigger only for rows matching specific criteria. */ longDesc: () => LocalizedString options: { - employee_id: { + tableName: { /** - * Employee ID + * Table Name */ displayName: () => LocalizedString /** - * Filter by employee + * The table to monitor for new rows */ shortDesc: () => LocalizedString /** - * Only trigger for time off requests from a specific employee. + * Select the Supabase table you want to monitor. The trigger will fire whenever new rows are inserted into this table. + */ + longDesc: () => LocalizedString + } + filter: { + /** + * Filter + */ + displayName: () => LocalizedString + /** + * Optional condition to filter new rows + */ + shortDesc: () => LocalizedString + /** + * Apply a filter to trigger only for new rows matching specific criteria. Leave empty to trigger for all new rows. */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The column to filter on + */ + shortDesc: () => LocalizedString + /** + * Select the table column to apply the filter condition to. + */ + longDesc: () => LocalizedString + } + operator: { + /** + * Operator + */ + displayName: () => LocalizedString + /** + * The comparison operator + */ + shortDesc: () => LocalizedString + /** + * Choose the comparison operator for filtering new rows. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * The value to match + */ + shortDesc: () => LocalizedString + /** + * The value to compare against. Only new rows matching this condition will trigger the event. + */ + longDesc: () => LocalizedString + } + } + } } } } - new_time_off: { + } + expressions: { + '&&': { /** - * New Time Off + * and (&&) */ displayName: () => LocalizedString /** - * Triggers when new approved time off appears + * Returns True if all arguments are True */ shortDesc: () => LocalizedString /** - * Fires when a new approved time off entry appears in the Who's Out list. This includes both employee time off and company holidays. + * Returns `True` if all arguments are `True` with logic short-circuiting */ longDesc: () => LocalizedString - options: { + args: { + '0': { + /** + * Condition + */ + displayName: () => LocalizedString + /** + * Boolean condition to evaluate + */ + shortDesc: () => LocalizedString + /** + * A boolean expression or condition that evaluates to True or False + */ + longDesc: () => LocalizedString + } } } - new_employee: { + '||': { /** - * New Employee + * or (||) */ displayName: () => LocalizedString /** - * Triggers when a new employee is created + * Returns True if any argument is True */ shortDesc: () => LocalizedString /** - * Fires when a new active employee is added to BambooHR. Returns basic employee information including name, email, department, and job title. + * Returns `True` if any argument is `True` with logic short-circuiting */ longDesc: () => LocalizedString - options: { + args: { + '0': { + /** + * Condition + */ + displayName: () => LocalizedString + /** + * Boolean condition to evaluate + */ + shortDesc: () => LocalizedString + /** + * A boolean expression or condition that evaluates to True or False + */ + longDesc: () => LocalizedString + } } } - } - } - Baserow: { - /** - * Baserow - */ - displayName: () => LocalizedString - groups: { - /** - * Spreadsheets & Data Tables - */ - '0': () => LocalizedString - /** - * Databases & Backend Services - */ - '1': () => LocalizedString - } - /** - * Connect to Baserow to manage your database tables, rows, and files with powerful automation - */ - shortDesc: () => LocalizedString - /** - * The Baserow integration provides comprehensive access to your Baserow database operations. Create, read, update, and delete rows in your tables, upload files, and monitor new entries with real-time triggers. Whether you need to manage data, filter results, or track new records, this integration streamlines your Baserow workflow automation and database management. - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to Baserow - */ - title: () => LocalizedString - /** - * To connect to Baserow, you will need your **Baserow URL** and a **Database Token**. - - ## Getting Your Database Token - - 1. Log in to your Baserow instance - 2. Click on your **profile icon** in the top right corner - 3. Select **Settings** from the dropdown menu - 4. Navigate to **Database tokens** in the left sidebar - 5. Click **Create token** - 6. Give your token a descriptive name (e.g., "Qore Integration") - 7. Select the **workspace** the token should have access to - 8. Configure **table-level permissions** (create, read, update, delete) as needed - 9. Click **Create token** and copy the generated token - - ## Connection Details - - ### Baserow URL - The base URL of your Baserow instance: - - **Baserow Cloud**: Use `https://api.baserow.io` - - **Self-hosted**: Use your instance URL (e.g., `https://baserow.yourcompany.com`) - - ### Database Token - Your database token that grants access to specific workspaces and tables. Tokens are scoped to a single workspace with granular table-level permissions. - - **Note:** Database tokens provide more granular control than API tokens. Each token can be restricted to specific operations (create, read, update, delete) on individual tables within a workspace. - */ - content: () => LocalizedString - } - actions: { - create_row: { + NOT: { /** - * Create Row + * not (!) */ displayName: () => LocalizedString /** - * Insert a new row into a Baserow table + * Logical negation */ shortDesc: () => LocalizedString /** - * Creates a new record in the specified Baserow table. The action dynamically presents the table schema, allowing you to provide values for each column. Optionally specify a row ID to insert the new row before it. Returns the newly created row with all its data. + * Returns the logical negation of the argument */ longDesc: () => LocalizedString - options: { - table: { + args: { + '0': { /** - * Table + * Condition */ displayName: () => LocalizedString /** - * The table where the row will be inserted + * Boolean condition to negate */ shortDesc: () => LocalizedString /** - * Select the target Baserow table for inserting the new row. The available fields will be dynamically loaded based on the selected table schema. + * A boolean expression or condition to negate */ longDesc: () => LocalizedString } - data: { + } + } + '==': { + /** + * equals (==) + */ + displayName: () => LocalizedString + /** + * Equality comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value equals the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Row Data + * Field */ displayName: () => LocalizedString /** - * The data to insert into the new row + * Field to compare */ shortDesc: () => LocalizedString /** - * Provide values for the table columns. The structure is dynamically generated based on the selected table schema, showing all available columns with their data types and constraints. + * The field whose value will be compared */ longDesc: () => LocalizedString } - before_row_id: { + '1': { /** - * Before Row ID + * Value */ displayName: () => LocalizedString /** - * Insert the new row before this row + * Value to compare against */ shortDesc: () => LocalizedString /** - * Optionally specify a row ID to insert the new row before it in the table order. Leave empty to append the row at the end. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - delete_row: { + '!=': { /** - * Delete Row + * not equals (!=) */ displayName: () => LocalizedString /** - * Delete a specific row from a Baserow table + * Inequality comparison */ shortDesc: () => LocalizedString /** - * Removes a single row from a Baserow table by its ID. Use with caution as this operation is irreversible and permanently deletes the specified row. + * Returns `True` if the field value does not equal the specified value */ longDesc: () => LocalizedString - options: { - table: { + args: { + '0': { /** - * Table + * Field */ displayName: () => LocalizedString /** - * The table to delete the row from + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Baserow table from which you want to delete a row. Ensure you have proper permissions for delete operations on this table. + * The field whose value will be compared */ longDesc: () => LocalizedString } - row: { + '1': { /** - * Row + * Value */ displayName: () => LocalizedString /** - * The row to delete + * Value to compare against */ shortDesc: () => LocalizedString /** - * Select the specific row to delete from the table by its ID. This row will be permanently removed. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - get_table_row: { + '>': { /** - * Get Table Row + * greater than (>) */ displayName: () => LocalizedString /** - * Retrieve a specific row from a Baserow table + * Greater than comparison */ shortDesc: () => LocalizedString /** - * Fetches detailed data for a single row in a Baserow table by its ID. Returns all column values for the specified row with dynamically loaded field types. + * Returns `True` if the field value is greater than the specified value */ longDesc: () => LocalizedString - options: { - table: { + args: { + '0': { /** - * Table + * Field */ displayName: () => LocalizedString /** - * The table to retrieve the row from + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Baserow table from which you want to retrieve a row. The available rows will be loaded based on this selection. + * The field whose value will be compared */ longDesc: () => LocalizedString } - row: { + '1': { /** - * Row + * Value */ displayName: () => LocalizedString /** - * The row to retrieve + * Value to compare against */ shortDesc: () => LocalizedString /** - * Select the specific row to retrieve from the table by its ID. All data for this row will be returned. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - get_table_fields: { + '>=': { /** - * Get Table Fields + * greater than or equal (>=) */ displayName: () => LocalizedString /** - * Retrieve all field definitions from a Baserow table + * Greater than or equal comparison */ shortDesc: () => LocalizedString /** - * Fetches comprehensive metadata for all fields in a specific Baserow table including field types, order, descriptions, default values, and properties. This action helps you understand the structure and configuration of your database tables. + * Returns `True` if the field value is greater than or equal to the specified value */ longDesc: () => LocalizedString - options: { - table: { + args: { + '0': { /** - * Table + * Field */ displayName: () => LocalizedString /** - * The table to retrieve fields from + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Baserow table whose field definitions you want to fetch. All fields and their configurations will be returned. + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against */ longDesc: () => LocalizedString } } } - list_rows: { + '<': { /** - * List Rows + * less than (<) */ displayName: () => LocalizedString /** - * Query and retrieve rows from a Baserow table + * Less than comparison */ shortDesc: () => LocalizedString /** - * Fetches rows from a Baserow table with support for filtering, sorting, pagination, and search. Returns a list of records matching your query criteria along with total count and pagination information. + * Returns `True` if the field value is less than the specified value */ longDesc: () => LocalizedString - options: { - table: { + args: { + '0': { /** - * Table + * Field */ displayName: () => LocalizedString /** - * The table to query + * Field to compare */ shortDesc: () => LocalizedString /** - * Select the Baserow table from which you want to retrieve rows. The available columns for filtering and ordering will be loaded based on this selection. + * The field whose value will be compared */ longDesc: () => LocalizedString } - page: { + '1': { /** - * Page + * Value */ displayName: () => LocalizedString /** - * Page number for pagination + * Value to compare against */ shortDesc: () => LocalizedString /** - * Specify which page of results to retrieve. Used in combination with size for pagination through large datasets. Defaults to page 1. + * The value to compare the field against */ longDesc: () => LocalizedString } - size: { + } + } + '<=': { + /** + * less than or equal (<=) + */ + displayName: () => LocalizedString + /** + * Less than or equal comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is less than or equal to the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Size + * Field */ displayName: () => LocalizedString /** - * Number of rows per page + * Field to compare */ shortDesc: () => LocalizedString /** - * Specify the maximum number of rows to retrieve per page. Defaults to 100 rows if not specified. + * The field whose value will be compared */ longDesc: () => LocalizedString } - search: { + '1': { /** - * Search + * Value */ displayName: () => LocalizedString /** - * Search term to filter rows + * Value to compare against */ shortDesc: () => LocalizedString /** - * Provide a search term to filter rows across all text fields in the table. Only rows containing this term will be returned. + * The value to compare the field against */ longDesc: () => LocalizedString } - order: { + } + } + like: { + /** + * like + */ + displayName: () => LocalizedString + /** + * Pattern matching (case-sensitive) + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field matches the pattern with % as wildcard + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Order + * Field */ displayName: () => LocalizedString /** - * Sort the results by a specific field + * Text field to match */ shortDesc: () => LocalizedString /** - * Define how to sort the retrieved rows by specifying a field and sort direction (ascending or descending). + * The text field to match against the pattern */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to sort by - */ - shortDesc: () => LocalizedString - /** - * Select the table field used for sorting the results. - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * Choose ascending (+) to sort from lowest to highest, or descending (-) to sort from highest to lowest. - */ - longDesc: () => LocalizedString - } - } - } } - filter: { + '1': { /** - * Filter + * Pattern */ displayName: () => LocalizedString /** - * Filter rows based on conditions + * Pattern to match */ shortDesc: () => LocalizedString /** - * Apply multiple filter conditions to retrieve only rows that match specific criteria. Supports various comparison operators and logical combinations. + * The pattern to match with (use % as wildcard, e.g., "%example%") */ longDesc: () => LocalizedString - type: { - fields: { - filters: { - /** - * Filters - */ - displayName: () => LocalizedString - /** - * List of filter conditions - */ - shortDesc: () => LocalizedString - /** - * Define one or more filter conditions. Each condition specifies a field, operator, and value to match against. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - type: { - /** - * Type - */ - displayName: () => LocalizedString - /** - * The comparison operator - */ - shortDesc: () => LocalizedString - /** - * Choose the comparison operator for this filter condition (equal, contains, empty, etc.). - */ - longDesc: () => LocalizedString - } - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to filter on - */ - shortDesc: () => LocalizedString - /** - * Select the table field to apply this filter condition to. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against using the selected operator. - */ - longDesc: () => LocalizedString - } - } - } - } - } - filter_type: { - /** - * Filter Type - */ - displayName: () => LocalizedString - /** - * Logical operator for combining filters - */ - shortDesc: () => LocalizedString - /** - * Choose AND to require all filter conditions to match, or OR to match any filter condition. - */ - longDesc: () => LocalizedString - } - } - } } } } - list_tables: { - /** - * List Tables - */ - displayName: () => LocalizedString - /** - * Get all tables in your Baserow database - */ - shortDesc: () => LocalizedString - /** - * Retrieves a list of all tables from your Baserow database with their basic metadata including table IDs, names, order, and associated database IDs. - */ - longDesc: () => LocalizedString - } - update_row: { + ilike: { /** - * Update Row + * ilike */ displayName: () => LocalizedString /** - * Update an existing row in a Baserow table + * Pattern matching (case-insensitive) */ shortDesc: () => LocalizedString /** - * Updates the values of an existing row in a Baserow table. The action dynamically presents the table schema, allowing you to modify values for each column. Returns the updated row with all its current data. + * Returns `True` if the field matches the pattern (case-insensitive) with % as wildcard */ longDesc: () => LocalizedString - options: { - table: { + args: { + '0': { /** - * Table + * Field */ displayName: () => LocalizedString /** - * The table containing the row to update + * Text field to match */ shortDesc: () => LocalizedString /** - * Select the Baserow table containing the row you want to update. The available fields will be dynamically loaded based on the table schema. + * The text field to match against the pattern */ longDesc: () => LocalizedString } - row: { + '1': { /** - * Row + * Pattern */ displayName: () => LocalizedString /** - * The row to update + * Pattern to match */ shortDesc: () => LocalizedString /** - * Select the specific row to update by its ID. The current values of this row will be modified. - */ - longDesc: () => LocalizedString - } - data: { - /** - * Row Data - */ - displayName: () => LocalizedString - /** - * The new data for the row - */ - shortDesc: () => LocalizedString - /** - * Provide new values for the table columns you want to update. The structure is dynamically generated based on the selected table schema. + * The pattern to match with, case-insensitive (use % as wildcard, e.g., "%example%") */ longDesc: () => LocalizedString } } } - upload_file: { + 'in': { /** - * Upload File + * in */ displayName: () => LocalizedString /** - * Upload a file to Baserow storage + * In list */ shortDesc: () => LocalizedString /** - * Uploads a file to Baserow's file storage system. Returns the uploaded file's metadata including URL, size, MIME type, and generated thumbnails for images. The uploaded file can then be referenced in file fields within your tables. + * Returns `True` if the field value is in the provided list */ longDesc: () => LocalizedString - options: { - file: { + args: { + '0': { /** - * File + * Field */ displayName: () => LocalizedString /** - * The file to upload + * Field to check */ shortDesc: () => LocalizedString /** - * Select or provide the file to upload to Baserow storage. The file will be stored and available for use in file fields. + * The field whose value will be checked + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Values + */ + displayName: () => LocalizedString + /** + * List of values + */ + shortDesc: () => LocalizedString + /** + * The list of values to check the field against */ longDesc: () => LocalizedString } } } - } - triggers: { - new_document: { + contains: { /** - * New Row + * contains (@>) */ displayName: () => LocalizedString /** - * Triggers when a new row is added to a Baserow table + * Array contains elements */ shortDesc: () => LocalizedString /** - * Monitors a Baserow table for new rows and triggers when new records are inserted. Supports optional filtering and search to trigger only for rows matching specific criteria. + * Returns `True` if the array field contains all the specified elements */ longDesc: () => LocalizedString - options: { - table: { - /** - * Table - */ - displayName: () => LocalizedString - /** - * The table to monitor for new rows - */ - shortDesc: () => LocalizedString - /** - * Select the Baserow table you want to monitor. The trigger will fire whenever new rows are inserted into this table. - */ - longDesc: () => LocalizedString - } - search: { + args: { + '0': { /** - * Search + * Field */ displayName: () => LocalizedString /** - * Optional search term to filter new rows + * Array field to check */ shortDesc: () => LocalizedString /** - * Provide a search term to trigger only for new rows that contain this term in any text field. Leave empty to trigger for all new rows. + * The array field to check for contained elements */ longDesc: () => LocalizedString } - filter: { + '1': { /** - * Filter + * Elements */ displayName: () => LocalizedString /** - * Optional conditions to filter new rows + * Elements to find */ shortDesc: () => LocalizedString /** - * Apply filter conditions to trigger only for new rows matching specific criteria. Leave empty to trigger for all new rows. + * The list of elements that should be contained in the array */ longDesc: () => LocalizedString - type: { - fields: { - filters: { - /** - * Filters - */ - displayName: () => LocalizedString - /** - * List of filter conditions - */ - shortDesc: () => LocalizedString - /** - * Define one or more filter conditions. Only new rows matching these conditions will trigger the event. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - type: { - /** - * Type - */ - displayName: () => LocalizedString - /** - * The comparison operator - */ - shortDesc: () => LocalizedString - /** - * Choose the comparison operator for this filter condition. - */ - longDesc: () => LocalizedString - } - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to filter on - */ - shortDesc: () => LocalizedString - /** - * Select the table field to apply this filter condition to. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value to match - */ - shortDesc: () => LocalizedString - /** - * The value to compare against. Only new rows matching this condition will trigger the event. - */ - longDesc: () => LocalizedString - } - } - } - } - } - filter_type: { - /** - * Filter Type - */ - displayName: () => LocalizedString - /** - * Logical operator for combining filters - */ - shortDesc: () => LocalizedString - /** - * Choose AND to require all filter conditions to match, or OR to match any filter condition. - */ - longDesc: () => LocalizedString - } - } - } } } } @@ -145005,1547 +145704,1929 @@ export type TranslationFunctions = { } } } - } - expressions: { - '&&': { + limit: { /** - * and (&&) + * Limit */ displayName: () => LocalizedString /** - * Returns True if all arguments are True + * Maximum number of records to return */ shortDesc: () => LocalizedString /** - * Returns `True` if all arguments are `True` with logic short-circuiting + * Set the maximum total number of records to retrieve from the search */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Condition - */ - displayName: () => LocalizedString - /** - * Boolean condition to evaluate - */ - shortDesc: () => LocalizedString - /** - * A boolean expression or condition that evaluates to True or False - */ - longDesc: () => LocalizedString - } - } } - '||': { - /** - * or (||) - */ - displayName: () => LocalizedString - /** - * Returns True if any argument is True - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if any argument is `True` with logic short-circuiting - */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Condition - */ - displayName: () => LocalizedString - /** - * Boolean condition to evaluate - */ - shortDesc: () => LocalizedString - /** - * A boolean expression or condition that evaluates to True or False - */ - longDesc: () => LocalizedString - } + } + } + BambooHR: { + /** + * BambooHR + */ + displayName: () => LocalizedString + groups: { + /** + * HR & People Management + */ + '0': () => LocalizedString + } + /** + * Connect to BambooHR to manage employee data with powerful automation + */ + shortDesc: () => LocalizedString + /** + * The BambooHR integration provides comprehensive access to your HR operations. Create, read, update, and list employees with dynamic field support. The integration automatically discovers available fields in your BambooHR account, including custom fields, and provides intelligent type handling for dates, lists, and other field types. + */ + longDesc: () => LocalizedString + actions: { + get_employee: { + groups: { + /** + * Employees + */ + '0': () => LocalizedString } - } - '==': { /** - * equal (==) + * Get Employee */ displayName: () => LocalizedString /** - * Equality comparison + * Retrieve a single employee by ID */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value equals the specified value + * Fetches detailed data for a single employee in BambooHR by their ID. Returns all requested fields with dynamically loaded field types. You can specify which fields to retrieve or fetch all available fields. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + employee_id: { /** - * Field + * Employee ID */ displayName: () => LocalizedString /** - * Field to compare + * The ID of the employee to retrieve */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Enter the unique identifier of the employee you want to fetch. Use 0 to retrieve the employee associated with your API key. */ longDesc: () => LocalizedString } - '1': { + fields: { /** - * Value + * Fields */ displayName: () => LocalizedString /** - * Value to compare against + * Specific fields to retrieve */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Select which fields to retrieve for the employee. Leave empty to retrieve all available fields (up to 400 fields). */ longDesc: () => LocalizedString } } } - '!=': { + create_employee: { + groups: { + /** + * Employees + */ + '0': () => LocalizedString + } /** - * not equal (!=) + * Create Employee */ displayName: () => LocalizedString /** - * Inequality comparison + * Create a new employee in BambooHR */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value does not equal the specified value + * Creates a new employee record in BambooHR. At minimum, firstName and lastName are required. The action dynamically presents all available fields based on your BambooHR configuration, including custom fields. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { + options: { + employee_data: { /** - * Value + * Employee Data */ displayName: () => LocalizedString /** - * Value to compare against + * The data for the new employee */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Provide values for the employee fields. The available fields are dynamically loaded from your BambooHR account and include both standard and custom fields. firstName and lastName are required. */ longDesc: () => LocalizedString } } } - '>': { + update_employee: { + groups: { + /** + * Employees + */ + '0': () => LocalizedString + } /** - * higher than (>) + * Update Employee */ displayName: () => LocalizedString /** - * Greater than comparison + * Update an existing employee in BambooHR */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is greater than the specified number + * Updates an existing employee record in BambooHR. The action dynamically presents all available fields based on your BambooHR configuration. Only provide the fields you want to update. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + employee_id: { /** - * Field + * Employee ID */ displayName: () => LocalizedString /** - * Numeric field to compare + * The ID of the employee to update */ shortDesc: () => LocalizedString /** - * The numeric field whose value will be compared + * Enter the unique identifier of the employee you want to update. */ longDesc: () => LocalizedString } - '1': { + employee_data: { /** - * Number + * Employee Data */ displayName: () => LocalizedString /** - * Number to compare against + * The data to update */ shortDesc: () => LocalizedString /** - * The numeric value to compare the field against + * Provide new values for the employee fields you want to update. The available fields are dynamically loaded from your BambooHR account. */ longDesc: () => LocalizedString } } } - '>=': { + list_employees: { + groups: { + /** + * Employees + */ + '0': () => LocalizedString + } /** - * higher than or equal (>=) + * List Employees */ displayName: () => LocalizedString /** - * Greater than or equal comparison + * Retrieve a list of all employees */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is greater than or equal to the specified number + * Fetches a list of all employees from BambooHR. You can specify which fields to retrieve for each employee. Uses the custom report endpoint for efficient bulk retrieval. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Numeric field to compare - */ - shortDesc: () => LocalizedString - /** - * The numeric field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { + options: { + fields: { /** - * Number + * Fields */ displayName: () => LocalizedString /** - * Number to compare against + * Specific fields to retrieve for each employee */ shortDesc: () => LocalizedString /** - * The numeric value to compare the field against + * Select which fields to retrieve for each employee. Leave empty to retrieve a default set of common fields (id, name, email, department, job title). */ longDesc: () => LocalizedString } } } - '<': { + get_whos_out: { + groups: { + /** + * Time Off + */ + '0': () => LocalizedString + } /** - * lower than (<) + * Get Who's Out */ displayName: () => LocalizedString /** - * Less than comparison + * Get a summary of employees who are out */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is less than the specified number + * Retrieves a list of employees who are out (vacation, sick leave, etc.) and company holidays for a given date range. If no dates are specified, returns the current day plus the next 14 days. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + start_date: { /** - * Field + * Start Date */ displayName: () => LocalizedString /** - * Numeric field to compare + * Start of the date range */ shortDesc: () => LocalizedString /** - * The numeric field whose value will be compared + * The start date for the query. Defaults to today if not specified. */ longDesc: () => LocalizedString } - '1': { + end_date: { /** - * Number + * End Date */ displayName: () => LocalizedString /** - * Number to compare against + * End of the date range */ shortDesc: () => LocalizedString /** - * The numeric value to compare the field against + * The end date for the query. Defaults to 14 days from the start date if not specified. */ longDesc: () => LocalizedString } } } - '<=': { + search_time_off_requests: { + groups: { + /** + * Time Off + */ + '0': () => LocalizedString + } /** - * lower than or equal (<=) + * Search Time Off Requests */ displayName: () => LocalizedString /** - * Less than or equal comparison + * Search and filter time off requests */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is less than or equal to the specified number + * Searches time off requests in BambooHR with various filters. Returns requests matching the specified criteria including date range, employee, status, and time off type. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + start_date: { /** - * Field + * Start Date */ displayName: () => LocalizedString /** - * Numeric field to compare + * Filter by start date */ shortDesc: () => LocalizedString /** - * The numeric field whose value will be compared + * Only show time off requests on or after this date. */ longDesc: () => LocalizedString } - '1': { + end_date: { /** - * Number + * End Date */ displayName: () => LocalizedString /** - * Number to compare against + * Filter by end date */ shortDesc: () => LocalizedString /** - * The numeric value to compare the field against + * Only show time off requests on or before this date. */ longDesc: () => LocalizedString } - } - } - contains: { - /** - * contains - */ - displayName: () => LocalizedString - /** - * Contains text - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field contains the specified text - */ - longDesc: () => LocalizedString - args: { - '0': { + employee_id: { /** - * Field + * Employee ID */ displayName: () => LocalizedString /** - * Text field to search + * Filter by employee */ shortDesc: () => LocalizedString /** - * The text field to search within + * Limit results to a specific employee by their ID. */ longDesc: () => LocalizedString } - '1': { + status: { /** - * Text + * Status */ displayName: () => LocalizedString /** - * Text to search for + * Filter by request status */ shortDesc: () => LocalizedString /** - * The text string to search for within the field + * Filter by one or more statuses: approved, denied, requested, canceled, superceded. + */ + longDesc: () => LocalizedString + } + type: { + /** + * Time Off Type + */ + displayName: () => LocalizedString + /** + * Filter by time off type + */ + shortDesc: () => LocalizedString + /** + * Filter by one or more time off types configured in your BambooHR account. */ longDesc: () => LocalizedString } } } - 'contains-not': { + get_all_employee_files: { + groups: { + /** + * Employee Files + */ + '0': () => LocalizedString + } /** - * doesn't contain + * Get All Employee Files */ displayName: () => LocalizedString /** - * Does not contain text + * List all files for an employee */ shortDesc: () => LocalizedString /** - * Returns `True` if the field does not contain the specified text + * Retrieves all files associated with a specific employee, organized by category. Returns file metadata including name, size, upload date, and sharing status. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Text field to search - */ - shortDesc: () => LocalizedString - /** - * The text field to search within - */ - longDesc: () => LocalizedString - } - '1': { + options: { + employee_id: { /** - * Text + * Employee ID */ displayName: () => LocalizedString /** - * Text to exclude + * The employee to get files for */ shortDesc: () => LocalizedString /** - * The text string that should not be present in the field + * The ID of the employee whose files you want to retrieve. */ longDesc: () => LocalizedString } } } - 'contains-word': { + download_employee_file: { + groups: { + /** + * Employee Files + */ + '0': () => LocalizedString + } /** - * contains word + * Download Employee File */ displayName: () => LocalizedString /** - * Contains whole word + * Download an employee file */ shortDesc: () => LocalizedString /** - * Returns `True` if the field contains the specified word as a complete word + * Downloads a specific file from an employee record. Returns the file content as base64-encoded binary along with the MIME type. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + employee_id: { /** - * Field + * Employee ID */ displayName: () => LocalizedString /** - * Text field to search + * The employee who owns the file */ shortDesc: () => LocalizedString /** - * The text field to search within + * The ID of the employee whose file you want to download. */ longDesc: () => LocalizedString } - '1': { + file_id: { /** - * Word + * File ID */ displayName: () => LocalizedString /** - * Word to search for + * The file to download */ shortDesc: () => LocalizedString /** - * The complete word to search for within the field + * The ID of the file to download. */ longDesc: () => LocalizedString } } } - 'doesnt-contain-word': { + upload_employee_file: { + groups: { + /** + * Employee Files + */ + '0': () => LocalizedString + } /** - * doesn't contain word + * Upload Employee File */ displayName: () => LocalizedString /** - * Does not contain whole word + * Upload a file to an employee */ shortDesc: () => LocalizedString /** - * Returns `True` if the field does not contain the specified word as a complete word + * Uploads a new file to an employee record in BambooHR. The file will be placed in the specified category. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + employee_id: { /** - * Field + * Employee ID */ displayName: () => LocalizedString /** - * Text field to search + * The employee to upload the file to */ shortDesc: () => LocalizedString /** - * The text field to search within + * The ID of the employee to associate the file with. */ longDesc: () => LocalizedString } - '1': { + category: { /** - * Word + * Category */ displayName: () => LocalizedString /** - * Word to exclude + * File category */ shortDesc: () => LocalizedString /** - * The complete word that should not be present in the field + * The category to place the file in. Categories are configured in BambooHR. */ longDesc: () => LocalizedString } - } - } - 'length-is-lower-than': { - /** - * length is lower than - */ - displayName: () => LocalizedString - /** - * Text length is less than - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the length of the text field is less than the specified number - */ - longDesc: () => LocalizedString - args: { - '0': { + file: { /** - * Field + * File */ displayName: () => LocalizedString /** - * Text field to measure + * The file to upload */ shortDesc: () => LocalizedString /** - * The text field whose length will be measured + * The file to upload. Must include name, MIME type, and base64-encoded content. */ longDesc: () => LocalizedString } - '1': { + share_with_employee: { /** - * Length + * Share with Employee */ displayName: () => LocalizedString /** - * Maximum length + * Make file visible to employee */ shortDesc: () => LocalizedString /** - * The maximum length the field should be less than + * Whether to make this file visible to the employee in their self-service portal. */ longDesc: () => LocalizedString } } } - empty: { - /** - * is empty - */ - displayName: () => LocalizedString - /** - * Field is empty - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field is empty or has no value - */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to check - */ - shortDesc: () => LocalizedString - /** - * The field to check for emptiness - */ - longDesc: () => LocalizedString - } + update_employee_file: { + groups: { + /** + * Employee Files + */ + '0': () => LocalizedString } - } - 'not-empty': { /** - * is not empty + * Update Employee File */ displayName: () => LocalizedString /** - * Field is not empty + * Update employee file metadata */ shortDesc: () => LocalizedString /** - * Returns `True` if the field has a value + * Updates the metadata for an existing employee file, such as name, category, or sharing settings. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + employee_id: { /** - * Field + * Employee ID */ displayName: () => LocalizedString /** - * Field to check + * The employee who owns the file */ shortDesc: () => LocalizedString /** - * The field to check for a value + * The ID of the employee whose file you want to update. */ longDesc: () => LocalizedString } - } - } - 'date-is': { - /** - * date is - */ - displayName: () => LocalizedString - /** - * Date equals - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the date field equals the specified date - */ - longDesc: () => LocalizedString - args: { - '0': { + file_id: { /** - * Field + * File ID */ displayName: () => LocalizedString /** - * Date field to compare + * The file to update */ shortDesc: () => LocalizedString /** - * The date field to compare + * The ID of the file to update. */ longDesc: () => LocalizedString } - '1': { + name: { /** - * Date + * Name */ displayName: () => LocalizedString /** - * Date to match + * New file name */ shortDesc: () => LocalizedString /** - * The date value to compare against (format: YYYY-MM-DD) + * The new name for the file. */ longDesc: () => LocalizedString } - } - } - 'date-is-not': { - /** - * date is not - */ - displayName: () => LocalizedString - /** - * Date does not equal - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the date field does not equal the specified date - */ - longDesc: () => LocalizedString - args: { - '0': { + category: { /** - * Field + * Category */ displayName: () => LocalizedString /** - * Date field to compare + * New category */ shortDesc: () => LocalizedString /** - * The date field to compare + * Move the file to a different category. */ longDesc: () => LocalizedString } - '1': { + share_with_employee: { /** - * Date + * Share with Employee */ displayName: () => LocalizedString /** - * Date to exclude + * Update sharing setting */ shortDesc: () => LocalizedString /** - * The date value that should not match (format: YYYY-MM-DD) + * Whether to make this file visible to the employee. */ longDesc: () => LocalizedString } } } - 'date-is-before': { + delete_employee_file: { + groups: { + /** + * Employee Files + */ + '0': () => LocalizedString + } /** - * date is before + * Delete Employee File */ displayName: () => LocalizedString /** - * Date is before + * Delete an employee file */ shortDesc: () => LocalizedString /** - * Returns `True` if the date field is before the specified date + * Permanently deletes a file from an employee record. This action cannot be undone. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + employee_id: { /** - * Field + * Employee ID */ displayName: () => LocalizedString /** - * Date field to compare + * The employee who owns the file */ shortDesc: () => LocalizedString /** - * The date field to compare + * The ID of the employee whose file you want to delete. */ longDesc: () => LocalizedString } - '1': { + file_id: { /** - * Date + * File ID */ displayName: () => LocalizedString /** - * Maximum date + * The file to delete */ shortDesc: () => LocalizedString /** - * The date that the field should be before (format: YYYY-MM-DD) + * The ID of the file to delete. */ longDesc: () => LocalizedString } } } - 'date-is-on-or-before': { + get_all_company_files: { + groups: { + /** + * Company Files + */ + '0': () => LocalizedString + } /** - * date is on or before + * Get All Company Files */ displayName: () => LocalizedString /** - * Date is on or before + * List all company files */ shortDesc: () => LocalizedString /** - * Returns `True` if the date field is on or before the specified date + * Retrieves all company files organized by category. Returns file metadata including name, size, upload date, and sharing status. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Date field to compare - */ - shortDesc: () => LocalizedString - /** - * The date field to compare - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Date - */ - displayName: () => LocalizedString - /** - * Maximum date - */ - shortDesc: () => LocalizedString - /** - * The date that the field should be on or before (format: YYYY-MM-DD) - */ - longDesc: () => LocalizedString - } + options: { } } - 'date-is-after': { + download_company_file: { + groups: { + /** + * Company Files + */ + '0': () => LocalizedString + } /** - * date is after + * Download Company File */ displayName: () => LocalizedString /** - * Date is after + * Download a company file */ shortDesc: () => LocalizedString /** - * Returns `True` if the date field is after the specified date + * Downloads a specific company file. Returns the file content as base64-encoded binary along with the MIME type. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Date field to compare - */ - shortDesc: () => LocalizedString - /** - * The date field to compare - */ - longDesc: () => LocalizedString - } - '1': { + options: { + file_id: { /** - * Date + * File ID */ displayName: () => LocalizedString /** - * Minimum date + * The file to download */ shortDesc: () => LocalizedString /** - * The date that the field should be after (format: YYYY-MM-DD) + * The ID of the company file to download. */ longDesc: () => LocalizedString } } } - 'date-is-on-or-after': { + upload_company_file: { + groups: { + /** + * Company Files + */ + '0': () => LocalizedString + } /** - * date is on or after + * Upload Company File */ displayName: () => LocalizedString /** - * Date is on or after + * Upload a company file */ shortDesc: () => LocalizedString /** - * Returns `True` if the date field is on or after the specified date + * Uploads a new file to the company files in BambooHR. The file will be placed in the specified category. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + category: { /** - * Field + * Category */ displayName: () => LocalizedString /** - * Date field to compare + * File category */ shortDesc: () => LocalizedString /** - * The date field to compare + * The category to place the file in. Categories are configured in BambooHR. */ longDesc: () => LocalizedString } - '1': { + file: { /** - * Date + * File */ displayName: () => LocalizedString /** - * Minimum date + * The file to upload */ shortDesc: () => LocalizedString /** - * The date that the field should be on or after (format: YYYY-MM-DD) + * The file to upload. Must include name, MIME type, and base64-encoded content. + */ + longDesc: () => LocalizedString + } + share_with_employees: { + /** + * Share with Employees + */ + displayName: () => LocalizedString + /** + * Make file visible to employees + */ + shortDesc: () => LocalizedString + /** + * Whether to make this file visible to all employees. */ longDesc: () => LocalizedString } } } - 'date-is-within': { + update_company_file: { + groups: { + /** + * Company Files + */ + '0': () => LocalizedString + } /** - * date is within + * Update Company File */ displayName: () => LocalizedString /** - * Date is within time period + * Update company file metadata */ shortDesc: () => LocalizedString /** - * Returns `True` if the date field falls within the specified time period + * Updates the metadata for an existing company file, such as name, category, or sharing settings. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + file_id: { /** - * Field + * File ID */ displayName: () => LocalizedString /** - * Date field to check + * The file to update */ shortDesc: () => LocalizedString /** - * The date field to check + * The ID of the company file to update. */ longDesc: () => LocalizedString } - '1': { + name: { /** - * Period + * Name */ displayName: () => LocalizedString /** - * Time period + * New file name */ shortDesc: () => LocalizedString /** - * The time period to check (e.g., "today", "yesterday", "this_week", "last_month") + * The new name for the file. */ longDesc: () => LocalizedString } - } - } - 'date-equals-day-of-month': { - /** - * day of month is - */ - displayName: () => LocalizedString - /** - * Day of month equals - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the day of the month equals the specified number - */ - longDesc: () => LocalizedString - args: { - '0': { + category: { /** - * Field + * Category */ displayName: () => LocalizedString /** - * Date field to check + * New category */ shortDesc: () => LocalizedString /** - * The date field whose day will be checked + * Move the file to a different category. */ longDesc: () => LocalizedString } - '1': { + share_with_employees: { /** - * Day + * Share with Employees */ displayName: () => LocalizedString /** - * Day number + * Update sharing setting */ shortDesc: () => LocalizedString /** - * The day of the month (1-31) to match + * Whether to make this file visible to all employees. */ longDesc: () => LocalizedString } } } - boolean: { + delete_company_file: { + groups: { + /** + * Company Files + */ + '0': () => LocalizedString + } /** - * is + * Delete Company File */ displayName: () => LocalizedString /** - * Boolean comparison + * Delete a company file */ shortDesc: () => LocalizedString /** - * Returns `True` if the boolean field equals the specified value + * Permanently deletes a company file. This action cannot be undone. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Boolean field to check - */ - shortDesc: () => LocalizedString - /** - * The boolean field to compare - */ - longDesc: () => LocalizedString - } - '1': { + options: { + file_id: { /** - * Value + * File ID */ displayName: () => LocalizedString /** - * Boolean value + * The file to delete */ shortDesc: () => LocalizedString /** - * The boolean value (true or false) to compare against + * The ID of the company file to delete. */ longDesc: () => LocalizedString } } } - 'is-even-and-whole': { + } + expressions: { + '&&': { /** - * is even and whole + * And */ displayName: () => LocalizedString /** - * Number is even and whole + * Logical AND operator */ shortDesc: () => LocalizedString /** - * Returns `True` if the number is even and a whole number + * Combines multiple conditions where all must be true */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Numeric field to check - */ - shortDesc: () => LocalizedString - /** - * The numeric field to check - */ - longDesc: () => LocalizedString - } - '1': { + } + '||': { + /** + * Or + */ + displayName: () => LocalizedString + /** + * Logical OR operator + */ + shortDesc: () => LocalizedString + /** + * Combines multiple conditions where at least one must be true + */ + longDesc: () => LocalizedString + } + '==': { + /** + * Equals + */ + displayName: () => LocalizedString + /** + * Field equals value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field equals the specified value + */ + longDesc: () => LocalizedString + } + '!=': { + /** + * Not Equals + */ + displayName: () => LocalizedString + /** + * Field does not equal value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field does not equal the specified value + */ + longDesc: () => LocalizedString + } + '>': { + /** + * Greater Than + */ + displayName: () => LocalizedString + /** + * Field is greater than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than the specified value + */ + longDesc: () => LocalizedString + } + '>=': { + /** + * Greater Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is greater than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than or equal to the specified value + */ + longDesc: () => LocalizedString + } + '<': { + /** + * Less Than + */ + displayName: () => LocalizedString + /** + * Field is less than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than the specified value + */ + longDesc: () => LocalizedString + } + '<=': { + /** + * Less Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is less than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than or equal to the specified value + */ + longDesc: () => LocalizedString + } + contains: { + /** + * Contains + */ + displayName: () => LocalizedString + /** + * Field contains value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field contains the specified text (case-insensitive) + */ + longDesc: () => LocalizedString + } + 'is-set': { + /** + * Is Set + */ + displayName: () => LocalizedString + /** + * Field has a value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has a value (is not empty) + */ + longDesc: () => LocalizedString + } + 'is-not-set': { + /** + * Is Not Set + */ + displayName: () => LocalizedString + /** + * Field has no value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has no value (is empty) + */ + longDesc: () => LocalizedString + } + } + triggers: { + new_time_off_request: { + /** + * New Time Off Request + */ + displayName: () => LocalizedString + /** + * Triggers when a new time off request is submitted + */ + shortDesc: () => LocalizedString + /** + * Fires when a new time off request is created in BambooHR with status "requested". Useful for building approval workflows or notifications. + */ + longDesc: () => LocalizedString + options: { + employee_id: { /** - * Check + * Employee ID */ displayName: () => LocalizedString /** - * Check value + * Filter by employee */ shortDesc: () => LocalizedString /** - * Set to true to check if even and whole, false to check if not + * Only trigger for time off requests from a specific employee. */ longDesc: () => LocalizedString } } } - 'single-select-equal': { + new_time_off: { /** - * is + * New Time Off */ displayName: () => LocalizedString /** - * Single select equals + * Triggers when new approved time off appears */ shortDesc: () => LocalizedString /** - * Returns `True` if the single select field equals the specified option + * Fires when a new approved time off entry appears in the Who's Out list. This includes both employee time off and company holidays. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + } + } + new_employee: { + /** + * New Employee + */ + displayName: () => LocalizedString + /** + * Triggers when a new employee is created + */ + shortDesc: () => LocalizedString + /** + * Fires when a new active employee is added to BambooHR. Returns basic employee information including name, email, department, and job title. + */ + longDesc: () => LocalizedString + options: { + } + } + } + } + Baserow: { + /** + * Baserow + */ + displayName: () => LocalizedString + groups: { + /** + * Spreadsheets & Data Tables + */ + '0': () => LocalizedString + /** + * Databases & Backend Services + */ + '1': () => LocalizedString + } + /** + * Connect to Baserow to manage your database tables, rows, and files with powerful automation + */ + shortDesc: () => LocalizedString + /** + * The Baserow integration provides comprehensive access to your Baserow database operations. Create, read, update, and delete rows in your tables, upload files, and monitor new entries with real-time triggers. Whether you need to manage data, filter results, or track new records, this integration streamlines your Baserow workflow automation and database management. + */ + longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to Baserow + */ + title: () => LocalizedString + /** + * To connect to Baserow, you will need your **Baserow URL** and a **Database Token**. + + ## Getting Your Database Token + + 1. Log in to your Baserow instance + 2. Click on your **profile icon** in the top right corner + 3. Select **Settings** from the dropdown menu + 4. Navigate to **Database tokens** in the left sidebar + 5. Click **Create token** + 6. Give your token a descriptive name (e.g., "Qore Integration") + 7. Select the **workspace** the token should have access to + 8. Configure **table-level permissions** (create, read, update, delete) as needed + 9. Click **Create token** and copy the generated token + + ## Connection Details + + ### Baserow URL + The base URL of your Baserow instance: + - **Baserow Cloud**: Use `https://api.baserow.io` + - **Self-hosted**: Use your instance URL (e.g., `https://baserow.yourcompany.com`) + + ### Database Token + Your database token that grants access to specific workspaces and tables. Tokens are scoped to a single workspace with granular table-level permissions. + + **Note:** Database tokens provide more granular control than API tokens. Each token can be restricted to specific operations (create, read, update, delete) on individual tables within a workspace. + */ + content: () => LocalizedString + } + actions: { + create_row: { + /** + * Create Row + */ + displayName: () => LocalizedString + /** + * Insert a new row into a Baserow table + */ + shortDesc: () => LocalizedString + /** + * Creates a new record in the specified Baserow table. The action dynamically presents the table schema, allowing you to provide values for each column. Optionally specify a row ID to insert the new row before it. Returns the newly created row with all its data. + */ + longDesc: () => LocalizedString + options: { + table: { /** - * Field + * Table */ displayName: () => LocalizedString /** - * Single select field + * The table where the row will be inserted */ shortDesc: () => LocalizedString /** - * The single select field to check + * Select the target Baserow table for inserting the new row. The available fields will be dynamically loaded based on the selected table schema. */ longDesc: () => LocalizedString } - '1': { + data: { /** - * Option + * Row Data */ displayName: () => LocalizedString /** - * Option to match + * The data to insert into the new row */ shortDesc: () => LocalizedString /** - * The select option value to match + * Provide values for the table columns. The structure is dynamically generated based on the selected table schema, showing all available columns with their data types and constraints. + */ + longDesc: () => LocalizedString + } + before_row_id: { + /** + * Before Row ID + */ + displayName: () => LocalizedString + /** + * Insert the new row before this row + */ + shortDesc: () => LocalizedString + /** + * Optionally specify a row ID to insert the new row before it in the table order. Leave empty to append the row at the end. */ longDesc: () => LocalizedString } } } - 'single-select-not-equal': { + delete_row: { /** - * is not + * Delete Row */ displayName: () => LocalizedString /** - * Single select does not equal + * Delete a specific row from a Baserow table */ shortDesc: () => LocalizedString /** - * Returns `True` if the single select field does not equal the specified option + * Removes a single row from a Baserow table by its ID. Use with caution as this operation is irreversible and permanently deletes the specified row. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + table: { /** - * Field + * Table */ displayName: () => LocalizedString /** - * Single select field + * The table to delete the row from */ shortDesc: () => LocalizedString /** - * The single select field to check + * Select the Baserow table from which you want to delete a row. Ensure you have proper permissions for delete operations on this table. */ longDesc: () => LocalizedString } - '1': { + row: { /** - * Option + * Row */ displayName: () => LocalizedString /** - * Option to exclude + * The row to delete */ shortDesc: () => LocalizedString /** - * The select option value to exclude + * Select the specific row to delete from the table by its ID. This row will be permanently removed. */ longDesc: () => LocalizedString } } } - 'single-select-is-any-of': { + get_table_row: { /** - * is any of + * Get Table Row */ displayName: () => LocalizedString /** - * Single select is any of + * Retrieve a specific row from a Baserow table */ shortDesc: () => LocalizedString /** - * Returns `True` if the single select field matches any of the specified options + * Fetches detailed data for a single row in a Baserow table by its ID. Returns all column values for the specified row with dynamically loaded field types. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + table: { /** - * Field + * Table */ displayName: () => LocalizedString /** - * Single select field + * The table to retrieve the row from */ shortDesc: () => LocalizedString /** - * The single select field to check + * Select the Baserow table from which you want to retrieve a row. The available rows will be loaded based on this selection. */ longDesc: () => LocalizedString } - '1': { + row: { /** - * Options + * Row */ displayName: () => LocalizedString /** - * Options list + * The row to retrieve */ shortDesc: () => LocalizedString /** - * List of select option values to match against + * Select the specific row to retrieve from the table by its ID. All data for this row will be returned. */ longDesc: () => LocalizedString } } } - 'single-select-is-none-of': { + get_table_fields: { /** - * is none of + * Get Table Fields */ displayName: () => LocalizedString /** - * Single select is none of + * Retrieve all field definitions from a Baserow table */ shortDesc: () => LocalizedString /** - * Returns `True` if the single select field does not match any of the specified options + * Fetches comprehensive metadata for all fields in a specific Baserow table including field types, order, descriptions, default values, and properties. This action helps you understand the structure and configuration of your database tables. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Single select field - */ - shortDesc: () => LocalizedString - /** - * The single select field to check - */ - longDesc: () => LocalizedString - } - '1': { + options: { + table: { /** - * Options + * Table */ displayName: () => LocalizedString /** - * Options list + * The table to retrieve fields from */ shortDesc: () => LocalizedString /** - * List of select option values to exclude + * Select the Baserow table whose field definitions you want to fetch. All fields and their configurations will be returned. */ longDesc: () => LocalizedString } } } - 'multiple-select-has': { + list_rows: { /** - * has any of + * List Rows */ displayName: () => LocalizedString /** - * Multiple select contains + * Query and retrieve rows from a Baserow table */ shortDesc: () => LocalizedString /** - * Returns `True` if the multiple select field contains the specified option + * Fetches rows from a Baserow table with support for filtering, sorting, pagination, and search. Returns a list of records matching your query criteria along with total count and pagination information. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + table: { /** - * Field + * Table */ displayName: () => LocalizedString /** - * Multiple select field + * The table to query */ shortDesc: () => LocalizedString /** - * The multiple select field to check + * Select the Baserow table from which you want to retrieve rows. The available columns for filtering and ordering will be loaded based on this selection. */ longDesc: () => LocalizedString } - '1': { + page: { /** - * Option + * Page */ displayName: () => LocalizedString /** - * Option to find + * Page number for pagination */ shortDesc: () => LocalizedString /** - * The select option value to find in the field + * Specify which page of results to retrieve. Used in combination with size for pagination through large datasets. Defaults to page 1. */ longDesc: () => LocalizedString } - } - } - 'multiple-select-has-not': { - /** - * doesn't have any of - */ - displayName: () => LocalizedString - /** - * Multiple select does not contain - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the multiple select field does not contain the specified option - */ - longDesc: () => LocalizedString - args: { - '0': { + size: { /** - * Field + * Size */ displayName: () => LocalizedString /** - * Multiple select field + * Number of rows per page */ shortDesc: () => LocalizedString /** - * The multiple select field to check + * Specify the maximum number of rows to retrieve per page. Defaults to 100 rows if not specified. */ longDesc: () => LocalizedString } - '1': { + search: { /** - * Option + * Search */ displayName: () => LocalizedString /** - * Option to exclude + * Search term to filter rows */ shortDesc: () => LocalizedString /** - * The select option value that should not be in the field + * Provide a search term to filter rows across all text fields in the table. Only rows containing this term will be returned. */ longDesc: () => LocalizedString } - } - } - 'link-row-has': { - /** - * has - */ - displayName: () => LocalizedString - /** - * Link row contains - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the link row field contains the specified linked record - */ - longDesc: () => LocalizedString - args: { - '0': { + order: { /** - * Field + * Order */ displayName: () => LocalizedString /** - * Link row field + * Sort the results by a specific field */ shortDesc: () => LocalizedString /** - * The link row field to check + * Define how to sort the retrieved rows by specifying a field and sort direction (ascending or descending). */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * Select the table field used for sorting the results. + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * Choose ascending (+) to sort from lowest to highest, or descending (-) to sort from highest to lowest. + */ + longDesc: () => LocalizedString + } + } + } } - '1': { + filter: { /** - * Record ID + * Filter */ displayName: () => LocalizedString /** - * Linked record ID + * Filter rows based on conditions */ shortDesc: () => LocalizedString /** - * The ID of the linked record to find + * Apply multiple filter conditions to retrieve only rows that match specific criteria. Supports various comparison operators and logical combinations. */ longDesc: () => LocalizedString + type: { + fields: { + filters: { + /** + * Filters + */ + displayName: () => LocalizedString + /** + * List of filter conditions + */ + shortDesc: () => LocalizedString + /** + * Define one or more filter conditions. Each condition specifies a field, operator, and value to match against. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + type: { + /** + * Type + */ + displayName: () => LocalizedString + /** + * The comparison operator + */ + shortDesc: () => LocalizedString + /** + * Choose the comparison operator for this filter condition (equal, contains, empty, etc.). + */ + longDesc: () => LocalizedString + } + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to filter on + */ + shortDesc: () => LocalizedString + /** + * Select the table field to apply this filter condition to. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * The value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against using the selected operator. + */ + longDesc: () => LocalizedString + } + } + } + } + } + filter_type: { + /** + * Filter Type + */ + displayName: () => LocalizedString + /** + * Logical operator for combining filters + */ + shortDesc: () => LocalizedString + /** + * Choose AND to require all filter conditions to match, or OR to match any filter condition. + */ + longDesc: () => LocalizedString + } + } + } } } } - 'link-row-has-not': { + list_tables: { /** - * doesn't have + * List Tables */ displayName: () => LocalizedString /** - * Link row does not contain + * Get all tables in your Baserow database */ shortDesc: () => LocalizedString /** - * Returns `True` if the link row field does not contain the specified linked record + * Retrieves a list of all tables from your Baserow database with their basic metadata including table IDs, names, order, and associated database IDs. */ longDesc: () => LocalizedString - args: { - '0': { + } + update_row: { + /** + * Update Row + */ + displayName: () => LocalizedString + /** + * Update an existing row in a Baserow table + */ + shortDesc: () => LocalizedString + /** + * Updates the values of an existing row in a Baserow table. The action dynamically presents the table schema, allowing you to modify values for each column. Returns the updated row with all its current data. + */ + longDesc: () => LocalizedString + options: { + table: { /** - * Field + * Table */ displayName: () => LocalizedString /** - * Link row field + * The table containing the row to update */ shortDesc: () => LocalizedString /** - * The link row field to check + * Select the Baserow table containing the row you want to update. The available fields will be dynamically loaded based on the table schema. */ longDesc: () => LocalizedString } - '1': { + row: { /** - * Record ID + * Row */ displayName: () => LocalizedString /** - * Linked record ID + * The row to update */ shortDesc: () => LocalizedString /** - * The ID of the linked record that should not be present + * Select the specific row to update by its ID. The current values of this row will be modified. + */ + longDesc: () => LocalizedString + } + data: { + /** + * Row Data + */ + displayName: () => LocalizedString + /** + * The new data for the row + */ + shortDesc: () => LocalizedString + /** + * Provide new values for the table columns you want to update. The structure is dynamically generated based on the selected table schema. */ longDesc: () => LocalizedString } } } - 'link-row-contains': { + upload_file: { /** - * contains + * Upload File */ displayName: () => LocalizedString /** - * Link row value contains + * Upload a file to Baserow storage */ shortDesc: () => LocalizedString /** - * Returns `True` if any linked record value contains the specified text + * Uploads a file to Baserow's file storage system. Returns the uploaded file's metadata including URL, size, MIME type, and generated thumbnails for images. The uploaded file can then be referenced in file fields within your tables. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Link row field - */ - shortDesc: () => LocalizedString - /** - * The link row field to search - */ - longDesc: () => LocalizedString - } - '1': { + options: { + file: { /** - * Text + * File */ displayName: () => LocalizedString /** - * Text to find + * The file to upload */ shortDesc: () => LocalizedString /** - * The text to search for in linked record values + * Select or provide the file to upload to Baserow storage. The file will be stored and available for use in file fields. */ longDesc: () => LocalizedString } } } - 'link-row-not-contains': { + } + triggers: { + new_document: { /** - * doesn't contain + * New Row */ displayName: () => LocalizedString /** - * Link row value does not contain + * Triggers when a new row is added to a Baserow table */ shortDesc: () => LocalizedString /** - * Returns `True` if no linked record value contains the specified text + * Monitors a Baserow table for new rows and triggers when new records are inserted. Supports optional filtering and search to trigger only for rows matching specific criteria. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + table: { /** - * Field + * Table */ displayName: () => LocalizedString /** - * Link row field + * The table to monitor for new rows */ shortDesc: () => LocalizedString /** - * The link row field to search + * Select the Baserow table you want to monitor. The trigger will fire whenever new rows are inserted into this table. */ longDesc: () => LocalizedString } - '1': { + search: { /** - * Text + * Search */ displayName: () => LocalizedString /** - * Text to exclude + * Optional search term to filter new rows */ shortDesc: () => LocalizedString /** - * The text that should not be in linked record values + * Provide a search term to trigger only for new rows that contain this term in any text field. Leave empty to trigger for all new rows. */ longDesc: () => LocalizedString } + filter: { + /** + * Filter + */ + displayName: () => LocalizedString + /** + * Optional conditions to filter new rows + */ + shortDesc: () => LocalizedString + /** + * Apply filter conditions to trigger only for new rows matching specific criteria. Leave empty to trigger for all new rows. + */ + longDesc: () => LocalizedString + type: { + fields: { + filters: { + /** + * Filters + */ + displayName: () => LocalizedString + /** + * List of filter conditions + */ + shortDesc: () => LocalizedString + /** + * Define one or more filter conditions. Only new rows matching these conditions will trigger the event. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + type: { + /** + * Type + */ + displayName: () => LocalizedString + /** + * The comparison operator + */ + shortDesc: () => LocalizedString + /** + * Choose the comparison operator for this filter condition. + */ + longDesc: () => LocalizedString + } + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to filter on + */ + shortDesc: () => LocalizedString + /** + * Select the table field to apply this filter condition to. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * The value to match + */ + shortDesc: () => LocalizedString + /** + * The value to compare against. Only new rows matching this condition will trigger the event. + */ + longDesc: () => LocalizedString + } + } + } + } + } + filter_type: { + /** + * Filter Type + */ + displayName: () => LocalizedString + /** + * Logical operator for combining filters + */ + shortDesc: () => LocalizedString + /** + * Choose AND to require all filter conditions to match, or OR to match any filter condition. + */ + longDesc: () => LocalizedString + } + } + } + } } } - 'filename-contains': { + } + searchOptions: { + orderBy: { /** - * filename contains + * Order By */ displayName: () => LocalizedString /** - * File name contains text + * Sort results by a specific field */ shortDesc: () => LocalizedString /** - * Returns `True` if any file name contains the specified text + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + column: { + /** + * Column + */ + displayName: () => LocalizedString + /** + * The column to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the column to use for sorting results + */ + longDesc: () => LocalizedString + } + ascending: { + /** + * Ascending + */ + displayName: () => LocalizedString + /** + * Sort in ascending order + */ + shortDesc: () => LocalizedString + /** + * When enabled, results are sorted in ascending order (A-Z, 0-9) + */ + longDesc: () => LocalizedString + } + } + } + } + } + expressions: { + '&&': { + /** + * and (&&) + */ + displayName: () => LocalizedString + /** + * Returns True if all arguments are True + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if all arguments are `True` with logic short-circuiting */ longDesc: () => LocalizedString args: { '0': { /** - * Field + * Condition */ displayName: () => LocalizedString /** - * File field + * Boolean condition to evaluate */ shortDesc: () => LocalizedString /** - * The file field to check + * A boolean expression or condition that evaluates to True or False */ longDesc: () => LocalizedString } - '1': { + } + } + '||': { + /** + * or (||) + */ + displayName: () => LocalizedString + /** + * Returns True if any argument is True + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if any argument is `True` with logic short-circuiting + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Text + * Condition */ displayName: () => LocalizedString /** - * Text to find + * Boolean condition to evaluate */ shortDesc: () => LocalizedString /** - * The text to search for in file names + * A boolean expression or condition that evaluates to True or False */ longDesc: () => LocalizedString } } } - 'has-file-type': { + '==': { /** - * has file type + * equal (==) */ displayName: () => LocalizedString /** - * Has file with type + * Equality comparison */ shortDesc: () => LocalizedString /** - * Returns `True` if the field contains a file with the specified type + * Returns `True` if the field value equals the specified value */ longDesc: () => LocalizedString args: { @@ -146555,41 +147636,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * File field + * Field to compare */ shortDesc: () => LocalizedString /** - * The file field to check + * The field whose value will be compared */ longDesc: () => LocalizedString } '1': { /** - * Type + * Value */ displayName: () => LocalizedString /** - * File type + * Value to compare against */ shortDesc: () => LocalizedString /** - * The file type to check for (e.g., "image", "document") + * The value to compare the field against */ longDesc: () => LocalizedString } } } - 'files-lower-than': { + '!=': { /** - * files lower than + * not equal (!=) */ displayName: () => LocalizedString /** - * File count is less than + * Inequality comparison */ shortDesc: () => LocalizedString /** - * Returns `True` if the number of files is less than the specified count + * Returns `True` if the field value does not equal the specified value */ longDesc: () => LocalizedString args: { @@ -146599,41 +147680,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * File field + * Field to compare */ shortDesc: () => LocalizedString /** - * The file field to count + * The field whose value will be compared */ longDesc: () => LocalizedString } '1': { /** - * Count + * Value */ displayName: () => LocalizedString /** - * Maximum count + * Value to compare against */ shortDesc: () => LocalizedString /** - * The maximum number of files + * The value to compare the field against */ longDesc: () => LocalizedString } } } - 'user-is': { + '>': { /** - * is + * higher than (>) */ displayName: () => LocalizedString /** - * User equals + * Greater than comparison */ shortDesc: () => LocalizedString /** - * Returns `True` if the user field equals the specified user + * Returns `True` if the field value is greater than the specified number */ longDesc: () => LocalizedString args: { @@ -146643,41 +147724,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * User field + * Numeric field to compare */ shortDesc: () => LocalizedString /** - * The user field to check + * The numeric field whose value will be compared */ longDesc: () => LocalizedString } '1': { /** - * User + * Number */ displayName: () => LocalizedString /** - * User to match + * Number to compare against */ shortDesc: () => LocalizedString /** - * The user identifier to match + * The numeric value to compare the field against */ longDesc: () => LocalizedString } } } - 'user-is-not': { + '>=': { /** - * is not + * higher than or equal (>=) */ displayName: () => LocalizedString /** - * User does not equal + * Greater than or equal comparison */ shortDesc: () => LocalizedString /** - * Returns `True` if the user field does not equal the specified user + * Returns `True` if the field value is greater than or equal to the specified number */ longDesc: () => LocalizedString args: { @@ -146687,41 +147768,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * User field + * Numeric field to compare */ shortDesc: () => LocalizedString /** - * The user field to check + * The numeric field whose value will be compared */ longDesc: () => LocalizedString } '1': { /** - * User + * Number */ displayName: () => LocalizedString /** - * User to exclude + * Number to compare against */ shortDesc: () => LocalizedString /** - * The user identifier to exclude + * The numeric value to compare the field against */ longDesc: () => LocalizedString } } } - 'multiple-collaborators-has': { + '<': { /** - * has + * lower than (<) */ displayName: () => LocalizedString /** - * Has collaborator + * Less than comparison */ shortDesc: () => LocalizedString /** - * Returns `True` if the multiple collaborators field contains the specified user + * Returns `True` if the field value is less than the specified number */ longDesc: () => LocalizedString args: { @@ -146731,41 +147812,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Collaborators field + * Numeric field to compare */ shortDesc: () => LocalizedString /** - * The multiple collaborators field to check + * The numeric field whose value will be compared */ longDesc: () => LocalizedString } '1': { /** - * User + * Number */ displayName: () => LocalizedString /** - * User to find + * Number to compare against */ shortDesc: () => LocalizedString /** - * The user identifier to find + * The numeric value to compare the field against */ longDesc: () => LocalizedString } } } - 'multiple-collaborators-has-not': { + '<=': { /** - * doesn't have + * lower than or equal (<=) */ displayName: () => LocalizedString /** - * Does not have collaborator + * Less than or equal comparison */ shortDesc: () => LocalizedString /** - * Returns `True` if the multiple collaborators field does not contain the specified user + * Returns `True` if the field value is less than or equal to the specified number */ longDesc: () => LocalizedString args: { @@ -146775,41 +147856,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Collaborators field + * Numeric field to compare */ shortDesc: () => LocalizedString /** - * The multiple collaborators field to check + * The numeric field whose value will be compared */ longDesc: () => LocalizedString } '1': { /** - * User + * Number */ displayName: () => LocalizedString /** - * User to exclude + * Number to compare against */ shortDesc: () => LocalizedString /** - * The user identifier that should not be present + * The numeric value to compare the field against */ longDesc: () => LocalizedString } } } - 'has-empty-value': { + contains: { /** - * has empty value + * contains */ displayName: () => LocalizedString /** - * Lookup has empty value + * Contains text */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has at least one empty value + * Returns `True` if the field contains the specified text */ longDesc: () => LocalizedString args: { @@ -146819,41 +147900,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Text field to search */ shortDesc: () => LocalizedString /** - * The lookup field to check for empty values + * The text field to search within */ longDesc: () => LocalizedString } '1': { /** - * Subfield + * Text */ displayName: () => LocalizedString /** - * Subfield to check + * Text to search for */ shortDesc: () => LocalizedString /** - * The specific subfield within the lookup to check + * The text string to search for within the field */ longDesc: () => LocalizedString } } } - 'has-not-empty-value': { + 'contains-not': { /** - * doesn't have empty value + * doesn't contain */ displayName: () => LocalizedString /** - * Lookup has no empty values + * Does not contain text */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has no empty values + * Returns `True` if the field does not contain the specified text */ longDesc: () => LocalizedString args: { @@ -146863,41 +147944,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Text field to search */ shortDesc: () => LocalizedString /** - * The lookup field to check + * The text field to search within */ longDesc: () => LocalizedString } '1': { /** - * Subfield + * Text */ displayName: () => LocalizedString /** - * Subfield to check + * Text to exclude */ shortDesc: () => LocalizedString /** - * The specific subfield within the lookup to check + * The text string that should not be present in the field */ longDesc: () => LocalizedString } } } - 'has-value-equal': { + 'contains-word': { /** - * has value equal + * contains word */ displayName: () => LocalizedString /** - * Lookup value equals + * Contains whole word */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a value equal to the specified value + * Returns `True` if the field contains the specified word as a complete word */ longDesc: () => LocalizedString args: { @@ -146907,41 +147988,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Text field to search */ shortDesc: () => LocalizedString /** - * The lookup field to check + * The text field to search within */ longDesc: () => LocalizedString } '1': { /** - * Value + * Word */ displayName: () => LocalizedString /** - * Value to match + * Word to search for */ shortDesc: () => LocalizedString /** - * The value to find in the lookup field + * The complete word to search for within the field */ longDesc: () => LocalizedString } } } - 'has-not-value-equal': { + 'doesnt-contain-word': { /** - * doesn't have value equal + * doesn't contain word */ displayName: () => LocalizedString /** - * Lookup value does not equal + * Does not contain whole word */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a value equal to the specified value + * Returns `True` if the field does not contain the specified word as a complete word */ longDesc: () => LocalizedString args: { @@ -146951,41 +148032,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Text field to search */ shortDesc: () => LocalizedString /** - * The lookup field to check + * The text field to search within */ longDesc: () => LocalizedString } '1': { /** - * Value + * Word */ displayName: () => LocalizedString /** - * Value to exclude + * Word to exclude */ shortDesc: () => LocalizedString /** - * The value that should not be in the lookup field + * The complete word that should not be present in the field */ longDesc: () => LocalizedString } } } - 'has-value-contains': { + 'length-is-lower-than': { /** - * has value contains + * length is lower than */ displayName: () => LocalizedString /** - * Lookup value contains + * Text length is less than */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a value containing the specified text + * Returns `True` if the length of the text field is less than the specified number */ longDesc: () => LocalizedString args: { @@ -146995,41 +148076,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Text field to measure */ shortDesc: () => LocalizedString /** - * The lookup field to search + * The text field whose length will be measured */ longDesc: () => LocalizedString } '1': { /** - * Text + * Length */ displayName: () => LocalizedString /** - * Text to find + * Maximum length */ shortDesc: () => LocalizedString /** - * The text to search for in lookup values + * The maximum length the field should be less than */ longDesc: () => LocalizedString } } } - 'has-not-value-contains': { + empty: { /** - * doesn't have value contains + * is empty */ displayName: () => LocalizedString /** - * Lookup value does not contain + * Field is empty */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a value containing the specified text + * Returns `True` if the field is empty or has no value */ longDesc: () => LocalizedString args: { @@ -147039,41 +148120,57 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Field to check */ shortDesc: () => LocalizedString /** - * The lookup field to search + * The field to check for emptiness */ longDesc: () => LocalizedString } - '1': { + } + } + 'not-empty': { + /** + * is not empty + */ + displayName: () => LocalizedString + /** + * Field is not empty + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field has a value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Text + * Field */ displayName: () => LocalizedString /** - * Text to exclude + * Field to check */ shortDesc: () => LocalizedString /** - * The text that should not be in lookup values + * The field to check for a value */ longDesc: () => LocalizedString } } } - 'has-value-contains-word': { + 'date-is': { /** - * has value contains word + * date is */ displayName: () => LocalizedString /** - * Lookup value contains word + * Date equals */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a value containing the specified word + * Returns `True` if the date field equals the specified date */ longDesc: () => LocalizedString args: { @@ -147083,41 +148180,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Date field to compare */ shortDesc: () => LocalizedString /** - * The lookup field to search + * The date field to compare */ longDesc: () => LocalizedString } '1': { /** - * Word + * Date */ displayName: () => LocalizedString /** - * Word to find + * Date to match */ shortDesc: () => LocalizedString /** - * The complete word to search for in lookup values + * The date value to compare against (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - 'has-not-value-contains-word': { + 'date-is-not': { /** - * doesn't have value contains word + * date is not */ displayName: () => LocalizedString /** - * Lookup value does not contain word + * Date does not equal */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a value containing the specified word + * Returns `True` if the date field does not equal the specified date */ longDesc: () => LocalizedString args: { @@ -147127,41 +148224,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Date field to compare */ shortDesc: () => LocalizedString /** - * The lookup field to search + * The date field to compare */ longDesc: () => LocalizedString } '1': { /** - * Word + * Date */ displayName: () => LocalizedString /** - * Word to exclude + * Date to exclude */ shortDesc: () => LocalizedString /** - * The complete word that should not be in lookup values + * The date value that should not match (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - 'has-value-length-is-lower-than': { + 'date-is-before': { /** - * has value length is lower than + * date is before */ displayName: () => LocalizedString /** - * Lookup value length is less than + * Date is before */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a value with length less than the specified number + * Returns `True` if the date field is before the specified date */ longDesc: () => LocalizedString args: { @@ -147171,41 +148268,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Date field to compare */ shortDesc: () => LocalizedString /** - * The lookup field to measure + * The date field to compare */ longDesc: () => LocalizedString } '1': { /** - * Length + * Date */ displayName: () => LocalizedString /** - * Maximum length + * Maximum date */ shortDesc: () => LocalizedString /** - * The maximum length for lookup values + * The date that the field should be before (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - 'has-all-values-equal': { + 'date-is-on-or-before': { /** - * has all values equal + * date is on or before */ displayName: () => LocalizedString /** - * All lookup values equal + * Date is on or before */ shortDesc: () => LocalizedString /** - * Returns `True` if all values in the lookup field equal the specified value + * Returns `True` if the date field is on or before the specified date */ longDesc: () => LocalizedString args: { @@ -147215,41 +148312,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Date field to compare */ shortDesc: () => LocalizedString /** - * The lookup field to check + * The date field to compare */ longDesc: () => LocalizedString } '1': { /** - * Value + * Date */ displayName: () => LocalizedString /** - * Value to match + * Maximum date */ shortDesc: () => LocalizedString /** - * The value that all lookup values should equal + * The date that the field should be on or before (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - 'has-any-select-option-equal': { + 'date-is-after': { /** - * has any select option equal + * date is after */ displayName: () => LocalizedString /** - * Lookup has select option + * Date is after */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has any select option equal to the specified value + * Returns `True` if the date field is after the specified date */ longDesc: () => LocalizedString args: { @@ -147259,41 +148356,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Date field to compare */ shortDesc: () => LocalizedString /** - * The lookup field with select options + * The date field to compare */ longDesc: () => LocalizedString } '1': { /** - * Option + * Date */ displayName: () => LocalizedString /** - * Option to find + * Minimum date */ shortDesc: () => LocalizedString /** - * The select option value to find + * The date that the field should be after (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - 'has-none-select-option-equal': { + 'date-is-on-or-after': { /** - * doesn't have select option equal + * date is on or after */ displayName: () => LocalizedString /** - * Lookup has no select option + * Date is on or after */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has no select option equal to the specified value + * Returns `True` if the date field is on or after the specified date */ longDesc: () => LocalizedString args: { @@ -147303,41 +148400,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Date field to compare */ shortDesc: () => LocalizedString /** - * The lookup field with select options + * The date field to compare */ longDesc: () => LocalizedString } '1': { /** - * Option + * Date */ displayName: () => LocalizedString /** - * Option to exclude + * Minimum date */ shortDesc: () => LocalizedString /** - * The select option value that should not be present + * The date that the field should be on or after (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - 'has-value-higher': { + 'date-is-within': { /** - * has value higher than + * date is within */ displayName: () => LocalizedString /** - * Lookup value is greater than + * Date is within time period */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a numeric value greater than the specified number + * Returns `True` if the date field falls within the specified time period */ longDesc: () => LocalizedString args: { @@ -147347,41 +148444,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Date field to check */ shortDesc: () => LocalizedString /** - * The lookup field with numeric values + * The date field to check */ longDesc: () => LocalizedString } '1': { /** - * Number + * Period */ displayName: () => LocalizedString /** - * Minimum value + * Time period */ shortDesc: () => LocalizedString /** - * The number that lookup values should be greater than + * The time period to check (e.g., "today", "yesterday", "this_week", "last_month") */ longDesc: () => LocalizedString } } } - 'has-not-value-higher': { + 'date-equals-day-of-month': { /** - * doesn't have value higher than + * day of month is */ displayName: () => LocalizedString /** - * Lookup value is not greater than + * Day of month equals */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a numeric value greater than the specified number + * Returns `True` if the day of the month equals the specified number */ longDesc: () => LocalizedString args: { @@ -147391,41 +148488,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Date field to check */ shortDesc: () => LocalizedString /** - * The lookup field with numeric values + * The date field whose day will be checked */ longDesc: () => LocalizedString } '1': { /** - * Number + * Day */ displayName: () => LocalizedString /** - * Maximum value + * Day number */ shortDesc: () => LocalizedString /** - * The number that lookup values should not be greater than + * The day of the month (1-31) to match */ longDesc: () => LocalizedString } } } - 'has-value-higher-or-equal': { + boolean: { /** - * has value higher than or equal + * is */ displayName: () => LocalizedString /** - * Lookup value is greater than or equal + * Boolean comparison */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a numeric value greater than or equal to the specified number + * Returns `True` if the boolean field equals the specified value */ longDesc: () => LocalizedString args: { @@ -147435,41 +148532,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Boolean field to check */ shortDesc: () => LocalizedString /** - * The lookup field with numeric values + * The boolean field to compare */ longDesc: () => LocalizedString } '1': { /** - * Number + * Value */ displayName: () => LocalizedString /** - * Minimum value + * Boolean value */ shortDesc: () => LocalizedString /** - * The number that lookup values should be greater than or equal to + * The boolean value (true or false) to compare against */ longDesc: () => LocalizedString } } } - 'has-not-value-higher-or-equal': { + 'is-even-and-whole': { /** - * doesn't have value higher than or equal + * is even and whole */ displayName: () => LocalizedString /** - * Lookup value is not greater than or equal + * Number is even and whole */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a numeric value greater than or equal to the specified number + * Returns `True` if the number is even and a whole number */ longDesc: () => LocalizedString args: { @@ -147479,41 +148576,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Numeric field to check */ shortDesc: () => LocalizedString /** - * The lookup field with numeric values + * The numeric field to check */ longDesc: () => LocalizedString } '1': { /** - * Number + * Check */ displayName: () => LocalizedString /** - * Threshold value + * Check value */ shortDesc: () => LocalizedString /** - * The number that lookup values should not be greater than or equal to + * Set to true to check if even and whole, false to check if not */ longDesc: () => LocalizedString } } } - 'has-value-lower': { + 'single-select-equal': { /** - * has value lower than + * is */ displayName: () => LocalizedString /** - * Lookup value is less than + * Single select equals */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a numeric value less than the specified number + * Returns `True` if the single select field equals the specified option */ longDesc: () => LocalizedString args: { @@ -147523,41 +148620,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Single select field */ shortDesc: () => LocalizedString /** - * The lookup field with numeric values + * The single select field to check */ longDesc: () => LocalizedString } '1': { /** - * Number + * Option */ displayName: () => LocalizedString /** - * Maximum value + * Option to match */ shortDesc: () => LocalizedString /** - * The number that lookup values should be less than + * The select option value to match */ longDesc: () => LocalizedString } } } - 'has-not-value-lower': { + 'single-select-not-equal': { /** - * doesn't have value lower than + * is not */ displayName: () => LocalizedString /** - * Lookup value is not less than + * Single select does not equal */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a numeric value less than the specified number + * Returns `True` if the single select field does not equal the specified option */ longDesc: () => LocalizedString args: { @@ -147567,41 +148664,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Single select field */ shortDesc: () => LocalizedString /** - * The lookup field with numeric values + * The single select field to check */ longDesc: () => LocalizedString } '1': { /** - * Number + * Option */ displayName: () => LocalizedString /** - * Minimum value + * Option to exclude */ shortDesc: () => LocalizedString /** - * The number that lookup values should not be less than + * The select option value to exclude */ longDesc: () => LocalizedString } } } - 'has-value-lower-or-equal': { + 'single-select-is-any-of': { /** - * has value lower than or equal + * is any of */ displayName: () => LocalizedString /** - * Lookup value is less than or equal + * Single select is any of */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a numeric value less than or equal to the specified number + * Returns `True` if the single select field matches any of the specified options */ longDesc: () => LocalizedString args: { @@ -147611,41 +148708,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Single select field */ shortDesc: () => LocalizedString /** - * The lookup field with numeric values + * The single select field to check */ longDesc: () => LocalizedString } '1': { /** - * Number + * Options */ displayName: () => LocalizedString /** - * Maximum value + * Options list */ shortDesc: () => LocalizedString /** - * The number that lookup values should be less than or equal to + * List of select option values to match against */ longDesc: () => LocalizedString } } } - 'has-not-value-lower-or-equal': { + 'single-select-is-none-of': { /** - * doesn't have value lower than or equal + * is none of */ displayName: () => LocalizedString /** - * Lookup value is not less than or equal + * Single select is none of */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a numeric value less than or equal to the specified number + * Returns `True` if the single select field does not match any of the specified options */ longDesc: () => LocalizedString args: { @@ -147655,41 +148752,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Single select field */ shortDesc: () => LocalizedString /** - * The lookup field with numeric values + * The single select field to check */ longDesc: () => LocalizedString } '1': { /** - * Number + * Options */ displayName: () => LocalizedString /** - * Threshold value + * Options list */ shortDesc: () => LocalizedString /** - * The number that lookup values should not be less than or equal to + * List of select option values to exclude */ longDesc: () => LocalizedString } } } - 'has-date-equal': { + 'multiple-select-has': { /** - * has date equal + * has any of */ displayName: () => LocalizedString /** - * Lookup date equals + * Multiple select contains */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a date equal to the specified date + * Returns `True` if the multiple select field contains the specified option */ longDesc: () => LocalizedString args: { @@ -147699,41 +148796,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Multiple select field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The multiple select field to check */ longDesc: () => LocalizedString } '1': { /** - * Date + * Option */ displayName: () => LocalizedString /** - * Date to match + * Option to find */ shortDesc: () => LocalizedString /** - * The date that lookup values should equal (format: YYYY-MM-DD) + * The select option value to find in the field */ longDesc: () => LocalizedString } } } - 'has-not-date-equal': { + 'multiple-select-has-not': { /** - * doesn't have date equal + * doesn't have any of */ displayName: () => LocalizedString /** - * Lookup date does not equal + * Multiple select does not contain */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a date equal to the specified date + * Returns `True` if the multiple select field does not contain the specified option */ longDesc: () => LocalizedString args: { @@ -147743,41 +148840,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Multiple select field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The multiple select field to check */ longDesc: () => LocalizedString } '1': { /** - * Date + * Option */ displayName: () => LocalizedString /** - * Date to exclude + * Option to exclude */ shortDesc: () => LocalizedString /** - * The date that lookup values should not equal (format: YYYY-MM-DD) + * The select option value that should not be in the field */ longDesc: () => LocalizedString } } } - 'has-date-before': { + 'link-row-has': { /** - * has date before + * has */ displayName: () => LocalizedString /** - * Lookup date is before + * Link row contains */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a date before the specified date + * Returns `True` if the link row field contains the specified linked record */ longDesc: () => LocalizedString args: { @@ -147787,41 +148884,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Link row field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The link row field to check */ longDesc: () => LocalizedString } '1': { /** - * Date + * Record ID */ displayName: () => LocalizedString /** - * Maximum date + * Linked record ID */ shortDesc: () => LocalizedString /** - * The date that lookup values should be before (format: YYYY-MM-DD) + * The ID of the linked record to find */ longDesc: () => LocalizedString } } } - 'has-not-date-before': { + 'link-row-has-not': { /** - * doesn't have date before + * doesn't have */ displayName: () => LocalizedString /** - * Lookup date is not before + * Link row does not contain */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a date before the specified date + * Returns `True` if the link row field does not contain the specified linked record */ longDesc: () => LocalizedString args: { @@ -147831,41 +148928,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Link row field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The link row field to check */ longDesc: () => LocalizedString } '1': { /** - * Date + * Record ID */ displayName: () => LocalizedString /** - * Threshold date + * Linked record ID */ shortDesc: () => LocalizedString /** - * The date that lookup values should not be before (format: YYYY-MM-DD) + * The ID of the linked record that should not be present */ longDesc: () => LocalizedString } } } - 'has-date-on-or-before': { + 'link-row-contains': { /** - * has date on or before + * contains */ displayName: () => LocalizedString /** - * Lookup date is on or before + * Link row value contains */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a date on or before the specified date + * Returns `True` if any linked record value contains the specified text */ longDesc: () => LocalizedString args: { @@ -147875,41 +148972,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Link row field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The link row field to search */ longDesc: () => LocalizedString } '1': { /** - * Date + * Text */ displayName: () => LocalizedString /** - * Maximum date + * Text to find */ shortDesc: () => LocalizedString /** - * The date that lookup values should be on or before (format: YYYY-MM-DD) + * The text to search for in linked record values */ longDesc: () => LocalizedString } } } - 'has-not-date-on-or-before': { + 'link-row-not-contains': { /** - * doesn't have date on or before + * doesn't contain */ displayName: () => LocalizedString /** - * Lookup date is not on or before + * Link row value does not contain */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a date on or before the specified date + * Returns `True` if no linked record value contains the specified text */ longDesc: () => LocalizedString args: { @@ -147919,41 +149016,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Link row field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The link row field to search */ longDesc: () => LocalizedString } '1': { /** - * Date + * Text */ displayName: () => LocalizedString /** - * Threshold date + * Text to exclude */ shortDesc: () => LocalizedString /** - * The date that lookup values should not be on or before (format: YYYY-MM-DD) + * The text that should not be in linked record values */ longDesc: () => LocalizedString } } } - 'has-date-after': { + 'filename-contains': { /** - * has date after + * filename contains */ displayName: () => LocalizedString /** - * Lookup date is after + * File name contains text */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a date after the specified date + * Returns `True` if any file name contains the specified text */ longDesc: () => LocalizedString args: { @@ -147963,41 +149060,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * File field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The file field to check */ longDesc: () => LocalizedString } '1': { /** - * Date + * Text */ displayName: () => LocalizedString /** - * Minimum date + * Text to find */ shortDesc: () => LocalizedString /** - * The date that lookup values should be after (format: YYYY-MM-DD) + * The text to search for in file names */ longDesc: () => LocalizedString } } } - 'has-not-date-after': { + 'has-file-type': { /** - * doesn't have date after + * has file type */ displayName: () => LocalizedString /** - * Lookup date is not after + * Has file with type */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a date after the specified date + * Returns `True` if the field contains a file with the specified type */ longDesc: () => LocalizedString args: { @@ -148007,41 +149104,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * File field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The file field to check */ longDesc: () => LocalizedString } '1': { /** - * Date + * Type */ displayName: () => LocalizedString /** - * Threshold date + * File type */ shortDesc: () => LocalizedString /** - * The date that lookup values should not be after (format: YYYY-MM-DD) + * The file type to check for (e.g., "image", "document") */ longDesc: () => LocalizedString } } } - 'has-date-on-or-after': { + 'files-lower-than': { /** - * has date on or after + * files lower than */ displayName: () => LocalizedString /** - * Lookup date is on or after + * File count is less than */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a date on or after the specified date + * Returns `True` if the number of files is less than the specified count */ longDesc: () => LocalizedString args: { @@ -148051,41 +149148,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * File field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The file field to count */ longDesc: () => LocalizedString } '1': { /** - * Date + * Count */ displayName: () => LocalizedString /** - * Minimum date + * Maximum count */ shortDesc: () => LocalizedString /** - * The date that lookup values should be on or after (format: YYYY-MM-DD) + * The maximum number of files */ longDesc: () => LocalizedString } } } - 'has-not-date-on-or-after': { + 'user-is': { /** - * doesn't have date on or after + * is */ displayName: () => LocalizedString /** - * Lookup date is not on or after + * User equals */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a date on or after the specified date + * Returns `True` if the user field equals the specified user */ longDesc: () => LocalizedString args: { @@ -148095,41 +149192,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * User field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The user field to check */ longDesc: () => LocalizedString } '1': { /** - * Date + * User */ displayName: () => LocalizedString /** - * Threshold date + * User to match */ shortDesc: () => LocalizedString /** - * The date that lookup values should not be on or after (format: YYYY-MM-DD) + * The user identifier to match */ longDesc: () => LocalizedString } } } - 'has-date-within': { + 'user-is-not': { /** - * has date within + * is not */ displayName: () => LocalizedString /** - * Lookup date is within period + * User does not equal */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field has a date within the specified time period + * Returns `True` if the user field does not equal the specified user */ longDesc: () => LocalizedString args: { @@ -148139,41 +149236,41 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * User field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The user field to check */ longDesc: () => LocalizedString } '1': { /** - * Period + * User */ displayName: () => LocalizedString /** - * Time period + * User to exclude */ shortDesc: () => LocalizedString /** - * The time period to check (e.g., "today", "this_week", "last_month") + * The user identifier to exclude */ longDesc: () => LocalizedString } } } - 'has-not-date-within': { + 'multiple-collaborators-has': { /** - * doesn't have date within + * has */ displayName: () => LocalizedString /** - * Lookup date is not within period + * Has collaborator */ shortDesc: () => LocalizedString /** - * Returns `True` if the lookup field does not have a date within the specified time period + * Returns `True` if the multiple collaborators field contains the specified user */ longDesc: () => LocalizedString args: { @@ -148183,1809 +149280,1477 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Lookup field + * Collaborators field */ shortDesc: () => LocalizedString /** - * The lookup field with date values + * The multiple collaborators field to check */ longDesc: () => LocalizedString } '1': { /** - * Period + * User */ displayName: () => LocalizedString /** - * Time period + * User to find */ shortDesc: () => LocalizedString /** - * The time period to exclude (e.g., "today", "this_week", "last_month") + * The user identifier to find */ longDesc: () => LocalizedString } } } - } - } - Firestore: { - /** - * Firestore - */ - displayName: () => LocalizedString - groups: { - /** - * Databases & Backend Services - */ - '0': () => LocalizedString - } - /** - * Connect to Google Cloud Firestore to manage your NoSQL document database. - */ - shortDesc: () => LocalizedString - /** - * The Firestore integration enables you to interact with Google Cloud Firestore, a flexible, scalable NoSQL cloud database. Create, read, update, and delete documents, manage collections, and execute queries to automate your document database operations seamlessly. - */ - longDesc: () => LocalizedString - triggers: { - new_document: { + 'multiple-collaborators-has-not': { /** - * New Document + * doesn't have */ displayName: () => LocalizedString /** - * Triggers when a new document is created in a Firestore collection + * Does not have collaborator */ shortDesc: () => LocalizedString /** - * Monitors a Firestore collection for newly created documents. Documents are ordered based on your specified criteria, and the trigger activates when new documents appear at the top of the ordered list. You can optionally filter documents and customize the ordering to track specific types of documents. + * Returns `True` if the multiple collaborators field does not contain the specified user */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Google Cloud project ID + * Collaborators field */ shortDesc: () => LocalizedString /** - * The unique identifier for your Google Cloud project containing the Firestore database + * The multiple collaborators field to check */ longDesc: () => LocalizedString } - collection_path: { + '1': { /** - * Collection Path + * User */ displayName: () => LocalizedString /** - * The path to the Firestore collection + * User to exclude */ shortDesc: () => LocalizedString /** - * The full path to the collection you want to monitor. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + * The user identifier that should not be present */ longDesc: () => LocalizedString } - filters: { + } + } + 'has-empty-value': { + /** + * has empty value + */ + displayName: () => LocalizedString + /** + * Lookup has empty value + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field has at least one empty value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Filters + * Field */ displayName: () => LocalizedString /** - * Optional filters to apply to documents + * Lookup field */ shortDesc: () => LocalizedString /** - * Define one or more filters to narrow down which documents will trigger the event. Multiple filters are combined with AND logic. + * The lookup field to check for empty values */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The document field to filter on - */ - shortDesc: () => LocalizedString - /** - * Select the field name in the document that you want to filter - */ - longDesc: () => LocalizedString - } - operator: { - /** - * Operator - */ - displayName: () => LocalizedString - /** - * The comparison operator - */ - shortDesc: () => LocalizedString - /** - * The comparison operation to perform between the field value and your specified value - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to use in the comparison. The value will be automatically converted to the appropriate type (string, number, boolean, or null) - */ - longDesc: () => LocalizedString - } - } - } - } } - order_by: { + '1': { /** - * Order By + * Subfield */ displayName: () => LocalizedString /** - * Specify how to order documents + * Subfield to check */ shortDesc: () => LocalizedString /** - * Define the ordering criteria for documents. The trigger will activate for documents that appear at the top of the ordered list. If not specified, documents are ordered by creation time in descending order (newest first). + * The specific subfield within the lookup to check */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to order by - */ - shortDesc: () => LocalizedString - /** - * Select the document field to use for ordering - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * Choose ascending (oldest/smallest first) or descending (newest/largest first) order - */ - longDesc: () => LocalizedString - } - } - } } } } - } - actions: { - list_projects: { + 'has-not-empty-value': { /** - * List Projects + * doesn't have empty value */ displayName: () => LocalizedString /** - * List all Google Cloud projects accessible with the current credentials + * Lookup has no empty values */ shortDesc: () => LocalizedString /** - * Retrieves a list of all Google Cloud projects that are accessible with your credentials. You can filter projects by name and use pagination to navigate through large result sets. This is useful for discovering which projects contain Firestore databases. + * Returns `True` if the lookup field has no empty values */ longDesc: () => LocalizedString - options: { - name: { - /** - * Project Name - */ - displayName: () => LocalizedString - /** - * Filter projects by name - */ - shortDesc: () => LocalizedString - /** - * Optional filter to search for projects containing this name. The search is case-insensitive and matches partial names. - */ - longDesc: () => LocalizedString - } - page_size: { + args: { + '0': { /** - * Page Size + * Field */ displayName: () => LocalizedString /** - * Number of projects to return per page + * Lookup field */ shortDesc: () => LocalizedString /** - * The maximum number of projects to return in a single request. Default is 100. Use this with pagination tokens to retrieve large result sets. + * The lookup field to check */ longDesc: () => LocalizedString } - next_page_token: { + '1': { /** - * Next Page Token + * Subfield */ displayName: () => LocalizedString /** - * Token for retrieving the next page of results + * Subfield to check */ shortDesc: () => LocalizedString /** - * Pagination token obtained from a previous request. Use this to retrieve the next page of projects when there are more results than the page size. + * The specific subfield within the lookup to check */ longDesc: () => LocalizedString } } } - create_document: { - groups: { - /** - * Documents - */ - '0': () => LocalizedString - } + 'has-value-equal': { /** - * Create Document + * has value equal */ displayName: () => LocalizedString /** - * Create a new document in a Firestore collection + * Lookup value equals */ shortDesc: () => LocalizedString /** - * Creates a new document in the specified Firestore collection. You can either let Firestore auto-generate a document ID or provide your own. The document data can be specified through structured fields or as a custom hash object. + * Returns `True` if the lookup field has a value equal to the specified value */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Google Cloud project ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier for your Google Cloud project containing the Firestore database - */ - longDesc: () => LocalizedString - } - collection_path: { + args: { + '0': { /** - * Collection Path + * Field */ displayName: () => LocalizedString /** - * The path to the Firestore collection + * Lookup field */ shortDesc: () => LocalizedString /** - * The full path to the collection where the document will be created. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + * The lookup field to check */ longDesc: () => LocalizedString } - document_id: { + '1': { /** - * Document ID + * Value */ displayName: () => LocalizedString /** - * Custom document ID (optional) + * Value to match */ shortDesc: () => LocalizedString /** - * Optional custom identifier for the document. If not provided, Firestore will auto-generate a unique ID. Document IDs must be valid UTF-8 strings and cannot contain forward slashes. + * The value to find in the lookup field */ longDesc: () => LocalizedString } - data: { + } + } + 'has-not-value-equal': { + /** + * doesn't have value equal + */ + displayName: () => LocalizedString + /** + * Lookup value does not equal + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field does not have a value equal to the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Document Data + * Field */ displayName: () => LocalizedString /** - * The data to store in the document + * Lookup field */ shortDesc: () => LocalizedString /** - * The structured data to store in the document. This will be dynamically typed based on the collection schema if available. Each field will be stored with its appropriate Firestore data type. + * The lookup field to check */ longDesc: () => LocalizedString } - additional_data: { + '1': { /** - * Additional Data + * Value */ displayName: () => LocalizedString /** - * Additional fields to include in the document + * Value to exclude */ shortDesc: () => LocalizedString /** - * Optional additional fields to merge with the structured data. Use this to add fields that are not part of the predefined schema or to include dynamic fields. + * The value that should not be in the lookup field */ longDesc: () => LocalizedString } } } - get_document: { - groups: { - /** - * Documents - */ - '0': () => LocalizedString - } + 'has-value-contains': { /** - * Get Document + * has value contains */ displayName: () => LocalizedString /** - * Retrieve a specific document from a Firestore collection + * Lookup value contains */ shortDesc: () => LocalizedString /** - * Fetches a single document by its ID from a Firestore collection. Returns the complete document data including metadata such as creation time and last update time. This action will fail if the document does not exist. + * Returns `True` if the lookup field has a value containing the specified text */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Google Cloud project ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier for your Google Cloud project containing the Firestore database - */ - longDesc: () => LocalizedString - } - collection_path: { + args: { + '0': { /** - * Collection Path + * Field */ displayName: () => LocalizedString /** - * The path to the Firestore collection + * Lookup field */ shortDesc: () => LocalizedString /** - * The full path to the collection containing the document. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + * The lookup field to search */ longDesc: () => LocalizedString } - document_id: { + '1': { /** - * Document ID + * Text */ displayName: () => LocalizedString /** - * The ID of the document to retrieve + * Text to find */ shortDesc: () => LocalizedString /** - * The unique identifier of the document you want to retrieve. This is the document ID that was either auto-generated or specified when the document was created. + * The text to search for in lookup values */ longDesc: () => LocalizedString } } } - update_document: { - groups: { - /** - * Documents - */ - '0': () => LocalizedString - } + 'has-not-value-contains': { /** - * Update Document + * doesn't have value contains */ displayName: () => LocalizedString /** - * Update an existing document in a Firestore collection + * Lookup value does not contain */ shortDesc: () => LocalizedString /** - * Updates an existing document in Firestore with new data. You can choose to merge the new data with existing fields or replace the entire document. By default, the update merges new fields while preserving unspecified fields. + * Returns `True` if the lookup field does not have a value containing the specified text */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Google Cloud project ID + * Lookup field */ shortDesc: () => LocalizedString /** - * The unique identifier for your Google Cloud project containing the Firestore database + * The lookup field to search */ longDesc: () => LocalizedString } - collection_path: { + '1': { /** - * Collection Path + * Text */ displayName: () => LocalizedString /** - * The path to the Firestore collection + * Text to exclude */ shortDesc: () => LocalizedString /** - * The full path to the collection containing the document. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + * The text that should not be in lookup values */ longDesc: () => LocalizedString } - document_id: { + } + } + 'has-value-contains-word': { + /** + * has value contains word + */ + displayName: () => LocalizedString + /** + * Lookup value contains word + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field has a value containing the specified word + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Document ID + * Field */ displayName: () => LocalizedString /** - * The ID of the document to update + * Lookup field */ shortDesc: () => LocalizedString /** - * The unique identifier of the document you want to update. The document must exist or the operation will fail. + * The lookup field to search */ longDesc: () => LocalizedString } - data: { + '1': { /** - * Document Data + * Word */ displayName: () => LocalizedString /** - * The new data for the document + * Word to find */ shortDesc: () => LocalizedString /** - * The data to update in the document. When merge is enabled, only the specified fields will be updated. When merge is disabled, this data will replace the entire document. + * The complete word to search for in lookup values */ longDesc: () => LocalizedString } - additional_data: { + } + } + 'has-not-value-contains-word': { + /** + * doesn't have value contains word + */ + displayName: () => LocalizedString + /** + * Lookup value does not contain word + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field does not have a value containing the specified word + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Additional Data + * Field */ displayName: () => LocalizedString /** - * Additional fields to update + * Lookup field */ shortDesc: () => LocalizedString /** - * Optional additional fields to merge with the structured data. Use this to update fields that are not part of the predefined schema or to include dynamic fields. + * The lookup field to search */ longDesc: () => LocalizedString } - merge: { + '1': { /** - * Merge + * Word */ displayName: () => LocalizedString /** - * Whether to merge with existing data + * Word to exclude */ shortDesc: () => LocalizedString /** - * When true (default), only the specified fields are updated and other fields remain unchanged. When false, the entire document is replaced with the new data. + * The complete word that should not be in lookup values */ longDesc: () => LocalizedString } } } - delete_document: { - groups: { - /** - * Documents - */ - '0': () => LocalizedString - } + 'has-value-length-is-lower-than': { /** - * Delete Document + * has value length is lower than */ displayName: () => LocalizedString /** - * Delete a document from a Firestore collection + * Lookup value length is less than */ shortDesc: () => LocalizedString /** - * Permanently deletes a document from a Firestore collection. This operation cannot be undone. The document must exist or the operation will fail. All subcollections under the document will NOT be automatically deleted. + * Returns `True` if the lookup field has a value with length less than the specified number */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Google Cloud project ID + * Lookup field */ shortDesc: () => LocalizedString /** - * The unique identifier for your Google Cloud project containing the Firestore database + * The lookup field to measure */ longDesc: () => LocalizedString } - collection_path: { + '1': { /** - * Collection Path + * Length */ displayName: () => LocalizedString /** - * The path to the Firestore collection + * Maximum length */ shortDesc: () => LocalizedString /** - * The full path to the collection containing the document. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection - */ - longDesc: () => LocalizedString - } - document_id: { - /** - * Document ID - */ - displayName: () => LocalizedString - /** - * The ID of the document to delete - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the document you want to delete. The document must exist or the operation will fail. + * The maximum length for lookup values */ longDesc: () => LocalizedString } } } - list_documents: { - groups: { - /** - * Documents - */ - '0': () => LocalizedString - } + 'has-all-values-equal': { /** - * List Documents + * has all values equal */ displayName: () => LocalizedString /** - * List all documents in a Firestore collection + * All lookup values equal */ shortDesc: () => LocalizedString /** - * Retrieves all documents from a specified Firestore collection. You can limit the number of results and specify ordering criteria. This action returns the complete document data along with metadata for each document. + * Returns `True` if all values in the lookup field equal the specified value */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Google Cloud project ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier for your Google Cloud project containing the Firestore database - */ - longDesc: () => LocalizedString - } - collection_path: { - /** - * Collection Path - */ - displayName: () => LocalizedString - /** - * The path to the Firestore collection - */ - shortDesc: () => LocalizedString - /** - * The full path to the collection whose documents you want to list. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection - */ - longDesc: () => LocalizedString - } - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * Maximum number of documents to return - */ - shortDesc: () => LocalizedString - /** - * The maximum number of documents to retrieve. Default is 100. Use this to control the size of the result set and improve performance. - */ - longDesc: () => LocalizedString - } - order_by: { + args: { + '0': { /** - * Order By + * Field */ displayName: () => LocalizedString /** - * Field to order documents by + * Lookup field */ shortDesc: () => LocalizedString /** - * Optional field name to use for ordering the documents. The field must exist in the documents and be of a comparable type (string, number, date). + * The lookup field to check */ longDesc: () => LocalizedString } - order_direction: { + '1': { /** - * Order Direction + * Value */ displayName: () => LocalizedString /** - * Sort direction for ordering + * Value to match */ shortDesc: () => LocalizedString /** - * The direction to sort documents when an order_by field is specified. Choose ascending for lowest to highest or descending for highest to lowest. + * The value that all lookup values should equal */ longDesc: () => LocalizedString } } } - list_collections: { - groups: { - /** - * Collections - */ - '0': () => LocalizedString - } + 'has-any-select-option-equal': { /** - * List Collections + * has any select option equal */ displayName: () => LocalizedString /** - * List all collections in a Firestore database or document + * Lookup has select option */ shortDesc: () => LocalizedString /** - * Retrieves all collection IDs at the root level of a Firestore database or within a specific document. This is useful for discovering the structure of your Firestore database and navigating nested collections. + * Returns `True` if the lookup field has any select option equal to the specified value */ longDesc: () => LocalizedString - options: { - project_id: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The Google Cloud project ID + * Lookup field */ shortDesc: () => LocalizedString /** - * The unique identifier for your Google Cloud project containing the Firestore database + * The lookup field with select options */ longDesc: () => LocalizedString } - parent_document_path: { + '1': { /** - * Parent Document Path + * Option */ displayName: () => LocalizedString /** - * Path to the parent document (optional) + * Option to find */ shortDesc: () => LocalizedString /** - * Optional path to a document whose subcollections you want to list. If not specified, lists root-level collections. Format: collection_id/document_id + * The select option value to find */ longDesc: () => LocalizedString } } } - get_collection: { + 'has-none-select-option-equal': { /** - * Get Collection + * doesn't have select option equal */ displayName: () => LocalizedString /** - * Get information about a Firestore collection + * Lookup has no select option */ shortDesc: () => LocalizedString /** - * Retrieves metadata and information about a specific Firestore collection. This includes checking if the collection exists, whether it has documents, and optionally retrieving sample documents from the collection. + * Returns `True` if the lookup field has no select option equal to the specified value */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Google Cloud project ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier for your Google Cloud project containing the Firestore database - */ - longDesc: () => LocalizedString - } - collection_id: { + args: { + '0': { /** - * Collection ID + * Field */ displayName: () => LocalizedString /** - * The ID of the collection + * Lookup field */ shortDesc: () => LocalizedString /** - * The identifier of the collection you want to retrieve information about. This is the collection name without any parent path. + * The lookup field with select options */ longDesc: () => LocalizedString } - parent_document_path: { + '1': { /** - * Parent Document Path + * Option */ displayName: () => LocalizedString /** - * Path to the parent document (optional) + * Option to exclude */ shortDesc: () => LocalizedString /** - * Optional path to the parent document if this is a subcollection. If not specified, assumes this is a root-level collection. Format: collection_id/document_id + * The select option value that should not be present */ longDesc: () => LocalizedString } - include_sample_documents: { + } + } + 'has-value-higher': { + /** + * has value higher than + */ + displayName: () => LocalizedString + /** + * Lookup value is greater than + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field has a numeric value greater than the specified number + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Include Sample Documents + * Field */ displayName: () => LocalizedString /** - * Whether to include sample documents + * Lookup field */ shortDesc: () => LocalizedString /** - * When true, includes sample documents from the collection in the response. This helps you understand the structure and content of the collection. + * The lookup field with numeric values */ longDesc: () => LocalizedString } - sample_limit: { + '1': { /** - * Sample Limit + * Number */ displayName: () => LocalizedString /** - * Number of sample documents to include + * Minimum value */ shortDesc: () => LocalizedString /** - * The maximum number of sample documents to retrieve when include_sample_documents is true. Default is 5. + * The number that lookup values should be greater than */ longDesc: () => LocalizedString } } } - query_documents: { + 'has-not-value-higher': { /** - * Query Documents + * doesn't have value higher than */ displayName: () => LocalizedString /** - * Query documents in a Firestore collection with filters and ordering + * Lookup value is not greater than */ shortDesc: () => LocalizedString /** - * Performs advanced queries on a Firestore collection with support for multiple filters, ordering, and limits. This allows you to search for specific documents based on field values and retrieve them in a particular order. + * Returns `True` if the lookup field does not have a numeric value greater than the specified number */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Google Cloud project ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier for your Google Cloud project containing the Firestore database - */ - longDesc: () => LocalizedString - } - collection_path: { + args: { + '0': { /** - * Collection Path + * Field */ displayName: () => LocalizedString /** - * The path to the Firestore collection + * Lookup field */ shortDesc: () => LocalizedString /** - * The full path to the collection you want to query. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + * The lookup field with numeric values */ longDesc: () => LocalizedString } - filters: { + '1': { /** - * Filters + * Number */ displayName: () => LocalizedString /** - * Filter criteria for documents + * Maximum value */ shortDesc: () => LocalizedString /** - * Optional list of filters to apply to the query. Multiple filters are combined with AND logic. Each filter specifies a field, comparison operator, and value to match. + * The number that lookup values should not be greater than */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The document field to filter on - */ - shortDesc: () => LocalizedString - /** - * The name of the field in the document to apply the filter to. The field must exist in the documents being queried. - */ - longDesc: () => LocalizedString - } - operator: { - /** - * Operator - */ - displayName: () => LocalizedString - /** - * The comparison operator - */ - shortDesc: () => LocalizedString - /** - * The comparison operator to use for filtering. Options include equality, inequality, comparison operators, and array operators. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to use in the comparison. The value type should match the field type in the documents (string, number, boolean, etc.). - */ - longDesc: () => LocalizedString - } - } - } - } } - order_by: { + } + } + 'has-value-higher-or-equal': { + /** + * has value higher than or equal + */ + displayName: () => LocalizedString + /** + * Lookup value is greater than or equal + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field has a numeric value greater than or equal to the specified number + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Order By + * Field */ displayName: () => LocalizedString /** - * Ordering criteria for results + * Lookup field */ shortDesc: () => LocalizedString /** - * Optional list of ordering criteria to apply to the query results. Documents will be sorted by the specified fields in the order they are listed. + * The lookup field with numeric values */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to order by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to use for ordering. The field must exist in the documents and be of a comparable type. - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort: ascending (lowest to highest) or descending (highest to lowest). - */ - longDesc: () => LocalizedString - } - } - } - } } - limit: { + '1': { /** - * Limit + * Number */ displayName: () => LocalizedString /** - * Maximum number of documents to return + * Minimum value */ shortDesc: () => LocalizedString /** - * The maximum number of documents to retrieve. Default is 100. Use this to control query performance and result set size. + * The number that lookup values should be greater than or equal to */ longDesc: () => LocalizedString } } } - backup_to_google_cloud_storage: { + 'has-not-value-higher-or-equal': { /** - * Backup to Google Cloud Storage + * doesn't have value higher than or equal */ displayName: () => LocalizedString /** - * Export Firestore data to Google Cloud Storage + * Lookup value is not greater than or equal */ shortDesc: () => LocalizedString /** - * Creates a backup of your Firestore database or specific collections by exporting the data to Google Cloud Storage. This is useful for disaster recovery, data migration, or creating snapshots of your database at a point in time. + * Returns `True` if the lookup field does not have a numeric value greater than or equal to the specified number */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Google Cloud project ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier for your Google Cloud project containing the Firestore database to backup - */ - longDesc: () => LocalizedString - } - output_uri_prefix: { + args: { + '0': { /** - * Output URI Prefix + * Field */ displayName: () => LocalizedString /** - * GCS bucket URI where backup will be stored + * Lookup field */ shortDesc: () => LocalizedString /** - * The Google Cloud Storage URI prefix where the backup files will be written. Format: gs://bucket-name/path/to/backup. The bucket must already exist and you must have write permissions. + * The lookup field with numeric values */ longDesc: () => LocalizedString } - collection_ids: { + '1': { /** - * Collection IDs + * Number */ displayName: () => LocalizedString /** - * Specific collections to backup (optional) + * Threshold value */ shortDesc: () => LocalizedString /** - * Optional list of collection IDs to backup. If not specified, the entire database will be backed up. Use this to create selective backups of specific collections. + * The number that lookup values should not be greater than or equal to */ longDesc: () => LocalizedString } } } - restore_from_google_cloud_storage: { + 'has-value-lower': { /** - * Restore from Google Cloud Storage + * has value lower than */ displayName: () => LocalizedString /** - * Import Firestore data from Google Cloud Storage + * Lookup value is less than */ shortDesc: () => LocalizedString /** - * Restores Firestore data from a previous backup stored in Google Cloud Storage. This operation can restore the entire database or specific collections. Warning: This will overwrite existing documents with the same IDs. + * Returns `True` if the lookup field has a numeric value less than the specified number */ longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The Google Cloud project ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier for your Google Cloud project where the data will be restored - */ - longDesc: () => LocalizedString - } - input_uri_prefix: { + args: { + '0': { /** - * Input URI Prefix + * Field */ displayName: () => LocalizedString /** - * GCS bucket URI where backup is stored + * Lookup field */ shortDesc: () => LocalizedString /** - * The Google Cloud Storage URI prefix where the backup files are located. This should match the output_uri_prefix used when creating the backup. Format: gs://bucket-name/path/to/backup + * The lookup field with numeric values */ longDesc: () => LocalizedString } - collection_ids: { + '1': { /** - * Collection IDs + * Number */ displayName: () => LocalizedString /** - * Specific collections to restore (optional) + * Maximum value */ shortDesc: () => LocalizedString /** - * Optional list of collection IDs to restore from the backup. If not specified, all collections in the backup will be restored. Use this to selectively restore specific collections. + * The number that lookup values should be less than */ longDesc: () => LocalizedString } } } - } - } - Sentry: { - /** - * Sentry - */ - displayName: () => LocalizedString - groups: { - /** - * DevOps & Cloud Infrastructure - */ - '0': () => LocalizedString - } - /** - * Monitor and fix errors, track performance issues, and maintain application health with the developer-first debugging platform. - */ - shortDesc: () => LocalizedString - /** - * The Sentry integration enables comprehensive error monitoring and performance tracking for your applications. Access projects, issues, events, and teams to quickly identify, triage, and resolve problems. With real-time alerts and detailed debugging context including stack traces, breadcrumbs, and user impact metrics, Sentry helps your team maintain code quality and deliver seamless user experiences. - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to Sentry - */ - title: () => LocalizedString - /** - * To connect to Sentry, you will need an **Auth Token** and your **Organization Slug**. - - ## Getting Your Auth Token - - ### Option 1: User Auth Token (Recommended for personal use) - 1. Log in to [Sentry](https://sentry.io/) - 2. Go to **Settings** → **Account** → **API** → **Auth Tokens** - 3. Click **Create New Token** - 4. Select the required scopes: - - `project:read` - Read project information - - `project:write` - Modify projects - - `org:read` - Read organization data - - `event:read` - Read events - - `member:read` - Read team members - 5. Click **Create Token** and copy it immediately - - Direct link: [sentry.io/settings/account/api/auth-tokens/](https://sentry.io/settings/account/api/auth-tokens/) - - ### Option 2: Internal Integration Token (Recommended for production) - 1. Go to **Settings** → **Developer Settings** → **Custom Integrations** - 2. Click **Create New Integration** → **Internal Integration** - 3. Configure the name and required permissions - 4. After saving, copy the generated token - - ## Finding Your Organization Slug - - Your organization slug is in your Sentry URL: - - If your Sentry URL is `https://your-org.sentry.io/`, your slug is `your-org` - - For sentry.io hosted accounts: `https://sentry.io/organizations/your-org/` → slug is `your-org` - - ## Connection Details - - ### Auth Token - Your Sentry authentication token. Starts with `sntrys_` for newer tokens or may have different prefixes for legacy tokens. - - ### Organization Slug - The URL-friendly identifier for your organization (found in your Sentry URL). - - **Note:** Auth tokens inherit permissions based on your user role and the scopes you selected. For production integrations, use Internal Integration tokens which can be scoped to specific permissions and managed at the organization level. - */ - content: () => LocalizedString - } - triggers: { - new_project_issue: { + 'has-not-value-lower': { /** - * New Project Issue + * doesn't have value lower than */ displayName: () => LocalizedString /** - * Triggers when a new issue is detected in a specific project + * Lookup value is not less than */ shortDesc: () => LocalizedString /** - * Monitors a specific Sentry project and triggers when a new issue (grouped error or problem) is detected. Issues represent single bugs or problems in your application, with events grouped by fingerprint. Use optional query filters and time periods to focus on specific types of issues. + * Returns `True` if the lookup field does not have a numeric value less than the specified number */ longDesc: () => LocalizedString - options: { - projectId: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The project to monitor for new issues - */ - shortDesc: () => LocalizedString - /** - * Select the Sentry project you want to monitor. Projects represent individual applications or services within your organization. - */ - longDesc: () => LocalizedString - } - query: { + args: { + '0': { /** - * Query Filter + * Field */ displayName: () => LocalizedString /** - * Optional search query to filter issues + * Lookup field */ shortDesc: () => LocalizedString /** - * Use Sentry query syntax to filter which issues trigger this event. For example, filter by browser, device, tags, or whether errors are unhandled. + * The lookup field with numeric values */ longDesc: () => LocalizedString } - statsPeriod: { + '1': { /** - * Statistics Period + * Number */ displayName: () => LocalizedString /** - * Time period for issue statistics + * Minimum value */ shortDesc: () => LocalizedString /** - * The time range for collecting issue statistics. Affects metrics like event counts and user impact within the selected period. + * The number that lookup values should not be less than */ longDesc: () => LocalizedString } } } - new_organization_issue: { + 'has-value-lower-or-equal': { /** - * New Organization Issue + * has value lower than or equal */ displayName: () => LocalizedString /** - * Triggers when a new issue is detected across the entire organization + * Lookup value is less than or equal */ shortDesc: () => LocalizedString /** - * Monitors all projects within your Sentry organization and triggers when a new issue is detected in any project. This provides organization-wide visibility into problems across all applications and services. Use query filters to focus on specific issue types or characteristics. + * Returns `True` if the lookup field has a numeric value less than or equal to the specified number */ longDesc: () => LocalizedString - options: { - query: { + args: { + '0': { /** - * Query Filter + * Field */ displayName: () => LocalizedString /** - * Optional search query to filter issues + * Lookup field */ shortDesc: () => LocalizedString /** - * Use Sentry query syntax to filter which issues trigger this event across all projects. Filter by properties like platform, environment, release, or custom tags. + * The lookup field with numeric values */ longDesc: () => LocalizedString } - statsPeriod: { + '1': { /** - * Statistics Period + * Number */ displayName: () => LocalizedString /** - * Time period for issue statistics + * Maximum value */ shortDesc: () => LocalizedString /** - * The time range for collecting issue statistics across all projects. Determines the time window for metrics like frequency and user impact. + * The number that lookup values should be less than or equal to */ longDesc: () => LocalizedString } } } - } - actions: { - list_projects: { + 'has-not-value-lower-or-equal': { /** - * List Projects + * doesn't have value lower than or equal */ displayName: () => LocalizedString /** - * Retrieve all projects in your organization + * Lookup value is not less than or equal */ shortDesc: () => LocalizedString /** - * Fetches a paginated list of all projects within your Sentry organization. Each project represents an individual application or service being monitored. Returns project details including name, platform, creation date, team membership, and configuration. + * Returns `True` if the lookup field does not have a numeric value less than or equal to the specified number */ longDesc: () => LocalizedString - options: { - cursor: { + args: { + '0': { /** - * Cursor + * Field */ displayName: () => LocalizedString /** - * Pagination cursor for retrieving additional results + * Lookup field */ shortDesc: () => LocalizedString /** - * Use the cursor from a previous response to fetch the next or previous page of results. Leave empty to start from the beginning. + * The lookup field with numeric values */ longDesc: () => LocalizedString } - } - } - get_project: { - /** - * Get Project Details - */ - displayName: () => LocalizedString - /** - * Retrieve detailed information about a specific project - */ - shortDesc: () => LocalizedString - /** - * Fetches comprehensive details about a specific Sentry project, including configuration options, team assignments, integrations, features, symbol sources, and project statistics. Use this to understand project settings and capabilities. - */ - longDesc: () => LocalizedString - options: { - projectId: { + '1': { /** - * Project ID + * Number */ displayName: () => LocalizedString /** - * The project to retrieve + * Threshold value */ shortDesc: () => LocalizedString /** - * Select or enter the slug identifier of the project you want to retrieve details for. + * The number that lookup values should not be less than or equal to */ longDesc: () => LocalizedString } } } - list_project_events: { + 'has-date-equal': { /** - * List Project Events + * has date equal */ displayName: () => LocalizedString /** - * Retrieve events from a specific project + * Lookup date equals */ shortDesc: () => LocalizedString /** - * Fetches a paginated list of events (individual error or transaction occurrences) from a specific project. Events are the raw data sent to Sentry and are grouped into issues. Use the full parameter to retrieve complete event payloads including context, breadcrumbs, and metadata. + * Returns `True` if the lookup field has a date equal to the specified date */ longDesc: () => LocalizedString - options: { - projectId: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The project to retrieve events from - */ - shortDesc: () => LocalizedString - /** - * Select the project whose events you want to list. - */ - longDesc: () => LocalizedString - } - full: { + args: { + '0': { /** - * Full Details + * Field */ displayName: () => LocalizedString /** - * Whether to return complete event data + * Lookup field */ shortDesc: () => LocalizedString /** - * When enabled, returns the full event payload including all context, breadcrumbs, stack traces, and metadata. When disabled, returns summary information only. + * The lookup field with date values */ longDesc: () => LocalizedString } - cursor: { + '1': { /** - * Cursor + * Date */ displayName: () => LocalizedString /** - * Pagination cursor for retrieving additional results + * Date to match */ shortDesc: () => LocalizedString /** - * Use the cursor from a previous response to navigate through pages of events. + * The date that lookup values should equal (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - get_event: { + 'has-not-date-equal': { /** - * Get Event Details + * doesn't have date equal */ displayName: () => LocalizedString /** - * Retrieve detailed information about a specific event + * Lookup date does not equal */ shortDesc: () => LocalizedString /** - * Fetches complete details about a specific event, including the full stack trace, breadcrumbs (trail of events leading to the error), user context, device information, tags, SDK details, and all captured metadata. Essential for debugging and understanding the exact conditions when an error occurred. + * Returns `True` if the lookup field does not have a date equal to the specified date */ longDesc: () => LocalizedString - options: { - projectId: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The project containing the event + * Lookup field */ shortDesc: () => LocalizedString /** - * Select the project that the event belongs to. + * The lookup field with date values */ longDesc: () => LocalizedString } - eventId: { + '1': { /** - * Event ID + * Date */ displayName: () => LocalizedString /** - * The unique identifier of the event + * Date to exclude */ shortDesc: () => LocalizedString /** - * Enter the event ID (hexadecimal string) you want to retrieve. Event IDs can be found in issue details or event listings. + * The date that lookup values should not equal (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - list_project_issues: { + 'has-date-before': { /** - * List Project Issues + * has date before */ displayName: () => LocalizedString /** - * Retrieve issues from a specific project + * Lookup date is before */ shortDesc: () => LocalizedString /** - * Fetches a paginated list of issues (grouped errors or problems) from a specific project. Issues represent single bugs affecting your application, with multiple event occurrences grouped by fingerprint. Filter by query to find specific types of issues, and use statistics period to see relevant metrics. + * Returns `True` if the lookup field has a date before the specified date */ longDesc: () => LocalizedString - options: { - projectId: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The project to retrieve issues from - */ - shortDesc: () => LocalizedString - /** - * Select the project whose issues you want to list. - */ - longDesc: () => LocalizedString - } - query: { + args: { + '0': { /** - * Query Filter + * Field */ displayName: () => LocalizedString /** - * Search query to filter issues + * Lookup field */ shortDesc: () => LocalizedString /** - * Use Sentry query syntax to filter issues by properties like status, assignee, tags, platform, or time range. Example: "is:unresolved assigned:me" + * The lookup field with date values */ longDesc: () => LocalizedString } - statsPeriod: { + '1': { /** - * Statistics Period + * Date */ displayName: () => LocalizedString /** - * Time period for issue statistics + * Maximum date */ shortDesc: () => LocalizedString /** - * The time range for calculating issue statistics such as event count, frequency, and user impact. + * The date that lookup values should be before (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } - shortIdLookup: { + } + } + 'has-not-date-before': { + /** + * doesn't have date before + */ + displayName: () => LocalizedString + /** + * Lookup date is not before + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field does not have a date before the specified date + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Short ID Lookup + * Field */ displayName: () => LocalizedString /** - * Whether to look up issues by their short ID + * Lookup field */ shortDesc: () => LocalizedString /** - * When enabled, allows searching for issues using their short IDs (e.g., PROJECT-123) instead of full issue IDs. + * The lookup field with date values */ longDesc: () => LocalizedString } - cursor: { + '1': { /** - * Cursor + * Date */ displayName: () => LocalizedString /** - * Pagination cursor for retrieving additional results + * Threshold date */ shortDesc: () => LocalizedString /** - * Use the cursor from a previous response to navigate through pages of issues. + * The date that lookup values should not be before (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - list_organization_issues: { + 'has-date-on-or-before': { /** - * List Organization Issues + * has date on or before */ displayName: () => LocalizedString /** - * Retrieve issues across the entire organization + * Lookup date is on or before */ shortDesc: () => LocalizedString /** - * Fetches a paginated list of issues from all projects within your organization. This provides organization-wide visibility into problems across all applications and services. Use query filters to narrow down results by project, platform, status, or other criteria. + * Returns `True` if the lookup field has a date on or before the specified date */ longDesc: () => LocalizedString - options: { - query: { + args: { + '0': { /** - * Query Filter + * Field */ displayName: () => LocalizedString /** - * Search query to filter issues + * Lookup field */ shortDesc: () => LocalizedString /** - * Use Sentry query syntax to filter issues across all projects. Filter by project, platform, environment, status, tags, or any other issue property. + * The lookup field with date values */ longDesc: () => LocalizedString } - statsPeriod: { + '1': { /** - * Statistics Period + * Date */ displayName: () => LocalizedString /** - * Time period for issue statistics + * Maximum date */ shortDesc: () => LocalizedString /** - * The time range for calculating issue statistics and metrics across the organization. + * The date that lookup values should be on or before (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } - shortIdLookup: { + } + } + 'has-not-date-on-or-before': { + /** + * doesn't have date on or before + */ + displayName: () => LocalizedString + /** + * Lookup date is not on or before + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field does not have a date on or before the specified date + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Short ID Lookup + * Field */ displayName: () => LocalizedString /** - * Whether to look up issues by their short ID + * Lookup field */ shortDesc: () => LocalizedString /** - * When enabled, allows searching for issues using their short IDs across all projects. + * The lookup field with date values */ longDesc: () => LocalizedString } - cursor: { + '1': { /** - * Cursor + * Date */ displayName: () => LocalizedString /** - * Pagination cursor for retrieving additional results + * Threshold date */ shortDesc: () => LocalizedString /** - * Use the cursor from a previous response to retrieve additional pages of organization-wide issues. + * The date that lookup values should not be on or before (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - get_issue: { + 'has-date-after': { /** - * Get Issue Details + * has date after */ displayName: () => LocalizedString /** - * Retrieve detailed information about a specific issue + * Lookup date is after */ shortDesc: () => LocalizedString /** - * Fetches comprehensive details about a specific issue, including its status, metadata, assignment, statistics (event count, user impact, frequency), participants, activity history, linked integrations, and the latest event details. Essential for understanding the full context and history of a problem. + * Returns `True` if the lookup field has a date after the specified date */ longDesc: () => LocalizedString - options: { - issueId: { + args: { + '0': { /** - * Issue ID + * Field */ displayName: () => LocalizedString /** - * The unique identifier of the issue + * Lookup field */ shortDesc: () => LocalizedString /** - * Enter the issue ID you want to retrieve. Issue IDs are numeric values that can be found in the Sentry UI or from list operations. + * The lookup field with date values + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Date + */ + displayName: () => LocalizedString + /** + * Minimum date + */ + shortDesc: () => LocalizedString + /** + * The date that lookup values should be after (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } } } - update_issue: { + 'has-not-date-after': { /** - * Update Issue + * doesn't have date after */ displayName: () => LocalizedString /** - * Update the status or properties of an issue + * Lookup date is not after */ shortDesc: () => LocalizedString /** - * Modifies an issue's status (resolved, unresolved, ignored), assignment, bookmarked state, subscription status, or visibility. Use this to triage issues, assign them to team members, resolve bugs, or mark issues as ignored. Status changes can trigger alerts and affect issue grouping. + * Returns `True` if the lookup field does not have a date after the specified date */ longDesc: () => LocalizedString - options: { - projectId: { + args: { + '0': { /** - * Project ID + * Field */ displayName: () => LocalizedString /** - * The project containing the issue (optional) + * Lookup field */ shortDesc: () => LocalizedString /** - * Optionally specify the project for context. While issues can be updated by ID alone, providing the project can be helpful for organization. + * The lookup field with date values */ longDesc: () => LocalizedString } - issueId: { + '1': { /** - * Issue ID + * Date */ displayName: () => LocalizedString /** - * The unique identifier of the issue to update + * Threshold date */ shortDesc: () => LocalizedString /** - * Enter the issue ID you want to update. You can find issue IDs in the Sentry UI or from list/search operations. + * The date that lookup values should not be after (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } - status: { + } + } + 'has-date-on-or-after': { + /** + * has date on or after + */ + displayName: () => LocalizedString + /** + * Lookup date is on or after + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field has a date on or after the specified date + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Status + * Field */ displayName: () => LocalizedString /** - * The new status for the issue + * Lookup field */ shortDesc: () => LocalizedString /** - * Change the issue status to control its lifecycle. "Resolved" marks it as fixed, "Unresolved" reopens it, "Ignored" archives it temporarily, and "Resolved in Next Release" indicates it will be fixed in an upcoming deployment. + * The lookup field with date values */ longDesc: () => LocalizedString } - assignedTo: { + '1': { /** - * Assigned To + * Date */ displayName: () => LocalizedString /** - * User or team to assign the issue to + * Minimum date */ shortDesc: () => LocalizedString /** - * Assign the issue to a specific user or team for ownership and accountability. Enter a team slug (e.g., "team:backend") or user ID. + * The date that lookup values should be on or after (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } - hasSeen: { + } + } + 'has-not-date-on-or-after': { + /** + * doesn't have date on or after + */ + displayName: () => LocalizedString + /** + * Lookup date is not on or after + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field does not have a date on or after the specified date + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Has Seen + * Field */ displayName: () => LocalizedString /** - * Mark whether the issue has been viewed + * Lookup field */ shortDesc: () => LocalizedString /** - * Mark the issue as seen (reviewed) or unseen. This helps track which issues have been triaged by your team. + * The lookup field with date values */ longDesc: () => LocalizedString } - isBookmarked: { + '1': { /** - * Is Bookmarked + * Date */ displayName: () => LocalizedString /** - * Bookmark status for the issue + * Threshold date */ shortDesc: () => LocalizedString /** - * Bookmark the issue for easy access and filtering. Bookmarked issues appear in your personal issue list. + * The date that lookup values should not be on or after (format: YYYY-MM-DD) */ longDesc: () => LocalizedString } - isSubscribed: { + } + } + 'has-date-within': { + /** + * has date within + */ + displayName: () => LocalizedString + /** + * Lookup date is within period + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the lookup field has a date within the specified time period + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Is Subscribed + * Field */ displayName: () => LocalizedString /** - * Subscription status for notifications + * Lookup field */ shortDesc: () => LocalizedString /** - * Subscribe to or unsubscribe from notifications about this issue. When subscribed, you'll receive alerts when the issue changes or escalates. + * The lookup field with date values */ longDesc: () => LocalizedString } - isPublic: { + '1': { /** - * Is Public + * Period */ displayName: () => LocalizedString /** - * Whether the issue should be publicly accessible + * Time period */ shortDesc: () => LocalizedString /** - * Control whether the issue is publicly visible via a share link. Public issues can be viewed by anyone with the link, even without Sentry access. + * The time period to check (e.g., "today", "this_week", "last_month") */ longDesc: () => LocalizedString } } } - list_teams: { + 'has-not-date-within': { /** - * List Teams + * doesn't have date within */ displayName: () => LocalizedString /** - * Retrieve all teams in your organization + * Lookup date is not within period */ shortDesc: () => LocalizedString /** - * Fetches a paginated list of all teams within your Sentry organization. Teams represent groups of developers working together on projects. Returns team details including member count, access permissions, role assignments, linked projects, and external team integrations. + * Returns `True` if the lookup field does not have a date within the specified time period */ longDesc: () => LocalizedString - options: { - cursor: { + args: { + '0': { /** - * Cursor + * Field */ displayName: () => LocalizedString /** - * Pagination cursor for retrieving additional results + * Lookup field */ shortDesc: () => LocalizedString /** - * Use the cursor from a previous response to navigate through pages of teams. + * The lookup field with date values */ longDesc: () => LocalizedString } - } - } - get_team: { - /** - * Get Team Details - */ - displayName: () => LocalizedString - /** - * Retrieve detailed information about a specific team - */ - shortDesc: () => LocalizedString - /** - * Fetches comprehensive details about a specific team, including its members, assigned projects, access permissions, role settings, external integrations (like Slack channels), and organization-level role. Use this to understand team structure and project ownership. - */ - longDesc: () => LocalizedString - options: { - teamId: { + '1': { /** - * Team ID + * Period */ displayName: () => LocalizedString /** - * The team slug to retrieve + * Time period */ shortDesc: () => LocalizedString /** - * Enter the team slug (URL-friendly identifier) of the team you want to retrieve details for. + * The time period to exclude (e.g., "today", "this_week", "last_month") */ longDesc: () => LocalizedString } @@ -149993,2751 +150758,2333 @@ export type TranslationFunctions = { } } } - Patreon: { + Firestore: { /** - * Patreon + * Firestore */ displayName: () => LocalizedString groups: { /** - * Social Media Management + * Databases & Backend Services */ '0': () => LocalizedString } /** - * Connect to Patreon to manage your creator content, memberships, and patron relationships. + * Connect to Google Cloud Firestore to manage your NoSQL document database. */ shortDesc: () => LocalizedString /** - * The Patreon integration enables creators to automate their patron management workflows. Access patron data, manage memberships, track campaigns, and engage with your community through comprehensive API actions and real-time triggers for patron activities. + * The Firestore integration enables you to interact with Google Cloud Firestore, a flexible, scalable NoSQL cloud database. Create, read, update, and delete documents, manage collections, and execute queries to automate your document database operations seamlessly. */ longDesc: () => LocalizedString - actions: { - list_campaigns: { + triggers: { + new_document: { /** - * List Campaigns + * New Document */ displayName: () => LocalizedString /** - * Retrieve a list of campaigns for the authenticated creator + * Triggers when a new document is created in a Firestore collection */ shortDesc: () => LocalizedString /** - * Fetches a paginated list of campaigns associated with the authenticated Patreon account. Returns comprehensive campaign information including patron counts, settings, and metadata. + * Monitors a Firestore collection for newly created documents. Documents are ordered based on your specified criteria, and the trigger activates when new documents appear at the top of the ordered list. You can optionally filter documents and customize the ordering to track specific types of documents. */ longDesc: () => LocalizedString options: { - count: { + project_id: { /** - * Count + * Project ID */ displayName: () => LocalizedString /** - * Maximum number of campaigns to return + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * Specifies the maximum number of campaigns to retrieve in a single request. Defaults to 20 if not specified. + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - cursor: { + collection_path: { /** - * Cursor + * Collection Path */ displayName: () => LocalizedString /** - * Pagination cursor for retrieving the next set of results + * The path to the Firestore collection */ shortDesc: () => LocalizedString /** - * Use the cursor returned from a previous request to fetch the next page of campaigns. Leave empty for the first page. + * The full path to the collection you want to monitor. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + */ + longDesc: () => LocalizedString + } + filters: { + /** + * Filters + */ + displayName: () => LocalizedString + /** + * Optional filters to apply to documents + */ + shortDesc: () => LocalizedString + /** + * Define one or more filters to narrow down which documents will trigger the event. Multiple filters are combined with AND logic. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The document field to filter on + */ + shortDesc: () => LocalizedString + /** + * Select the field name in the document that you want to filter + */ + longDesc: () => LocalizedString + } + operator: { + /** + * Operator + */ + displayName: () => LocalizedString + /** + * The comparison operator + */ + shortDesc: () => LocalizedString + /** + * The comparison operation to perform between the field value and your specified value + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * The value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to use in the comparison. The value will be automatically converted to the appropriate type (string, number, boolean, or null) + */ + longDesc: () => LocalizedString + } + } + } + } + } + order_by: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Specify how to order documents + */ + shortDesc: () => LocalizedString + /** + * Define the ordering criteria for documents. The trigger will activate for documents that appear at the top of the ordered list. If not specified, documents are ordered by creation time in descending order (newest first). */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to order by + */ + shortDesc: () => LocalizedString + /** + * Select the document field to use for ordering + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * Choose ascending (oldest/smallest first) or descending (newest/largest first) order + */ + longDesc: () => LocalizedString + } + } + } } } } - list_campaign_members: { + } + actions: { + list_projects: { /** - * List Campaign Members + * List Projects */ displayName: () => LocalizedString /** - * Retrieve members of a specific campaign + * List all Google Cloud projects accessible with the current credentials */ shortDesc: () => LocalizedString /** - * Fetches a paginated list of members (patrons) for a specified campaign. Returns detailed member information including pledge amounts, payment status, and membership details. + * Retrieves a list of all Google Cloud projects that are accessible with your credentials. You can filter projects by name and use pagination to navigate through large result sets. This is useful for discovering which projects contain Firestore databases. */ longDesc: () => LocalizedString options: { - campaignId: { + name: { /** - * Campaign ID + * Project Name */ displayName: () => LocalizedString /** - * The ID of the campaign to retrieve members from + * Filter projects by name */ shortDesc: () => LocalizedString /** - * Select the campaign whose members you want to retrieve. This is a required field. + * Optional filter to search for projects containing this name. The search is case-insensitive and matches partial names. */ longDesc: () => LocalizedString } - count: { + page_size: { /** - * Count + * Page Size */ displayName: () => LocalizedString /** - * Maximum number of members to return + * Number of projects to return per page */ shortDesc: () => LocalizedString /** - * Specifies the maximum number of members to retrieve in a single request. Defaults to 20 if not specified. + * The maximum number of projects to return in a single request. Default is 100. Use this with pagination tokens to retrieve large result sets. */ longDesc: () => LocalizedString } - cursor: { + next_page_token: { /** - * Cursor + * Next Page Token */ displayName: () => LocalizedString /** - * Pagination cursor for retrieving the next set of results + * Token for retrieving the next page of results */ shortDesc: () => LocalizedString /** - * Use the cursor returned from a previous request to fetch the next page of members. Leave empty for the first page. + * Pagination token obtained from a previous request. Use this to retrieve the next page of projects when there are more results than the page size. */ longDesc: () => LocalizedString } } } - get_campaign: { + create_document: { + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } /** - * Get Campaign + * Create Document */ displayName: () => LocalizedString /** - * Retrieve detailed information about a specific campaign + * Create a new document in a Firestore collection */ shortDesc: () => LocalizedString /** - * Fetches comprehensive details about a single campaign including summary, creation details, social media integration, RSS feed settings, and patron statistics. + * Creates a new document in the specified Firestore collection. You can either let Firestore auto-generate a document ID or provide your own. The document data can be specified through structured fields or as a custom hash object. */ longDesc: () => LocalizedString options: { - campaignId: { + project_id: { /** - * Campaign ID + * Project ID */ displayName: () => LocalizedString /** - * The ID of the campaign to retrieve + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * Select the campaign you want to get detailed information about. This is a required field. + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - } - } - get_member: { - /** - * Get Member - */ - displayName: () => LocalizedString - /** - * Retrieve detailed information about a specific member - */ - shortDesc: () => LocalizedString - /** - * Fetches comprehensive details about a single campaign member (patron) including pledge amounts, payment history, membership status, and relationship timeline. - */ - longDesc: () => LocalizedString - options: { - campaignId: { + collection_path: { /** - * Campaign ID + * Collection Path */ displayName: () => LocalizedString /** - * The campaign to filter members from + * The path to the Firestore collection */ shortDesc: () => LocalizedString /** - * Optionally select a campaign to filter the member selection. This helps narrow down the member list when searching. + * The full path to the collection where the document will be created. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection */ longDesc: () => LocalizedString } - memberId: { + document_id: { /** - * Member ID + * Document ID */ displayName: () => LocalizedString /** - * The ID of the member to retrieve + * Custom document ID (optional) */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the member (patron) whose details you want to retrieve. This is a required field. + * Optional custom identifier for the document. If not provided, Firestore will auto-generate a unique ID. Document IDs must be valid UTF-8 strings and cannot contain forward slashes. + */ + longDesc: () => LocalizedString + } + data: { + /** + * Document Data + */ + displayName: () => LocalizedString + /** + * The data to store in the document + */ + shortDesc: () => LocalizedString + /** + * The structured data to store in the document. This will be dynamically typed based on the collection schema if available. Each field will be stored with its appropriate Firestore data type. + */ + longDesc: () => LocalizedString + } + additional_data: { + /** + * Additional Data + */ + displayName: () => LocalizedString + /** + * Additional fields to include in the document + */ + shortDesc: () => LocalizedString + /** + * Optional additional fields to merge with the structured data. Use this to add fields that are not part of the predefined schema or to include dynamic fields. */ longDesc: () => LocalizedString } } } - list_posts: { + get_document: { + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } /** - * List Posts + * Get Document */ displayName: () => LocalizedString /** - * Retrieve posts from a specific campaign + * Retrieve a specific document from a Firestore collection */ shortDesc: () => LocalizedString /** - * Fetches a paginated list of posts from a specified campaign, sorted by publish date. Returns post content, metadata, and engagement information. + * Fetches a single document by its ID from a Firestore collection. Returns the complete document data including metadata such as creation time and last update time. This action will fail if the document does not exist. */ longDesc: () => LocalizedString options: { - campaignId: { + project_id: { /** - * Campaign ID + * Project ID */ displayName: () => LocalizedString /** - * The ID of the campaign to retrieve posts from + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * Select the campaign whose posts you want to retrieve. This is a required field. + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - count: { + collection_path: { /** - * Count + * Collection Path */ displayName: () => LocalizedString /** - * Maximum number of posts to return + * The path to the Firestore collection */ shortDesc: () => LocalizedString /** - * Specifies the maximum number of posts to retrieve in a single request. Defaults to 20 if not specified. + * The full path to the collection containing the document. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection */ longDesc: () => LocalizedString } - cursor: { + document_id: { /** - * Cursor + * Document ID */ displayName: () => LocalizedString /** - * Pagination cursor for retrieving the next set of results + * The ID of the document to retrieve */ shortDesc: () => LocalizedString /** - * Use the cursor returned from a previous request to fetch the next page of posts. Leave empty for the first page. + * The unique identifier of the document you want to retrieve. This is the document ID that was either auto-generated or specified when the document was created. */ longDesc: () => LocalizedString } } } - get_post: { + update_document: { + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } /** - * Get Post + * Update Document */ displayName: () => LocalizedString /** - * Retrieve detailed information about a specific post + * Update an existing document in a Firestore collection */ shortDesc: () => LocalizedString /** - * Fetches comprehensive details about a single post including content, publish information, access settings, and engagement metrics. + * Updates an existing document in Firestore with new data. You can choose to merge the new data with existing fields or replace the entire document. By default, the update merges new fields while preserving unspecified fields. */ longDesc: () => LocalizedString options: { - campaignId: { + project_id: { /** - * Campaign ID + * Project ID */ displayName: () => LocalizedString /** - * The campaign to filter posts from + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * Optionally select a campaign to filter the post selection. This helps narrow down the post list when searching. + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - postId: { + collection_path: { /** - * Post ID + * Collection Path */ displayName: () => LocalizedString /** - * The ID of the post to retrieve + * The path to the Firestore collection */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the post whose details you want to retrieve. This is a required field. + * The full path to the collection containing the document. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + */ + longDesc: () => LocalizedString + } + document_id: { + /** + * Document ID + */ + displayName: () => LocalizedString + /** + * The ID of the document to update + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the document you want to update. The document must exist or the operation will fail. + */ + longDesc: () => LocalizedString + } + data: { + /** + * Document Data + */ + displayName: () => LocalizedString + /** + * The new data for the document + */ + shortDesc: () => LocalizedString + /** + * The data to update in the document. When merge is enabled, only the specified fields will be updated. When merge is disabled, this data will replace the entire document. + */ + longDesc: () => LocalizedString + } + additional_data: { + /** + * Additional Data + */ + displayName: () => LocalizedString + /** + * Additional fields to update + */ + shortDesc: () => LocalizedString + /** + * Optional additional fields to merge with the structured data. Use this to update fields that are not part of the predefined schema or to include dynamic fields. + */ + longDesc: () => LocalizedString + } + merge: { + /** + * Merge + */ + displayName: () => LocalizedString + /** + * Whether to merge with existing data + */ + shortDesc: () => LocalizedString + /** + * When true (default), only the specified fields are updated and other fields remain unchanged. When false, the entire document is replaced with the new data. */ longDesc: () => LocalizedString } } } - } - triggers: { - pledge_trigger: { + delete_document: { + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } /** - * Pledge Event + * Delete Document */ displayName: () => LocalizedString /** - * Triggers when a pledge is created, updated, or deleted + * Delete a document from a Firestore collection */ shortDesc: () => LocalizedString /** - * Monitors pledge events for a specific campaign using Patreon webhooks. This trigger fires when a member creates, updates, or deletes their pledge, allowing you to automate workflows based on patron pledge activity. + * Permanently deletes a document from a Firestore collection. This operation cannot be undone. The document must exist or the operation will fail. All subcollections under the document will NOT be automatically deleted. */ longDesc: () => LocalizedString options: { - campaignId: { + project_id: { /** - * Campaign ID + * Project ID */ displayName: () => LocalizedString /** - * The campaign to monitor for pledge events + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * Select the campaign you want to monitor for pledge-related events. This is a required field. + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - trigger: { + collection_path: { /** - * Trigger Event + * Collection Path */ displayName: () => LocalizedString /** - * The specific pledge event to monitor + * The path to the Firestore collection */ shortDesc: () => LocalizedString /** - * Select which type of pledge event should trigger this workflow. Choose from pledge creation (when a member first pledges or a follower becomes a patron), pledge updates (upgrades or downgrades), or pledge deletion. + * The full path to the collection containing the document. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + */ + longDesc: () => LocalizedString + } + document_id: { + /** + * Document ID + */ + displayName: () => LocalizedString + /** + * The ID of the document to delete + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the document you want to delete. The document must exist or the operation will fail. */ longDesc: () => LocalizedString } } } - member_trigger: { + list_documents: { + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } /** - * Member Event + * List Documents */ displayName: () => LocalizedString /** - * Triggers when a member is created, updated, or deleted + * List all documents in a Firestore collection */ shortDesc: () => LocalizedString /** - * Monitors member events for a specific campaign using Patreon webhooks. This trigger fires when a member is created, their information is updated (including payment charging events), or their membership is deleted. + * Retrieves all documents from a specified Firestore collection. You can limit the number of results and specify ordering criteria. This action returns the complete document data along with metadata for each document. */ longDesc: () => LocalizedString options: { - campaignId: { + project_id: { /** - * Campaign ID + * Project ID */ displayName: () => LocalizedString /** - * The campaign to monitor for member events + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * Select the campaign you want to monitor for member-related events. This is a required field. + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - trigger: { + collection_path: { /** - * Trigger Event + * Collection Path */ displayName: () => LocalizedString /** - * The specific member event to monitor + * The path to the Firestore collection */ shortDesc: () => LocalizedString /** - * Select which type of member event should trigger this workflow. Member creation occurs only if there was no prior payment between patron and creator. Updates include payment charging events. Deletion only occurs if no prior payment happened. + * The full path to the collection whose documents you want to list. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of documents to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of documents to retrieve. Default is 100. Use this to control the size of the result set and improve performance. + */ + longDesc: () => LocalizedString + } + order_by: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Field to order documents by + */ + shortDesc: () => LocalizedString + /** + * Optional field name to use for ordering the documents. The field must exist in the documents and be of a comparable type (string, number, date). + */ + longDesc: () => LocalizedString + } + order_direction: { + /** + * Order Direction + */ + displayName: () => LocalizedString + /** + * Sort direction for ordering + */ + shortDesc: () => LocalizedString + /** + * The direction to sort documents when an order_by field is specified. Choose ascending for lowest to highest or descending for highest to lowest. */ longDesc: () => LocalizedString } } } - post_trigger: { + list_collections: { + groups: { + /** + * Collections + */ + '0': () => LocalizedString + } /** - * Post Event + * List Collections */ displayName: () => LocalizedString /** - * Triggers when a post is published, updated, or deleted + * List all collections in a Firestore database or document */ shortDesc: () => LocalizedString /** - * Monitors post events for a specific campaign using Patreon webhooks. This trigger fires when a post is published, updated, or deleted on the campaign, allowing you to automate content distribution and notifications. + * Retrieves all collection IDs at the root level of a Firestore database or within a specific document. This is useful for discovering the structure of your Firestore database and navigating nested collections. */ longDesc: () => LocalizedString options: { - campaignId: { + project_id: { /** - * Campaign ID + * Project ID */ displayName: () => LocalizedString /** - * The campaign to monitor for post events + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * Select the campaign you want to monitor for post-related events. This is a required field. + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - trigger: { + parent_document_path: { /** - * Trigger Event + * Parent Document Path */ displayName: () => LocalizedString /** - * The specific post event to monitor + * Path to the parent document (optional) */ shortDesc: () => LocalizedString /** - * Select which type of post event should trigger this workflow. Choose from post publication, post updates, or post deletion events. + * Optional path to a document whose subcollections you want to list. If not specified, lists root-level collections. Format: collection_id/document_id */ longDesc: () => LocalizedString } } } - } - } - Asana: { - /** - * Asana - */ - displayName: () => LocalizedString - groups: { - /** - * Project & Task Management - */ - '0': () => LocalizedString - } - /** - * Automate workflows by integrating with the Asana project management platform - */ - shortDesc: () => LocalizedString - /** - * Connect to Asana to automate task management, project monitoring, and team collaboration workflows. Use these triggers to respond to changes in tasks, projects, and workspaces. - */ - longDesc: () => LocalizedString - triggers: { - task_completed: { + get_collection: { /** - * Task Completed + * Get Collection */ displayName: () => LocalizedString /** - * Triggers when a task is marked complete in a specific project + * Get information about a Firestore collection */ shortDesc: () => LocalizedString /** - * Initiates a workflow when any task within the specified project is marked as completed. Use this to automate follow-up actions or notifications upon task completion. + * Retrieves metadata and information about a specific Firestore collection. This includes checking if the collection exists, whether it has documents, and optionally retrieving sample documents from the collection. */ longDesc: () => LocalizedString options: { - project: { + project_id: { /** * Project ID */ displayName: () => LocalizedString /** - * The project containing the completed tasks + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where task completions will be monitored + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - workspace: { + collection_id: { /** - * Workspace ID + * Collection ID */ displayName: () => LocalizedString /** - * The workspace containing the project + * The ID of the collection */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where the project exists + * The identifier of the collection you want to retrieve information about. This is the collection name without any parent path. */ longDesc: () => LocalizedString } - } - event_info: { - /** - * Event data - */ - desc: () => LocalizedString - type: { - fields: { - events: { - /** - * Events - */ - displayName: () => LocalizedString - /** - * List of event objects - */ - shortDesc: () => LocalizedString - /** - * An array containing event objects that represent individual changes or actions within Asana. - */ - longDesc: () => LocalizedString - type: { - fields: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Type of action performed - */ - shortDesc: () => LocalizedString - /** - * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - parent: { - /** - * Parent Resource - */ - displayName: () => LocalizedString - /** - * Parent resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Parent GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the parent resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Parent Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the parent resource, such as 'project' or 'task'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Parent Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the parent resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - resource: { - /** - * Resource - */ - displayName: () => LocalizedString - /** - * Affected resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the resource that was directly affected by the event; in this case, the task that was completed. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Resource GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the resource, which would be 'task' for task completion events. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - change: { - /** - * Change Details - */ - displayName: () => LocalizedString - /** - * Details of the change - */ - shortDesc: () => LocalizedString - /** - * Specific information about the change that occurred, including the field affected and the nature of the change. - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Changed Field - */ - displayName: () => LocalizedString - /** - * Field that was changed - */ - shortDesc: () => LocalizedString - /** - * The specific field within the resource that was modified; for task completion, this is 'completed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - action: { - /** - * Change Action - */ - displayName: () => LocalizedString - /** - * Nature of the change - */ - shortDesc: () => LocalizedString - /** - * Describes how the field was changed; for task completion, this is 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * User details - */ - shortDesc: () => LocalizedString - /** - * Information about the user who initiated the action that triggered the event. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * User GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the user - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the user within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * User Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the user resource - */ - shortDesc: () => LocalizedString - /** - * The resource type, typically 'user', indicating the entity is a user. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - created_at: { - /** - * Creation Timestamp - */ - displayName: () => LocalizedString - /** - * Event creation time - */ - shortDesc: () => LocalizedString - /** - * The timestamp indicating when the event was created. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - } + parent_document_path: { + /** + * Parent Document Path + */ + displayName: () => LocalizedString + /** + * Path to the parent document (optional) + */ + shortDesc: () => LocalizedString + /** + * Optional path to the parent document if this is a subcollection. If not specified, assumes this is a root-level collection. Format: collection_id/document_id + */ + longDesc: () => LocalizedString + } + include_sample_documents: { + /** + * Include Sample Documents + */ + displayName: () => LocalizedString + /** + * Whether to include sample documents + */ + shortDesc: () => LocalizedString + /** + * When true, includes sample documents from the collection in the response. This helps you understand the structure and content of the collection. + */ + longDesc: () => LocalizedString + } + sample_limit: { + /** + * Sample Limit + */ + displayName: () => LocalizedString + /** + * Number of sample documents to include + */ + shortDesc: () => LocalizedString + /** + * The maximum number of sample documents to retrieve when include_sample_documents is true. Default is 5. + */ + longDesc: () => LocalizedString } } } - attachment_added: { + query_documents: { /** - * Attachment Added + * Query Documents */ displayName: () => LocalizedString /** - * Triggers when an attachment is uploaded to a task + * Query documents in a Firestore collection with filters and ordering */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a file is attached to any task within the specified project. Optionally filter by a specific task. Use this to process or track files as they are added to tasks. + * Performs advanced queries on a Firestore collection with support for multiple filters, ordering, and limits. This allows you to search for specific documents based on field values and retrieve them in a particular order. */ longDesc: () => LocalizedString options: { - project: { + project_id: { /** * Project ID */ displayName: () => LocalizedString /** - * The project containing the tasks with attachments + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where attachment activities will be monitored + * The unique identifier for your Google Cloud project containing the Firestore database */ longDesc: () => LocalizedString } - task: { + collection_path: { /** - * Task ID (Optional) + * Collection Path */ displayName: () => LocalizedString /** - * Specific task to monitor for attachments + * The path to the Firestore collection */ shortDesc: () => LocalizedString /** - * The unique identifier of a specific task to monitor. If not provided, attachments from all tasks in the project will trigger the workflow + * The full path to the collection you want to query. For nested collections, use the format: parent_collection/parent_doc_id/nested_collection */ longDesc: () => LocalizedString } - workspace: { + filters: { /** - * Workspace ID + * Filters */ displayName: () => LocalizedString /** - * The workspace containing the project + * Filter criteria for documents */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where the project exists + * Optional list of filters to apply to the query. Multiple filters are combined with AND logic. Each filter specifies a field, comparison operator, and value to match. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The document field to filter on + */ + shortDesc: () => LocalizedString + /** + * The name of the field in the document to apply the filter to. The field must exist in the documents being queried. + */ + longDesc: () => LocalizedString + } + operator: { + /** + * Operator + */ + displayName: () => LocalizedString + /** + * The comparison operator + */ + shortDesc: () => LocalizedString + /** + * The comparison operator to use for filtering. Options include equality, inequality, comparison operators, and array operators. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * The value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to use in the comparison. The value type should match the field type in the documents (string, number, boolean, etc.). + */ + longDesc: () => LocalizedString + } + } + } + } } - } - event_info: { - /** - * Event data - */ - desc: () => LocalizedString - type: { - fields: { - events: { - /** - * Events - */ - displayName: () => LocalizedString - /** - * List of event objects - */ - shortDesc: () => LocalizedString - /** - * An array containing event objects that represent individual changes or actions within Asana. - */ - longDesc: () => LocalizedString - type: { - fields: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Type of action performed - */ - shortDesc: () => LocalizedString - /** - * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - parent: { - /** - * Parent Resource - */ - displayName: () => LocalizedString - /** - * Parent resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Parent GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the parent resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Parent Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the parent resource, such as 'project' or 'task'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Parent Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the parent resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - resource: { - /** - * Resource - */ - displayName: () => LocalizedString - /** - * Affected resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the resource that was directly affected by the event; in this case, the task that was completed. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Resource GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the resource, which would be 'task' for task completion events. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - change: { - /** - * Change Details - */ - displayName: () => LocalizedString - /** - * Details of the change - */ - shortDesc: () => LocalizedString - /** - * Specific information about the change that occurred, including the field affected and the nature of the change. - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Changed Field - */ - displayName: () => LocalizedString - /** - * Field that was changed - */ - shortDesc: () => LocalizedString - /** - * The specific field within the resource that was modified; for task completion, this is 'completed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - action: { - /** - * Change Action - */ - displayName: () => LocalizedString - /** - * Nature of the change - */ - shortDesc: () => LocalizedString - /** - * Describes how the field was changed; for task completion, this is 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * User details - */ - shortDesc: () => LocalizedString - /** - * Information about the user who initiated the action that triggered the event. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * User GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the user - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the user within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * User Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the user resource - */ - shortDesc: () => LocalizedString - /** - * The resource type, typically 'user', indicating the entity is a user. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - created_at: { - /** - * Creation Timestamp - */ - displayName: () => LocalizedString - /** - * Event creation time - */ - shortDesc: () => LocalizedString - /** - * The timestamp indicating when the event was created. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } + order_by: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Ordering criteria for results + */ + shortDesc: () => LocalizedString + /** + * Optional list of ordering criteria to apply to the query results. Documents will be sorted by the specified fields in the order they are listed. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to order by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for ordering. The field must exist in the documents and be of a comparable type. + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort: ascending (lowest to highest) or descending (highest to lowest). + */ + longDesc: () => LocalizedString } } } } } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of documents to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of documents to retrieve. Default is 100. Use this to control query performance and result set size. + */ + longDesc: () => LocalizedString + } } } - subtask_completed: { + backup_to_google_cloud_storage: { /** - * Subtask Completed + * Backup to Google Cloud Storage */ displayName: () => LocalizedString /** - * Triggers when a subtask is marked complete + * Export Firestore data to Google Cloud Storage */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a subtask within a specific parent task is marked as completed. Use this to track progress on multi-stage tasks or to trigger the next steps in a workflow. + * Creates a backup of your Firestore database or specific collections by exporting the data to Google Cloud Storage. This is useful for disaster recovery, data migration, or creating snapshots of your database at a point in time. */ longDesc: () => LocalizedString options: { - project: { + project_id: { /** * Project ID */ displayName: () => LocalizedString /** - * The project containing the parent task + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where the parent task exists + * The unique identifier for your Google Cloud project containing the Firestore database to backup */ longDesc: () => LocalizedString } - workspace: { + output_uri_prefix: { /** - * Workspace ID + * Output URI Prefix */ displayName: () => LocalizedString /** - * The workspace containing the project + * GCS bucket URI where backup will be stored */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where the project exists + * The Google Cloud Storage URI prefix where the backup files will be written. Format: gs://bucket-name/path/to/backup. The bucket must already exist and you must have write permissions. */ longDesc: () => LocalizedString } - task: { + collection_ids: { /** - * Parent Task ID + * Collection IDs */ displayName: () => LocalizedString /** - * The parent task containing the subtasks + * Specific collections to backup (optional) */ shortDesc: () => LocalizedString /** - * The unique identifier of the parent task whose subtasks will be monitored for completion + * Optional list of collection IDs to backup. If not specified, the entire database will be backed up. Use this to create selective backups of specific collections. */ longDesc: () => LocalizedString } } - event_info: { - /** - * Event data - */ - desc: () => LocalizedString - type: { - fields: { - events: { - /** - * Events - */ - displayName: () => LocalizedString - /** - * List of event objects - */ - shortDesc: () => LocalizedString - /** - * An array containing event objects that represent individual changes or actions within Asana. - */ - longDesc: () => LocalizedString - type: { - fields: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Type of action performed - */ - shortDesc: () => LocalizedString - /** - * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - parent: { - /** - * Parent Resource - */ - displayName: () => LocalizedString - /** - * Parent resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Parent GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the parent resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Parent Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the parent resource, such as 'project' or 'task'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Parent Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the parent resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - resource: { - /** - * Resource - */ - displayName: () => LocalizedString - /** - * Affected resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the resource that was directly affected by the event; in this case, the task that was completed. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Resource GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the resource, which would be 'task' for task completion events. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - change: { - /** - * Change Details - */ - displayName: () => LocalizedString - /** - * Details of the change - */ - shortDesc: () => LocalizedString - /** - * Specific information about the change that occurred, including the field affected and the nature of the change. - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Changed Field - */ - displayName: () => LocalizedString - /** - * Field that was changed - */ - shortDesc: () => LocalizedString - /** - * The specific field within the resource that was modified; for task completion, this is 'completed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - action: { - /** - * Change Action - */ - displayName: () => LocalizedString - /** - * Nature of the change - */ - shortDesc: () => LocalizedString - /** - * Describes how the field was changed; for task completion, this is 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * User details - */ - shortDesc: () => LocalizedString - /** - * Information about the user who initiated the action that triggered the event. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * User GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the user - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the user within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * User Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the user resource - */ - shortDesc: () => LocalizedString - /** - * The resource type, typically 'user', indicating the entity is a user. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - created_at: { - /** - * Creation Timestamp - */ - displayName: () => LocalizedString - /** - * Event creation time - */ - shortDesc: () => LocalizedString - /** - * The timestamp indicating when the event was created. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - } - } - } } - project_task_added: { + restore_from_google_cloud_storage: { /** - * Project Task Added + * Restore from Google Cloud Storage */ displayName: () => LocalizedString /** - * Triggers when a new task is created in a project + * Import Firestore data from Google Cloud Storage */ shortDesc: () => LocalizedString /** - * Initiates a workflow whenever a new task is added to the specified project. Use this to automatically process, categorize, or assign new tasks as they are created. + * Restores Firestore data from a previous backup stored in Google Cloud Storage. This operation can restore the entire database or specific collections. Warning: This will overwrite existing documents with the same IDs. */ longDesc: () => LocalizedString options: { - project: { + project_id: { /** * Project ID */ displayName: () => LocalizedString /** - * The project to monitor for new tasks + * The Google Cloud project ID */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where new task creation will be monitored + * The unique identifier for your Google Cloud project where the data will be restored */ longDesc: () => LocalizedString } - workspace: { + input_uri_prefix: { /** - * Workspace ID + * Input URI Prefix */ displayName: () => LocalizedString /** - * The workspace containing the project + * GCS bucket URI where backup is stored */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where the project exists + * The Google Cloud Storage URI prefix where the backup files are located. This should match the output_uri_prefix used when creating the backup. Format: gs://bucket-name/path/to/backup */ longDesc: () => LocalizedString } - } - event_info: { - /** - * Event data - */ - desc: () => LocalizedString - type: { - fields: { - events: { - /** - * Events - */ - displayName: () => LocalizedString - /** - * List of event objects - */ - shortDesc: () => LocalizedString - /** - * An array containing event objects that represent individual changes or actions within Asana. - */ - longDesc: () => LocalizedString - type: { - fields: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Type of action performed - */ - shortDesc: () => LocalizedString - /** - * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - parent: { - /** - * Parent Resource - */ - displayName: () => LocalizedString - /** - * Parent resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Parent GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the parent resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Parent Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the parent resource, such as 'project' or 'task'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Parent Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the parent resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - resource: { - /** - * Resource - */ - displayName: () => LocalizedString - /** - * Affected resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the resource that was directly affected by the event; in this case, the task that was completed. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Resource GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the resource, which would be 'task' for task completion events. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - change: { - /** - * Change Details - */ - displayName: () => LocalizedString - /** - * Details of the change - */ - shortDesc: () => LocalizedString - /** - * Specific information about the change that occurred, including the field affected and the nature of the change. - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Changed Field - */ - displayName: () => LocalizedString - /** - * Field that was changed - */ - shortDesc: () => LocalizedString - /** - * The specific field within the resource that was modified; for task completion, this is 'completed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - action: { - /** - * Change Action - */ - displayName: () => LocalizedString - /** - * Nature of the change - */ - shortDesc: () => LocalizedString - /** - * Describes how the field was changed; for task completion, this is 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * User details - */ - shortDesc: () => LocalizedString - /** - * Information about the user who initiated the action that triggered the event. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * User GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the user - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the user within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * User Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the user resource - */ - shortDesc: () => LocalizedString - /** - * The resource type, typically 'user', indicating the entity is a user. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - created_at: { - /** - * Creation Timestamp - */ - displayName: () => LocalizedString - /** - * Event creation time - */ - shortDesc: () => LocalizedString - /** - * The timestamp indicating when the event was created. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - } + collection_ids: { + /** + * Collection IDs + */ + displayName: () => LocalizedString + /** + * Specific collections to restore (optional) + */ + shortDesc: () => LocalizedString + /** + * Optional list of collection IDs to restore from the backup. If not specified, all collections in the backup will be restored. Use this to selectively restore specific collections. + */ + longDesc: () => LocalizedString } } } - project_added: { - /** - * Project Added - */ - displayName: () => LocalizedString - /** - * Triggers when a new project is created in a workspace + } + } + Sentry: { + /** + * Sentry + */ + displayName: () => LocalizedString + groups: { + /** + * DevOps & Cloud Infrastructure + */ + '0': () => LocalizedString + } + /** + * Monitor and fix errors, track performance issues, and maintain application health with the developer-first debugging platform. + */ + shortDesc: () => LocalizedString + /** + * The Sentry integration enables comprehensive error monitoring and performance tracking for your applications. Access projects, issues, events, and teams to quickly identify, triage, and resolve problems. With real-time alerts and detailed debugging context including stack traces, breadcrumbs, and user impact metrics, Sentry helps your team maintain code quality and deliver seamless user experiences. + */ + longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to Sentry + */ + title: () => LocalizedString + /** + * To connect to Sentry, you will need an **Auth Token** and your **Organization Slug**. + + ## Getting Your Auth Token + + ### Option 1: User Auth Token (Recommended for personal use) + 1. Log in to [Sentry](https://sentry.io/) + 2. Go to **Settings** → **Account** → **API** → **Auth Tokens** + 3. Click **Create New Token** + 4. Select the required scopes: + - `project:read` - Read project information + - `project:write` - Modify projects + - `org:read` - Read organization data + - `event:read` - Read events + - `member:read` - Read team members + 5. Click **Create Token** and copy it immediately + + Direct link: [sentry.io/settings/account/api/auth-tokens/](https://sentry.io/settings/account/api/auth-tokens/) + + ### Option 2: Internal Integration Token (Recommended for production) + 1. Go to **Settings** → **Developer Settings** → **Custom Integrations** + 2. Click **Create New Integration** → **Internal Integration** + 3. Configure the name and required permissions + 4. After saving, copy the generated token + + ## Finding Your Organization Slug + + Your organization slug is in your Sentry URL: + - If your Sentry URL is `https://your-org.sentry.io/`, your slug is `your-org` + - For sentry.io hosted accounts: `https://sentry.io/organizations/your-org/` → slug is `your-org` + + ## Connection Details + + ### Auth Token + Your Sentry authentication token. Starts with `sntrys_` for newer tokens or may have different prefixes for legacy tokens. + + ### Organization Slug + The URL-friendly identifier for your organization (found in your Sentry URL). + + **Note:** Auth tokens inherit permissions based on your user role and the scopes you selected. For production integrations, use Internal Integration tokens which can be scoped to specific permissions and managed at the organization level. + */ + content: () => LocalizedString + } + triggers: { + new_project_issue: { + /** + * New Project Issue + */ + displayName: () => LocalizedString + /** + * Triggers when a new issue is detected in a specific project */ shortDesc: () => LocalizedString /** - * Initiates a workflow whenever a new project is created within the specified workspace. Use this to automate project setup, create standard templates, or notify team members about new initiatives. + * Monitors a specific Sentry project and triggers when a new issue (grouped error or problem) is detected. Issues represent single bugs or problems in your application, with events grouped by fingerprint. Use optional query filters and time periods to focus on specific types of issues. */ longDesc: () => LocalizedString options: { - workspace: { + projectId: { /** - * Workspace ID + * Project ID */ displayName: () => LocalizedString /** - * The workspace to monitor for new projects + * The project to monitor for new issues */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where new project creation will be monitored + * Select the Sentry project you want to monitor. Projects represent individual applications or services within your organization. + */ + longDesc: () => LocalizedString + } + query: { + /** + * Query Filter + */ + displayName: () => LocalizedString + /** + * Optional search query to filter issues + */ + shortDesc: () => LocalizedString + /** + * Use Sentry query syntax to filter which issues trigger this event. For example, filter by browser, device, tags, or whether errors are unhandled. + */ + longDesc: () => LocalizedString + } + statsPeriod: { + /** + * Statistics Period + */ + displayName: () => LocalizedString + /** + * Time period for issue statistics + */ + shortDesc: () => LocalizedString + /** + * The time range for collecting issue statistics. Affects metrics like event counts and user impact within the selected period. */ longDesc: () => LocalizedString } } - event_info: { - /** - * Event data - */ - desc: () => LocalizedString - type: { - fields: { - events: { - /** - * Events - */ - displayName: () => LocalizedString - /** - * List of event objects - */ - shortDesc: () => LocalizedString - /** - * An array containing event objects that represent individual changes or actions within Asana. - */ - longDesc: () => LocalizedString - type: { - fields: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Type of action performed - */ - shortDesc: () => LocalizedString - /** - * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - parent: { - /** - * Parent Resource - */ - displayName: () => LocalizedString - /** - * Parent resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Parent GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the parent resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Parent Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the parent resource, such as 'project' or 'task'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Parent Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the parent resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - resource: { - /** - * Resource - */ - displayName: () => LocalizedString - /** - * Affected resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the resource that was directly affected by the event; in this case, the task that was completed. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Resource GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the resource, which would be 'task' for task completion events. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - change: { - /** - * Change Details - */ - displayName: () => LocalizedString - /** - * Details of the change - */ - shortDesc: () => LocalizedString - /** - * Specific information about the change that occurred, including the field affected and the nature of the change. - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Changed Field - */ - displayName: () => LocalizedString - /** - * Field that was changed - */ - shortDesc: () => LocalizedString - /** - * The specific field within the resource that was modified; for task completion, this is 'completed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - action: { - /** - * Change Action - */ - displayName: () => LocalizedString - /** - * Nature of the change - */ - shortDesc: () => LocalizedString - /** - * Describes how the field was changed; for task completion, this is 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * User details - */ - shortDesc: () => LocalizedString - /** - * Information about the user who initiated the action that triggered the event. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * User GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the user - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the user within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * User Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the user resource - */ - shortDesc: () => LocalizedString - /** - * The resource type, typically 'user', indicating the entity is a user. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - created_at: { - /** - * Creation Timestamp - */ - displayName: () => LocalizedString - /** - * Event creation time - */ - shortDesc: () => LocalizedString - /** - * The timestamp indicating when the event was created. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - } + } + new_organization_issue: { + /** + * New Organization Issue + */ + displayName: () => LocalizedString + /** + * Triggers when a new issue is detected across the entire organization + */ + shortDesc: () => LocalizedString + /** + * Monitors all projects within your Sentry organization and triggers when a new issue is detected in any project. This provides organization-wide visibility into problems across all applications and services. Use query filters to focus on specific issue types or characteristics. + */ + longDesc: () => LocalizedString + options: { + query: { + /** + * Query Filter + */ + displayName: () => LocalizedString + /** + * Optional search query to filter issues + */ + shortDesc: () => LocalizedString + /** + * Use Sentry query syntax to filter which issues trigger this event across all projects. Filter by properties like platform, environment, release, or custom tags. + */ + longDesc: () => LocalizedString + } + statsPeriod: { + /** + * Statistics Period + */ + displayName: () => LocalizedString + /** + * Time period for issue statistics + */ + shortDesc: () => LocalizedString + /** + * The time range for collecting issue statistics across all projects. Determines the time window for metrics like frequency and user impact. + */ + longDesc: () => LocalizedString } } } - task_comment_added: { + } + actions: { + list_projects: { /** - * Task Comment Added + * List Projects */ displayName: () => LocalizedString /** - * Triggers when a comment is added to a specific task + * Retrieve all projects in your organization */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a new comment is posted on the specified task. Use this to monitor discussions, notify stakeholders, or track communication around critical tasks. + * Fetches a paginated list of all projects within your Sentry organization. Each project represents an individual application or service being monitored. Returns project details including name, platform, creation date, team membership, and configuration. */ longDesc: () => LocalizedString options: { - project: { + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor for retrieving additional results + */ + shortDesc: () => LocalizedString + /** + * Use the cursor from a previous response to fetch the next or previous page of results. Leave empty to start from the beginning. + */ + longDesc: () => LocalizedString + } + } + } + get_project: { + /** + * Get Project Details + */ + displayName: () => LocalizedString + /** + * Retrieve detailed information about a specific project + */ + shortDesc: () => LocalizedString + /** + * Fetches comprehensive details about a specific Sentry project, including configuration options, team assignments, integrations, features, symbol sources, and project statistics. Use this to understand project settings and capabilities. + */ + longDesc: () => LocalizedString + options: { + projectId: { /** * Project ID */ displayName: () => LocalizedString /** - * The project containing the task + * The project to retrieve */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where the task exists + * Select or enter the slug identifier of the project you want to retrieve details for. */ longDesc: () => LocalizedString } - workspace: { + } + } + list_project_events: { + /** + * List Project Events + */ + displayName: () => LocalizedString + /** + * Retrieve events from a specific project + */ + shortDesc: () => LocalizedString + /** + * Fetches a paginated list of events (individual error or transaction occurrences) from a specific project. Events are the raw data sent to Sentry and are grouped into issues. Use the full parameter to retrieve complete event payloads including context, breadcrumbs, and metadata. + */ + longDesc: () => LocalizedString + options: { + projectId: { /** - * Workspace ID + * Project ID */ displayName: () => LocalizedString /** - * The workspace containing the project + * The project to retrieve events from */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where the project exists + * Select the project whose events you want to list. */ longDesc: () => LocalizedString } - task: { + full: { /** - * Task ID + * Full Details */ displayName: () => LocalizedString /** - * The specific task to monitor for comments + * Whether to return complete event data */ shortDesc: () => LocalizedString /** - * The unique identifier of the task where comments will be monitored + * When enabled, returns the full event payload including all context, breadcrumbs, stack traces, and metadata. When disabled, returns summary information only. + */ + longDesc: () => LocalizedString + } + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor for retrieving additional results + */ + shortDesc: () => LocalizedString + /** + * Use the cursor from a previous response to navigate through pages of events. */ longDesc: () => LocalizedString } } - event_info: { - /** - * Event data - */ - desc: () => LocalizedString - type: { - fields: { - events: { - /** - * Events - */ - displayName: () => LocalizedString - /** - * List of event objects - */ - shortDesc: () => LocalizedString - /** - * An array containing event objects that represent individual changes or actions within Asana. - */ - longDesc: () => LocalizedString - type: { - fields: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Type of action performed - */ - shortDesc: () => LocalizedString - /** - * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - parent: { - /** - * Parent Resource - */ - displayName: () => LocalizedString - /** - * Parent resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Parent GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the parent resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Parent Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the parent resource, such as 'project' or 'task'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Parent Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the parent resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the parent resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - resource: { - /** - * Resource - */ - displayName: () => LocalizedString - /** - * Affected resource details - */ - shortDesc: () => LocalizedString - /** - * Information about the resource that was directly affected by the event; in this case, the task that was completed. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * Resource GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the resource - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the resource within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the resource - */ - shortDesc: () => LocalizedString - /** - * The specific type of the resource, which would be 'task' for task completion events. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_subtype: { - /** - * Resource Subtype - */ - displayName: () => LocalizedString - /** - * Subtype of the resource - */ - shortDesc: () => LocalizedString - /** - * The subtype classification of the resource, providing more specific categorization. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - change: { - /** - * Change Details - */ - displayName: () => LocalizedString - /** - * Details of the change - */ - shortDesc: () => LocalizedString - /** - * Specific information about the change that occurred, including the field affected and the nature of the change. - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Changed Field - */ - displayName: () => LocalizedString - /** - * Field that was changed - */ - shortDesc: () => LocalizedString - /** - * The specific field within the resource that was modified; for task completion, this is 'completed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - action: { - /** - * Change Action - */ - displayName: () => LocalizedString - /** - * Nature of the change - */ - shortDesc: () => LocalizedString - /** - * Describes how the field was changed; for task completion, this is 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * User details - */ - shortDesc: () => LocalizedString - /** - * Information about the user who initiated the action that triggered the event. - */ - longDesc: () => LocalizedString - type: { - fields: { - gid: { - /** - * User GID - */ - displayName: () => LocalizedString - /** - * Globally unique identifier of the user - */ - shortDesc: () => LocalizedString - /** - * The unique identifier assigned to the user within Asana. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - resource_type: { - /** - * User Resource Type - */ - displayName: () => LocalizedString - /** - * Type of the user resource - */ - shortDesc: () => LocalizedString - /** - * The resource type, typically 'user', indicating the entity is a user. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - created_at: { - /** - * Creation Timestamp - */ - displayName: () => LocalizedString - /** - * Event creation time - */ - shortDesc: () => LocalizedString - /** - * The timestamp indicating when the event was created. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - } - } - } - } + } + get_event: { + /** + * Get Event Details + */ + displayName: () => LocalizedString + /** + * Retrieve detailed information about a specific event + */ + shortDesc: () => LocalizedString + /** + * Fetches complete details about a specific event, including the full stack trace, breadcrumbs (trail of events leading to the error), user context, device information, tags, SDK details, and all captured metadata. Essential for debugging and understanding the exact conditions when an error occurred. + */ + longDesc: () => LocalizedString + options: { + projectId: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * The project containing the event + */ + shortDesc: () => LocalizedString + /** + * Select the project that the event belongs to. + */ + longDesc: () => LocalizedString + } + eventId: { + /** + * Event ID + */ + displayName: () => LocalizedString + /** + * The unique identifier of the event + */ + shortDesc: () => LocalizedString + /** + * Enter the event ID (hexadecimal string) you want to retrieve. Event IDs can be found in issue details or event listings. + */ + longDesc: () => LocalizedString } } } - task_story_added: { + list_project_issues: { /** - * Task Story Added + * List Project Issues */ displayName: () => LocalizedString /** - * Triggers when any activity occurs on a task + * Retrieve issues from a specific project */ shortDesc: () => LocalizedString /** - * Initiates a workflow when any story (comment, status update, field change) is added to a task. This captures all activity including automated system updates. Use this for comprehensive task activity monitoring. + * Fetches a paginated list of issues (grouped errors or problems) from a specific project. Issues represent single bugs affecting your application, with multiple event occurrences grouped by fingerprint. Filter by query to find specific types of issues, and use statistics period to see relevant metrics. */ longDesc: () => LocalizedString options: { - project: { + projectId: { /** * Project ID */ displayName: () => LocalizedString /** - * The project containing the task + * The project to retrieve issues from */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where the task exists + * Select the project whose issues you want to list. */ longDesc: () => LocalizedString } - workspace: { + query: { /** - * Workspace ID + * Query Filter */ displayName: () => LocalizedString /** - * The workspace containing the project + * Search query to filter issues */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where the project exists + * Use Sentry query syntax to filter issues by properties like status, assignee, tags, platform, or time range. Example: "is:unresolved assigned:me" */ longDesc: () => LocalizedString } - task: { + statsPeriod: { /** - * Task ID + * Statistics Period */ displayName: () => LocalizedString /** - * The specific task to monitor for activity + * Time period for issue statistics */ shortDesc: () => LocalizedString /** - * The unique identifier of the task where all activity will be monitored + * The time range for calculating issue statistics such as event count, frequency, and user impact. + */ + longDesc: () => LocalizedString + } + shortIdLookup: { + /** + * Short ID Lookup + */ + displayName: () => LocalizedString + /** + * Whether to look up issues by their short ID + */ + shortDesc: () => LocalizedString + /** + * When enabled, allows searching for issues using their short IDs (e.g., PROJECT-123) instead of full issue IDs. + */ + longDesc: () => LocalizedString + } + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor for retrieving additional results + */ + shortDesc: () => LocalizedString + /** + * Use the cursor from a previous response to navigate through pages of issues. */ longDesc: () => LocalizedString } } - event_info: { - /** - * Event data - */ - desc: () => LocalizedString - type: { - fields: { - events: { - /** - * Events - */ - displayName: () => LocalizedString - /** - * List of event objects - */ - shortDesc: () => LocalizedString - /** - * An array containing event objects that represent individual changes or actions within Asana. - */ - longDesc: () => LocalizedString - type: { - fields: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Type of action performed - */ - shortDesc: () => LocalizedString - /** - * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. - */ - longDesc: () => LocalizedString - /** - * string - */ - type: () => LocalizedString - } - parent: { - /** - * Parent Resource - */ - displayName: () => LocalizedString - /** + } + list_organization_issues: { + /** + * List Organization Issues + */ + displayName: () => LocalizedString + /** + * Retrieve issues across the entire organization + */ + shortDesc: () => LocalizedString + /** + * Fetches a paginated list of issues from all projects within your organization. This provides organization-wide visibility into problems across all applications and services. Use query filters to narrow down results by project, platform, status, or other criteria. + */ + longDesc: () => LocalizedString + options: { + query: { + /** + * Query Filter + */ + displayName: () => LocalizedString + /** + * Search query to filter issues + */ + shortDesc: () => LocalizedString + /** + * Use Sentry query syntax to filter issues across all projects. Filter by project, platform, environment, status, tags, or any other issue property. + */ + longDesc: () => LocalizedString + } + statsPeriod: { + /** + * Statistics Period + */ + displayName: () => LocalizedString + /** + * Time period for issue statistics + */ + shortDesc: () => LocalizedString + /** + * The time range for calculating issue statistics and metrics across the organization. + */ + longDesc: () => LocalizedString + } + shortIdLookup: { + /** + * Short ID Lookup + */ + displayName: () => LocalizedString + /** + * Whether to look up issues by their short ID + */ + shortDesc: () => LocalizedString + /** + * When enabled, allows searching for issues using their short IDs across all projects. + */ + longDesc: () => LocalizedString + } + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor for retrieving additional results + */ + shortDesc: () => LocalizedString + /** + * Use the cursor from a previous response to retrieve additional pages of organization-wide issues. + */ + longDesc: () => LocalizedString + } + } + } + get_issue: { + /** + * Get Issue Details + */ + displayName: () => LocalizedString + /** + * Retrieve detailed information about a specific issue + */ + shortDesc: () => LocalizedString + /** + * Fetches comprehensive details about a specific issue, including its status, metadata, assignment, statistics (event count, user impact, frequency), participants, activity history, linked integrations, and the latest event details. Essential for understanding the full context and history of a problem. + */ + longDesc: () => LocalizedString + options: { + issueId: { + /** + * Issue ID + */ + displayName: () => LocalizedString + /** + * The unique identifier of the issue + */ + shortDesc: () => LocalizedString + /** + * Enter the issue ID you want to retrieve. Issue IDs are numeric values that can be found in the Sentry UI or from list operations. + */ + longDesc: () => LocalizedString + } + } + } + update_issue: { + /** + * Update Issue + */ + displayName: () => LocalizedString + /** + * Update the status or properties of an issue + */ + shortDesc: () => LocalizedString + /** + * Modifies an issue's status (resolved, unresolved, ignored), assignment, bookmarked state, subscription status, or visibility. Use this to triage issues, assign them to team members, resolve bugs, or mark issues as ignored. Status changes can trigger alerts and affect issue grouping. + */ + longDesc: () => LocalizedString + options: { + projectId: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * The project containing the issue (optional) + */ + shortDesc: () => LocalizedString + /** + * Optionally specify the project for context. While issues can be updated by ID alone, providing the project can be helpful for organization. + */ + longDesc: () => LocalizedString + } + issueId: { + /** + * Issue ID + */ + displayName: () => LocalizedString + /** + * The unique identifier of the issue to update + */ + shortDesc: () => LocalizedString + /** + * Enter the issue ID you want to update. You can find issue IDs in the Sentry UI or from list/search operations. + */ + longDesc: () => LocalizedString + } + status: { + /** + * Status + */ + displayName: () => LocalizedString + /** + * The new status for the issue + */ + shortDesc: () => LocalizedString + /** + * Change the issue status to control its lifecycle. "Resolved" marks it as fixed, "Unresolved" reopens it, "Ignored" archives it temporarily, and "Resolved in Next Release" indicates it will be fixed in an upcoming deployment. + */ + longDesc: () => LocalizedString + } + assignedTo: { + /** + * Assigned To + */ + displayName: () => LocalizedString + /** + * User or team to assign the issue to + */ + shortDesc: () => LocalizedString + /** + * Assign the issue to a specific user or team for ownership and accountability. Enter a team slug (e.g., "team:backend") or user ID. + */ + longDesc: () => LocalizedString + } + hasSeen: { + /** + * Has Seen + */ + displayName: () => LocalizedString + /** + * Mark whether the issue has been viewed + */ + shortDesc: () => LocalizedString + /** + * Mark the issue as seen (reviewed) or unseen. This helps track which issues have been triaged by your team. + */ + longDesc: () => LocalizedString + } + isBookmarked: { + /** + * Is Bookmarked + */ + displayName: () => LocalizedString + /** + * Bookmark status for the issue + */ + shortDesc: () => LocalizedString + /** + * Bookmark the issue for easy access and filtering. Bookmarked issues appear in your personal issue list. + */ + longDesc: () => LocalizedString + } + isSubscribed: { + /** + * Is Subscribed + */ + displayName: () => LocalizedString + /** + * Subscription status for notifications + */ + shortDesc: () => LocalizedString + /** + * Subscribe to or unsubscribe from notifications about this issue. When subscribed, you'll receive alerts when the issue changes or escalates. + */ + longDesc: () => LocalizedString + } + isPublic: { + /** + * Is Public + */ + displayName: () => LocalizedString + /** + * Whether the issue should be publicly accessible + */ + shortDesc: () => LocalizedString + /** + * Control whether the issue is publicly visible via a share link. Public issues can be viewed by anyone with the link, even without Sentry access. + */ + longDesc: () => LocalizedString + } + } + } + list_teams: { + /** + * List Teams + */ + displayName: () => LocalizedString + /** + * Retrieve all teams in your organization + */ + shortDesc: () => LocalizedString + /** + * Fetches a paginated list of all teams within your Sentry organization. Teams represent groups of developers working together on projects. Returns team details including member count, access permissions, role assignments, linked projects, and external team integrations. + */ + longDesc: () => LocalizedString + options: { + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor for retrieving additional results + */ + shortDesc: () => LocalizedString + /** + * Use the cursor from a previous response to navigate through pages of teams. + */ + longDesc: () => LocalizedString + } + } + } + get_team: { + /** + * Get Team Details + */ + displayName: () => LocalizedString + /** + * Retrieve detailed information about a specific team + */ + shortDesc: () => LocalizedString + /** + * Fetches comprehensive details about a specific team, including its members, assigned projects, access permissions, role settings, external integrations (like Slack channels), and organization-level role. Use this to understand team structure and project ownership. + */ + longDesc: () => LocalizedString + options: { + teamId: { + /** + * Team ID + */ + displayName: () => LocalizedString + /** + * The team slug to retrieve + */ + shortDesc: () => LocalizedString + /** + * Enter the team slug (URL-friendly identifier) of the team you want to retrieve details for. + */ + longDesc: () => LocalizedString + } + } + } + } + } + Patreon: { + /** + * Patreon + */ + displayName: () => LocalizedString + groups: { + /** + * Social Media Management + */ + '0': () => LocalizedString + } + /** + * Connect to Patreon to manage your creator content, memberships, and patron relationships. + */ + shortDesc: () => LocalizedString + /** + * The Patreon integration enables creators to automate their patron management workflows. Access patron data, manage memberships, track campaigns, and engage with your community through comprehensive API actions and real-time triggers for patron activities. + */ + longDesc: () => LocalizedString + actions: { + list_campaigns: { + /** + * List Campaigns + */ + displayName: () => LocalizedString + /** + * Retrieve a list of campaigns for the authenticated creator + */ + shortDesc: () => LocalizedString + /** + * Fetches a paginated list of campaigns associated with the authenticated Patreon account. Returns comprehensive campaign information including patron counts, settings, and metadata. + */ + longDesc: () => LocalizedString + options: { + count: { + /** + * Count + */ + displayName: () => LocalizedString + /** + * Maximum number of campaigns to return + */ + shortDesc: () => LocalizedString + /** + * Specifies the maximum number of campaigns to retrieve in a single request. Defaults to 20 if not specified. + */ + longDesc: () => LocalizedString + } + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor for retrieving the next set of results + */ + shortDesc: () => LocalizedString + /** + * Use the cursor returned from a previous request to fetch the next page of campaigns. Leave empty for the first page. + */ + longDesc: () => LocalizedString + } + } + } + list_campaign_members: { + /** + * List Campaign Members + */ + displayName: () => LocalizedString + /** + * Retrieve members of a specific campaign + */ + shortDesc: () => LocalizedString + /** + * Fetches a paginated list of members (patrons) for a specified campaign. Returns detailed member information including pledge amounts, payment status, and membership details. + */ + longDesc: () => LocalizedString + options: { + campaignId: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The ID of the campaign to retrieve members from + */ + shortDesc: () => LocalizedString + /** + * Select the campaign whose members you want to retrieve. This is a required field. + */ + longDesc: () => LocalizedString + } + count: { + /** + * Count + */ + displayName: () => LocalizedString + /** + * Maximum number of members to return + */ + shortDesc: () => LocalizedString + /** + * Specifies the maximum number of members to retrieve in a single request. Defaults to 20 if not specified. + */ + longDesc: () => LocalizedString + } + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor for retrieving the next set of results + */ + shortDesc: () => LocalizedString + /** + * Use the cursor returned from a previous request to fetch the next page of members. Leave empty for the first page. + */ + longDesc: () => LocalizedString + } + } + } + get_campaign: { + /** + * Get Campaign + */ + displayName: () => LocalizedString + /** + * Retrieve detailed information about a specific campaign + */ + shortDesc: () => LocalizedString + /** + * Fetches comprehensive details about a single campaign including summary, creation details, social media integration, RSS feed settings, and patron statistics. + */ + longDesc: () => LocalizedString + options: { + campaignId: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The ID of the campaign to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select the campaign you want to get detailed information about. This is a required field. + */ + longDesc: () => LocalizedString + } + } + } + get_member: { + /** + * Get Member + */ + displayName: () => LocalizedString + /** + * Retrieve detailed information about a specific member + */ + shortDesc: () => LocalizedString + /** + * Fetches comprehensive details about a single campaign member (patron) including pledge amounts, payment history, membership status, and relationship timeline. + */ + longDesc: () => LocalizedString + options: { + campaignId: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The campaign to filter members from + */ + shortDesc: () => LocalizedString + /** + * Optionally select a campaign to filter the member selection. This helps narrow down the member list when searching. + */ + longDesc: () => LocalizedString + } + memberId: { + /** + * Member ID + */ + displayName: () => LocalizedString + /** + * The ID of the member to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the member (patron) whose details you want to retrieve. This is a required field. + */ + longDesc: () => LocalizedString + } + } + } + list_posts: { + /** + * List Posts + */ + displayName: () => LocalizedString + /** + * Retrieve posts from a specific campaign + */ + shortDesc: () => LocalizedString + /** + * Fetches a paginated list of posts from a specified campaign, sorted by publish date. Returns post content, metadata, and engagement information. + */ + longDesc: () => LocalizedString + options: { + campaignId: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The ID of the campaign to retrieve posts from + */ + shortDesc: () => LocalizedString + /** + * Select the campaign whose posts you want to retrieve. This is a required field. + */ + longDesc: () => LocalizedString + } + count: { + /** + * Count + */ + displayName: () => LocalizedString + /** + * Maximum number of posts to return + */ + shortDesc: () => LocalizedString + /** + * Specifies the maximum number of posts to retrieve in a single request. Defaults to 20 if not specified. + */ + longDesc: () => LocalizedString + } + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor for retrieving the next set of results + */ + shortDesc: () => LocalizedString + /** + * Use the cursor returned from a previous request to fetch the next page of posts. Leave empty for the first page. + */ + longDesc: () => LocalizedString + } + } + } + get_post: { + /** + * Get Post + */ + displayName: () => LocalizedString + /** + * Retrieve detailed information about a specific post + */ + shortDesc: () => LocalizedString + /** + * Fetches comprehensive details about a single post including content, publish information, access settings, and engagement metrics. + */ + longDesc: () => LocalizedString + options: { + campaignId: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The campaign to filter posts from + */ + shortDesc: () => LocalizedString + /** + * Optionally select a campaign to filter the post selection. This helps narrow down the post list when searching. + */ + longDesc: () => LocalizedString + } + postId: { + /** + * Post ID + */ + displayName: () => LocalizedString + /** + * The ID of the post to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the post whose details you want to retrieve. This is a required field. + */ + longDesc: () => LocalizedString + } + } + } + } + triggers: { + pledge_trigger: { + /** + * Pledge Event + */ + displayName: () => LocalizedString + /** + * Triggers when a pledge is created, updated, or deleted + */ + shortDesc: () => LocalizedString + /** + * Monitors pledge events for a specific campaign using Patreon webhooks. This trigger fires when a member creates, updates, or deletes their pledge, allowing you to automate workflows based on patron pledge activity. + */ + longDesc: () => LocalizedString + options: { + campaignId: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The campaign to monitor for pledge events + */ + shortDesc: () => LocalizedString + /** + * Select the campaign you want to monitor for pledge-related events. This is a required field. + */ + longDesc: () => LocalizedString + } + trigger: { + /** + * Trigger Event + */ + displayName: () => LocalizedString + /** + * The specific pledge event to monitor + */ + shortDesc: () => LocalizedString + /** + * Select which type of pledge event should trigger this workflow. Choose from pledge creation (when a member first pledges or a follower becomes a patron), pledge updates (upgrades or downgrades), or pledge deletion. + */ + longDesc: () => LocalizedString + } + } + } + member_trigger: { + /** + * Member Event + */ + displayName: () => LocalizedString + /** + * Triggers when a member is created, updated, or deleted + */ + shortDesc: () => LocalizedString + /** + * Monitors member events for a specific campaign using Patreon webhooks. This trigger fires when a member is created, their information is updated (including payment charging events), or their membership is deleted. + */ + longDesc: () => LocalizedString + options: { + campaignId: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The campaign to monitor for member events + */ + shortDesc: () => LocalizedString + /** + * Select the campaign you want to monitor for member-related events. This is a required field. + */ + longDesc: () => LocalizedString + } + trigger: { + /** + * Trigger Event + */ + displayName: () => LocalizedString + /** + * The specific member event to monitor + */ + shortDesc: () => LocalizedString + /** + * Select which type of member event should trigger this workflow. Member creation occurs only if there was no prior payment between patron and creator. Updates include payment charging events. Deletion only occurs if no prior payment happened. + */ + longDesc: () => LocalizedString + } + } + } + post_trigger: { + /** + * Post Event + */ + displayName: () => LocalizedString + /** + * Triggers when a post is published, updated, or deleted + */ + shortDesc: () => LocalizedString + /** + * Monitors post events for a specific campaign using Patreon webhooks. This trigger fires when a post is published, updated, or deleted on the campaign, allowing you to automate content distribution and notifications. + */ + longDesc: () => LocalizedString + options: { + campaignId: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The campaign to monitor for post events + */ + shortDesc: () => LocalizedString + /** + * Select the campaign you want to monitor for post-related events. This is a required field. + */ + longDesc: () => LocalizedString + } + trigger: { + /** + * Trigger Event + */ + displayName: () => LocalizedString + /** + * The specific post event to monitor + */ + shortDesc: () => LocalizedString + /** + * Select which type of post event should trigger this workflow. Choose from post publication, post updates, or post deletion events. + */ + longDesc: () => LocalizedString + } + } + } + } + } + Asana: { + /** + * Asana + */ + displayName: () => LocalizedString + groups: { + /** + * Project & Task Management + */ + '0': () => LocalizedString + } + /** + * Automate workflows by integrating with the Asana project management platform + */ + shortDesc: () => LocalizedString + /** + * Connect to Asana to automate task management, project monitoring, and team collaboration workflows. Use these triggers to respond to changes in tasks, projects, and workspaces. + */ + longDesc: () => LocalizedString + triggers: { + task_completed: { + /** + * Task Completed + */ + displayName: () => LocalizedString + /** + * Triggers when a task is marked complete in a specific project + */ + shortDesc: () => LocalizedString + /** + * Initiates a workflow when any task within the specified project is marked as completed. Use this to automate follow-up actions or notifications upon task completion. + */ + longDesc: () => LocalizedString + options: { + project: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * The project containing the completed tasks + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the project where task completions will be monitored + */ + longDesc: () => LocalizedString + } + workspace: { + /** + * Workspace ID + */ + displayName: () => LocalizedString + /** + * The workspace containing the project + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the workspace where the project exists + */ + longDesc: () => LocalizedString + } + } + event_info: { + /** + * Event data + */ + desc: () => LocalizedString + type: { + fields: { + events: { + /** + * Events + */ + displayName: () => LocalizedString + /** + * List of event objects + */ + shortDesc: () => LocalizedString + /** + * An array containing event objects that represent individual changes or actions within Asana. + */ + longDesc: () => LocalizedString + type: { + fields: { + action: { + /** + * Action + */ + displayName: () => LocalizedString + /** + * Type of action performed + */ + shortDesc: () => LocalizedString + /** + * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + parent: { + /** + * Parent Resource + */ + displayName: () => LocalizedString + /** * Parent resource details */ shortDesc: () => LocalizedString @@ -153009,17 +153356,17 @@ export type TranslationFunctions = { } } } - task_subtask_added: { + attachment_added: { /** - * Task Subtask Added + * Attachment Added */ displayName: () => LocalizedString /** - * Triggers when a subtask is created under a parent task + * Triggers when an attachment is uploaded to a task */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a new subtask is added to the specified parent task. Use this to track task breakdown or to automate subtask assignments and deadlines. + * Initiates a workflow when a file is attached to any task within the specified project. Optionally filter by a specific task. Use this to process or track files as they are added to tasks. */ longDesc: () => LocalizedString options: { @@ -153029,39 +153376,39 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * The project containing the parent task + * The project containing the tasks with attachments */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where the parent task exists + * The unique identifier of the project where attachment activities will be monitored */ longDesc: () => LocalizedString } - workspace: { + task: { /** - * Workspace ID + * Task ID (Optional) */ displayName: () => LocalizedString /** - * The workspace containing the project + * Specific task to monitor for attachments */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where the project exists + * The unique identifier of a specific task to monitor. If not provided, attachments from all tasks in the project will trigger the workflow */ longDesc: () => LocalizedString } - task: { + workspace: { /** - * Parent Task ID + * Workspace ID */ displayName: () => LocalizedString /** - * The parent task to monitor for new subtasks + * The workspace containing the project */ shortDesc: () => LocalizedString /** - * The unique identifier of the parent task where subtask creation will be monitored + * The unique identifier of the workspace where the project exists */ longDesc: () => LocalizedString } @@ -153383,17 +153730,17 @@ export type TranslationFunctions = { } } } - task_tag_added: { + subtask_completed: { /** - * Task Tag Added + * Subtask Completed */ displayName: () => LocalizedString /** - * Triggers when a tag is applied to a task + * Triggers when a subtask is marked complete */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a tag is added to the specified task. Use this to automate actions based on task categorization or to monitor how tasks are being classified. + * Initiates a workflow when a subtask within a specific parent task is marked as completed. Use this to track progress on multi-stage tasks or to trigger the next steps in a workflow. */ longDesc: () => LocalizedString options: { @@ -153403,11 +153750,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * The project containing the task + * The project containing the parent task */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where the task exists + * The unique identifier of the project where the parent task exists */ longDesc: () => LocalizedString } @@ -153427,15 +153774,15 @@ export type TranslationFunctions = { } task: { /** - * Task ID + * Parent Task ID */ displayName: () => LocalizedString /** - * The specific task to monitor for tag additions + * The parent task containing the subtasks */ shortDesc: () => LocalizedString /** - * The unique identifier of the task where tag additions will be monitored + * The unique identifier of the parent task whose subtasks will be monitored for completion */ longDesc: () => LocalizedString } @@ -153757,31 +154104,45 @@ export type TranslationFunctions = { } } } - team_added: { + project_task_added: { /** - * Team Added + * Project Task Added */ displayName: () => LocalizedString /** - * Triggers when a new team is created in a workspace + * Triggers when a new task is created in a project */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a new team is formed within the specified workspace. Use this to automate team onboarding processes or to set up default team resources. + * Initiates a workflow whenever a new task is added to the specified project. Use this to automatically process, categorize, or assign new tasks as they are created. */ longDesc: () => LocalizedString options: { + project: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * The project to monitor for new tasks + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the project where new task creation will be monitored + */ + longDesc: () => LocalizedString + } workspace: { /** * Workspace ID */ displayName: () => LocalizedString /** - * The workspace to monitor for new teams + * The workspace containing the project */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where new team creation will be monitored + * The unique identifier of the workspace where the project exists */ longDesc: () => LocalizedString } @@ -154103,17 +154464,17 @@ export type TranslationFunctions = { } } } - user_added: { + project_added: { /** - * User Added + * Project Added */ displayName: () => LocalizedString /** - * Triggers when a user joins a workspace + * Triggers when a new project is created in a workspace */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a new user is added to the specified workspace. Use this to automate user onboarding, permission assignments, or welcome notifications. + * Initiates a workflow whenever a new project is created within the specified workspace. Use this to automate project setup, create standard templates, or notify team members about new initiatives. */ longDesc: () => LocalizedString options: { @@ -154123,11 +154484,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * The workspace to monitor for new users + * The workspace to monitor for new projects */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where new user additions will be monitored + * The unique identifier of the workspace where new project creation will be monitored */ longDesc: () => LocalizedString } @@ -154449,31 +154810,59 @@ export type TranslationFunctions = { } } } - tag_created: { + task_comment_added: { /** - * Tag Created + * Task Comment Added */ displayName: () => LocalizedString /** - * Triggers when a new tag is created in a workspace + * Triggers when a comment is added to a specific task */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a new tag is created within the specified workspace. Use this to monitor taxonomy changes or to standardize tag usage across projects. + * Initiates a workflow when a new comment is posted on the specified task. Use this to monitor discussions, notify stakeholders, or track communication around critical tasks. */ longDesc: () => LocalizedString options: { + project: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * The project containing the task + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the project where the task exists + */ + longDesc: () => LocalizedString + } workspace: { /** * Workspace ID */ displayName: () => LocalizedString /** - * The workspace to monitor for new tags + * The workspace containing the project */ shortDesc: () => LocalizedString /** - * The unique identifier of the workspace where new tag creation will be monitored + * The unique identifier of the workspace where the project exists + */ + longDesc: () => LocalizedString + } + task: { + /** + * Task ID + */ + displayName: () => LocalizedString + /** + * The specific task to monitor for comments + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the task where comments will be monitored */ longDesc: () => LocalizedString } @@ -154795,17 +155184,17 @@ export type TranslationFunctions = { } } } - task_moved_to_section: { + task_story_added: { /** - * Task Moved to Section + * Task Story Added */ displayName: () => LocalizedString /** - * Triggers when a task is moved to a different section + * Triggers when any activity occurs on a task */ shortDesc: () => LocalizedString /** - * Initiates a workflow when a task is moved between sections in the specified project. Use this to track task progress through different stages or to automate actions based on task status changes. + * Initiates a workflow when any story (comment, status update, field change) is added to a task. This captures all activity including automated system updates. Use this for comprehensive task activity monitoring. */ longDesc: () => LocalizedString options: { @@ -154815,11 +155204,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * The project containing the sections and tasks + * The project containing the task */ shortDesc: () => LocalizedString /** - * The unique identifier of the project where task movements between sections will be monitored + * The unique identifier of the project where the task exists */ longDesc: () => LocalizedString } @@ -154837,6 +155226,20 @@ export type TranslationFunctions = { */ longDesc: () => LocalizedString } + task: { + /** + * Task ID + */ + displayName: () => LocalizedString + /** + * The specific task to monitor for activity + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the task where all activity will be monitored + */ + longDesc: () => LocalizedString + } } event_info: { /** @@ -155155,1535 +155558,2981 @@ export type TranslationFunctions = { } } } - } - actions: { - getEvents: { - groups: { - /** - * Time & Events - */ - '0': () => LocalizedString - } - } - getGoals: { - groups: { - /** - * Goals - */ - '0': () => LocalizedString - } - } - createGoal: { - groups: { - /** - * Goals - */ - '0': () => LocalizedString - } - } - deleteGoal: { - groups: { - /** - * Goals - */ - '0': () => LocalizedString - } - } - getGoal: { - groups: { - /** - * Goals - */ - '0': () => LocalizedString - } - } - updateGoal: { - groups: { - /** - * Goals - */ - '0': () => LocalizedString - } - } - getProjects: { - groups: { - /** - * Projects - */ - '0': () => LocalizedString - } - } - createProject: { - groups: { - /** - * Projects - */ - '0': () => LocalizedString - } - } - deleteProject: { - groups: { - /** - * Projects - */ - '0': () => LocalizedString - } - } - getProject: { - groups: { - /** - * Projects - */ - '0': () => LocalizedString - } - } - updateProject: { - groups: { - /** - * Projects - */ - '0': () => LocalizedString - } - } - getSectionsForProject: { - groups: { - /** - * Projects - */ - '0': () => LocalizedString - } - } - createSectionForProject: { - groups: { - /** - * Projects - */ - '0': () => LocalizedString - } - } - getTasksForProject: { - groups: { - /** - * Projects - */ - '0': () => LocalizedString - } - } - getSection: { - groups: { - /** - * Sections - */ - '0': () => LocalizedString - } - } - updateSection: { - groups: { - /** - * Sections - */ - '0': () => LocalizedString - } - } - deleteSection: { - groups: { - /** - * Sections - */ - '0': () => LocalizedString - } - } - getTasksForSection: { - groups: { - /** - * Sections - */ - '0': () => LocalizedString - } - } - getTasks: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - createTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - deleteTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - getTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - updateTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - getDependenciesForTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - getDependentsForTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - getStoriesForTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - createStoryForTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - getSubtasksForTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - createSubtaskForTask: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - } - getTags: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - } - } - createTag: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - } - } - deleteTag: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - } - } - getTag: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - } - } - updateTag: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - } - } - getTasksForTag: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - } - } - getProjectsForTeam: { - groups: { - /** - * Teams & Users - */ - '0': () => LocalizedString - } - } - createProjectForTeam: { - groups: { - /** - * Teams & Users - */ - '0': () => LocalizedString - } - } - getUsers: { - groups: { - /** - * Teams & Users - */ - '0': () => LocalizedString - } - } - getUser: { - groups: { - /** - * Teams & Users - */ - '0': () => LocalizedString - } - } - getWorkspaces: { - groups: { - /** - * Workspaces - */ - '0': () => LocalizedString - } - } - getWorkspace: { - groups: { - /** - * Workspaces - */ - '0': () => LocalizedString - } - } - updateWorkspace: { - groups: { - /** - * Workspaces - */ - '0': () => LocalizedString - } - } - getTimePeriods: { - groups: { - /** - * Other - */ - '0': () => LocalizedString - } - } - } - searchOptions: { - orderBy: { - /** - * Order By - */ - displayName: () => LocalizedString - /** - * Sort results by a specific field - */ - shortDesc: () => LocalizedString - /** - * Define the field and direction to sort search results - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to use for sorting results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort results (ascending or descending) - */ - longDesc: () => LocalizedString - } - } - } - } - } - expressions: { - '&&': { - /** - * And - */ - displayName: () => LocalizedString - /** - * Logical AND operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where all must be true - */ - longDesc: () => LocalizedString - } - '||': { - /** - * Or - */ - displayName: () => LocalizedString - /** - * Logical OR operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where at least one must be true - */ - longDesc: () => LocalizedString - } - '==': { - /** - * Equals - */ - displayName: () => LocalizedString - /** - * Field equals value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field equals the specified value - */ - longDesc: () => LocalizedString - } - '!=': { - /** - * Not Equals - */ - displayName: () => LocalizedString - /** - * Field does not equal value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field does not equal the specified value - */ - longDesc: () => LocalizedString - } - '>': { - /** - * Greater Than - */ - displayName: () => LocalizedString - /** - * Field is greater than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than the specified value - */ - longDesc: () => LocalizedString - } - '>=': { - /** - * Greater Than or Equal - */ - displayName: () => LocalizedString - /** - * Field is greater than or equal to value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than or equal to the specified value - */ - longDesc: () => LocalizedString - } - '<': { - /** - * Less Than - */ - displayName: () => LocalizedString - /** - * Field is less than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is less than the specified value - */ - longDesc: () => LocalizedString - } - '<=': { - /** - * Less Than or Equal - */ - displayName: () => LocalizedString - /** - * Field is less than or equal to value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is less than or equal to the specified value - */ - longDesc: () => LocalizedString - } - 'is-set': { - /** - * Is Set - */ - displayName: () => LocalizedString - /** - * Field has a value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field has a value (is not empty) - */ - longDesc: () => LocalizedString - } - 'is-not-set': { - /** - * Is Not Set - */ - displayName: () => LocalizedString - /** - * Field has no value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field has no value (is empty) - */ - longDesc: () => LocalizedString - } - contains: { - /** - * Contains - */ - displayName: () => LocalizedString - /** - * Field contains value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field contains the specified substring - */ - longDesc: () => LocalizedString - } - 'starts-with': { - /** - * Starts With - */ - displayName: () => LocalizedString - /** - * Field starts with value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value starts with the specified prefix - */ - longDesc: () => LocalizedString - } - 'ends-with': { - /** - * Ends With - */ - displayName: () => LocalizedString - /** - * Field ends with value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value ends with the specified suffix - */ - longDesc: () => LocalizedString - } - } - } - Todoist: { - /** - * Todoist - */ - displayName: () => LocalizedString - groups: { - /** - * Project & Task Management - */ - '0': () => LocalizedString - } - /** - * Connect to Todoist to automate task and project management workflows. - */ - shortDesc: () => LocalizedString - /** - * The Todoist integration enables you to seamlessly interact with the Todoist API to manage tasks, projects, labels, and comments. Automate your task management workflows, sync project data, and streamline team collaboration with comprehensive actions and triggers. - */ - longDesc: () => LocalizedString - actions: { - add_comment_to_project: { - groups: { - /** - * Comments - */ - '0': () => LocalizedString - } + task_subtask_added: { /** - * Add Comment to Project + * Task Subtask Added */ displayName: () => LocalizedString /** - * Add a comment to a Todoist project + * Triggers when a subtask is created under a parent task */ shortDesc: () => LocalizedString /** - * Creates a new comment on a specified Todoist project. Comments can be used to provide updates, notes, or collaborate with team members on project-related discussions. + * Initiates a workflow when a new subtask is added to the specified parent task. Use this to track task breakdown or to automate subtask assignments and deadlines. */ longDesc: () => LocalizedString options: { - content: { + project: { /** - * Comment Content + * Project ID */ displayName: () => LocalizedString /** - * The text content of the comment + * The project containing the parent task */ shortDesc: () => LocalizedString /** - * The message or note you want to add to the project. Supports Markdown formatting for rich text. + * The unique identifier of the project where the parent task exists */ longDesc: () => LocalizedString } - project_id: { + workspace: { /** - * Project ID + * Workspace ID */ displayName: () => LocalizedString /** - * The project to comment on + * The workspace containing the project */ shortDesc: () => LocalizedString /** - * Select the Todoist project where you want to add the comment. + * The unique identifier of the workspace where the project exists + */ + longDesc: () => LocalizedString + } + task: { + /** + * Parent Task ID + */ + displayName: () => LocalizedString + /** + * The parent task to monitor for new subtasks + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the parent task where subtask creation will be monitored */ longDesc: () => LocalizedString } } - } - add_comment_to_task: { - groups: { + event_info: { /** - * Comments + * Event data */ - '0': () => LocalizedString + desc: () => LocalizedString + type: { + fields: { + events: { + /** + * Events + */ + displayName: () => LocalizedString + /** + * List of event objects + */ + shortDesc: () => LocalizedString + /** + * An array containing event objects that represent individual changes or actions within Asana. + */ + longDesc: () => LocalizedString + type: { + fields: { + action: { + /** + * Action + */ + displayName: () => LocalizedString + /** + * Type of action performed + */ + shortDesc: () => LocalizedString + /** + * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + parent: { + /** + * Parent Resource + */ + displayName: () => LocalizedString + /** + * Parent resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Parent GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the parent resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Parent Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the parent resource, such as 'project' or 'task'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Parent Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the parent resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + resource: { + /** + * Resource + */ + displayName: () => LocalizedString + /** + * Affected resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the resource that was directly affected by the event; in this case, the task that was completed. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Resource GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the resource, which would be 'task' for task completion events. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + change: { + /** + * Change Details + */ + displayName: () => LocalizedString + /** + * Details of the change + */ + shortDesc: () => LocalizedString + /** + * Specific information about the change that occurred, including the field affected and the nature of the change. + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Changed Field + */ + displayName: () => LocalizedString + /** + * Field that was changed + */ + shortDesc: () => LocalizedString + /** + * The specific field within the resource that was modified; for task completion, this is 'completed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + action: { + /** + * Change Action + */ + displayName: () => LocalizedString + /** + * Nature of the change + */ + shortDesc: () => LocalizedString + /** + * Describes how the field was changed; for task completion, this is 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * User details + */ + shortDesc: () => LocalizedString + /** + * Information about the user who initiated the action that triggered the event. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * User GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the user + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the user within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * User Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the user resource + */ + shortDesc: () => LocalizedString + /** + * The resource type, typically 'user', indicating the entity is a user. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + created_at: { + /** + * Creation Timestamp + */ + displayName: () => LocalizedString + /** + * Event creation time + */ + shortDesc: () => LocalizedString + /** + * The timestamp indicating when the event was created. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + } + } } + } + task_tag_added: { /** - * Add Comment to Task + * Task Tag Added */ displayName: () => LocalizedString /** - * Add a comment to a Todoist task + * Triggers when a tag is applied to a task */ shortDesc: () => LocalizedString /** - * Creates a new comment on a specified Todoist task. Use comments to add notes, updates, or collaborate with team members on specific tasks. + * Initiates a workflow when a tag is added to the specified task. Use this to automate actions based on task categorization or to monitor how tasks are being classified. */ longDesc: () => LocalizedString options: { - content: { + project: { /** - * Comment Content + * Project ID */ displayName: () => LocalizedString /** - * The text content of the comment + * The project containing the task */ shortDesc: () => LocalizedString /** - * The message or note you want to add to the task. Supports Markdown formatting for rich text. + * The unique identifier of the project where the task exists */ longDesc: () => LocalizedString } - task_id: { + workspace: { + /** + * Workspace ID + */ + displayName: () => LocalizedString + /** + * The workspace containing the project + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the workspace where the project exists + */ + longDesc: () => LocalizedString + } + task: { /** * Task ID */ displayName: () => LocalizedString /** - * The task to comment on + * The specific task to monitor for tag additions */ shortDesc: () => LocalizedString /** - * Select the Todoist task where you want to add the comment. + * The unique identifier of the task where tag additions will be monitored */ longDesc: () => LocalizedString } } - } - complete_task: { - groups: { + event_info: { /** - * Tasks + * Event data */ - '0': () => LocalizedString + desc: () => LocalizedString + type: { + fields: { + events: { + /** + * Events + */ + displayName: () => LocalizedString + /** + * List of event objects + */ + shortDesc: () => LocalizedString + /** + * An array containing event objects that represent individual changes or actions within Asana. + */ + longDesc: () => LocalizedString + type: { + fields: { + action: { + /** + * Action + */ + displayName: () => LocalizedString + /** + * Type of action performed + */ + shortDesc: () => LocalizedString + /** + * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + parent: { + /** + * Parent Resource + */ + displayName: () => LocalizedString + /** + * Parent resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Parent GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the parent resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Parent Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the parent resource, such as 'project' or 'task'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Parent Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the parent resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + resource: { + /** + * Resource + */ + displayName: () => LocalizedString + /** + * Affected resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the resource that was directly affected by the event; in this case, the task that was completed. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Resource GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the resource, which would be 'task' for task completion events. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + change: { + /** + * Change Details + */ + displayName: () => LocalizedString + /** + * Details of the change + */ + shortDesc: () => LocalizedString + /** + * Specific information about the change that occurred, including the field affected and the nature of the change. + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Changed Field + */ + displayName: () => LocalizedString + /** + * Field that was changed + */ + shortDesc: () => LocalizedString + /** + * The specific field within the resource that was modified; for task completion, this is 'completed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + action: { + /** + * Change Action + */ + displayName: () => LocalizedString + /** + * Nature of the change + */ + shortDesc: () => LocalizedString + /** + * Describes how the field was changed; for task completion, this is 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * User details + */ + shortDesc: () => LocalizedString + /** + * Information about the user who initiated the action that triggered the event. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * User GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the user + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the user within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * User Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the user resource + */ + shortDesc: () => LocalizedString + /** + * The resource type, typically 'user', indicating the entity is a user. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + created_at: { + /** + * Creation Timestamp + */ + displayName: () => LocalizedString + /** + * Event creation time + */ + shortDesc: () => LocalizedString + /** + * The timestamp indicating when the event was created. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + } + } } + } + team_added: { /** - * Complete Task + * Team Added */ displayName: () => LocalizedString /** - * Mark a Todoist task as complete + * Triggers when a new team is created in a workspace */ shortDesc: () => LocalizedString /** - * Closes a task by marking it as completed. This action moves the task to the completed tasks list and updates its status accordingly. + * Initiates a workflow when a new team is formed within the specified workspace. Use this to automate team onboarding processes or to set up default team resources. */ longDesc: () => LocalizedString options: { - task_id: { + workspace: { /** - * Task ID + * Workspace ID */ displayName: () => LocalizedString /** - * The task to complete + * The workspace to monitor for new teams */ shortDesc: () => LocalizedString /** - * Select the Todoist task you want to mark as complete. + * The unique identifier of the workspace where new team creation will be monitored */ longDesc: () => LocalizedString } } - } - create_project: { - groups: { + event_info: { /** - * Projects + * Event data */ - '0': () => LocalizedString + desc: () => LocalizedString + type: { + fields: { + events: { + /** + * Events + */ + displayName: () => LocalizedString + /** + * List of event objects + */ + shortDesc: () => LocalizedString + /** + * An array containing event objects that represent individual changes or actions within Asana. + */ + longDesc: () => LocalizedString + type: { + fields: { + action: { + /** + * Action + */ + displayName: () => LocalizedString + /** + * Type of action performed + */ + shortDesc: () => LocalizedString + /** + * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + parent: { + /** + * Parent Resource + */ + displayName: () => LocalizedString + /** + * Parent resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Parent GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the parent resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Parent Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the parent resource, such as 'project' or 'task'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Parent Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the parent resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + resource: { + /** + * Resource + */ + displayName: () => LocalizedString + /** + * Affected resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the resource that was directly affected by the event; in this case, the task that was completed. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Resource GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the resource, which would be 'task' for task completion events. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + change: { + /** + * Change Details + */ + displayName: () => LocalizedString + /** + * Details of the change + */ + shortDesc: () => LocalizedString + /** + * Specific information about the change that occurred, including the field affected and the nature of the change. + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Changed Field + */ + displayName: () => LocalizedString + /** + * Field that was changed + */ + shortDesc: () => LocalizedString + /** + * The specific field within the resource that was modified; for task completion, this is 'completed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + action: { + /** + * Change Action + */ + displayName: () => LocalizedString + /** + * Nature of the change + */ + shortDesc: () => LocalizedString + /** + * Describes how the field was changed; for task completion, this is 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * User details + */ + shortDesc: () => LocalizedString + /** + * Information about the user who initiated the action that triggered the event. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * User GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the user + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the user within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * User Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the user resource + */ + shortDesc: () => LocalizedString + /** + * The resource type, typically 'user', indicating the entity is a user. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + created_at: { + /** + * Creation Timestamp + */ + displayName: () => LocalizedString + /** + * Event creation time + */ + shortDesc: () => LocalizedString + /** + * The timestamp indicating when the event was created. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + } + } } + } + user_added: { /** - * Create Project + * User Added */ displayName: () => LocalizedString /** - * Create a new Todoist project + * Triggers when a user joins a workspace */ shortDesc: () => LocalizedString /** - * Creates a new project in Todoist. Projects help you organize related tasks and collaborate with team members. + * Initiates a workflow when a new user is added to the specified workspace. Use this to automate user onboarding, permission assignments, or welcome notifications. */ longDesc: () => LocalizedString options: { - name: { + workspace: { /** - * Project Name + * Workspace ID */ displayName: () => LocalizedString /** - * The name of the project + * The workspace to monitor for new users */ shortDesc: () => LocalizedString /** - * A descriptive name for your new Todoist project. + * The unique identifier of the workspace where new user additions will be monitored */ longDesc: () => LocalizedString } - description: { - /** - * Description - */ - displayName: () => LocalizedString - /** - * Project description - */ - shortDesc: () => LocalizedString - /** - * Optional detailed description explaining the purpose and scope of the project. - */ - longDesc: () => LocalizedString + } + event_info: { + /** + * Event data + */ + desc: () => LocalizedString + type: { + fields: { + events: { + /** + * Events + */ + displayName: () => LocalizedString + /** + * List of event objects + */ + shortDesc: () => LocalizedString + /** + * An array containing event objects that represent individual changes or actions within Asana. + */ + longDesc: () => LocalizedString + type: { + fields: { + action: { + /** + * Action + */ + displayName: () => LocalizedString + /** + * Type of action performed + */ + shortDesc: () => LocalizedString + /** + * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + parent: { + /** + * Parent Resource + */ + displayName: () => LocalizedString + /** + * Parent resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Parent GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the parent resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Parent Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the parent resource, such as 'project' or 'task'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Parent Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the parent resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + resource: { + /** + * Resource + */ + displayName: () => LocalizedString + /** + * Affected resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the resource that was directly affected by the event; in this case, the task that was completed. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Resource GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the resource, which would be 'task' for task completion events. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + change: { + /** + * Change Details + */ + displayName: () => LocalizedString + /** + * Details of the change + */ + shortDesc: () => LocalizedString + /** + * Specific information about the change that occurred, including the field affected and the nature of the change. + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Changed Field + */ + displayName: () => LocalizedString + /** + * Field that was changed + */ + shortDesc: () => LocalizedString + /** + * The specific field within the resource that was modified; for task completion, this is 'completed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + action: { + /** + * Change Action + */ + displayName: () => LocalizedString + /** + * Nature of the change + */ + shortDesc: () => LocalizedString + /** + * Describes how the field was changed; for task completion, this is 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * User details + */ + shortDesc: () => LocalizedString + /** + * Information about the user who initiated the action that triggered the event. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * User GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the user + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the user within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * User Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the user resource + */ + shortDesc: () => LocalizedString + /** + * The resource type, typically 'user', indicating the entity is a user. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + created_at: { + /** + * Creation Timestamp + */ + displayName: () => LocalizedString + /** + * Event creation time + */ + shortDesc: () => LocalizedString + /** + * The timestamp indicating when the event was created. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + } } - color: { + } + } + tag_created: { + /** + * Tag Created + */ + displayName: () => LocalizedString + /** + * Triggers when a new tag is created in a workspace + */ + shortDesc: () => LocalizedString + /** + * Initiates a workflow when a new tag is created within the specified workspace. Use this to monitor taxonomy changes or to standardize tag usage across projects. + */ + longDesc: () => LocalizedString + options: { + workspace: { /** - * Color + * Workspace ID */ displayName: () => LocalizedString /** - * Project color identifier + * The workspace to monitor for new tags */ shortDesc: () => LocalizedString /** - * The color used to visually identify the project in the Todoist interface. - */ - longDesc: () => LocalizedString - } - view_style: { - /** - * View Style - */ - displayName: () => LocalizedString - /** - * How the project is displayed - */ - shortDesc: () => LocalizedString - /** - * Choose how tasks in this project are displayed: as a list, board (Kanban), or calendar view. - */ - longDesc: () => LocalizedString - } - is_favorite: { - /** - * Is Favorite - */ - displayName: () => LocalizedString - /** - * Mark project as favorite - */ - shortDesc: () => LocalizedString - /** - * When enabled, the project will appear in your favorites section for quick access. + * The unique identifier of the workspace where new tag creation will be monitored */ longDesc: () => LocalizedString } } - } - create_task: { - groups: { + event_info: { /** - * Tasks + * Event data */ - '0': () => LocalizedString + desc: () => LocalizedString + type: { + fields: { + events: { + /** + * Events + */ + displayName: () => LocalizedString + /** + * List of event objects + */ + shortDesc: () => LocalizedString + /** + * An array containing event objects that represent individual changes or actions within Asana. + */ + longDesc: () => LocalizedString + type: { + fields: { + action: { + /** + * Action + */ + displayName: () => LocalizedString + /** + * Type of action performed + */ + shortDesc: () => LocalizedString + /** + * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + parent: { + /** + * Parent Resource + */ + displayName: () => LocalizedString + /** + * Parent resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Parent GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the parent resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Parent Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the parent resource, such as 'project' or 'task'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Parent Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the parent resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + resource: { + /** + * Resource + */ + displayName: () => LocalizedString + /** + * Affected resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the resource that was directly affected by the event; in this case, the task that was completed. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Resource GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the resource, which would be 'task' for task completion events. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + change: { + /** + * Change Details + */ + displayName: () => LocalizedString + /** + * Details of the change + */ + shortDesc: () => LocalizedString + /** + * Specific information about the change that occurred, including the field affected and the nature of the change. + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Changed Field + */ + displayName: () => LocalizedString + /** + * Field that was changed + */ + shortDesc: () => LocalizedString + /** + * The specific field within the resource that was modified; for task completion, this is 'completed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + action: { + /** + * Change Action + */ + displayName: () => LocalizedString + /** + * Nature of the change + */ + shortDesc: () => LocalizedString + /** + * Describes how the field was changed; for task completion, this is 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * User details + */ + shortDesc: () => LocalizedString + /** + * Information about the user who initiated the action that triggered the event. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * User GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the user + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the user within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * User Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the user resource + */ + shortDesc: () => LocalizedString + /** + * The resource type, typically 'user', indicating the entity is a user. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + created_at: { + /** + * Creation Timestamp + */ + displayName: () => LocalizedString + /** + * Event creation time + */ + shortDesc: () => LocalizedString + /** + * The timestamp indicating when the event was created. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + } + } } + } + task_moved_to_section: { /** - * Create Task + * Task Moved to Section */ displayName: () => LocalizedString /** - * Create a new Todoist task + * Triggers when a task is moved to a different section */ shortDesc: () => LocalizedString /** - * Creates a new task in Todoist. Tasks can be assigned to projects, sections, given labels, priorities, due dates, and more. + * Initiates a workflow when a task is moved between sections in the specified project. Use this to track task progress through different stages or to automate actions based on task status changes. */ longDesc: () => LocalizedString options: { - content: { - /** - * Task Content - */ - displayName: () => LocalizedString - /** - * The task description - */ - shortDesc: () => LocalizedString - /** - * The main text describing what needs to be done. This is the primary content of the task. - */ - longDesc: () => LocalizedString - } - description: { - /** - * Description - */ - displayName: () => LocalizedString - /** - * Additional task details - */ - shortDesc: () => LocalizedString - /** - * Optional detailed description or notes about the task. Supports Markdown formatting. - */ - longDesc: () => LocalizedString - } - project_id: { + project: { /** * Project ID */ displayName: () => LocalizedString /** - * The project for this task - */ - shortDesc: () => LocalizedString - /** - * Select which Todoist project this task belongs to. If not specified, the task will be added to your Inbox. - */ - longDesc: () => LocalizedString - } - assignee_id: { - /** - * Assignee ID - */ - displayName: () => LocalizedString - /** - * Person assigned to the task - */ - shortDesc: () => LocalizedString - /** - * Assign the task to a specific collaborator in the selected project. - */ - longDesc: () => LocalizedString - } - section_id: { - /** - * Section ID - */ - displayName: () => LocalizedString - /** - * The section within the project - */ - shortDesc: () => LocalizedString - /** - * Organize the task within a specific section of the project for better categorization. - */ - longDesc: () => LocalizedString - } - order: { - /** - * Order - */ - displayName: () => LocalizedString - /** - * Task position in the list - */ - shortDesc: () => LocalizedString - /** - * Specify the position of the task in the project or section. Lower numbers appear first. - */ - longDesc: () => LocalizedString - } - labels: { - /** - * Labels - */ - displayName: () => LocalizedString - /** - * Task labels - */ - shortDesc: () => LocalizedString - /** - * Add one or more labels to categorize and filter the task. Labels help with organization and quick filtering. - */ - longDesc: () => LocalizedString - } - priority: { - /** - * Priority - */ - displayName: () => LocalizedString - /** - * Task priority level + * The project containing the sections and tasks */ shortDesc: () => LocalizedString /** - * Set the priority level for the task. Higher priority tasks are displayed with color-coded flags: 1 (urgent), 2 (high), 3 (normal), 4 (low). + * The unique identifier of the project where task movements between sections will be monitored */ longDesc: () => LocalizedString } - due_datetime: { + workspace: { /** - * Due Date + * Workspace ID */ displayName: () => LocalizedString /** - * When the task is due + * The workspace containing the project */ shortDesc: () => LocalizedString /** - * Set a due date and optionally a time for when the task should be completed. + * The unique identifier of the workspace where the project exists */ longDesc: () => LocalizedString } - duration: { - /** - * Duration - */ - displayName: () => LocalizedString - /** - * Estimated time to complete - */ - shortDesc: () => LocalizedString - /** - * Specify how long you expect the task to take. Used for time tracking and scheduling. - */ - longDesc: () => LocalizedString - type: { - fields: { - amount: { - /** - * Amount - */ - displayName: () => LocalizedString - /** - * Duration value - */ - shortDesc: () => LocalizedString - /** - * The numeric value for the duration. - */ - longDesc: () => LocalizedString - } - unit: { - /** - * Unit - */ - displayName: () => LocalizedString - /** - * Duration unit - */ - shortDesc: () => LocalizedString - /** - * The unit of time: minutes or days. - */ - longDesc: () => LocalizedString + } + event_info: { + /** + * Event data + */ + desc: () => LocalizedString + type: { + fields: { + events: { + /** + * Events + */ + displayName: () => LocalizedString + /** + * List of event objects + */ + shortDesc: () => LocalizedString + /** + * An array containing event objects that represent individual changes or actions within Asana. + */ + longDesc: () => LocalizedString + type: { + fields: { + action: { + /** + * Action + */ + displayName: () => LocalizedString + /** + * Type of action performed + */ + shortDesc: () => LocalizedString + /** + * Specifies the nature of the action that triggered the event; for task completion, this is typically 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + parent: { + /** + * Parent Resource + */ + displayName: () => LocalizedString + /** + * Parent resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the parent resource associated with the event, if applicable. For tasks, this could be the project or parent task. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Parent GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the parent resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Parent Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the parent resource, such as 'project' or 'task'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Parent Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the parent resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the parent resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + resource: { + /** + * Resource + */ + displayName: () => LocalizedString + /** + * Affected resource details + */ + shortDesc: () => LocalizedString + /** + * Information about the resource that was directly affected by the event; in this case, the task that was completed. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * Resource GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the resource + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the resource within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the resource + */ + shortDesc: () => LocalizedString + /** + * The specific type of the resource, which would be 'task' for task completion events. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_subtype: { + /** + * Resource Subtype + */ + displayName: () => LocalizedString + /** + * Subtype of the resource + */ + shortDesc: () => LocalizedString + /** + * The subtype classification of the resource, providing more specific categorization. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + change: { + /** + * Change Details + */ + displayName: () => LocalizedString + /** + * Details of the change + */ + shortDesc: () => LocalizedString + /** + * Specific information about the change that occurred, including the field affected and the nature of the change. + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Changed Field + */ + displayName: () => LocalizedString + /** + * Field that was changed + */ + shortDesc: () => LocalizedString + /** + * The specific field within the resource that was modified; for task completion, this is 'completed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + action: { + /** + * Change Action + */ + displayName: () => LocalizedString + /** + * Nature of the change + */ + shortDesc: () => LocalizedString + /** + * Describes how the field was changed; for task completion, this is 'changed'. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * User details + */ + shortDesc: () => LocalizedString + /** + * Information about the user who initiated the action that triggered the event. + */ + longDesc: () => LocalizedString + type: { + fields: { + gid: { + /** + * User GID + */ + displayName: () => LocalizedString + /** + * Globally unique identifier of the user + */ + shortDesc: () => LocalizedString + /** + * The unique identifier assigned to the user within Asana. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + resource_type: { + /** + * User Resource Type + */ + displayName: () => LocalizedString + /** + * Type of the user resource + */ + shortDesc: () => LocalizedString + /** + * The resource type, typically 'user', indicating the entity is a user. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } + } + } + created_at: { + /** + * Creation Timestamp + */ + displayName: () => LocalizedString + /** + * Event creation time + */ + shortDesc: () => LocalizedString + /** + * The timestamp indicating when the event was created. + */ + longDesc: () => LocalizedString + /** + * string + */ + type: () => LocalizedString + } + } } } } } } } - delete_task: { + } + actions: { + getEvents: { groups: { /** - * Tasks + * Time & Events */ '0': () => LocalizedString } - /** - * Delete Task - */ - displayName: () => LocalizedString - /** - * Permanently delete a Todoist task - */ - shortDesc: () => LocalizedString - /** - * Permanently removes a task from Todoist. This action cannot be undone. Use with caution. - */ - longDesc: () => LocalizedString - options: { - task_id: { - /** - * Task ID - */ - displayName: () => LocalizedString - /** - * The task to delete - */ - shortDesc: () => LocalizedString - /** - * Select the Todoist task you want to permanently delete. - */ - longDesc: () => LocalizedString - } + } + getGoals: { + groups: { + /** + * Goals + */ + '0': () => LocalizedString } } - get_project: { + createGoal: { groups: { /** - * Projects + * Goals */ '0': () => LocalizedString } - /** - * Get Project - */ - displayName: () => LocalizedString - /** - * Retrieve details of a Todoist project - */ - shortDesc: () => LocalizedString - /** - * Fetches detailed information about a specific Todoist project, including its properties, metadata, and settings. - */ - longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The project to retrieve - */ - shortDesc: () => LocalizedString - /** - * Select the Todoist project you want to get details for. - */ - longDesc: () => LocalizedString - } + } + deleteGoal: { + groups: { + /** + * Goals + */ + '0': () => LocalizedString } } - get_project_collaborators: { + getGoal: { + groups: { + /** + * Goals + */ + '0': () => LocalizedString + } + } + updateGoal: { + groups: { + /** + * Goals + */ + '0': () => LocalizedString + } + } + getProjects: { groups: { /** * Projects */ '0': () => LocalizedString } - /** - * Get Project Collaborators - */ - displayName: () => LocalizedString - /** - * List collaborators in a project - */ - shortDesc: () => LocalizedString - /** - * Retrieves a list of all collaborators who have access to a specific Todoist project. Useful for managing team assignments and permissions. - */ - longDesc: () => LocalizedString - options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * The project to get collaborators for - */ - shortDesc: () => LocalizedString - /** - * Select the Todoist project to retrieve the list of collaborators. - */ - longDesc: () => LocalizedString - } - cursor: { - /** - * Cursor - */ - displayName: () => LocalizedString - /** - * Pagination cursor - */ - shortDesc: () => LocalizedString - /** - * Used for pagination. Provide the cursor from a previous response to get the next page of results. - */ - longDesc: () => LocalizedString - } - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * Maximum number of results - */ - shortDesc: () => LocalizedString - /** - * The maximum number of collaborators to return in a single request. Default is 50. - */ - longDesc: () => LocalizedString - } + } + createProject: { + groups: { + /** + * Projects + */ + '0': () => LocalizedString } } - get_task: { + deleteProject: { groups: { /** - * Tasks + * Projects */ '0': () => LocalizedString } - /** - * Get Task - */ - displayName: () => LocalizedString - /** - * Retrieve details of a Todoist task - */ - shortDesc: () => LocalizedString - /** - * Fetches detailed information about a specific Todoist task, including all its properties, labels, due dates, and metadata. - */ - longDesc: () => LocalizedString - options: { - task_id: { - /** - * Task ID - */ - displayName: () => LocalizedString - /** - * The task to retrieve - */ - shortDesc: () => LocalizedString - /** - * Select the Todoist task you want to get details for. - */ - longDesc: () => LocalizedString - } + } + getProject: { + groups: { + /** + * Projects + */ + '0': () => LocalizedString } } - get_tasks_by_filter: { + updateProject: { groups: { /** - * Tasks + * Projects */ '0': () => LocalizedString } + } + getSectionsForProject: { + groups: { + /** + * Projects + */ + '0': () => LocalizedString + } + } + createSectionForProject: { + groups: { + /** + * Projects + */ + '0': () => LocalizedString + } + } + getTasksForProject: { + groups: { + /** + * Projects + */ + '0': () => LocalizedString + } + } + getSection: { + groups: { + /** + * Sections + */ + '0': () => LocalizedString + } + } + updateSection: { + groups: { + /** + * Sections + */ + '0': () => LocalizedString + } + } + deleteSection: { + groups: { + /** + * Sections + */ + '0': () => LocalizedString + } + } + getTasksForSection: { + groups: { + /** + * Sections + */ + '0': () => LocalizedString + } + } + getTasks: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + createTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + deleteTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + getTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + updateTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + getDependenciesForTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + getDependentsForTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + getStoriesForTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + createStoryForTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + getSubtasksForTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + createSubtaskForTask: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + } + getTags: { + groups: { + /** + * Tags + */ + '0': () => LocalizedString + } + } + createTag: { + groups: { + /** + * Tags + */ + '0': () => LocalizedString + } + } + deleteTag: { + groups: { + /** + * Tags + */ + '0': () => LocalizedString + } + } + getTag: { + groups: { + /** + * Tags + */ + '0': () => LocalizedString + } + } + updateTag: { + groups: { + /** + * Tags + */ + '0': () => LocalizedString + } + } + getTasksForTag: { + groups: { + /** + * Tags + */ + '0': () => LocalizedString + } + } + getProjectsForTeam: { + groups: { + /** + * Teams & Users + */ + '0': () => LocalizedString + } + } + createProjectForTeam: { + groups: { + /** + * Teams & Users + */ + '0': () => LocalizedString + } + } + getUsers: { + groups: { + /** + * Teams & Users + */ + '0': () => LocalizedString + } + } + getUser: { + groups: { + /** + * Teams & Users + */ + '0': () => LocalizedString + } + } + getWorkspaces: { + groups: { + /** + * Workspaces + */ + '0': () => LocalizedString + } + } + getWorkspace: { + groups: { + /** + * Workspaces + */ + '0': () => LocalizedString + } + } + updateWorkspace: { + groups: { + /** + * Workspaces + */ + '0': () => LocalizedString + } + } + getTimePeriods: { + groups: { + /** + * Other + */ + '0': () => LocalizedString + } + } + } + searchOptions: { + orderBy: { /** - * Get Tasks by Filter - */ - displayName: () => LocalizedString - /** - * Search tasks using Todoist filter queries - */ - shortDesc: () => LocalizedString - /** - * Retrieves tasks that match a specific filter query. Todoist filters allow powerful searches using keywords, dates, priorities, labels, and more. See Todoist filter documentation for advanced query syntax. + * Order By + */ + displayName: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results */ longDesc: () => LocalizedString - options: { - cursor: { - /** - * Cursor - */ - displayName: () => LocalizedString - /** - * Pagination cursor - */ - shortDesc: () => LocalizedString - /** - * Used for pagination. Provide the cursor from a previous response to get the next page of results. - */ - longDesc: () => LocalizedString - } - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * Maximum number of results - */ - shortDesc: () => LocalizedString - /** - * The maximum number of tasks to return in a single request. Default is 50. - */ - longDesc: () => LocalizedString - } - query: { - /** - * Filter Query - */ - displayName: () => LocalizedString - /** - * The filter expression - */ - shortDesc: () => LocalizedString - /** - * The filter query to use, see [documentation](https://www.todoist.com/help/articles/introduction-to-filters-V98wIH) for more details - */ - longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for sorting results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } } } } - list_labels: { + } + expressions: { + '&&': { + /** + * And + */ + displayName: () => LocalizedString + /** + * Logical AND operator + */ + shortDesc: () => LocalizedString + /** + * Combines multiple conditions where all must be true + */ + longDesc: () => LocalizedString + } + '||': { + /** + * Or + */ + displayName: () => LocalizedString + /** + * Logical OR operator + */ + shortDesc: () => LocalizedString + /** + * Combines multiple conditions where at least one must be true + */ + longDesc: () => LocalizedString + } + '==': { + /** + * Equals + */ + displayName: () => LocalizedString + /** + * Field equals value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field equals the specified value + */ + longDesc: () => LocalizedString + } + '!=': { + /** + * Not Equals + */ + displayName: () => LocalizedString + /** + * Field does not equal value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field does not equal the specified value + */ + longDesc: () => LocalizedString + } + '>': { + /** + * Greater Than + */ + displayName: () => LocalizedString + /** + * Field is greater than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than the specified value + */ + longDesc: () => LocalizedString + } + '>=': { + /** + * Greater Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is greater than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than or equal to the specified value + */ + longDesc: () => LocalizedString + } + '<': { + /** + * Less Than + */ + displayName: () => LocalizedString + /** + * Field is less than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than the specified value + */ + longDesc: () => LocalizedString + } + '<=': { + /** + * Less Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is less than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than or equal to the specified value + */ + longDesc: () => LocalizedString + } + 'is-set': { + /** + * Is Set + */ + displayName: () => LocalizedString + /** + * Field has a value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has a value (is not empty) + */ + longDesc: () => LocalizedString + } + 'is-not-set': { + /** + * Is Not Set + */ + displayName: () => LocalizedString + /** + * Field has no value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has no value (is empty) + */ + longDesc: () => LocalizedString + } + contains: { + /** + * Contains + */ + displayName: () => LocalizedString + /** + * Field contains value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field contains the specified substring + */ + longDesc: () => LocalizedString + } + 'starts-with': { + /** + * Starts With + */ + displayName: () => LocalizedString + /** + * Field starts with value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value starts with the specified prefix + */ + longDesc: () => LocalizedString + } + 'ends-with': { + /** + * Ends With + */ + displayName: () => LocalizedString + /** + * Field ends with value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value ends with the specified suffix + */ + longDesc: () => LocalizedString + } + } + } + Todoist: { + /** + * Todoist + */ + displayName: () => LocalizedString + groups: { + /** + * Project & Task Management + */ + '0': () => LocalizedString + } + /** + * Connect to Todoist to automate task and project management workflows. + */ + shortDesc: () => LocalizedString + /** + * The Todoist integration enables you to seamlessly interact with the Todoist API to manage tasks, projects, labels, and comments. Automate your task management workflows, sync project data, and streamline team collaboration with comprehensive actions and triggers. + */ + longDesc: () => LocalizedString + actions: { + add_comment_to_project: { groups: { /** - * Labels + * Comments */ '0': () => LocalizedString } /** - * List Labels + * Add Comment to Project */ displayName: () => LocalizedString /** - * Retrieve all Todoist labels + * Add a comment to a Todoist project */ shortDesc: () => LocalizedString /** - * Fetches a list of all labels in your Todoist account. Labels are used to categorize and filter tasks across projects. + * Creates a new comment on a specified Todoist project. Comments can be used to provide updates, notes, or collaborate with team members on project-related discussions. */ longDesc: () => LocalizedString options: { - cursor: { + content: { /** - * Cursor + * Comment Content */ displayName: () => LocalizedString /** - * Pagination cursor + * The text content of the comment */ shortDesc: () => LocalizedString /** - * Used for pagination. Provide the cursor from a previous response to get the next page of results. + * The message or note you want to add to the project. Supports Markdown formatting for rich text. */ longDesc: () => LocalizedString } - limit: { + project_id: { /** - * Limit + * Project ID */ displayName: () => LocalizedString /** - * Maximum number of results + * The project to comment on */ shortDesc: () => LocalizedString /** - * The maximum number of labels to return in a single request. Default is 50. + * Select the Todoist project where you want to add the comment. */ longDesc: () => LocalizedString } } } - list_projects: { + add_comment_to_task: { groups: { /** - * Projects + * Comments */ '0': () => LocalizedString } /** - * List Projects + * Add Comment to Task */ displayName: () => LocalizedString /** - * Retrieve all Todoist projects + * Add a comment to a Todoist task */ shortDesc: () => LocalizedString /** - * Fetches a list of all projects in your Todoist account, including shared and personal projects. Use this to discover available projects for task organization. + * Creates a new comment on a specified Todoist task. Use comments to add notes, updates, or collaborate with team members on specific tasks. */ longDesc: () => LocalizedString options: { - cursor: { + content: { /** - * Cursor + * Comment Content */ displayName: () => LocalizedString /** - * Pagination cursor + * The text content of the comment */ shortDesc: () => LocalizedString /** - * Used for pagination. Provide the cursor from a previous response to get the next page of results. + * The message or note you want to add to the task. Supports Markdown formatting for rich text. */ longDesc: () => LocalizedString } - limit: { + task_id: { /** - * Limit + * Task ID */ displayName: () => LocalizedString /** - * Maximum number of results + * The task to comment on */ shortDesc: () => LocalizedString /** - * The maximum number of projects to return in a single request. Default is 50. + * Select the Todoist task where you want to add the comment. */ longDesc: () => LocalizedString } } } - list_sections: { + complete_task: { groups: { /** - * Sections + * Tasks */ '0': () => LocalizedString } /** - * List Sections + * Complete Task */ displayName: () => LocalizedString /** - * Retrieve sections from projects + * Mark a Todoist task as complete */ shortDesc: () => LocalizedString /** - * Fetches a list of sections. Sections are used within projects to organize tasks into logical groups or categories. + * Closes a task by marking it as completed. This action moves the task to the completed tasks list and updates its status accordingly. */ longDesc: () => LocalizedString options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * Filter by project - */ - shortDesc: () => LocalizedString - /** - * Optionally filter sections to only those within a specific project. - */ - longDesc: () => LocalizedString - } - cursor: { - /** - * Cursor - */ - displayName: () => LocalizedString - /** - * Pagination cursor - */ - shortDesc: () => LocalizedString - /** - * Used for pagination. Provide the cursor from a previous response to get the next page of results. - */ - longDesc: () => LocalizedString - } - limit: { + task_id: { /** - * Limit + * Task ID */ displayName: () => LocalizedString /** - * Maximum number of results + * The task to complete */ shortDesc: () => LocalizedString /** - * The maximum number of sections to return in a single request. Default is 50. + * Select the Todoist task you want to mark as complete. */ longDesc: () => LocalizedString } } } - list_tasks: { + create_project: { groups: { /** - * Tasks + * Projects */ '0': () => LocalizedString } /** - * List Tasks + * Create Project */ displayName: () => LocalizedString /** - * Retrieve Todoist tasks + * Create a new Todoist project */ shortDesc: () => LocalizedString /** - * Fetches a list of tasks with optional filtering by project, section, or label. Use this to retrieve tasks for processing or display. + * Creates a new project in Todoist. Projects help you organize related tasks and collaborate with team members. */ longDesc: () => LocalizedString options: { - cursor: { - /** - * Cursor - */ - displayName: () => LocalizedString - /** - * Pagination cursor - */ - shortDesc: () => LocalizedString - /** - * Used for pagination. Provide the cursor from a previous response to get the next page of results. - */ - longDesc: () => LocalizedString - } - limit: { + name: { /** - * Limit + * Project Name */ displayName: () => LocalizedString /** - * Maximum number of results + * The name of the project */ shortDesc: () => LocalizedString /** - * The maximum number of tasks to return in a single request. Default is 50. + * A descriptive name for your new Todoist project. */ longDesc: () => LocalizedString } - ids: { + description: { /** - * Task IDs + * Description */ displayName: () => LocalizedString /** - * Filter by specific task IDs + * Project description */ shortDesc: () => LocalizedString /** - * Optionally specify a list of task IDs to retrieve only those specific tasks. + * Optional detailed description explaining the purpose and scope of the project. */ longDesc: () => LocalizedString } - project_id: { + color: { /** - * Project ID + * Color */ displayName: () => LocalizedString /** - * Filter by project + * Project color identifier */ shortDesc: () => LocalizedString /** - * Retrieve only tasks from a specific project. + * The color used to visually identify the project in the Todoist interface. */ longDesc: () => LocalizedString } - section_id: { + view_style: { /** - * Section ID + * View Style */ displayName: () => LocalizedString /** - * Filter by section + * How the project is displayed */ shortDesc: () => LocalizedString /** - * Retrieve only tasks from a specific section within a project. + * Choose how tasks in this project are displayed: as a list, board (Kanban), or calendar view. */ longDesc: () => LocalizedString } - label: { + is_favorite: { /** - * Label + * Is Favorite */ displayName: () => LocalizedString /** - * Filter by label + * Mark project as favorite */ shortDesc: () => LocalizedString /** - * Retrieve only tasks that have a specific label assigned. + * When enabled, the project will appear in your favorites section for quick access. */ longDesc: () => LocalizedString } } } - move_task_to_section: { + create_task: { groups: { /** * Tasks @@ -156691,43 +158540,43 @@ export type TranslationFunctions = { '0': () => LocalizedString } /** - * Move Task to Section + * Create Task */ displayName: () => LocalizedString /** - * Move a task to a different section or project + * Create a new Todoist task */ shortDesc: () => LocalizedString /** - * Moves a task to a different section within the same project, or to a different project entirely. Useful for reorganizing tasks and workflows. + * Creates a new task in Todoist. Tasks can be assigned to projects, sections, given labels, priorities, due dates, and more. */ longDesc: () => LocalizedString options: { - task_id: { + content: { /** - * Task ID + * Task Content */ displayName: () => LocalizedString /** - * The task to move + * The task description */ shortDesc: () => LocalizedString /** - * Select the Todoist task you want to move. + * The main text describing what needs to be done. This is the primary content of the task. */ longDesc: () => LocalizedString } - section_id: { + description: { /** - * Section ID + * Description */ displayName: () => LocalizedString /** - * Destination section + * Additional task details */ shortDesc: () => LocalizedString /** - * The section where you want to move the task. Either section_id or project_id must be specified. + * Optional detailed description or notes about the task. Supports Markdown formatting. */ longDesc: () => LocalizedString } @@ -156737,89 +158586,25 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Destination project - */ - shortDesc: () => LocalizedString - /** - * The project where you want to move the task. Either section_id or project_id must be specified. - */ - longDesc: () => LocalizedString - } - } - } - update_task: { - groups: { - /** - * Tasks - */ - '0': () => LocalizedString - } - /** - * Update Task - */ - displayName: () => LocalizedString - /** - * Update an existing Todoist task - */ - shortDesc: () => LocalizedString - /** - * Modifies the properties of an existing Todoist task. You can update content, description, due dates, labels, priority, and more. - */ - longDesc: () => LocalizedString - options: { - task_id: { - /** - * Task ID - */ - displayName: () => LocalizedString - /** - * The task to update - */ - shortDesc: () => LocalizedString - /** - * Select the Todoist task you want to modify. - */ - longDesc: () => LocalizedString - } - content: { - /** - * Task Content - */ - displayName: () => LocalizedString - /** - * Updated task description - */ - shortDesc: () => LocalizedString - /** - * The new main text describing what needs to be done. - */ - longDesc: () => LocalizedString - } - description: { - /** - * Description - */ - displayName: () => LocalizedString - /** - * Updated task details + * The project for this task */ shortDesc: () => LocalizedString /** - * New detailed description or notes about the task. Supports Markdown formatting. + * Select which Todoist project this task belongs to. If not specified, the task will be added to your Inbox. */ longDesc: () => LocalizedString } - project_id: { + assignee_id: { /** - * Project ID + * Assignee ID */ displayName: () => LocalizedString /** - * Move to different project + * Person assigned to the task */ shortDesc: () => LocalizedString /** - * Move the task to a different Todoist project. + * Assign the task to a specific collaborator in the selected project. */ longDesc: () => LocalizedString } @@ -156829,11 +158614,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Move to different section + * The section within the project */ shortDesc: () => LocalizedString /** - * Move the task to a different section within the project. + * Organize the task within a specific section of the project for better categorization. */ longDesc: () => LocalizedString } @@ -156843,11 +158628,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * New task position + * Task position in the list */ shortDesc: () => LocalizedString /** - * Change the position of the task in the project or section. + * Specify the position of the task in the project or section. Lower numbers appear first. */ longDesc: () => LocalizedString } @@ -156857,11 +158642,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Updated task labels + * Task labels */ shortDesc: () => LocalizedString /** - * Replace the task's labels with a new set of labels. + * Add one or more labels to categorize and filter the task. Labels help with organization and quick filtering. */ longDesc: () => LocalizedString } @@ -156871,11 +158656,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Updated priority level + * Task priority level */ shortDesc: () => LocalizedString /** - * Change the priority level: 1 (urgent), 2 (high), 3 (normal), 4 (low). + * Set the priority level for the task. Higher priority tasks are displayed with color-coded flags: 1 (urgent), 2 (high), 3 (normal), 4 (low). */ longDesc: () => LocalizedString } @@ -156885,11 +158670,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Updated due date + * When the task is due */ shortDesc: () => LocalizedString /** - * Change the due date and optionally the time for the task. + * Set a due date and optionally a time for when the task should be completed. */ longDesc: () => LocalizedString } @@ -156899,11 +158684,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Updated estimated time + * Estimated time to complete */ shortDesc: () => LocalizedString /** - * Change how long you expect the task to take. + * Specify how long you expect the task to take. Used for time tracking and scheduling. */ longDesc: () => LocalizedString type: { @@ -156941,214 +158726,978 @@ export type TranslationFunctions = { } } } - } - triggers: { - new_completed_task: { + delete_task: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } /** - * New Completed Task + * Delete Task */ displayName: () => LocalizedString /** - * Triggers when a task is completed in Todoist + * Permanently delete a Todoist task */ shortDesc: () => LocalizedString /** - * Monitors your Todoist account for newly completed tasks. This trigger fires whenever any task is marked as complete, with optional filtering by project, section, or custom query. Perfect for tracking productivity, logging completions, or triggering follow-up workflows based on task completion. + * Permanently removes a task from Todoist. This action cannot be undone. Use with caution. */ longDesc: () => LocalizedString options: { - project_id: { - /** - * Project ID - */ - displayName: () => LocalizedString - /** - * Filter by specific project - */ - shortDesc: () => LocalizedString - /** - * Optionally monitor only completed tasks from a specific Todoist project. If not specified, all completed tasks across all projects will trigger the event. - */ - longDesc: () => LocalizedString - } - section_id: { + task_id: { /** - * Section ID + * Task ID */ displayName: () => LocalizedString /** - * Filter by specific section + * The task to delete */ shortDesc: () => LocalizedString /** - * Optionally monitor only completed tasks from a specific section within a project. This allows you to track completions in specific areas of your workflow. + * Select the Todoist task you want to permanently delete. */ longDesc: () => LocalizedString } - query: { + } + } + get_project: { + groups: { + /** + * Projects + */ + '0': () => LocalizedString + } + /** + * Get Project + */ + displayName: () => LocalizedString + /** + * Retrieve details of a Todoist project + */ + shortDesc: () => LocalizedString + /** + * Fetches detailed information about a specific Todoist project, including its properties, metadata, and settings. + */ + longDesc: () => LocalizedString + options: { + project_id: { /** - * Filter Query + * Project ID */ displayName: () => LocalizedString /** - * Custom filter expression + * The project to retrieve */ shortDesc: () => LocalizedString /** - * The filter query to use, see [documentation](https://www.todoist.com/help/articles/introduction-to-filters-V98wIH) for more details + * Select the Todoist project you want to get details for. */ longDesc: () => LocalizedString } } } - } - } - AzureDevOps: { - /** - * Azure DevOps - */ - displayName: () => LocalizedString - groups: { - /** - * DevOps & Cloud Infrastructure - */ - '0': () => LocalizedString - /** - * Version Control & Code Repositories - */ - '1': () => LocalizedString - } - /** - * Connect to Azure DevOps to automate project management, code repositories, and CI/CD pipelines. - */ - shortDesc: () => LocalizedString - /** - * The Azure DevOps integration provides comprehensive actions and triggers to interact with Azure DevOps Services. Manage work items, repositories, builds, releases, and team projects efficiently. Automate your development workflow by connecting Azure DevOps with other tools and services in your automation pipeline. - */ - longDesc: () => LocalizedString - actions: { - create_work_item: { + get_project_collaborators: { + groups: { + /** + * Projects + */ + '0': () => LocalizedString + } /** - * Create Work Item + * Get Project Collaborators */ displayName: () => LocalizedString /** - * Create a new work item in Azure DevOps + * List collaborators in a project */ shortDesc: () => LocalizedString /** - * Create a new work item such as a task, bug, epic, or user story in a specified Azure DevOps project with customizable properties and fields. + * Retrieves a list of all collaborators who have access to a specific Todoist project. Useful for managing team assignments and permissions. */ longDesc: () => LocalizedString options: { - project: { + project_id: { /** - * Project + * Project ID */ displayName: () => LocalizedString /** - * The Azure DevOps project where the work item will be created + * The project to get collaborators for */ shortDesc: () => LocalizedString /** - * Select the target project from your Azure DevOps organization where the new work item should be created. + * Select the Todoist project to retrieve the list of collaborators. */ longDesc: () => LocalizedString } - itemType: { + cursor: { /** - * Work Item Type + * Cursor */ displayName: () => LocalizedString /** - * The type of work item to create + * Pagination cursor */ shortDesc: () => LocalizedString /** - * Choose the specific type of work item you want to create, such as Task, Bug, Epic, User Story, or other available types in your project. + * Used for pagination. Provide the cursor from a previous response to get the next page of results. */ longDesc: () => LocalizedString } - properties: { + limit: { /** - * Work Item Properties + * Limit */ displayName: () => LocalizedString /** - * Fields and values for the work item + * Maximum number of results */ shortDesc: () => LocalizedString /** - * Configure the properties and field values for the work item, including title, description, and other custom fields based on the selected work item type. + * The maximum number of collaborators to return in a single request. Default is 50. */ longDesc: () => LocalizedString - type: { - fields: { - 'System.Title': { - /** - * Title - */ - displayName: () => LocalizedString - /** - * The title of the work item - */ - shortDesc: () => LocalizedString - /** - * A descriptive title that summarizes the work item content. - */ - longDesc: () => LocalizedString - } - 'System.Description': { - /** - * Description - */ - displayName: () => LocalizedString - /** - * Detailed description of the work item - */ - shortDesc: () => LocalizedString - /** - * A comprehensive description explaining the work item requirements, context, and any relevant details. - */ - longDesc: () => LocalizedString - } - } - } } } } - delete_work_item: { + get_task: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } /** - * Delete Work Item + * Get Task */ displayName: () => LocalizedString /** - * Delete a work item from Azure DevOps + * Retrieve details of a Todoist task */ shortDesc: () => LocalizedString /** - * Permanently remove a work item from the specified Azure DevOps project. This action cannot be undone. + * Fetches detailed information about a specific Todoist task, including all its properties, labels, due dates, and metadata. */ longDesc: () => LocalizedString options: { - project: { + task_id: { /** - * Project + * Task ID */ displayName: () => LocalizedString /** - * The Azure DevOps project containing the work item + * The task to retrieve */ shortDesc: () => LocalizedString /** - * Select the project where the work item to be deleted is located. + * Select the Todoist task you want to get details for. */ longDesc: () => LocalizedString } - id: { - /** - * Work Item ID - */ + } + } + get_tasks_by_filter: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + /** + * Get Tasks by Filter + */ + displayName: () => LocalizedString + /** + * Search tasks using Todoist filter queries + */ + shortDesc: () => LocalizedString + /** + * Retrieves tasks that match a specific filter query. Todoist filters allow powerful searches using keywords, dates, priorities, labels, and more. See Todoist filter documentation for advanced query syntax. + */ + longDesc: () => LocalizedString + options: { + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor + */ + shortDesc: () => LocalizedString + /** + * Used for pagination. Provide the cursor from a previous response to get the next page of results. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of results + */ + shortDesc: () => LocalizedString + /** + * The maximum number of tasks to return in a single request. Default is 50. + */ + longDesc: () => LocalizedString + } + query: { + /** + * Filter Query + */ + displayName: () => LocalizedString + /** + * The filter expression + */ + shortDesc: () => LocalizedString + /** + * The filter query to use, see [documentation](https://www.todoist.com/help/articles/introduction-to-filters-V98wIH) for more details + */ + longDesc: () => LocalizedString + } + } + } + list_labels: { + groups: { + /** + * Labels + */ + '0': () => LocalizedString + } + /** + * List Labels + */ + displayName: () => LocalizedString + /** + * Retrieve all Todoist labels + */ + shortDesc: () => LocalizedString + /** + * Fetches a list of all labels in your Todoist account. Labels are used to categorize and filter tasks across projects. + */ + longDesc: () => LocalizedString + options: { + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor + */ + shortDesc: () => LocalizedString + /** + * Used for pagination. Provide the cursor from a previous response to get the next page of results. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of results + */ + shortDesc: () => LocalizedString + /** + * The maximum number of labels to return in a single request. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + list_projects: { + groups: { + /** + * Projects + */ + '0': () => LocalizedString + } + /** + * List Projects + */ + displayName: () => LocalizedString + /** + * Retrieve all Todoist projects + */ + shortDesc: () => LocalizedString + /** + * Fetches a list of all projects in your Todoist account, including shared and personal projects. Use this to discover available projects for task organization. + */ + longDesc: () => LocalizedString + options: { + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor + */ + shortDesc: () => LocalizedString + /** + * Used for pagination. Provide the cursor from a previous response to get the next page of results. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of results + */ + shortDesc: () => LocalizedString + /** + * The maximum number of projects to return in a single request. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + list_sections: { + groups: { + /** + * Sections + */ + '0': () => LocalizedString + } + /** + * List Sections + */ + displayName: () => LocalizedString + /** + * Retrieve sections from projects + */ + shortDesc: () => LocalizedString + /** + * Fetches a list of sections. Sections are used within projects to organize tasks into logical groups or categories. + */ + longDesc: () => LocalizedString + options: { + project_id: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * Filter by project + */ + shortDesc: () => LocalizedString + /** + * Optionally filter sections to only those within a specific project. + */ + longDesc: () => LocalizedString + } + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor + */ + shortDesc: () => LocalizedString + /** + * Used for pagination. Provide the cursor from a previous response to get the next page of results. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of results + */ + shortDesc: () => LocalizedString + /** + * The maximum number of sections to return in a single request. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + list_tasks: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + /** + * List Tasks + */ + displayName: () => LocalizedString + /** + * Retrieve Todoist tasks + */ + shortDesc: () => LocalizedString + /** + * Fetches a list of tasks with optional filtering by project, section, or label. Use this to retrieve tasks for processing or display. + */ + longDesc: () => LocalizedString + options: { + cursor: { + /** + * Cursor + */ + displayName: () => LocalizedString + /** + * Pagination cursor + */ + shortDesc: () => LocalizedString + /** + * Used for pagination. Provide the cursor from a previous response to get the next page of results. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of results + */ + shortDesc: () => LocalizedString + /** + * The maximum number of tasks to return in a single request. Default is 50. + */ + longDesc: () => LocalizedString + } + ids: { + /** + * Task IDs + */ + displayName: () => LocalizedString + /** + * Filter by specific task IDs + */ + shortDesc: () => LocalizedString + /** + * Optionally specify a list of task IDs to retrieve only those specific tasks. + */ + longDesc: () => LocalizedString + } + project_id: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * Filter by project + */ + shortDesc: () => LocalizedString + /** + * Retrieve only tasks from a specific project. + */ + longDesc: () => LocalizedString + } + section_id: { + /** + * Section ID + */ + displayName: () => LocalizedString + /** + * Filter by section + */ + shortDesc: () => LocalizedString + /** + * Retrieve only tasks from a specific section within a project. + */ + longDesc: () => LocalizedString + } + label: { + /** + * Label + */ + displayName: () => LocalizedString + /** + * Filter by label + */ + shortDesc: () => LocalizedString + /** + * Retrieve only tasks that have a specific label assigned. + */ + longDesc: () => LocalizedString + } + } + } + move_task_to_section: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + /** + * Move Task to Section + */ + displayName: () => LocalizedString + /** + * Move a task to a different section or project + */ + shortDesc: () => LocalizedString + /** + * Moves a task to a different section within the same project, or to a different project entirely. Useful for reorganizing tasks and workflows. + */ + longDesc: () => LocalizedString + options: { + task_id: { + /** + * Task ID + */ + displayName: () => LocalizedString + /** + * The task to move + */ + shortDesc: () => LocalizedString + /** + * Select the Todoist task you want to move. + */ + longDesc: () => LocalizedString + } + section_id: { + /** + * Section ID + */ + displayName: () => LocalizedString + /** + * Destination section + */ + shortDesc: () => LocalizedString + /** + * The section where you want to move the task. Either section_id or project_id must be specified. + */ + longDesc: () => LocalizedString + } + project_id: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * Destination project + */ + shortDesc: () => LocalizedString + /** + * The project where you want to move the task. Either section_id or project_id must be specified. + */ + longDesc: () => LocalizedString + } + } + } + update_task: { + groups: { + /** + * Tasks + */ + '0': () => LocalizedString + } + /** + * Update Task + */ + displayName: () => LocalizedString + /** + * Update an existing Todoist task + */ + shortDesc: () => LocalizedString + /** + * Modifies the properties of an existing Todoist task. You can update content, description, due dates, labels, priority, and more. + */ + longDesc: () => LocalizedString + options: { + task_id: { + /** + * Task ID + */ + displayName: () => LocalizedString + /** + * The task to update + */ + shortDesc: () => LocalizedString + /** + * Select the Todoist task you want to modify. + */ + longDesc: () => LocalizedString + } + content: { + /** + * Task Content + */ + displayName: () => LocalizedString + /** + * Updated task description + */ + shortDesc: () => LocalizedString + /** + * The new main text describing what needs to be done. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * Updated task details + */ + shortDesc: () => LocalizedString + /** + * New detailed description or notes about the task. Supports Markdown formatting. + */ + longDesc: () => LocalizedString + } + project_id: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * Move to different project + */ + shortDesc: () => LocalizedString + /** + * Move the task to a different Todoist project. + */ + longDesc: () => LocalizedString + } + section_id: { + /** + * Section ID + */ + displayName: () => LocalizedString + /** + * Move to different section + */ + shortDesc: () => LocalizedString + /** + * Move the task to a different section within the project. + */ + longDesc: () => LocalizedString + } + order: { + /** + * Order + */ + displayName: () => LocalizedString + /** + * New task position + */ + shortDesc: () => LocalizedString + /** + * Change the position of the task in the project or section. + */ + longDesc: () => LocalizedString + } + labels: { + /** + * Labels + */ + displayName: () => LocalizedString + /** + * Updated task labels + */ + shortDesc: () => LocalizedString + /** + * Replace the task's labels with a new set of labels. + */ + longDesc: () => LocalizedString + } + priority: { + /** + * Priority + */ + displayName: () => LocalizedString + /** + * Updated priority level + */ + shortDesc: () => LocalizedString + /** + * Change the priority level: 1 (urgent), 2 (high), 3 (normal), 4 (low). + */ + longDesc: () => LocalizedString + } + due_datetime: { + /** + * Due Date + */ + displayName: () => LocalizedString + /** + * Updated due date + */ + shortDesc: () => LocalizedString + /** + * Change the due date and optionally the time for the task. + */ + longDesc: () => LocalizedString + } + duration: { + /** + * Duration + */ + displayName: () => LocalizedString + /** + * Updated estimated time + */ + shortDesc: () => LocalizedString + /** + * Change how long you expect the task to take. + */ + longDesc: () => LocalizedString + type: { + fields: { + amount: { + /** + * Amount + */ + displayName: () => LocalizedString + /** + * Duration value + */ + shortDesc: () => LocalizedString + /** + * The numeric value for the duration. + */ + longDesc: () => LocalizedString + } + unit: { + /** + * Unit + */ + displayName: () => LocalizedString + /** + * Duration unit + */ + shortDesc: () => LocalizedString + /** + * The unit of time: minutes or days. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + } + triggers: { + new_completed_task: { + /** + * New Completed Task + */ + displayName: () => LocalizedString + /** + * Triggers when a task is completed in Todoist + */ + shortDesc: () => LocalizedString + /** + * Monitors your Todoist account for newly completed tasks. This trigger fires whenever any task is marked as complete, with optional filtering by project, section, or custom query. Perfect for tracking productivity, logging completions, or triggering follow-up workflows based on task completion. + */ + longDesc: () => LocalizedString + options: { + project_id: { + /** + * Project ID + */ + displayName: () => LocalizedString + /** + * Filter by specific project + */ + shortDesc: () => LocalizedString + /** + * Optionally monitor only completed tasks from a specific Todoist project. If not specified, all completed tasks across all projects will trigger the event. + */ + longDesc: () => LocalizedString + } + section_id: { + /** + * Section ID + */ + displayName: () => LocalizedString + /** + * Filter by specific section + */ + shortDesc: () => LocalizedString + /** + * Optionally monitor only completed tasks from a specific section within a project. This allows you to track completions in specific areas of your workflow. + */ + longDesc: () => LocalizedString + } + query: { + /** + * Filter Query + */ + displayName: () => LocalizedString + /** + * Custom filter expression + */ + shortDesc: () => LocalizedString + /** + * The filter query to use, see [documentation](https://www.todoist.com/help/articles/introduction-to-filters-V98wIH) for more details + */ + longDesc: () => LocalizedString + } + } + } + } + } + AzureDevOps: { + /** + * Azure DevOps + */ + displayName: () => LocalizedString + groups: { + /** + * DevOps & Cloud Infrastructure + */ + '0': () => LocalizedString + /** + * Version Control & Code Repositories + */ + '1': () => LocalizedString + } + /** + * Connect to Azure DevOps to automate project management, code repositories, and CI/CD pipelines. + */ + shortDesc: () => LocalizedString + /** + * The Azure DevOps integration provides comprehensive actions and triggers to interact with Azure DevOps Services. Manage work items, repositories, builds, releases, and team projects efficiently. Automate your development workflow by connecting Azure DevOps with other tools and services in your automation pipeline. + */ + longDesc: () => LocalizedString + actions: { + create_work_item: { + /** + * Create Work Item + */ + displayName: () => LocalizedString + /** + * Create a new work item in Azure DevOps + */ + shortDesc: () => LocalizedString + /** + * Create a new work item such as a task, bug, epic, or user story in a specified Azure DevOps project with customizable properties and fields. + */ + longDesc: () => LocalizedString + options: { + project: { + /** + * Project + */ + displayName: () => LocalizedString + /** + * The Azure DevOps project where the work item will be created + */ + shortDesc: () => LocalizedString + /** + * Select the target project from your Azure DevOps organization where the new work item should be created. + */ + longDesc: () => LocalizedString + } + itemType: { + /** + * Work Item Type + */ + displayName: () => LocalizedString + /** + * The type of work item to create + */ + shortDesc: () => LocalizedString + /** + * Choose the specific type of work item you want to create, such as Task, Bug, Epic, User Story, or other available types in your project. + */ + longDesc: () => LocalizedString + } + properties: { + /** + * Work Item Properties + */ + displayName: () => LocalizedString + /** + * Fields and values for the work item + */ + shortDesc: () => LocalizedString + /** + * Configure the properties and field values for the work item, including title, description, and other custom fields based on the selected work item type. + */ + longDesc: () => LocalizedString + type: { + fields: { + 'System.Title': { + /** + * Title + */ + displayName: () => LocalizedString + /** + * The title of the work item + */ + shortDesc: () => LocalizedString + /** + * A descriptive title that summarizes the work item content. + */ + longDesc: () => LocalizedString + } + 'System.Description': { + /** + * Description + */ + displayName: () => LocalizedString + /** + * Detailed description of the work item + */ + shortDesc: () => LocalizedString + /** + * A comprehensive description explaining the work item requirements, context, and any relevant details. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + delete_work_item: { + /** + * Delete Work Item + */ + displayName: () => LocalizedString + /** + * Delete a work item from Azure DevOps + */ + shortDesc: () => LocalizedString + /** + * Permanently remove a work item from the specified Azure DevOps project. This action cannot be undone. + */ + longDesc: () => LocalizedString + options: { + project: { + /** + * Project + */ + displayName: () => LocalizedString + /** + * The Azure DevOps project containing the work item + */ + shortDesc: () => LocalizedString + /** + * Select the project where the work item to be deleted is located. + */ + longDesc: () => LocalizedString + } + id: { + /** + * Work Item ID + */ displayName: () => LocalizedString /** * The unique identifier of the work item to delete @@ -208803,1802 +211352,5512 @@ export type TranslationFunctions = { displayName: () => LocalizedString groups: { /** - * Brands + * Brands + */ + '0': () => LocalizedString + } + } + Brands_DeleteBrands: { + /** + * Delete Brand + */ + displayName: () => LocalizedString + groups: { + /** + * Brands + */ + '0': () => LocalizedString + } + } + Envelopes_GetEnvelopes: { + /** + * Get Envelopes + */ + displayName: () => LocalizedString + groups: { + /** + * Envelopes + */ + '0': () => LocalizedString + } + } + Envelopes_PostEnvelopes: { + /** + * Create Envelopes + */ + displayName: () => LocalizedString + groups: { + /** + * Envelopes + */ + '0': () => LocalizedString + } + } + Envelopes_GetEnvelope: { + /** + * Get Envelope + */ + displayName: () => LocalizedString + groups: { + /** + * Envelopes + */ + '0': () => LocalizedString + } + } + Envelopes_PutEnvelope: { + /** + * Update Envelope + */ + displayName: () => LocalizedString + groups: { + /** + * Envelopes + */ + '0': () => LocalizedString + } + } + Documents_GetDocuments: { + /** + * Get Documents + */ + displayName: () => LocalizedString + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } + } + Documents_PutDocuments: { + /** + * Update Documents + */ + displayName: () => LocalizedString + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } + } + Documents_DeleteDocuments: { + /** + * Delete Documents + */ + displayName: () => LocalizedString + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } + } + Documents_GetDocument: { + /** + * Get Document + */ + displayName: () => LocalizedString + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } + } + Documents_PutDocument: { + /** + * Update Document + */ + displayName: () => LocalizedString + groups: { + /** + * Documents + */ + '0': () => LocalizedString + } + } + Recipients_GetRecipients: { + /** + * Get Recipients + */ + displayName: () => LocalizedString + groups: { + /** + * Recipients + */ + '0': () => LocalizedString + } + } + Recipients_PutRecipients: { + /** + * Update Recipients + */ + displayName: () => LocalizedString + groups: { + /** + * Recipients + */ + '0': () => LocalizedString + } + } + Recipients_PostRecipients: { + /** + * Add Recipients + */ + displayName: () => LocalizedString + groups: { + /** + * Recipients + */ + '0': () => LocalizedString + } + } + Recipients_DeleteRecipients: { + /** + * Delete Recipients + */ + displayName: () => LocalizedString + groups: { + /** + * Recipients + */ + '0': () => LocalizedString + } + } + Views_PostEnvelopeRecipientView: { + /** + * Create Recipient View + */ + displayName: () => LocalizedString + groups: { + /** + * Views + */ + '0': () => LocalizedString + } + } + } + triggers: { + envelope_status_updated: { + /** + * Envelope Status Updated + */ + displayName: () => LocalizedString + /** + * Triggers whenever a DocuSign envelope's status or properties are updated, including events like it being sent, delivered, signed, completed, declined, voided, corrected, purged, or deleted. + */ + shortDesc: () => LocalizedString + /** + * This trigger activates whenever there’s a change in a DocuSign envelope’s lifecycle. It listens for a variety of updates, such as when an envelope is sent to recipients, delivered, signed, completed, or declined. It also includes administrative events like envelopes being resent, corrected, purged, deleted, discarded, newly created, or removed. By setting up this trigger, you can stay informed of envelope progress and status changes, enabling timely follow-ups, record-keeping, or other automated actions in your workflow. + */ + longDesc: () => LocalizedString + options: { + accountId: { + /** + * Default Account ID + */ + displayName: () => LocalizedString + /** + * The default account ID set when the connection is authorized + */ + shortDesc: () => LocalizedString + /** + * The default account ID set when the connection is authorized + */ + longDesc: () => LocalizedString + } + } + event_info: { + /** + * DocuSign envelope status update event data + */ + desc: () => LocalizedString + } + } + template_updated: { + /** + * Template Updated + */ + displayName: () => LocalizedString + /** + * Triggers whenever a new DocuSign template is created, updated or deleted, allowing you to take immediate action in response to the new template. + */ + shortDesc: () => LocalizedString + options: { + accountId: { + /** + * Default Account ID + */ + displayName: () => LocalizedString + /** + * The default account ID set when the connection is authorized + */ + shortDesc: () => LocalizedString + /** + * The default account ID set when the connection is authorized + */ + longDesc: () => LocalizedString + } + } + event_info: { + /** + * DocuSign template update event data + */ + desc: () => LocalizedString + } + } + } + } + Zendesk: { + /** + * Zendesk + */ + displayName: () => LocalizedString + groups: { + /** + * Customer Support & Helpdesk + */ + '0': () => LocalizedString + } + /** + * Collection of actions to interact with the Zendesk API + */ + shortDesc: () => LocalizedString + /** + * Collection of actions to interact with the Zendesk API + */ + longDesc: () => LocalizedString + expressions: { + '&&': { + /** + * and (&&) + */ + displayName: () => LocalizedString + /** + * Returns True if all arguments are True + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if all arguments are `True` with logic short-circuiting + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Condition + */ + displayName: () => LocalizedString + /** + * Boolean condition to evaluate + */ + shortDesc: () => LocalizedString + /** + * A boolean expression or condition that evaluates to True or False + */ + longDesc: () => LocalizedString + } + } + } + '||': { + /** + * or (||) + */ + displayName: () => LocalizedString + /** + * Returns True if any argument is True + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if any argument is `True` with logic short-circuiting + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Condition + */ + displayName: () => LocalizedString + /** + * Boolean condition to evaluate + */ + shortDesc: () => LocalizedString + /** + * A boolean expression or condition that evaluates to True or False + */ + longDesc: () => LocalizedString + } + } + } + '==': { + /** + * equal (==) + */ + displayName: () => LocalizedString + /** + * Equality comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value equals the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } + } + '!=': { + /** + * not equal (!=) + */ + displayName: () => LocalizedString + /** + * Inequality comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value does not equal the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } + } + '>': { + /** + * greater than (>) + */ + displayName: () => LocalizedString + /** + * Greater than comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is greater than the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } + } + '>=': { + /** + * greater than or equal (>=) + */ + displayName: () => LocalizedString + /** + * Greater than or equal comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is greater than or equal to the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } + } + '<': { + /** + * less than (<) + */ + displayName: () => LocalizedString + /** + * Less than comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is less than the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } + } + '<=': { + /** + * less than or equal (<=) + */ + displayName: () => LocalizedString + /** + * Less than or equal comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is less than or equal to the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } + } + } + triggers: { + new_user: { + /** + * New User + */ + displayName: () => LocalizedString + /** + * Triggers when a new user is created + */ + shortDesc: () => LocalizedString + /** + * Triggers when a new user is created + */ + longDesc: () => LocalizedString + event_info: { + /** + * Zendesk User Event Data + */ + desc: () => LocalizedString + type: { + fields: { + account_id: { + /** + * Account ID + */ + displayName: () => LocalizedString + /** + * Account ID + */ + shortDesc: () => LocalizedString + /** + * ID of the associated account + */ + longDesc: () => LocalizedString + } + detail: { + /** + * Detail + */ + displayName: () => LocalizedString + /** + * User details + */ + shortDesc: () => LocalizedString + /** + * Detailed user information + */ + longDesc: () => LocalizedString + type: { + fields: { + created_at: { + /** + * Created At + */ + displayName: () => LocalizedString + /** + * User creation time + */ + shortDesc: () => LocalizedString + /** + * Timestamp of user creation + */ + longDesc: () => LocalizedString + } + default_group_id: { + /** + * Default Group ID + */ + displayName: () => LocalizedString + /** + * Default group ID + */ + shortDesc: () => LocalizedString + /** + * ID of the default group for the user + */ + longDesc: () => LocalizedString + } + email: { + /** + * Email + */ + displayName: () => LocalizedString + /** + * User email + */ + shortDesc: () => LocalizedString + /** + * Email address of the user + */ + longDesc: () => LocalizedString + } + external_id: { + /** + * External ID + */ + displayName: () => LocalizedString + /** + * User external ID + */ + shortDesc: () => LocalizedString + /** + * External identifier for the user + */ + longDesc: () => LocalizedString + } + id: { + /** + * User ID + */ + displayName: () => LocalizedString + /** + * User ID + */ + shortDesc: () => LocalizedString + /** + * Unique identifier for the user + */ + longDesc: () => LocalizedString + } + organization_id: { + /** + * Organization ID + */ + displayName: () => LocalizedString + /** + * Organization ID + */ + shortDesc: () => LocalizedString + /** + * ID of the organization associated with the user + */ + longDesc: () => LocalizedString + } + role: { + /** + * Role + */ + displayName: () => LocalizedString + /** + * User role + */ + shortDesc: () => LocalizedString + /** + * Role of the user in the system + */ + longDesc: () => LocalizedString + } + updated_at: { + /** + * Updated At + */ + displayName: () => LocalizedString + /** + * User update time + */ + shortDesc: () => LocalizedString + /** + * Last update timestamp for the user + */ + longDesc: () => LocalizedString + } + } + } + } + event: { + /** + * Event + */ + displayName: () => LocalizedString + /** + * Event info + */ + shortDesc: () => LocalizedString + /** + * Additional event information + */ + longDesc: () => LocalizedString + } + id: { + /** + * Event ID + */ + displayName: () => LocalizedString + /** + * Event ID + */ + shortDesc: () => LocalizedString + /** + * Unique identifier for the event + */ + longDesc: () => LocalizedString + } + subject: { + /** + * Subject + */ + displayName: () => LocalizedString + /** + * Event subject + */ + shortDesc: () => LocalizedString + /** + * Subject of the event + */ + longDesc: () => LocalizedString + } + time: { + /** + * Time + */ + displayName: () => LocalizedString + /** + * Event time + */ + shortDesc: () => LocalizedString + /** + * Timestamp of the event occurrence + */ + longDesc: () => LocalizedString + } + type: { + /** + * Event Type + */ + displayName: () => LocalizedString + /** + * Event type + */ + shortDesc: () => LocalizedString + /** + * Type of the event + */ + longDesc: () => LocalizedString + } + zendesk_event_version: { + /** + * Zendesk Event Version + */ + displayName: () => LocalizedString + /** + * Event version + */ + shortDesc: () => LocalizedString + /** + * Version of the Zendesk event format + */ + longDesc: () => LocalizedString + } + } + } + } + } + new_ticket: { + /** + * New Ticket + */ + displayName: () => LocalizedString + /** + * Triggers when a new ticket is created + */ + shortDesc: () => LocalizedString + /** + * Triggers when a new ticket is created + */ + longDesc: () => LocalizedString + event_info: { + /** + * New Ticket Event Data + */ + desc: () => LocalizedString + type: { + fields: { + assignee_email: { + /** + * Assignee Email + */ + displayName: () => LocalizedString + /** + * Assignee email + */ + shortDesc: () => LocalizedString + /** + * Email of the assignee + */ + longDesc: () => LocalizedString + } + assignee_name: { + /** + * Assignee Name + */ + displayName: () => LocalizedString + /** + * Assignee name + */ + shortDesc: () => LocalizedString + /** + * Name of the assignee + */ + longDesc: () => LocalizedString + } + group_name: { + /** + * Group Name + */ + displayName: () => LocalizedString + /** + * Group name + */ + shortDesc: () => LocalizedString + /** + * Name of the group handling the ticket + */ + longDesc: () => LocalizedString + } + organization_name: { + /** + * Organization Name + */ + displayName: () => LocalizedString + /** + * Organization name + */ + shortDesc: () => LocalizedString + /** + * Name of the associated organization + */ + longDesc: () => LocalizedString + } + requester_email: { + /** + * Requester Email + */ + displayName: () => LocalizedString + /** + * Requester email + */ + shortDesc: () => LocalizedString + /** + * Email of the requester + */ + longDesc: () => LocalizedString + } + requester_name: { + /** + * Requester Name + */ + displayName: () => LocalizedString + /** + * Requester name + */ + shortDesc: () => LocalizedString + /** + * Name of the requester + */ + longDesc: () => LocalizedString + } + tags: { + /** + * Tags + */ + displayName: () => LocalizedString + /** + * Ticket tags + */ + shortDesc: () => LocalizedString + /** + * Tags associated with the ticket + */ + longDesc: () => LocalizedString + } + ticket_description: { + /** + * Ticket Description + */ + displayName: () => LocalizedString + /** + * Ticket description + */ + shortDesc: () => LocalizedString + /** + * Description of the ticket + */ + longDesc: () => LocalizedString + } + ticket_id: { + /** + * Ticket ID + */ + displayName: () => LocalizedString + /** + * Ticket ID + */ + shortDesc: () => LocalizedString + /** + * Unique identifier for the ticket + */ + longDesc: () => LocalizedString + } + ticket_priority: { + /** + * Ticket Priority + */ + displayName: () => LocalizedString + /** + * Ticket priority + */ + shortDesc: () => LocalizedString + /** + * Priority level of the ticket + */ + longDesc: () => LocalizedString + } + ticket_status: { + /** + * Ticket Status + */ + displayName: () => LocalizedString + /** + * Ticket status + */ + shortDesc: () => LocalizedString + /** + * Current status of the ticket + */ + longDesc: () => LocalizedString + } + ticket_subject: { + /** + * Ticket Subject + */ + displayName: () => LocalizedString + /** + * Ticket subject + */ + shortDesc: () => LocalizedString + /** + * Subject of the ticket + */ + longDesc: () => LocalizedString + } + ticket_type: { + /** + * Ticket Type + */ + displayName: () => LocalizedString + /** + * Ticket type + */ + shortDesc: () => LocalizedString + /** + * Type of the ticket + */ + longDesc: () => LocalizedString + } + ticket_url: { + /** + * Ticket URL + */ + displayName: () => LocalizedString + /** + * Ticket URL + */ + shortDesc: () => LocalizedString + /** + * URL of the ticket in the system + */ + longDesc: () => LocalizedString + } + } + } + } + } + new_organization: { + /** + * New Organization + */ + displayName: () => LocalizedString + /** + * Triggers when a new organization is created + */ + shortDesc: () => LocalizedString + /** + * Triggers when a new organization is created + */ + longDesc: () => LocalizedString + event_info: { + /** + * Zendesk Organization Event Data + */ + desc: () => LocalizedString + type: { + fields: { + account_id: { + /** + * Account ID + */ + displayName: () => LocalizedString + /** + * Account ID + */ + shortDesc: () => LocalizedString + /** + * ID of the associated account + */ + longDesc: () => LocalizedString + } + detail: { + /** + * Detail + */ + displayName: () => LocalizedString + /** + * Organization details + */ + shortDesc: () => LocalizedString + /** + * Detailed organization information + */ + longDesc: () => LocalizedString + type: { + fields: { + created_at: { + /** + * Created At + */ + displayName: () => LocalizedString + /** + * Organization creation time + */ + shortDesc: () => LocalizedString + /** + * Timestamp of organization creation + */ + longDesc: () => LocalizedString + } + external_id: { + /** + * External ID + */ + displayName: () => LocalizedString + /** + * Organization external ID + */ + shortDesc: () => LocalizedString + /** + * External identifier for the organization + */ + longDesc: () => LocalizedString + } + group_id: { + /** + * Group ID + */ + displayName: () => LocalizedString + /** + * Group ID + */ + shortDesc: () => LocalizedString + /** + * ID of the associated group + */ + longDesc: () => LocalizedString + } + id: { + /** + * Organization ID + */ + displayName: () => LocalizedString + /** + * Organization ID + */ + shortDesc: () => LocalizedString + /** + * Unique identifier for the organization + */ + longDesc: () => LocalizedString + } + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * Organization name + */ + shortDesc: () => LocalizedString + /** + * Name of the organization + */ + longDesc: () => LocalizedString + } + shared_comments: { + /** + * Shared Comments + */ + displayName: () => LocalizedString + /** + * Shared comments + */ + shortDesc: () => LocalizedString + /** + * Indicates if comments are shared + */ + longDesc: () => LocalizedString + } + shared_tickets: { + /** + * Shared Tickets + */ + displayName: () => LocalizedString + /** + * Shared tickets + */ + shortDesc: () => LocalizedString + /** + * Indicates if tickets are shared + */ + longDesc: () => LocalizedString + } + updated_at: { + /** + * Updated At + */ + displayName: () => LocalizedString + /** + * Organization update time + */ + shortDesc: () => LocalizedString + /** + * Last update timestamp for the organization + */ + longDesc: () => LocalizedString + } + } + } + } + event: { + /** + * Event + */ + displayName: () => LocalizedString + /** + * Event info + */ + shortDesc: () => LocalizedString + /** + * Additional event information + */ + longDesc: () => LocalizedString + } + id: { + /** + * Event ID + */ + displayName: () => LocalizedString + /** + * Event ID + */ + shortDesc: () => LocalizedString + /** + * Unique identifier for the event + */ + longDesc: () => LocalizedString + } + subject: { + /** + * Subject + */ + displayName: () => LocalizedString + /** + * Event subject + */ + shortDesc: () => LocalizedString + /** + * Subject of the event + */ + longDesc: () => LocalizedString + } + time: { + /** + * Time + */ + displayName: () => LocalizedString + /** + * Event time + */ + shortDesc: () => LocalizedString + /** + * Timestamp of the event occurrence + */ + longDesc: () => LocalizedString + } + type: { + /** + * Event Type + */ + displayName: () => LocalizedString + /** + * Event type + */ + shortDesc: () => LocalizedString + /** + * Type of the event + */ + longDesc: () => LocalizedString + } + zendesk_event_version: { + /** + * Zendesk Event Version + */ + displayName: () => LocalizedString + /** + * Event version + */ + shortDesc: () => LocalizedString + /** + * Version of the Zendesk event format + */ + longDesc: () => LocalizedString + } + } + } + } + } + new_custom_object_record: { + /** + * New Custom Object Record + */ + displayName: () => LocalizedString + /** + * Triggers when a new custom object record is created + */ + shortDesc: () => LocalizedString + /** + * Triggers when a new custom object record is created in Zendesk + */ + longDesc: () => LocalizedString + options: { + custom_object: { + /** + * Custom Object + */ + displayName: () => LocalizedString + /** + * The custom object to monitor for new records + */ + shortDesc: () => LocalizedString + /** + * Select the custom object type to monitor for new records + */ + longDesc: () => LocalizedString + } + } + event_info: { + /** + * Zendesk Custom Object Record Event Data + */ + desc: () => LocalizedString + type: { + fields: { + id: { + /** + * Record ID + */ + displayName: () => LocalizedString + /** + * Record ID + */ + shortDesc: () => LocalizedString + /** + * Unique identifier for the custom object record + */ + longDesc: () => LocalizedString + } + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * Record name + */ + shortDesc: () => LocalizedString + /** + * The name of the custom object record + */ + longDesc: () => LocalizedString + } + external_id: { + /** + * External ID + */ + displayName: () => LocalizedString + /** + * External ID + */ + shortDesc: () => LocalizedString + /** + * External identifier for the record + */ + longDesc: () => LocalizedString + } + created_at: { + /** + * Created At + */ + displayName: () => LocalizedString + /** + * Record creation time + */ + shortDesc: () => LocalizedString + /** + * Timestamp of record creation + */ + longDesc: () => LocalizedString + } + updated_at: { + /** + * Updated At + */ + displayName: () => LocalizedString + /** + * Record update time + */ + shortDesc: () => LocalizedString + /** + * Last update timestamp for the record + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + actions: { + ShowAccountSettings: { + groups: { + /** + * Settings + */ + '0': () => LocalizedString + } + } + ShowAttachment: { + groups: { + /** + * Attachments + */ + '0': () => LocalizedString + } + } + ListGroups: { + groups: { + /** + * Groups + */ + '0': () => LocalizedString + } + } + CreateGroup: { + groups: { + /** + * Groups + */ + '0': () => LocalizedString + } + options: { + group: { + /** + * Group + */ + displayName: () => LocalizedString + /** + * Group + */ + shortDesc: () => LocalizedString + /** + * Group + */ + longDesc: () => LocalizedString + type: { + fields: { + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * Group name + */ + shortDesc: () => LocalizedString + /** + * Group name + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * Group description + */ + shortDesc: () => LocalizedString + /** + * Group description + */ + longDesc: () => LocalizedString + } + 'default': { + /** + * Default + */ + displayName: () => LocalizedString + /** + * Default group assignment for team members in Zendesk. + */ + shortDesc: () => LocalizedString + /** + * Team members will automatically be assigned to this group when they're added to Zendesk. There can only be one default group. + */ + longDesc: () => LocalizedString + } + is_public: { + /** + * Public + */ + displayName: () => LocalizedString + /** + * Public group visibility + */ + shortDesc: () => LocalizedString + /** + * Indicates if the group should be public. Default is true. + */ + longDesc: () => LocalizedString + } + user_ids: { + /** + * User IDs + */ + displayName: () => LocalizedString + /** + * Users to add to the group + */ + shortDesc: () => LocalizedString + /** + * List of user IDs to be added to the group + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + DeleteGroup: { + groups: { + /** + * Groups + */ + '0': () => LocalizedString + } + } + ShowGroupById: { + groups: { + /** + * Groups + */ + '0': () => LocalizedString + } + } + UpdateGroup: { + groups: { + /** + * Groups + */ + '0': () => LocalizedString + } + options: { + group_id: { + /** + * Group ID + */ + displayName: () => LocalizedString + /** + * Group ID + */ + shortDesc: () => LocalizedString + /** + * Group ID + */ + longDesc: () => LocalizedString + } + group: { + /** + * Group + */ + displayName: () => LocalizedString + /** + * Group information + */ + shortDesc: () => LocalizedString + /** + * Details about the group settings in Zendesk + */ + longDesc: () => LocalizedString + type: { + fields: { + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * Group name + */ + shortDesc: () => LocalizedString + /** + * The name of the group + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * Group description + */ + shortDesc: () => LocalizedString + /** + * A description of the group + */ + longDesc: () => LocalizedString + } + 'default': { + /** + * Default + */ + displayName: () => LocalizedString + /** + * Default group assignment + */ + shortDesc: () => LocalizedString + /** + * Team members will automatically be assigned to this group when they're added to Zendesk. There can only be one default group. + */ + longDesc: () => LocalizedString + } + is_public: { + /** + * Public + */ + displayName: () => LocalizedString + /** + * Public group visibility + */ + shortDesc: () => LocalizedString + /** + * Indicates whether the group should be public. Default is true. + */ + longDesc: () => LocalizedString + } + user_ids: { + /** + * User IDs + */ + displayName: () => LocalizedString + /** + * List of user IDs + */ + shortDesc: () => LocalizedString + /** + * The IDs of users to be added to the group + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + ListOrganizations: { + groups: { + /** + * Organizations + */ + '0': () => LocalizedString + } + } + CreateOrganization: { + groups: { + /** + * Organizations + */ + '0': () => LocalizedString + } + } + DeleteOrganization: { + groups: { + /** + * Organizations + */ + '0': () => LocalizedString + } + } + ShowOrganization: { + groups: { + /** + * Organizations + */ + '0': () => LocalizedString + } + } + UpdateOrganization: { + groups: { + /** + * Organizations + */ + '0': () => LocalizedString + } + options: { + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * Organization name + */ + shortDesc: () => LocalizedString + /** + * Organization name + */ + longDesc: () => LocalizedString + } + group_id: { + /** + * Group ID + */ + displayName: () => LocalizedString + /** + * Group ID + */ + shortDesc: () => LocalizedString + /** + * Group ID + */ + longDesc: () => LocalizedString + } + notes: { + /** + * Notes + */ + displayName: () => LocalizedString + /** + * Notes about the organization + */ + shortDesc: () => LocalizedString + /** + * Notes about the organization + */ + longDesc: () => LocalizedString + } + details: { + /** + * Details + */ + displayName: () => LocalizedString + /** + * Details + */ + shortDesc: () => LocalizedString + /** + * Details + */ + longDesc: () => LocalizedString + } + } + } + ListSearchResults: { + groups: { + /** + * Search + */ + '0': () => LocalizedString + } + } + ListTickets: { + groups: { + /** + * Tickets + */ + '0': () => LocalizedString + } + } + CreateTicket: { + groups: { + /** + * Tickets + */ + '0': () => LocalizedString + } + } + CountTickets: { + groups: { + /** + * Tickets + */ + '0': () => LocalizedString + } + } + DeleteTicket: { + groups: { + /** + * Tickets + */ + '0': () => LocalizedString + } + } + ShowTicket: { + groups: { + /** + * Tickets + */ + '0': () => LocalizedString + } + } + UpdateTicket: { + groups: { + /** + * Tickets + */ + '0': () => LocalizedString + } + } + ListTicketMetrics: { + groups: { + /** + * Ticket Metrics + */ + '0': () => LocalizedString + } + } + ShowTicketMetrics: { + groups: { + /** + * Ticket Metrics + */ + '0': () => LocalizedString + } + } + DeleteUpload: { + groups: { + /** + * Uploads + */ + '0': () => LocalizedString + } + } + ListUsers: { + groups: { + /** + * Users + */ + '0': () => LocalizedString + } + } + CreateUser: { + groups: { + /** + * Users + */ + '0': () => LocalizedString + } + options: { + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * User information + */ + shortDesc: () => LocalizedString + /** + * Details about the user in Zendesk + */ + longDesc: () => LocalizedString + type: { + fields: { + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * User's name + */ + shortDesc: () => LocalizedString + /** + * The full name of the user + */ + longDesc: () => LocalizedString + } + email: { + /** + * Email + */ + displayName: () => LocalizedString + /** + * User's email address + */ + shortDesc: () => LocalizedString + /** + * The email address associated with the user + */ + longDesc: () => LocalizedString + } + phone: { + /** + * Phone + */ + displayName: () => LocalizedString + /** + * User's phone number + */ + shortDesc: () => LocalizedString + /** + * The phone number associated with the user + */ + longDesc: () => LocalizedString + } + notes: { + /** + * Notes + */ + displayName: () => LocalizedString + /** + * User notes + */ + shortDesc: () => LocalizedString + /** + * Additional notes or comments about the user + */ + longDesc: () => LocalizedString + } + details: { + /** + * Details + */ + displayName: () => LocalizedString + /** + * Additional details + */ + shortDesc: () => LocalizedString + /** + * Detailed information about the user + */ + longDesc: () => LocalizedString + } + role: { + /** + * Role + */ + displayName: () => LocalizedString + /** + * User role + */ + shortDesc: () => LocalizedString + /** + * The role assigned to the user in the system + */ + longDesc: () => LocalizedString + } + organization_ids: { + /** + * Organization IDs + */ + displayName: () => LocalizedString + /** + * List of organization IDs + */ + shortDesc: () => LocalizedString + /** + * The IDs of the organizations the user is associated with + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + DeleteUser: { + groups: { + /** + * Users + */ + '0': () => LocalizedString + } + } + ShowUser: { + groups: { + /** + * Users + */ + '0': () => LocalizedString + } + } + UpdateUser: { + groups: { + /** + * Users + */ + '0': () => LocalizedString + } + options: { + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * User information + */ + shortDesc: () => LocalizedString + /** + * Details about the user in the Zendesk system + */ + longDesc: () => LocalizedString + type: { + fields: { + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * User's name + */ + shortDesc: () => LocalizedString + /** + * The full name of the user + */ + longDesc: () => LocalizedString + } + email: { + /** + * Email + */ + displayName: () => LocalizedString + /** + * User's email address + */ + shortDesc: () => LocalizedString + /** + * The email address associated with the user + */ + longDesc: () => LocalizedString + } + phone: { + /** + * Phone + */ + displayName: () => LocalizedString + /** + * User's phone number + */ + shortDesc: () => LocalizedString + /** + * The phone number associated with the user + */ + longDesc: () => LocalizedString + } + notes: { + /** + * Notes + */ + displayName: () => LocalizedString + /** + * User notes + */ + shortDesc: () => LocalizedString + /** + * Additional notes or comments about the user + */ + longDesc: () => LocalizedString + } + details: { + /** + * Details + */ + displayName: () => LocalizedString + /** + * Additional details + */ + shortDesc: () => LocalizedString + /** + * Additional detailed information about the user + */ + longDesc: () => LocalizedString + } + role: { + /** + * Role + */ + displayName: () => LocalizedString + /** + * User role + */ + shortDesc: () => LocalizedString + /** + * The role assigned to the user within the system + */ + longDesc: () => LocalizedString + } + organization_ids: { + /** + * Organization IDs + */ + displayName: () => LocalizedString + /** + * List of organization IDs + */ + shortDesc: () => LocalizedString + /** + * The IDs of the organizations the user is associated with + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + } + searchOptions: { + orderBy: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + column: { + /** + * Column + */ + displayName: () => LocalizedString + /** + * The column to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the column to use for sorting results + */ + longDesc: () => LocalizedString + } + ascending: { + /** + * Ascending + */ + displayName: () => LocalizedString + /** + * Sort in ascending order + */ + shortDesc: () => LocalizedString + /** + * When enabled, results are sorted in ascending order (A-Z, 0-9) + */ + longDesc: () => LocalizedString + } + } + } + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of records to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of records to return. + */ + longDesc: () => LocalizedString + } + } + } + HelpScout: { + /** + * Help Scout + */ + displayName: () => LocalizedString + groups: { + /** + * Customer Support & Helpdesk + */ + '0': () => LocalizedString + } + connectionMessage: { + /** + * OAuth Connection + */ + title: () => LocalizedString + /** + * Help Scout uses OAuth 2.0 for authentication. You will be redirected to Help Scout to authorize access to your account. + */ + content: () => LocalizedString + } + /** + * Connect with Help Scout to manage customer conversations and support tickets + */ + shortDesc: () => LocalizedString + /** + * Integrate with Help Scout to manage customer support conversations, create and update customers, send replies, and track support interactions. This integration enables you to automate support workflows, respond to customers, and maintain customer relationships through Help Scout. + */ + longDesc: () => LocalizedString + actions: { + add_note: { + groups: { + /** + * Conversations + */ + '0': () => LocalizedString + } + /** + * Add Note to Conversation + */ + displayName: () => LocalizedString + /** + * Add an internal note to a conversation + */ + shortDesc: () => LocalizedString + /** + * Add an internal note to an existing conversation in Help Scout. Notes are only visible to your team members and are not sent to the customer. Use notes to document internal discussions, research, or context about a customer issue. + */ + longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to add the note to + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation where you want to add the note. You can search for conversations by number or subject. + */ + longDesc: () => LocalizedString + } + text: { + /** + * Note Text + */ + displayName: () => LocalizedString + /** + * The content of the note + */ + shortDesc: () => LocalizedString + /** + * The text content of the internal note. This can include HTML formatting. The note will only be visible to your team members. + */ + longDesc: () => LocalizedString + } + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * The user adding the note + */ + shortDesc: () => LocalizedString + /** + * The Help Scout user who is adding the note. If not specified, defaults to the authenticated user. + */ + longDesc: () => LocalizedString + } + status: { + /** + * Status + */ + displayName: () => LocalizedString + /** + * Change the conversation status + */ + shortDesc: () => LocalizedString + /** + * Optionally change the conversation status when adding the note. Options include active, closed, open, pending, or spam. + */ + longDesc: () => LocalizedString + } + } + } + create_conversation: { + groups: { + /** + * Conversations + */ + '0': () => LocalizedString + } + /** + * Create Conversation + */ + displayName: () => LocalizedString + /** + * Create a new conversation + */ + shortDesc: () => LocalizedString + /** + * Create a new conversation in Help Scout. A conversation represents an email thread or support ticket with a customer. You must specify the mailbox, customer, and initial message content. + */ + longDesc: () => LocalizedString + options: { + subject: { + /** + * Subject + */ + displayName: () => LocalizedString + /** + * The conversation subject line + */ + shortDesc: () => LocalizedString + /** + * The subject line for the conversation. This will be visible to the customer in email communications. + */ + longDesc: () => LocalizedString + } + mailboxId: { + /** + * Mailbox + */ + displayName: () => LocalizedString + /** + * The mailbox to create the conversation in + */ + shortDesc: () => LocalizedString + /** + * Select the Help Scout mailbox (inbox) where this conversation should be created. Each mailbox typically corresponds to a different support email address or team. + */ + longDesc: () => LocalizedString + } + type: { + /** + * Type + */ + displayName: () => LocalizedString + /** + * The conversation type + */ + shortDesc: () => LocalizedString + /** + * The type of conversation: email (standard email thread), phone (phone call record), or chat (live chat conversation). + */ + longDesc: () => LocalizedString + } + status: { + /** + * Status + */ + displayName: () => LocalizedString + /** + * The initial conversation status + */ + shortDesc: () => LocalizedString + /** + * The initial status of the conversation. Active means the conversation needs attention, closed means it is resolved, and pending means waiting for customer response. + */ + longDesc: () => LocalizedString + } + customerId: { + /** + * Customer ID + */ + displayName: () => LocalizedString + /** + * The ID of an existing customer + */ + shortDesc: () => LocalizedString + /** + * Select an existing customer from Help Scout. Either Customer ID or Customer Email must be provided. + */ + longDesc: () => LocalizedString + } + customerEmail: { + /** + * Customer Email + */ + displayName: () => LocalizedString + /** + * The email address of the customer + */ + shortDesc: () => LocalizedString + /** + * The email address of the customer. If the customer does not exist, they will be created. Either Customer ID or Customer Email must be provided. + */ + longDesc: () => LocalizedString + } + threadType: { + /** + * Thread Type + */ + displayName: () => LocalizedString + /** + * The type of the initial thread + */ + shortDesc: () => LocalizedString + /** + * The type of the first message in the conversation. Customer means the message is from the customer, reply means it is from your team, and note is an internal note. + */ + longDesc: () => LocalizedString + } + threadText: { + /** + * Thread Text + */ + displayName: () => LocalizedString + /** + * The content of the initial message + */ + shortDesc: () => LocalizedString + /** + * The text content of the first message in the conversation. This can include HTML formatting. + */ + longDesc: () => LocalizedString + } + assignTo: { + /** + * Assign To + */ + displayName: () => LocalizedString + /** + * Assign the conversation to a user + */ + shortDesc: () => LocalizedString + /** + * Optionally assign the conversation to a specific Help Scout user. If not specified, the conversation will be unassigned or follow your mailbox routing rules. + */ + longDesc: () => LocalizedString + } + tags: { + /** + * Tags + */ + displayName: () => LocalizedString + /** + * Tags to add to the conversation + */ + shortDesc: () => LocalizedString + /** + * A list of tag names to add to the conversation. Tags help organize and categorize conversations for easier filtering and reporting. + */ + longDesc: () => LocalizedString + } + autoReply: { + /** + * Auto Reply + */ + displayName: () => LocalizedString + /** + * Enable auto-reply for this conversation + */ + shortDesc: () => LocalizedString + /** + * When set to true, Help Scout will send an auto-reply to the customer if one is configured for the mailbox. Set to false to prevent auto-replies. + */ + longDesc: () => LocalizedString + } + } + } + create_customer: { + groups: { + /** + * Customers + */ + '0': () => LocalizedString + } + /** + * Create Customer + */ + displayName: () => LocalizedString + /** + * Create a new customer + */ + shortDesc: () => LocalizedString + /** + * Create a new customer profile in Help Scout. Customers represent the people who contact your support team. You can store their contact information, company details, and other relevant data. + */ + longDesc: () => LocalizedString + options: { + firstName: { + /** + * First Name + */ + displayName: () => LocalizedString + /** + * The customer first name + */ + shortDesc: () => LocalizedString + /** + * The first name of the customer. Maximum 40 characters. + */ + longDesc: () => LocalizedString + } + lastName: { + /** + * Last Name + */ + displayName: () => LocalizedString + /** + * The customer last name + */ + shortDesc: () => LocalizedString + /** + * The last name of the customer. Maximum 40 characters. + */ + longDesc: () => LocalizedString + } + email: { + /** + * Email + */ + displayName: () => LocalizedString + /** + * The customer email address + */ + shortDesc: () => LocalizedString + /** + * The primary email address for the customer. This is used to identify the customer when they send emails to your support address. + */ + longDesc: () => LocalizedString + } + emailType: { + /** + * Email Type + */ + displayName: () => LocalizedString + /** + * The type of email address + */ + shortDesc: () => LocalizedString + /** + * Categorize the email address type: work (business email), home (personal email), or other. + */ + longDesc: () => LocalizedString + } + phone: { + /** + * Phone + */ + displayName: () => LocalizedString + /** + * The customer phone number + */ + shortDesc: () => LocalizedString + /** + * The phone number for the customer. + */ + longDesc: () => LocalizedString + } + phoneType: { + /** + * Phone Type + */ + displayName: () => LocalizedString + /** + * The type of phone number + */ + shortDesc: () => LocalizedString + /** + * Categorize the phone number type: work, home, mobile, fax, pager, or other. + */ + longDesc: () => LocalizedString + } + jobTitle: { + /** + * Job Title + */ + displayName: () => LocalizedString + /** + * The customer job title + */ + shortDesc: () => LocalizedString + /** + * The job title or position of the customer. Maximum 60 characters. + */ + longDesc: () => LocalizedString + } + organizationId: { + /** + * Organization + */ + displayName: () => LocalizedString + /** + * The customer company or organization + */ + shortDesc: () => LocalizedString + /** + * The company or organization the customer belongs to. + */ + longDesc: () => LocalizedString + } + location: { + /** + * Location + */ + displayName: () => LocalizedString + /** + * The customer location + */ + shortDesc: () => LocalizedString + /** + * The geographic location of the customer. Maximum 60 characters. + */ + longDesc: () => LocalizedString + } + background: { + /** + * Background + */ + displayName: () => LocalizedString + /** + * Background notes about the customer + */ + shortDesc: () => LocalizedString + /** + * Internal notes or background information about the customer. Maximum 200 characters. This is only visible to your team. + */ + longDesc: () => LocalizedString + } + gender: { + /** + * Gender + */ + displayName: () => LocalizedString + /** + * The customer gender + */ + shortDesc: () => LocalizedString + /** + * The gender of the customer: male, female, or unknown. + */ + longDesc: () => LocalizedString + } + age: { + /** + * Age + */ + displayName: () => LocalizedString + /** + * The customer age + */ + shortDesc: () => LocalizedString + /** + * The age of the customer as a string. + */ + longDesc: () => LocalizedString + } + } + } + update_customer: { + groups: { + /** + * Customers + */ + '0': () => LocalizedString + } + /** + * Update Customer + */ + displayName: () => LocalizedString + /** + * Update an existing customer + */ + shortDesc: () => LocalizedString + /** + * Update the profile information of an existing customer in Help Scout. You can modify their name, contact details, organization, and other profile fields. + */ + longDesc: () => LocalizedString + options: { + customerId: { + /** + * Customer + */ + displayName: () => LocalizedString + /** + * The customer to update + */ + shortDesc: () => LocalizedString + /** + * Select the customer whose profile you want to update. + */ + longDesc: () => LocalizedString + } + firstName: { + /** + * First Name + */ + displayName: () => LocalizedString + /** + * The new first name + */ + shortDesc: () => LocalizedString + /** + * Update the first name of the customer. Maximum 40 characters. + */ + longDesc: () => LocalizedString + } + lastName: { + /** + * Last Name + */ + displayName: () => LocalizedString + /** + * The new last name + */ + shortDesc: () => LocalizedString + /** + * Update the last name of the customer. Maximum 40 characters. + */ + longDesc: () => LocalizedString + } + jobTitle: { + /** + * Job Title + */ + displayName: () => LocalizedString + /** + * The new job title + */ + shortDesc: () => LocalizedString + /** + * Update the job title of the customer. Maximum 60 characters. + */ + longDesc: () => LocalizedString + } + organization: { + /** + * Organization + */ + displayName: () => LocalizedString + /** + * The new organization + */ + shortDesc: () => LocalizedString + /** + * Update the company or organization of the customer. + */ + longDesc: () => LocalizedString + } + location: { + /** + * Location + */ + displayName: () => LocalizedString + /** + * The new location + */ + shortDesc: () => LocalizedString + /** + * Update the geographic location of the customer. Maximum 60 characters. + */ + longDesc: () => LocalizedString + } + background: { + /** + * Background + */ + displayName: () => LocalizedString + /** + * The new background notes + */ + shortDesc: () => LocalizedString + /** + * Update the internal background notes about the customer. Maximum 200 characters. + */ + longDesc: () => LocalizedString + } + gender: { + /** + * Gender + */ + displayName: () => LocalizedString + /** + * The new gender + */ + shortDesc: () => LocalizedString + /** + * Update the gender of the customer: male, female, or unknown. + */ + longDesc: () => LocalizedString + } + age: { + /** + * Age + */ + displayName: () => LocalizedString + /** + * The new age + */ + shortDesc: () => LocalizedString + /** + * Update the age of the customer. + */ + longDesc: () => LocalizedString + } + } + } + send_reply: { + groups: { + /** + * Conversations + */ + '0': () => LocalizedString + } + /** + * Send Reply + */ + displayName: () => LocalizedString + /** + * Send a reply to a conversation + */ + shortDesc: () => LocalizedString + /** + * Send a reply to an existing conversation in Help Scout. The reply will be sent to the customer via email. You can optionally CC/BCC additional recipients, save as draft, or change the conversation status. + */ + longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to reply to + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation you want to reply to. + */ + longDesc: () => LocalizedString + } + customerId: { + /** + * Customer + */ + displayName: () => LocalizedString + /** + * The customer being replied to + */ + shortDesc: () => LocalizedString + /** + * Select the customer who will receive this reply. This should match the customer associated with the conversation. + */ + longDesc: () => LocalizedString + } + text: { + /** + * Reply Text + */ + displayName: () => LocalizedString + /** + * The content of the reply + */ + shortDesc: () => LocalizedString + /** + * The text content of the reply message. This can include HTML formatting. The reply will be sent to the customer via email. + */ + longDesc: () => LocalizedString + } + user: { + /** + * User + */ + displayName: () => LocalizedString + /** + * The user sending the reply + */ + shortDesc: () => LocalizedString + /** + * The Help Scout user sending the reply. If not specified, defaults to the authenticated user. + */ + longDesc: () => LocalizedString + } + status: { + /** + * Status + */ + displayName: () => LocalizedString + /** + * Change the conversation status + */ + shortDesc: () => LocalizedString + /** + * Optionally change the conversation status after sending the reply. For example, set to closed after resolving an issue. + */ + longDesc: () => LocalizedString + } + draft: { + /** + * Save as Draft + */ + displayName: () => LocalizedString + /** + * Save the reply as a draft + */ + shortDesc: () => LocalizedString + /** + * When set to true, the reply is saved as a draft and not sent to the customer. You can review and send it later from Help Scout. + */ + longDesc: () => LocalizedString + } + cc: { + /** + * CC + */ + displayName: () => LocalizedString + /** + * Carbon copy email addresses + */ + shortDesc: () => LocalizedString + /** + * A list of email addresses to CC on the reply. These recipients will receive a copy of the email. + */ + longDesc: () => LocalizedString + } + bcc: { + /** + * BCC + */ + displayName: () => LocalizedString + /** + * Blind carbon copy email addresses + */ + shortDesc: () => LocalizedString + /** + * A list of email addresses to BCC on the reply. These recipients will receive a copy of the email without other recipients knowing. + */ + longDesc: () => LocalizedString + } + assignTo: { + /** + * Assign To + */ + displayName: () => LocalizedString + /** + * Assign the conversation after replying + */ + shortDesc: () => LocalizedString + /** + * Optionally assign the conversation to a different Help Scout user after sending the reply. + */ + longDesc: () => LocalizedString + } + } + } + list_customers: { + groups: { + /** + * Customers + */ + '0': () => LocalizedString + } + /** + * List Customers + */ + displayName: () => LocalizedString + /** + * Retrieve a list of customers + */ + shortDesc: () => LocalizedString + /** + * Retrieve a list of customers from Help Scout. You can filter customers by mailbox, name, email, or modification date. Results can be sorted and paginated. + */ + longDesc: () => LocalizedString + options: { + mailbox: { + /** + * Mailbox + */ + displayName: () => LocalizedString + /** + * Filter by mailbox + */ + shortDesc: () => LocalizedString + /** + * Only return customers associated with conversations in this mailbox. + */ + longDesc: () => LocalizedString + } + firstName: { + /** + * First Name + */ + displayName: () => LocalizedString + /** + * Filter by first name + */ + shortDesc: () => LocalizedString + /** + * Only return customers with this first name. + */ + longDesc: () => LocalizedString + } + lastName: { + /** + * Last Name + */ + displayName: () => LocalizedString + /** + * Filter by last name + */ + shortDesc: () => LocalizedString + /** + * Only return customers with this last name. + */ + longDesc: () => LocalizedString + } + email: { + /** + * Email + */ + displayName: () => LocalizedString + /** + * Filter by email address + */ + shortDesc: () => LocalizedString + /** + * Only return customers with this email address. + */ + longDesc: () => LocalizedString + } + modifiedSince: { + /** + * Modified Since + */ + displayName: () => LocalizedString + /** + * Filter by modification date + */ + shortDesc: () => LocalizedString + /** + * Only return customers modified on or after this date. + */ + longDesc: () => LocalizedString + } + sortField: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to sort results by: createdAt, firstName, lastName, or modifiedAt. + */ + longDesc: () => LocalizedString + } + sortOrder: { + /** + * Sort Order + */ + displayName: () => LocalizedString + /** + * Sort order direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results: desc (newest first) or asc (oldest first). + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of customers to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of customer records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + list_conversations: { + groups: { + /** + * Conversations + */ + '0': () => LocalizedString + } + /** + * List Conversations + */ + displayName: () => LocalizedString + /** + * Retrieve a list of conversations + */ + shortDesc: () => LocalizedString + /** + * Retrieve a list of conversations from Help Scout. You can filter by mailbox, status, assignee, tags, and more. Results can be sorted and paginated. + */ + longDesc: () => LocalizedString + options: { + mailbox: { + /** + * Mailbox + */ + displayName: () => LocalizedString + /** + * Filter by mailbox + */ + shortDesc: () => LocalizedString + /** + * Only return conversations from this mailbox. + */ + longDesc: () => LocalizedString + } + status: { + /** + * Status + */ + displayName: () => LocalizedString + /** + * Filter by conversation status + */ + shortDesc: () => LocalizedString + /** + * Only return conversations with this status: all, active, closed, open, pending, or spam. + */ + longDesc: () => LocalizedString + } + assignedTo: { + /** + * Assigned To + */ + displayName: () => LocalizedString + /** + * Filter by assignee + */ + shortDesc: () => LocalizedString + /** + * Only return conversations assigned to this user. + */ + longDesc: () => LocalizedString + } + tag: { + /** + * Tag + */ + displayName: () => LocalizedString + /** + * Filter by tag + */ + shortDesc: () => LocalizedString + /** + * Only return conversations with this tag. You can specify multiple tags separated by commas. + */ + longDesc: () => LocalizedString + } + modifiedSince: { + /** + * Modified Since + */ + displayName: () => LocalizedString + /** + * Filter by modification date + */ + shortDesc: () => LocalizedString + /** + * Only return conversations modified on or after this date. + */ + longDesc: () => LocalizedString + } + sortField: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to sort results by: createdAt, customerEmail, customerName, mailboxid, modifiedAt, number, status, or subject. + */ + longDesc: () => LocalizedString + } + sortOrder: { + /** + * Sort Order + */ + displayName: () => LocalizedString + /** + * Sort order direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results: desc (newest first) or asc (oldest first). + */ + longDesc: () => LocalizedString + } + query: { + /** + * Query + */ + displayName: () => LocalizedString + /** + * Advanced search query + */ + shortDesc: () => LocalizedString + /** + * An advanced search query using Help Scout query syntax. For example: (subject:"billing issue") AND (status:active) + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of conversations to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of conversation records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + find_mailbox: { + groups: { + /** + * Mailboxes + */ + '0': () => LocalizedString + } + /** + * Find Mailbox by Name + */ + displayName: () => LocalizedString + /** + * Find a mailbox by its name + */ + shortDesc: () => LocalizedString + /** + * Search for a mailbox in Help Scout by its name. Returns the mailbox details if found. The search is case-insensitive and supports partial matching. + */ + longDesc: () => LocalizedString + options: { + name: { + /** + * Mailbox Name + */ + displayName: () => LocalizedString + /** + * The name of the mailbox to find + */ + shortDesc: () => LocalizedString + /** + * The name of the mailbox to search for. The search is case-insensitive and will match partial names or slugs. + */ + longDesc: () => LocalizedString + } + } + } + list_users: { + groups: { + /** + * Users + */ + '0': () => LocalizedString + } + /** + * List Users + */ + displayName: () => LocalizedString + /** + * Retrieve a list of Help Scout users + */ + shortDesc: () => LocalizedString + /** + * Retrieve a list of users from your Help Scout account. You can filter users by email address or mailbox. Returns all user types including those who have not yet accepted their invitations. + */ + longDesc: () => LocalizedString + options: { + email: { + /** + * Email + */ + displayName: () => LocalizedString + /** + * Filter by email address + */ + shortDesc: () => LocalizedString + /** + * Only return users with this exact email address. + */ + longDesc: () => LocalizedString + } + mailbox: { + /** + * Mailbox + */ + displayName: () => LocalizedString + /** + * Filter by mailbox + */ + shortDesc: () => LocalizedString + /** + * Only return users associated with this mailbox. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of users to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of user records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + get_company_report: { + groups: { + /** + * Reports */ '0': () => LocalizedString } - } - Brands_DeleteBrands: { /** - * Delete Brand + * Get Company Report */ displayName: () => LocalizedString + /** + * Get company-wide performance report + */ + shortDesc: () => LocalizedString + /** + * Retrieve a company-wide performance report from Help Scout. Includes metrics like customers helped, closed conversations, total replies, and happiness scores. Only available on Plus and Pro plans. + */ + longDesc: () => LocalizedString + options: { + start: { + /** + * Start Date + */ + displayName: () => LocalizedString + /** + * Start of the reporting period + */ + shortDesc: () => LocalizedString + /** + * The start date and time for the reporting period in ISO 8601 format. + */ + longDesc: () => LocalizedString + } + end: { + /** + * End Date + */ + displayName: () => LocalizedString + /** + * End of the reporting period + */ + shortDesc: () => LocalizedString + /** + * The end date and time for the reporting period in ISO 8601 format. + */ + longDesc: () => LocalizedString + } + previousStart: { + /** + * Previous Start + */ + displayName: () => LocalizedString + /** + * Start of the comparison period + */ + shortDesc: () => LocalizedString + /** + * The start date for a previous period to compare against. Used to calculate deltas. + */ + longDesc: () => LocalizedString + } + previousEnd: { + /** + * Previous End + */ + displayName: () => LocalizedString + /** + * End of the comparison period + */ + shortDesc: () => LocalizedString + /** + * The end date for a previous period to compare against. Used to calculate deltas. + */ + longDesc: () => LocalizedString + } + mailboxes: { + /** + * Mailboxes + */ + displayName: () => LocalizedString + /** + * Filter by mailbox IDs + */ + shortDesc: () => LocalizedString + /** + * Comma-separated list of mailbox IDs to filter the report by. + */ + longDesc: () => LocalizedString + } + tags: { + /** + * Tags + */ + displayName: () => LocalizedString + /** + * Filter by tag IDs + */ + shortDesc: () => LocalizedString + /** + * Comma-separated list of tag IDs to filter the report by. + */ + longDesc: () => LocalizedString + } + types: { + /** + * Types + */ + displayName: () => LocalizedString + /** + * Filter by conversation types + */ + shortDesc: () => LocalizedString + /** + * Filter by conversation type: email, chat, or phone. + */ + longDesc: () => LocalizedString + } + folders: { + /** + * Folders + */ + displayName: () => LocalizedString + /** + * Filter by folder IDs + */ + shortDesc: () => LocalizedString + /** + * Comma-separated list of folder IDs to filter the report by. + */ + longDesc: () => LocalizedString + } + } + } + get_email_report: { groups: { /** - * Brands + * Reports */ '0': () => LocalizedString } - } - Envelopes_GetEnvelopes: { /** - * Get Envelopes + * Get Email Report */ displayName: () => LocalizedString + /** + * Get email channel performance report + */ + shortDesc: () => LocalizedString + /** + * Retrieve an email channel performance report from Help Scout. Includes volume metrics, resolution times, response times, and time distribution data. Only available on Plus and Pro plans. + */ + longDesc: () => LocalizedString + options: { + start: { + /** + * Start Date + */ + displayName: () => LocalizedString + /** + * Start of the reporting period + */ + shortDesc: () => LocalizedString + /** + * The start date and time for the reporting period in ISO 8601 format. + */ + longDesc: () => LocalizedString + } + end: { + /** + * End Date + */ + displayName: () => LocalizedString + /** + * End of the reporting period + */ + shortDesc: () => LocalizedString + /** + * The end date and time for the reporting period in ISO 8601 format. + */ + longDesc: () => LocalizedString + } + previousStart: { + /** + * Previous Start + */ + displayName: () => LocalizedString + /** + * Start of the comparison period + */ + shortDesc: () => LocalizedString + /** + * The start date for a previous period to compare against. Used to calculate deltas. + */ + longDesc: () => LocalizedString + } + previousEnd: { + /** + * Previous End + */ + displayName: () => LocalizedString + /** + * End of the comparison period + */ + shortDesc: () => LocalizedString + /** + * The end date for a previous period to compare against. Used to calculate deltas. + */ + longDesc: () => LocalizedString + } + mailboxes: { + /** + * Mailboxes + */ + displayName: () => LocalizedString + /** + * Filter by mailbox IDs + */ + shortDesc: () => LocalizedString + /** + * Comma-separated list of mailbox IDs to filter the report by. + */ + longDesc: () => LocalizedString + } + tags: { + /** + * Tags + */ + displayName: () => LocalizedString + /** + * Filter by tag IDs + */ + shortDesc: () => LocalizedString + /** + * Comma-separated list of tag IDs to filter the report by. + */ + longDesc: () => LocalizedString + } + folders: { + /** + * Folders + */ + displayName: () => LocalizedString + /** + * Filter by folder IDs + */ + shortDesc: () => LocalizedString + /** + * Comma-separated list of folder IDs to filter the report by. + */ + longDesc: () => LocalizedString + } + officeHours: { + /** + * Office Hours + */ + displayName: () => LocalizedString + /** + * Consider office hours in calculations + */ + shortDesc: () => LocalizedString + /** + * When set to true, time-based metrics will only consider office hours. Defaults to false. + */ + longDesc: () => LocalizedString + } + } + } + get_conversation: { groups: { /** - * Envelopes + * Conversations */ '0': () => LocalizedString } - } - Envelopes_PostEnvelopes: { /** - * Create Envelopes + * Get Conversation */ displayName: () => LocalizedString + /** + * Retrieve a single conversation by ID + */ + shortDesc: () => LocalizedString + /** + * Retrieve the full details of a specific conversation from Help Scout by its ID. Returns all conversation data including subject, status, customer information, tags, and custom fields. + */ + longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation you want to retrieve. + */ + longDesc: () => LocalizedString + } + } + } + update_conversation: { groups: { /** - * Envelopes + * Conversations */ '0': () => LocalizedString } - } - Envelopes_GetEnvelope: { /** - * Get Envelope + * Update Conversation */ displayName: () => LocalizedString + /** + * Update an existing conversation + */ + shortDesc: () => LocalizedString + /** + * Update the properties of an existing conversation in Help Scout. You can change the subject, status, or assignee. At least one field must be provided to update. + */ + longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to update + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation you want to update. + */ + longDesc: () => LocalizedString + } + subject: { + /** + * Subject + */ + displayName: () => LocalizedString + /** + * The new subject line + */ + shortDesc: () => LocalizedString + /** + * Update the subject line of the conversation. This will be visible to the customer in email communications. + */ + longDesc: () => LocalizedString + } + status: { + /** + * Status + */ + displayName: () => LocalizedString + /** + * The new conversation status + */ + shortDesc: () => LocalizedString + /** + * Update the status of the conversation. Options include active, closed, or pending. + */ + longDesc: () => LocalizedString + } + assignTo: { + /** + * Assign To + */ + displayName: () => LocalizedString + /** + * Assign to a user + */ + shortDesc: () => LocalizedString + /** + * Assign or reassign the conversation to a specific Help Scout user. + */ + longDesc: () => LocalizedString + } + } + } + delete_conversation: { groups: { /** - * Envelopes + * Conversations */ '0': () => LocalizedString } - } - Envelopes_PutEnvelope: { /** - * Update Envelope + * Delete Conversation */ displayName: () => LocalizedString + /** + * Delete a conversation + */ + shortDesc: () => LocalizedString + /** + * Delete a conversation from Help Scout. This action moves the conversation to the trash. Be cautious as this action may be irreversible depending on your Help Scout settings. + */ + longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to delete + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation you want to delete. + */ + longDesc: () => LocalizedString + } + } + } + add_tags: { groups: { /** - * Envelopes + * Conversations */ '0': () => LocalizedString } - } - Documents_GetDocuments: { /** - * Get Documents + * Add Tags to Conversation */ displayName: () => LocalizedString + /** + * Add tags to a conversation + */ + shortDesc: () => LocalizedString + /** + * Add one or more tags to an existing conversation in Help Scout. Tags help organize and categorize conversations for easier filtering, reporting, and workflow automation. + */ + longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to add tags to + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation you want to add tags to. + */ + longDesc: () => LocalizedString + } + tags: { + /** + * Tags + */ + displayName: () => LocalizedString + /** + * Tags to add + */ + shortDesc: () => LocalizedString + /** + * A list of tag names to add to the conversation. Tags are case-insensitive and will be created if they do not already exist. + */ + longDesc: () => LocalizedString + } + } + } + list_threads: { groups: { /** - * Documents + * Threads */ '0': () => LocalizedString } - } - Documents_PutDocuments: { /** - * Update Documents + * List Threads */ displayName: () => LocalizedString + /** + * List all threads in a conversation + */ + shortDesc: () => LocalizedString + /** + * Retrieve all threads (messages) within a specific conversation. Threads include customer messages, agent replies, notes, and other conversation activities. + */ + longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to list threads from + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation whose threads you want to retrieve. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of threads to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of thread records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + get_thread: { groups: { /** - * Documents + * Threads */ '0': () => LocalizedString } - } - Documents_DeleteDocuments: { /** - * Delete Documents + * Get Thread */ displayName: () => LocalizedString + /** + * Retrieve a specific thread by ID + */ + shortDesc: () => LocalizedString + /** + * Retrieve the full details of a specific thread (message) within a conversation. Returns the thread content, type, status, and metadata. + */ + longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation containing the thread + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation that contains the thread. + */ + longDesc: () => LocalizedString + } + threadId: { + /** + * Thread ID + */ + displayName: () => LocalizedString + /** + * The thread to retrieve + */ + shortDesc: () => LocalizedString + /** + * Enter the ID of the specific thread you want to retrieve. + */ + longDesc: () => LocalizedString + } + } + } + get_customer: { groups: { /** - * Documents + * Customers */ '0': () => LocalizedString } - } - Documents_GetDocument: { /** - * Get Document + * Get Customer */ displayName: () => LocalizedString + /** + * Retrieve a single customer by ID + */ + shortDesc: () => LocalizedString + /** + * Retrieve the full details of a specific customer from Help Scout by their ID. Returns all customer data including contact information, organization, and custom fields. + */ + longDesc: () => LocalizedString + options: { + customerId: { + /** + * Customer + */ + displayName: () => LocalizedString + /** + * The customer to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the customer whose profile you want to retrieve. + */ + longDesc: () => LocalizedString + } + } + } + delete_customer: { groups: { /** - * Documents + * Customers */ '0': () => LocalizedString } - } - Documents_PutDocument: { /** - * Update Document + * Delete Customer */ displayName: () => LocalizedString + /** + * Delete a customer + */ + shortDesc: () => LocalizedString + /** + * Delete a customer profile from Help Scout. Be cautious as this action may affect conversation history and is typically irreversible. + */ + longDesc: () => LocalizedString + options: { + customerId: { + /** + * Customer + */ + displayName: () => LocalizedString + /** + * The customer to delete + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the customer you want to delete. + */ + longDesc: () => LocalizedString + } + } + } + search_customers: { groups: { /** - * Documents + * Customers */ '0': () => LocalizedString } - } - Recipients_GetRecipients: { /** - * Get Recipients + * Search Customers */ displayName: () => LocalizedString + /** + * Search for customers using a query + */ + shortDesc: () => LocalizedString + /** + * Search for customers in Help Scout using a query string. You can search by email, name, phone number, or other customer properties using Help Scout query syntax. + */ + longDesc: () => LocalizedString + options: { + query: { + /** + * Query + */ + displayName: () => LocalizedString + /** + * Search query + */ + shortDesc: () => LocalizedString + /** + * The search query using Help Scout query syntax. Examples: (email:"john@example.com"), (firstName:"John"), (phone:"555-1234"). You can combine multiple conditions with AND/OR operators. + */ + longDesc: () => LocalizedString + } + sortField: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to sort results by: createdAt, firstName, lastName, or modifiedAt. + */ + longDesc: () => LocalizedString + } + sortOrder: { + /** + * Sort Order + */ + displayName: () => LocalizedString + /** + * Sort order direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results: desc (newest first) or asc (oldest first). + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of customers to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of customer records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + list_saved_replies: { groups: { /** - * Recipients + * Saved Replies */ '0': () => LocalizedString } - } - Recipients_PutRecipients: { /** - * Update Recipients + * List Saved Replies */ displayName: () => LocalizedString + /** + * List saved replies for a mailbox + */ + shortDesc: () => LocalizedString + /** + * Retrieve a list of saved reply templates for a specific mailbox. Saved replies are pre-written response templates that agents can use to quickly respond to common questions. + */ + longDesc: () => LocalizedString + options: { + mailboxId: { + /** + * Mailbox + */ + displayName: () => LocalizedString + /** + * The mailbox to list saved replies from + */ + shortDesc: () => LocalizedString + /** + * Select the mailbox whose saved replies you want to retrieve. Saved replies are specific to each mailbox. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of saved replies to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of saved reply records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } + } + } + triggers: { + new_customer: { groups: { /** - * Recipients + * Customers */ '0': () => LocalizedString } - } - Recipients_PostRecipients: { /** - * Add Recipients + * New Customer */ displayName: () => LocalizedString + /** + * Triggers when a new customer is created + */ + shortDesc: () => LocalizedString + /** + * This trigger fires whenever a new customer is created in Help Scout. It provides the full customer profile including contact information, organization, and custom fields. + */ + longDesc: () => LocalizedString + options: { + } + } + updated_customer: { groups: { /** - * Recipients + * Customers */ '0': () => LocalizedString } - } - Recipients_DeleteRecipients: { /** - * Delete Recipients + * Updated Customer */ displayName: () => LocalizedString + /** + * Triggers when a customer is updated + */ + shortDesc: () => LocalizedString + /** + * This trigger fires whenever a customer profile is updated in Help Scout. It provides the updated customer data including any changed fields. + */ + longDesc: () => LocalizedString + options: { + } + } + new_organization: { groups: { /** - * Recipients + * Organizations */ '0': () => LocalizedString } - } - Views_PostEnvelopeRecipientView: { /** - * Create Recipient View + * New Organization */ displayName: () => LocalizedString + /** + * Triggers when a new organization is created + */ + shortDesc: () => LocalizedString + /** + * This trigger fires whenever a new organization is created in Help Scout. Organizations help group customers from the same company. + */ + longDesc: () => LocalizedString + options: { + } + } + new_conversation: { groups: { /** - * Views + * Conversations */ '0': () => LocalizedString } - } - } - triggers: { - envelope_status_updated: { /** - * Envelope Status Updated + * New Conversation */ displayName: () => LocalizedString /** - * Triggers whenever a DocuSign envelope's status or properties are updated, including events like it being sent, delivered, signed, completed, declined, voided, corrected, purged, or deleted. + * Triggers when a new conversation is created */ shortDesc: () => LocalizedString /** - * This trigger activates whenever there’s a change in a DocuSign envelope’s lifecycle. It listens for a variety of updates, such as when an envelope is sent to recipients, delivered, signed, completed, or declined. It also includes administrative events like envelopes being resent, corrected, purged, deleted, discarded, newly created, or removed. By setting up this trigger, you can stay informed of envelope progress and status changes, enabling timely follow-ups, record-keeping, or other automated actions in your workflow. + * This trigger fires whenever a new conversation (support ticket) is created in Help Scout. You can optionally filter by mailbox to only receive events from specific inboxes. */ longDesc: () => LocalizedString options: { - accountId: { + mailboxId: { /** - * Default Account ID + * Mailbox */ displayName: () => LocalizedString /** - * The default account ID set when the connection is authorized + * Filter by mailbox */ shortDesc: () => LocalizedString /** - * The default account ID set when the connection is authorized + * Optionally filter to only trigger for conversations in a specific mailbox. Leave empty to trigger for all mailboxes. */ longDesc: () => LocalizedString } } - event_info: { + } + assigned_conversation: { + groups: { /** - * DocuSign envelope status update event data + * Conversations */ - desc: () => LocalizedString + '0': () => LocalizedString } - } - template_updated: { /** - * Template Updated + * Assigned Conversation */ displayName: () => LocalizedString /** - * Triggers whenever a new DocuSign template is created, updated or deleted, allowing you to take immediate action in response to the new template. + * Triggers when a conversation is assigned */ shortDesc: () => LocalizedString + /** + * This trigger fires whenever a conversation is assigned to a user in Help Scout. This includes both new assignments and reassignments. + */ + longDesc: () => LocalizedString options: { - accountId: { + mailboxId: { /** - * Default Account ID + * Mailbox */ displayName: () => LocalizedString /** - * The default account ID set when the connection is authorized + * Filter by mailbox */ shortDesc: () => LocalizedString /** - * The default account ID set when the connection is authorized + * Optionally filter to only trigger for conversations in a specific mailbox. Leave empty to trigger for all mailboxes. */ longDesc: () => LocalizedString } } - event_info: { - /** - * DocuSign template update event data - */ - desc: () => LocalizedString - } } } } - Zendesk: { + Hubspot: { /** - * Zendesk + * HubSpot */ displayName: () => LocalizedString groups: { /** - * Customer Support & Helpdesk + * CRM & Sales Management */ '0': () => LocalizedString + /** + * Email & Email Marketing + */ + '1': () => LocalizedString } /** - * Collection of actions to interact with the Zendesk API + * Seamlessly connect to the HubSpot API to automate and streamline your CRM processes. */ shortDesc: () => LocalizedString /** - * Collection of actions to interact with the Zendesk API + * The HubSpot integration provides a comprehensive collection of actions and triggers to interact with the HubSpot API. Whether you need to manage companies, contacts, deals, or custom objects, this integration simplifies your workflow automation and CRM management. */ longDesc: () => LocalizedString - expressions: { - '&&': { + actions: { + 'post-crm-v3-objects-companies-batch-upsert_upsert': { /** - * and (&&) + * Create Or Update Companies */ displayName: () => LocalizedString /** - * Returns True if all arguments are True + * Create or update multiple companies */ shortDesc: () => LocalizedString - /** - * Returns `True` if all arguments are `True` with logic short-circuiting - */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Condition - */ - displayName: () => LocalizedString - /** - * Boolean condition to evaluate - */ - shortDesc: () => LocalizedString - /** - * A boolean expression or condition that evaluates to True or False - */ - longDesc: () => LocalizedString - } + groups: { + /** + * Companies + */ + '0': () => LocalizedString } } - '||': { + 'get-crm-v3-objects-contacts': { /** - * or (||) + * List Contacts */ displayName: () => LocalizedString /** - * Returns True if any argument is True + * Retrieve a list of contacts */ shortDesc: () => LocalizedString - /** - * Returns `True` if any argument is `True` with logic short-circuiting - */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Condition - */ - displayName: () => LocalizedString - /** - * Boolean condition to evaluate - */ - shortDesc: () => LocalizedString - /** - * A boolean expression or condition that evaluates to True or False - */ - longDesc: () => LocalizedString - } + groups: { + /** + * Contacts + */ + '0': () => LocalizedString } } - '==': { + 'post-crm-v3-objects-contacts': { /** - * equal (==) + * Create Contact */ displayName: () => LocalizedString /** - * Equality comparison + * Create a new contact */ shortDesc: () => LocalizedString - /** - * Returns `True` if the field value equals the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { + groups: { + /** + * Contacts + */ + '0': () => LocalizedString + } + options: { + associations: { /** - * Value + * HubSpot Associations */ displayName: () => LocalizedString /** - * Value to compare against + * Define relationships between HubSpot objects */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + to: { + /** + * Target Object + */ + displayName: () => LocalizedString + /** + * The HubSpot object to create an association with + */ + shortDesc: () => LocalizedString + /** + * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. + */ + longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Object ID + */ + displayName: () => LocalizedString + /** + * Unique identifier of the target object + */ + shortDesc: () => LocalizedString + /** + * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. + */ + longDesc: () => LocalizedString + } + } + } + } + types: { + /** + * Association Types + */ + displayName: () => LocalizedString + /** + * Types of relationship between objects + */ + shortDesc: () => LocalizedString + /** + * Defines the nature and direction of the relationship between the two HubSpot objects being associated. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + associationTypeId: { + /** + * Association Type ID + */ + displayName: () => LocalizedString + /** + * Numeric identifier of the association type + */ + shortDesc: () => LocalizedString + /** + * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. + */ + longDesc: () => LocalizedString + } + associationCategory: { + /** + * Association Category + */ + displayName: () => LocalizedString + /** + * Category of the association type + */ + shortDesc: () => LocalizedString + /** + * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + } + } } } } - '!=': { + 'post-crm-v3-objects-contacts-search': { /** - * not equal (!=) + * Search Contacts */ displayName: () => LocalizedString /** - * Inequality comparison + * Search for contacts based on specific criteria */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value does not equal the specified value + * Search for contacts based on specific criteria */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } + groups: { + /** + * Contacts + */ + '0': () => LocalizedString } } - '>': { + 'delete-crm-v3-objects-contacts-contactId': { /** - * greater than (>) + * Delete Contact */ displayName: () => LocalizedString /** - * Greater than comparison + * Soft delete a selected contact */ shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is greater than the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } + groups: { + /** + * Contacts + */ + '0': () => LocalizedString } } - '>=': { + 'get-crm-v3-objects-contacts-contactId': { /** - * greater than or equal (>=) + * Retrieve Contact */ displayName: () => LocalizedString /** - * Greater than or equal comparison + * Retrieve a specific contact */ shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is greater than or equal to the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } + groups: { + /** + * Contacts + */ + '0': () => LocalizedString } } - '<': { + 'patch-crm-v3-objects-contacts-contactId': { /** - * less than (<) + * Update Contact */ displayName: () => LocalizedString /** - * Less than comparison + * Update an existing contact */ shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is less than the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } + groups: { + /** + * Contacts + */ + '0': () => LocalizedString } } - '<=': { + 'get-crm-v3-objects-objectType_getPage': { /** - * less than or equal (<=) + * List Custom Objects */ displayName: () => LocalizedString /** - * Less than or equal comparison + * Retrieve a list of selected custom objects */ shortDesc: () => LocalizedString + groups: { + /** + * Custom Objects + */ + '0': () => LocalizedString + } + } + 'post-crm-v3-objects-objectType_create': { /** - * Returns `True` if the field value is less than or equal to the specified value + * Create Custom Object */ - longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { + displayName: () => LocalizedString + /** + * Create a new custom object of a selected type + */ + shortDesc: () => LocalizedString + groups: { + /** + * Custom Objects + */ + '0': () => LocalizedString + } + options: { + associations: { /** - * Value + * HubSpot Associations */ displayName: () => LocalizedString /** - * Value to compare against + * Define relationships between HubSpot objects */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. */ longDesc: () => LocalizedString - } - } - } - } - triggers: { - new_user: { - /** - * New User - */ - displayName: () => LocalizedString - /** - * Triggers when a new user is created - */ - shortDesc: () => LocalizedString - /** - * Triggers when a new user is created - */ - longDesc: () => LocalizedString - event_info: { - /** - * Zendesk User Event Data - */ - desc: () => LocalizedString - type: { - fields: { - account_id: { - /** - * Account ID - */ - displayName: () => LocalizedString - /** - * Account ID - */ - shortDesc: () => LocalizedString - /** - * ID of the associated account - */ - longDesc: () => LocalizedString - } - detail: { - /** - * Detail - */ - displayName: () => LocalizedString - /** - * User details - */ - shortDesc: () => LocalizedString - /** - * Detailed user information - */ - longDesc: () => LocalizedString - type: { - fields: { - created_at: { - /** - * Created At - */ - displayName: () => LocalizedString - /** - * User creation time - */ - shortDesc: () => LocalizedString - /** - * Timestamp of user creation - */ - longDesc: () => LocalizedString - } - default_group_id: { - /** - * Default Group ID - */ - displayName: () => LocalizedString - /** - * Default group ID - */ - shortDesc: () => LocalizedString - /** - * ID of the default group for the user - */ - longDesc: () => LocalizedString - } - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * User email - */ - shortDesc: () => LocalizedString - /** - * Email address of the user - */ - longDesc: () => LocalizedString - } - external_id: { - /** - * External ID - */ - displayName: () => LocalizedString - /** - * User external ID - */ - shortDesc: () => LocalizedString - /** - * External identifier for the user - */ - longDesc: () => LocalizedString - } - id: { - /** - * User ID - */ - displayName: () => LocalizedString - /** - * User ID - */ - shortDesc: () => LocalizedString - /** - * Unique identifier for the user - */ - longDesc: () => LocalizedString - } - organization_id: { - /** - * Organization ID - */ - displayName: () => LocalizedString - /** - * Organization ID - */ - shortDesc: () => LocalizedString - /** - * ID of the organization associated with the user - */ - longDesc: () => LocalizedString - } - role: { - /** - * Role - */ - displayName: () => LocalizedString - /** - * User role - */ - shortDesc: () => LocalizedString - /** - * Role of the user in the system - */ - longDesc: () => LocalizedString + type: { + element_type: { + fields: { + to: { + /** + * Target Object + */ + displayName: () => LocalizedString + /** + * The HubSpot object to create an association with + */ + shortDesc: () => LocalizedString + /** + * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. + */ + longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Object ID + */ + displayName: () => LocalizedString + /** + * Unique identifier of the target object + */ + shortDesc: () => LocalizedString + /** + * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. + */ + longDesc: () => LocalizedString + } + } } - updated_at: { - /** - * Updated At - */ - displayName: () => LocalizedString - /** - * User update time - */ - shortDesc: () => LocalizedString - /** - * Last update timestamp for the user - */ - longDesc: () => LocalizedString + } + types: { + /** + * Association Types + */ + displayName: () => LocalizedString + /** + * Types of relationship between objects + */ + shortDesc: () => LocalizedString + /** + * Defines the nature and direction of the relationship between the two HubSpot objects being associated. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + associationTypeId: { + /** + * Association Type ID + */ + displayName: () => LocalizedString + /** + * Numeric identifier of the association type + */ + shortDesc: () => LocalizedString + /** + * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. + */ + longDesc: () => LocalizedString + } + associationCategory: { + /** + * Association Category + */ + displayName: () => LocalizedString + /** + * Category of the association type + */ + shortDesc: () => LocalizedString + /** + * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. + */ + longDesc: () => LocalizedString + } + } + } } } } } - event: { - /** - * Event - */ - displayName: () => LocalizedString - /** - * Event info - */ - shortDesc: () => LocalizedString - /** - * Additional event information - */ - longDesc: () => LocalizedString - } - id: { - /** - * Event ID - */ - displayName: () => LocalizedString - /** - * Event ID - */ - shortDesc: () => LocalizedString - /** - * Unique identifier for the event - */ - longDesc: () => LocalizedString - } - subject: { - /** - * Subject - */ - displayName: () => LocalizedString - /** - * Event subject - */ - shortDesc: () => LocalizedString - /** - * Subject of the event - */ - longDesc: () => LocalizedString - } - time: { - /** - * Time - */ - displayName: () => LocalizedString - /** - * Event time - */ - shortDesc: () => LocalizedString - /** - * Timestamp of the event occurrence - */ - longDesc: () => LocalizedString - } - type: { - /** - * Event Type - */ - displayName: () => LocalizedString - /** - * Event type - */ - shortDesc: () => LocalizedString - /** - * Type of the event - */ - longDesc: () => LocalizedString - } - zendesk_event_version: { - /** - * Zendesk Event Version - */ - displayName: () => LocalizedString - /** - * Event version - */ - shortDesc: () => LocalizedString - /** - * Version of the Zendesk event format - */ - longDesc: () => LocalizedString - } } } } } - new_ticket: { + 'post-crm-v3-objects-objectType-batch-upsert': { /** - * New Ticket + * Create Or Update Custom Objects */ displayName: () => LocalizedString - /** - * Triggers when a new ticket is created - */ - shortDesc: () => LocalizedString - /** - * Triggers when a new ticket is created - */ - longDesc: () => LocalizedString - event_info: { + groups: { /** - * New Ticket Event Data + * Custom Objects */ - desc: () => LocalizedString - type: { - fields: { - assignee_email: { - /** - * Assignee Email - */ - displayName: () => LocalizedString - /** - * Assignee email - */ - shortDesc: () => LocalizedString - /** - * Email of the assignee - */ - longDesc: () => LocalizedString - } - assignee_name: { - /** - * Assignee Name - */ - displayName: () => LocalizedString - /** - * Assignee name - */ - shortDesc: () => LocalizedString - /** - * Name of the assignee - */ - longDesc: () => LocalizedString - } - group_name: { - /** - * Group Name - */ - displayName: () => LocalizedString - /** - * Group name - */ - shortDesc: () => LocalizedString - /** - * Name of the group handling the ticket - */ - longDesc: () => LocalizedString - } - organization_name: { - /** - * Organization Name - */ - displayName: () => LocalizedString - /** - * Organization name - */ - shortDesc: () => LocalizedString - /** - * Name of the associated organization - */ - longDesc: () => LocalizedString - } - requester_email: { - /** - * Requester Email - */ - displayName: () => LocalizedString - /** - * Requester email - */ - shortDesc: () => LocalizedString - /** - * Email of the requester - */ - longDesc: () => LocalizedString - } - requester_name: { - /** - * Requester Name - */ - displayName: () => LocalizedString - /** - * Requester name - */ - shortDesc: () => LocalizedString - /** - * Name of the requester - */ - longDesc: () => LocalizedString - } - tags: { - /** - * Tags - */ - displayName: () => LocalizedString - /** - * Ticket tags - */ - shortDesc: () => LocalizedString - /** - * Tags associated with the ticket - */ - longDesc: () => LocalizedString - } - ticket_description: { - /** - * Ticket Description - */ - displayName: () => LocalizedString - /** - * Ticket description - */ - shortDesc: () => LocalizedString - /** - * Description of the ticket - */ - longDesc: () => LocalizedString - } - ticket_id: { - /** - * Ticket ID - */ - displayName: () => LocalizedString - /** - * Ticket ID - */ - shortDesc: () => LocalizedString - /** - * Unique identifier for the ticket - */ - longDesc: () => LocalizedString - } - ticket_priority: { - /** - * Ticket Priority - */ - displayName: () => LocalizedString - /** - * Ticket priority - */ - shortDesc: () => LocalizedString - /** - * Priority level of the ticket - */ - longDesc: () => LocalizedString - } - ticket_status: { - /** - * Ticket Status - */ - displayName: () => LocalizedString - /** - * Ticket status - */ - shortDesc: () => LocalizedString - /** - * Current status of the ticket - */ - longDesc: () => LocalizedString - } - ticket_subject: { - /** - * Ticket Subject - */ - displayName: () => LocalizedString - /** - * Ticket subject - */ - shortDesc: () => LocalizedString - /** - * Subject of the ticket - */ - longDesc: () => LocalizedString - } - ticket_type: { - /** - * Ticket Type - */ - displayName: () => LocalizedString - /** - * Ticket type - */ - shortDesc: () => LocalizedString - /** - * Type of the ticket - */ - longDesc: () => LocalizedString - } - ticket_url: { - /** - * Ticket URL - */ - displayName: () => LocalizedString - /** - * Ticket URL - */ - shortDesc: () => LocalizedString - /** - * URL of the ticket in the system - */ - longDesc: () => LocalizedString - } - } - } + '0': () => LocalizedString } } - new_organization: { + 'post-crm-v3-objects-objectType-search_doSearch': { /** - * New Organization + * Search Custom Objects */ displayName: () => LocalizedString /** - * Triggers when a new organization is created + * Search for custom objects based on specific criteria */ shortDesc: () => LocalizedString /** - * Triggers when a new organization is created + * Search for custom objects based on specific criteria */ - longDesc: () => LocalizedString - event_info: { - /** - * Zendesk Organization Event Data - */ - desc: () => LocalizedString - type: { - fields: { - account_id: { - /** - * Account ID - */ - displayName: () => LocalizedString - /** - * Account ID - */ - shortDesc: () => LocalizedString - /** - * ID of the associated account - */ - longDesc: () => LocalizedString - } - detail: { - /** - * Detail - */ - displayName: () => LocalizedString - /** - * Organization details - */ - shortDesc: () => LocalizedString - /** - * Detailed organization information - */ - longDesc: () => LocalizedString - type: { - fields: { - created_at: { - /** - * Created At - */ - displayName: () => LocalizedString - /** - * Organization creation time - */ - shortDesc: () => LocalizedString - /** - * Timestamp of organization creation - */ - longDesc: () => LocalizedString - } - external_id: { - /** - * External ID - */ - displayName: () => LocalizedString - /** - * Organization external ID - */ - shortDesc: () => LocalizedString - /** - * External identifier for the organization - */ - longDesc: () => LocalizedString - } - group_id: { - /** - * Group ID - */ - displayName: () => LocalizedString - /** - * Group ID - */ - shortDesc: () => LocalizedString - /** - * ID of the associated group - */ - longDesc: () => LocalizedString - } - id: { - /** - * Organization ID - */ - displayName: () => LocalizedString - /** - * Organization ID - */ - shortDesc: () => LocalizedString - /** - * Unique identifier for the organization - */ - longDesc: () => LocalizedString - } - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * Organization name - */ - shortDesc: () => LocalizedString - /** - * Name of the organization - */ - longDesc: () => LocalizedString - } - shared_comments: { - /** - * Shared Comments - */ - displayName: () => LocalizedString - /** - * Shared comments - */ - shortDesc: () => LocalizedString - /** - * Indicates if comments are shared - */ - longDesc: () => LocalizedString - } - shared_tickets: { - /** - * Shared Tickets - */ - displayName: () => LocalizedString - /** - * Shared tickets - */ - shortDesc: () => LocalizedString - /** - * Indicates if tickets are shared - */ - longDesc: () => LocalizedString - } - updated_at: { - /** - * Updated At - */ - displayName: () => LocalizedString - /** - * Organization update time - */ - shortDesc: () => LocalizedString - /** - * Last update timestamp for the organization - */ - longDesc: () => LocalizedString - } - } - } - } - event: { - /** - * Event - */ - displayName: () => LocalizedString - /** - * Event info - */ - shortDesc: () => LocalizedString - /** - * Additional event information - */ - longDesc: () => LocalizedString - } - id: { - /** - * Event ID - */ - displayName: () => LocalizedString - /** - * Event ID - */ - shortDesc: () => LocalizedString - /** - * Unique identifier for the event - */ - longDesc: () => LocalizedString - } - subject: { - /** - * Subject - */ - displayName: () => LocalizedString - /** - * Event subject - */ - shortDesc: () => LocalizedString - /** - * Subject of the event - */ - longDesc: () => LocalizedString - } - time: { - /** - * Time - */ - displayName: () => LocalizedString - /** - * Event time - */ - shortDesc: () => LocalizedString - /** - * Timestamp of the event occurrence - */ - longDesc: () => LocalizedString - } - type: { - /** - * Event Type - */ - displayName: () => LocalizedString - /** - * Event type - */ - shortDesc: () => LocalizedString - /** - * Type of the event - */ - longDesc: () => LocalizedString - } - zendesk_event_version: { - /** - * Zendesk Event Version - */ - displayName: () => LocalizedString - /** - * Event version - */ - shortDesc: () => LocalizedString - /** - * Version of the Zendesk event format - */ - longDesc: () => LocalizedString - } - } - } + longDesc: () => LocalizedString + groups: { + /** + * Custom Objects + */ + '0': () => LocalizedString } } - new_custom_object_record: { + 'delete-crm-v3-objects-objectType-objectId_archive': { /** - * New Custom Object Record + * Delete Custom Object */ displayName: () => LocalizedString /** - * Triggers when a new custom object record is created + * Soft delete a selected custom object */ shortDesc: () => LocalizedString + groups: { + /** + * Custom Objects + */ + '0': () => LocalizedString + } + } + 'get-crm-v3-objects-objectType-objectId_getById': { /** - * Triggers when a new custom object record is created in Zendesk + * Retrieve Custom Object */ - longDesc: () => LocalizedString + displayName: () => LocalizedString + /** + * Retrieve a specific custom object + */ + shortDesc: () => LocalizedString + groups: { + /** + * Custom Objects + */ + '0': () => LocalizedString + } + } + 'patch-crm-v3-objects-objectType-objectId_update': { + /** + * Update Custom Object + */ + displayName: () => LocalizedString + /** + * Update an existing custom object + */ + shortDesc: () => LocalizedString + groups: { + /** + * Custom Objects + */ + '0': () => LocalizedString + } + } + 'get-crm-v3-objects-deals_getPage': { + /** + * List Deals + */ + displayName: () => LocalizedString + /** + * Retrieve a list of deals + */ + shortDesc: () => LocalizedString + groups: { + /** + * Deals + */ + '0': () => LocalizedString + } + } + 'post-crm-v3-objects-deals_create': { + /** + * Create Deal + */ + displayName: () => LocalizedString + /** + * Create a new deal + */ + shortDesc: () => LocalizedString + groups: { + /** + * Deals + */ + '0': () => LocalizedString + } options: { - custom_object: { + associations: { /** - * Custom Object + * HubSpot Associations */ displayName: () => LocalizedString /** - * The custom object to monitor for new records + * Define relationships between HubSpot objects */ shortDesc: () => LocalizedString /** - * Select the custom object type to monitor for new records + * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + to: { + /** + * Target Object + */ + displayName: () => LocalizedString + /** + * The HubSpot object to create an association with + */ + shortDesc: () => LocalizedString + /** + * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. + */ + longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Object ID + */ + displayName: () => LocalizedString + /** + * Unique identifier of the target object + */ + shortDesc: () => LocalizedString + /** + * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. + */ + longDesc: () => LocalizedString + } + } + } + } + types: { + /** + * Association Types + */ + displayName: () => LocalizedString + /** + * Types of relationship between objects + */ + shortDesc: () => LocalizedString + /** + * Defines the nature and direction of the relationship between the two HubSpot objects being associated. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + associationTypeId: { + /** + * Association Type ID + */ + displayName: () => LocalizedString + /** + * Numeric identifier of the association type + */ + shortDesc: () => LocalizedString + /** + * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. + */ + longDesc: () => LocalizedString + } + associationCategory: { + /** + * Association Category + */ + displayName: () => LocalizedString + /** + * Category of the association type + */ + shortDesc: () => LocalizedString + /** + * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + } + } } } - event_info: { + } + 'post-crm-v3-objects-deals-batch-upsert_upsert': { + /** + * Create Or Update Deals + */ + displayName: () => LocalizedString + groups: { /** - * Zendesk Custom Object Record Event Data + * Deals */ - desc: () => LocalizedString - type: { - fields: { - id: { - /** - * Record ID - */ - displayName: () => LocalizedString - /** - * Record ID - */ - shortDesc: () => LocalizedString - /** - * Unique identifier for the custom object record - */ - longDesc: () => LocalizedString - } - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * Record name - */ - shortDesc: () => LocalizedString - /** - * The name of the custom object record - */ - longDesc: () => LocalizedString - } - external_id: { - /** - * External ID - */ - displayName: () => LocalizedString - /** - * External ID - */ - shortDesc: () => LocalizedString - /** - * External identifier for the record - */ - longDesc: () => LocalizedString - } - created_at: { - /** - * Created At - */ - displayName: () => LocalizedString - /** - * Record creation time - */ - shortDesc: () => LocalizedString - /** - * Timestamp of record creation - */ - longDesc: () => LocalizedString - } - updated_at: { - /** - * Updated At - */ - displayName: () => LocalizedString - /** - * Record update time - */ - shortDesc: () => LocalizedString - /** - * Last update timestamp for the record - */ - longDesc: () => LocalizedString - } - } - } + '0': () => LocalizedString } } - } - actions: { - ShowAccountSettings: { + 'post-crm-v3-objects-deals-search_doSearch': { + /** + * Search Deals + */ + displayName: () => LocalizedString + /** + * Search for deals based on specific criteria + */ + shortDesc: () => LocalizedString + /** + * Search for deals based on specific criteria + */ + longDesc: () => LocalizedString groups: { /** - * Settings + * Deals */ '0': () => LocalizedString } } - ShowAttachment: { + 'delete-crm-v3-objects-deals-dealId_archive': { + /** + * Delete a Deal + */ + displayName: () => LocalizedString + /** + * Soft delete a selected deal + */ + shortDesc: () => LocalizedString groups: { /** - * Attachments + * Deals */ '0': () => LocalizedString } } - ListGroups: { + 'get-crm-v3-objects-deals-dealId_getById': { + /** + * Retrieve Deal + */ + displayName: () => LocalizedString + /** + * Retrieve a specific deal + */ + shortDesc: () => LocalizedString groups: { /** - * Groups + * Deals */ '0': () => LocalizedString } } - CreateGroup: { + 'patch-crm-v3-objects-deals-dealId_update': { + /** + * Update Deal + */ + displayName: () => LocalizedString + /** + * Update an existing deal + */ + shortDesc: () => LocalizedString groups: { /** - * Groups + * Deals + */ + '0': () => LocalizedString + } + } + 'get-crm-v3-objects-leads_getPage': { + /** + * List Leads + */ + displayName: () => LocalizedString + /** + * Retrieve a list of leads + */ + shortDesc: () => LocalizedString + groups: { + /** + * Leads + */ + '0': () => LocalizedString + } + } + 'post-crm-v3-objects-leads_create': { + /** + * Create Lead + */ + displayName: () => LocalizedString + /** + * Create a new lead + */ + shortDesc: () => LocalizedString + groups: { + /** + * Leads */ '0': () => LocalizedString } options: { - group: { + associations: { /** - * Group + * HubSpot Associations */ displayName: () => LocalizedString /** - * Group + * Define relationships between HubSpot objects */ shortDesc: () => LocalizedString /** - * Group + * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. */ longDesc: () => LocalizedString type: { - fields: { - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * Group name - */ - shortDesc: () => LocalizedString - /** - * Group name - */ - longDesc: () => LocalizedString - } - description: { - /** - * Description - */ - displayName: () => LocalizedString - /** - * Group description - */ - shortDesc: () => LocalizedString - /** - * Group description - */ - longDesc: () => LocalizedString - } - 'default': { - /** - * Default - */ - displayName: () => LocalizedString - /** - * Default group assignment for team members in Zendesk. - */ - shortDesc: () => LocalizedString - /** - * Team members will automatically be assigned to this group when they're added to Zendesk. There can only be one default group. - */ - longDesc: () => LocalizedString - } - is_public: { - /** - * Public - */ - displayName: () => LocalizedString - /** - * Public group visibility - */ - shortDesc: () => LocalizedString - /** - * Indicates if the group should be public. Default is true. - */ - longDesc: () => LocalizedString - } - user_ids: { - /** - * User IDs - */ - displayName: () => LocalizedString - /** - * Users to add to the group - */ - shortDesc: () => LocalizedString - /** - * List of user IDs to be added to the group - */ - longDesc: () => LocalizedString + element_type: { + fields: { + to: { + /** + * Target Object + */ + displayName: () => LocalizedString + /** + * The HubSpot object to create an association with + */ + shortDesc: () => LocalizedString + /** + * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. + */ + longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Object ID + */ + displayName: () => LocalizedString + /** + * Unique identifier of the target object + */ + shortDesc: () => LocalizedString + /** + * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. + */ + longDesc: () => LocalizedString + } + } + } + } + types: { + /** + * Association Types + */ + displayName: () => LocalizedString + /** + * Types of relationship between objects + */ + shortDesc: () => LocalizedString + /** + * Defines the nature and direction of the relationship between the two HubSpot objects being associated. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + associationTypeId: { + /** + * Association Type ID + */ + displayName: () => LocalizedString + /** + * Numeric identifier of the association type + */ + shortDesc: () => LocalizedString + /** + * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. + */ + longDesc: () => LocalizedString + } + associationCategory: { + /** + * Association Category + */ + displayName: () => LocalizedString + /** + * Category of the association type + */ + shortDesc: () => LocalizedString + /** + * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. + */ + longDesc: () => LocalizedString + } + } + } + } + } } } } } } } - DeleteGroup: { + 'post-crm-v3-objects-leads-batch-upsert_upsert': { + /** + * Create Or Update Leads + */ + displayName: () => LocalizedString groups: { /** - * Groups + * Leads */ '0': () => LocalizedString } } - ShowGroupById: { + 'post-crm-v3-objects-leads-search_doSearch': { + /** + * Search Leads + */ + displayName: () => LocalizedString + /** + * Search for leads based on specific criteria + */ + shortDesc: () => LocalizedString + /** + * Search for leads based on specific criteria + */ + longDesc: () => LocalizedString groups: { /** - * Groups + * Leads */ '0': () => LocalizedString } } - UpdateGroup: { + 'delete-crm-v3-objects-leads-leadsId_archive': { + /** + * Delete Lead + */ + displayName: () => LocalizedString + /** + * Soft delete a selected lead + */ + shortDesc: () => LocalizedString groups: { /** - * Groups + * Leads + */ + '0': () => LocalizedString + } + } + 'get-crm-v3-objects-leads-leadsId_getById': { + /** + * Retrieve Lead + */ + displayName: () => LocalizedString + /** + * Retrieve a specific lead + */ + shortDesc: () => LocalizedString + groups: { + /** + * Leads + */ + '0': () => LocalizedString + } + } + 'patch-crm-v3-objects-leads-leadsId_update': { + /** + * Update Lead + */ + displayName: () => LocalizedString + /** + * Update an existing lead + */ + shortDesc: () => LocalizedString + groups: { + /** + * Leads + */ + '0': () => LocalizedString + } + } + 'get-crm-v3-objects-products_getPage': { + /** + * List Products + */ + displayName: () => LocalizedString + /** + * Retrieve a list of products + */ + shortDesc: () => LocalizedString + groups: { + /** + * Products + */ + '0': () => LocalizedString + } + } + 'post-crm-v3-objects-products_create': { + /** + * Create Product + */ + displayName: () => LocalizedString + /** + * Create a new product + */ + shortDesc: () => LocalizedString + groups: { + /** + * Products */ '0': () => LocalizedString } options: { - group_id: { - /** - * Group ID - */ - displayName: () => LocalizedString - /** - * Group ID - */ - shortDesc: () => LocalizedString - /** - * Group ID - */ - longDesc: () => LocalizedString - } - group: { + associations: { /** - * Group + * HubSpot Associations */ displayName: () => LocalizedString /** - * Group information + * Define relationships between HubSpot objects */ shortDesc: () => LocalizedString /** - * Details about the group settings in Zendesk + * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. */ longDesc: () => LocalizedString type: { - fields: { - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * Group name - */ - shortDesc: () => LocalizedString - /** - * The name of the group - */ - longDesc: () => LocalizedString - } - description: { - /** - * Description - */ - displayName: () => LocalizedString - /** - * Group description - */ - shortDesc: () => LocalizedString - /** - * A description of the group - */ - longDesc: () => LocalizedString - } - 'default': { - /** - * Default - */ - displayName: () => LocalizedString - /** - * Default group assignment - */ - shortDesc: () => LocalizedString - /** - * Team members will automatically be assigned to this group when they're added to Zendesk. There can only be one default group. - */ - longDesc: () => LocalizedString - } - is_public: { - /** - * Public - */ - displayName: () => LocalizedString - /** - * Public group visibility - */ - shortDesc: () => LocalizedString - /** - * Indicates whether the group should be public. Default is true. - */ - longDesc: () => LocalizedString - } - user_ids: { - /** - * User IDs - */ - displayName: () => LocalizedString - /** - * List of user IDs - */ - shortDesc: () => LocalizedString - /** - * The IDs of users to be added to the group - */ - longDesc: () => LocalizedString + element_type: { + fields: { + to: { + /** + * Target Object + */ + displayName: () => LocalizedString + /** + * The HubSpot object to create an association with + */ + shortDesc: () => LocalizedString + /** + * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. + */ + longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Object ID + */ + displayName: () => LocalizedString + /** + * Unique identifier of the target object + */ + shortDesc: () => LocalizedString + /** + * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. + */ + longDesc: () => LocalizedString + } + } + } + } + types: { + /** + * Association Types + */ + displayName: () => LocalizedString + /** + * Types of relationship between objects + */ + shortDesc: () => LocalizedString + /** + * Defines the nature and direction of the relationship between the two HubSpot objects being associated. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + associationTypeId: { + /** + * Association Type ID + */ + displayName: () => LocalizedString + /** + * Numeric identifier of the association type + */ + shortDesc: () => LocalizedString + /** + * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. + */ + longDesc: () => LocalizedString + } + associationCategory: { + /** + * Association Category + */ + displayName: () => LocalizedString + /** + * Category of the association type + */ + shortDesc: () => LocalizedString + /** + * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. + */ + longDesc: () => LocalizedString + } + } + } + } + } } } } } } } - ListOrganizations: { + 'post-crm-v3-objects-products-batch-upsert_upsert': { + /** + * Create Or Update Products + */ + displayName: () => LocalizedString groups: { /** - * Organizations + * Products */ '0': () => LocalizedString } } - CreateOrganization: { + 'post-crm-v3-objects-products-search_doSearch': { + /** + * Search Products + */ + displayName: () => LocalizedString + /** + * Search for products based on specific criteria + */ + shortDesc: () => LocalizedString + /** + * Search for products based on specific criteria + */ + longDesc: () => LocalizedString groups: { /** - * Organizations + * Products */ '0': () => LocalizedString } } - DeleteOrganization: { + 'delete-crm-v3-objects-products-productId_archive': { + /** + * Delete Product + */ + displayName: () => LocalizedString + /** + * Soft delete a selected product + */ + shortDesc: () => LocalizedString groups: { /** - * Organizations + * Products */ '0': () => LocalizedString } } - ShowOrganization: { + 'get-crm-v3-objects-products-productId_getById': { + /** + * Retrieve Product + */ + displayName: () => LocalizedString + /** + * Retrieve a specific product + */ + shortDesc: () => LocalizedString groups: { /** - * Organizations + * Products */ '0': () => LocalizedString } } - UpdateOrganization: { + 'patch-crm-v3-objects-products-productId_update': { + /** + * Update Product + */ + displayName: () => LocalizedString + /** + * Update an existing product + */ + shortDesc: () => LocalizedString groups: { /** - * Organizations + * Products + */ + '0': () => LocalizedString + } + } + 'get-crm-v3-objects-tickets_getPage': { + /** + * List Tickets + */ + displayName: () => LocalizedString + /** + * Retrieve a list of tickets + */ + shortDesc: () => LocalizedString + groups: { + /** + * Tickets + */ + '0': () => LocalizedString + } + } + 'post-crm-v3-objects-tickets_create': { + /** + * Create Ticket + */ + displayName: () => LocalizedString + /** + * Create a new ticket + */ + shortDesc: () => LocalizedString + groups: { + /** + * Tickets */ '0': () => LocalizedString } options: { - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * Organization name - */ - shortDesc: () => LocalizedString - /** - * Organization name - */ - longDesc: () => LocalizedString - } - group_id: { - /** - * Group ID - */ - displayName: () => LocalizedString - /** - * Group ID - */ - shortDesc: () => LocalizedString - /** - * Group ID - */ - longDesc: () => LocalizedString - } - notes: { - /** - * Notes - */ - displayName: () => LocalizedString - /** - * Notes about the organization - */ - shortDesc: () => LocalizedString - /** - * Notes about the organization - */ - longDesc: () => LocalizedString - } - details: { + associations: { /** - * Details + * HubSpot Associations */ displayName: () => LocalizedString /** - * Details + * Define relationships between HubSpot objects */ shortDesc: () => LocalizedString /** - * Details + * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + to: { + /** + * Target Object + */ + displayName: () => LocalizedString + /** + * The HubSpot object to create an association with + */ + shortDesc: () => LocalizedString + /** + * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. + */ + longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Object ID + */ + displayName: () => LocalizedString + /** + * Unique identifier of the target object + */ + shortDesc: () => LocalizedString + /** + * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. + */ + longDesc: () => LocalizedString + } + } + } + } + types: { + /** + * Association Types + */ + displayName: () => LocalizedString + /** + * Types of relationship between objects + */ + shortDesc: () => LocalizedString + /** + * Defines the nature and direction of the relationship between the two HubSpot objects being associated. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + associationTypeId: { + /** + * Association Type ID + */ + displayName: () => LocalizedString + /** + * Numeric identifier of the association type + */ + shortDesc: () => LocalizedString + /** + * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. + */ + longDesc: () => LocalizedString + } + associationCategory: { + /** + * Association Category + */ + displayName: () => LocalizedString + /** + * Category of the association type + */ + shortDesc: () => LocalizedString + /** + * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + } + } } } } - ListSearchResults: { - groups: { - /** - * Search - */ - '0': () => LocalizedString - } - } - ListTickets: { + 'post-crm-v3-objects-tickets-batch-upsert_upsert': { + /** + * Create Or Update Tickets + */ + displayName: () => LocalizedString groups: { /** * Tickets @@ -210606,7 +216865,19 @@ export type TranslationFunctions = { '0': () => LocalizedString } } - CreateTicket: { + 'post-crm-v3-objects-tickets-search_doSearch': { + /** + * Search Tickets + */ + displayName: () => LocalizedString + /** + * Search for tickets based on specific criteria + */ + shortDesc: () => LocalizedString + /** + * Search for tickets based on specific criteria + */ + longDesc: () => LocalizedString groups: { /** * Tickets @@ -210614,7 +216885,15 @@ export type TranslationFunctions = { '0': () => LocalizedString } } - CountTickets: { + 'delete-crm-v3-objects-tickets-ticketId_archive': { + /** + * Delete Ticket + */ + displayName: () => LocalizedString + /** + * Soft delete a selected ticket + */ + shortDesc: () => LocalizedString groups: { /** * Tickets @@ -210622,7 +216901,15 @@ export type TranslationFunctions = { '0': () => LocalizedString } } - DeleteTicket: { + 'get-crm-v3-objects-tickets-ticketId_getById': { + /** + * Retrieve Ticket + */ + displayName: () => LocalizedString + /** + * Retrieve a specific ticket + */ + shortDesc: () => LocalizedString groups: { /** * Tickets @@ -210630,7 +216917,15 @@ export type TranslationFunctions = { '0': () => LocalizedString } } - ShowTicket: { + 'patch-crm-v3-objects-tickets-ticketId_update': { + /** + * Update Ticket + */ + displayName: () => LocalizedString + /** + * Update an existing ticket + */ + shortDesc: () => LocalizedString groups: { /** * Tickets @@ -210638,39 +216933,79 @@ export type TranslationFunctions = { '0': () => LocalizedString } } - UpdateTicket: { + 'get-crm-v3-objects-users': { + /** + * List Users + */ + displayName: () => LocalizedString + /** + * Retrieve a list of users + */ + shortDesc: () => LocalizedString groups: { /** - * Tickets + * Users */ '0': () => LocalizedString } } - ListTicketMetrics: { + 'post-crm-v3-objects-users-batch-upsert': { + /** + * Create Or Update Users + */ + displayName: () => LocalizedString groups: { /** - * Ticket Metrics + * Users */ '0': () => LocalizedString } } - ShowTicketMetrics: { + 'post-crm-v3-objects-users-search': { + /** + * Search Users + */ + displayName: () => LocalizedString + /** + * Search for users based on specific criteria + */ + shortDesc: () => LocalizedString + /** + * Search for users based on specific criteria + */ + longDesc: () => LocalizedString groups: { /** - * Ticket Metrics + * Users */ '0': () => LocalizedString } } - DeleteUpload: { + 'get-crm-v3-objects-users-userId': { + /** + * Retrieve User + */ + displayName: () => LocalizedString + /** + * Retrieve a specific user + */ + shortDesc: () => LocalizedString groups: { /** - * Uploads + * Users */ '0': () => LocalizedString } } - ListUsers: { + 'patch-crm-v3-objects-users-userId': { + /** + * Update User + */ + displayName: () => LocalizedString + /** + * Update an existing user + */ + shortDesc: () => LocalizedString groups: { /** * Users @@ -210678,2239 +217013,2119 @@ export type TranslationFunctions = { '0': () => LocalizedString } } - CreateUser: { + create_list: { + /** + * Create List + */ + displayName: () => LocalizedString + /** + * Create a new HubSpot list + */ + shortDesc: () => LocalizedString + /** + * Creates a new list in HubSpot CRM with the specified configuration and properties. + */ + longDesc: () => LocalizedString groups: { /** - * Users + * Lists */ '0': () => LocalizedString } - options: { - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * User information - */ - shortDesc: () => LocalizedString - /** - * Details about the user in Zendesk - */ - longDesc: () => LocalizedString - type: { - fields: { - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * User's name - */ - shortDesc: () => LocalizedString - /** - * The full name of the user - */ - longDesc: () => LocalizedString - } - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * User's email address - */ - shortDesc: () => LocalizedString - /** - * The email address associated with the user - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone - */ - displayName: () => LocalizedString - /** - * User's phone number - */ - shortDesc: () => LocalizedString - /** - * The phone number associated with the user - */ - longDesc: () => LocalizedString - } - notes: { - /** - * Notes - */ - displayName: () => LocalizedString - /** - * User notes - */ - shortDesc: () => LocalizedString - /** - * Additional notes or comments about the user - */ - longDesc: () => LocalizedString - } - details: { - /** - * Details - */ - displayName: () => LocalizedString - /** - * Additional details - */ - shortDesc: () => LocalizedString - /** - * Detailed information about the user - */ - longDesc: () => LocalizedString - } - role: { - /** - * Role - */ - displayName: () => LocalizedString - /** - * User role - */ - shortDesc: () => LocalizedString - /** - * The role assigned to the user in the system - */ - longDesc: () => LocalizedString - } - organization_ids: { - /** - * Organization IDs - */ - displayName: () => LocalizedString - /** - * List of organization IDs - */ - shortDesc: () => LocalizedString - /** - * The IDs of the organizations the user is associated with - */ - longDesc: () => LocalizedString - } - } - } - } - } } - DeleteUser: { + search_lists: { + /** + * Search Lists + */ + displayName: () => LocalizedString + /** + * Search for HubSpot lists + */ + shortDesc: () => LocalizedString + /** + * Search and retrieve HubSpot lists based on specified criteria and filters. + */ + longDesc: () => LocalizedString groups: { /** - * Users + * Lists */ '0': () => LocalizedString } } - ShowUser: { + delete_list: { + /** + * Delete List + */ + displayName: () => LocalizedString + /** + * Delete a HubSpot list + */ + shortDesc: () => LocalizedString + /** + * Permanently removes a specified list from HubSpot CRM by its ID. + */ + longDesc: () => LocalizedString groups: { /** - * Users + * Lists */ '0': () => LocalizedString } } - UpdateUser: { + get_list: { + /** + * Get List + */ + displayName: () => LocalizedString + /** + * Retrieve a HubSpot list by ID + */ + shortDesc: () => LocalizedString + /** + * Fetches detailed information about a specific HubSpot list using its unique identifier. + */ + longDesc: () => LocalizedString groups: { /** - * Users + * Lists */ '0': () => LocalizedString } - options: { - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * User information - */ - shortDesc: () => LocalizedString - /** - * Details about the user in the Zendesk system - */ - longDesc: () => LocalizedString - type: { - fields: { - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * User's name - */ - shortDesc: () => LocalizedString - /** - * The full name of the user - */ - longDesc: () => LocalizedString - } - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * User's email address - */ - shortDesc: () => LocalizedString - /** - * The email address associated with the user - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone - */ - displayName: () => LocalizedString - /** - * User's phone number - */ - shortDesc: () => LocalizedString - /** - * The phone number associated with the user - */ - longDesc: () => LocalizedString - } - notes: { - /** - * Notes - */ - displayName: () => LocalizedString - /** - * User notes - */ - shortDesc: () => LocalizedString - /** - * Additional notes or comments about the user - */ - longDesc: () => LocalizedString - } - details: { - /** - * Details - */ - displayName: () => LocalizedString - /** - * Additional details - */ - shortDesc: () => LocalizedString - /** - * Additional detailed information about the user - */ - longDesc: () => LocalizedString - } - role: { - /** - * Role - */ - displayName: () => LocalizedString - /** - * User role - */ - shortDesc: () => LocalizedString - /** - * The role assigned to the user within the system - */ - longDesc: () => LocalizedString - } - organization_ids: { - /** - * Organization IDs - */ - displayName: () => LocalizedString - /** - * List of organization IDs - */ - shortDesc: () => LocalizedString - /** - * The IDs of the organizations the user is associated with - */ - longDesc: () => LocalizedString - } - } - } - } - } } - } - searchOptions: { - orderBy: { + add_memberships: { /** - * Order By + * Add List Records */ displayName: () => LocalizedString /** - * Sort results by a specific field + * Add records to a HubSpot list */ shortDesc: () => LocalizedString /** - * Define the field and direction to sort search results + * Adds specified records as members to an existing HubSpot list. */ longDesc: () => LocalizedString - type: { - fields: { - column: { - /** - * Column - */ - displayName: () => LocalizedString - /** - * The column to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the column to use for sorting results - */ - longDesc: () => LocalizedString - } - ascending: { - /** - * Ascending - */ - displayName: () => LocalizedString - /** - * Sort in ascending order - */ - shortDesc: () => LocalizedString - /** - * When enabled, results are sorted in ascending order (A-Z, 0-9) - */ - longDesc: () => LocalizedString - } - } + groups: { + /** + * Lists + */ + '0': () => LocalizedString } } - limit: { + add_members_from_source_list: { /** - * Limit + * Add Records from another list */ displayName: () => LocalizedString /** - * Maximum number of records to return + * Copy all members from one list to another */ shortDesc: () => LocalizedString /** - * The maximum number of records to return. + * Adds all members from a source HubSpot list to a target list, effectively copying the membership. */ longDesc: () => LocalizedString - } - } - } - HelpScout: { - /** - * Help Scout - */ - displayName: () => LocalizedString - groups: { - /** - * Customer Support & Helpdesk - */ - '0': () => LocalizedString - } - connectionMessage: { - /** - * OAuth Connection - */ - title: () => LocalizedString - /** - * Help Scout uses OAuth 2.0 for authentication. You will be redirected to Help Scout to authorize access to your account. - */ - content: () => LocalizedString - } - /** - * Connect with Help Scout to manage customer conversations and support tickets - */ - shortDesc: () => LocalizedString - /** - * Integrate with Help Scout to manage customer support conversations, create and update customers, send replies, and track support interactions. This integration enables you to automate support workflows, respond to customers, and maintain customer relationships through Help Scout. - */ - longDesc: () => LocalizedString - actions: { - add_note: { groups: { /** - * Conversations + * Lists */ '0': () => LocalizedString } + } + remove_members_from_list: { /** - * Add Note to Conversation + * Remove List Records */ displayName: () => LocalizedString /** - * Add an internal note to a conversation + * Remove records from a HubSpot list */ shortDesc: () => LocalizedString /** - * Add an internal note to an existing conversation in Help Scout. Notes are only visible to your team members and are not sent to the customer. Use notes to document internal discussions, research, or context about a customer issue. + * Removes specified records from an existing HubSpot list membership. */ longDesc: () => LocalizedString - options: { - conversationId: { - /** - * Conversation - */ - displayName: () => LocalizedString - /** - * The conversation to add the note to - */ - shortDesc: () => LocalizedString - /** - * Select or enter the ID of the conversation where you want to add the note. You can search for conversations by number or subject. - */ - longDesc: () => LocalizedString - } - text: { - /** - * Note Text - */ - displayName: () => LocalizedString - /** - * The content of the note - */ - shortDesc: () => LocalizedString - /** - * The text content of the internal note. This can include HTML formatting. The note will only be visible to your team members. - */ - longDesc: () => LocalizedString - } - user: { - /** - * User - */ - displayName: () => LocalizedString - /** - * The user adding the note - */ - shortDesc: () => LocalizedString - /** - * The Help Scout user who is adding the note. If not specified, defaults to the authenticated user. - */ - longDesc: () => LocalizedString - } - status: { - /** - * Status - */ - displayName: () => LocalizedString - /** - * Change the conversation status - */ - shortDesc: () => LocalizedString - /** - * Optionally change the conversation status when adding the note. Options include active, closed, open, pending, or spam. - */ - longDesc: () => LocalizedString - } - } - } - create_conversation: { groups: { /** - * Conversations + * Lists */ '0': () => LocalizedString } + } + get_list_records: { /** - * Create Conversation + * Get List Records */ displayName: () => LocalizedString /** - * Create a new conversation + * Retrieve records from a HubSpot list with pagination and property filtering. */ shortDesc: () => LocalizedString /** - * Create a new conversation in Help Scout. A conversation represents an email thread or support ticket with a customer. You must specify the mailbox, customer, and initial message content. + * Fetches records from a specified HubSpot list, including support for pagination using before/after cursors and filtering by specific properties. Returns the actual record data along with pagination metadata. */ longDesc: () => LocalizedString + groups: { + /** + * Lists + */ + '0': () => LocalizedString + } options: { - subject: { - /** - * Subject - */ - displayName: () => LocalizedString - /** - * The conversation subject line - */ - shortDesc: () => LocalizedString - /** - * The subject line for the conversation. This will be visible to the customer in email communications. - */ - longDesc: () => LocalizedString - } - mailboxId: { - /** - * Mailbox - */ - displayName: () => LocalizedString - /** - * The mailbox to create the conversation in - */ - shortDesc: () => LocalizedString - /** - * Select the Help Scout mailbox (inbox) where this conversation should be created. Each mailbox typically corresponds to a different support email address or team. - */ - longDesc: () => LocalizedString - } - type: { - /** - * Type - */ - displayName: () => LocalizedString - /** - * The conversation type - */ - shortDesc: () => LocalizedString - /** - * The type of conversation: email (standard email thread), phone (phone call record), or chat (live chat conversation). - */ - longDesc: () => LocalizedString - } - status: { - /** - * Status - */ - displayName: () => LocalizedString - /** - * The initial conversation status - */ - shortDesc: () => LocalizedString - /** - * The initial status of the conversation. Active means the conversation needs attention, closed means it is resolved, and pending means waiting for customer response. - */ - longDesc: () => LocalizedString - } - customerId: { - /** - * Customer ID - */ - displayName: () => LocalizedString - /** - * The ID of an existing customer - */ - shortDesc: () => LocalizedString - /** - * Select an existing customer from Help Scout. Either Customer ID or Customer Email must be provided. - */ - longDesc: () => LocalizedString - } - customerEmail: { - /** - * Customer Email - */ - displayName: () => LocalizedString - /** - * The email address of the customer - */ - shortDesc: () => LocalizedString - /** - * The email address of the customer. If the customer does not exist, they will be created. Either Customer ID or Customer Email must be provided. - */ - longDesc: () => LocalizedString - } - threadType: { + listId: { /** - * Thread Type + * List ID */ displayName: () => LocalizedString /** - * The type of the initial thread + * The HubSpot list to retrieve records from */ shortDesc: () => LocalizedString /** - * The type of the first message in the conversation. Customer means the message is from the customer, reply means it is from your team, and note is an internal note. + * The unique identifier of the HubSpot list to fetch records from. */ longDesc: () => LocalizedString } - threadText: { + after: { /** - * Thread Text + * After */ displayName: () => LocalizedString /** - * The content of the initial message + * Pagination cursor for next page */ shortDesc: () => LocalizedString /** - * The text content of the first message in the conversation. This can include HTML formatting. + * Cursor value to retrieve records after this point. Used for forward pagination. */ longDesc: () => LocalizedString } - assignTo: { + before: { /** - * Assign To + * Before */ displayName: () => LocalizedString /** - * Assign the conversation to a user + * Pagination cursor for previous page */ shortDesc: () => LocalizedString /** - * Optionally assign the conversation to a specific Help Scout user. If not specified, the conversation will be unassigned or follow your mailbox routing rules. + * Cursor value to retrieve records before this point. Used for backward pagination. */ longDesc: () => LocalizedString } - tags: { + limit: { /** - * Tags + * Limit */ displayName: () => LocalizedString /** - * Tags to add to the conversation + * Maximum number of records to return */ shortDesc: () => LocalizedString /** - * A list of tag names to add to the conversation. Tags help organize and categorize conversations for easier filtering and reporting. + * The maximum number of records to return in a single request. Default is 100. */ longDesc: () => LocalizedString } - autoReply: { + properties: { /** - * Auto Reply + * Properties */ displayName: () => LocalizedString /** - * Enable auto-reply for this conversation + * List of properties to include */ shortDesc: () => LocalizedString /** - * When set to true, Help Scout will send an auto-reply to the customer if one is configured for the mailbox. Set to false to prevent auto-replies. + * Specific properties to include in the response for each record. If not specified, default properties will be returned. */ longDesc: () => LocalizedString } } } - create_customer: { - groups: { + } + triggers: { + hubspot_company_created_or_updated_trigger: { + event_info: { /** - * Customers + * Company Information */ - '0': () => LocalizedString + desc: () => LocalizedString } /** - * Create Customer + * Company Created or Updated */ displayName: () => LocalizedString /** - * Create a new customer + * Triggers when a company is added or updated in HubSpot. */ shortDesc: () => LocalizedString /** - * Create a new customer profile in Help Scout. Customers represent the people who contact your support team. You can store their contact information, company details, and other relevant data. + * This trigger activates whenever a company record is created or modified in HubSpot, enabling you to automate workflows based on company data changes. */ longDesc: () => LocalizedString options: { - firstName: { - /** - * First Name - */ - displayName: () => LocalizedString - /** - * The customer first name - */ - shortDesc: () => LocalizedString - /** - * The first name of the customer. Maximum 40 characters. - */ - longDesc: () => LocalizedString - } - lastName: { - /** - * Last Name - */ - displayName: () => LocalizedString - /** - * The customer last name - */ - shortDesc: () => LocalizedString - /** - * The last name of the customer. Maximum 40 characters. - */ - longDesc: () => LocalizedString - } - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * The customer email address - */ - shortDesc: () => LocalizedString - /** - * The primary email address for the customer. This is used to identify the customer when they send emails to your support address. - */ - longDesc: () => LocalizedString - } - emailType: { - /** - * Email Type - */ - displayName: () => LocalizedString - /** - * The type of email address - */ - shortDesc: () => LocalizedString - /** - * Categorize the email address type: work (business email), home (personal email), or other. - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone - */ - displayName: () => LocalizedString - /** - * The customer phone number - */ - shortDesc: () => LocalizedString - /** - * The phone number for the customer. - */ - longDesc: () => LocalizedString - } - phoneType: { - /** - * Phone Type - */ - displayName: () => LocalizedString - /** - * The type of phone number - */ - shortDesc: () => LocalizedString - /** - * Categorize the phone number type: work, home, mobile, fax, pager, or other. - */ - longDesc: () => LocalizedString - } - jobTitle: { - /** - * Job Title - */ - displayName: () => LocalizedString - /** - * The customer job title - */ - shortDesc: () => LocalizedString - /** - * The job title or position of the customer. Maximum 60 characters. - */ - longDesc: () => LocalizedString - } - organizationId: { - /** - * Organization - */ - displayName: () => LocalizedString - /** - * The customer company or organization - */ - shortDesc: () => LocalizedString - /** - * The company or organization the customer belongs to. - */ - longDesc: () => LocalizedString - } - location: { + activationCriteria: { /** - * Location + * Activation Criteria */ displayName: () => LocalizedString /** - * The customer location + * Criteria for trigger to activate (created or updated) */ shortDesc: () => LocalizedString /** - * The geographic location of the customer. Maximum 60 characters. + * Select the criteria for the trigger to activate. + + - Created: Triggers when a new object is created + - Updated: Triggers when an existing object is updated */ longDesc: () => LocalizedString } - background: { + additionalProperties: { /** - * Background + * Additional Properties */ displayName: () => LocalizedString /** - * Background notes about the customer + * Additional properties to add to returned data */ shortDesc: () => LocalizedString /** - * Internal notes or background information about the customer. Maximum 200 characters. This is only visible to your team. + * Select additional properties to add to the returned object data */ longDesc: () => LocalizedString } - gender: { + } + } + hubspot_contact_created_or_updated_trigger: { + event_info: { + /** + * Contact Information + */ + desc: () => LocalizedString + } + /** + * Contact Created or Updated + */ + displayName: () => LocalizedString + /** + * Triggers when a contact is added or updated in HubSpot. + */ + shortDesc: () => LocalizedString + /** + * Activate workflows whenever a new contact is created or an existing contact is updated within HubSpot. Ideal for managing customer information efficiently. + */ + longDesc: () => LocalizedString + options: { + activationCriteria: { /** - * Gender + * Activation Criteria */ displayName: () => LocalizedString /** - * The customer gender + * Criteria for trigger to activate (created or updated) */ shortDesc: () => LocalizedString /** - * The gender of the customer: male, female, or unknown. + * Select the criteria for the trigger to activate. + + - Created: Triggers when a new object is created + - Updated: Triggers when an existing object is updated */ longDesc: () => LocalizedString } - age: { + additionalProperties: { /** - * Age + * Additional Properties */ displayName: () => LocalizedString /** - * The customer age + * Additional properties to add to returned data */ shortDesc: () => LocalizedString /** - * The age of the customer as a string. + * Select additional properties to add to the returned object data */ longDesc: () => LocalizedString } } } - update_customer: { - groups: { + hubspot_custom_object_created_or_updated_trigger: { + event_info: { /** - * Customers + * Custom Object Information */ - '0': () => LocalizedString + desc: () => LocalizedString } /** - * Update Customer + * Custom Object Created or Updated */ displayName: () => LocalizedString /** - * Update an existing customer + * Triggers when a custom object is added or updated in HubSpot. */ shortDesc: () => LocalizedString /** - * Update the profile information of an existing customer in Help Scout. You can modify their name, contact details, organization, and other profile fields. + * Use this trigger to capture changes to custom objects in HubSpot, ensuring that updates to custom data structures are processed immediately for automation or integration. */ longDesc: () => LocalizedString options: { - customerId: { + activationCriteria: { /** - * Customer + * Activation Criteria */ displayName: () => LocalizedString /** - * The customer to update + * Criteria for trigger to activate (created or updated) */ shortDesc: () => LocalizedString /** - * Select the customer whose profile you want to update. + * Select the criteria for the trigger to activate. + + - Created: Triggers when a new object is created + - Updated: Triggers when an existing object is updated */ longDesc: () => LocalizedString } - firstName: { + additionalProperties: { /** - * First Name + * Additional Properties */ displayName: () => LocalizedString /** - * The new first name + * Additional properties to add to returned data */ shortDesc: () => LocalizedString /** - * Update the first name of the customer. Maximum 40 characters. + * Select additional properties to add to the returned object data */ longDesc: () => LocalizedString } - lastName: { + object: { /** - * Last Name + * Object */ displayName: () => LocalizedString /** - * The new last name + * The custom object to monitor for changes. */ shortDesc: () => LocalizedString /** - * Update the last name of the customer. Maximum 40 characters. + * Select the custom object you want to monitor for new or updated records. */ longDesc: () => LocalizedString } - jobTitle: { + } + } + hubspot_deal_created_or_updated_trigger: { + event_info: { + /** + * Deal Information + */ + desc: () => LocalizedString + } + /** + * Deal Created or Updated + */ + displayName: () => LocalizedString + /** + * Triggers when a deal is created or updated in HubSpot. + */ + shortDesc: () => LocalizedString + /** + * This trigger fires when a deal is created or modified in HubSpot, allowing you to track sales opportunities and integrate with your sales pipeline automation workflows. + */ + longDesc: () => LocalizedString + options: { + activationCriteria: { /** - * Job Title + * Activation Criteria */ displayName: () => LocalizedString /** - * The new job title + * Criteria for trigger to activate (created or updated) */ shortDesc: () => LocalizedString /** - * Update the job title of the customer. Maximum 60 characters. + * Select the criteria for the trigger to activate. + + - Created: Triggers when a new object is created + - Updated: Triggers when an existing object is updated */ longDesc: () => LocalizedString } - organization: { + additionalProperties: { /** - * Organization + * Additional Properties */ displayName: () => LocalizedString /** - * The new organization + * Additional properties to add to returned data */ shortDesc: () => LocalizedString /** - * Update the company or organization of the customer. + * Select additional properties to add to the returned object data */ longDesc: () => LocalizedString } - location: { + } + } + hubspot_lead_created_or_updated_trigger: { + event_info: { + /** + * Lead Information + */ + desc: () => LocalizedString + } + /** + * Lead Created or Updated + */ + displayName: () => LocalizedString + /** + * Triggers when a lead is added or updated in HubSpot. + */ + shortDesc: () => LocalizedString + /** + * Monitor new leads and updates to existing leads in HubSpot with this trigger, enabling efficient lead management and follow-up processes. + */ + longDesc: () => LocalizedString + options: { + activationCriteria: { /** - * Location + * Activation Criteria */ displayName: () => LocalizedString /** - * The new location + * Criteria for trigger to activate (created or updated) */ shortDesc: () => LocalizedString /** - * Update the geographic location of the customer. Maximum 60 characters. + * Select the criteria for the trigger to activate. + + - Created: Triggers when a new object is created + - Updated: Triggers when an existing object is updated */ longDesc: () => LocalizedString } - background: { + additionalProperties: { /** - * Background + * Additional Properties */ displayName: () => LocalizedString /** - * The new background notes + * Additional properties to add to returned data */ shortDesc: () => LocalizedString /** - * Update the internal background notes about the customer. Maximum 200 characters. + * Select additional properties to add to the returned object data */ longDesc: () => LocalizedString } - gender: { + } + } + hubspot_product_created_or_updated_trigger: { + event_info: { + /** + * Product Information + */ + desc: () => LocalizedString + } + /** + * Product Created or Updated + */ + displayName: () => LocalizedString + /** + * Triggers when a product is added or updated in HubSpot. + */ + shortDesc: () => LocalizedString + /** + * This trigger alerts you to any new or updated products within your HubSpot account, ensuring that your product data remains synchronized with your workflows and external systems. + */ + longDesc: () => LocalizedString + options: { + activationCriteria: { /** - * Gender + * Activation Criteria */ displayName: () => LocalizedString /** - * The new gender + * Criteria for trigger to activate (created or updated) */ shortDesc: () => LocalizedString /** - * Update the gender of the customer: male, female, or unknown. + * Select the criteria for the trigger to activate. + + - Created: Triggers when a new object is created + - Updated: Triggers when an existing object is updated */ longDesc: () => LocalizedString } - age: { + additionalProperties: { /** - * Age + * Additional Properties */ displayName: () => LocalizedString /** - * The new age + * Additional properties to add to returned data */ shortDesc: () => LocalizedString /** - * Update the age of the customer. + * Select additional properties to add to the returned object data */ longDesc: () => LocalizedString } } } - send_reply: { - groups: { + hubspot_ticket_created_or_updated_trigger: { + event_info: { /** - * Conversations + * Ticket Information */ - '0': () => LocalizedString + desc: () => LocalizedString } /** - * Send Reply + * Ticket Created or Updated */ displayName: () => LocalizedString /** - * Send a reply to a conversation + * Triggers when a support ticket is created or updated in HubSpot. */ shortDesc: () => LocalizedString /** - * Send a reply to an existing conversation in Help Scout. The reply will be sent to the customer via email. You can optionally CC/BCC additional recipients, save as draft, or change the conversation status. + * Automatically trigger workflows when a support ticket is created or updated in HubSpot, ideal for managing customer support operations and streamlining issue resolution. */ longDesc: () => LocalizedString options: { - conversationId: { - /** - * Conversation - */ - displayName: () => LocalizedString - /** - * The conversation to reply to - */ - shortDesc: () => LocalizedString - /** - * Select or enter the ID of the conversation you want to reply to. - */ - longDesc: () => LocalizedString - } - customerId: { + activationCriteria: { /** - * Customer + * Activation Criteria */ displayName: () => LocalizedString /** - * The customer being replied to + * Criteria for trigger to activate (created or updated) */ shortDesc: () => LocalizedString /** - * Select the customer who will receive this reply. This should match the customer associated with the conversation. + * Select the criteria for the trigger to activate. + + - Created: Triggers when a new object is created + - Updated: Triggers when an existing object is updated */ longDesc: () => LocalizedString } - text: { + additionalProperties: { /** - * Reply Text + * Additional Properties */ displayName: () => LocalizedString /** - * The content of the reply + * Additional properties to add to returned data */ shortDesc: () => LocalizedString /** - * The text content of the reply message. This can include HTML formatting. The reply will be sent to the customer via email. + * Select additional properties to add to the returned object data */ longDesc: () => LocalizedString } - user: { + } + } + hubspot_user_created_or_updated_trigger: { + event_info: { + /** + * User Information + */ + desc: () => LocalizedString + } + /** + * User Created or Updated + */ + displayName: () => LocalizedString + /** + * Triggers when a user is added or updated in HubSpot. + */ + shortDesc: () => LocalizedString + /** + * This trigger fires upon the creation or update of a user within HubSpot, helping you keep track of user accounts and maintain updated access control for your team. + */ + longDesc: () => LocalizedString + options: { + activationCriteria: { /** - * User + * Activation Criteria */ displayName: () => LocalizedString /** - * The user sending the reply + * Criteria for trigger to activate (created or updated) */ shortDesc: () => LocalizedString /** - * The Help Scout user sending the reply. If not specified, defaults to the authenticated user. + * Select the criteria for the trigger to activate. + + - Created: Triggers when a new object is created + - Updated: Triggers when an existing object is updated */ longDesc: () => LocalizedString } - status: { + additionalProperties: { /** - * Status + * Additional Properties */ displayName: () => LocalizedString /** - * Change the conversation status + * Additional properties to add to returned data */ shortDesc: () => LocalizedString /** - * Optionally change the conversation status after sending the reply. For example, set to closed after resolving an issue. + * Select additional properties to add to the returned object data */ longDesc: () => LocalizedString } - draft: { + } + } + } + expressions: { + '&&': { + /** + * and (&&) + */ + displayName: () => LocalizedString + /** + * Returns True if all arguments are True + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if all arguments are `True` with logic short-circuiting + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Save as Draft + * Condition */ displayName: () => LocalizedString /** - * Save the reply as a draft + * Boolean condition to evaluate */ shortDesc: () => LocalizedString /** - * When set to true, the reply is saved as a draft and not sent to the customer. You can review and send it later from Help Scout. + * A boolean expression or condition that evaluates to True or False */ longDesc: () => LocalizedString } - cc: { + } + } + '||': { + /** + * or (||) + */ + displayName: () => LocalizedString + /** + * Returns True if any argument is True + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if any argument is `True` with logic short-circuiting + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * CC + * Condition */ displayName: () => LocalizedString /** - * Carbon copy email addresses + * Boolean condition to evaluate */ shortDesc: () => LocalizedString /** - * A list of email addresses to CC on the reply. These recipients will receive a copy of the email. + * A boolean expression or condition that evaluates to True or False */ longDesc: () => LocalizedString } - bcc: { + } + } + '==': { + /** + * equals (=) + */ + displayName: () => LocalizedString + /** + * Equality comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value equals the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * BCC + * Field */ displayName: () => LocalizedString /** - * Blind carbon copy email addresses + * Field to compare */ shortDesc: () => LocalizedString /** - * A list of email addresses to BCC on the reply. These recipients will receive a copy of the email without other recipients knowing. + * The field whose value will be compared */ longDesc: () => LocalizedString } - assignTo: { + '1': { /** - * Assign To + * Value */ displayName: () => LocalizedString /** - * Assign the conversation after replying + * Value to compare against */ shortDesc: () => LocalizedString /** - * Optionally assign the conversation to a different Help Scout user after sending the reply. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - list_customers: { - groups: { - /** - * Customers - */ - '0': () => LocalizedString - } + '!=': { /** - * List Customers + * not equals (!=) */ displayName: () => LocalizedString /** - * Retrieve a list of customers + * Inequality comparison */ shortDesc: () => LocalizedString /** - * Retrieve a list of customers from Help Scout. You can filter customers by mailbox, name, email, or modification date. Results can be sorted and paginated. + * Returns `True` if the field value does not equal the specified value */ longDesc: () => LocalizedString - options: { - mailbox: { + args: { + '0': { /** - * Mailbox + * Field */ displayName: () => LocalizedString /** - * Filter by mailbox + * Field to compare */ shortDesc: () => LocalizedString /** - * Only return customers associated with conversations in this mailbox. + * The field whose value will be compared */ longDesc: () => LocalizedString } - firstName: { + '1': { /** - * First Name + * Value */ displayName: () => LocalizedString /** - * Filter by first name + * Value to compare against */ shortDesc: () => LocalizedString /** - * Only return customers with this first name. + * The value to compare the field against */ longDesc: () => LocalizedString } - lastName: { + } + } + '>': { + /** + * greater than (>) + */ + displayName: () => LocalizedString + /** + * Greater than comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is greater than the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Last Name + * Field */ displayName: () => LocalizedString /** - * Filter by last name + * Field to compare */ shortDesc: () => LocalizedString /** - * Only return customers with this last name. + * The field whose value will be compared */ longDesc: () => LocalizedString } - email: { + '1': { /** - * Email + * Value */ displayName: () => LocalizedString /** - * Filter by email address + * Value to compare against */ shortDesc: () => LocalizedString /** - * Only return customers with this email address. + * The value to compare the field against */ longDesc: () => LocalizedString } - modifiedSince: { + } + } + '>=': { + /** + * greater than or equal (>=) + */ + displayName: () => LocalizedString + /** + * Greater than or equal comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is greater than or equal to the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Modified Since + * Field */ displayName: () => LocalizedString /** - * Filter by modification date + * Field to compare */ shortDesc: () => LocalizedString /** - * Only return customers modified on or after this date. + * The field whose value will be compared */ longDesc: () => LocalizedString } - sortField: { + '1': { /** - * Sort Field + * Value */ displayName: () => LocalizedString /** - * Field to sort by + * Value to compare against */ shortDesc: () => LocalizedString /** - * The field to sort results by: createdAt, firstName, lastName, or modifiedAt. + * The value to compare the field against */ longDesc: () => LocalizedString } - sortOrder: { + } + } + '<': { + /** + * less than (<) + */ + displayName: () => LocalizedString + /** + * Less than comparison + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is less than the specified value + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Sort Order + * Field */ displayName: () => LocalizedString /** - * Sort order direction + * Field to compare */ shortDesc: () => LocalizedString /** - * The direction to sort results: desc (newest first) or asc (oldest first). + * The field whose value will be compared */ longDesc: () => LocalizedString } - limit: { + '1': { /** - * Limit + * Value */ displayName: () => LocalizedString /** - * Maximum number of customers to return + * Value to compare against */ shortDesc: () => LocalizedString /** - * The maximum number of customer records to return. Default is 50. + * The value to compare the field against */ longDesc: () => LocalizedString } } } - list_conversations: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - } + '<=': { /** - * List Conversations + * less than or equal (<=) */ displayName: () => LocalizedString /** - * Retrieve a list of conversations + * Less than or equal comparison */ shortDesc: () => LocalizedString /** - * Retrieve a list of conversations from Help Scout. You can filter by mailbox, status, assignee, tags, and more. Results can be sorted and paginated. + * Returns `True` if the field value is less than or equal to the specified value */ longDesc: () => LocalizedString - options: { - mailbox: { + args: { + '0': { /** - * Mailbox + * Field */ displayName: () => LocalizedString /** - * Filter by mailbox + * Field to compare */ shortDesc: () => LocalizedString /** - * Only return conversations from this mailbox. + * The field whose value will be compared */ longDesc: () => LocalizedString } - status: { + '1': { /** - * Status + * Value */ displayName: () => LocalizedString /** - * Filter by conversation status + * Value to compare against */ shortDesc: () => LocalizedString /** - * Only return conversations with this status: all, active, closed, open, pending, or spam. + * The value to compare the field against */ longDesc: () => LocalizedString } - assignedTo: { + } + } + 'in': { + /** + * in + */ + displayName: () => LocalizedString + /** + * In list + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is in the provided list + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Assigned To + * Field */ displayName: () => LocalizedString /** - * Filter by assignee + * Field to check */ shortDesc: () => LocalizedString /** - * Only return conversations assigned to this user. + * The field whose value will be checked */ longDesc: () => LocalizedString } - tag: { + '1': { /** - * Tag + * Values */ displayName: () => LocalizedString /** - * Filter by tag + * List of values */ shortDesc: () => LocalizedString /** - * Only return conversations with this tag. You can specify multiple tags separated by commas. + * The list of values to check the field against */ longDesc: () => LocalizedString } - modifiedSince: { + } + } + not_in: { + /** + * not in + */ + displayName: () => LocalizedString + /** + * Not in list + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is not in the provided list + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Modified Since + * Field */ displayName: () => LocalizedString /** - * Filter by modification date + * Field to check */ shortDesc: () => LocalizedString /** - * Only return conversations modified on or after this date. + * The field whose value will be checked */ longDesc: () => LocalizedString } - sortField: { + '1': { /** - * Sort Field + * Values */ displayName: () => LocalizedString /** - * Field to sort by + * List of values */ shortDesc: () => LocalizedString /** - * The field to sort results by: createdAt, customerEmail, customerName, mailboxid, modifiedAt, number, status, or subject. + * The list of values the field should not match */ longDesc: () => LocalizedString } - sortOrder: { + } + } + between: { + /** + * between + */ + displayName: () => LocalizedString + /** + * Between two values + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field value is between the two specified values + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Sort Order + * Field */ displayName: () => LocalizedString /** - * Sort order direction + * Field to check */ shortDesc: () => LocalizedString /** - * The direction to sort results: desc (newest first) or asc (oldest first). + * The field whose value will be checked */ longDesc: () => LocalizedString } - query: { + '1': { /** - * Query + * Lower bound */ displayName: () => LocalizedString /** - * Advanced search query + * Minimum value */ shortDesc: () => LocalizedString /** - * An advanced search query using Help Scout query syntax. For example: (subject:"billing issue") AND (status:active) + * The lower bound of the range (inclusive) */ longDesc: () => LocalizedString } - limit: { + '2': { /** - * Limit + * Upper bound */ displayName: () => LocalizedString /** - * Maximum number of conversations to return + * Maximum value */ shortDesc: () => LocalizedString /** - * The maximum number of conversation records to return. Default is 50. + * The upper bound of the range (inclusive) */ longDesc: () => LocalizedString } } } - find_mailbox: { - groups: { - /** - * Mailboxes - */ - '0': () => LocalizedString - } + has_property: { /** - * Find Mailbox by Name + * has property */ displayName: () => LocalizedString /** - * Find a mailbox by its name + * Field has a value */ shortDesc: () => LocalizedString /** - * Search for a mailbox in Help Scout by its name. Returns the mailbox details if found. The search is case-insensitive and supports partial matching. + * Returns `True` if the field has any value set (is not null or empty) */ longDesc: () => LocalizedString - options: { - name: { + args: { + '0': { /** - * Mailbox Name + * Field */ displayName: () => LocalizedString /** - * The name of the mailbox to find + * Field to check */ shortDesc: () => LocalizedString /** - * The name of the mailbox to search for. The search is case-insensitive and will match partial names or slugs. + * The field to check for a value */ longDesc: () => LocalizedString } } } - list_users: { - groups: { - /** - * Users - */ - '0': () => LocalizedString - } + not_has_property: { /** - * List Users + * does not have property */ displayName: () => LocalizedString /** - * Retrieve a list of Help Scout users + * Field has no value */ shortDesc: () => LocalizedString /** - * Retrieve a list of users from your Help Scout account. You can filter users by email address or mailbox. Returns all user types including those who have not yet accepted their invitations. + * Returns `True` if the field has no value set (is null or empty) */ longDesc: () => LocalizedString - options: { - email: { + args: { + '0': { /** - * Email + * Field */ displayName: () => LocalizedString /** - * Filter by email address + * Field to check */ shortDesc: () => LocalizedString /** - * Only return users with this exact email address. + * The field to check for emptiness */ longDesc: () => LocalizedString } - mailbox: { + } + } + contains_token: { + /** + * contains token + */ + displayName: () => LocalizedString + /** + * Contains token or substring + */ + shortDesc: () => LocalizedString + /** + * Returns `True` if the field contains the specified token or substring + */ + longDesc: () => LocalizedString + args: { + '0': { /** - * Mailbox + * Field */ displayName: () => LocalizedString /** - * Filter by mailbox + * Text field to search */ shortDesc: () => LocalizedString /** - * Only return users associated with this mailbox. + * The text field to search within */ longDesc: () => LocalizedString } - limit: { + '1': { /** - * Limit + * Token */ displayName: () => LocalizedString /** - * Maximum number of users to return + * Token to find */ shortDesc: () => LocalizedString /** - * The maximum number of user records to return. Default is 50. + * The token or substring to search for */ longDesc: () => LocalizedString } } } - get_company_report: { - groups: { - /** - * Reports - */ - '0': () => LocalizedString - } + not_contains_token: { /** - * Get Company Report + * does not contain token */ displayName: () => LocalizedString /** - * Get company-wide performance report + * Does not contain token or substring */ shortDesc: () => LocalizedString /** - * Retrieve a company-wide performance report from Help Scout. Includes metrics like customers helped, closed conversations, total replies, and happiness scores. Only available on Plus and Pro plans. + * Returns `True` if the field does not contain the specified token or substring */ longDesc: () => LocalizedString - options: { - start: { - /** - * Start Date - */ - displayName: () => LocalizedString - /** - * Start of the reporting period - */ - shortDesc: () => LocalizedString - /** - * The start date and time for the reporting period in ISO 8601 format. - */ - longDesc: () => LocalizedString - } - end: { + args: { + '0': { /** - * End Date + * Field */ displayName: () => LocalizedString /** - * End of the reporting period + * Text field to search */ shortDesc: () => LocalizedString /** - * The end date and time for the reporting period in ISO 8601 format. + * The text field to search within */ longDesc: () => LocalizedString } - previousStart: { + '1': { /** - * Previous Start + * Token */ displayName: () => LocalizedString /** - * Start of the comparison period + * Token to exclude */ shortDesc: () => LocalizedString /** - * The start date for a previous period to compare against. Used to calculate deltas. + * The token or substring that should not be present */ longDesc: () => LocalizedString } - previousEnd: { - /** - * Previous End - */ - displayName: () => LocalizedString - /** - * End of the comparison period - */ - shortDesc: () => LocalizedString - /** - * The end date for a previous period to compare against. Used to calculate deltas. - */ - longDesc: () => LocalizedString + } + } + } + searchOptions: { + orderBy: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + column: { + /** + * Column + */ + displayName: () => LocalizedString + /** + * The column to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the column to use for sorting results + */ + longDesc: () => LocalizedString + } + ascending: { + /** + * Ascending + */ + displayName: () => LocalizedString + /** + * Sort in ascending order + */ + shortDesc: () => LocalizedString + /** + * When enabled, results are sorted in ascending order (A-Z, 0-9) + */ + longDesc: () => LocalizedString + } } - mailboxes: { + } + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of records to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of records to return. If not specified, all matching records will be returned. + */ + longDesc: () => LocalizedString + } + } + upsertOptions: { + idProperty: { + /** + * ID Property + */ + displayName: () => LocalizedString + /** + * The unique identifier property for upsert operations + */ + shortDesc: () => LocalizedString + /** + * The unique identifier property name used to determine if a record already exists for updating. If no matching record is found, a new record will be created. + */ + longDesc: () => LocalizedString + } + } + } + Dropbox: { + /** + * Dropbox + */ + displayName: () => LocalizedString + groups: { + /** + * Cloud Storage & File Management + */ + '0': () => LocalizedString + } + /** + * Connect with Dropbox to manage files, folders, and shared links in your cloud storage + */ + shortDesc: () => LocalizedString + /** + * Integrate with Dropbox to automate file management, sharing, and synchronization. Dropbox is a cloud-based file storage solution that allows users to store, share, and collaborate on files and folders. This integration enables you to create, copy, move, and delete files and folders, manage shared links, track file revisions, and monitor for new or modified files. + */ + longDesc: () => LocalizedString + actions: { + create_text_file: { + groups: { + /** + * Files + */ + '0': () => LocalizedString + } + /** + * Create Text File + */ + displayName: () => LocalizedString + /** + * Create a new text file in Dropbox + */ + shortDesc: () => LocalizedString + /** + * Create a new text file with the specified content at the given path in your Dropbox. If a file already exists at the path and autorename is enabled, a new name will be generated. + */ + longDesc: () => LocalizedString + options: { + path: { /** - * Mailboxes + * File Path */ displayName: () => LocalizedString /** - * Filter by mailbox IDs + * Full path for the new file */ shortDesc: () => LocalizedString /** - * Comma-separated list of mailbox IDs to filter the report by. + * The full path where the file should be created, including the filename (e.g., "/Documents/notes.txt"). */ longDesc: () => LocalizedString } - tags: { + content: { /** - * Tags + * Content */ displayName: () => LocalizedString /** - * Filter by tag IDs + * Text content for the file */ shortDesc: () => LocalizedString /** - * Comma-separated list of tag IDs to filter the report by. + * The text content to write to the file. */ longDesc: () => LocalizedString } - types: { + autorename: { /** - * Types + * Auto Rename */ displayName: () => LocalizedString /** - * Filter by conversation types + * Automatically rename if file exists */ shortDesc: () => LocalizedString /** - * Filter by conversation type: email, chat, or phone. + * If enabled and a file with the same name exists, Dropbox will automatically generate a new name. */ longDesc: () => LocalizedString } - folders: { + mute: { /** - * Folders + * Mute */ displayName: () => LocalizedString /** - * Filter by folder IDs + * Suppress change notifications */ shortDesc: () => LocalizedString /** - * Comma-separated list of folder IDs to filter the report by. + * If enabled, users will not receive notifications about this file being created. */ longDesc: () => LocalizedString } } } - get_email_report: { + upload_file: { groups: { /** - * Reports + * Files */ '0': () => LocalizedString } /** - * Get Email Report + * Upload File */ displayName: () => LocalizedString /** - * Get email channel performance report + * Upload a file to Dropbox */ shortDesc: () => LocalizedString /** - * Retrieve an email channel performance report from Help Scout. Includes volume metrics, resolution times, response times, and time distribution data. Only available on Plus and Pro plans. + * Upload a file from binary content to the specified path in your Dropbox. Supports files up to 150MB. */ longDesc: () => LocalizedString options: { - start: { - /** - * Start Date - */ - displayName: () => LocalizedString - /** - * Start of the reporting period - */ - shortDesc: () => LocalizedString - /** - * The start date and time for the reporting period in ISO 8601 format. - */ - longDesc: () => LocalizedString - } - end: { - /** - * End Date - */ - displayName: () => LocalizedString - /** - * End of the reporting period - */ - shortDesc: () => LocalizedString - /** - * The end date and time for the reporting period in ISO 8601 format. - */ - longDesc: () => LocalizedString - } - previousStart: { + path: { /** - * Previous Start + * Destination Path */ displayName: () => LocalizedString /** - * Start of the comparison period + * Full path for the uploaded file */ shortDesc: () => LocalizedString /** - * The start date for a previous period to compare against. Used to calculate deltas. + * The full path where the file should be uploaded, including the filename (e.g., "/Documents/report.pdf"). If not provided, the file will be uploaded to the root folder with its original name. */ longDesc: () => LocalizedString } - previousEnd: { + file: { /** - * Previous End + * File */ displayName: () => LocalizedString /** - * End of the comparison period + * The file to upload */ shortDesc: () => LocalizedString /** - * The end date for a previous period to compare against. Used to calculate deltas. + * The file to upload to Dropbox. */ longDesc: () => LocalizedString } - mailboxes: { + autorename: { /** - * Mailboxes + * Auto Rename */ displayName: () => LocalizedString /** - * Filter by mailbox IDs + * Automatically rename if file exists */ shortDesc: () => LocalizedString /** - * Comma-separated list of mailbox IDs to filter the report by. + * If enabled and a file with the same name exists, Dropbox will automatically generate a new name. */ longDesc: () => LocalizedString } - tags: { + mute: { /** - * Tags + * Mute */ displayName: () => LocalizedString /** - * Filter by tag IDs + * Suppress change notifications */ shortDesc: () => LocalizedString /** - * Comma-separated list of tag IDs to filter the report by. + * If enabled, users will not receive notifications about this file being uploaded. */ longDesc: () => LocalizedString } - folders: { + strictConflict: { /** - * Folders + * Strict Conflict */ displayName: () => LocalizedString /** - * Filter by folder IDs + * Fail on conflict instead of renaming */ shortDesc: () => LocalizedString /** - * Comma-separated list of folder IDs to filter the report by. + * If enabled, the upload will fail if a file with the same name exists, even if autorename is enabled. */ longDesc: () => LocalizedString } - officeHours: { + } + } + download_file: { + groups: { + /** + * Files + */ + '0': () => LocalizedString + } + /** + * Download File + */ + displayName: () => LocalizedString + /** + * Download a file from Dropbox + */ + shortDesc: () => LocalizedString + /** + * Download the content of a file from your Dropbox. Returns the file content as base64-encoded binary data along with file metadata. + */ + longDesc: () => LocalizedString + options: { + path: { /** - * Office Hours + * File Path */ displayName: () => LocalizedString /** - * Consider office hours in calculations + * Path to the file to download */ shortDesc: () => LocalizedString /** - * When set to true, time-based metrics will only consider office hours. Defaults to false. + * The full path to the file you want to download (e.g., "/Documents/report.pdf"). */ longDesc: () => LocalizedString } } } - get_conversation: { + get_file_link: { groups: { /** - * Conversations + * Files */ '0': () => LocalizedString } /** - * Get Conversation + * Get Temporary Link */ displayName: () => LocalizedString /** - * Retrieve a single conversation by ID + * Get a temporary download link for a file */ shortDesc: () => LocalizedString /** - * Retrieve the full details of a specific conversation from Help Scout by its ID. Returns all conversation data including subject, status, customer information, tags, and custom fields. + * Get a temporary direct link to download a file. The link is valid for 4 hours and can be used to stream content directly. */ longDesc: () => LocalizedString options: { - conversationId: { + path: { /** - * Conversation + * File Path */ displayName: () => LocalizedString /** - * The conversation to retrieve + * Path to the file */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to retrieve. + * The full path to the file for which you want to generate a temporary link. */ longDesc: () => LocalizedString } } } - update_conversation: { + delete_file: { groups: { /** - * Conversations + * Files */ '0': () => LocalizedString } /** - * Update Conversation + * Delete File */ displayName: () => LocalizedString /** - * Update an existing conversation + * Delete a file from Dropbox */ shortDesc: () => LocalizedString /** - * Update the properties of an existing conversation in Help Scout. You can change the subject, status, or assignee. At least one field must be provided to update. + * Permanently delete a file from your Dropbox. This action cannot be undone through the API. */ longDesc: () => LocalizedString options: { - conversationId: { + path: { /** - * Conversation + * File Path */ displayName: () => LocalizedString /** - * The conversation to update + * Path to the file to delete */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to update. + * The full path to the file you want to delete. */ longDesc: () => LocalizedString } - subject: { + } + } + copy_file: { + groups: { + /** + * Files + */ + '0': () => LocalizedString + } + /** + * Copy File + */ + displayName: () => LocalizedString + /** + * Copy a file to a new location + */ + shortDesc: () => LocalizedString + /** + * Copy a file from one location to another within your Dropbox. The original file remains unchanged. + */ + longDesc: () => LocalizedString + options: { + fromPath: { /** - * Subject + * Source Path */ displayName: () => LocalizedString /** - * The new subject line + * Path to the file to copy */ shortDesc: () => LocalizedString /** - * Update the subject line of the conversation. This will be visible to the customer in email communications. + * The full path to the source file. */ longDesc: () => LocalizedString } - status: { + toPath: { /** - * Status + * Destination Path */ displayName: () => LocalizedString /** - * The new conversation status + * Path for the copied file */ shortDesc: () => LocalizedString /** - * Update the status of the conversation. Options include active, closed, or pending. + * The full path where the file should be copied to. */ longDesc: () => LocalizedString } - assignTo: { + autorename: { /** - * Assign To + * Auto Rename */ displayName: () => LocalizedString /** - * Assign to a user + * Automatically rename if destination exists */ shortDesc: () => LocalizedString /** - * Assign or reassign the conversation to a specific Help Scout user. + * If enabled and a file exists at the destination, generate a new name. */ longDesc: () => LocalizedString } - } - } - delete_conversation: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - } - /** - * Delete Conversation - */ - displayName: () => LocalizedString - /** - * Delete a conversation - */ - shortDesc: () => LocalizedString - /** - * Delete a conversation from Help Scout. This action moves the conversation to the trash. Be cautious as this action may be irreversible depending on your Help Scout settings. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + allowOwnershipTransfer: { /** - * Conversation + * Allow Ownership Transfer */ displayName: () => LocalizedString /** - * The conversation to delete + * Allow ownership transfer for shared content */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to delete. + * If enabled, allows the copy operation to transfer ownership of the content if needed. */ longDesc: () => LocalizedString } } } - add_tags: { + move_file: { groups: { /** - * Conversations + * Files */ '0': () => LocalizedString } /** - * Add Tags to Conversation + * Move File */ displayName: () => LocalizedString /** - * Add tags to a conversation + * Move a file to a new location */ shortDesc: () => LocalizedString /** - * Add one or more tags to an existing conversation in Help Scout. Tags help organize and categorize conversations for easier filtering, reporting, and workflow automation. + * Move a file from one location to another within your Dropbox. */ longDesc: () => LocalizedString options: { - conversationId: { + fromPath: { /** - * Conversation + * Source Path */ displayName: () => LocalizedString /** - * The conversation to add tags to + * Path to the file to move */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to add tags to. + * The full path to the source file. */ longDesc: () => LocalizedString } - tags: { + toPath: { /** - * Tags + * Destination Path */ displayName: () => LocalizedString /** - * Tags to add + * Path for the moved file */ shortDesc: () => LocalizedString /** - * A list of tag names to add to the conversation. Tags are case-insensitive and will be created if they do not already exist. + * The full path where the file should be moved to. */ longDesc: () => LocalizedString - } - } - } - list_threads: { - groups: { - /** - * Threads - */ - '0': () => LocalizedString - } - /** - * List Threads - */ - displayName: () => LocalizedString - /** - * List all threads in a conversation - */ - shortDesc: () => LocalizedString - /** - * Retrieve all threads (messages) within a specific conversation. Threads include customer messages, agent replies, notes, and other conversation activities. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + } + autorename: { /** - * Conversation + * Auto Rename */ displayName: () => LocalizedString /** - * The conversation to list threads from + * Automatically rename if destination exists */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation whose threads you want to retrieve. + * If enabled and a file exists at the destination, generate a new name. */ longDesc: () => LocalizedString } - limit: { + allowOwnershipTransfer: { /** - * Limit + * Allow Ownership Transfer */ displayName: () => LocalizedString /** - * Maximum number of threads to return + * Allow ownership transfer for shared content */ shortDesc: () => LocalizedString /** - * The maximum number of thread records to return. Default is 50. + * If enabled, allows the move operation to transfer ownership of the content if needed. */ longDesc: () => LocalizedString } } } - get_thread: { + create_folder: { groups: { /** - * Threads + * Folders */ '0': () => LocalizedString } /** - * Get Thread + * Create Folder */ displayName: () => LocalizedString /** - * Retrieve a specific thread by ID + * Create a new folder in Dropbox */ shortDesc: () => LocalizedString /** - * Retrieve the full details of a specific thread (message) within a conversation. Returns the thread content, type, status, and metadata. + * Create a new folder at the specified path in your Dropbox. */ longDesc: () => LocalizedString options: { - conversationId: { + path: { /** - * Conversation + * Folder Path */ displayName: () => LocalizedString /** - * The conversation containing the thread + * Full path for the new folder */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation that contains the thread. + * The full path where the folder should be created (e.g., "/Documents/Projects"). */ longDesc: () => LocalizedString } - threadId: { + autorename: { /** - * Thread ID + * Auto Rename */ displayName: () => LocalizedString /** - * The thread to retrieve + * Automatically rename if folder exists */ shortDesc: () => LocalizedString /** - * Enter the ID of the specific thread you want to retrieve. + * If enabled and a folder with the same name exists, generate a new name. */ longDesc: () => LocalizedString } } } - get_customer: { + delete_folder: { groups: { /** - * Customers + * Folders */ '0': () => LocalizedString } /** - * Get Customer + * Delete Folder */ displayName: () => LocalizedString /** - * Retrieve a single customer by ID + * Delete a folder from Dropbox */ shortDesc: () => LocalizedString /** - * Retrieve the full details of a specific customer from Help Scout by their ID. Returns all customer data including contact information, organization, and custom fields. + * Permanently delete a folder and all its contents from your Dropbox. This action cannot be undone through the API. */ longDesc: () => LocalizedString options: { - customerId: { + path: { /** - * Customer + * Folder Path */ displayName: () => LocalizedString /** - * The customer to retrieve + * Path to the folder to delete */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the customer whose profile you want to retrieve. + * The full path to the folder you want to delete. */ longDesc: () => LocalizedString } } } - delete_customer: { + copy_folder: { groups: { /** - * Customers + * Folders */ '0': () => LocalizedString } /** - * Delete Customer + * Copy Folder */ displayName: () => LocalizedString /** - * Delete a customer + * Copy a folder to a new location */ shortDesc: () => LocalizedString /** - * Delete a customer profile from Help Scout. Be cautious as this action may affect conversation history and is typically irreversible. + * Copy a folder and all its contents from one location to another within your Dropbox. */ longDesc: () => LocalizedString options: { - customerId: { + fromPath: { /** - * Customer + * Source Path */ displayName: () => LocalizedString /** - * The customer to delete + * Path to the folder to copy */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the customer you want to delete. + * The full path to the source folder. + */ + longDesc: () => LocalizedString + } + toPath: { + /** + * Destination Path + */ + displayName: () => LocalizedString + /** + * Path for the copied folder + */ + shortDesc: () => LocalizedString + /** + * The full path where the folder should be copied to. + */ + longDesc: () => LocalizedString + } + autorename: { + /** + * Auto Rename + */ + displayName: () => LocalizedString + /** + * Automatically rename if destination exists + */ + shortDesc: () => LocalizedString + /** + * If enabled and a folder exists at the destination, generate a new name. + */ + longDesc: () => LocalizedString + } + allowOwnershipTransfer: { + /** + * Allow Ownership Transfer + */ + displayName: () => LocalizedString + /** + * Allow ownership transfer for shared content + */ + shortDesc: () => LocalizedString + /** + * If enabled, allows the copy operation to transfer ownership of the content if needed. */ longDesc: () => LocalizedString } } } - search_customers: { + move_folder: { groups: { /** - * Customers + * Folders */ '0': () => LocalizedString } /** - * Search Customers + * Move Folder */ displayName: () => LocalizedString /** - * Search for customers using a query + * Move a folder to a new location */ shortDesc: () => LocalizedString /** - * Search for customers in Help Scout using a query string. You can search by email, name, phone number, or other customer properties using Help Scout query syntax. + * Move a folder and all its contents from one location to another within your Dropbox. */ longDesc: () => LocalizedString options: { - query: { + fromPath: { /** - * Query + * Source Path */ displayName: () => LocalizedString /** - * Search query + * Path to the folder to move */ shortDesc: () => LocalizedString /** - * The search query using Help Scout query syntax. Examples: (email:"john@example.com"), (firstName:"John"), (phone:"555-1234"). You can combine multiple conditions with AND/OR operators. + * The full path to the source folder. */ longDesc: () => LocalizedString } - sortField: { + toPath: { /** - * Sort Field + * Destination Path */ displayName: () => LocalizedString /** - * Field to sort by + * Path for the moved folder */ shortDesc: () => LocalizedString /** - * The field to sort results by: createdAt, firstName, lastName, or modifiedAt. + * The full path where the folder should be moved to. */ longDesc: () => LocalizedString } - sortOrder: { + autorename: { /** - * Sort Order + * Auto Rename */ displayName: () => LocalizedString /** - * Sort order direction + * Automatically rename if destination exists */ shortDesc: () => LocalizedString /** - * The direction to sort results: desc (newest first) or asc (oldest first). + * If enabled and a folder exists at the destination, generate a new name. */ longDesc: () => LocalizedString } - limit: { + allowOwnershipTransfer: { /** - * Limit + * Allow Ownership Transfer */ displayName: () => LocalizedString /** - * Maximum number of customers to return + * Allow ownership transfer for shared content */ shortDesc: () => LocalizedString /** - * The maximum number of customer records to return. Default is 50. + * If enabled, allows the move operation to transfer ownership of the content if needed. */ longDesc: () => LocalizedString } } } - list_saved_replies: { + list_folder: { groups: { /** - * Saved Replies + * Folders */ '0': () => LocalizedString } /** - * List Saved Replies + * List Folder Contents */ displayName: () => LocalizedString /** - * List saved replies for a mailbox + * List files and folders in a directory */ shortDesc: () => LocalizedString /** - * Retrieve a list of saved reply templates for a specific mailbox. Saved replies are pre-written response templates that agents can use to quickly respond to common questions. + * Retrieve a list of all files and subfolders within a specified folder in your Dropbox. */ longDesc: () => LocalizedString options: { - mailboxId: { + path: { /** - * Mailbox + * Folder Path */ displayName: () => LocalizedString /** - * The mailbox to list saved replies from + * Path to the folder to list */ shortDesc: () => LocalizedString /** - * Select the mailbox whose saved replies you want to retrieve. Saved replies are specific to each mailbox. + * The full path to the folder whose contents you want to list. Use empty string for root. + */ + longDesc: () => LocalizedString + } + recursive: { + /** + * Recursive + */ + displayName: () => LocalizedString + /** + * Include contents of subfolders + */ + shortDesc: () => LocalizedString + /** + * If enabled, also include files and folders from all subfolders recursively. */ longDesc: () => LocalizedString } @@ -212920,6906 +219135,6022 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Maximum number of saved replies to return + * Maximum number of items to return */ shortDesc: () => LocalizedString /** - * The maximum number of saved reply records to return. Default is 50. + * The maximum number of items to return. Default is 2000. */ longDesc: () => LocalizedString } } } - } - triggers: { - new_customer: { - groups: { - /** - * Customers - */ - '0': () => LocalizedString - } - /** - * New Customer - */ - displayName: () => LocalizedString - /** - * Triggers when a new customer is created - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a new customer is created in Help Scout. It provides the full customer profile including contact information, organization, and custom fields. - */ - longDesc: () => LocalizedString - options: { - } - } - updated_customer: { - groups: { - /** - * Customers - */ - '0': () => LocalizedString - } - /** - * Updated Customer - */ - displayName: () => LocalizedString - /** - * Triggers when a customer is updated - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a customer profile is updated in Help Scout. It provides the updated customer data including any changed fields. - */ - longDesc: () => LocalizedString - options: { - } - } - new_organization: { - groups: { - /** - * Organizations - */ - '0': () => LocalizedString - } - /** - * New Organization - */ - displayName: () => LocalizedString - /** - * Triggers when a new organization is created - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a new organization is created in Help Scout. Organizations help group customers from the same company. - */ - longDesc: () => LocalizedString - options: { - } - } - new_conversation: { + search: { groups: { /** - * Conversations + * Search */ '0': () => LocalizedString } /** - * New Conversation + * Search */ displayName: () => LocalizedString /** - * Triggers when a new conversation is created + * Search for files and folders in Dropbox */ shortDesc: () => LocalizedString /** - * This trigger fires whenever a new conversation (support ticket) is created in Help Scout. You can optionally filter by mailbox to only receive events from specific inboxes. + * Search for files and folders in your Dropbox by name or content. Returns matching items with their metadata. */ longDesc: () => LocalizedString options: { - mailboxId: { + query: { /** - * Mailbox + * Search Query */ displayName: () => LocalizedString /** - * Filter by mailbox + * Text to search for */ shortDesc: () => LocalizedString /** - * Optionally filter to only trigger for conversations in a specific mailbox. Leave empty to trigger for all mailboxes. + * The search query. Searches file and folder names. */ longDesc: () => LocalizedString } - } - } - assigned_conversation: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - } - /** - * Assigned Conversation - */ - displayName: () => LocalizedString - /** - * Triggers when a conversation is assigned - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a conversation is assigned to a user in Help Scout. This includes both new assignments and reassignments. - */ - longDesc: () => LocalizedString - options: { - mailboxId: { + path: { /** - * Mailbox + * Path */ displayName: () => LocalizedString /** - * Filter by mailbox + * Folder to search within */ shortDesc: () => LocalizedString /** - * Optionally filter to only trigger for conversations in a specific mailbox. Leave empty to trigger for all mailboxes. + * Optionally limit the search to a specific folder path. Leave empty to search all of Dropbox. */ longDesc: () => LocalizedString } - } - } - } - } - Hubspot: { - /** - * HubSpot - */ - displayName: () => LocalizedString - groups: { - /** - * CRM & Sales Management - */ - '0': () => LocalizedString - /** - * Email & Email Marketing - */ - '1': () => LocalizedString - } - /** - * Seamlessly connect to the HubSpot API to automate and streamline your CRM processes. - */ - shortDesc: () => LocalizedString - /** - * The HubSpot integration provides a comprehensive collection of actions and triggers to interact with the HubSpot API. Whether you need to manage companies, contacts, deals, or custom objects, this integration simplifies your workflow automation and CRM management. - */ - longDesc: () => LocalizedString - actions: { - 'post-crm-v3-objects-companies-batch-upsert_upsert': { - /** - * Create Or Update Companies - */ - displayName: () => LocalizedString - /** - * Create or update multiple companies - */ - shortDesc: () => LocalizedString - groups: { - /** - * Companies - */ - '0': () => LocalizedString - } - } - 'get-crm-v3-objects-contacts': { - /** - * List Contacts - */ - displayName: () => LocalizedString - /** - * Retrieve a list of contacts - */ - shortDesc: () => LocalizedString - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - } - 'post-crm-v3-objects-contacts': { - /** - * Create Contact - */ - displayName: () => LocalizedString - /** - * Create a new contact - */ - shortDesc: () => LocalizedString - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - options: { - associations: { + maxResults: { /** - * HubSpot Associations + * Max Results */ displayName: () => LocalizedString /** - * Define relationships between HubSpot objects + * Maximum number of results */ shortDesc: () => LocalizedString /** - * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. + * The maximum number of search results to return. Default is 100. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - to: { - /** - * Target Object - */ - displayName: () => LocalizedString - /** - * The HubSpot object to create an association with - */ - shortDesc: () => LocalizedString - /** - * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. - */ - longDesc: () => LocalizedString - type: { - fields: { - id: { - /** - * Object ID - */ - displayName: () => LocalizedString - /** - * Unique identifier of the target object - */ - shortDesc: () => LocalizedString - /** - * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. - */ - longDesc: () => LocalizedString - } - } - } - } - types: { - /** - * Association Types - */ - displayName: () => LocalizedString - /** - * Types of relationship between objects - */ - shortDesc: () => LocalizedString - /** - * Defines the nature and direction of the relationship between the two HubSpot objects being associated. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - associationTypeId: { - /** - * Association Type ID - */ - displayName: () => LocalizedString - /** - * Numeric identifier of the association type - */ - shortDesc: () => LocalizedString - /** - * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. - */ - longDesc: () => LocalizedString - } - associationCategory: { - /** - * Association Category - */ - displayName: () => LocalizedString - /** - * Category of the association type - */ - shortDesc: () => LocalizedString - /** - * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } - } - } } - } - } - 'post-crm-v3-objects-contacts-search': { - /** - * Search Contacts - */ - displayName: () => LocalizedString - /** - * Search for contacts based on specific criteria - */ - shortDesc: () => LocalizedString - /** - * Search for contacts based on specific criteria - */ - longDesc: () => LocalizedString - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - } - 'delete-crm-v3-objects-contacts-contactId': { - /** - * Delete Contact - */ - displayName: () => LocalizedString - /** - * Soft delete a selected contact - */ - shortDesc: () => LocalizedString - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - } - 'get-crm-v3-objects-contacts-contactId': { - /** - * Retrieve Contact - */ - displayName: () => LocalizedString - /** - * Retrieve a specific contact - */ - shortDesc: () => LocalizedString - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - } - 'patch-crm-v3-objects-contacts-contactId': { - /** - * Update Contact - */ - displayName: () => LocalizedString - /** - * Update an existing contact - */ - shortDesc: () => LocalizedString - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - } - 'get-crm-v3-objects-objectType_getPage': { - /** - * List Custom Objects - */ - displayName: () => LocalizedString - /** - * Retrieve a list of selected custom objects - */ - shortDesc: () => LocalizedString - groups: { - /** - * Custom Objects - */ - '0': () => LocalizedString - } - } - 'post-crm-v3-objects-objectType_create': { - /** - * Create Custom Object - */ - displayName: () => LocalizedString - /** - * Create a new custom object of a selected type - */ - shortDesc: () => LocalizedString - groups: { - /** - * Custom Objects - */ - '0': () => LocalizedString - } - options: { - associations: { + orderBy: { /** - * HubSpot Associations + * Order By */ displayName: () => LocalizedString /** - * Define relationships between HubSpot objects + * Sort order for results */ shortDesc: () => LocalizedString /** - * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. + * How to order the search results: by relevance or by modified time. + */ + longDesc: () => LocalizedString + } + fileStatus: { + /** + * File Status + */ + displayName: () => LocalizedString + /** + * Filter by file status + */ + shortDesc: () => LocalizedString + /** + * Filter search results by file status: active (existing files) or deleted (removed files). + */ + longDesc: () => LocalizedString + } + filenameOnly: { + /** + * Filename Only + */ + displayName: () => LocalizedString + /** + * Search only in file names + */ + shortDesc: () => LocalizedString + /** + * If enabled, search will only match file names, not file contents. + */ + longDesc: () => LocalizedString + } + fileExtensions: { + /** + * File Extensions + */ + displayName: () => LocalizedString + /** + * Filter by file extensions + */ + shortDesc: () => LocalizedString + /** + * Comma-separated list of file extensions to filter by (e.g., "pdf,doc,txt"). + */ + longDesc: () => LocalizedString + } + fileCategories: { + /** + * File Categories + */ + displayName: () => LocalizedString + /** + * Filter by file categories + */ + shortDesc: () => LocalizedString + /** + * Comma-separated list of file categories to filter by (e.g., "image,document,video"). */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - to: { - /** - * Target Object - */ - displayName: () => LocalizedString - /** - * The HubSpot object to create an association with - */ - shortDesc: () => LocalizedString - /** - * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. - */ - longDesc: () => LocalizedString - type: { - fields: { - id: { - /** - * Object ID - */ - displayName: () => LocalizedString - /** - * Unique identifier of the target object - */ - shortDesc: () => LocalizedString - /** - * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. - */ - longDesc: () => LocalizedString - } - } - } - } - types: { - /** - * Association Types - */ - displayName: () => LocalizedString - /** - * Types of relationship between objects - */ - shortDesc: () => LocalizedString - /** - * Defines the nature and direction of the relationship between the two HubSpot objects being associated. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - associationTypeId: { - /** - * Association Type ID - */ - displayName: () => LocalizedString - /** - * Numeric identifier of the association type - */ - shortDesc: () => LocalizedString - /** - * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. - */ - longDesc: () => LocalizedString - } - associationCategory: { - /** - * Association Category - */ - displayName: () => LocalizedString - /** - * Category of the association type - */ - shortDesc: () => LocalizedString - /** - * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } - } - } } } } - 'post-crm-v3-objects-objectType-batch-upsert': { - /** - * Create Or Update Custom Objects - */ - displayName: () => LocalizedString + create_shared_link: { groups: { /** - * Custom Objects + * Sharing */ '0': () => LocalizedString } - } - 'post-crm-v3-objects-objectType-search_doSearch': { /** - * Search Custom Objects + * Create Shared Link */ displayName: () => LocalizedString /** - * Search for custom objects based on specific criteria + * Create a shared link for a file */ shortDesc: () => LocalizedString /** - * Search for custom objects based on specific criteria + * Create a shared link for a file in your Dropbox that can be shared with others. You can configure visibility and expiration settings. */ longDesc: () => LocalizedString - groups: { - /** - * Custom Objects - */ - '0': () => LocalizedString - } - } - 'delete-crm-v3-objects-objectType-objectId_archive': { - /** - * Delete Custom Object - */ - displayName: () => LocalizedString - /** - * Soft delete a selected custom object - */ - shortDesc: () => LocalizedString - groups: { - /** - * Custom Objects - */ - '0': () => LocalizedString - } - } - 'get-crm-v3-objects-objectType-objectId_getById': { - /** - * Retrieve Custom Object - */ - displayName: () => LocalizedString - /** - * Retrieve a specific custom object - */ - shortDesc: () => LocalizedString - groups: { - /** - * Custom Objects - */ - '0': () => LocalizedString - } - } - 'patch-crm-v3-objects-objectType-objectId_update': { - /** - * Update Custom Object - */ - displayName: () => LocalizedString - /** - * Update an existing custom object - */ - shortDesc: () => LocalizedString - groups: { - /** - * Custom Objects - */ - '0': () => LocalizedString - } - } - 'get-crm-v3-objects-deals_getPage': { - /** - * List Deals - */ - displayName: () => LocalizedString - /** - * Retrieve a list of deals - */ - shortDesc: () => LocalizedString - groups: { - /** - * Deals - */ - '0': () => LocalizedString - } - } - 'post-crm-v3-objects-deals_create': { - /** - * Create Deal - */ - displayName: () => LocalizedString - /** - * Create a new deal - */ - shortDesc: () => LocalizedString - groups: { - /** - * Deals - */ - '0': () => LocalizedString - } options: { - associations: { + path: { /** - * HubSpot Associations + * File Path */ displayName: () => LocalizedString /** - * Define relationships between HubSpot objects + * Path to the file to share */ shortDesc: () => LocalizedString /** - * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. + * The full path to the file for which you want to create a shared link. + */ + longDesc: () => LocalizedString + } + requested_visibility: { + /** + * Visibility + */ + displayName: () => LocalizedString + /** + * Who can access this link + */ + shortDesc: () => LocalizedString + /** + * The visibility level for the shared link: public (anyone), team_only (team members), or password (requires password). + */ + longDesc: () => LocalizedString + } + expires: { + /** + * Expiration Date + */ + displayName: () => LocalizedString + /** + * When the link expires + */ + shortDesc: () => LocalizedString + /** + * Optional expiration date for the link in ISO 8601 format (e.g., "2024-12-31T23:59:59Z"). */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - to: { - /** - * Target Object - */ - displayName: () => LocalizedString - /** - * The HubSpot object to create an association with - */ - shortDesc: () => LocalizedString - /** - * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. - */ - longDesc: () => LocalizedString - type: { - fields: { - id: { - /** - * Object ID - */ - displayName: () => LocalizedString - /** - * Unique identifier of the target object - */ - shortDesc: () => LocalizedString - /** - * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. - */ - longDesc: () => LocalizedString - } - } - } - } - types: { - /** - * Association Types - */ - displayName: () => LocalizedString - /** - * Types of relationship between objects - */ - shortDesc: () => LocalizedString - /** - * Defines the nature and direction of the relationship between the two HubSpot objects being associated. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - associationTypeId: { - /** - * Association Type ID - */ - displayName: () => LocalizedString - /** - * Numeric identifier of the association type - */ - shortDesc: () => LocalizedString - /** - * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. - */ - longDesc: () => LocalizedString - } - associationCategory: { - /** - * Association Category - */ - displayName: () => LocalizedString - /** - * Category of the association type - */ - shortDesc: () => LocalizedString - /** - * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } - } - } } } } - 'post-crm-v3-objects-deals-batch-upsert_upsert': { - /** - * Create Or Update Deals - */ - displayName: () => LocalizedString - groups: { - /** - * Deals - */ - '0': () => LocalizedString - } - } - 'post-crm-v3-objects-deals-search_doSearch': { - /** - * Search Deals - */ - displayName: () => LocalizedString - /** - * Search for deals based on specific criteria - */ - shortDesc: () => LocalizedString - /** - * Search for deals based on specific criteria - */ - longDesc: () => LocalizedString - groups: { - /** - * Deals - */ - '0': () => LocalizedString - } - } - 'delete-crm-v3-objects-deals-dealId_archive': { - /** - * Delete a Deal - */ - displayName: () => LocalizedString - /** - * Soft delete a selected deal - */ - shortDesc: () => LocalizedString - groups: { - /** - * Deals - */ - '0': () => LocalizedString - } - } - 'get-crm-v3-objects-deals-dealId_getById': { - /** - * Retrieve Deal - */ - displayName: () => LocalizedString - /** - * Retrieve a specific deal - */ - shortDesc: () => LocalizedString - groups: { - /** - * Deals - */ - '0': () => LocalizedString - } - } - 'patch-crm-v3-objects-deals-dealId_update': { - /** - * Update Deal - */ - displayName: () => LocalizedString - /** - * Update an existing deal - */ - shortDesc: () => LocalizedString + list_shared_links: { groups: { /** - * Deals + * Sharing */ '0': () => LocalizedString } - } - 'get-crm-v3-objects-leads_getPage': { /** - * List Leads + * List Shared Links */ displayName: () => LocalizedString /** - * Retrieve a list of leads + * List shared links for a file or all files */ shortDesc: () => LocalizedString - groups: { - /** - * Leads - */ - '0': () => LocalizedString - } - } - 'post-crm-v3-objects-leads_create': { - /** - * Create Lead - */ - displayName: () => LocalizedString /** - * Create a new lead + * Retrieve a list of shared links. You can list all shared links or filter to a specific file path. */ - shortDesc: () => LocalizedString - groups: { - /** - * Leads - */ - '0': () => LocalizedString - } + longDesc: () => LocalizedString options: { - associations: { + path: { /** - * HubSpot Associations + * File Path */ displayName: () => LocalizedString /** - * Define relationships between HubSpot objects + * Filter by file path */ shortDesc: () => LocalizedString /** - * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. + * Optionally specify a file path to list only shared links for that file. Leave empty to list all shared links. + */ + longDesc: () => LocalizedString + } + direct_only: { + /** + * Direct Only + */ + displayName: () => LocalizedString + /** + * Return only direct links + */ + shortDesc: () => LocalizedString + /** + * If enabled, only return shared links that directly reference the file, not links to parent folders. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - to: { - /** - * Target Object - */ - displayName: () => LocalizedString - /** - * The HubSpot object to create an association with - */ - shortDesc: () => LocalizedString - /** - * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. - */ - longDesc: () => LocalizedString - type: { - fields: { - id: { - /** - * Object ID - */ - displayName: () => LocalizedString - /** - * Unique identifier of the target object - */ - shortDesc: () => LocalizedString - /** - * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. - */ - longDesc: () => LocalizedString - } - } - } - } - types: { - /** - * Association Types - */ - displayName: () => LocalizedString - /** - * Types of relationship between objects - */ - shortDesc: () => LocalizedString - /** - * Defines the nature and direction of the relationship between the two HubSpot objects being associated. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - associationTypeId: { - /** - * Association Type ID - */ - displayName: () => LocalizedString - /** - * Numeric identifier of the association type - */ - shortDesc: () => LocalizedString - /** - * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. - */ - longDesc: () => LocalizedString - } - associationCategory: { - /** - * Association Category - */ - displayName: () => LocalizedString - /** - * Category of the association type - */ - shortDesc: () => LocalizedString - /** - * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } - } - } } } } - 'post-crm-v3-objects-leads-batch-upsert_upsert': { - /** - * Create Or Update Leads - */ - displayName: () => LocalizedString + revoke_shared_link: { groups: { /** - * Leads + * Sharing */ '0': () => LocalizedString } - } - 'post-crm-v3-objects-leads-search_doSearch': { /** - * Search Leads + * Revoke Shared Link */ displayName: () => LocalizedString /** - * Search for leads based on specific criteria + * Revoke a shared link */ shortDesc: () => LocalizedString /** - * Search for leads based on specific criteria + * Revoke a shared link so it can no longer be used to access the file. This action cannot be undone. */ longDesc: () => LocalizedString - groups: { - /** - * Leads - */ - '0': () => LocalizedString + options: { + url: { + /** + * Shared Link URL + */ + displayName: () => LocalizedString + /** + * The URL of the shared link to revoke + */ + shortDesc: () => LocalizedString + /** + * The full URL of the shared link you want to revoke. + */ + longDesc: () => LocalizedString + } } } - 'delete-crm-v3-objects-leads-leadsId_archive': { - /** - * Delete Lead - */ - displayName: () => LocalizedString - /** - * Soft delete a selected lead - */ - shortDesc: () => LocalizedString + list_file_revisions: { groups: { /** - * Leads + * Revisions */ '0': () => LocalizedString } - } - 'get-crm-v3-objects-leads-leadsId_getById': { /** - * Retrieve Lead + * List File Revisions */ displayName: () => LocalizedString /** - * Retrieve a specific lead + * List revision history for a file */ shortDesc: () => LocalizedString - groups: { - /** - * Leads - */ - '0': () => LocalizedString - } - } - 'patch-crm-v3-objects-leads-leadsId_update': { - /** - * Update Lead - */ - displayName: () => LocalizedString /** - * Update an existing lead + * Retrieve a list of all revisions (versions) of a file. This allows you to see the history of changes to the file. */ - shortDesc: () => LocalizedString - groups: { - /** - * Leads - */ - '0': () => LocalizedString + longDesc: () => LocalizedString + options: { + path: { + /** + * File Path + */ + displayName: () => LocalizedString + /** + * Path to the file + */ + shortDesc: () => LocalizedString + /** + * The full path to the file whose revisions you want to list. + */ + longDesc: () => LocalizedString + } + mode: { + /** + * Mode + */ + displayName: () => LocalizedString + /** + * How to identify the file + */ + shortDesc: () => LocalizedString + /** + * How the path parameter identifies the file: "path" (by file path) or "id" (by file ID). + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of revisions + */ + shortDesc: () => LocalizedString + /** + * The maximum number of revisions to return. Default is 10. + */ + longDesc: () => LocalizedString + } } } - 'get-crm-v3-objects-products_getPage': { - /** - * List Products - */ - displayName: () => LocalizedString - /** - * Retrieve a list of products - */ - shortDesc: () => LocalizedString + restore_file_revision: { groups: { /** - * Products + * Revisions */ '0': () => LocalizedString } - } - 'post-crm-v3-objects-products_create': { /** - * Create Product + * Restore File Revision */ displayName: () => LocalizedString /** - * Create a new product + * Restore a file to a previous revision */ shortDesc: () => LocalizedString - groups: { - /** - * Products - */ - '0': () => LocalizedString - } + /** + * Restore a file to a previous revision (version). This creates a new revision with the content from the specified revision. + */ + longDesc: () => LocalizedString options: { - associations: { + path: { /** - * HubSpot Associations + * File Path */ displayName: () => LocalizedString /** - * Define relationships between HubSpot objects + * Path to the file */ shortDesc: () => LocalizedString /** - * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. + * The full path to the file you want to restore. + */ + longDesc: () => LocalizedString + } + rev: { + /** + * Revision + */ + displayName: () => LocalizedString + /** + * Revision ID to restore + */ + shortDesc: () => LocalizedString + /** + * The revision identifier (rev) of the version you want to restore. Get this from list_file_revisions. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - to: { - /** - * Target Object - */ - displayName: () => LocalizedString - /** - * The HubSpot object to create an association with - */ - shortDesc: () => LocalizedString - /** - * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. - */ - longDesc: () => LocalizedString - type: { - fields: { - id: { - /** - * Object ID - */ - displayName: () => LocalizedString - /** - * Unique identifier of the target object - */ - shortDesc: () => LocalizedString - /** - * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. - */ - longDesc: () => LocalizedString - } - } - } - } - types: { - /** - * Association Types - */ - displayName: () => LocalizedString - /** - * Types of relationship between objects - */ - shortDesc: () => LocalizedString - /** - * Defines the nature and direction of the relationship between the two HubSpot objects being associated. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - associationTypeId: { - /** - * Association Type ID - */ - displayName: () => LocalizedString - /** - * Numeric identifier of the association type - */ - shortDesc: () => LocalizedString - /** - * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. - */ - longDesc: () => LocalizedString - } - associationCategory: { - /** - * Association Category - */ - displayName: () => LocalizedString - /** - * Category of the association type - */ - shortDesc: () => LocalizedString - /** - * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } - } - } } } } - 'post-crm-v3-objects-products-batch-upsert_upsert': { - /** - * Create Or Update Products - */ - displayName: () => LocalizedString + } + triggers: { + new_file: { groups: { /** - * Products + * Files */ '0': () => LocalizedString } - } - 'post-crm-v3-objects-products-search_doSearch': { /** - * Search Products + * New File */ displayName: () => LocalizedString /** - * Search for products based on specific criteria + * Triggers when a new file is added to a folder */ shortDesc: () => LocalizedString /** - * Search for products based on specific criteria + * This trigger fires whenever a new file is created in the specified folder. Monitor for new uploads, file creations, or files moved into the folder. */ longDesc: () => LocalizedString - groups: { - /** - * Products - */ - '0': () => LocalizedString + options: { + folder: { + /** + * Folder Path + */ + displayName: () => LocalizedString + /** + * The folder to monitor for new files + */ + shortDesc: () => LocalizedString + /** + * Specify the path to the folder you want to monitor for new files. Use empty string for root folder. + */ + longDesc: () => LocalizedString + } } } - 'delete-crm-v3-objects-products-productId_archive': { - /** - * Delete Product - */ - displayName: () => LocalizedString - /** - * Soft delete a selected product - */ - shortDesc: () => LocalizedString + new_folder: { groups: { /** - * Products + * Folders */ '0': () => LocalizedString } - } - 'get-crm-v3-objects-products-productId_getById': { /** - * Retrieve Product + * New Folder */ displayName: () => LocalizedString /** - * Retrieve a specific product + * Triggers when a new folder is created */ shortDesc: () => LocalizedString + /** + * This trigger fires whenever a new folder is created within the specified parent folder. + */ + longDesc: () => LocalizedString + options: { + parentFolder: { + /** + * Parent Folder + */ + displayName: () => LocalizedString + /** + * The parent folder to monitor + */ + shortDesc: () => LocalizedString + /** + * Specify the path to the parent folder you want to monitor for new subfolders. + */ + longDesc: () => LocalizedString + } + } + } + file_modified: { groups: { /** - * Products + * Files */ '0': () => LocalizedString } - } - 'patch-crm-v3-objects-products-productId_update': { /** - * Update Product + * File Modified */ displayName: () => LocalizedString /** - * Update an existing product + * Triggers when a file is modified */ shortDesc: () => LocalizedString - groups: { - /** - * Products - */ - '0': () => LocalizedString + /** + * This trigger fires whenever a file is modified in the specified folder. This includes content changes, not just metadata updates. + */ + longDesc: () => LocalizedString + options: { + folder: { + /** + * Folder Path + */ + displayName: () => LocalizedString + /** + * The folder to monitor for modified files + */ + shortDesc: () => LocalizedString + /** + * Specify the path to the folder you want to monitor for file modifications. + */ + longDesc: () => LocalizedString + } } } - 'get-crm-v3-objects-tickets_getPage': { + } + } + NetSuite: { + /** + * NetSuite + */ + displayName: () => LocalizedString + groups: { + /** + * Accounting & ERP + */ + '0': () => LocalizedString + } + /** + * A comprehensive suite of cloud-based business management solutions. + */ + shortDesc: () => LocalizedString + /** + * NetSuite offers a unified platform for ERP, CRM, e-commerce, and more, enabling businesses to manage all key operations in a single system. + */ + longDesc: () => LocalizedString + triggers: { + new_record: { /** - * List Tickets + * New Record */ displayName: () => LocalizedString /** - * Retrieve a list of tickets + * Triggers when a new record is created */ shortDesc: () => LocalizedString + /** + * Triggers when a new record is created + */ + longDesc: () => LocalizedString + options: { + recordType: { + /** + * Record Type + */ + displayName: () => LocalizedString + /** + * The type of record to monitor + */ + shortDesc: () => LocalizedString + /** + * The type of record to monitor + */ + longDesc: () => LocalizedString + } + } + } + } + actions: { + list_records: { groups: { /** - * Tickets + * Data & Search */ '0': () => LocalizedString } - } - 'post-crm-v3-objects-tickets_create': { /** - * Create Ticket + * List Records */ displayName: () => LocalizedString /** - * Create a new ticket + * Retrieve NetSuite records based on search criteria */ shortDesc: () => LocalizedString - groups: { - /** - * Tickets - */ - '0': () => LocalizedString - } + /** + * Query NetSuite records by type with optional filtering, field selection, and pagination + */ + longDesc: () => LocalizedString options: { - associations: { + recordType: { /** - * HubSpot Associations + * Record Type */ displayName: () => LocalizedString /** - * Define relationships between HubSpot objects + * Type of NetSuite record to retrieve */ shortDesc: () => LocalizedString /** - * Associations create connections between different HubSpot objects such as contacts, companies, deals, tickets, and custom objects. + * Specifies which NetSuite record type to query (customer, invoice, transaction, etc.) + */ + longDesc: () => LocalizedString + } + searchMode: { + /** + * Search Mode + */ + displayName: () => LocalizedString + /** + * How multiple search criteria are combined + */ + shortDesc: () => LocalizedString + /** + * Determines if records must match all criteria (All) or any criteria (Any) when multiple query fields are provided + */ + longDesc: () => LocalizedString + } + fields: { + /** + * Fields + */ + displayName: () => LocalizedString + /** + * Specific record fields to return + */ + shortDesc: () => LocalizedString + /** + * List of field names to include in results (returns all fields if omitted) + */ + longDesc: () => LocalizedString + } + query: { + /** + * Query Criteria + */ + displayName: () => LocalizedString + /** + * Search conditions for filtering records + */ + shortDesc: () => LocalizedString + /** + * Key-value pairs defining search criteria */ longDesc: () => LocalizedString type: { element_type: { fields: { - to: { + key: { /** - * Target Object + * Field Name */ displayName: () => LocalizedString /** - * The HubSpot object to create an association with + * Name of the field to filter by */ shortDesc: () => LocalizedString /** - * Specifies the target HubSpot object (company, contact, deal, etc.) that will be associated with the current object. + * The name of the field to filter by */ longDesc: () => LocalizedString - type: { - fields: { - id: { - /** - * Object ID - */ - displayName: () => LocalizedString - /** - * Unique identifier of the target object - */ - shortDesc: () => LocalizedString - /** - * The unique identifier (ID) of the HubSpot object being associated with. This could be a company ID, contact ID, deal ID, etc. - */ - longDesc: () => LocalizedString - } - } - } } - types: { + value: { /** - * Association Types + * Field Value */ displayName: () => LocalizedString /** - * Types of relationship between objects + * Value to match for the field */ shortDesc: () => LocalizedString /** - * Defines the nature and direction of the relationship between the two HubSpot objects being associated. + * The value to match for the field */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - associationTypeId: { - /** - * Association Type ID - */ - displayName: () => LocalizedString - /** - * Numeric identifier of the association type - */ - shortDesc: () => LocalizedString - /** - * A numeric ID that defines the type of association (e.g., 1 for company-to-contact, 3 for deal-to-contact). Each ID represents a specific directional relationship between two object types. - */ - longDesc: () => LocalizedString - } - associationCategory: { - /** - * Association Category - */ - displayName: () => LocalizedString - /** - * Category of the association type - */ - shortDesc: () => LocalizedString - /** - * Categorizes the association as either "HUBSPOT_DEFINED" (built-in system associations) or "USER_DEFINED" (custom associations created by users). Most standard associations use HUBSPOT_DEFINED. - */ - longDesc: () => LocalizedString - } - } - } - } } } } } } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of records to return + */ + shortDesc: () => LocalizedString + /** + * Caps the number of results returned in a single query + */ + longDesc: () => LocalizedString + } + offset: { + /** + * Offset + */ + displayName: () => LocalizedString + /** + * Number of records to skip + */ + shortDesc: () => LocalizedString + /** + * Used for pagination to skip a specified number of records in the result set + */ + longDesc: () => LocalizedString + } } } - 'post-crm-v3-objects-tickets-batch-upsert_upsert': { - /** - * Create Or Update Tickets - */ - displayName: () => LocalizedString + suite_ql: { groups: { /** - * Tickets + * Data & Search */ '0': () => LocalizedString } - } - 'post-crm-v3-objects-tickets-search_doSearch': { /** - * Search Tickets + * SuiteQL */ displayName: () => LocalizedString /** - * Search for tickets based on specific criteria + * Run a SuiteQL query */ shortDesc: () => LocalizedString /** - * Search for tickets based on specific criteria + * Run a SuiteQL query */ longDesc: () => LocalizedString - groups: { - /** - * Tickets - */ - '0': () => LocalizedString - } - } - 'delete-crm-v3-objects-tickets-ticketId_archive': { - /** - * Delete Ticket - */ - displayName: () => LocalizedString - /** - * Soft delete a selected ticket - */ - shortDesc: () => LocalizedString - groups: { - /** - * Tickets - */ - '0': () => LocalizedString + options: { + query: { + /** + * Query + */ + displayName: () => LocalizedString + /** + * The SuiteQL query to run + */ + shortDesc: () => LocalizedString + /** + * The SuiteQL query to run + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * The maximum number of records to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of records to return + */ + longDesc: () => LocalizedString + } + offset: { + /** + * Offset + */ + displayName: () => LocalizedString + /** + * The number of records to skip + */ + shortDesc: () => LocalizedString + /** + * The number of records to skip + */ + longDesc: () => LocalizedString + } + response_type: { + fields: { + links: { + /** + * Links + */ + display_name: () => LocalizedString + /** + * Links + */ + short_desc: () => LocalizedString + /** + * Links + */ + desc: () => LocalizedString + } + count: { + /** + * Count + */ + display_name: () => LocalizedString + /** + * The number of results + */ + short_desc: () => LocalizedString + /** + * The number of results + */ + desc: () => LocalizedString + } + hasMore: { + /** + * Has More + */ + display_name: () => LocalizedString + /** + * Whether there are more results + */ + short_desc: () => LocalizedString + /** + * Whether there are more results + */ + desc: () => LocalizedString + } + items: { + /** + * Items + */ + display_name: () => LocalizedString + /** + * The items + */ + short_desc: () => LocalizedString + /** + * The items + */ + desc: () => LocalizedString + } + } + } } } - 'get-crm-v3-objects-tickets-ticketId_getById': { - /** - * Retrieve Ticket - */ - displayName: () => LocalizedString - /** - * Retrieve a specific ticket - */ - shortDesc: () => LocalizedString + account_get: { groups: { /** - * Tickets + * Accounting */ '0': () => LocalizedString } - } - 'patch-crm-v3-objects-tickets-ticketId_update': { /** - * Update Ticket + * Get List of Accounts */ displayName: () => LocalizedString /** - * Update an existing ticket + * Retrieve a list of accounts. */ shortDesc: () => LocalizedString - groups: { - /** - * Tickets - */ - '0': () => LocalizedString - } - } - 'get-crm-v3-objects-users': { - /** - * List Users - */ - displayName: () => LocalizedString /** - * Retrieve a list of users + * Fetches a list of accounts based on specified filters. */ - shortDesc: () => LocalizedString - groups: { - /** - * Users - */ - '0': () => LocalizedString - } + longDesc: () => LocalizedString } - 'post-crm-v3-objects-users-batch-upsert': { - /** - * Create Or Update Users - */ - displayName: () => LocalizedString + account_post: { groups: { /** - * Users + * Accounting */ '0': () => LocalizedString } - } - 'post-crm-v3-objects-users-search': { /** - * Search Users + * Create Account */ displayName: () => LocalizedString /** - * Search for users based on specific criteria + * Creates a new account. */ shortDesc: () => LocalizedString /** - * Search for users based on specific criteria + * Allows the user to create a new account record in NetSuite. */ longDesc: () => LocalizedString - groups: { - /** - * Users - */ - '0': () => LocalizedString - } - } - 'get-crm-v3-objects-users-userId': { - /** - * Retrieve User - */ - displayName: () => LocalizedString - /** - * Retrieve a specific user - */ - shortDesc: () => LocalizedString - groups: { - /** - * Users - */ - '0': () => LocalizedString - } } - 'patch-crm-v3-objects-users-userId': { - /** - * Update User - */ - displayName: () => LocalizedString - /** - * Update an existing user - */ - shortDesc: () => LocalizedString + account_id_get: { groups: { /** - * Users + * Accounting */ '0': () => LocalizedString } - } - create_list: { /** - * Create List + * Get Account */ displayName: () => LocalizedString /** - * Create a new HubSpot list + * Retrieve details of a specific account. */ shortDesc: () => LocalizedString /** - * Creates a new list in HubSpot CRM with the specified configuration and properties. + * Fetches detailed information of a single account by its ID. */ longDesc: () => LocalizedString + } + account_id_patch: { groups: { /** - * Lists + * Accounting */ '0': () => LocalizedString } - } - search_lists: { /** - * Search Lists + * Update Account */ displayName: () => LocalizedString /** - * Search for HubSpot lists + * Updates an existing account. */ shortDesc: () => LocalizedString /** - * Search and retrieve HubSpot lists based on specified criteria and filters. + * Allows the user to update details of a specific account by its ID. */ longDesc: () => LocalizedString + } + account_id_delete: { groups: { /** - * Lists + * Accounting */ '0': () => LocalizedString } - } - delete_list: { /** - * Delete List + * Delete Account */ displayName: () => LocalizedString /** - * Delete a HubSpot list + * Deletes a specific account. */ shortDesc: () => LocalizedString /** - * Permanently removes a specified list from HubSpot CRM by its ID. + * Removes an account record from NetSuite based on its ID. */ longDesc: () => LocalizedString + } + customer_get: { groups: { /** - * Lists + * CRM */ '0': () => LocalizedString } - } - get_list: { /** - * Get List + * Get List of Customers */ displayName: () => LocalizedString /** - * Retrieve a HubSpot list by ID + * Retrieve a list of customers. */ shortDesc: () => LocalizedString /** - * Fetches detailed information about a specific HubSpot list using its unique identifier. + * Fetches a list of customers based on specified filters. */ longDesc: () => LocalizedString + } + customer_post: { groups: { /** - * Lists + * CRM */ '0': () => LocalizedString } - } - add_memberships: { /** - * Add List Records + * Create Customer */ displayName: () => LocalizedString /** - * Add records to a HubSpot list + * Creates a new customer. */ shortDesc: () => LocalizedString /** - * Adds specified records as members to an existing HubSpot list. + * Allows the user to create a new customer record in NetSuite. */ longDesc: () => LocalizedString + } + customer_id_get: { groups: { /** - * Lists + * CRM */ '0': () => LocalizedString } - } - add_members_from_source_list: { /** - * Add Records from another list + * Get Customer */ displayName: () => LocalizedString /** - * Copy all members from one list to another + * Retrieve details of a specific customer. */ shortDesc: () => LocalizedString /** - * Adds all members from a source HubSpot list to a target list, effectively copying the membership. + * Fetches detailed information of a single customer by its ID. */ longDesc: () => LocalizedString + } + customer_id_patch: { groups: { /** - * Lists + * CRM */ '0': () => LocalizedString } - } - remove_members_from_list: { /** - * Remove List Records + * Update Customer */ displayName: () => LocalizedString /** - * Remove records from a HubSpot list + * Updates an existing customer. */ shortDesc: () => LocalizedString /** - * Removes specified records from an existing HubSpot list membership. + * Allows the user to update details of a specific customer by its ID. */ longDesc: () => LocalizedString + } + customer_id_delete: { groups: { /** - * Lists + * CRM */ '0': () => LocalizedString } - } - get_list_records: { /** - * Get List Records + * Delete Customer */ displayName: () => LocalizedString /** - * Retrieve records from a HubSpot list with pagination and property filtering. + * Deletes a specific customer. */ shortDesc: () => LocalizedString /** - * Fetches records from a specified HubSpot list, including support for pagination using before/after cursors and filtering by specific properties. Returns the actual record data along with pagination metadata. + * Removes a customer record from NetSuite based on its ID. */ longDesc: () => LocalizedString + } + contact_get: { groups: { /** - * Lists + * CRM */ '0': () => LocalizedString } - options: { - listId: { - /** - * List ID - */ - displayName: () => LocalizedString - /** - * The HubSpot list to retrieve records from - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the HubSpot list to fetch records from. - */ - longDesc: () => LocalizedString - } - after: { - /** - * After - */ - displayName: () => LocalizedString - /** - * Pagination cursor for next page - */ - shortDesc: () => LocalizedString - /** - * Cursor value to retrieve records after this point. Used for forward pagination. - */ - longDesc: () => LocalizedString - } - before: { - /** - * Before - */ - displayName: () => LocalizedString - /** - * Pagination cursor for previous page - */ - shortDesc: () => LocalizedString - /** - * Cursor value to retrieve records before this point. Used for backward pagination. - */ - longDesc: () => LocalizedString - } - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * Maximum number of records to return - */ - shortDesc: () => LocalizedString - /** - * The maximum number of records to return in a single request. Default is 100. - */ - longDesc: () => LocalizedString - } - properties: { - /** - * Properties - */ - displayName: () => LocalizedString - /** - * List of properties to include - */ - shortDesc: () => LocalizedString - /** - * Specific properties to include in the response for each record. If not specified, default properties will be returned. - */ - longDesc: () => LocalizedString - } - } - } - } - triggers: { - hubspot_company_created_or_updated_trigger: { - event_info: { - /** - * Company Information - */ - desc: () => LocalizedString - } /** - * Company Created or Updated + * Get List of Contacts */ displayName: () => LocalizedString /** - * Triggers when a company is added or updated in HubSpot. + * Retrieve a list of contacts. */ shortDesc: () => LocalizedString /** - * This trigger activates whenever a company record is created or modified in HubSpot, enabling you to automate workflows based on company data changes. + * Fetches a list of contacts based on specified filters. */ longDesc: () => LocalizedString - options: { - activationCriteria: { - /** - * Activation Criteria - */ - displayName: () => LocalizedString - /** - * Criteria for trigger to activate (created or updated) - */ - shortDesc: () => LocalizedString - /** - * Select the criteria for the trigger to activate. - - - Created: Triggers when a new object is created - - Updated: Triggers when an existing object is updated - */ - longDesc: () => LocalizedString - } - additionalProperties: { - /** - * Additional Properties - */ - displayName: () => LocalizedString - /** - * Additional properties to add to returned data - */ - shortDesc: () => LocalizedString - /** - * Select additional properties to add to the returned object data - */ - longDesc: () => LocalizedString - } - } } - hubspot_contact_created_or_updated_trigger: { - event_info: { + contact_post: { + groups: { /** - * Contact Information + * CRM */ - desc: () => LocalizedString + '0': () => LocalizedString } /** - * Contact Created or Updated + * Create Contact */ displayName: () => LocalizedString /** - * Triggers when a contact is added or updated in HubSpot. + * Creates a new contact. */ shortDesc: () => LocalizedString /** - * Activate workflows whenever a new contact is created or an existing contact is updated within HubSpot. Ideal for managing customer information efficiently. + * Allows the user to create a new contact record in NetSuite. */ longDesc: () => LocalizedString - options: { - activationCriteria: { - /** - * Activation Criteria - */ - displayName: () => LocalizedString - /** - * Criteria for trigger to activate (created or updated) - */ - shortDesc: () => LocalizedString - /** - * Select the criteria for the trigger to activate. - - - Created: Triggers when a new object is created - - Updated: Triggers when an existing object is updated - */ - longDesc: () => LocalizedString - } - additionalProperties: { - /** - * Additional Properties - */ - displayName: () => LocalizedString - /** - * Additional properties to add to returned data - */ - shortDesc: () => LocalizedString - /** - * Select additional properties to add to the returned object data - */ - longDesc: () => LocalizedString - } - } } - hubspot_custom_object_created_or_updated_trigger: { - event_info: { + contact_id_delete: { + groups: { /** - * Custom Object Information + * CRM */ - desc: () => LocalizedString + '0': () => LocalizedString } /** - * Custom Object Created or Updated + * Delete Contact */ displayName: () => LocalizedString /** - * Triggers when a custom object is added or updated in HubSpot. + * Deletes a specific contact. */ shortDesc: () => LocalizedString /** - * Use this trigger to capture changes to custom objects in HubSpot, ensuring that updates to custom data structures are processed immediately for automation or integration. + * Removes a contact record from NetSuite based on its ID. */ longDesc: () => LocalizedString - options: { - activationCriteria: { - /** - * Activation Criteria - */ - displayName: () => LocalizedString - /** - * Criteria for trigger to activate (created or updated) - */ - shortDesc: () => LocalizedString - /** - * Select the criteria for the trigger to activate. - - - Created: Triggers when a new object is created - - Updated: Triggers when an existing object is updated - */ - longDesc: () => LocalizedString - } - additionalProperties: { - /** - * Additional Properties - */ - displayName: () => LocalizedString - /** - * Additional properties to add to returned data - */ - shortDesc: () => LocalizedString - /** - * Select additional properties to add to the returned object data - */ - longDesc: () => LocalizedString - } - object: { - /** - * Object - */ - displayName: () => LocalizedString - /** - * The custom object to monitor for changes. - */ - shortDesc: () => LocalizedString - /** - * Select the custom object you want to monitor for new or updated records. - */ - longDesc: () => LocalizedString - } - } } - hubspot_deal_created_or_updated_trigger: { - event_info: { + contact_id_get: { + groups: { /** - * Deal Information + * CRM */ - desc: () => LocalizedString + '0': () => LocalizedString } /** - * Deal Created or Updated + * Get Contact */ displayName: () => LocalizedString /** - * Triggers when a deal is created or updated in HubSpot. + * Retrieve details of a specific contact. */ shortDesc: () => LocalizedString /** - * This trigger fires when a deal is created or modified in HubSpot, allowing you to track sales opportunities and integrate with your sales pipeline automation workflows. + * Fetches detailed information of a single contact by its ID. */ longDesc: () => LocalizedString - options: { - activationCriteria: { - /** - * Activation Criteria - */ - displayName: () => LocalizedString - /** - * Criteria for trigger to activate (created or updated) - */ - shortDesc: () => LocalizedString - /** - * Select the criteria for the trigger to activate. - - - Created: Triggers when a new object is created - - Updated: Triggers when an existing object is updated - */ - longDesc: () => LocalizedString - } - additionalProperties: { - /** - * Additional Properties - */ - displayName: () => LocalizedString - /** - * Additional properties to add to returned data - */ - shortDesc: () => LocalizedString - /** - * Select additional properties to add to the returned object data - */ - longDesc: () => LocalizedString - } - } } - hubspot_lead_created_or_updated_trigger: { - event_info: { + contact_id_patch: { + groups: { /** - * Lead Information + * CRM */ - desc: () => LocalizedString + '0': () => LocalizedString } /** - * Lead Created or Updated + * Update Contact */ displayName: () => LocalizedString /** - * Triggers when a lead is added or updated in HubSpot. + * Updates an existing contact. */ shortDesc: () => LocalizedString /** - * Monitor new leads and updates to existing leads in HubSpot with this trigger, enabling efficient lead management and follow-up processes. + * Allows the user to update details of a specific contact by its ID. */ longDesc: () => LocalizedString - options: { - activationCriteria: { - /** - * Activation Criteria - */ - displayName: () => LocalizedString - /** - * Criteria for trigger to activate (created or updated) - */ - shortDesc: () => LocalizedString - /** - * Select the criteria for the trigger to activate. - - - Created: Triggers when a new object is created - - Updated: Triggers when an existing object is updated - */ - longDesc: () => LocalizedString - } - additionalProperties: { - /** - * Additional Properties - */ - displayName: () => LocalizedString - /** - * Additional properties to add to returned data - */ - shortDesc: () => LocalizedString - /** - * Select additional properties to add to the returned object data - */ - longDesc: () => LocalizedString - } - } } - hubspot_product_created_or_updated_trigger: { - event_info: { + opportunity_get: { + groups: { /** - * Product Information + * CRM */ - desc: () => LocalizedString + '0': () => LocalizedString } /** - * Product Created or Updated + * Get List of Opportunities */ displayName: () => LocalizedString /** - * Triggers when a product is added or updated in HubSpot. + * Retrieve a list of opportunities. */ shortDesc: () => LocalizedString /** - * This trigger alerts you to any new or updated products within your HubSpot account, ensuring that your product data remains synchronized with your workflows and external systems. + * Fetches a list of opportunities based on specified filters. */ longDesc: () => LocalizedString - options: { - activationCriteria: { - /** - * Activation Criteria - */ - displayName: () => LocalizedString - /** - * Criteria for trigger to activate (created or updated) - */ - shortDesc: () => LocalizedString - /** - * Select the criteria for the trigger to activate. - - - Created: Triggers when a new object is created - - Updated: Triggers when an existing object is updated - */ - longDesc: () => LocalizedString - } - additionalProperties: { - /** - * Additional Properties - */ - displayName: () => LocalizedString - /** - * Additional properties to add to returned data - */ - shortDesc: () => LocalizedString - /** - * Select additional properties to add to the returned object data - */ - longDesc: () => LocalizedString - } - } } - hubspot_ticket_created_or_updated_trigger: { - event_info: { + opportunity_id_delete: { + groups: { /** - * Ticket Information + * CRM */ - desc: () => LocalizedString + '0': () => LocalizedString } /** - * Ticket Created or Updated + * Delete Opportunity */ displayName: () => LocalizedString /** - * Triggers when a support ticket is created or updated in HubSpot. + * Deletes a specific opportunity. */ shortDesc: () => LocalizedString /** - * Automatically trigger workflows when a support ticket is created or updated in HubSpot, ideal for managing customer support operations and streamlining issue resolution. + * Removes an opportunity record from NetSuite based on its ID. */ longDesc: () => LocalizedString - options: { - activationCriteria: { - /** - * Activation Criteria - */ - displayName: () => LocalizedString - /** - * Criteria for trigger to activate (created or updated) - */ - shortDesc: () => LocalizedString - /** - * Select the criteria for the trigger to activate. - - - Created: Triggers when a new object is created - - Updated: Triggers when an existing object is updated - */ - longDesc: () => LocalizedString - } - additionalProperties: { - /** - * Additional Properties - */ - displayName: () => LocalizedString - /** - * Additional properties to add to returned data - */ - shortDesc: () => LocalizedString - /** - * Select additional properties to add to the returned object data - */ - longDesc: () => LocalizedString - } - } } - hubspot_user_created_or_updated_trigger: { - event_info: { + opportunity_id_get: { + groups: { /** - * User Information + * CRM */ - desc: () => LocalizedString + '0': () => LocalizedString } /** - * User Created or Updated + * Get Opportunity */ displayName: () => LocalizedString /** - * Triggers when a user is added or updated in HubSpot. + * Retrieve details of a specific opportunity. */ shortDesc: () => LocalizedString /** - * This trigger fires upon the creation or update of a user within HubSpot, helping you keep track of user accounts and maintain updated access control for your team. + * Fetches detailed information of a single opportunity by its ID. */ longDesc: () => LocalizedString - options: { - activationCriteria: { - /** - * Activation Criteria - */ - displayName: () => LocalizedString - /** - * Criteria for trigger to activate (created or updated) - */ - shortDesc: () => LocalizedString - /** - * Select the criteria for the trigger to activate. - - - Created: Triggers when a new object is created - - Updated: Triggers when an existing object is updated - */ - longDesc: () => LocalizedString - } - additionalProperties: { - /** - * Additional Properties - */ - displayName: () => LocalizedString - /** - * Additional properties to add to returned data - */ - shortDesc: () => LocalizedString - /** - * Select additional properties to add to the returned object data - */ - longDesc: () => LocalizedString - } - } } - } - expressions: { - '&&': { + opportunity_id_patch: { + groups: { + /** + * CRM + */ + '0': () => LocalizedString + } /** - * and (&&) + * Update Opportunity */ displayName: () => LocalizedString /** - * Returns True if all arguments are True + * Updates an existing opportunity. */ shortDesc: () => LocalizedString /** - * Returns `True` if all arguments are `True` with logic short-circuiting + * Allows the user to update details of a specific opportunity by its ID. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Condition - */ - displayName: () => LocalizedString - /** - * Boolean condition to evaluate - */ - shortDesc: () => LocalizedString - /** - * A boolean expression or condition that evaluates to True or False - */ - longDesc: () => LocalizedString - } - } } - '||': { + opportunity_post: { + groups: { + /** + * CRM + */ + '0': () => LocalizedString + } /** - * or (||) + * Create Opportunity */ displayName: () => LocalizedString /** - * Returns True if any argument is True + * Creates a new opportunity. */ shortDesc: () => LocalizedString /** - * Returns `True` if any argument is `True` with logic short-circuiting + * Allows the user to create a new opportunity record in NetSuite. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Condition - */ - displayName: () => LocalizedString - /** - * Boolean condition to evaluate - */ - shortDesc: () => LocalizedString - /** - * A boolean expression or condition that evaluates to True or False - */ - longDesc: () => LocalizedString - } - } } - '==': { + invoice_get: { + groups: { + /** + * Sales & Billing + */ + '0': () => LocalizedString + } /** - * equals (=) + * Get List of Invoices */ displayName: () => LocalizedString /** - * Equality comparison + * Retrieve a list of invoices. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value equals the specified value + * Fetches a list of invoices based on specified filters. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } - } } - '!=': { + invoice_post: { + groups: { + /** + * Sales & Billing + */ + '0': () => LocalizedString + } /** - * not equals (!=) + * Create Invoice */ displayName: () => LocalizedString /** - * Inequality comparison + * Creates a new invoice. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value does not equal the specified value + * Allows the user to create a new invoice record in NetSuite. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { + options: { + entity: { /** - * Value + * Customer for the invoice */ displayName: () => LocalizedString /** - * Value to compare against + * The customer for the invoice */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * The customer for the invoice */ longDesc: () => LocalizedString } } } - '>': { + invoice_id_get: { + groups: { + /** + * Sales & Billing + */ + '0': () => LocalizedString + } /** - * greater than (>) + * Get Invoice */ displayName: () => LocalizedString /** - * Greater than comparison + * Retrieve details of a specific invoice. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is greater than the specified value + * Fetches detailed information of a single invoice by its ID. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } - } } - '>=': { + invoice_id_patch: { + groups: { + /** + * Sales & Billing + */ + '0': () => LocalizedString + } /** - * greater than or equal (>=) + * Update Invoice */ displayName: () => LocalizedString /** - * Greater than or equal comparison + * Updates an existing invoice. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is greater than or equal to the specified value + * Allows the user to update details of a specific invoice by its ID. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } - } } - '<': { + invoice_id_delete: { + groups: { + /** + * Sales & Billing + */ + '0': () => LocalizedString + } /** - * less than (<) + * Delete Invoice */ displayName: () => LocalizedString /** - * Less than comparison + * Deletes a specific invoice. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is less than the specified value + * Removes an invoice record from NetSuite based on its ID. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } - } } - '<=': { + journalEntry_get: { + groups: { + /** + * Accounting + */ + '0': () => LocalizedString + } /** - * less than or equal (<=) + * Get List of Journal Entries */ displayName: () => LocalizedString /** - * Less than or equal comparison + * Retrieve a list of journal entries. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is less than or equal to the specified value + * Fetches a list of journal entries based on specified filters. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to compare - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be compared - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Value to compare against - */ - shortDesc: () => LocalizedString - /** - * The value to compare the field against - */ - longDesc: () => LocalizedString - } - } } - 'in': { + journalEntry_post: { + groups: { + /** + * Accounting + */ + '0': () => LocalizedString + } /** - * in + * Create Journal Entry */ displayName: () => LocalizedString /** - * In list + * Creates a new journal entry. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is in the provided list + * Allows the user to create a new journal entry record in NetSuite. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to check - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be checked - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Values - */ - displayName: () => LocalizedString - /** - * List of values - */ - shortDesc: () => LocalizedString - /** - * The list of values to check the field against - */ - longDesc: () => LocalizedString - } - } } - not_in: { + journalEntry_id_get: { + groups: { + /** + * Accounting + */ + '0': () => LocalizedString + } /** - * not in + * Get Journal Entry */ displayName: () => LocalizedString /** - * Not in list + * Retrieve details of a specific journal entry. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is not in the provided list + * Fetches detailed information of a single journal entry by its ID. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to check - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be checked - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Values - */ - displayName: () => LocalizedString - /** - * List of values - */ - shortDesc: () => LocalizedString - /** - * The list of values the field should not match - */ - longDesc: () => LocalizedString - } - } } - between: { + journal_entry_id_patch: { + groups: { + /** + * Accounting + */ + '0': () => LocalizedString + } /** - * between + * Update Journal Entry */ displayName: () => LocalizedString /** - * Between two values + * Updates an existing journal entry. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is between the two specified values + * Allows the user to update details of a specific journal entry by its ID. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to check - */ - shortDesc: () => LocalizedString - /** - * The field whose value will be checked - */ - longDesc: () => LocalizedString - } - '1': { - /** - * Lower bound - */ - displayName: () => LocalizedString - /** - * Minimum value - */ - shortDesc: () => LocalizedString - /** - * The lower bound of the range (inclusive) - */ - longDesc: () => LocalizedString - } - '2': { - /** - * Upper bound - */ - displayName: () => LocalizedString - /** - * Maximum value - */ - shortDesc: () => LocalizedString - /** - * The upper bound of the range (inclusive) - */ - longDesc: () => LocalizedString - } - } } - has_property: { + journalEntry_id_delete: { + groups: { + /** + * Accounting + */ + '0': () => LocalizedString + } /** - * has property + * Delete Journal Entry */ displayName: () => LocalizedString /** - * Field has a value + * Deletes a specific journal entry. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field has any value set (is not null or empty) + * Removes a journal entry record from NetSuite based on its ID. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to check - */ - shortDesc: () => LocalizedString - /** - * The field to check for a value - */ - longDesc: () => LocalizedString - } - } } - not_has_property: { + purchaseOrder_get: { + groups: { + /** + * Procurement + */ + '0': () => LocalizedString + } /** - * does not have property + * Get List of Purchase Orders */ displayName: () => LocalizedString /** - * Field has no value + * Retrieve a list of purchase orders. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field has no value set (is null or empty) + * Fetches a list of purchase orders based on specified filters. */ longDesc: () => LocalizedString - args: { - '0': { - /** - * Field - */ - displayName: () => LocalizedString - /** - * Field to check - */ - shortDesc: () => LocalizedString - /** - * The field to check for emptiness - */ - longDesc: () => LocalizedString - } + } + purchaseOrder_post: { + groups: { + /** + * Procurement + */ + '0': () => LocalizedString } - } - contains_token: { /** - * contains token + * Create Purchase Order */ displayName: () => LocalizedString /** - * Contains token or substring + * Creates a new purchase order. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field contains the specified token or substring + * Allows the user to create a new purchase order record in NetSuite. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + entity: { /** - * Field + * Vendor */ displayName: () => LocalizedString /** - * Text field to search + * The vendor for the purchase order */ shortDesc: () => LocalizedString /** - * The text field to search within + * The vendor for the purchase order */ longDesc: () => LocalizedString } - '1': { + employee: { /** - * Token + * Employee (Requestor) */ displayName: () => LocalizedString /** - * Token to find + * The employee who requested the purchase order */ shortDesc: () => LocalizedString /** - * The token or substring to search for + * The employee who requested the purchase order */ longDesc: () => LocalizedString } } } - not_contains_token: { + purchaseOrder_id_get: { + groups: { + /** + * Procurement + */ + '0': () => LocalizedString + } /** - * does not contain token + * Get Purchase Order */ displayName: () => LocalizedString /** - * Does not contain token or substring + * Retrieve details of a specific purchase order. */ shortDesc: () => LocalizedString /** - * Returns `True` if the field does not contain the specified token or substring + * Fetches detailed information of a single purchase order by its ID. */ longDesc: () => LocalizedString - args: { - '0': { + } + purchaseOrder_id_patch: { + groups: { + /** + * Procurement + */ + '0': () => LocalizedString + } + /** + * Update Purchase Order + */ + displayName: () => LocalizedString + /** + * Updates an existing purchase order. + */ + shortDesc: () => LocalizedString + /** + * Allows the user to update details of a specific purchase order by its ID. + */ + longDesc: () => LocalizedString + options: { + entity: { /** - * Field + * Vendor */ displayName: () => LocalizedString /** - * Text field to search + * The vendor for the purchase order */ shortDesc: () => LocalizedString /** - * The text field to search within + * The vendor for the purchase order */ longDesc: () => LocalizedString } - '1': { + employee: { /** - * Token + * Employee (Requestor) */ displayName: () => LocalizedString /** - * Token to exclude + * The employee who requested the purchase order */ shortDesc: () => LocalizedString /** - * The token or substring that should not be present + * The employee who requested the purchase order */ longDesc: () => LocalizedString } } } - } - searchOptions: { - orderBy: { - /** - * Order By - */ - displayName: () => LocalizedString - /** - * Sort results by a specific field - */ - shortDesc: () => LocalizedString - /** - * Define the field and direction to sort search results - */ - longDesc: () => LocalizedString - type: { - fields: { - column: { - /** - * Column - */ - displayName: () => LocalizedString - /** - * The column to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the column to use for sorting results - */ - longDesc: () => LocalizedString - } - ascending: { - /** - * Ascending - */ - displayName: () => LocalizedString - /** - * Sort in ascending order - */ - shortDesc: () => LocalizedString - /** - * When enabled, results are sorted in ascending order (A-Z, 0-9) - */ - longDesc: () => LocalizedString - } - } + purchaseOrder_id_delete: { + groups: { + /** + * Procurement + */ + '0': () => LocalizedString } - } - limit: { /** - * Limit + * Delete Purchase Order */ displayName: () => LocalizedString /** - * Maximum number of records to return + * Deletes a specific purchase order. */ shortDesc: () => LocalizedString /** - * The maximum number of records to return. If not specified, all matching records will be returned. + * Removes a purchase order record from NetSuite based on its ID. */ longDesc: () => LocalizedString } - } - upsertOptions: { - idProperty: { + salesOrder_get: { + groups: { + /** + * Sales & Billing + */ + '0': () => LocalizedString + } /** - * ID Property + * Get List of Sales Orders */ displayName: () => LocalizedString /** - * The unique identifier property for upsert operations + * Retrieve a list of sales orders. */ shortDesc: () => LocalizedString /** - * The unique identifier property name used to determine if a record already exists for updating. If no matching record is found, a new record will be created. + * Fetches a list of sales orders based on specified filters. */ longDesc: () => LocalizedString } - } - } - Dropbox: { - /** - * Dropbox - */ - displayName: () => LocalizedString - groups: { - /** - * Cloud Storage & File Management - */ - '0': () => LocalizedString - } - /** - * Connect with Dropbox to manage files, folders, and shared links in your cloud storage - */ - shortDesc: () => LocalizedString - /** - * Integrate with Dropbox to automate file management, sharing, and synchronization. Dropbox is a cloud-based file storage solution that allows users to store, share, and collaborate on files and folders. This integration enables you to create, copy, move, and delete files and folders, manage shared links, track file revisions, and monitor for new or modified files. - */ - longDesc: () => LocalizedString - actions: { - create_text_file: { + salesOrder_post: { groups: { /** - * Files + * Sales & Billing */ '0': () => LocalizedString } /** - * Create Text File + * Create Sales Order */ displayName: () => LocalizedString /** - * Create a new text file in Dropbox + * Creates a new sales order. */ shortDesc: () => LocalizedString /** - * Create a new text file with the specified content at the given path in your Dropbox. If a file already exists at the path and autorename is enabled, a new name will be generated. + * Allows the user to create a new sales order record in NetSuite. */ longDesc: () => LocalizedString options: { - path: { - /** - * File Path - */ - displayName: () => LocalizedString - /** - * Full path for the new file - */ - shortDesc: () => LocalizedString - /** - * The full path where the file should be created, including the filename (e.g., "/Documents/notes.txt"). - */ - longDesc: () => LocalizedString - } - content: { + entity: { /** - * Content + * Customer */ displayName: () => LocalizedString /** - * Text content for the file + * The customer for the sales order */ shortDesc: () => LocalizedString /** - * The text content to write to the file. + * The customer for the sales order */ longDesc: () => LocalizedString } - autorename: { + } + } + customer_post_simplified: { + groups: { + /** + * CRM + */ + '0': () => LocalizedString + } + /** + * Create Customer (Simplified) + */ + displayName: () => LocalizedString + /** + * Creates a new customer with simplified options. + */ + shortDesc: () => LocalizedString + /** + * Creates a new customer in NetSuite with simplified fields + */ + longDesc: () => LocalizedString + options: { + entityStatus: { /** - * Auto Rename + * Status */ displayName: () => LocalizedString /** - * Automatically rename if file exists + * Customer status */ shortDesc: () => LocalizedString /** - * If enabled and a file with the same name exists, Dropbox will automatically generate a new name. + * The status of the customer (e.g., Active, Inactive) */ longDesc: () => LocalizedString } - mute: { + subsidiary: { /** - * Mute + * Subsidiary */ displayName: () => LocalizedString /** - * Suppress change notifications + * The subsidiary for the customer */ shortDesc: () => LocalizedString /** - * If enabled, users will not receive notifications about this file being created. + * The subsidiary for the customer */ longDesc: () => LocalizedString } } } - upload_file: { + salesOrder_post_simplified: { groups: { /** - * Files + * Sales & Billing */ '0': () => LocalizedString } /** - * Upload File + * Create Sales Order (Simplified) */ displayName: () => LocalizedString /** - * Upload a file to Dropbox + * Creates a new sales order with simplified options. */ shortDesc: () => LocalizedString /** - * Upload a file from binary content to the specified path in your Dropbox. Supports files up to 150MB. + * Creates a new customer sales order in NetSuite with only the most commonly used fields, making order creation faster and more straightforward. */ longDesc: () => LocalizedString options: { - path: { - /** - * Destination Path - */ - displayName: () => LocalizedString - /** - * Full path for the uploaded file - */ - shortDesc: () => LocalizedString - /** - * The full path where the file should be uploaded, including the filename (e.g., "/Documents/report.pdf"). If not provided, the file will be uploaded to the root folder with its original name. - */ - longDesc: () => LocalizedString - } - file: { + entity: { /** - * File + * Customer */ displayName: () => LocalizedString /** - * The file to upload + * Customer for this order */ shortDesc: () => LocalizedString /** - * The file to upload to Dropbox. + * The NetSuite internal ID of the customer this sales order is for. Must be an existing customer record in your NetSuite account. */ longDesc: () => LocalizedString } - autorename: { + memo: { /** - * Auto Rename + * Memo */ displayName: () => LocalizedString /** - * Automatically rename if file exists + * Order notes */ shortDesc: () => LocalizedString /** - * If enabled and a file with the same name exists, Dropbox will automatically generate a new name. + * Additional notes or information about this order. This will appear in the memo field on the sales order record. */ longDesc: () => LocalizedString } - mute: { + orderStatus: { /** - * Mute + * Order Status */ displayName: () => LocalizedString /** - * Suppress change notifications + * Current status of order */ shortDesc: () => LocalizedString /** - * If enabled, users will not receive notifications about this file being uploaded. + * The processing status of this sales order (e.g., Pending Approval, Pending Fulfillment). Controls workflow and availability for further processing. */ longDesc: () => LocalizedString } - strictConflict: { + item: { /** - * Strict Conflict + * Order Items */ displayName: () => LocalizedString /** - * Fail on conflict instead of renaming + * Products or services being ordered */ shortDesc: () => LocalizedString /** - * If enabled, the upload will fail if a file with the same name exists, even if autorename is enabled. + * List of items being purchased in this order. Each item requires an ID and amount */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + id: { + /** + * Item ID + */ + displayName: () => LocalizedString + /** + * NetSuite item identifier + */ + shortDesc: () => LocalizedString + /** + * The internal ID of the inventory item, non-inventory item, service, or other item type in NetSuite that is being ordered. + */ + longDesc: () => LocalizedString + } + quantity: { + /** + * Quantity + */ + displayName: () => LocalizedString + /** + * Number of units + */ + shortDesc: () => LocalizedString + /** + * The number of units being ordered for this line item. For services, this is typically hours or days. + */ + longDesc: () => LocalizedString + } + amount: { + /** + * Amount Override + */ + displayName: () => LocalizedString + /** + * Custom price (optional) + */ + shortDesc: () => LocalizedString + /** + * Optional custom price override for this line item. If provided, overrides the standard price calculation (quantity × rate). Leave empty to use standard pricing from the price level assigned to the customer. + */ + longDesc: () => LocalizedString + } + } + } + } } } } - download_file: { + salesOrder_id_get: { groups: { /** - * Files + * Sales & Billing */ '0': () => LocalizedString } /** - * Download File + * Get Sales Order */ displayName: () => LocalizedString /** - * Download a file from Dropbox + * Retrieve details of a specific sales order. */ shortDesc: () => LocalizedString /** - * Download the content of a file from your Dropbox. Returns the file content as base64-encoded binary data along with file metadata. + * Fetches detailed information of a single sales order by its ID. */ longDesc: () => LocalizedString - options: { - path: { - /** - * File Path - */ - displayName: () => LocalizedString - /** - * Path to the file to download - */ - shortDesc: () => LocalizedString - /** - * The full path to the file you want to download (e.g., "/Documents/report.pdf"). - */ - longDesc: () => LocalizedString - } - } } - get_file_link: { + salesOrder_id_patch: { groups: { /** - * Files + * Sales & Billing */ '0': () => LocalizedString } /** - * Get Temporary Link + * Update Sales Order */ displayName: () => LocalizedString /** - * Get a temporary download link for a file + * Updates an existing sales order. */ shortDesc: () => LocalizedString /** - * Get a temporary direct link to download a file. The link is valid for 4 hours and can be used to stream content directly. + * Allows the user to update details of a specific sales order by its ID. */ longDesc: () => LocalizedString options: { - path: { + entity: { /** - * File Path + * Customer */ displayName: () => LocalizedString /** - * Path to the file + * The customer for the sales order */ shortDesc: () => LocalizedString /** - * The full path to the file for which you want to generate a temporary link. + * The customer for the sales order */ longDesc: () => LocalizedString } } } - delete_file: { + salesOrder_id_delete: { groups: { /** - * Files + * Sales & Billing */ '0': () => LocalizedString } /** - * Delete File + * Delete Sales Order */ displayName: () => LocalizedString /** - * Delete a file from Dropbox + * Deletes a specific sales order. */ shortDesc: () => LocalizedString /** - * Permanently delete a file from your Dropbox. This action cannot be undone through the API. + * Removes a sales order record from NetSuite based on its ID. */ longDesc: () => LocalizedString - options: { - path: { - /** - * File Path - */ - displayName: () => LocalizedString - /** - * Path to the file to delete - */ - shortDesc: () => LocalizedString - /** - * The full path to the file you want to delete. - */ - longDesc: () => LocalizedString - } - } } - copy_file: { + vendor_get: { groups: { /** - * Files + * Procurement */ '0': () => LocalizedString } /** - * Copy File + * Get List of Vendors */ displayName: () => LocalizedString /** - * Copy a file to a new location + * Retrieve a list of vendors. */ shortDesc: () => LocalizedString /** - * Copy a file from one location to another within your Dropbox. The original file remains unchanged. + * Fetches a list of vendors based on specified filters. */ longDesc: () => LocalizedString - options: { - fromPath: { - /** - * Source Path - */ - displayName: () => LocalizedString - /** - * Path to the file to copy - */ - shortDesc: () => LocalizedString - /** - * The full path to the source file. - */ - longDesc: () => LocalizedString - } - toPath: { - /** - * Destination Path - */ - displayName: () => LocalizedString - /** - * Path for the copied file - */ - shortDesc: () => LocalizedString - /** - * The full path where the file should be copied to. - */ - longDesc: () => LocalizedString - } - autorename: { - /** - * Auto Rename - */ - displayName: () => LocalizedString - /** - * Automatically rename if destination exists - */ - shortDesc: () => LocalizedString - /** - * If enabled and a file exists at the destination, generate a new name. - */ - longDesc: () => LocalizedString - } - allowOwnershipTransfer: { - /** - * Allow Ownership Transfer - */ - displayName: () => LocalizedString - /** - * Allow ownership transfer for shared content - */ - shortDesc: () => LocalizedString - /** - * If enabled, allows the copy operation to transfer ownership of the content if needed. - */ - longDesc: () => LocalizedString - } - } } - move_file: { + vendor_post: { groups: { /** - * Files + * Procurement */ '0': () => LocalizedString } /** - * Move File + * Create Vendor */ displayName: () => LocalizedString /** - * Move a file to a new location + * Creates a new vendor. */ shortDesc: () => LocalizedString /** - * Move a file from one location to another within your Dropbox. + * Allows the user to create a new vendor record in NetSuite. */ longDesc: () => LocalizedString - options: { - fromPath: { - /** - * Source Path - */ - displayName: () => LocalizedString - /** - * Path to the file to move - */ - shortDesc: () => LocalizedString - /** - * The full path to the source file. - */ - longDesc: () => LocalizedString - } - toPath: { - /** - * Destination Path - */ - displayName: () => LocalizedString - /** - * Path for the moved file - */ - shortDesc: () => LocalizedString - /** - * The full path where the file should be moved to. - */ - longDesc: () => LocalizedString - } - autorename: { - /** - * Auto Rename - */ - displayName: () => LocalizedString - /** - * Automatically rename if destination exists - */ - shortDesc: () => LocalizedString - /** - * If enabled and a file exists at the destination, generate a new name. - */ - longDesc: () => LocalizedString - } - allowOwnershipTransfer: { - /** - * Allow Ownership Transfer - */ - displayName: () => LocalizedString - /** - * Allow ownership transfer for shared content - */ - shortDesc: () => LocalizedString - /** - * If enabled, allows the move operation to transfer ownership of the content if needed. - */ - longDesc: () => LocalizedString - } - } } - create_folder: { + vendor_id_get: { groups: { /** - * Folders + * Procurement */ '0': () => LocalizedString } /** - * Create Folder + * Get Vendor */ displayName: () => LocalizedString /** - * Create a new folder in Dropbox + * Retrieve details of a specific vendor. */ shortDesc: () => LocalizedString /** - * Create a new folder at the specified path in your Dropbox. + * Fetches detailed information of a single vendor by its ID. */ longDesc: () => LocalizedString - options: { - path: { - /** - * Folder Path - */ - displayName: () => LocalizedString - /** - * Full path for the new folder - */ - shortDesc: () => LocalizedString - /** - * The full path where the folder should be created (e.g., "/Documents/Projects"). - */ - longDesc: () => LocalizedString - } - autorename: { - /** - * Auto Rename - */ - displayName: () => LocalizedString - /** - * Automatically rename if folder exists - */ - shortDesc: () => LocalizedString - /** - * If enabled and a folder with the same name exists, generate a new name. - */ - longDesc: () => LocalizedString - } - } } - delete_folder: { + vendor_id_patch: { groups: { /** - * Folders + * Procurement */ '0': () => LocalizedString } /** - * Delete Folder + * Update Vendor */ displayName: () => LocalizedString /** - * Delete a folder from Dropbox + * Updates an existing vendor. */ shortDesc: () => LocalizedString /** - * Permanently delete a folder and all its contents from your Dropbox. This action cannot be undone through the API. + * Allows the user to update details of a specific vendor by its ID. */ longDesc: () => LocalizedString - options: { - path: { - /** - * Folder Path - */ - displayName: () => LocalizedString - /** - * Path to the folder to delete - */ - shortDesc: () => LocalizedString - /** - * The full path to the folder you want to delete. - */ - longDesc: () => LocalizedString - } - } } - copy_folder: { + vendor_id_delete: { groups: { /** - * Folders + * Procurement */ '0': () => LocalizedString } /** - * Copy Folder + * Delete Vendor */ displayName: () => LocalizedString /** - * Copy a folder to a new location + * Deletes a specific vendor. */ shortDesc: () => LocalizedString /** - * Copy a folder and all its contents from one location to another within your Dropbox. + * Removes a vendor record from NetSuite based on its ID. + */ + longDesc: () => LocalizedString + } + } + expressions: { + '&&': { + /** + * And + */ + displayName: () => LocalizedString + /** + * Logical AND operator + */ + shortDesc: () => LocalizedString + /** + * Combines multiple conditions where all must be true + */ + longDesc: () => LocalizedString + } + '||': { + /** + * Or + */ + displayName: () => LocalizedString + /** + * Logical OR operator + */ + shortDesc: () => LocalizedString + /** + * Combines multiple conditions where at least one must be true + */ + longDesc: () => LocalizedString + } + '==': { + /** + * Equals + */ + displayName: () => LocalizedString + /** + * Field equals value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field equals the specified value + */ + longDesc: () => LocalizedString + } + '!=': { + /** + * Not Equals + */ + displayName: () => LocalizedString + /** + * Field does not equal value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field does not equal the specified value + */ + longDesc: () => LocalizedString + } + '>': { + /** + * Greater Than + */ + displayName: () => LocalizedString + /** + * Field is greater than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than the specified value + */ + longDesc: () => LocalizedString + } + '>=': { + /** + * Greater Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is greater than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than or equal to the specified value + */ + longDesc: () => LocalizedString + } + '<': { + /** + * Less Than + */ + displayName: () => LocalizedString + /** + * Field is less than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than the specified value + */ + longDesc: () => LocalizedString + } + '<=': { + /** + * Less Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is less than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than or equal to the specified value + */ + longDesc: () => LocalizedString + } + 'is-set': { + /** + * Is Set + */ + displayName: () => LocalizedString + /** + * Field has a value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has a value (is not null) + */ + longDesc: () => LocalizedString + } + 'is-not-set': { + /** + * Is Not Set + */ + displayName: () => LocalizedString + /** + * Field has no value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has no value (is null) + */ + longDesc: () => LocalizedString + } + contains: { + /** + * Contains + */ + displayName: () => LocalizedString + /** + * Field contains value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field contains the specified substring + */ + longDesc: () => LocalizedString + } + 'starts-with': { + /** + * Starts With + */ + displayName: () => LocalizedString + /** + * Field starts with value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value starts with the specified prefix + */ + longDesc: () => LocalizedString + } + 'ends-with': { + /** + * Ends With + */ + displayName: () => LocalizedString + /** + * Field ends with value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value ends with the specified suffix + */ + longDesc: () => LocalizedString + } + } + searchOptions: { + orderBy: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for sorting results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + NocoDB: { + /** + * NocoDB + */ + displayName: () => LocalizedString + groups: { + /** + * Spreadsheets & Data Tables + */ + '0': () => LocalizedString + /** + * Databases & Backend Services + */ + '1': () => LocalizedString + } + /** + * Connect to NocoDB to manage your database tables and records with powerful automation + */ + shortDesc: () => LocalizedString + /** + * The NocoDB integration provides comprehensive access to your NocoDB database operations. Create, read, update, and delete records in your tables, and monitor new entries with real-time triggers. Whether you need to manage data, filter results, or track new records, this integration streamlines your NocoDB workflow automation and database management. + */ + longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to NocoDB + */ + title: () => LocalizedString + /** + * To connect to NocoDB, you will need your **NocoDB URL** and an **API Token**. + + ## Getting Your API Token + + 1. Log in to your NocoDB instance + 2. Click on your **profile icon** in the top right corner + 3. Select **Copy Auth Token** from the dropdown menu + 4. Alternatively, go to **Account Settings** → **Tokens** to create a new API token + + ## Connection Details + + ### NocoDB URL + The base URL of your NocoDB instance: + - **NocoDB Cloud**: Use `https://app.nocodb.com` + - **Self-hosted**: Use your instance URL (e.g., `https://nocodb.yourcompany.com`) + + ### API Token + Your API token that grants access to NocoDB. Tokens can be created in your account settings and provide access to all operations within the authorized workspaces and bases. + + **Note:** API tokens provide full access to the workspaces and bases you have permissions for. Ensure you keep your tokens secure and only use them in trusted environments. + */ + content: () => LocalizedString + } + triggers: { + new_document: { + /** + * New Row + */ + displayName: () => LocalizedString + /** + * Trigger when a new row is added to a NocoDB table + */ + shortDesc: () => LocalizedString + /** + * Monitors a NocoDB table for new rows and triggers when new records are detected. You can optionally filter which rows trigger the event using a where clause. */ longDesc: () => LocalizedString options: { - fromPath: { + workspaceId: { /** - * Source Path + * Workspace */ displayName: () => LocalizedString /** - * Path to the folder to copy + * The NocoDB workspace containing the base */ shortDesc: () => LocalizedString /** - * The full path to the source folder. + * Select the NocoDB workspace containing the base with the table you want to monitor. */ longDesc: () => LocalizedString } - toPath: { + baseId: { /** - * Destination Path + * Base */ displayName: () => LocalizedString /** - * Path for the copied folder + * The NocoDB base containing the table */ shortDesc: () => LocalizedString /** - * The full path where the folder should be copied to. + * Select the NocoDB base (project) containing the table you want to monitor for new rows. */ longDesc: () => LocalizedString } - autorename: { + table: { /** - * Auto Rename + * Table */ displayName: () => LocalizedString /** - * Automatically rename if destination exists + * The table to monitor for new rows */ shortDesc: () => LocalizedString /** - * If enabled and a folder exists at the destination, generate a new name. + * Select the NocoDB table to monitor. The trigger will fire when new rows are added to this table. */ longDesc: () => LocalizedString } - allowOwnershipTransfer: { + where: { /** - * Allow Ownership Transfer + * Where Filter */ displayName: () => LocalizedString /** - * Allow ownership transfer for shared content + * Optional filter for new rows */ shortDesc: () => LocalizedString /** - * If enabled, allows the copy operation to transfer ownership of the content if needed. + * Optionally specify a filter using NocoDB where syntax (e.g., "(Status,eq,Active)") to only trigger for rows matching specific criteria. */ longDesc: () => LocalizedString } } } - move_folder: { - groups: { - /** - * Folders - */ - '0': () => LocalizedString + } + searchOptions: { + orderBy: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for sorting results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } + } } + } + } + actions: { + count_records: { /** - * Move Folder + * Count Records */ displayName: () => LocalizedString /** - * Move a folder to a new location + * Get the count of records in a table */ shortDesc: () => LocalizedString /** - * Move a folder and all its contents from one location to another within your Dropbox. + * Returns the total number of records in a NocoDB table. You can optionally filter the count using a where clause to count only records matching specific criteria. */ longDesc: () => LocalizedString options: { - fromPath: { + workspaceId: { /** - * Source Path + * Workspace */ displayName: () => LocalizedString /** - * Path to the folder to move + * The NocoDB workspace containing the base */ shortDesc: () => LocalizedString /** - * The full path to the source folder. + * Select the NocoDB workspace containing the base with the table. */ longDesc: () => LocalizedString } - toPath: { + baseId: { /** - * Destination Path + * Base */ displayName: () => LocalizedString /** - * Path for the moved folder + * The NocoDB base containing the table */ shortDesc: () => LocalizedString /** - * The full path where the folder should be moved to. + * Select the NocoDB base (project) containing the table. */ longDesc: () => LocalizedString } - autorename: { + table: { /** - * Auto Rename + * Table */ displayName: () => LocalizedString /** - * Automatically rename if destination exists + * The table to count records from */ shortDesc: () => LocalizedString /** - * If enabled and a folder exists at the destination, generate a new name. + * Select the NocoDB table to count records from. */ longDesc: () => LocalizedString } - allowOwnershipTransfer: { + where: { /** - * Allow Ownership Transfer + * Where Filter */ displayName: () => LocalizedString /** - * Allow ownership transfer for shared content + * Optional filter to count specific records */ shortDesc: () => LocalizedString /** - * If enabled, allows the move operation to transfer ownership of the content if needed. + * Optionally specify a filter using NocoDB where syntax (e.g., "(Status,eq,Active)") to only count records matching specific criteria. */ longDesc: () => LocalizedString } } } - list_folder: { - groups: { - /** - * Folders - */ - '0': () => LocalizedString - } + upload_attachment: { /** - * List Folder Contents + * Upload Attachment */ displayName: () => LocalizedString /** - * List files and folders in a directory + * Upload a file to an attachment field */ shortDesc: () => LocalizedString /** - * Retrieve a list of all files and subfolders within a specified folder in your Dropbox. + * Uploads a file to a specific attachment field in a NocoDB record. The file will be stored in NocoDB and associated with the specified record. */ longDesc: () => LocalizedString options: { - path: { + workspaceId: { /** - * Folder Path + * Workspace */ displayName: () => LocalizedString /** - * Path to the folder to list + * The NocoDB workspace containing the base */ shortDesc: () => LocalizedString /** - * The full path to the folder whose contents you want to list. Use empty string for root. + * Select the NocoDB workspace containing the base with the table. */ longDesc: () => LocalizedString } - recursive: { + baseId: { /** - * Recursive + * Base */ displayName: () => LocalizedString /** - * Include contents of subfolders + * The NocoDB base containing the table */ shortDesc: () => LocalizedString /** - * If enabled, also include files and folders from all subfolders recursively. + * Select the NocoDB base (project) containing the table. */ longDesc: () => LocalizedString } - limit: { + table: { /** - * Limit + * Table */ displayName: () => LocalizedString /** - * Maximum number of items to return + * The table containing the record */ shortDesc: () => LocalizedString /** - * The maximum number of items to return. Default is 2000. + * Select the NocoDB table containing the record to attach the file to. */ longDesc: () => LocalizedString } - } - } - search: { - groups: { - /** - * Search - */ - '0': () => LocalizedString - } - /** - * Search - */ - displayName: () => LocalizedString - /** - * Search for files and folders in Dropbox - */ - shortDesc: () => LocalizedString - /** - * Search for files and folders in your Dropbox by name or content. Returns matching items with their metadata. - */ - longDesc: () => LocalizedString - options: { - query: { + recordId: { /** - * Search Query + * Record ID */ displayName: () => LocalizedString /** - * Text to search for + * The ID of the record to attach the file to */ shortDesc: () => LocalizedString /** - * The search query. Searches file and folder names. + * Specify the ID of the record where the file should be uploaded. */ longDesc: () => LocalizedString } - path: { + attachmentField: { /** - * Path + * Attachment Field */ displayName: () => LocalizedString /** - * Folder to search within + * The attachment field to upload to */ shortDesc: () => LocalizedString /** - * Optionally limit the search to a specific folder path. Leave empty to search all of Dropbox. + * Select the attachment field in the table where the file will be stored. */ longDesc: () => LocalizedString } - maxResults: { + file: { /** - * Max Results + * File */ displayName: () => LocalizedString /** - * Maximum number of results + * The file to upload */ shortDesc: () => LocalizedString /** - * The maximum number of search results to return. Default is 100. + * The file to upload to the attachment field. Supports various file types including images, documents, and more. */ longDesc: () => LocalizedString } - orderBy: { + } + } + link_records: { + /** + * Link Records + */ + displayName: () => LocalizedString + /** + * Create relationships between records + */ + shortDesc: () => LocalizedString + /** + * Links records from another table to a record via a link field. This creates a relationship between the records without affecting existing links. + */ + longDesc: () => LocalizedString + options: { + workspaceId: { /** - * Order By + * Workspace */ displayName: () => LocalizedString /** - * Sort order for results + * The NocoDB workspace containing the base */ shortDesc: () => LocalizedString /** - * How to order the search results: by relevance or by modified time. + * Select the NocoDB workspace containing the base with the table. */ longDesc: () => LocalizedString } - fileStatus: { + baseId: { /** - * File Status + * Base */ displayName: () => LocalizedString /** - * Filter by file status + * The NocoDB base containing the table */ shortDesc: () => LocalizedString /** - * Filter search results by file status: active (existing files) or deleted (removed files). + * Select the NocoDB base (project) containing the table. */ longDesc: () => LocalizedString } - filenameOnly: { + table: { /** - * Filename Only + * Table */ displayName: () => LocalizedString /** - * Search only in file names + * The table containing the source record */ shortDesc: () => LocalizedString /** - * If enabled, search will only match file names, not file contents. + * Select the NocoDB table containing the record you want to link from. */ longDesc: () => LocalizedString } - fileExtensions: { + linkField: { /** - * File Extensions + * Link Field */ displayName: () => LocalizedString /** - * Filter by file extensions + * The link field to use for the relationship */ shortDesc: () => LocalizedString /** - * Comma-separated list of file extensions to filter by (e.g., "pdf,doc,txt"). + * Select the link field (Link to Another Record) that defines the relationship between tables. */ longDesc: () => LocalizedString } - fileCategories: { + recordId: { /** - * File Categories + * Record ID */ displayName: () => LocalizedString /** - * Filter by file categories + * The source record ID */ shortDesc: () => LocalizedString /** - * Comma-separated list of file categories to filter by (e.g., "image,document,video"). + * Specify the ID of the record in the source table to link from. + */ + longDesc: () => LocalizedString + } + linkedRecordIds: { + /** + * Records to Link + */ + displayName: () => LocalizedString + /** + * IDs of records to link + */ + shortDesc: () => LocalizedString + /** + * Provide the IDs of records from the linked table to connect to the source record. */ longDesc: () => LocalizedString } } } - create_shared_link: { - groups: { - /** - * Sharing - */ - '0': () => LocalizedString - } + unlink_records: { /** - * Create Shared Link + * Unlink Records */ displayName: () => LocalizedString /** - * Create a shared link for a file + * Remove relationships between records */ shortDesc: () => LocalizedString /** - * Create a shared link for a file in your Dropbox that can be shared with others. You can configure visibility and expiration settings. + * Removes the link between records via a link field. This breaks the relationship without deleting any records. */ longDesc: () => LocalizedString options: { - path: { + workspaceId: { /** - * File Path + * Workspace */ displayName: () => LocalizedString /** - * Path to the file to share + * The NocoDB workspace containing the base */ shortDesc: () => LocalizedString /** - * The full path to the file for which you want to create a shared link. + * Select the NocoDB workspace containing the base with the table. */ longDesc: () => LocalizedString } - requested_visibility: { + baseId: { /** - * Visibility + * Base */ displayName: () => LocalizedString /** - * Who can access this link + * The NocoDB base containing the table */ shortDesc: () => LocalizedString /** - * The visibility level for the shared link: public (anyone), team_only (team members), or password (requires password). + * Select the NocoDB base (project) containing the table. */ longDesc: () => LocalizedString } - expires: { + table: { /** - * Expiration Date + * Table */ displayName: () => LocalizedString /** - * When the link expires + * The table containing the source record */ shortDesc: () => LocalizedString /** - * Optional expiration date for the link in ISO 8601 format (e.g., "2024-12-31T23:59:59Z"). + * Select the NocoDB table containing the record you want to unlink from. */ longDesc: () => LocalizedString } - } - } - list_shared_links: { - groups: { - /** - * Sharing - */ - '0': () => LocalizedString - } - /** - * List Shared Links - */ - displayName: () => LocalizedString - /** - * List shared links for a file or all files - */ - shortDesc: () => LocalizedString - /** - * Retrieve a list of shared links. You can list all shared links or filter to a specific file path. - */ - longDesc: () => LocalizedString - options: { - path: { + linkField: { /** - * File Path + * Link Field */ displayName: () => LocalizedString /** - * Filter by file path + * The link field with the relationship */ shortDesc: () => LocalizedString /** - * Optionally specify a file path to list only shared links for that file. Leave empty to list all shared links. + * Select the link field (Link to Another Record) that defines the relationship to remove. */ longDesc: () => LocalizedString } - direct_only: { + recordId: { /** - * Direct Only + * Record ID */ displayName: () => LocalizedString /** - * Return only direct links + * The source record ID */ shortDesc: () => LocalizedString /** - * If enabled, only return shared links that directly reference the file, not links to parent folders. + * Specify the ID of the record in the source table to unlink from. */ longDesc: () => LocalizedString } - } - } - revoke_shared_link: { - groups: { - /** - * Sharing - */ - '0': () => LocalizedString - } - /** - * Revoke Shared Link - */ - displayName: () => LocalizedString - /** - * Revoke a shared link - */ - shortDesc: () => LocalizedString - /** - * Revoke a shared link so it can no longer be used to access the file. This action cannot be undone. - */ - longDesc: () => LocalizedString - options: { - url: { + linkedRecordIds: { /** - * Shared Link URL + * Records to Unlink */ displayName: () => LocalizedString /** - * The URL of the shared link to revoke + * IDs of records to unlink */ shortDesc: () => LocalizedString /** - * The full URL of the shared link you want to revoke. + * Provide the IDs of records from the linked table to disconnect from the source record. */ longDesc: () => LocalizedString } } } - list_file_revisions: { - groups: { - /** - * Revisions - */ - '0': () => LocalizedString - } + trigger_button: { /** - * List File Revisions + * Trigger Button */ displayName: () => LocalizedString /** - * List revision history for a file + * Trigger a button action on records */ shortDesc: () => LocalizedString /** - * Retrieve a list of all revisions (versions) of a file. This allows you to see the history of changes to the file. + * Programmatically triggers a button action (such as AI generation or webhook) for specified records. Maximum of 25 records can be processed at a time. */ longDesc: () => LocalizedString options: { - path: { + workspaceId: { /** - * File Path + * Workspace */ displayName: () => LocalizedString /** - * Path to the file + * The NocoDB workspace containing the base */ shortDesc: () => LocalizedString /** - * The full path to the file whose revisions you want to list. + * Select the NocoDB workspace containing the base with the table. */ longDesc: () => LocalizedString } - mode: { + baseId: { /** - * Mode + * Base */ displayName: () => LocalizedString /** - * How to identify the file + * The NocoDB base containing the table */ shortDesc: () => LocalizedString /** - * How the path parameter identifies the file: "path" (by file path) or "id" (by file ID). + * Select the NocoDB base (project) containing the table. */ longDesc: () => LocalizedString } - limit: { + table: { /** - * Limit + * Table */ displayName: () => LocalizedString /** - * Maximum number of revisions + * The table containing the button field */ shortDesc: () => LocalizedString /** - * The maximum number of revisions to return. Default is 10. + * Select the NocoDB table containing the button field to trigger. */ longDesc: () => LocalizedString } - } - } - restore_file_revision: { - groups: { - /** - * Revisions - */ - '0': () => LocalizedString - } - /** - * Restore File Revision - */ - displayName: () => LocalizedString - /** - * Restore a file to a previous revision - */ - shortDesc: () => LocalizedString - /** - * Restore a file to a previous revision (version). This creates a new revision with the content from the specified revision. - */ - longDesc: () => LocalizedString - options: { - path: { + buttonField: { /** - * File Path + * Button Field */ displayName: () => LocalizedString /** - * Path to the file + * The button field to trigger */ shortDesc: () => LocalizedString /** - * The full path to the file you want to restore. + * Select the button field whose action should be triggered for the specified records. */ longDesc: () => LocalizedString } - rev: { + recordIds: { /** - * Revision + * Record IDs */ displayName: () => LocalizedString /** - * Revision ID to restore + * IDs of records to process */ shortDesc: () => LocalizedString /** - * The revision identifier (rev) of the version you want to restore. Get this from list_file_revisions. + * Provide the IDs of records to trigger the button action for. Maximum 25 records per request. + */ + longDesc: () => LocalizedString + } + preview: { + /** + * Preview Mode + */ + displayName: () => LocalizedString + /** + * Run in preview mode without saving changes + */ + shortDesc: () => LocalizedString + /** + * When enabled, the button action runs in preview mode and changes are not saved. Useful for testing. */ longDesc: () => LocalizedString } } } } + } + Salesforce: { + groups: { + /** + * CRM & Sales Management + */ + '0': () => LocalizedString + } triggers: { - new_file: { - groups: { - /** - * Files - */ - '0': () => LocalizedString - } + new_record_trigger: { /** - * New File + * New Record */ displayName: () => LocalizedString /** - * Triggers when a new file is added to a folder + * Triggers when a new record is created in the specified object. */ shortDesc: () => LocalizedString /** - * This trigger fires whenever a new file is created in the specified folder. Monitor for new uploads, file creations, or files moved into the folder. + * This trigger fires whenever a new record is created in a specified Salesforce object. You can configure the object type to target specific record types, such as Leads, Contacts, or custom objects. It is useful for automating workflows triggered by record creation. */ longDesc: () => LocalizedString options: { - folder: { + object: { /** - * Folder Path + * Object Type */ displayName: () => LocalizedString /** - * The folder to monitor for new files + * The Salesforce object to monitor for new records. */ shortDesc: () => LocalizedString /** - * Specify the path to the folder you want to monitor for new files. Use empty string for root folder. + * Select the Salesforce object (e.g., Lead, Account, Contact) where this trigger will monitor for newly created records. */ longDesc: () => LocalizedString } } - } - new_folder: { - groups: { + event_info: { /** - * Folders + * Fires when a new record is created in the specified Salesforce object. */ - '0': () => LocalizedString + desc: () => LocalizedString } + } + new_contact_trigger: { /** - * New Folder + * New Contact */ displayName: () => LocalizedString /** - * Triggers when a new folder is created + * Triggers when a new Contact record is created. */ shortDesc: () => LocalizedString /** - * This trigger fires whenever a new folder is created within the specified parent folder. + * This trigger fires whenever a new Contact record is created in Salesforce. It is ideal for automating workflows such as contact notifications, integrations, or CRM updates. */ longDesc: () => LocalizedString - options: { - parentFolder: { - /** - * Parent Folder - */ - displayName: () => LocalizedString - /** - * The parent folder to monitor - */ - shortDesc: () => LocalizedString - /** - * Specify the path to the parent folder you want to monitor for new subfolders. - */ - longDesc: () => LocalizedString - } + event_info: { + /** + * Fires when a new Contact record is created in Salesforce. + */ + desc: () => LocalizedString } } - file_modified: { - groups: { + new_lead_trigger: { + /** + * New Lead + */ + displayName: () => LocalizedString + /** + * Triggers when a new Lead record is created. + */ + shortDesc: () => LocalizedString + /** + * This trigger activates whenever a new Lead record is created in Salesforce. It is commonly used for workflows related to lead generation, qualification, or assignment. + */ + longDesc: () => LocalizedString + event_info: { /** - * Files + * Fires when a new Lead record is created in Salesforce. */ - '0': () => LocalizedString + desc: () => LocalizedString } + } + updated_record_trigger: { /** - * File Modified + * Updated Record */ displayName: () => LocalizedString /** - * Triggers when a file is modified + * Triggers when an existing record is updated. */ shortDesc: () => LocalizedString /** - * This trigger fires whenever a file is modified in the specified folder. This includes content changes, not just metadata updates. + * This trigger fires whenever an existing record in a specified Salesforce object is updated. It is useful for workflows that depend on changes to specific fields or records, such as updating downstream systems or notifying users of record changes. */ longDesc: () => LocalizedString options: { - folder: { + object: { /** - * Folder Path + * Object Type */ displayName: () => LocalizedString /** - * The folder to monitor for modified files + * The Salesforce object to monitor for updates. */ shortDesc: () => LocalizedString /** - * Specify the path to the folder you want to monitor for file modifications. + * Specify the Salesforce object (e.g., Opportunity, Contact, or custom objects) where this trigger will monitor for record updates. */ longDesc: () => LocalizedString } } + event_info: { + /** + * Fires when a record in the specified Salesforce object is updated. + */ + desc: () => LocalizedString + } } } } - NetSuite: { + Freshdesk: { /** - * NetSuite + * Freshdesk */ displayName: () => LocalizedString groups: { /** - * Accounting & ERP + * Customer Support & Helpdesk */ '0': () => LocalizedString } /** - * A comprehensive suite of cloud-based business management solutions. + * Cloud-based customer support software */ shortDesc: () => LocalizedString /** - * NetSuite offers a unified platform for ERP, CRM, e-commerce, and more, enabling businesses to manage all key operations in a single system. + * Freshdesk is a cloud-based customer support platform that was founded with the mission of enabling companies of all sizes to provide great customer service. Our goal is simple: make it easy for brands to talk to their customers and make it easy for users to get in touch with businesses. */ longDesc: () => LocalizedString - triggers: { - new_record: { - /** - * New Record - */ - displayName: () => LocalizedString - /** - * Triggers when a new record is created - */ - shortDesc: () => LocalizedString - /** - * Triggers when a new record is created - */ - longDesc: () => LocalizedString - options: { - recordType: { - /** - * Record Type - */ - displayName: () => LocalizedString - /** - * The type of record to monitor - */ - shortDesc: () => LocalizedString - /** - * The type of record to monitor - */ - longDesc: () => LocalizedString - } - } - } + connectionMessage: { + /** + * Connect to Freshdesk + */ + title: () => LocalizedString + /** + * To connect to Freshdesk, you will need your **Subdomain** and **API Key**. + + ## Finding Your Subdomain + + Your Freshdesk subdomain is the unique identifier in your Freshdesk URL: + - If your Freshdesk URL is `https://yourcompany.freshdesk.com`, your subdomain is `yourcompany` + + ## Getting Your API Key + + 1. Log in to your Freshdesk account + 2. Click on your **profile icon** in the top right corner + 3. Select **Profile settings** + 4. Scroll down to find your **API Key** section + 5. Click **View API Key** to reveal your key + 6. Copy the API key + + ## Connection Details + + ### Subdomain + Your Freshdesk subdomain (e.g., `yourcompany` from `yourcompany.freshdesk.com`). Do not include the full URL, just the subdomain portion. + + ### API Key + Your personal Freshdesk API key. This key is tied to your user account and inherits your permissions within Freshdesk. + + **Note:** Your API key provides access based on your user role and permissions in Freshdesk. For production integrations, consider using a dedicated service account with appropriate permissions. Keep your API key secure and never share it publicly. + */ + content: () => LocalizedString } - actions: { - list_records: { - groups: { - /** - * Data & Search - */ - '0': () => LocalizedString - } + triggers: { + new_ticket_trigger: { /** - * List Records + * New Ticket */ displayName: () => LocalizedString /** - * Retrieve NetSuite records based on search criteria + * Triggers when a new ticket is created in Freshdesk. */ shortDesc: () => LocalizedString /** - * Query NetSuite records by type with optional filtering, field selection, and pagination + * Fires whenever a new ticket is created in your Freshdesk instance. You can capture details such as subject, description, priority, and more, and use this data in subsequent actions or notifications. */ longDesc: () => LocalizedString options: { - recordType: { - /** - * Record Type - */ - displayName: () => LocalizedString - /** - * Type of NetSuite record to retrieve - */ - shortDesc: () => LocalizedString - /** - * Specifies which NetSuite record type to query (customer, invoice, transaction, etc.) - */ - longDesc: () => LocalizedString - } - searchMode: { - /** - * Search Mode - */ - displayName: () => LocalizedString - /** - * How multiple search criteria are combined - */ - shortDesc: () => LocalizedString - /** - * Determines if records must match all criteria (All) or any criteria (Any) when multiple query fields are provided - */ - longDesc: () => LocalizedString - } - fields: { - /** - * Fields - */ - displayName: () => LocalizedString - /** - * Specific record fields to return - */ - shortDesc: () => LocalizedString - /** - * List of field names to include in results (returns all fields if omitted) - */ - longDesc: () => LocalizedString - } - query: { - /** - * Query Criteria - */ - displayName: () => LocalizedString - /** - * Search conditions for filtering records - */ - shortDesc: () => LocalizedString - /** - * Key-value pairs defining search criteria - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - key: { - /** - * Field Name - */ - displayName: () => LocalizedString - /** - * Name of the field to filter by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to filter by - */ - longDesc: () => LocalizedString - } - value: { - /** - * Field Value - */ - displayName: () => LocalizedString - /** - * Value to match for the field - */ - shortDesc: () => LocalizedString - /** - * The value to match for the field - */ - longDesc: () => LocalizedString - } - } - } - } - } - limit: { + ticketStatus: { /** - * Limit + * Ticket Status Filter */ displayName: () => LocalizedString /** - * Maximum number of records to return + * Filters by ticket status */ shortDesc: () => LocalizedString /** - * Caps the number of results returned in a single query + * Restrict or filter the trigger to only fire for tickets matching a certain status (e.g. Open, Pending, Resolved, etc.). */ longDesc: () => LocalizedString } - offset: { + ticketPriority: { /** - * Offset + * Ticket Priority Filter */ displayName: () => LocalizedString /** - * Number of records to skip + * Filters by ticket priority */ shortDesc: () => LocalizedString /** - * Used for pagination to skip a specified number of records in the result set + * Restrict or filter the trigger to only fire for tickets matching a certain priority (e.g. Low, Medium, High). */ longDesc: () => LocalizedString } } - } - suite_ql: { - groups: { + event_info: { /** - * Data & Search + * Structure and types for Freshdesk’s new ticket data payload. */ - '0': () => LocalizedString + desc: () => LocalizedString } + } + new_contact_trigger: { /** - * SuiteQL + * New Contact */ displayName: () => LocalizedString /** - * Run a SuiteQL query + * Triggers when a new contact is created in Freshdesk. */ shortDesc: () => LocalizedString /** - * Run a SuiteQL query + * Fires whenever a new contact is added to your Freshdesk instance. Capture details such as name, email, phone, and any custom fields associated with the contact. */ longDesc: () => LocalizedString - options: { - query: { - /** - * Query - */ - displayName: () => LocalizedString - /** - * The SuiteQL query to run - */ - shortDesc: () => LocalizedString - /** - * The SuiteQL query to run - */ - longDesc: () => LocalizedString - } - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * The maximum number of records to return - */ - shortDesc: () => LocalizedString - /** - * The maximum number of records to return - */ - longDesc: () => LocalizedString - } - offset: { - /** - * Offset - */ - displayName: () => LocalizedString - /** - * The number of records to skip - */ - shortDesc: () => LocalizedString - /** - * The number of records to skip - */ - longDesc: () => LocalizedString - } - response_type: { - fields: { - links: { - /** - * Links - */ - display_name: () => LocalizedString - /** - * Links - */ - short_desc: () => LocalizedString - /** - * Links - */ - desc: () => LocalizedString - } - count: { - /** - * Count - */ - display_name: () => LocalizedString - /** - * The number of results - */ - short_desc: () => LocalizedString - /** - * The number of results - */ - desc: () => LocalizedString - } - hasMore: { - /** - * Has More - */ - display_name: () => LocalizedString - /** - * Whether there are more results - */ - short_desc: () => LocalizedString - /** - * Whether there are more results - */ - desc: () => LocalizedString - } - items: { - /** - * Items - */ - display_name: () => LocalizedString - /** - * The items - */ - short_desc: () => LocalizedString - /** - * The items - */ - desc: () => LocalizedString - } - } - } - } - } - account_get: { - groups: { + event_info: { /** - * Accounting + * Structure and types for Freshdesk’s new contact data payload. */ - '0': () => LocalizedString + desc: () => LocalizedString } + } + updated_ticket_trigger: { /** - * Get List of Accounts + * Updated Ticket */ displayName: () => LocalizedString /** - * Retrieve a list of accounts. + * Triggers when an existing ticket is updated in Freshdesk. */ shortDesc: () => LocalizedString /** - * Fetches a list of accounts based on specified filters. + * Fires whenever an existing ticket is updated with new details in your Freshdesk instance. For example, changes to subject, priority, status, or assigned agent. */ longDesc: () => LocalizedString - } - account_post: { - groups: { + event_info: { /** - * Accounting + * Structure and types for Freshdesk’s updated ticket data payload. */ - '0': () => LocalizedString + desc: () => LocalizedString } + } + updated_contact_trigger: { /** - * Create Account + * Updated Contact */ displayName: () => LocalizedString /** - * Creates a new account. + * Triggers when an existing contact is updated in Freshdesk. */ shortDesc: () => LocalizedString /** - * Allows the user to create a new account record in NetSuite. + * Fires whenever an existing contact's details are updated in your Freshdesk instance. For example, changes to name, phone number, email, or custom fields. */ longDesc: () => LocalizedString - } - account_id_get: { - groups: { + event_info: { /** - * Accounting + * Structure and types for Freshdesk's updated contact data payload. */ - '0': () => LocalizedString + desc: () => LocalizedString } + } + } + searchOptions: { + orderBy: { /** - * Get Account + * Order By */ displayName: () => LocalizedString /** - * Retrieve details of a specific account. + * Sort results by a specific field */ shortDesc: () => LocalizedString /** - * Fetches detailed information of a single account by its ID. + * Define the field and direction to sort search results */ longDesc: () => LocalizedString - } - account_id_patch: { - groups: { - /** - * Accounting - */ - '0': () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for sorting results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } + } } + } + } + expressions: { + '&&': { /** - * Update Account + * And */ displayName: () => LocalizedString /** - * Updates an existing account. + * Logical AND operator */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific account by its ID. + * Combines multiple conditions where all must be true */ longDesc: () => LocalizedString } - account_id_delete: { - groups: { - /** - * Accounting - */ - '0': () => LocalizedString - } + '||': { /** - * Delete Account + * Or */ displayName: () => LocalizedString /** - * Deletes a specific account. + * Logical OR operator */ shortDesc: () => LocalizedString /** - * Removes an account record from NetSuite based on its ID. + * Combines multiple conditions where at least one must be true */ longDesc: () => LocalizedString } - customer_get: { - groups: { - /** - * CRM - */ - '0': () => LocalizedString - } + '==': { /** - * Get List of Customers + * Equals */ displayName: () => LocalizedString /** - * Retrieve a list of customers. + * Field equals value */ shortDesc: () => LocalizedString /** - * Fetches a list of customers based on specified filters. + * Matches records where the field equals the specified value */ longDesc: () => LocalizedString } - customer_post: { - groups: { - /** - * CRM - */ - '0': () => LocalizedString - } + '!=': { /** - * Create Customer + * Not Equals */ displayName: () => LocalizedString /** - * Creates a new customer. + * Field does not equal value */ shortDesc: () => LocalizedString /** - * Allows the user to create a new customer record in NetSuite. + * Matches records where the field does not equal the specified value */ longDesc: () => LocalizedString } - customer_id_get: { - groups: { - /** - * CRM - */ - '0': () => LocalizedString - } + '>': { /** - * Get Customer + * Greater Than */ displayName: () => LocalizedString /** - * Retrieve details of a specific customer. + * Field is greater than value */ shortDesc: () => LocalizedString /** - * Fetches detailed information of a single customer by its ID. + * Matches records where the field value is greater than the specified value */ longDesc: () => LocalizedString } - customer_id_patch: { - groups: { - /** - * CRM - */ - '0': () => LocalizedString - } + '>=': { /** - * Update Customer + * Greater Than or Equal */ displayName: () => LocalizedString /** - * Updates an existing customer. + * Field is greater than or equal to value */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific customer by its ID. + * Matches records where the field value is greater than or equal to the specified value */ longDesc: () => LocalizedString } - customer_id_delete: { - groups: { - /** - * CRM - */ - '0': () => LocalizedString - } + '<': { /** - * Delete Customer + * Less Than */ displayName: () => LocalizedString /** - * Deletes a specific customer. + * Field is less than value */ shortDesc: () => LocalizedString /** - * Removes a customer record from NetSuite based on its ID. + * Matches records where the field value is less than the specified value */ longDesc: () => LocalizedString } - contact_get: { - groups: { - /** - * CRM - */ - '0': () => LocalizedString - } + '<=': { + /** + * Less Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is less than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than or equal to the specified value + */ + longDesc: () => LocalizedString + } + contains: { + /** + * Contains + */ + displayName: () => LocalizedString + /** + * Field contains value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field contains the specified substring + */ + longDesc: () => LocalizedString + } + 'is-set': { /** - * Get List of Contacts + * Is Set */ displayName: () => LocalizedString /** - * Retrieve a list of contacts. + * Field has a value */ shortDesc: () => LocalizedString /** - * Fetches a list of contacts based on specified filters. + * Matches records where the field has a value (is not empty) */ longDesc: () => LocalizedString } - contact_post: { - groups: { - /** - * CRM - */ - '0': () => LocalizedString - } + 'is-not-set': { /** - * Create Contact + * Is Not Set */ displayName: () => LocalizedString /** - * Creates a new contact. + * Field has no value */ shortDesc: () => LocalizedString /** - * Allows the user to create a new contact record in NetSuite. + * Matches records where the field has no value (is empty) */ longDesc: () => LocalizedString } - contact_id_delete: { + } + } + Front: { + /** + * Front + */ + displayName: () => LocalizedString + groups: { + /** + * Customer Support & Helpdesk + */ + '0': () => LocalizedString + /** + * Messaging & Real-time Communication + */ + '1': () => LocalizedString + } + /** + * Connect with Front to manage shared inboxes, contacts, and customer communications + */ + shortDesc: () => LocalizedString + /** + * Integrate with Front to manage your team shared inboxes, contacts, accounts, and customer conversations. Front is a customer communication platform that brings email and messaging into a shared inbox. This integration enables you to automate contact management, organize accounts, and streamline team collaboration. + */ + longDesc: () => LocalizedString + actions: { + list_accounts: { groups: { /** - * CRM + * Accounts */ '0': () => LocalizedString } /** - * Delete Contact + * List Accounts */ displayName: () => LocalizedString /** - * Deletes a specific contact. + * Retrieve a list of accounts */ shortDesc: () => LocalizedString /** - * Removes a contact record from NetSuite based on its ID. + * Retrieve a list of all accounts in your Front workspace. Accounts represent companies or organizations that your contacts belong to. Use accounts to group contacts and track interactions at the company level. */ longDesc: () => LocalizedString + options: { + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of accounts to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of account records to return. Default is 50. Use pagination for larger datasets. + */ + longDesc: () => LocalizedString + } + } } - contact_id_get: { + get_account: { groups: { /** - * CRM + * Accounts */ '0': () => LocalizedString } /** - * Get Contact + * Get Account */ displayName: () => LocalizedString /** - * Retrieve details of a specific contact. + * Retrieve a single account by ID */ shortDesc: () => LocalizedString /** - * Fetches detailed information of a single contact by its ID. + * Retrieve the full details of a specific account from Front by its ID. Returns all account data including name, description, domains, external ID, and custom fields. */ longDesc: () => LocalizedString + options: { + accountId: { + /** + * Account + */ + displayName: () => LocalizedString + /** + * The account to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the account you want to retrieve. Account IDs start with "acc_". + */ + longDesc: () => LocalizedString + } + } } - contact_id_patch: { + create_account: { groups: { /** - * CRM + * Accounts */ '0': () => LocalizedString } /** - * Update Contact + * Create Account */ displayName: () => LocalizedString /** - * Updates an existing contact. + * Create a new account */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific contact by its ID. + * Create a new account in Front. Accounts represent companies or organizations and can be used to group related contacts together. You can associate domains with accounts to automatically link contacts. */ longDesc: () => LocalizedString + options: { + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * The account name + */ + shortDesc: () => LocalizedString + /** + * The name of the account, typically the company or organization name. This is a required field. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * A description of the account + */ + shortDesc: () => LocalizedString + /** + * An optional description providing additional context about the account, such as the type of business or relationship. + */ + longDesc: () => LocalizedString + } + domains: { + /** + * Domains + */ + displayName: () => LocalizedString + /** + * Email domains associated with the account + */ + shortDesc: () => LocalizedString + /** + * A list of email domains (e.g., "example.com") associated with this account. Contacts with email addresses from these domains can be automatically linked to the account. + */ + longDesc: () => LocalizedString + } + externalId: { + /** + * External ID + */ + displayName: () => LocalizedString + /** + * External system identifier + */ + shortDesc: () => LocalizedString + /** + * An optional external ID to link this account to a record in another system, such as a CRM or billing platform. + */ + longDesc: () => LocalizedString + } + customFields: { + /** + * Custom Fields + */ + displayName: () => LocalizedString + /** + * Custom field values + */ + shortDesc: () => LocalizedString + /** + * An object containing custom field values for the account. The keys should match your configured custom field names. + */ + longDesc: () => LocalizedString + } + } } - opportunity_get: { + update_account: { groups: { /** - * CRM + * Accounts */ '0': () => LocalizedString } /** - * Get List of Opportunities + * Update Account */ displayName: () => LocalizedString /** - * Retrieve a list of opportunities. + * Update an existing account */ shortDesc: () => LocalizedString /** - * Fetches a list of opportunities based on specified filters. + * Update the properties of an existing account in Front. You can modify the name, description, domains, external ID, or custom fields. At least one field must be provided to update. */ longDesc: () => LocalizedString + options: { + accountId: { + /** + * Account + */ + displayName: () => LocalizedString + /** + * The account to update + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the account you want to update. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * The new account name + */ + shortDesc: () => LocalizedString + /** + * Update the name of the account. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * The new description + */ + shortDesc: () => LocalizedString + /** + * Update the description of the account. + */ + longDesc: () => LocalizedString + } + domains: { + /** + * Domains + */ + displayName: () => LocalizedString + /** + * The new list of domains + */ + shortDesc: () => LocalizedString + /** + * Update the list of email domains associated with this account. This will replace the existing domains. + */ + longDesc: () => LocalizedString + } + externalId: { + /** + * External ID + */ + displayName: () => LocalizedString + /** + * The new external ID + */ + shortDesc: () => LocalizedString + /** + * Update the external system identifier for this account. + */ + longDesc: () => LocalizedString + } + customFields: { + /** + * Custom Fields + */ + displayName: () => LocalizedString + /** + * Updated custom field values + */ + shortDesc: () => LocalizedString + /** + * Update custom field values for the account. + */ + longDesc: () => LocalizedString + } + } } - opportunity_id_delete: { + delete_account: { groups: { /** - * CRM + * Accounts */ '0': () => LocalizedString } /** - * Delete Opportunity + * Delete Account */ displayName: () => LocalizedString /** - * Deletes a specific opportunity. + * Delete an account */ shortDesc: () => LocalizedString /** - * Removes an opportunity record from NetSuite based on its ID. + * Delete an account from Front. This action is permanent. Contacts associated with the account will not be deleted but will no longer be linked to this account. */ longDesc: () => LocalizedString + options: { + accountId: { + /** + * Account + */ + displayName: () => LocalizedString + /** + * The account to delete + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the account you want to delete. + */ + longDesc: () => LocalizedString + } + } } - opportunity_id_get: { + list_account_contacts: { groups: { /** - * CRM + * Accounts */ '0': () => LocalizedString } /** - * Get Opportunity + * List Account Contacts */ displayName: () => LocalizedString /** - * Retrieve details of a specific opportunity. + * List contacts associated with an account */ shortDesc: () => LocalizedString /** - * Fetches detailed information of a single opportunity by its ID. + * Retrieve a list of all contacts that are associated with a specific account. This helps you see all the people from a particular company or organization. */ longDesc: () => LocalizedString + options: { + accountId: { + /** + * Account + */ + displayName: () => LocalizedString + /** + * The account to list contacts from + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the account whose contacts you want to retrieve. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of contacts to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of contact records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } } - opportunity_id_patch: { + add_contact_to_account: { groups: { /** - * CRM + * Accounts */ '0': () => LocalizedString } /** - * Update Opportunity + * Add Contact to Account */ displayName: () => LocalizedString /** - * Updates an existing opportunity. + * Add contacts to an account */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific opportunity by its ID. + * Add one or more contacts to an account in Front. This creates an association between the contacts and the account, helping you organize contacts by company or organization. */ longDesc: () => LocalizedString + options: { + accountId: { + /** + * Account + */ + displayName: () => LocalizedString + /** + * The account to add contacts to + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the account where you want to add contacts. + */ + longDesc: () => LocalizedString + } + contactIds: { + /** + * Contacts + */ + displayName: () => LocalizedString + /** + * The contacts to add + */ + shortDesc: () => LocalizedString + /** + * Select one or more contacts to add to the account. Contact IDs start with "crd_". + */ + longDesc: () => LocalizedString + } + } } - opportunity_post: { + remove_contact_from_account: { groups: { /** - * CRM + * Accounts */ '0': () => LocalizedString } /** - * Create Opportunity + * Remove Contact from Account */ displayName: () => LocalizedString /** - * Creates a new opportunity. + * Remove contacts from an account */ shortDesc: () => LocalizedString /** - * Allows the user to create a new opportunity record in NetSuite. + * Remove one or more contacts from an account in Front. This removes the association between the contacts and the account but does not delete the contacts themselves. */ longDesc: () => LocalizedString + options: { + accountId: { + /** + * Account + */ + displayName: () => LocalizedString + /** + * The account to remove contacts from + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the account from which you want to remove contacts. + */ + longDesc: () => LocalizedString + } + contactIds: { + /** + * Contacts + */ + displayName: () => LocalizedString + /** + * The contacts to remove + */ + shortDesc: () => LocalizedString + /** + * Select one or more contacts to remove from the account. + */ + longDesc: () => LocalizedString + } + } } - invoice_get: { + list_contacts: { groups: { /** - * Sales & Billing + * Contacts */ '0': () => LocalizedString } /** - * Get List of Invoices + * List Contacts */ displayName: () => LocalizedString /** - * Retrieve a list of invoices. + * Retrieve a list of contacts */ shortDesc: () => LocalizedString /** - * Fetches a list of invoices based on specified filters. + * Retrieve a list of all contacts in your Front workspace. Contacts represent the people you communicate with. Results can be sorted by creation or update date. */ longDesc: () => LocalizedString + options: { + sortBy: { + /** + * Sort By + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to sort results by: created_at or updated_at. + */ + longDesc: () => LocalizedString + } + sortOrder: { + /** + * Sort Order + */ + displayName: () => LocalizedString + /** + * Sort order direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results: desc (newest first) or asc (oldest first). + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of contacts to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of contact records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } } - invoice_post: { + get_contact: { groups: { /** - * Sales & Billing + * Contacts */ '0': () => LocalizedString } /** - * Create Invoice + * Get Contact */ displayName: () => LocalizedString /** - * Creates a new invoice. + * Retrieve a single contact by ID */ shortDesc: () => LocalizedString /** - * Allows the user to create a new invoice record in NetSuite. + * Retrieve the full details of a specific contact from Front by their ID. Returns all contact data including name, handles (email, phone, etc.), groups, links, and custom fields. */ longDesc: () => LocalizedString options: { - entity: { + contactId: { /** - * Customer for the invoice + * Contact */ displayName: () => LocalizedString /** - * The customer for the invoice + * The contact to retrieve */ shortDesc: () => LocalizedString /** - * The customer for the invoice + * Select or enter the ID of the contact you want to retrieve. Contact IDs start with "crd_". */ longDesc: () => LocalizedString } } } - invoice_id_get: { + create_contact: { groups: { /** - * Sales & Billing + * Contacts */ '0': () => LocalizedString } /** - * Get Invoice + * Create Contact */ displayName: () => LocalizedString /** - * Retrieve details of a specific invoice. + * Create a new contact */ shortDesc: () => LocalizedString /** - * Fetches detailed information of a single invoice by its ID. + * Create a new contact in Front. Contacts represent the people you communicate with. A contact must have at least one handle (email, phone, etc.) to be created. */ longDesc: () => LocalizedString + options: { + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * The contact name + */ + shortDesc: () => LocalizedString + /** + * The display name of the contact. This is optional but recommended for easier identification. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * A description of the contact + */ + shortDesc: () => LocalizedString + /** + * An optional description or notes about the contact. This can include any relevant context about the person. + */ + longDesc: () => LocalizedString + } + handles: { + /** + * Handles + */ + displayName: () => LocalizedString + /** + * Contact handles (email, phone, etc.) + */ + shortDesc: () => LocalizedString + /** + * A list of handles for the contact. Each handle consists of a handle value (e.g., email address) and a source type (email, phone, twitter, etc.). At least one handle is required. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + handle: { + /** + * Handle + */ + displayName: () => LocalizedString + /** + * The handle value + */ + shortDesc: () => LocalizedString + /** + * The actual handle value, such as an email address, phone number, or social media username. + */ + longDesc: () => LocalizedString + } + source: { + /** + * Source + */ + displayName: () => LocalizedString + /** + * The type of handle + */ + shortDesc: () => LocalizedString + /** + * The type of handle: email, phone, twitter, facebook, intercom, front_chat, or custom. + */ + longDesc: () => LocalizedString + } + } + } + } + } + links: { + /** + * Links + */ + displayName: () => LocalizedString + /** + * Associated URLs + */ + shortDesc: () => LocalizedString + /** + * A list of URLs associated with this contact, such as social media profiles or company websites. + */ + longDesc: () => LocalizedString + } + groupNames: { + /** + * Group Names + */ + displayName: () => LocalizedString + /** + * Groups to add the contact to + */ + shortDesc: () => LocalizedString + /** + * A list of group names to add the contact to. Groups help organize contacts into categories. + */ + longDesc: () => LocalizedString + } + customFields: { + /** + * Custom Fields + */ + displayName: () => LocalizedString + /** + * Custom field values + */ + shortDesc: () => LocalizedString + /** + * An object containing custom field values for the contact. The keys should match your configured custom field names. + */ + longDesc: () => LocalizedString + } + } } - invoice_id_patch: { + update_contact: { groups: { /** - * Sales & Billing + * Contacts */ '0': () => LocalizedString } /** - * Update Invoice + * Update Contact */ displayName: () => LocalizedString /** - * Updates an existing invoice. + * Update an existing contact */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific invoice by its ID. + * Update the properties of an existing contact in Front. You can modify the name, description, links, or custom fields. At least one field must be provided to update. */ longDesc: () => LocalizedString + options: { + contactId: { + /** + * Contact + */ + displayName: () => LocalizedString + /** + * The contact to update + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the contact you want to update. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * The new contact name + */ + shortDesc: () => LocalizedString + /** + * Update the display name of the contact. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * The new description + */ + shortDesc: () => LocalizedString + /** + * Update the description or notes about the contact. This can include any relevant context about the person. + */ + longDesc: () => LocalizedString + } + links: { + /** + * Links + */ + displayName: () => LocalizedString + /** + * Associated URLs + */ + shortDesc: () => LocalizedString + /** + * A list of URLs associated with this contact, such as social media profiles or company websites. + */ + longDesc: () => LocalizedString + } + customFields: { + /** + * Custom Fields + */ + displayName: () => LocalizedString + /** + * Updated custom field values + */ + shortDesc: () => LocalizedString + /** + * Update custom field values for the contact. + */ + longDesc: () => LocalizedString + } + } } - invoice_id_delete: { + delete_contact: { groups: { /** - * Sales & Billing + * Contacts */ '0': () => LocalizedString } /** - * Delete Invoice + * Delete Contact */ displayName: () => LocalizedString /** - * Deletes a specific invoice. + * Delete a contact */ shortDesc: () => LocalizedString /** - * Removes an invoice record from NetSuite based on its ID. + * Delete a contact from Front. This action is permanent and will remove all associated data. Conversations with this contact will remain but will no longer be linked to the contact. */ longDesc: () => LocalizedString + options: { + contactId: { + /** + * Contact + */ + displayName: () => LocalizedString + /** + * The contact to delete + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the contact you want to delete. + */ + longDesc: () => LocalizedString + } + } } - journalEntry_get: { + list_contact_conversations: { groups: { /** - * Accounting + * Contacts */ '0': () => LocalizedString } /** - * Get List of Journal Entries + * List Contact Conversations */ displayName: () => LocalizedString /** - * Retrieve a list of journal entries. + * List conversations for a contact */ shortDesc: () => LocalizedString /** - * Fetches a list of journal entries based on specified filters. + * Retrieve a list of all conversations associated with a specific contact. Conversations are returned in reverse chronological order (newest first). This helps you see the full communication history with a contact. */ longDesc: () => LocalizedString + options: { + contactId: { + /** + * Contact + */ + displayName: () => LocalizedString + /** + * The contact to list conversations for + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the contact whose conversations you want to retrieve. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of conversations to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of conversation records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } } - journalEntry_post: { + list_contact_notes: { groups: { /** - * Accounting + * Contacts */ '0': () => LocalizedString + /** + * Notes + */ + '1': () => LocalizedString } /** - * Create Journal Entry + * List Contact Notes */ displayName: () => LocalizedString /** - * Creates a new journal entry. + * List notes for a contact */ shortDesc: () => LocalizedString /** - * Allows the user to create a new journal entry record in NetSuite. + * Retrieve all notes that have been added to a specific contact. Notes are internal annotations visible only to your team, useful for documenting important information about contacts. */ longDesc: () => LocalizedString + options: { + contactId: { + /** + * Contact + */ + displayName: () => LocalizedString + /** + * The contact to list notes for + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the contact whose notes you want to retrieve. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of notes to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of note records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } } - journalEntry_id_get: { + add_contact_note: { groups: { /** - * Accounting + * Contacts */ '0': () => LocalizedString + /** + * Notes + */ + '1': () => LocalizedString } /** - * Get Journal Entry + * Add Note to Contact */ displayName: () => LocalizedString /** - * Retrieve details of a specific journal entry. + * Add a note to a contact */ shortDesc: () => LocalizedString /** - * Fetches detailed information of a single journal entry by its ID. + * Add a new note to a contact in Front. Notes are internal annotations that are only visible to your team members. Use notes to document important information, context, or reminders about a contact. */ longDesc: () => LocalizedString + options: { + contactId: { + /** + * Contact + */ + displayName: () => LocalizedString + /** + * The contact to add the note to + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the contact you want to add a note to. + */ + longDesc: () => LocalizedString + } + body: { + /** + * Note Body + */ + displayName: () => LocalizedString + /** + * The content of the note + */ + shortDesc: () => LocalizedString + /** + * The text content of the note. This will be visible to all team members who can access the contact. + */ + longDesc: () => LocalizedString + } + authorId: { + /** + * Author + */ + displayName: () => LocalizedString + /** + * The teammate who authored the note + */ + shortDesc: () => LocalizedString + /** + * Select the teammate who will be recorded as the author of this note. This is a required field. + */ + longDesc: () => LocalizedString + } + } } - journal_entry_id_patch: { + list_contact_lists: { groups: { /** - * Accounting + * Contact Lists */ '0': () => LocalizedString } /** - * Update Journal Entry + * List Contact Lists */ displayName: () => LocalizedString /** - * Updates an existing journal entry. + * Retrieve all contact lists */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific journal entry by its ID. + * Retrieve a list of all contact lists in your Front workspace. Contact lists are used to organize contacts into groups for easier management, such as for marketing campaigns or customer segments. */ longDesc: () => LocalizedString + options: { + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of contact lists to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of contact list records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } } - journalEntry_id_delete: { + create_contact_list: { groups: { /** - * Accounting + * Contact Lists */ '0': () => LocalizedString } /** - * Delete Journal Entry + * Create Contact List */ displayName: () => LocalizedString /** - * Deletes a specific journal entry. + * Create a new contact list */ shortDesc: () => LocalizedString /** - * Removes a journal entry record from NetSuite based on its ID. + * Create a new contact list in Front. Contact lists help you organize contacts into logical groups. The list will be created in the oldest active workspace that your token has access to. */ longDesc: () => LocalizedString + options: { + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * The contact list name + */ + shortDesc: () => LocalizedString + /** + * The name of the contact list. Choose a descriptive name that clearly identifies the purpose of the list. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * A description of the contact list + */ + shortDesc: () => LocalizedString + /** + * An optional description explaining the purpose of the contact list or the criteria for contacts in it. + */ + longDesc: () => LocalizedString + } + } } - purchaseOrder_get: { + delete_contact_list: { groups: { /** - * Procurement + * Contact Lists */ '0': () => LocalizedString } /** - * Get List of Purchase Orders + * Delete Contact List */ displayName: () => LocalizedString /** - * Retrieve a list of purchase orders. + * Delete a contact list */ shortDesc: () => LocalizedString /** - * Fetches a list of purchase orders based on specified filters. + * Delete a contact list from Front. This removes the list but does not delete the contacts that were in it. The contacts will remain in your workspace. */ longDesc: () => LocalizedString + options: { + contactListId: { + /** + * Contact List + */ + displayName: () => LocalizedString + /** + * The contact list to delete + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the contact list you want to delete. + */ + longDesc: () => LocalizedString + } + } } - purchaseOrder_post: { + list_contacts_in_contact_list: { groups: { /** - * Procurement + * Contact Lists */ '0': () => LocalizedString } /** - * Create Purchase Order + * List Contacts in Contact List */ displayName: () => LocalizedString /** - * Creates a new purchase order. + * List contacts in a specific contact list */ shortDesc: () => LocalizedString /** - * Allows the user to create a new purchase order record in NetSuite. + * Retrieve all contacts that belong to a specific contact list. This helps you see which contacts are included in a particular list or segment. */ longDesc: () => LocalizedString options: { - entity: { + contactListId: { /** - * Vendor + * Contact List */ displayName: () => LocalizedString /** - * The vendor for the purchase order + * The contact list to retrieve contacts from */ shortDesc: () => LocalizedString /** - * The vendor for the purchase order + * Select or enter the ID of the contact list whose contacts you want to see. */ longDesc: () => LocalizedString } - employee: { + limit: { /** - * Employee (Requestor) + * Limit */ displayName: () => LocalizedString /** - * The employee who requested the purchase order + * Maximum number of contacts to return */ shortDesc: () => LocalizedString /** - * The employee who requested the purchase order + * The maximum number of contact records to return. Default is 50. */ longDesc: () => LocalizedString } } } - purchaseOrder_id_get: { - groups: { - /** - * Procurement - */ - '0': () => LocalizedString - } - /** - * Get Purchase Order - */ - displayName: () => LocalizedString - /** - * Retrieve details of a specific purchase order. - */ - shortDesc: () => LocalizedString - /** - * Fetches detailed information of a single purchase order by its ID. - */ - longDesc: () => LocalizedString - } - purchaseOrder_id_patch: { + add_contacts_to_contact_list: { groups: { /** - * Procurement + * Contact Lists */ '0': () => LocalizedString } /** - * Update Purchase Order + * Add Contacts to Contact List */ displayName: () => LocalizedString /** - * Updates an existing purchase order. + * Add contacts to a contact list */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific purchase order by its ID. + * Add one or more contacts to a contact list in Front. This helps you organize contacts into logical groups for easier management and targeted communication. */ longDesc: () => LocalizedString options: { - entity: { + contactListId: { /** - * Vendor + * Contact List */ displayName: () => LocalizedString /** - * The vendor for the purchase order + * The contact list to add contacts to */ shortDesc: () => LocalizedString /** - * The vendor for the purchase order + * Select or enter the ID of the contact list where you want to add contacts. */ longDesc: () => LocalizedString } - employee: { + contactIds: { /** - * Employee (Requestor) + * Contacts */ displayName: () => LocalizedString /** - * The employee who requested the purchase order + * The contacts to add */ shortDesc: () => LocalizedString /** - * The employee who requested the purchase order + * Select one or more contacts to add to the contact list. */ longDesc: () => LocalizedString } } } - purchaseOrder_id_delete: { + remove_contacts_from_contact_list: { groups: { /** - * Procurement + * Contact Lists */ '0': () => LocalizedString } /** - * Delete Purchase Order + * Remove Contacts from Contact List */ displayName: () => LocalizedString /** - * Deletes a specific purchase order. + * Remove contacts from a contact list */ shortDesc: () => LocalizedString /** - * Removes a purchase order record from NetSuite based on its ID. + * Remove one or more contacts from a contact list in Front. This removes the contacts from the list but does not delete the contacts themselves. */ longDesc: () => LocalizedString + options: { + contactListId: { + /** + * Contact List + */ + displayName: () => LocalizedString + /** + * The contact list to remove contacts from + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the contact list from which you want to remove contacts. + */ + longDesc: () => LocalizedString + } + contactIds: { + /** + * Contacts + */ + displayName: () => LocalizedString + /** + * The contacts to remove + */ + shortDesc: () => LocalizedString + /** + * Select one or more contacts to remove from the contact list. + */ + longDesc: () => LocalizedString + } + } } - salesOrder_get: { + list_conversations: { groups: { /** - * Sales & Billing + * Conversations */ '0': () => LocalizedString } /** - * Get List of Sales Orders + * List Conversations */ displayName: () => LocalizedString /** - * Retrieve a list of sales orders. + * Retrieve a list of conversations */ shortDesc: () => LocalizedString /** - * Fetches a list of sales orders based on specified filters. + * Retrieve a list of conversations in your Front workspace. Conversations are returned in reverse chronological order (most recently updated first). You can filter by inbox or status. */ longDesc: () => LocalizedString + options: { + inboxId: { + /** + * Inbox + */ + displayName: () => LocalizedString + /** + * Filter by inbox + */ + shortDesc: () => LocalizedString + /** + * Optionally filter conversations to a specific inbox. Leave empty to retrieve conversations from all inboxes. + */ + longDesc: () => LocalizedString + } + status: { + /** + * Status + */ + displayName: () => LocalizedString + /** + * Filter by conversation status + */ + shortDesc: () => LocalizedString + /** + * Optionally filter conversations by their status: open, archived, deleted, or spam. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of conversations to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of conversation records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } } - salesOrder_post: { + get_conversation: { groups: { /** - * Sales & Billing + * Conversations */ '0': () => LocalizedString } /** - * Create Sales Order + * Get Conversation */ displayName: () => LocalizedString /** - * Creates a new sales order. + * Retrieve a single conversation by ID */ shortDesc: () => LocalizedString /** - * Allows the user to create a new sales order record in NetSuite. + * Retrieve the full details of a specific conversation from Front by its ID. Returns all conversation data including subject, status, assignee, tags, and custom fields. */ longDesc: () => LocalizedString options: { - entity: { + conversationId: { /** - * Customer + * Conversation */ displayName: () => LocalizedString /** - * The customer for the sales order + * The conversation to retrieve */ shortDesc: () => LocalizedString /** - * The customer for the sales order + * Select or enter the ID of the conversation you want to retrieve. Conversation IDs start with "cnv_". */ longDesc: () => LocalizedString } } } - customer_post_simplified: { + search_conversations: { groups: { /** - * CRM + * Conversations */ '0': () => LocalizedString } /** - * Create Customer (Simplified) + * Search Conversations */ displayName: () => LocalizedString /** - * Creates a new customer with simplified options. + * Search for conversations */ shortDesc: () => LocalizedString /** - * Creates a new customer in NetSuite with simplified fields + * Search for conversations in Front using a search query. Returns matching conversations in descending order by last activity along with a count of total matches. */ longDesc: () => LocalizedString options: { - entityStatus: { + query: { /** - * Status + * Search Query */ displayName: () => LocalizedString /** - * Customer status + * The search query */ shortDesc: () => LocalizedString /** - * The status of the customer (e.g., Active, Inactive) + * The search query to find conversations. You can search by keywords, email addresses, or use Front search syntax for advanced queries. */ longDesc: () => LocalizedString } - subsidiary: { + limit: { /** - * Subsidiary + * Limit */ displayName: () => LocalizedString /** - * The subsidiary for the customer + * Maximum number of conversations to return */ shortDesc: () => LocalizedString /** - * The subsidiary for the customer + * The maximum number of conversation records to return. Default is 25. */ longDesc: () => LocalizedString } } } - salesOrder_post_simplified: { + update_conversation: { groups: { /** - * Sales & Billing + * Conversations */ '0': () => LocalizedString } /** - * Create Sales Order (Simplified) + * Update Conversation */ displayName: () => LocalizedString /** - * Creates a new sales order with simplified options. + * Update a conversation */ shortDesc: () => LocalizedString /** - * Creates a new customer sales order in NetSuite with only the most commonly used fields, making order creation faster and more straightforward. + * Update the properties of an existing conversation in Front. You can change the status, move to a different inbox, or update custom fields. */ longDesc: () => LocalizedString options: { - entity: { + conversationId: { /** - * Customer + * Conversation */ displayName: () => LocalizedString /** - * Customer for this order + * The conversation to update */ shortDesc: () => LocalizedString /** - * The NetSuite internal ID of the customer this sales order is for. Must be an existing customer record in your NetSuite account. + * Select or enter the ID of the conversation you want to update. */ longDesc: () => LocalizedString } - memo: { + status: { /** - * Memo + * Status */ displayName: () => LocalizedString /** - * Order notes + * The new status */ shortDesc: () => LocalizedString /** - * Additional notes or information about this order. This will appear in the memo field on the sales order record. + * Update the conversation status to open, archived, deleted, or spam. */ longDesc: () => LocalizedString } - orderStatus: { + inboxId: { /** - * Order Status + * Inbox */ displayName: () => LocalizedString /** - * Current status of order + * Move to inbox */ shortDesc: () => LocalizedString /** - * The processing status of this sales order (e.g., Pending Approval, Pending Fulfillment). Controls workflow and availability for further processing. + * Move the conversation to a different inbox. */ longDesc: () => LocalizedString } - item: { + customFields: { /** - * Order Items + * Custom Fields */ displayName: () => LocalizedString /** - * Products or services being ordered + * Updated custom field values */ shortDesc: () => LocalizedString /** - * List of items being purchased in this order. Each item requires an ID and amount + * Update custom field values for the conversation. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - id: { - /** - * Item ID - */ - displayName: () => LocalizedString - /** - * NetSuite item identifier - */ - shortDesc: () => LocalizedString - /** - * The internal ID of the inventory item, non-inventory item, service, or other item type in NetSuite that is being ordered. - */ - longDesc: () => LocalizedString - } - quantity: { - /** - * Quantity - */ - displayName: () => LocalizedString - /** - * Number of units - */ - shortDesc: () => LocalizedString - /** - * The number of units being ordered for this line item. For services, this is typically hours or days. - */ - longDesc: () => LocalizedString - } - amount: { - /** - * Amount Override - */ - displayName: () => LocalizedString - /** - * Custom price (optional) - */ - shortDesc: () => LocalizedString - /** - * Optional custom price override for this line item. If provided, overrides the standard price calculation (quantity × rate). Leave empty to use standard pricing from the price level assigned to the customer. - */ - longDesc: () => LocalizedString - } - } - } - } } } } - salesOrder_id_get: { + update_conversation_assignee: { groups: { /** - * Sales & Billing + * Conversations */ '0': () => LocalizedString } /** - * Get Sales Order + * Update Conversation Assignee */ displayName: () => LocalizedString /** - * Retrieve details of a specific sales order. + * Assign or unassign a conversation */ shortDesc: () => LocalizedString /** - * Fetches detailed information of a single sales order by its ID. + * Assign a conversation to a teammate or unassign it. Assigning conversations helps route work to the right team members and track ownership. */ longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to update + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation you want to assign. + */ + longDesc: () => LocalizedString + } + assigneeId: { + /** + * Assignee + */ + displayName: () => LocalizedString + /** + * The teammate to assign + */ + shortDesc: () => LocalizedString + /** + * Select a teammate to assign the conversation to. Leave empty to unassign the conversation. + */ + longDesc: () => LocalizedString + } + } } - salesOrder_id_patch: { + add_conversation_tag: { groups: { /** - * Sales & Billing + * Conversations */ '0': () => LocalizedString + /** + * Tags + */ + '1': () => LocalizedString } /** - * Update Sales Order + * Add Tag to Conversation */ displayName: () => LocalizedString /** - * Updates an existing sales order. + * Add tags to a conversation */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific sales order by its ID. + * Add one or more tags to a conversation in Front. Tags help categorize and organize conversations for easier filtering and reporting. */ longDesc: () => LocalizedString options: { - entity: { + conversationId: { /** - * Customer + * Conversation */ displayName: () => LocalizedString /** - * The customer for the sales order + * The conversation to tag */ shortDesc: () => LocalizedString /** - * The customer for the sales order + * Select or enter the ID of the conversation you want to add tags to. + */ + longDesc: () => LocalizedString + } + tagIds: { + /** + * Tags + */ + displayName: () => LocalizedString + /** + * The tags to add + */ + shortDesc: () => LocalizedString + /** + * Select one or more tags to add to the conversation. */ longDesc: () => LocalizedString } } } - salesOrder_id_delete: { + remove_conversation_tag: { groups: { /** - * Sales & Billing + * Conversations */ '0': () => LocalizedString - } - /** - * Delete Sales Order - */ - displayName: () => LocalizedString - /** - * Deletes a specific sales order. - */ - shortDesc: () => LocalizedString - /** - * Removes a sales order record from NetSuite based on its ID. - */ - longDesc: () => LocalizedString - } - vendor_get: { - groups: { /** - * Procurement + * Tags */ - '0': () => LocalizedString + '1': () => LocalizedString } /** - * Get List of Vendors + * Remove Tag from Conversation */ displayName: () => LocalizedString /** - * Retrieve a list of vendors. + * Remove tags from a conversation */ shortDesc: () => LocalizedString /** - * Fetches a list of vendors based on specified filters. + * Remove one or more tags from a conversation in Front. This removes the tag association but does not delete the tags themselves. */ longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to remove tags from + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation you want to remove tags from. + */ + longDesc: () => LocalizedString + } + tagIds: { + /** + * Tags + */ + displayName: () => LocalizedString + /** + * The tags to remove + */ + shortDesc: () => LocalizedString + /** + * Select one or more tags to remove from the conversation. + */ + longDesc: () => LocalizedString + } + } } - vendor_post: { + add_conversation_followers: { groups: { /** - * Procurement + * Conversations */ '0': () => LocalizedString } /** - * Create Vendor + * Add Conversation Followers */ displayName: () => LocalizedString /** - * Creates a new vendor. + * Add followers to a conversation */ shortDesc: () => LocalizedString /** - * Allows the user to create a new vendor record in NetSuite. + * Add teammates as followers to a conversation. Followers receive notifications about conversation updates without being the assignee. */ longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to add followers to + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation you want to add followers to. + */ + longDesc: () => LocalizedString + } + teammateIds: { + /** + * Teammates + */ + displayName: () => LocalizedString + /** + * The teammates to add as followers + */ + shortDesc: () => LocalizedString + /** + * Select one or more teammates to add as followers to the conversation. + */ + longDesc: () => LocalizedString + } + } } - vendor_id_get: { + get_message: { groups: { /** - * Procurement + * Messages */ '0': () => LocalizedString } /** - * Get Vendor + * Get Message */ displayName: () => LocalizedString /** - * Retrieve details of a specific vendor. + * Retrieve a single message by ID */ shortDesc: () => LocalizedString /** - * Fetches detailed information of a single vendor by its ID. + * Retrieve the full details of a specific message from Front by its ID. Returns all message data including content, author, recipients, and attachments. */ longDesc: () => LocalizedString + options: { + messageId: { + /** + * Message ID + */ + displayName: () => LocalizedString + /** + * The message to retrieve + */ + shortDesc: () => LocalizedString + /** + * Enter the ID of the message you want to retrieve. Message IDs start with "msg_". + */ + longDesc: () => LocalizedString + } + } } - vendor_id_patch: { + list_conversation_messages: { groups: { /** - * Procurement + * Conversations */ '0': () => LocalizedString + /** + * Messages + */ + '1': () => LocalizedString } /** - * Update Vendor + * List Conversation Messages */ displayName: () => LocalizedString /** - * Updates an existing vendor. + * List messages in a conversation */ shortDesc: () => LocalizedString /** - * Allows the user to update details of a specific vendor by its ID. + * Retrieve a list of all messages in a specific conversation. Messages are returned in reverse chronological order (newest first). This provides the full message history of a conversation. */ longDesc: () => LocalizedString + options: { + conversationId: { + /** + * Conversation + */ + displayName: () => LocalizedString + /** + * The conversation to list messages from + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the conversation whose messages you want to retrieve. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of messages to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of message records to return. Default is 50. + */ + longDesc: () => LocalizedString + } + } } - vendor_id_delete: { + create_message_reply: { groups: { /** - * Procurement + * Conversations */ '0': () => LocalizedString + /** + * Messages + */ + '1': () => LocalizedString } /** - * Delete Vendor - */ - displayName: () => LocalizedString - /** - * Deletes a specific vendor. - */ - shortDesc: () => LocalizedString - /** - * Removes a vendor record from NetSuite based on its ID. - */ - longDesc: () => LocalizedString - } - } - expressions: { - '&&': { - /** - * And - */ - displayName: () => LocalizedString - /** - * Logical AND operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where all must be true - */ - longDesc: () => LocalizedString - } - '||': { - /** - * Or - */ - displayName: () => LocalizedString - /** - * Logical OR operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where at least one must be true - */ - longDesc: () => LocalizedString - } - '==': { - /** - * Equals - */ - displayName: () => LocalizedString - /** - * Field equals value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field equals the specified value - */ - longDesc: () => LocalizedString - } - '!=': { - /** - * Not Equals - */ - displayName: () => LocalizedString - /** - * Field does not equal value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field does not equal the specified value - */ - longDesc: () => LocalizedString - } - '>': { - /** - * Greater Than - */ - displayName: () => LocalizedString - /** - * Field is greater than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than the specified value - */ - longDesc: () => LocalizedString - } - '>=': { - /** - * Greater Than or Equal - */ - displayName: () => LocalizedString - /** - * Field is greater than or equal to value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than or equal to the specified value - */ - longDesc: () => LocalizedString - } - '<': { - /** - * Less Than - */ - displayName: () => LocalizedString - /** - * Field is less than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is less than the specified value - */ - longDesc: () => LocalizedString - } - '<=': { - /** - * Less Than or Equal - */ - displayName: () => LocalizedString - /** - * Field is less than or equal to value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is less than or equal to the specified value - */ - longDesc: () => LocalizedString - } - 'is-set': { - /** - * Is Set - */ - displayName: () => LocalizedString - /** - * Field has a value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field has a value (is not null) - */ - longDesc: () => LocalizedString - } - 'is-not-set': { - /** - * Is Not Set - */ - displayName: () => LocalizedString - /** - * Field has no value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field has no value (is null) - */ - longDesc: () => LocalizedString - } - contains: { - /** - * Contains - */ - displayName: () => LocalizedString - /** - * Field contains value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field contains the specified substring - */ - longDesc: () => LocalizedString - } - 'starts-with': { - /** - * Starts With - */ - displayName: () => LocalizedString - /** - * Field starts with value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value starts with the specified prefix - */ - longDesc: () => LocalizedString - } - 'ends-with': { - /** - * Ends With - */ - displayName: () => LocalizedString - /** - * Field ends with value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value ends with the specified suffix - */ - longDesc: () => LocalizedString - } - } - searchOptions: { - orderBy: { - /** - * Order By - */ - displayName: () => LocalizedString - /** - * Sort results by a specific field - */ - shortDesc: () => LocalizedString - /** - * Define the field and direction to sort search results - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to use for sorting results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort results (ascending or descending) - */ - longDesc: () => LocalizedString - } - } - } - } - } - } - NocoDB: { - /** - * NocoDB - */ - displayName: () => LocalizedString - groups: { - /** - * Spreadsheets & Data Tables - */ - '0': () => LocalizedString - /** - * Databases & Backend Services - */ - '1': () => LocalizedString - } - /** - * Connect to NocoDB to manage your database tables and records with powerful automation - */ - shortDesc: () => LocalizedString - /** - * The NocoDB integration provides comprehensive access to your NocoDB database operations. Create, read, update, and delete records in your tables, and monitor new entries with real-time triggers. Whether you need to manage data, filter results, or track new records, this integration streamlines your NocoDB workflow automation and database management. - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to NocoDB - */ - title: () => LocalizedString - /** - * To connect to NocoDB, you will need your **NocoDB URL** and an **API Token**. - - ## Getting Your API Token - - 1. Log in to your NocoDB instance - 2. Click on your **profile icon** in the top right corner - 3. Select **Copy Auth Token** from the dropdown menu - 4. Alternatively, go to **Account Settings** → **Tokens** to create a new API token - - ## Connection Details - - ### NocoDB URL - The base URL of your NocoDB instance: - - **NocoDB Cloud**: Use `https://app.nocodb.com` - - **Self-hosted**: Use your instance URL (e.g., `https://nocodb.yourcompany.com`) - - ### API Token - Your API token that grants access to NocoDB. Tokens can be created in your account settings and provide access to all operations within the authorized workspaces and bases. - - **Note:** API tokens provide full access to the workspaces and bases you have permissions for. Ensure you keep your tokens secure and only use them in trusted environments. - */ - content: () => LocalizedString - } - triggers: { - new_document: { - /** - * New Row + * Reply to Conversation */ displayName: () => LocalizedString /** - * Trigger when a new row is added to a NocoDB table + * Send a reply message to a conversation */ shortDesc: () => LocalizedString /** - * Monitors a NocoDB table for new rows and triggers when new records are detected. You can optionally filter which rows trigger the event using a where clause. + * Reply to a conversation by sending a message. The message will be appended to the conversation and sent to the recipients. You can optionally save it as a draft instead of sending immediately. */ longDesc: () => LocalizedString options: { - workspaceId: { - /** - * Workspace - */ - displayName: () => LocalizedString - /** - * The NocoDB workspace containing the base - */ - shortDesc: () => LocalizedString - /** - * Select the NocoDB workspace containing the base with the table you want to monitor. - */ - longDesc: () => LocalizedString - } - baseId: { + conversationId: { /** - * Base + * Conversation */ displayName: () => LocalizedString /** - * The NocoDB base containing the table + * The conversation to reply to */ shortDesc: () => LocalizedString /** - * Select the NocoDB base (project) containing the table you want to monitor for new rows. + * Select or enter the ID of the conversation you want to reply to. */ longDesc: () => LocalizedString } - table: { + body: { /** - * Table + * Message Body */ displayName: () => LocalizedString /** - * The table to monitor for new rows + * The content of the reply */ shortDesc: () => LocalizedString /** - * Select the NocoDB table to monitor. The trigger will fire when new rows are added to this table. + * The HTML content of the reply message. This is the main body text that will be sent to recipients. */ longDesc: () => LocalizedString } - where: { + subject: { /** - * Where Filter + * Subject */ displayName: () => LocalizedString /** - * Optional filter for new rows + * Optional subject line */ shortDesc: () => LocalizedString /** - * Optionally specify a filter using NocoDB where syntax (e.g., "(Status,eq,Active)") to only trigger for rows matching specific criteria. + * An optional subject line for the reply. If not provided, the original conversation subject may be used. */ longDesc: () => LocalizedString } - } - } - } - searchOptions: { - orderBy: { - /** - * Order By - */ - displayName: () => LocalizedString - /** - * Sort results by a specific field - */ - shortDesc: () => LocalizedString - /** - * Define the field and direction to sort search results - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to use for sorting results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort results (ascending or descending) - */ - longDesc: () => LocalizedString - } - } - } - } - } - actions: { - count_records: { - /** - * Count Records - */ - displayName: () => LocalizedString - /** - * Get the count of records in a table - */ - shortDesc: () => LocalizedString - /** - * Returns the total number of records in a NocoDB table. You can optionally filter the count using a where clause to count only records matching specific criteria. - */ - longDesc: () => LocalizedString - options: { - workspaceId: { + to: { /** - * Workspace + * To */ displayName: () => LocalizedString /** - * The NocoDB workspace containing the base + * Additional recipients */ shortDesc: () => LocalizedString /** - * Select the NocoDB workspace containing the base with the table. + * A list of email addresses to send the reply to. These are added to the existing conversation recipients. */ longDesc: () => LocalizedString } - baseId: { + cc: { /** - * Base + * CC */ displayName: () => LocalizedString /** - * The NocoDB base containing the table + * CC recipients */ shortDesc: () => LocalizedString /** - * Select the NocoDB base (project) containing the table. + * A list of email addresses to CC on the reply. */ longDesc: () => LocalizedString } - table: { + bcc: { /** - * Table + * BCC */ displayName: () => LocalizedString /** - * The table to count records from + * BCC recipients */ shortDesc: () => LocalizedString /** - * Select the NocoDB table to count records from. + * A list of email addresses to BCC on the reply. */ longDesc: () => LocalizedString } - where: { + isDraft: { /** - * Where Filter + * Save as Draft */ displayName: () => LocalizedString /** - * Optional filter to count specific records + * Save as draft instead of sending */ shortDesc: () => LocalizedString /** - * Optionally specify a filter using NocoDB where syntax (e.g., "(Status,eq,Active)") to only count records matching specific criteria. + * If true, the message will be saved as a draft instead of being sent immediately. Default is false. */ longDesc: () => LocalizedString } } } - upload_attachment: { + add_conversation_comment: { + groups: { + /** + * Conversations + */ + '0': () => LocalizedString + /** + * Comments + */ + '1': () => LocalizedString + } /** - * Upload Attachment + * Add Comment to Conversation */ displayName: () => LocalizedString /** - * Upload a file to an attachment field + * Add an internal comment to a conversation */ shortDesc: () => LocalizedString /** - * Uploads a file to a specific attachment field in a NocoDB record. The file will be stored in NocoDB and associated with the specified record. + * Add an internal comment to a conversation in Front. Comments are private messages visible only to your teammates and are never sent to external contacts. Use comments for internal notes, discussions, or context sharing. */ longDesc: () => LocalizedString options: { - workspaceId: { - /** - * Workspace - */ - displayName: () => LocalizedString - /** - * The NocoDB workspace containing the base - */ - shortDesc: () => LocalizedString - /** - * Select the NocoDB workspace containing the base with the table. - */ - longDesc: () => LocalizedString - } - baseId: { - /** - * Base - */ - displayName: () => LocalizedString - /** - * The NocoDB base containing the table - */ - shortDesc: () => LocalizedString - /** - * Select the NocoDB base (project) containing the table. - */ - longDesc: () => LocalizedString - } - table: { + conversationId: { /** - * Table + * Conversation */ displayName: () => LocalizedString /** - * The table containing the record + * The conversation to add a comment to */ shortDesc: () => LocalizedString /** - * Select the NocoDB table containing the record to attach the file to. + * Select or enter the ID of the conversation you want to add a comment to. */ longDesc: () => LocalizedString } - recordId: { + body: { /** - * Record ID + * Comment Body */ displayName: () => LocalizedString /** - * The ID of the record to attach the file to + * The content of the comment */ shortDesc: () => LocalizedString /** - * Specify the ID of the record where the file should be uploaded. + * The text content of the internal comment. This will be visible to all teammates who can access the conversation. */ longDesc: () => LocalizedString } - attachmentField: { + } + } + list_conversation_comments: { + groups: { + /** + * Conversations + */ + '0': () => LocalizedString + /** + * Comments + */ + '1': () => LocalizedString + } + /** + * List Conversation Comments + */ + displayName: () => LocalizedString + /** + * List comments in a conversation + */ + shortDesc: () => LocalizedString + /** + * Retrieve a list of all internal comments in a specific conversation. Comments are returned in reverse chronological order (newest first). This provides the full internal discussion history of a conversation. + */ + longDesc: () => LocalizedString + options: { + conversationId: { /** - * Attachment Field + * Conversation */ displayName: () => LocalizedString /** - * The attachment field to upload to + * The conversation to list comments from */ shortDesc: () => LocalizedString /** - * Select the attachment field in the table where the file will be stored. + * Select or enter the ID of the conversation whose comments you want to retrieve. */ longDesc: () => LocalizedString } - file: { + limit: { /** - * File + * Limit */ displayName: () => LocalizedString /** - * The file to upload + * Maximum number of comments to return */ shortDesc: () => LocalizedString /** - * The file to upload to the attachment field. Supports various file types including images, documents, and more. + * The maximum number of comment records to return. Default is 50. */ longDesc: () => LocalizedString } } } - link_records: { + } + triggers: { + new_conversation: { + groups: { + /** + * Conversations + */ + '0': () => LocalizedString + } /** - * Link Records + * New Conversation */ displayName: () => LocalizedString /** - * Create relationships between records + * Triggers when a new conversation is created */ shortDesc: () => LocalizedString /** - * Links records from another table to a record via a link field. This creates a relationship between the records without affecting existing links. + * This trigger fires whenever a new conversation is created in Front. You can optionally filter by inbox or status to only trigger for specific types of conversations. */ longDesc: () => LocalizedString options: { - workspaceId: { + inboxId: { /** - * Workspace + * Inbox */ displayName: () => LocalizedString /** - * The NocoDB workspace containing the base + * Filter by inbox */ shortDesc: () => LocalizedString /** - * Select the NocoDB workspace containing the base with the table. + * Optionally filter to only trigger for conversations in a specific inbox. Leave empty to trigger for all inboxes. */ longDesc: () => LocalizedString } - baseId: { + status: { /** - * Base + * Status */ displayName: () => LocalizedString /** - * The NocoDB base containing the table + * Filter by conversation status */ shortDesc: () => LocalizedString /** - * Select the NocoDB base (project) containing the table. + * Optionally filter to only trigger for conversations with a specific status: open, archived, deleted, or spam. */ longDesc: () => LocalizedString } - table: { + } + } + new_contact: { + groups: { + /** + * Contacts + */ + '0': () => LocalizedString + } + /** + * New Contact + */ + displayName: () => LocalizedString + /** + * Triggers when a new contact is created + */ + shortDesc: () => LocalizedString + /** + * This trigger fires whenever a new contact is created in Front. Use this to automate workflows when new contacts are added to your workspace. + */ + longDesc: () => LocalizedString + options: { + } + } + new_contact_note: { + groups: { + /** + * Contacts + */ + '0': () => LocalizedString + /** + * Notes + */ + '1': () => LocalizedString + } + /** + * New Contact Note + */ + displayName: () => LocalizedString + /** + * Triggers when a new note is added to a contact + */ + shortDesc: () => LocalizedString + /** + * This trigger fires whenever a new note is added to a specific contact in Front. You must specify which contact to monitor for new notes. + */ + longDesc: () => LocalizedString + options: { + contactId: { /** - * Table + * Contact */ displayName: () => LocalizedString /** - * The table containing the source record + * The contact to monitor */ shortDesc: () => LocalizedString /** - * Select the NocoDB table containing the record you want to link from. + * Select or enter the ID of the contact you want to monitor for new notes. The trigger will fire whenever a new note is added to this contact. */ longDesc: () => LocalizedString } - linkField: { + } + } + new_comment: { + groups: { + /** + * Conversations + */ + '0': () => LocalizedString + /** + * Comments + */ + '1': () => LocalizedString + } + /** + * New Comment + */ + displayName: () => LocalizedString + /** + * Triggers when a new comment is added to a conversation + */ + shortDesc: () => LocalizedString + /** + * This trigger fires whenever a new internal comment is added to a specific conversation in Front. Comments are private messages visible only to teammates. You must specify which conversation to monitor for new comments. + */ + longDesc: () => LocalizedString + options: { + conversationId: { /** - * Link Field + * Conversation */ displayName: () => LocalizedString /** - * The link field to use for the relationship + * The conversation to monitor */ shortDesc: () => LocalizedString /** - * Select the link field (Link to Another Record) that defines the relationship between tables. + * Select or enter the ID of the conversation you want to monitor for new comments. The trigger will fire whenever a new comment is added to this conversation. */ longDesc: () => LocalizedString } - recordId: { + } + } + } + } + SharePoint: { + /** + * Microsoft SharePoint + */ + displayName: () => LocalizedString + groups: { + /** + * Documents & Documentation + */ + '0': () => LocalizedString + /** + * Cloud Storage & File Management + */ + '1': () => LocalizedString + } + /** + * Connect, automate, and manage your SharePoint Online workflows with ease. + */ + shortDesc: () => LocalizedString + /** + * Integrate your Microsoft 365 environment to quickly create, update, and synchronize documents, lists, and other assets—all from one secure, user-friendly app. + */ + longDesc: () => LocalizedString + triggers: { + 'new-row': { + /** + * New Row + */ + displayName: () => LocalizedString + /** + * Triggers when a new row is added to a SharePoint list. + */ + shortDesc: () => LocalizedString + /** + * This trigger activates whenever a new row is added to a specified SharePoint list. + */ + longDesc: () => LocalizedString + options: { + site_id: { /** - * Record ID + * Site ID */ displayName: () => LocalizedString /** - * The source record ID + * The unique identifier for the SharePoint site. */ shortDesc: () => LocalizedString /** - * Specify the ID of the record in the source table to link from. + * Enter the Site ID where the target list resides. This ID ensures that the trigger is activated in the correct SharePoint site. */ longDesc: () => LocalizedString } - linkedRecordIds: { + list_id: { /** - * Records to Link + * List ID */ displayName: () => LocalizedString /** - * IDs of records to link + * The unique identifier for the SharePoint list. */ shortDesc: () => LocalizedString /** - * Provide the IDs of records from the linked table to connect to the source record. + * Specify the List ID of the SharePoint list where the new row will be added. */ longDesc: () => LocalizedString } } } - unlink_records: { + } + actions: { + 'create-folder': { /** - * Unlink Records + * Create Folder */ displayName: () => LocalizedString /** - * Remove relationships between records + * Create a new folder in a specified SharePoint drive. */ shortDesc: () => LocalizedString /** - * Removes the link between records via a link field. This breaks the relationship without deleting any records. + * This action creates a new folder within a specified SharePoint document library. Provide the target site, drive, parent folder path, and the desired folder name to organize your files effectively. */ longDesc: () => LocalizedString options: { - workspaceId: { + site_id: { /** - * Workspace + * Site ID */ displayName: () => LocalizedString /** - * The NocoDB workspace containing the base + * The unique identifier for the SharePoint site. */ shortDesc: () => LocalizedString /** - * Select the NocoDB workspace containing the base with the table. + * Enter the unique Site ID where the folder will be created. This ID is required to target the correct SharePoint site in your Microsoft 365 environment. */ longDesc: () => LocalizedString } - baseId: { + drive_id: { /** - * Base + * Drive ID */ displayName: () => LocalizedString /** - * The NocoDB base containing the table + * The unique identifier for the SharePoint drive. */ shortDesc: () => LocalizedString /** - * Select the NocoDB base (project) containing the table. + * Specify the Drive ID corresponding to the document library in which the folder will be created. */ longDesc: () => LocalizedString } - table: { + parent_folder: { /** - * Table + * Parent Folder Path */ displayName: () => LocalizedString /** - * The table containing the source record + * The path of the existing parent folder. */ shortDesc: () => LocalizedString /** - * Select the NocoDB table containing the record you want to unlink from. + * Provide the path of the parent folder where the new folder should reside. This helps maintain an organized folder structure within your SharePoint drive. */ longDesc: () => LocalizedString } - linkField: { + folder_name: { /** - * Link Field + * Folder Name */ displayName: () => LocalizedString /** - * The link field with the relationship + * The name for the new folder. */ shortDesc: () => LocalizedString /** - * Select the link field (Link to Another Record) that defines the relationship to remove. + * Enter the desired name for the new folder. This name will be used as the folder title in SharePoint. */ longDesc: () => LocalizedString } - recordId: { + } + } + 'create-list-item': { + /** + * Create List Item + */ + displayName: () => LocalizedString + /** + * Add a new item to an existing SharePoint list. + */ + shortDesc: () => LocalizedString + /** + * This action creates a new item within a specified SharePoint list. Provide the Site ID and List ID to target the correct list, and include the necessary fields to populate the item data. + */ + longDesc: () => LocalizedString + options: { + site_id: { /** - * Record ID + * Site ID */ displayName: () => LocalizedString /** - * The source record ID + * The unique identifier for the SharePoint site. */ shortDesc: () => LocalizedString /** - * Specify the ID of the record in the source table to unlink from. + * Enter the Site ID where your target list resides. This ID ensures that the action is executed in the correct SharePoint environment. */ longDesc: () => LocalizedString } - linkedRecordIds: { + list_id: { /** - * Records to Unlink + * List ID */ displayName: () => LocalizedString /** - * IDs of records to unlink + * The unique identifier for the SharePoint list. */ shortDesc: () => LocalizedString /** - * Provide the IDs of records from the linked table to disconnect from the source record. + * Specify the List ID of the SharePoint list to which the new item will be added. */ longDesc: () => LocalizedString } } } - trigger_button: { + 'create-list': { /** - * Trigger Button + * Create List */ displayName: () => LocalizedString /** - * Trigger a button action on records + * Generate a new list within a SharePoint site. */ shortDesc: () => LocalizedString /** - * Programmatically triggers a button action (such as AI generation or webhook) for specified records. Maximum of 25 records can be processed at a time. + * This action creates a new SharePoint list. Provide the Site ID, a name for the list, and a description if needed. This is ideal for setting up new data repositories in your SharePoint site. */ longDesc: () => LocalizedString options: { - workspaceId: { + site_id: { /** - * Workspace + * Site ID */ displayName: () => LocalizedString /** - * The NocoDB workspace containing the base + * The unique identifier for the SharePoint site. */ shortDesc: () => LocalizedString /** - * Select the NocoDB workspace containing the base with the table. + * Enter the Site ID where the new list should be created, ensuring the list is added to the correct SharePoint site. */ longDesc: () => LocalizedString } - baseId: { + list_name: { /** - * Base + * List Name */ displayName: () => LocalizedString /** - * The NocoDB base containing the table + * The name of the new list. */ shortDesc: () => LocalizedString /** - * Select the NocoDB base (project) containing the table. + * Provide a name for your new list. This name will be visible to users and used to identify the list within SharePoint. */ longDesc: () => LocalizedString } - table: { + list_description: { /** - * Table + * List Description */ displayName: () => LocalizedString /** - * The table containing the button field + * A brief description of the list. */ shortDesc: () => LocalizedString /** - * Select the NocoDB table containing the button field to trigger. + * Enter a description for the new list to provide context about its purpose and contents. This helps users understand what the list is used for. */ longDesc: () => LocalizedString } - buttonField: { + } + } + 'delete-list-item': { + /** + * Delete List Item + */ + displayName: () => LocalizedString + /** + * Remove an item from a SharePoint list. + */ + shortDesc: () => LocalizedString + /** + * This action deletes a specific item from a SharePoint list. Provide the Site ID, List ID, and the Item ID of the list item to be removed. Use this action with caution, as deleted items cannot be easily recovered. + */ + longDesc: () => LocalizedString + options: { + site_id: { /** - * Button Field + * Site ID */ displayName: () => LocalizedString /** - * The button field to trigger + * The unique identifier for the SharePoint site. */ shortDesc: () => LocalizedString /** - * Select the button field whose action should be triggered for the specified records. + * Enter the Site ID where the list is hosted, ensuring the deletion is performed in the correct SharePoint environment. */ longDesc: () => LocalizedString } - recordIds: { + list_id: { /** - * Record IDs + * List ID */ displayName: () => LocalizedString /** - * IDs of records to process + * The unique identifier for the SharePoint list. */ shortDesc: () => LocalizedString /** - * Provide the IDs of records to trigger the button action for. Maximum 25 records per request. + * Specify the List ID of the target SharePoint list from which the item will be deleted. */ longDesc: () => LocalizedString } - preview: { + item_id: { /** - * Preview Mode + * Item ID */ displayName: () => LocalizedString /** - * Run in preview mode without saving changes + * The unique identifier for the list item. */ shortDesc: () => LocalizedString /** - * When enabled, the button action runs in preview mode and changes are not saved. Useful for testing. + * Provide the Item ID of the list item that you want to delete. This ensures that the correct item is removed from the list. */ longDesc: () => LocalizedString } } } - } - } - Salesforce: { - groups: { - /** - * CRM & Sales Management - */ - '0': () => LocalizedString - } - triggers: { - new_record_trigger: { + 'search-list-item': { /** - * New Record + * Search List Item */ displayName: () => LocalizedString /** - * Triggers when a new record is created in the specified object. + * Search for items in a SharePoint list by title. */ shortDesc: () => LocalizedString /** - * This trigger fires whenever a new record is created in a specified Salesforce object. You can configure the object type to target specific record types, such as Leads, Contacts, or custom objects. It is useful for automating workflows triggered by record creation. + * This action searches for list items within a specified SharePoint list that match a provided title or search term. Use this action to quickly locate specific items based on their Title field. */ longDesc: () => LocalizedString options: { - object: { + site_id: { /** - * Object Type + * Site ID */ displayName: () => LocalizedString /** - * The Salesforce object to monitor for new records. + * The unique identifier for the SharePoint site. */ shortDesc: () => LocalizedString /** - * Select the Salesforce object (e.g., Lead, Account, Contact) where this trigger will monitor for newly created records. + * Enter the Site ID where the list is located, ensuring the search is conducted in the correct SharePoint site. */ longDesc: () => LocalizedString } - } - event_info: { - /** - * Fires when a new record is created in the specified Salesforce object. - */ - desc: () => LocalizedString - } - } - new_contact_trigger: { - /** - * New Contact - */ - displayName: () => LocalizedString - /** - * Triggers when a new Contact record is created. - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a new Contact record is created in Salesforce. It is ideal for automating workflows such as contact notifications, integrations, or CRM updates. - */ - longDesc: () => LocalizedString - event_info: { - /** - * Fires when a new Contact record is created in Salesforce. - */ - desc: () => LocalizedString - } - } - new_lead_trigger: { - /** - * New Lead - */ - displayName: () => LocalizedString - /** - * Triggers when a new Lead record is created. - */ - shortDesc: () => LocalizedString - /** - * This trigger activates whenever a new Lead record is created in Salesforce. It is commonly used for workflows related to lead generation, qualification, or assignment. - */ - longDesc: () => LocalizedString - event_info: { - /** - * Fires when a new Lead record is created in Salesforce. - */ - desc: () => LocalizedString - } - } - updated_record_trigger: { - /** - * Updated Record - */ - displayName: () => LocalizedString - /** - * Triggers when an existing record is updated. - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever an existing record in a specified Salesforce object is updated. It is useful for workflows that depend on changes to specific fields or records, such as updating downstream systems or notifying users of record changes. - */ - longDesc: () => LocalizedString - options: { - object: { + list_id: { /** - * Object Type + * List ID */ displayName: () => LocalizedString /** - * The Salesforce object to monitor for updates. + * The unique identifier for the SharePoint list. */ shortDesc: () => LocalizedString /** - * Specify the Salesforce object (e.g., Opportunity, Contact, or custom objects) where this trigger will monitor for record updates. + * Provide the List ID of the SharePoint list to be searched. + */ + longDesc: () => LocalizedString + } + search_value: { + /** + * Search Value + */ + displayName: () => LocalizedString + /** + * The search term to filter list items. + */ + shortDesc: () => LocalizedString + /** + * Enter the text value to search for within the list items, particularly in the Title field. This value is used to filter and return matching items. */ longDesc: () => LocalizedString } - } - event_info: { - /** - * Fires when a record in the specified Salesforce object is updated. - */ - desc: () => LocalizedString } } - } - } - Freshdesk: { - /** - * Freshdesk - */ - displayName: () => LocalizedString - groups: { - /** - * Customer Support & Helpdesk - */ - '0': () => LocalizedString - } - /** - * Cloud-based customer support software - */ - shortDesc: () => LocalizedString - /** - * Freshdesk is a cloud-based customer support platform that was founded with the mission of enabling companies of all sizes to provide great customer service. Our goal is simple: make it easy for brands to talk to their customers and make it easy for users to get in touch with businesses. - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to Freshdesk - */ - title: () => LocalizedString - /** - * To connect to Freshdesk, you will need your **Subdomain** and **API Key**. - - ## Finding Your Subdomain - - Your Freshdesk subdomain is the unique identifier in your Freshdesk URL: - - If your Freshdesk URL is `https://yourcompany.freshdesk.com`, your subdomain is `yourcompany` - - ## Getting Your API Key - - 1. Log in to your Freshdesk account - 2. Click on your **profile icon** in the top right corner - 3. Select **Profile settings** - 4. Scroll down to find your **API Key** section - 5. Click **View API Key** to reveal your key - 6. Copy the API key - - ## Connection Details - - ### Subdomain - Your Freshdesk subdomain (e.g., `yourcompany` from `yourcompany.freshdesk.com`). Do not include the full URL, just the subdomain portion. - - ### API Key - Your personal Freshdesk API key. This key is tied to your user account and inherits your permissions within Freshdesk. - - **Note:** Your API key provides access based on your user role and permissions in Freshdesk. For production integrations, consider using a dedicated service account with appropriate permissions. Keep your API key secure and never share it publicly. - */ - content: () => LocalizedString - } - triggers: { - new_ticket_trigger: { + 'update-list-item': { /** - * New Ticket + * Update List Item */ displayName: () => LocalizedString /** - * Triggers when a new ticket is created in Freshdesk. + * Modify an existing item in a SharePoint list. */ shortDesc: () => LocalizedString /** - * Fires whenever a new ticket is created in your Freshdesk instance. You can capture details such as subject, description, priority, and more, and use this data in subsequent actions or notifications. + * This action updates the fields of an existing list item in a SharePoint list. Provide the Site ID, List ID, and Item ID to locate the item, along with the new field values that should be applied. */ longDesc: () => LocalizedString options: { - ticketStatus: { + site_id: { /** - * Ticket Status Filter + * Site ID */ displayName: () => LocalizedString /** - * Filters by ticket status + * The unique identifier for the SharePoint site. */ shortDesc: () => LocalizedString /** - * Restrict or filter the trigger to only fire for tickets matching a certain status (e.g. Open, Pending, Resolved, etc.). + * Enter the Site ID where the list is hosted. This identifies the correct SharePoint site in your Microsoft 365 environment. */ longDesc: () => LocalizedString } - ticketPriority: { + list_id: { /** - * Ticket Priority Filter + * List ID */ displayName: () => LocalizedString /** - * Filters by ticket priority + * The unique identifier for the SharePoint list. */ shortDesc: () => LocalizedString /** - * Restrict or filter the trigger to only fire for tickets matching a certain priority (e.g. Low, Medium, High). + * Provide the List ID of the target SharePoint list that contains the item you wish to update. */ longDesc: () => LocalizedString } - } - event_info: { - /** - * Structure and types for Freshdesk’s new ticket data payload. - */ - desc: () => LocalizedString - } - } - new_contact_trigger: { - /** - * New Contact - */ - displayName: () => LocalizedString - /** - * Triggers when a new contact is created in Freshdesk. - */ - shortDesc: () => LocalizedString - /** - * Fires whenever a new contact is added to your Freshdesk instance. Capture details such as name, email, phone, and any custom fields associated with the contact. - */ - longDesc: () => LocalizedString - event_info: { - /** - * Structure and types for Freshdesk’s new contact data payload. - */ - desc: () => LocalizedString - } - } - updated_ticket_trigger: { - /** - * Updated Ticket - */ - displayName: () => LocalizedString - /** - * Triggers when an existing ticket is updated in Freshdesk. - */ - shortDesc: () => LocalizedString - /** - * Fires whenever an existing ticket is updated with new details in your Freshdesk instance. For example, changes to subject, priority, status, or assigned agent. - */ - longDesc: () => LocalizedString - event_info: { - /** - * Structure and types for Freshdesk’s updated ticket data payload. - */ - desc: () => LocalizedString - } - } - updated_contact_trigger: { - /** - * Updated Contact - */ - displayName: () => LocalizedString - /** - * Triggers when an existing contact is updated in Freshdesk. - */ - shortDesc: () => LocalizedString - /** - * Fires whenever an existing contact's details are updated in your Freshdesk instance. For example, changes to name, phone number, email, or custom fields. - */ - longDesc: () => LocalizedString - event_info: { - /** - * Structure and types for Freshdesk's updated contact data payload. - */ - desc: () => LocalizedString - } - } - } - searchOptions: { - orderBy: { - /** - * Order By - */ - displayName: () => LocalizedString - /** - * Sort results by a specific field - */ - shortDesc: () => LocalizedString - /** - * Define the field and direction to sort search results - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to use for sorting results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort results (ascending or descending) - */ - longDesc: () => LocalizedString - } + item_id: { + /** + * Item ID + */ + displayName: () => LocalizedString + /** + * The unique identifier for the list item. + */ + shortDesc: () => LocalizedString + /** + * Specify the Item ID of the list item that you want to update. This ensures that the correct item is modified. + */ + longDesc: () => LocalizedString } } } @@ -219943,7 +225274,7 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Field contains value + * Field contains substring */ shortDesc: () => LocalizedString /** @@ -219951,2855 +225282,2283 @@ export type TranslationFunctions = { */ longDesc: () => LocalizedString } - 'is-set': { - /** - * Is Set - */ - displayName: () => LocalizedString - /** - * Field has a value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field has a value (is not empty) - */ - longDesc: () => LocalizedString - } - 'is-not-set': { + 'starts-with': { /** - * Is Not Set + * Starts With */ displayName: () => LocalizedString /** - * Field has no value + * Field starts with value */ shortDesc: () => LocalizedString /** - * Matches records where the field has no value (is empty) + * Matches records where the field value starts with the specified string */ longDesc: () => LocalizedString } } - } - Front: { - /** - * Front - */ - displayName: () => LocalizedString - groups: { - /** - * Customer Support & Helpdesk - */ - '0': () => LocalizedString - /** - * Messaging & Real-time Communication - */ - '1': () => LocalizedString - } - /** - * Connect with Front to manage shared inboxes, contacts, and customer communications - */ - shortDesc: () => LocalizedString - /** - * Integrate with Front to manage your team shared inboxes, contacts, accounts, and customer conversations. Front is a customer communication platform that brings email and messaging into a shared inbox. This integration enables you to automate contact management, organize accounts, and streamline team collaboration. - */ - longDesc: () => LocalizedString - actions: { - list_accounts: { - groups: { - /** - * Accounts - */ - '0': () => LocalizedString - } - /** - * List Accounts - */ - displayName: () => LocalizedString - /** - * Retrieve a list of accounts - */ - shortDesc: () => LocalizedString - /** - * Retrieve a list of all accounts in your Front workspace. Accounts represent companies or organizations that your contacts belong to. Use accounts to group contacts and track interactions at the company level. - */ - longDesc: () => LocalizedString - options: { - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * Maximum number of accounts to return - */ - shortDesc: () => LocalizedString - /** - * The maximum number of account records to return. Default is 50. Use pagination for larger datasets. - */ - longDesc: () => LocalizedString - } - } - } - get_account: { - groups: { - /** - * Accounts - */ - '0': () => LocalizedString - } - /** - * Get Account - */ - displayName: () => LocalizedString - /** - * Retrieve a single account by ID - */ - shortDesc: () => LocalizedString - /** - * Retrieve the full details of a specific account from Front by its ID. Returns all account data including name, description, domains, external ID, and custom fields. - */ - longDesc: () => LocalizedString - options: { - accountId: { - /** - * Account - */ - displayName: () => LocalizedString - /** - * The account to retrieve - */ - shortDesc: () => LocalizedString - /** - * Select or enter the ID of the account you want to retrieve. Account IDs start with "acc_". - */ - longDesc: () => LocalizedString - } - } - } - create_account: { - groups: { - /** - * Accounts - */ - '0': () => LocalizedString - } - /** - * Create Account - */ - displayName: () => LocalizedString - /** - * Create a new account - */ - shortDesc: () => LocalizedString - /** - * Create a new account in Front. Accounts represent companies or organizations and can be used to group related contacts together. You can associate domains with accounts to automatically link contacts. - */ - longDesc: () => LocalizedString - options: { - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * The account name - */ - shortDesc: () => LocalizedString - /** - * The name of the account, typically the company or organization name. This is a required field. - */ - longDesc: () => LocalizedString - } - description: { - /** - * Description - */ - displayName: () => LocalizedString - /** - * A description of the account - */ - shortDesc: () => LocalizedString - /** - * An optional description providing additional context about the account, such as the type of business or relationship. - */ - longDesc: () => LocalizedString - } - domains: { - /** - * Domains - */ - displayName: () => LocalizedString - /** - * Email domains associated with the account - */ - shortDesc: () => LocalizedString - /** - * A list of email domains (e.g., "example.com") associated with this account. Contacts with email addresses from these domains can be automatically linked to the account. - */ - longDesc: () => LocalizedString - } - externalId: { - /** - * External ID - */ - displayName: () => LocalizedString - /** - * External system identifier - */ - shortDesc: () => LocalizedString - /** - * An optional external ID to link this account to a record in another system, such as a CRM or billing platform. - */ - longDesc: () => LocalizedString - } - customFields: { - /** - * Custom Fields - */ - displayName: () => LocalizedString - /** - * Custom field values - */ - shortDesc: () => LocalizedString - /** - * An object containing custom field values for the account. The keys should match your configured custom field names. - */ - longDesc: () => LocalizedString - } - } - } - update_account: { - groups: { - /** - * Accounts - */ - '0': () => LocalizedString - } - /** - * Update Account - */ - displayName: () => LocalizedString - /** - * Update an existing account - */ - shortDesc: () => LocalizedString - /** - * Update the properties of an existing account in Front. You can modify the name, description, domains, external ID, or custom fields. At least one field must be provided to update. - */ - longDesc: () => LocalizedString - options: { - accountId: { - /** - * Account - */ - displayName: () => LocalizedString - /** - * The account to update - */ - shortDesc: () => LocalizedString - /** - * Select or enter the ID of the account you want to update. - */ - longDesc: () => LocalizedString - } - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * The new account name - */ - shortDesc: () => LocalizedString - /** - * Update the name of the account. - */ - longDesc: () => LocalizedString - } - description: { - /** - * Description - */ - displayName: () => LocalizedString - /** - * The new description - */ - shortDesc: () => LocalizedString - /** - * Update the description of the account. - */ - longDesc: () => LocalizedString - } - domains: { - /** - * Domains - */ - displayName: () => LocalizedString - /** - * The new list of domains - */ - shortDesc: () => LocalizedString - /** - * Update the list of email domains associated with this account. This will replace the existing domains. - */ - longDesc: () => LocalizedString - } - externalId: { - /** - * External ID - */ - displayName: () => LocalizedString - /** - * The new external ID - */ - shortDesc: () => LocalizedString - /** - * Update the external system identifier for this account. - */ - longDesc: () => LocalizedString - } - customFields: { - /** - * Custom Fields - */ - displayName: () => LocalizedString - /** - * Updated custom field values - */ - shortDesc: () => LocalizedString - /** - * Update custom field values for the account. - */ - longDesc: () => LocalizedString - } - } - } - delete_account: { - groups: { - /** - * Accounts - */ - '0': () => LocalizedString - } + searchOptions: { + orderBy: { /** - * Delete Account + * Order By */ displayName: () => LocalizedString - /** - * Delete an account - */ - shortDesc: () => LocalizedString - /** - * Delete an account from Front. This action is permanent. Contacts associated with the account will not be deleted but will no longer be linked to this account. - */ - longDesc: () => LocalizedString - options: { - accountId: { - /** - * Account - */ - displayName: () => LocalizedString - /** - * The account to delete - */ - shortDesc: () => LocalizedString - /** - * Select or enter the ID of the account you want to delete. - */ - longDesc: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for sorting results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } } } } - list_account_contacts: { + } + } + Klaviyo: { + /** + * Klaviyo + */ + displayName: () => LocalizedString + groups: { + /** + * Email & Email Marketing + */ + '0': () => LocalizedString + } + /** + * Email and SMS marketing automation platform + */ + shortDesc: () => LocalizedString + /** + * Klaviyo is a unified customer platform that gives online brands direct ownership of their consumer data and interactions, empowering them to turn transactions with customers into productive long-term relationships. + */ + longDesc: () => LocalizedString + actions: { + get_profile: { groups: { /** - * Accounts + * Profiles */ '0': () => LocalizedString } /** - * List Account Contacts + * Get Profile */ displayName: () => LocalizedString /** - * List contacts associated with an account + * Retrieves a specific profile */ shortDesc: () => LocalizedString /** - * Retrieve a list of all contacts that are associated with a specific account. This helps you see all the people from a particular company or organization. + * Retrieves detailed information about a specific profile by its ID */ longDesc: () => LocalizedString options: { - accountId: { + id: { /** - * Account + * Profile ID */ displayName: () => LocalizedString /** - * The account to list contacts from + * The ID of the profile to retrieve */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the account whose contacts you want to retrieve. + * The unique identifier of the profile you want to retrieve */ longDesc: () => LocalizedString } - limit: { + additionalFields: { /** - * Limit + * Additional Fields */ displayName: () => LocalizedString /** - * Maximum number of contacts to return + * Additional profile fields to include */ shortDesc: () => LocalizedString /** - * The maximum number of contact records to return. Default is 50. + * Optional additional fields to include in the profile response */ longDesc: () => LocalizedString } } } - add_contact_to_account: { + list_campaigns: { groups: { /** - * Accounts + * Campaigns */ '0': () => LocalizedString } /** - * Add Contact to Account + * List Campaigns */ displayName: () => LocalizedString /** - * Add contacts to an account + * Lists campaigns */ shortDesc: () => LocalizedString /** - * Add one or more contacts to an account in Front. This creates an association between the contacts and the account, helping you organize contacts by company or organization. + * Retrieves a list of campaigns with optional filtering and sorting */ longDesc: () => LocalizedString options: { - accountId: { + cursor: { /** - * Account + * Cursor */ displayName: () => LocalizedString /** - * The account to add contacts to + * Pagination cursor */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the account where you want to add contacts. + * Cursor for pagination to get the next set of results */ longDesc: () => LocalizedString } - contactIds: { + pageSize: { /** - * Contacts + * Page Size */ displayName: () => LocalizedString /** - * The contacts to add + * Number of items per page */ shortDesc: () => LocalizedString /** - * Select one or more contacts to add to the account. Contact IDs start with "crd_". + * The number of campaigns to return per page */ longDesc: () => LocalizedString } - } - } - remove_contact_from_account: { - groups: { - /** - * Accounts - */ - '0': () => LocalizedString - } - /** - * Remove Contact from Account - */ - displayName: () => LocalizedString - /** - * Remove contacts from an account - */ - shortDesc: () => LocalizedString - /** - * Remove one or more contacts from an account in Front. This removes the association between the contacts and the account but does not delete the contacts themselves. - */ - longDesc: () => LocalizedString - options: { - accountId: { + channel: { /** - * Account + * Channel */ displayName: () => LocalizedString /** - * The account to remove contacts from + * Campaign channel type */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the account from which you want to remove contacts. + * The channel type to filter campaigns by (email or SMS) */ longDesc: () => LocalizedString } - contactIds: { + name: { /** - * Contacts + * Name */ displayName: () => LocalizedString /** - * The contacts to remove + * Campaign name filter */ shortDesc: () => LocalizedString /** - * Select one or more contacts to remove from the account. + * Filter campaigns by name containing this value + */ + longDesc: () => LocalizedString + } + sort: { + /** + * Sort + */ + displayName: () => LocalizedString + /** + * Sort options + */ + shortDesc: () => LocalizedString + /** + * Sort configuration for the campaign list */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to use for sorting the campaign list + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Sort Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort the campaign list (ascending or descending) + */ + longDesc: () => LocalizedString + } + } + } } } } - list_contacts: { + list_lists: { groups: { /** - * Contacts + * Lists */ '0': () => LocalizedString } /** - * List Contacts + * List Lists */ displayName: () => LocalizedString /** - * Retrieve a list of contacts + * Lists all lists */ shortDesc: () => LocalizedString /** - * Retrieve a list of all contacts in your Front workspace. Contacts represent the people you communicate with. Results can be sorted by creation or update date. + * Retrieves a list of all lists with optional filtering and sorting */ longDesc: () => LocalizedString options: { - sortBy: { + cursor: { /** - * Sort By + * Cursor */ displayName: () => LocalizedString /** - * Field to sort by + * Pagination cursor */ shortDesc: () => LocalizedString /** - * The field to sort results by: created_at or updated_at. + * Cursor for pagination to get the next set of results */ longDesc: () => LocalizedString } - sortOrder: { + filter: { /** - * Sort Order + * Filter */ displayName: () => LocalizedString /** - * Sort order direction + * Filter options */ shortDesc: () => LocalizedString /** - * The direction to sort results: desc (newest first) or asc (oldest first). + * Filter configuration for the list results */ longDesc: () => LocalizedString + type: { + fields: { + name: { + /** + * Name Filter + */ + displayName: () => LocalizedString + /** + * Filter by list names + */ + shortDesc: () => LocalizedString + /** + * Filter lists by names containing these values + */ + longDesc: () => LocalizedString + } + id: { + /** + * ID Filter + */ + displayName: () => LocalizedString + /** + * Filter by list IDs + */ + shortDesc: () => LocalizedString + /** + * Filter lists by specific IDs + */ + longDesc: () => LocalizedString + } + } + } } - limit: { + sort: { /** - * Limit + * Sort */ displayName: () => LocalizedString /** - * Maximum number of contacts to return + * Sort options */ shortDesc: () => LocalizedString /** - * The maximum number of contact records to return. Default is 50. + * Sort configuration for the list results */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to use for sorting the list results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Sort Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort the list results (ascending or descending) + */ + longDesc: () => LocalizedString + } + } + } } } } - get_contact: { + list_profiles: { groups: { /** - * Contacts + * Profiles */ '0': () => LocalizedString } /** - * Get Contact + * List Profiles */ displayName: () => LocalizedString /** - * Retrieve a single contact by ID + * Lists profiles */ shortDesc: () => LocalizedString /** - * Retrieve the full details of a specific contact from Front by their ID. Returns all contact data including name, handles (email, phone, etc.), groups, links, and custom fields. + * Retrieves a list of profiles with optional filtering and sorting */ longDesc: () => LocalizedString options: { - contactId: { + additionalFields: { /** - * Contact + * Additional Fields */ displayName: () => LocalizedString /** - * The contact to retrieve + * Additional profile fields to include */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact you want to retrieve. Contact IDs start with "crd_". + * Optional additional fields to include in the profile responses */ longDesc: () => LocalizedString } - } - } - create_contact: { - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - /** - * Create Contact - */ - displayName: () => LocalizedString - /** - * Create a new contact - */ - shortDesc: () => LocalizedString - /** - * Create a new contact in Front. Contacts represent the people you communicate with. A contact must have at least one handle (email, phone, etc.) to be created. - */ - longDesc: () => LocalizedString - options: { - name: { + cursor: { /** - * Name + * Cursor */ displayName: () => LocalizedString /** - * The contact name + * Pagination cursor */ shortDesc: () => LocalizedString /** - * The display name of the contact. This is optional but recommended for easier identification. + * Cursor for pagination to get the next set of results */ longDesc: () => LocalizedString } - description: { + pageSize: { /** - * Description + * Page Size */ displayName: () => LocalizedString /** - * A description of the contact + * Number of items per page */ shortDesc: () => LocalizedString /** - * An optional description or notes about the contact. This can include any relevant context about the person. + * The number of profiles to return per page */ longDesc: () => LocalizedString } - handles: { + filter: { /** - * Handles + * Filter */ displayName: () => LocalizedString /** - * Contact handles (email, phone, etc.) + * Filter options */ shortDesc: () => LocalizedString /** - * A list of handles for the contact. Each handle consists of a handle value (e.g., email address) and a source type (email, phone, twitter, etc.). At least one handle is required. + * Filter configuration for the profile results */ longDesc: () => LocalizedString type: { - element_type: { - fields: { - handle: { - /** - * Handle - */ - displayName: () => LocalizedString - /** - * The handle value - */ - shortDesc: () => LocalizedString - /** - * The actual handle value, such as an email address, phone number, or social media username. - */ - longDesc: () => LocalizedString - } - source: { - /** - * Source - */ - displayName: () => LocalizedString - /** - * The type of handle - */ - shortDesc: () => LocalizedString - /** - * The type of handle: email, phone, twitter, facebook, intercom, front_chat, or custom. - */ - longDesc: () => LocalizedString - } + fields: { + email: { + /** + * Email Filter + */ + displayName: () => LocalizedString + /** + * Filter by email addresses + */ + shortDesc: () => LocalizedString + /** + * Filter profiles by specific email addresses + */ + longDesc: () => LocalizedString + } + phone_number: { + /** + * Phone Number Filter + */ + displayName: () => LocalizedString + /** + * Filter by phone numbers + */ + shortDesc: () => LocalizedString + /** + * Filter profiles by specific phone numbers + */ + longDesc: () => LocalizedString + } + external_id: { + /** + * External ID Filter + */ + displayName: () => LocalizedString + /** + * Filter by external IDs + */ + shortDesc: () => LocalizedString + /** + * Filter profiles by specific external IDs + */ + longDesc: () => LocalizedString + } + id: { + /** + * ID Filter + */ + displayName: () => LocalizedString + /** + * Filter by profile IDs + */ + shortDesc: () => LocalizedString + /** + * Filter profiles by specific profile IDs + */ + longDesc: () => LocalizedString } } } } - links: { - /** - * Links - */ - displayName: () => LocalizedString - /** - * Associated URLs - */ - shortDesc: () => LocalizedString - /** - * A list of URLs associated with this contact, such as social media profiles or company websites. - */ - longDesc: () => LocalizedString - } - groupNames: { - /** - * Group Names - */ - displayName: () => LocalizedString - /** - * Groups to add the contact to - */ - shortDesc: () => LocalizedString - /** - * A list of group names to add the contact to. Groups help organize contacts into categories. - */ - longDesc: () => LocalizedString - } - customFields: { + sort: { /** - * Custom Fields + * Sort */ displayName: () => LocalizedString /** - * Custom field values + * Sort options */ shortDesc: () => LocalizedString /** - * An object containing custom field values for the contact. The keys should match your configured custom field names. + * Sort configuration for the profile results */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to use for sorting the profile results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Sort Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort the profile results (ascending or descending) + */ + longDesc: () => LocalizedString + } + } + } } } } - update_contact: { + list_segments: { groups: { /** - * Contacts + * Segments */ '0': () => LocalizedString } /** - * Update Contact + * List Segments */ displayName: () => LocalizedString /** - * Update an existing contact + * Lists segments */ shortDesc: () => LocalizedString /** - * Update the properties of an existing contact in Front. You can modify the name, description, links, or custom fields. At least one field must be provided to update. + * Retrieves a list of segments with optional filtering and sorting */ longDesc: () => LocalizedString options: { - contactId: { - /** - * Contact - */ - displayName: () => LocalizedString - /** - * The contact to update - */ - shortDesc: () => LocalizedString - /** - * Select or enter the ID of the contact you want to update. - */ - longDesc: () => LocalizedString - } - name: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * The new contact name - */ - shortDesc: () => LocalizedString - /** - * Update the display name of the contact. - */ - longDesc: () => LocalizedString - } - description: { + cursor: { /** - * Description + * Cursor */ displayName: () => LocalizedString /** - * The new description + * Pagination cursor */ shortDesc: () => LocalizedString /** - * Update the description or notes about the contact. This can include any relevant context about the person. + * Cursor for pagination to get the next set of results */ longDesc: () => LocalizedString } - links: { + filter: { /** - * Links + * Filter */ displayName: () => LocalizedString /** - * Associated URLs + * Filter options */ shortDesc: () => LocalizedString /** - * A list of URLs associated with this contact, such as social media profiles or company websites. + * Filter configuration for the segment results */ longDesc: () => LocalizedString + type: { + fields: { + name: { + /** + * Name Filter + */ + displayName: () => LocalizedString + /** + * Filter by segment names + */ + shortDesc: () => LocalizedString + /** + * Filter segments by names containing these values + */ + longDesc: () => LocalizedString + } + id: { + /** + * ID Filter + */ + displayName: () => LocalizedString + /** + * Filter by segment IDs + */ + shortDesc: () => LocalizedString + /** + * Filter segments by specific IDs + */ + longDesc: () => LocalizedString + } + } + } } - customFields: { + sort: { /** - * Custom Fields + * Sort */ displayName: () => LocalizedString /** - * Updated custom field values + * Sort options */ shortDesc: () => LocalizedString /** - * Update custom field values for the contact. + * Sort configuration for the segment results */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to use for sorting the segment results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Sort Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort the segment results (ascending or descending) + */ + longDesc: () => LocalizedString + } + } + } } } } - delete_contact: { + list_tags: { groups: { /** - * Contacts + * Tags */ '0': () => LocalizedString } /** - * Delete Contact + * List Tags */ displayName: () => LocalizedString /** - * Delete a contact + * Lists tags */ shortDesc: () => LocalizedString /** - * Delete a contact from Front. This action is permanent and will remove all associated data. Conversations with this contact will remain but will no longer be linked to the contact. + * Retrieves a list of tags with optional filtering and sorting */ longDesc: () => LocalizedString options: { - contactId: { + cursor: { /** - * Contact + * Cursor */ displayName: () => LocalizedString /** - * The contact to delete + * Pagination cursor */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact you want to delete. + * Cursor for pagination to get the next set of results */ longDesc: () => LocalizedString } - } - } - list_contact_conversations: { - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - /** - * List Contact Conversations - */ - displayName: () => LocalizedString - /** - * List conversations for a contact - */ - shortDesc: () => LocalizedString - /** - * Retrieve a list of all conversations associated with a specific contact. Conversations are returned in reverse chronological order (newest first). This helps you see the full communication history with a contact. - */ - longDesc: () => LocalizedString - options: { - contactId: { + filter: { /** - * Contact + * Filter */ displayName: () => LocalizedString /** - * The contact to list conversations for + * Filter options */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact whose conversations you want to retrieve. + * Filter configuration for the tag results */ longDesc: () => LocalizedString + type: { + fields: { + name: { + /** + * Name Filter + */ + displayName: () => LocalizedString + /** + * Filter by tag name + */ + shortDesc: () => LocalizedString + /** + * Filter tags by name containing this value + */ + longDesc: () => LocalizedString + } + } + } } - limit: { + sort: { /** - * Limit + * Sort */ displayName: () => LocalizedString /** - * Maximum number of conversations to return + * Sort options */ shortDesc: () => LocalizedString /** - * The maximum number of conversation records to return. Default is 50. + * Sort configuration for the tag results */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * The field to use for sorting the tag results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Sort Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort the tag results (ascending or descending) + */ + longDesc: () => LocalizedString + } + } + } } } } - list_contact_notes: { + remove_profile_from_list: { groups: { /** - * Contacts + * Lists */ '0': () => LocalizedString - /** - * Notes - */ - '1': () => LocalizedString } /** - * List Contact Notes + * Remove Profile from List */ displayName: () => LocalizedString /** - * List notes for a contact + * Removes a profile from a list */ shortDesc: () => LocalizedString /** - * Retrieve all notes that have been added to a specific contact. Notes are internal annotations visible only to your team, useful for documenting important information about contacts. + * Removes a specified profile from a specified list in Klaviyo */ longDesc: () => LocalizedString options: { - contactId: { + profile: { /** - * Contact + * Profile */ displayName: () => LocalizedString /** - * The contact to list notes for + * Profile to remove */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact whose notes you want to retrieve. + * The profile to remove from the list */ longDesc: () => LocalizedString } - limit: { + list: { /** - * Limit + * List */ displayName: () => LocalizedString /** - * Maximum number of notes to return + * Target list */ shortDesc: () => LocalizedString /** - * The maximum number of note records to return. Default is 50. + * The list to remove the profile from */ longDesc: () => LocalizedString } } } - add_contact_note: { + remove_tag_from_list: { groups: { /** - * Contacts + * Tags */ '0': () => LocalizedString /** - * Notes + * Lists */ '1': () => LocalizedString } /** - * Add Note to Contact + * Remove Tag from List */ displayName: () => LocalizedString /** - * Add a note to a contact + * Removes a tag from a list */ shortDesc: () => LocalizedString /** - * Add a new note to a contact in Front. Notes are internal annotations that are only visible to your team members. Use notes to document important information, context, or reminders about a contact. + * Removes a specified tag from a specified list in Klaviyo */ longDesc: () => LocalizedString options: { - contactId: { - /** - * Contact - */ - displayName: () => LocalizedString - /** - * The contact to add the note to - */ - shortDesc: () => LocalizedString - /** - * Select or enter the ID of the contact you want to add a note to. - */ - longDesc: () => LocalizedString - } - body: { + tag: { /** - * Note Body + * Tag */ displayName: () => LocalizedString /** - * The content of the note + * Tag to remove */ shortDesc: () => LocalizedString /** - * The text content of the note. This will be visible to all team members who can access the contact. + * The tag to remove from the list */ longDesc: () => LocalizedString } - authorId: { + list: { /** - * Author + * List */ displayName: () => LocalizedString /** - * The teammate who authored the note + * Target list */ shortDesc: () => LocalizedString /** - * Select the teammate who will be recorded as the author of this note. This is a required field. + * The list to remove the tag from */ longDesc: () => LocalizedString } } } - list_contact_lists: { + remove_tag_from_segment: { groups: { /** - * Contact Lists + * Tags */ '0': () => LocalizedString - } - /** - * List Contact Lists - */ - displayName: () => LocalizedString - /** - * Retrieve all contact lists - */ - shortDesc: () => LocalizedString - /** - * Retrieve a list of all contact lists in your Front workspace. Contact lists are used to organize contacts into groups for easier management, such as for marketing campaigns or customer segments. - */ - longDesc: () => LocalizedString - options: { - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * Maximum number of contact lists to return - */ - shortDesc: () => LocalizedString - /** - * The maximum number of contact list records to return. Default is 50. - */ - longDesc: () => LocalizedString - } - } - } - create_contact_list: { - groups: { /** - * Contact Lists + * Segments */ - '0': () => LocalizedString + '1': () => LocalizedString } /** - * Create Contact List + * Remove Tag from Segment */ displayName: () => LocalizedString /** - * Create a new contact list + * Removes a tag from a segment */ shortDesc: () => LocalizedString /** - * Create a new contact list in Front. Contact lists help you organize contacts into logical groups. The list will be created in the oldest active workspace that your token has access to. + * Removes a specified tag from a specified segment in Klaviyo */ longDesc: () => LocalizedString options: { - name: { + tag: { /** - * Name + * Tag */ displayName: () => LocalizedString /** - * The contact list name + * Tag to remove */ shortDesc: () => LocalizedString /** - * The name of the contact list. Choose a descriptive name that clearly identifies the purpose of the list. + * The tag to remove from the segment */ longDesc: () => LocalizedString } - description: { + segment: { /** - * Description + * Segment */ displayName: () => LocalizedString /** - * A description of the contact list + * Target segment */ shortDesc: () => LocalizedString /** - * An optional description explaining the purpose of the contact list or the criteria for contacts in it. + * The segment to remove the tag from */ longDesc: () => LocalizedString } } } - delete_contact_list: { + send_campaign: { groups: { /** - * Contact Lists + * Campaigns */ '0': () => LocalizedString } /** - * Delete Contact List + * Send Campaign */ displayName: () => LocalizedString /** - * Delete a contact list + * Sends a campaign */ shortDesc: () => LocalizedString /** - * Delete a contact list from Front. This removes the list but does not delete the contacts that were in it. The contacts will remain in your workspace. + * Sends a draft campaign immediately to its target audience */ longDesc: () => LocalizedString options: { - contactListId: { + id: { /** - * Contact List + * Campaign ID */ displayName: () => LocalizedString /** - * The contact list to delete + * The ID of the campaign to send */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact list you want to delete. + * The unique identifier of the campaign you want to send */ longDesc: () => LocalizedString } } } - list_contacts_in_contact_list: { + subscribe_profile: { groups: { /** - * Contact Lists + * Profiles */ '0': () => LocalizedString } /** - * List Contacts in Contact List + * Subscribe Profile */ displayName: () => LocalizedString /** - * List contacts in a specific contact list + * Subscribes a profile to marketing channels */ shortDesc: () => LocalizedString /** - * Retrieve all contacts that belong to a specific contact list. This helps you see which contacts are included in a particular list or segment. + * Subscribes a profile to email marketing, SMS marketing, or both channels */ longDesc: () => LocalizedString options: { - contactListId: { + profileId: { /** - * Contact List + * Profile ID */ displayName: () => LocalizedString /** - * The contact list to retrieve contacts from + * The ID of the profile to subscribe */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact list whose contacts you want to see. + * The unique identifier of the profile to subscribe */ longDesc: () => LocalizedString } - limit: { + email: { /** - * Limit + * Email */ displayName: () => LocalizedString /** - * Maximum number of contacts to return + * Email address */ shortDesc: () => LocalizedString /** - * The maximum number of contact records to return. Default is 50. + * The email address of the profile to subscribe */ longDesc: () => LocalizedString } - } - } - add_contacts_to_contact_list: { - groups: { - /** - * Contact Lists - */ - '0': () => LocalizedString - } - /** - * Add Contacts to Contact List - */ - displayName: () => LocalizedString - /** - * Add contacts to a contact list - */ - shortDesc: () => LocalizedString - /** - * Add one or more contacts to a contact list in Front. This helps you organize contacts into logical groups for easier management and targeted communication. - */ - longDesc: () => LocalizedString - options: { - contactListId: { + phoneNumber: { /** - * Contact List + * Phone Number */ displayName: () => LocalizedString /** - * The contact list to add contacts to + * Phone number */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact list where you want to add contacts. + * The phone number of the profile to subscribe */ longDesc: () => LocalizedString } - contactIds: { + consentToSubscribeToChannel: { /** - * Contacts + * Subscription Channel */ displayName: () => LocalizedString /** - * The contacts to add + * Channel to subscribe to */ shortDesc: () => LocalizedString /** - * Select one or more contacts to add to the contact list. + * The marketing channel(s) to subscribe the profile to */ longDesc: () => LocalizedString } - } - } - remove_contacts_from_contact_list: { - groups: { - /** - * Contact Lists - */ - '0': () => LocalizedString - } - /** - * Remove Contacts from Contact List - */ - displayName: () => LocalizedString - /** - * Remove contacts from a contact list - */ - shortDesc: () => LocalizedString - /** - * Remove one or more contacts from a contact list in Front. This removes the contacts from the list but does not delete the contacts themselves. - */ - longDesc: () => LocalizedString - options: { - contactListId: { + smsSubscriptionType: { /** - * Contact List + * SMS Subscription Type */ displayName: () => LocalizedString /** - * The contact list to remove contacts from + * Type of SMS subscription */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact list from which you want to remove contacts. + * The type of SMS subscription (marketing, transactional, or both) */ longDesc: () => LocalizedString } - contactIds: { + list: { /** - * Contacts + * List */ displayName: () => LocalizedString /** - * The contacts to remove + * Target list */ shortDesc: () => LocalizedString /** - * Select one or more contacts to remove from the contact list. + * Optional list to add the profile to during subscription */ longDesc: () => LocalizedString } } } - list_conversations: { + unsubscribe_profile: { groups: { /** - * Conversations + * Profiles */ '0': () => LocalizedString } /** - * List Conversations + * Unsubscribe Profile */ displayName: () => LocalizedString /** - * Retrieve a list of conversations + * Unsubscribes a profile from marketing channels */ shortDesc: () => LocalizedString /** - * Retrieve a list of conversations in your Front workspace. Conversations are returned in reverse chronological order (most recently updated first). You can filter by inbox or status. + * Unsubscribes a profile from email and/or SMS marketing based on provided identifiers */ longDesc: () => LocalizedString options: { - inboxId: { - /** - * Inbox - */ - displayName: () => LocalizedString - /** - * Filter by inbox - */ - shortDesc: () => LocalizedString - /** - * Optionally filter conversations to a specific inbox. Leave empty to retrieve conversations from all inboxes. - */ - longDesc: () => LocalizedString - } - status: { + email: { /** - * Status + * Email */ displayName: () => LocalizedString /** - * Filter by conversation status + * Email address */ shortDesc: () => LocalizedString /** - * Optionally filter conversations by their status: open, archived, deleted, or spam. + * The email address of the profile to unsubscribe */ longDesc: () => LocalizedString } - limit: { + phoneNumber: { /** - * Limit + * Phone Number */ displayName: () => LocalizedString /** - * Maximum number of conversations to return + * Phone number */ shortDesc: () => LocalizedString /** - * The maximum number of conversation records to return. Default is 50. + * The phone number of the profile to unsubscribe */ longDesc: () => LocalizedString } - } - } - get_conversation: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - } - /** - * Get Conversation - */ - displayName: () => LocalizedString - /** - * Retrieve a single conversation by ID - */ - shortDesc: () => LocalizedString - /** - * Retrieve the full details of a specific conversation from Front by its ID. Returns all conversation data including subject, status, assignee, tags, and custom fields. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + smsSubscriptionType: { /** - * Conversation + * SMS Subscription Type */ displayName: () => LocalizedString /** - * The conversation to retrieve + * Type of SMS subscription to cancel */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to retrieve. Conversation IDs start with "cnv_". + * The type of SMS subscription to cancel (marketing, transactional, or both) */ longDesc: () => LocalizedString } } } - search_conversations: { + update_profile: { groups: { /** - * Conversations + * Profiles */ '0': () => LocalizedString } /** - * Search Conversations + * Update Profile */ displayName: () => LocalizedString /** - * Search for conversations + * Updates an existing profile */ shortDesc: () => LocalizedString /** - * Search for conversations in Front using a search query. Returns matching conversations in descending order by last activity along with a count of total matches. + * Updates an existing profile with new information and optionally adds them to a list */ longDesc: () => LocalizedString options: { - query: { + id: { /** - * Search Query + * Profile ID */ displayName: () => LocalizedString /** - * The search query + * The ID of the profile to update */ shortDesc: () => LocalizedString /** - * The search query to find conversations. You can search by keywords, email addresses, or use Front search syntax for advanced queries. + * The unique identifier of the profile you want to update */ longDesc: () => LocalizedString } - limit: { + email: { /** - * Limit + * Email */ displayName: () => LocalizedString /** - * Maximum number of conversations to return + * Email address */ shortDesc: () => LocalizedString /** - * The maximum number of conversation records to return. Default is 25. + * The new email address for the profile */ longDesc: () => LocalizedString } - } - } - update_conversation: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - } - /** - * Update Conversation - */ - displayName: () => LocalizedString - /** - * Update a conversation - */ - shortDesc: () => LocalizedString - /** - * Update the properties of an existing conversation in Front. You can change the status, move to a different inbox, or update custom fields. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + phoneNumber: { /** - * Conversation + * Phone Number */ displayName: () => LocalizedString /** - * The conversation to update + * Phone number */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to update. + * The new phone number for the profile */ longDesc: () => LocalizedString } - status: { + firstName: { /** - * Status + * First Name */ displayName: () => LocalizedString /** - * The new status + * First name */ shortDesc: () => LocalizedString /** - * Update the conversation status to open, archived, deleted, or spam. + * The first name of the profile */ longDesc: () => LocalizedString } - inboxId: { + lastName: { /** - * Inbox + * Last Name */ displayName: () => LocalizedString /** - * Move to inbox + * Last name */ shortDesc: () => LocalizedString /** - * Move the conversation to a different inbox. + * The last name of the profile */ longDesc: () => LocalizedString } - customFields: { + title: { /** - * Custom Fields + * Title */ displayName: () => LocalizedString /** - * Updated custom field values + * Job title */ shortDesc: () => LocalizedString /** - * Update custom field values for the conversation. + * The job title of the profile */ longDesc: () => LocalizedString } - } - } - update_conversation_assignee: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - } - /** - * Update Conversation Assignee - */ - displayName: () => LocalizedString - /** - * Assign or unassign a conversation - */ - shortDesc: () => LocalizedString - /** - * Assign a conversation to a teammate or unassign it. Assigning conversations helps route work to the right team members and track ownership. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + organization: { /** - * Conversation + * Organization */ displayName: () => LocalizedString /** - * The conversation to update + * Organization name */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to assign. + * The organization or company name for the profile */ longDesc: () => LocalizedString } - assigneeId: { + city: { /** - * Assignee + * City */ displayName: () => LocalizedString /** - * The teammate to assign + * City */ shortDesc: () => LocalizedString /** - * Select a teammate to assign the conversation to. Leave empty to unassign the conversation. + * The city where the profile is located */ longDesc: () => LocalizedString } - } - } - add_conversation_tag: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - /** - * Tags - */ - '1': () => LocalizedString - } - /** - * Add Tag to Conversation - */ - displayName: () => LocalizedString - /** - * Add tags to a conversation - */ - shortDesc: () => LocalizedString - /** - * Add one or more tags to a conversation in Front. Tags help categorize and organize conversations for easier filtering and reporting. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + region: { /** - * Conversation + * Region */ displayName: () => LocalizedString /** - * The conversation to tag + * State or region */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to add tags to. + * The state or region where the profile is located */ longDesc: () => LocalizedString } - tagIds: { + country: { /** - * Tags + * Country */ displayName: () => LocalizedString /** - * The tags to add + * Country */ shortDesc: () => LocalizedString /** - * Select one or more tags to add to the conversation. + * The country where the profile is located */ longDesc: () => LocalizedString } - } - } - remove_conversation_tag: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - /** - * Tags - */ - '1': () => LocalizedString - } - /** - * Remove Tag from Conversation - */ - displayName: () => LocalizedString - /** - * Remove tags from a conversation - */ - shortDesc: () => LocalizedString - /** - * Remove one or more tags from a conversation in Front. This removes the tag association but does not delete the tags themselves. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + zip: { /** - * Conversation + * ZIP Code */ displayName: () => LocalizedString /** - * The conversation to remove tags from + * ZIP or postal code */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to remove tags from. + * The ZIP or postal code for the profile location */ longDesc: () => LocalizedString } - tagIds: { + imageUrl: { /** - * Tags + * Image URL */ displayName: () => LocalizedString /** - * The tags to remove + * Profile image URL */ shortDesc: () => LocalizedString /** - * Select one or more tags to remove from the conversation. + * URL to the profile image */ longDesc: () => LocalizedString } - } - } - add_conversation_followers: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - } - /** - * Add Conversation Followers - */ - displayName: () => LocalizedString - /** - * Add followers to a conversation - */ - shortDesc: () => LocalizedString - /** - * Add teammates as followers to a conversation. Followers receive notifications about conversation updates without being the assignee. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + externalId: { /** - * Conversation + * External ID */ displayName: () => LocalizedString /** - * The conversation to add followers to + * External identifier */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to add followers to. + * External identifier for the profile from your system */ longDesc: () => LocalizedString } - teammateIds: { + customProperties: { /** - * Teammates + * Custom Properties */ displayName: () => LocalizedString /** - * The teammates to add as followers + * Custom profile properties */ shortDesc: () => LocalizedString /** - * Select one or more teammates to add as followers to the conversation. + * Additional custom properties to set on the profile */ longDesc: () => LocalizedString } } } - get_message: { + add_tag_to_list: { groups: { /** - * Messages + * Tags */ '0': () => LocalizedString + /** + * Lists + */ + '1': () => LocalizedString } /** - * Get Message + * Add Tag to List */ displayName: () => LocalizedString /** - * Retrieve a single message by ID + * Adds an existing tag to a list */ shortDesc: () => LocalizedString /** - * Retrieve the full details of a specific message from Front by its ID. Returns all message data including content, author, recipients, and attachments. + * Associates an existing tag with a specified list in Klaviyo */ longDesc: () => LocalizedString options: { - messageId: { + tag: { /** - * Message ID + * Tag */ displayName: () => LocalizedString /** - * The message to retrieve + * Tag to add */ shortDesc: () => LocalizedString /** - * Enter the ID of the message you want to retrieve. Message IDs start with "msg_". + * The tag to add to the list + */ + longDesc: () => LocalizedString + } + list: { + /** + * List + */ + displayName: () => LocalizedString + /** + * Target list + */ + shortDesc: () => LocalizedString + /** + * The list to add the tag to */ longDesc: () => LocalizedString } } } - list_conversation_messages: { + add_tag_to_segment: { groups: { /** - * Conversations + * Tags */ '0': () => LocalizedString /** - * Messages + * Segments */ '1': () => LocalizedString } /** - * List Conversation Messages + * Add Tag to Segment */ displayName: () => LocalizedString /** - * List messages in a conversation + * Adds an existing tag to a segment */ shortDesc: () => LocalizedString /** - * Retrieve a list of all messages in a specific conversation. Messages are returned in reverse chronological order (newest first). This provides the full message history of a conversation. + * Associates an existing tag with a specified segment in Klaviyo */ longDesc: () => LocalizedString options: { - conversationId: { + tag: { /** - * Conversation + * Tag */ displayName: () => LocalizedString /** - * The conversation to list messages from + * Tag to add */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation whose messages you want to retrieve. + * The tag to add to the segment */ longDesc: () => LocalizedString } - limit: { + segment: { /** - * Limit + * Segment */ displayName: () => LocalizedString /** - * Maximum number of messages to return + * Target segment */ shortDesc: () => LocalizedString /** - * The maximum number of message records to return. Default is 50. + * The segment to add the tag to */ longDesc: () => LocalizedString } } } - create_message_reply: { + create_event: { groups: { /** - * Conversations + * Events */ '0': () => LocalizedString - /** - * Messages - */ - '1': () => LocalizedString } /** - * Reply to Conversation + * Create Event */ displayName: () => LocalizedString /** - * Send a reply message to a conversation + * Creates a new event */ shortDesc: () => LocalizedString /** - * Reply to a conversation by sending a message. The message will be appended to the conversation and sent to the recipients. You can optionally save it as a draft instead of sending immediately. + * Creates a new event for a specific metric in Klaviyo */ longDesc: () => LocalizedString options: { - conversationId: { + email: { /** - * Conversation + * Email */ displayName: () => LocalizedString /** - * The conversation to reply to + * Email address */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to reply to. + * The email address of the profile for the event */ longDesc: () => LocalizedString } - body: { + metric: { /** - * Message Body + * Metric */ displayName: () => LocalizedString /** - * The content of the reply + * Event metric */ shortDesc: () => LocalizedString /** - * The HTML content of the reply message. This is the main body text that will be sent to recipients. + * The metric or event type to track */ longDesc: () => LocalizedString } - subject: { + profile: { /** - * Subject + * Profile */ displayName: () => LocalizedString /** - * Optional subject line + * Profile ID */ shortDesc: () => LocalizedString /** - * An optional subject line for the reply. If not provided, the original conversation subject may be used. + * The profile ID to associate with the event */ longDesc: () => LocalizedString } - to: { + time: { /** - * To + * Time */ displayName: () => LocalizedString /** - * Additional recipients + * Event timestamp */ shortDesc: () => LocalizedString /** - * A list of email addresses to send the reply to. These are added to the existing conversation recipients. + * The timestamp when the event occurred */ longDesc: () => LocalizedString } - cc: { + value: { /** - * CC + * Value */ displayName: () => LocalizedString /** - * CC recipients + * Event value */ shortDesc: () => LocalizedString /** - * A list of email addresses to CC on the reply. + * The monetary value associated with the event */ longDesc: () => LocalizedString } - bcc: { + customId: { /** - * BCC + * Custom ID */ displayName: () => LocalizedString /** - * BCC recipients + * Unique event identifier */ shortDesc: () => LocalizedString /** - * A list of email addresses to BCC on the reply. + * A custom unique identifier for the event */ longDesc: () => LocalizedString } - isDraft: { + customProperties: { /** - * Save as Draft + * Custom Properties */ displayName: () => LocalizedString /** - * Save as draft instead of sending + * Event properties */ shortDesc: () => LocalizedString /** - * If true, the message will be saved as a draft instead of being sent immediately. Default is false. + * Additional custom properties for the event */ longDesc: () => LocalizedString } } } - add_conversation_comment: { + create_list: { groups: { /** - * Conversations + * Lists */ '0': () => LocalizedString - /** - * Comments - */ - '1': () => LocalizedString } /** - * Add Comment to Conversation + * Create List */ displayName: () => LocalizedString /** - * Add an internal comment to a conversation + * Creates a new list */ shortDesc: () => LocalizedString /** - * Add an internal comment to a conversation in Front. Comments are private messages visible only to your teammates and are never sent to external contacts. Use comments for internal notes, discussions, or context sharing. + * Creates a new list in Klaviyo with the specified configuration */ longDesc: () => LocalizedString options: { - conversationId: { - /** - * Conversation - */ - displayName: () => LocalizedString - /** - * The conversation to add a comment to - */ - shortDesc: () => LocalizedString - /** - * Select or enter the ID of the conversation you want to add a comment to. - */ - longDesc: () => LocalizedString - } - body: { + name: { /** - * Comment Body + * Name */ displayName: () => LocalizedString /** - * The content of the comment + * List name */ shortDesc: () => LocalizedString /** - * The text content of the internal comment. This will be visible to all teammates who can access the conversation. + * The name of the new list */ longDesc: () => LocalizedString } } } - list_conversation_comments: { + create_or_update_profile: { groups: { /** - * Conversations + * Profiles */ '0': () => LocalizedString - /** - * Comments - */ - '1': () => LocalizedString } /** - * List Conversation Comments + * Create Or Update Profile */ displayName: () => LocalizedString /** - * List comments in a conversation + * Creates a new profile or updates an existing one */ shortDesc: () => LocalizedString /** - * Retrieve a list of all internal comments in a specific conversation. Comments are returned in reverse chronological order (newest first). This provides the full internal discussion history of a conversation. + * Creates a new profile or updates an existing profile and optionally adds it to a list */ longDesc: () => LocalizedString options: { - conversationId: { + id: { /** - * Conversation + * Profile ID */ displayName: () => LocalizedString /** - * The conversation to list comments from + * Profile ID (for update) */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation whose comments you want to retrieve. + * The ID of an existing profile to update (leave empty to create new) */ longDesc: () => LocalizedString } - limit: { + email: { /** - * Limit + * Email */ displayName: () => LocalizedString /** - * Maximum number of comments to return + * Email address */ shortDesc: () => LocalizedString /** - * The maximum number of comment records to return. Default is 50. + * The email address for the profile */ longDesc: () => LocalizedString } - } - } - } - triggers: { - new_conversation: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - } - /** - * New Conversation - */ - displayName: () => LocalizedString - /** - * Triggers when a new conversation is created - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a new conversation is created in Front. You can optionally filter by inbox or status to only trigger for specific types of conversations. - */ - longDesc: () => LocalizedString - options: { - inboxId: { + phoneNumber: { /** - * Inbox + * Phone Number */ displayName: () => LocalizedString /** - * Filter by inbox + * Phone number */ shortDesc: () => LocalizedString /** - * Optionally filter to only trigger for conversations in a specific inbox. Leave empty to trigger for all inboxes. + * The phone number for the profile */ longDesc: () => LocalizedString } - status: { + firstName: { /** - * Status + * First Name */ displayName: () => LocalizedString /** - * Filter by conversation status + * First name */ shortDesc: () => LocalizedString /** - * Optionally filter to only trigger for conversations with a specific status: open, archived, deleted, or spam. + * The first name of the profile */ longDesc: () => LocalizedString } - } - } - new_contact: { - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - } - /** - * New Contact - */ - displayName: () => LocalizedString - /** - * Triggers when a new contact is created - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a new contact is created in Front. Use this to automate workflows when new contacts are added to your workspace. - */ - longDesc: () => LocalizedString - options: { - } - } - new_contact_note: { - groups: { - /** - * Contacts - */ - '0': () => LocalizedString - /** - * Notes - */ - '1': () => LocalizedString - } - /** - * New Contact Note - */ - displayName: () => LocalizedString - /** - * Triggers when a new note is added to a contact - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a new note is added to a specific contact in Front. You must specify which contact to monitor for new notes. - */ - longDesc: () => LocalizedString - options: { - contactId: { + lastName: { /** - * Contact + * Last Name */ displayName: () => LocalizedString /** - * The contact to monitor + * Last name */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the contact you want to monitor for new notes. The trigger will fire whenever a new note is added to this contact. + * The last name of the profile */ longDesc: () => LocalizedString } - } - } - new_comment: { - groups: { - /** - * Conversations - */ - '0': () => LocalizedString - /** - * Comments - */ - '1': () => LocalizedString - } - /** - * New Comment - */ - displayName: () => LocalizedString - /** - * Triggers when a new comment is added to a conversation - */ - shortDesc: () => LocalizedString - /** - * This trigger fires whenever a new internal comment is added to a specific conversation in Front. Comments are private messages visible only to teammates. You must specify which conversation to monitor for new comments. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + title: { /** - * Conversation + * Title */ displayName: () => LocalizedString /** - * The conversation to monitor + * Job title */ shortDesc: () => LocalizedString /** - * Select or enter the ID of the conversation you want to monitor for new comments. The trigger will fire whenever a new comment is added to this conversation. + * The job title of the profile */ longDesc: () => LocalizedString } - } - } - } - } - SharePoint: { - /** - * Microsoft SharePoint - */ - displayName: () => LocalizedString - groups: { - /** - * Documents & Documentation - */ - '0': () => LocalizedString - /** - * Cloud Storage & File Management - */ - '1': () => LocalizedString - } - /** - * Connect, automate, and manage your SharePoint Online workflows with ease. - */ - shortDesc: () => LocalizedString - /** - * Integrate your Microsoft 365 environment to quickly create, update, and synchronize documents, lists, and other assets—all from one secure, user-friendly app. - */ - longDesc: () => LocalizedString - triggers: { - 'new-row': { - /** - * New Row - */ - displayName: () => LocalizedString - /** - * Triggers when a new row is added to a SharePoint list. - */ - shortDesc: () => LocalizedString - /** - * This trigger activates whenever a new row is added to a specified SharePoint list. - */ - longDesc: () => LocalizedString - options: { - site_id: { + organization: { /** - * Site ID + * Organization */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint site. + * Organization name */ shortDesc: () => LocalizedString /** - * Enter the Site ID where the target list resides. This ID ensures that the trigger is activated in the correct SharePoint site. + * The organization or company name for the profile */ longDesc: () => LocalizedString } - list_id: { + city: { /** - * List ID + * City */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint list. + * City */ shortDesc: () => LocalizedString /** - * Specify the List ID of the SharePoint list where the new row will be added. + * The city where the profile is located */ longDesc: () => LocalizedString } - } - } - } - actions: { - 'create-folder': { - /** - * Create Folder - */ - displayName: () => LocalizedString - /** - * Create a new folder in a specified SharePoint drive. - */ - shortDesc: () => LocalizedString - /** - * This action creates a new folder within a specified SharePoint document library. Provide the target site, drive, parent folder path, and the desired folder name to organize your files effectively. - */ - longDesc: () => LocalizedString - options: { - site_id: { + region: { /** - * Site ID + * Region */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint site. + * State or region */ shortDesc: () => LocalizedString /** - * Enter the unique Site ID where the folder will be created. This ID is required to target the correct SharePoint site in your Microsoft 365 environment. + * The state or region where the profile is located */ longDesc: () => LocalizedString } - drive_id: { + country: { /** - * Drive ID + * Country */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint drive. + * Country */ shortDesc: () => LocalizedString /** - * Specify the Drive ID corresponding to the document library in which the folder will be created. + * The country where the profile is located */ longDesc: () => LocalizedString } - parent_folder: { + zip: { /** - * Parent Folder Path + * ZIP Code */ displayName: () => LocalizedString /** - * The path of the existing parent folder. + * ZIP or postal code */ shortDesc: () => LocalizedString /** - * Provide the path of the parent folder where the new folder should reside. This helps maintain an organized folder structure within your SharePoint drive. + * The ZIP or postal code for the profile location */ longDesc: () => LocalizedString } - folder_name: { + imageUrl: { /** - * Folder Name + * Image URL */ displayName: () => LocalizedString /** - * The name for the new folder. + * Profile image URL */ shortDesc: () => LocalizedString /** - * Enter the desired name for the new folder. This name will be used as the folder title in SharePoint. + * URL to the profile image */ longDesc: () => LocalizedString } - } - } - 'create-list-item': { - /** - * Create List Item - */ - displayName: () => LocalizedString - /** - * Add a new item to an existing SharePoint list. - */ - shortDesc: () => LocalizedString - /** - * This action creates a new item within a specified SharePoint list. Provide the Site ID and List ID to target the correct list, and include the necessary fields to populate the item data. - */ - longDesc: () => LocalizedString - options: { - site_id: { + externalId: { /** - * Site ID + * External ID */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint site. + * External identifier */ shortDesc: () => LocalizedString /** - * Enter the Site ID where your target list resides. This ID ensures that the action is executed in the correct SharePoint environment. + * External identifier for the profile from your system */ longDesc: () => LocalizedString } - list_id: { + customProperties: { /** - * List ID + * Custom Properties */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint list. + * Custom profile properties */ shortDesc: () => LocalizedString /** - * Specify the List ID of the SharePoint list to which the new item will be added. + * Additional custom properties to set on the profile */ longDesc: () => LocalizedString } } } - 'create-list': { + create_profile: { + groups: { + /** + * Profiles + */ + '0': () => LocalizedString + } /** - * Create List + * Create Profile */ displayName: () => LocalizedString /** - * Generate a new list within a SharePoint site. + * Creates a new profile */ shortDesc: () => LocalizedString /** - * This action creates a new SharePoint list. Provide the Site ID, a name for the list, and a description if needed. This is ideal for setting up new data repositories in your SharePoint site. + * Creates a new profile in Klaviyo with the specified information */ longDesc: () => LocalizedString options: { - site_id: { + email: { /** - * Site ID + * Email */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint site. + * Email address */ shortDesc: () => LocalizedString /** - * Enter the Site ID where the new list should be created, ensuring the list is added to the correct SharePoint site. + * The email address for the new profile */ longDesc: () => LocalizedString } - list_name: { + phoneNumber: { /** - * List Name + * Phone Number */ displayName: () => LocalizedString /** - * The name of the new list. + * Phone number */ shortDesc: () => LocalizedString /** - * Provide a name for your new list. This name will be visible to users and used to identify the list within SharePoint. + * The phone number for the new profile */ longDesc: () => LocalizedString } - list_description: { + firstName: { /** - * List Description + * First Name */ displayName: () => LocalizedString /** - * A brief description of the list. + * First name */ shortDesc: () => LocalizedString /** - * Enter a description for the new list to provide context about its purpose and contents. This helps users understand what the list is used for. + * The first name of the profile */ longDesc: () => LocalizedString } - } - } - 'delete-list-item': { - /** - * Delete List Item - */ - displayName: () => LocalizedString - /** - * Remove an item from a SharePoint list. - */ - shortDesc: () => LocalizedString - /** - * This action deletes a specific item from a SharePoint list. Provide the Site ID, List ID, and the Item ID of the list item to be removed. Use this action with caution, as deleted items cannot be easily recovered. - */ - longDesc: () => LocalizedString - options: { - site_id: { + lastName: { /** - * Site ID + * Last Name */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint site. + * Last name */ shortDesc: () => LocalizedString /** - * Enter the Site ID where the list is hosted, ensuring the deletion is performed in the correct SharePoint environment. + * The last name of the profile */ longDesc: () => LocalizedString } - list_id: { + title: { /** - * List ID + * Title */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint list. + * Job title */ shortDesc: () => LocalizedString /** - * Specify the List ID of the target SharePoint list from which the item will be deleted. + * The job title of the profile */ longDesc: () => LocalizedString } - item_id: { + organization: { /** - * Item ID + * Organization */ displayName: () => LocalizedString /** - * The unique identifier for the list item. + * Organization name */ shortDesc: () => LocalizedString /** - * Provide the Item ID of the list item that you want to delete. This ensures that the correct item is removed from the list. + * The organization or company name for the profile */ longDesc: () => LocalizedString } - } - } - 'search-list-item': { - /** - * Search List Item - */ - displayName: () => LocalizedString - /** - * Search for items in a SharePoint list by title. - */ - shortDesc: () => LocalizedString - /** - * This action searches for list items within a specified SharePoint list that match a provided title or search term. Use this action to quickly locate specific items based on their Title field. - */ - longDesc: () => LocalizedString - options: { - site_id: { + city: { /** - * Site ID + * City */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint site. + * City */ shortDesc: () => LocalizedString /** - * Enter the Site ID where the list is located, ensuring the search is conducted in the correct SharePoint site. + * The city where the profile is located */ longDesc: () => LocalizedString } - list_id: { + region: { /** - * List ID + * Region */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint list. + * State or region */ shortDesc: () => LocalizedString /** - * Provide the List ID of the SharePoint list to be searched. + * The state or region where the profile is located */ longDesc: () => LocalizedString } - search_value: { + country: { /** - * Search Value + * Country */ displayName: () => LocalizedString /** - * The search term to filter list items. + * Country */ shortDesc: () => LocalizedString /** - * Enter the text value to search for within the list items, particularly in the Title field. This value is used to filter and return matching items. + * The country where the profile is located */ longDesc: () => LocalizedString } - } - } - 'update-list-item': { - /** - * Update List Item - */ - displayName: () => LocalizedString - /** - * Modify an existing item in a SharePoint list. - */ - shortDesc: () => LocalizedString - /** - * This action updates the fields of an existing list item in a SharePoint list. Provide the Site ID, List ID, and Item ID to locate the item, along with the new field values that should be applied. - */ - longDesc: () => LocalizedString - options: { - site_id: { + zip: { /** - * Site ID + * ZIP Code */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint site. + * ZIP or postal code */ shortDesc: () => LocalizedString /** - * Enter the Site ID where the list is hosted. This identifies the correct SharePoint site in your Microsoft 365 environment. + * The ZIP or postal code for the profile location */ longDesc: () => LocalizedString } - list_id: { + imageUrl: { /** - * List ID + * Image URL */ displayName: () => LocalizedString /** - * The unique identifier for the SharePoint list. + * Profile image URL */ shortDesc: () => LocalizedString /** - * Provide the List ID of the target SharePoint list that contains the item you wish to update. + * URL to the profile image */ longDesc: () => LocalizedString } - item_id: { + externalId: { /** - * Item ID + * External ID */ displayName: () => LocalizedString /** - * The unique identifier for the list item. + * External identifier */ shortDesc: () => LocalizedString /** - * Specify the Item ID of the list item that you want to update. This ensures that the correct item is modified. + * External identifier for the profile from your system + */ + longDesc: () => LocalizedString + } + customProperties: { + /** + * Custom Properties + */ + displayName: () => LocalizedString + /** + * Custom profile properties + */ + shortDesc: () => LocalizedString + /** + * Additional custom properties to set on the profile */ longDesc: () => LocalizedString } } } - } - expressions: { - '&&': { - /** - * And - */ - displayName: () => LocalizedString - /** - * Logical AND operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where all must be true - */ - longDesc: () => LocalizedString - } - '||': { - /** - * Or - */ - displayName: () => LocalizedString - /** - * Logical OR operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where at least one must be true - */ - longDesc: () => LocalizedString - } - '==': { - /** - * Equals - */ - displayName: () => LocalizedString - /** - * Field equals value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field equals the specified value - */ - longDesc: () => LocalizedString - } - '!=': { - /** - * Not Equals - */ - displayName: () => LocalizedString - /** - * Field does not equal value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field does not equal the specified value - */ - longDesc: () => LocalizedString - } - '>': { - /** - * Greater Than - */ - displayName: () => LocalizedString - /** - * Field is greater than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than the specified value - */ - longDesc: () => LocalizedString - } - '>=': { + get_campaign: { + groups: { + /** + * Campaigns + */ + '0': () => LocalizedString + } /** - * Greater Than or Equal + * Get Campaign */ displayName: () => LocalizedString /** - * Field is greater than or equal to value + * Retrieves a specific campaign */ shortDesc: () => LocalizedString /** - * Matches records where the field value is greater than or equal to the specified value + * Retrieves detailed information about a specific campaign by its ID */ longDesc: () => LocalizedString + options: { + id: { + /** + * Campaign ID + */ + displayName: () => LocalizedString + /** + * The ID of the campaign to retrieve + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the campaign you want to retrieve + */ + longDesc: () => LocalizedString + } + } } - '<': { + add_profile_to_list: { + groups: { + /** + * Lists + */ + '0': () => LocalizedString + } /** - * Less Than + * Add Profile to List */ displayName: () => LocalizedString /** - * Field is less than value + * Adds an existing profile to a list */ shortDesc: () => LocalizedString /** - * Matches records where the field value is less than the specified value + * Adds an existing profile to a specified list in Klaviyo */ longDesc: () => LocalizedString + options: { + profile: { + /** + * Profile + */ + displayName: () => LocalizedString + /** + * Profile to add + */ + shortDesc: () => LocalizedString + /** + * The profile to add to the list + */ + longDesc: () => LocalizedString + } + list: { + /** + * List + */ + displayName: () => LocalizedString + /** + * Target list + */ + shortDesc: () => LocalizedString + /** + * The list to add the profile to + */ + longDesc: () => LocalizedString + } + } } - '<=': { + } + triggers: { + new_event: { /** - * Less Than or Equal + * New Event */ displayName: () => LocalizedString /** - * Field is less than or equal to value + * Triggers when a new event occurs */ shortDesc: () => LocalizedString /** - * Matches records where the field value is less than or equal to the specified value + * Triggers when a new event occurs for a specific metric in Klaviyo */ longDesc: () => LocalizedString + options: { + metric: { + /** + * Metric + */ + displayName: () => LocalizedString + /** + * Event metric to monitor + */ + shortDesc: () => LocalizedString + /** + * The specific metric or event type to monitor for new events + */ + longDesc: () => LocalizedString + } + } } - contains: { + new_profile: { /** - * Contains + * New Profile */ displayName: () => LocalizedString /** - * Field contains substring + * Triggers when a new profile is created */ shortDesc: () => LocalizedString /** - * Matches records where the field contains the specified substring + * Triggers when a new profile is created in Klaviyo */ longDesc: () => LocalizedString } - 'starts-with': { + new_list_profile: { /** - * Starts With + * Profile Added to List */ displayName: () => LocalizedString /** - * Field starts with value + * Triggers when a profile is added to a list */ shortDesc: () => LocalizedString /** - * Matches records where the field value starts with the specified string + * Triggers when a profile is added to a specific list in Klaviyo */ longDesc: () => LocalizedString + options: { + list: { + /** + * List + */ + displayName: () => LocalizedString + /** + * List to monitor + */ + shortDesc: () => LocalizedString + /** + * The specific list to monitor for new profile additions + */ + longDesc: () => LocalizedString + } + } } - } - searchOptions: { - orderBy: { + new_segment_profile: { /** - * Order By + * Profile Added to Segment */ displayName: () => LocalizedString /** - * Sort results by a specific field + * Triggers when a profile is added to a segment */ shortDesc: () => LocalizedString /** - * Define the field and direction to sort search results + * Triggers when a profile is added to a specific segment in Klaviyo */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to use for sorting results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort results (ascending or descending) - */ - longDesc: () => LocalizedString - } + options: { + segment: { + /** + * Segment + */ + displayName: () => LocalizedString + /** + * Segment to monitor + */ + shortDesc: () => LocalizedString + /** + * The specific segment to monitor for new profile additions + */ + longDesc: () => LocalizedString } } } } } - Klaviyo: { + Outlook: { /** - * Klaviyo + * Microsoft Outlook */ displayName: () => LocalizedString groups: { @@ -222809,734 +227568,614 @@ export type TranslationFunctions = { '0': () => LocalizedString } /** - * Email and SMS marketing automation platform + * Get access to your calendar events, contacts, and emails in Microsoft Outlook. */ shortDesc: () => LocalizedString /** - * Klaviyo is a unified customer platform that gives online brands direct ownership of their consumer data and interactions, empowering them to turn transactions with customers into productive long-term relationships. + * Microsoft Outlook is a personal information manager software system from Microsoft, available as a part of the Microsoft Office suite. Primarily an email application, it also includes a calendar, task manager, contact manager, note taking, journal, and web browsing. Connect your Outlook account to create and manage contacts, calendar events, and send emails. */ longDesc: () => LocalizedString actions: { - get_profile: { - groups: { - /** - * Profiles - */ - '0': () => LocalizedString - } + 'manage-email': { /** - * Get Profile + * Manage Email */ displayName: () => LocalizedString /** - * Retrieves a specific profile + * Delete or move an email message to another folder. */ shortDesc: () => LocalizedString /** - * Retrieves detailed information about a specific profile by its ID + * Performs operations on an existing email message, allowing you to either delete it permanently or move it to another folder in your Outlook mailbox. */ longDesc: () => LocalizedString options: { - id: { + messageId: { /** - * Profile ID + * Message ID */ displayName: () => LocalizedString /** - * The ID of the profile to retrieve + * ID of the email message */ shortDesc: () => LocalizedString /** - * The unique identifier of the profile you want to retrieve + * The unique identifier of the email message to be moved or deleted. */ longDesc: () => LocalizedString } - additionalFields: { + action: { /** - * Additional Fields + * Action */ displayName: () => LocalizedString /** - * Additional profile fields to include + * Action to perform on the email */ shortDesc: () => LocalizedString /** - * Optional additional fields to include in the profile response + * Specify whether to delete the email permanently or move it to another folder. + */ + longDesc: () => LocalizedString + } + targetFolderId: { + /** + * Target Folder ID + */ + displayName: () => LocalizedString + /** + * ID of the target folder + */ + shortDesc: () => LocalizedString + /** + * The ID of the folder where you want to move the email. This field is required only when the action is set to "move". */ longDesc: () => LocalizedString } } } - list_campaigns: { - groups: { - /** - * Campaigns - */ - '0': () => LocalizedString - } + 'search-emails': { /** - * List Campaigns + * Search Emails */ displayName: () => LocalizedString /** - * Lists campaigns + * Search for emails using various filter criteria including advanced attachment filters. */ shortDesc: () => LocalizedString /** - * Retrieves a list of campaigns with optional filtering and sorting + * Search and retrieve emails from Outlook based on dates, senders, recipients, subject, body content, and detailed attachment properties like names, patterns, MIME types, and sizes. */ longDesc: () => LocalizedString options: { - cursor: { + sort: { /** - * Cursor + * Sort */ displayName: () => LocalizedString /** - * Pagination cursor + * Sort emails by a specific field */ shortDesc: () => LocalizedString /** - * Cursor for pagination to get the next set of results + * Sort the email results by a specific field. The default is to sort by received date in descending order. */ longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Sort Field + */ + displayName: () => LocalizedString + /** + * Field to sort by + */ + shortDesc: () => LocalizedString + /** + * Select the field by which to sort the email results. + */ + longDesc: () => LocalizedString + } + order: { + /** + * Sort Order + */ + displayName: () => LocalizedString + /** + * Order of sorting + */ + shortDesc: () => LocalizedString + /** + * Choose the order in which to sort the results. Options include Ascending and Descending. + */ + longDesc: () => LocalizedString + } + } + } } - pageSize: { + limit: { /** - * Page Size + * Limit */ displayName: () => LocalizedString /** - * Number of items per page + * Maximum number of emails to return */ shortDesc: () => LocalizedString /** - * The number of campaigns to return per page + * Sets the maximum number of email results to return. Default is 50. */ longDesc: () => LocalizedString } - channel: { + startDateTime: { /** - * Channel + * Start Date */ displayName: () => LocalizedString /** - * Campaign channel type + * Filter emails received on or after this date */ shortDesc: () => LocalizedString /** - * The channel type to filter campaigns by (email or SMS) + * Only include emails that were received on or after this date and time. */ longDesc: () => LocalizedString } - name: { + endDateTime: { /** - * Name + * End Date */ displayName: () => LocalizedString /** - * Campaign name filter + * Filter emails received on or before this date */ shortDesc: () => LocalizedString /** - * Filter campaigns by name containing this value + * Only include emails that were received on or before this date and time. */ longDesc: () => LocalizedString } - sort: { + fromSender: { /** - * Sort + * From Sender */ displayName: () => LocalizedString /** - * Sort options + * Filter emails from a specific sender */ shortDesc: () => LocalizedString /** - * Sort configuration for the campaign list + * Only include emails from this specific sender email address. */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Sort Field - */ - displayName: () => LocalizedString - /** - * Field to sort by - */ - shortDesc: () => LocalizedString - /** - * The field to use for sorting the campaign list - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Sort Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort the campaign list (ascending or descending) - */ - longDesc: () => LocalizedString - } - } - } } - } - } - list_lists: { - groups: { - /** - * Lists - */ - '0': () => LocalizedString - } - /** - * List Lists - */ - displayName: () => LocalizedString - /** - * Lists all lists - */ - shortDesc: () => LocalizedString - /** - * Retrieves a list of all lists with optional filtering and sorting - */ - longDesc: () => LocalizedString - options: { - cursor: { + toRecipient: { /** - * Cursor + * To Recipient */ displayName: () => LocalizedString /** - * Pagination cursor + * Filter emails sent to a specific recipient */ shortDesc: () => LocalizedString /** - * Cursor for pagination to get the next set of results + * Only include emails sent to this specific recipient email address. */ longDesc: () => LocalizedString } - filter: { + subject: { /** - * Filter + * Subject */ displayName: () => LocalizedString /** - * Filter options + * Filter emails by subject line text */ shortDesc: () => LocalizedString /** - * Filter configuration for the list results + * Only include emails with this text in the subject line. */ longDesc: () => LocalizedString - type: { - fields: { - name: { - /** - * Name Filter - */ - displayName: () => LocalizedString - /** - * Filter by list names - */ - shortDesc: () => LocalizedString - /** - * Filter lists by names containing these values - */ - longDesc: () => LocalizedString - } - id: { - /** - * ID Filter - */ - displayName: () => LocalizedString - /** - * Filter by list IDs - */ - shortDesc: () => LocalizedString - /** - * Filter lists by specific IDs - */ - longDesc: () => LocalizedString - } - } - } } - sort: { + hasAttachments: { /** - * Sort + * Has Attachments */ displayName: () => LocalizedString /** - * Sort options + * Filter emails with or without attachments */ shortDesc: () => LocalizedString /** - * Sort configuration for the list results + * When set to true, only include emails that have attachments. When false, only include emails without attachments. */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Sort Field - */ - displayName: () => LocalizedString - /** - * Field to sort by - */ - shortDesc: () => LocalizedString - /** - * The field to use for sorting the list results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Sort Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort the list results (ascending or descending) - */ - longDesc: () => LocalizedString - } - } - } } - } - } - list_profiles: { - groups: { - /** - * Profiles - */ - '0': () => LocalizedString - } - /** - * List Profiles - */ - displayName: () => LocalizedString - /** - * Lists profiles - */ - shortDesc: () => LocalizedString - /** - * Retrieves a list of profiles with optional filtering and sorting - */ - longDesc: () => LocalizedString - options: { - additionalFields: { + isRead: { /** - * Additional Fields + * Is Read */ displayName: () => LocalizedString /** - * Additional profile fields to include + * Filter read or unread emails */ shortDesc: () => LocalizedString /** - * Optional additional fields to include in the profile responses + * When set to true, only include emails that have been read. When false, only include unread emails. */ longDesc: () => LocalizedString } - cursor: { + attachmentNames: { /** - * Cursor + * Attachment Names */ displayName: () => LocalizedString /** - * Pagination cursor + * Filter emails by specific attachment names */ shortDesc: () => LocalizedString /** - * Cursor for pagination to get the next set of results + * Only include emails that have attachments with these filenames. */ longDesc: () => LocalizedString } - pageSize: { + bodyContains: { /** - * Page Size + * Body Contains */ displayName: () => LocalizedString /** - * Number of items per page + * Filter emails by body content */ shortDesc: () => LocalizedString /** - * The number of profiles to return per page + * Only include emails that contain this text in the body content. */ longDesc: () => LocalizedString } - filter: { + includeAttachments: { /** - * Filter + * Include Attachments */ displayName: () => LocalizedString /** - * Filter options + * Include attachment content in results */ shortDesc: () => LocalizedString /** - * Filter configuration for the profile results + * When set to true, the content of email attachments will be included in the results. This may increase response size significantly. */ longDesc: () => LocalizedString - type: { - fields: { - email: { - /** - * Email Filter - */ - displayName: () => LocalizedString - /** - * Filter by email addresses - */ - shortDesc: () => LocalizedString - /** - * Filter profiles by specific email addresses - */ - longDesc: () => LocalizedString - } - phone_number: { - /** - * Phone Number Filter - */ - displayName: () => LocalizedString - /** - * Filter by phone numbers - */ - shortDesc: () => LocalizedString - /** - * Filter profiles by specific phone numbers - */ - longDesc: () => LocalizedString - } - external_id: { - /** - * External ID Filter - */ - displayName: () => LocalizedString - /** - * Filter by external IDs - */ - shortDesc: () => LocalizedString - /** - * Filter profiles by specific external IDs - */ - longDesc: () => LocalizedString - } - id: { - /** - * ID Filter - */ - displayName: () => LocalizedString - /** - * Filter by profile IDs - */ - shortDesc: () => LocalizedString - /** - * Filter profiles by specific profile IDs - */ - longDesc: () => LocalizedString - } - } - } } - sort: { + folder: { /** - * Sort + * Folder */ displayName: () => LocalizedString /** - * Sort options + * Email folder to search in */ shortDesc: () => LocalizedString /** - * Sort configuration for the profile results + * The email folder to search in. Defaults to Inbox if not specified. */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Sort Field - */ - displayName: () => LocalizedString - /** - * Field to sort by - */ - shortDesc: () => LocalizedString - /** - * The field to use for sorting the profile results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Sort Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort the profile results (ascending or descending) - */ - longDesc: () => LocalizedString - } - } - } } - } - } - list_segments: { - groups: { - /** - * Segments - */ - '0': () => LocalizedString - } - /** - * List Segments - */ - displayName: () => LocalizedString - /** - * Lists segments - */ - shortDesc: () => LocalizedString - /** - * Retrieves a list of segments with optional filtering and sorting - */ - longDesc: () => LocalizedString - options: { - cursor: { + attachmentFilenamePattern: { /** - * Cursor + * Attachment Filename Pattern */ displayName: () => LocalizedString /** - * Pagination cursor + * Filter by attachment filename pattern (regex) */ shortDesc: () => LocalizedString /** - * Cursor for pagination to get the next set of results + * Filter emails by a regular expression pattern that matches attachment filenames. Example: ".*\.pdf$" would match all PDF files. */ longDesc: () => LocalizedString } - filter: { + attachmentMimeTypes: { /** - * Filter + * Attachment MIME Types */ displayName: () => LocalizedString /** - * Filter options + * Filter by attachment MIME types */ shortDesc: () => LocalizedString /** - * Filter configuration for the segment results + * Only include emails with attachments matching these MIME types (e.g., "application/pdf", "image/jpeg"). */ longDesc: () => LocalizedString - type: { - fields: { - name: { - /** - * Name Filter - */ - displayName: () => LocalizedString - /** - * Filter by segment names - */ - shortDesc: () => LocalizedString - /** - * Filter segments by names containing these values - */ - longDesc: () => LocalizedString - } - id: { - /** - * ID Filter - */ - displayName: () => LocalizedString - /** - * Filter by segment IDs - */ - shortDesc: () => LocalizedString - /** - * Filter segments by specific IDs - */ - longDesc: () => LocalizedString - } - } - } } - sort: { + attachmentMinSize: { /** - * Sort + * Attachment Minimum Size */ displayName: () => LocalizedString /** - * Sort options + * Filter by attachment minimum size in bytes */ shortDesc: () => LocalizedString /** - * Sort configuration for the segment results + * Only include emails with attachments larger than or equal to this size in bytes. + */ + longDesc: () => LocalizedString + } + attachmentMaxSize: { + /** + * Attachment Maximum Size + */ + displayName: () => LocalizedString + /** + * Filter by attachment maximum size in bytes + */ + shortDesc: () => LocalizedString + /** + * Only include emails with attachments smaller than or equal to this size in bytes. */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Sort Field - */ - displayName: () => LocalizedString - /** - * Field to sort by - */ - shortDesc: () => LocalizedString - /** - * The field to use for sorting the segment results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Sort Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort the segment results (ascending or descending) - */ - longDesc: () => LocalizedString - } - } - } } } } - list_tags: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - } + 'create-contact': { /** - * List Tags + * Create Contact */ displayName: () => LocalizedString /** - * Lists tags + * Create a new contact in your Outlook contacts. */ shortDesc: () => LocalizedString /** - * Retrieves a list of tags with optional filtering and sorting + * Create a new contact with details such as name, email, phone numbers, and job information in your Microsoft Outlook contacts. */ longDesc: () => LocalizedString options: { - cursor: { + givenName: { /** - * Cursor + * First Name */ displayName: () => LocalizedString /** - * Pagination cursor + * The contact's first name. */ shortDesc: () => LocalizedString /** - * Cursor for pagination to get the next set of results + * Enter the first name or given name of the contact. */ longDesc: () => LocalizedString } - filter: { + surname: { /** - * Filter + * Last Name */ displayName: () => LocalizedString /** - * Filter options + * The contact's last name. */ shortDesc: () => LocalizedString /** - * Filter configuration for the tag results + * Enter the last name or surname of the contact. + */ + longDesc: () => LocalizedString + } + emailAddresses: { + /** + * Email Addresses + */ + displayName: () => LocalizedString + /** + * Email addresses for the contact. + */ + shortDesc: () => LocalizedString + /** + * Enter one or more email addresses for the contact. */ longDesc: () => LocalizedString type: { - fields: { - name: { - /** - * Name Filter - */ - displayName: () => LocalizedString - /** - * Filter by tag name - */ - shortDesc: () => LocalizedString - /** - * Filter tags by name containing this value - */ - longDesc: () => LocalizedString + element_type: { + fields: { + address: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * The email address of the contact. + */ + shortDesc: () => LocalizedString + /** + * Enter a valid email address for the contact. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Display Name + */ + displayName: () => LocalizedString + /** + * The display name for this email address. + */ + shortDesc: () => LocalizedString + /** + * Enter how you want the name to appear for this email address. + */ + longDesc: () => LocalizedString + } } } } } - sort: { + businessPhones: { /** - * Sort + * Business Phones */ displayName: () => LocalizedString /** - * Sort options + * Business phone numbers for the contact. */ shortDesc: () => LocalizedString /** - * Sort configuration for the tag results + * Enter one or more business phone numbers for the contact. + */ + longDesc: () => LocalizedString + } + mobilePhone: { + /** + * Mobile Phone + */ + displayName: () => LocalizedString + /** + * The contact's mobile phone number. + */ + shortDesc: () => LocalizedString + /** + * Enter the mobile or cell phone number for the contact. + */ + longDesc: () => LocalizedString + } + jobTitle: { + /** + * Job Title + */ + displayName: () => LocalizedString + /** + * The contact's job title. + */ + shortDesc: () => LocalizedString + /** + * Enter the professional title or role of the contact. + */ + longDesc: () => LocalizedString + } + companyName: { + /** + * Company Name + */ + displayName: () => LocalizedString + /** + * The name of the contact's company. + */ + shortDesc: () => LocalizedString + /** + * Enter the organization or company where the contact works. + */ + longDesc: () => LocalizedString + } + department: { + /** + * Department + */ + displayName: () => LocalizedString + /** + * The contact's department. + */ + shortDesc: () => LocalizedString + /** + * Enter the department or division within the company where the contact works. + */ + longDesc: () => LocalizedString + } + officeLocation: { + /** + * Office Location + */ + displayName: () => LocalizedString + /** + * The contact's office location. + */ + shortDesc: () => LocalizedString + /** + * Enter the physical location or office where the contact works. + */ + longDesc: () => LocalizedString + } + businessAddress: { + /** + * Business Address + */ + displayName: () => LocalizedString + /** + * The contact's business address. + */ + shortDesc: () => LocalizedString + /** + * Enter the full business address details for the contact. */ longDesc: () => LocalizedString type: { fields: { - field: { + street: { /** - * Sort Field + * Street */ displayName: () => LocalizedString /** - * Field to sort by + * Street address. */ shortDesc: () => LocalizedString /** - * The field to use for sorting the tag results + * Enter the street address including building number and street name. */ longDesc: () => LocalizedString } - direction: { + city: { /** - * Sort Direction + * City */ displayName: () => LocalizedString /** - * Sort direction + * City name. */ shortDesc: () => LocalizedString /** - * The direction to sort the tag results (ascending or descending) + * Enter the city or town for the business address. + */ + longDesc: () => LocalizedString + } + state: { + /** + * State/Province + */ + displayName: () => LocalizedString + /** + * State or province. + */ + shortDesc: () => LocalizedString + /** + * Enter the state, province, or region for the business address. + */ + longDesc: () => LocalizedString + } + countryOrRegion: { + /** + * Country/Region + */ + displayName: () => LocalizedString + /** + * Country or region. + */ + shortDesc: () => LocalizedString + /** + * Enter the country or region for the business address. + */ + longDesc: () => LocalizedString + } + postalCode: { + /** + * Postal Code + */ + displayName: () => LocalizedString + /** + * Postal or zip code. + */ + shortDesc: () => LocalizedString + /** + * Enter the postal code or zip code for the business address. */ longDesc: () => LocalizedString } @@ -223545,457 +228184,339 @@ export type TranslationFunctions = { } } } - remove_profile_from_list: { - groups: { - /** - * Lists - */ - '0': () => LocalizedString - } - /** - * Remove Profile from List - */ - displayName: () => LocalizedString - /** - * Removes a profile from a list - */ - shortDesc: () => LocalizedString - /** - * Removes a specified profile from a specified list in Klaviyo - */ - longDesc: () => LocalizedString - options: { - profile: { - /** - * Profile - */ - displayName: () => LocalizedString - /** - * Profile to remove - */ - shortDesc: () => LocalizedString - /** - * The profile to remove from the list - */ - longDesc: () => LocalizedString - } - list: { - /** - * List - */ - displayName: () => LocalizedString - /** - * Target list - */ - shortDesc: () => LocalizedString - /** - * The list to remove the profile from - */ - longDesc: () => LocalizedString - } - } - } - remove_tag_from_list: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - /** - * Lists - */ - '1': () => LocalizedString - } + 'update-contact': { /** - * Remove Tag from List + * Update Contact */ displayName: () => LocalizedString /** - * Removes a tag from a list + * Update an existing contact in your Outlook contacts. */ shortDesc: () => LocalizedString /** - * Removes a specified tag from a specified list in Klaviyo + * Modify details of an existing contact in your Microsoft Outlook contacts, such as name, email, phone numbers, or job information. */ longDesc: () => LocalizedString options: { - tag: { + contactId: { /** - * Tag + * Contact ID */ displayName: () => LocalizedString /** - * Tag to remove + * The unique identifier for the contact. */ shortDesc: () => LocalizedString /** - * The tag to remove from the list + * Select the unique identifier of the contact you want to update. */ longDesc: () => LocalizedString } - list: { + givenName: { /** - * List + * First Name */ displayName: () => LocalizedString /** - * Target list + * The contact's first name. */ shortDesc: () => LocalizedString /** - * The list to remove the tag from + * Update the first name or given name of the contact. */ longDesc: () => LocalizedString } - } - } - remove_tag_from_segment: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - /** - * Segments - */ - '1': () => LocalizedString - } - /** - * Remove Tag from Segment - */ - displayName: () => LocalizedString - /** - * Removes a tag from a segment - */ - shortDesc: () => LocalizedString - /** - * Removes a specified tag from a specified segment in Klaviyo - */ - longDesc: () => LocalizedString - options: { - tag: { + surname: { /** - * Tag + * Last Name */ displayName: () => LocalizedString /** - * Tag to remove + * The contact's last name. */ shortDesc: () => LocalizedString /** - * The tag to remove from the segment + * Update the last name or surname of the contact. */ longDesc: () => LocalizedString } - segment: { + emailAddresses: { /** - * Segment + * Email Addresses */ displayName: () => LocalizedString /** - * Target segment + * Email addresses for the contact. */ shortDesc: () => LocalizedString /** - * The segment to remove the tag from + * Update one or more email addresses for the contact. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + address: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * The email address of the contact. + */ + shortDesc: () => LocalizedString + /** + * Enter a valid email address for the contact. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Display Name + */ + displayName: () => LocalizedString + /** + * The display name for this email address. + */ + shortDesc: () => LocalizedString + /** + * Enter how you want the name to appear for this email address. + */ + longDesc: () => LocalizedString + } + } + } + } } - } - } - send_campaign: { - groups: { - /** - * Campaigns - */ - '0': () => LocalizedString - } - /** - * Send Campaign - */ - displayName: () => LocalizedString - /** - * Sends a campaign - */ - shortDesc: () => LocalizedString - /** - * Sends a draft campaign immediately to its target audience - */ - longDesc: () => LocalizedString - options: { - id: { + businessPhones: { /** - * Campaign ID + * Business Phones */ displayName: () => LocalizedString /** - * The ID of the campaign to send + * Business phone numbers for the contact. */ shortDesc: () => LocalizedString /** - * The unique identifier of the campaign you want to send + * Update one or more business phone numbers for the contact. */ longDesc: () => LocalizedString } - } - } - subscribe_profile: { - groups: { - /** - * Profiles - */ - '0': () => LocalizedString - } - /** - * Subscribe Profile - */ - displayName: () => LocalizedString - /** - * Subscribes a profile to marketing channels - */ - shortDesc: () => LocalizedString - /** - * Subscribes a profile to email marketing, SMS marketing, or both channels - */ - longDesc: () => LocalizedString - options: { - profileId: { + mobilePhone: { /** - * Profile ID + * Mobile Phone */ displayName: () => LocalizedString /** - * The ID of the profile to subscribe + * The contact's mobile phone number. */ shortDesc: () => LocalizedString /** - * The unique identifier of the profile to subscribe + * Update the mobile or cell phone number for the contact. */ longDesc: () => LocalizedString } - email: { + jobTitle: { /** - * Email + * Job Title */ displayName: () => LocalizedString /** - * Email address + * The contact's job title. */ shortDesc: () => LocalizedString /** - * The email address of the profile to subscribe + * Update the professional title or role of the contact. */ longDesc: () => LocalizedString } - phoneNumber: { + companyName: { /** - * Phone Number + * Company Name */ displayName: () => LocalizedString /** - * Phone number + * The name of the contact's company. */ shortDesc: () => LocalizedString /** - * The phone number of the profile to subscribe + * Update the organization or company where the contact works. */ longDesc: () => LocalizedString } - consentToSubscribeToChannel: { + department: { /** - * Subscription Channel + * Department */ displayName: () => LocalizedString /** - * Channel to subscribe to + * The contact's department. */ shortDesc: () => LocalizedString /** - * The marketing channel(s) to subscribe the profile to + * Update the department or division within the company where the contact works. */ longDesc: () => LocalizedString } - smsSubscriptionType: { + officeLocation: { /** - * SMS Subscription Type + * Office Location */ displayName: () => LocalizedString /** - * Type of SMS subscription + * The contact's office location. */ shortDesc: () => LocalizedString /** - * The type of SMS subscription (marketing, transactional, or both) + * Update the physical location or office where the contact works. */ longDesc: () => LocalizedString } - list: { + businessAddress: { /** - * List + * Business Address */ displayName: () => LocalizedString /** - * Target list + * The contact's business address. */ shortDesc: () => LocalizedString /** - * Optional list to add the profile to during subscription + * Update the full business address details for the contact. */ longDesc: () => LocalizedString + type: { + fields: { + street: { + /** + * Street + */ + displayName: () => LocalizedString + /** + * Street address. + */ + shortDesc: () => LocalizedString + /** + * Update the street address including building number and street name. + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * City name. + */ + shortDesc: () => LocalizedString + /** + * Update the city or town for the business address. + */ + longDesc: () => LocalizedString + } + state: { + /** + * State/Province + */ + displayName: () => LocalizedString + /** + * State or province. + */ + shortDesc: () => LocalizedString + /** + * Update the state, province, or region for the business address. + */ + longDesc: () => LocalizedString + } + countryOrRegion: { + /** + * Country/Region + */ + displayName: () => LocalizedString + /** + * Country or region. + */ + shortDesc: () => LocalizedString + /** + * Update the country or region for the business address. + */ + longDesc: () => LocalizedString + } + postalCode: { + /** + * Postal Code + */ + displayName: () => LocalizedString + /** + * Postal or zip code. + */ + shortDesc: () => LocalizedString + /** + * Update the postal code or zip code for the business address. + */ + longDesc: () => LocalizedString + } + } + } } } } - unsubscribe_profile: { - groups: { - /** - * Profiles - */ - '0': () => LocalizedString - } + 'delete-contact': { /** - * Unsubscribe Profile + * Delete Contact */ displayName: () => LocalizedString /** - * Unsubscribes a profile from marketing channels + * Delete a contact from your Outlook contacts. */ shortDesc: () => LocalizedString /** - * Unsubscribes a profile from email and/or SMS marketing based on provided identifiers + * Permanently remove a contact from your Microsoft Outlook contacts. */ longDesc: () => LocalizedString options: { - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * Email address - */ - shortDesc: () => LocalizedString - /** - * The email address of the profile to unsubscribe - */ - longDesc: () => LocalizedString - } - phoneNumber: { - /** - * Phone Number - */ - displayName: () => LocalizedString - /** - * Phone number - */ - shortDesc: () => LocalizedString - /** - * The phone number of the profile to unsubscribe - */ - longDesc: () => LocalizedString - } - smsSubscriptionType: { + contactId: { /** - * SMS Subscription Type + * Contact ID */ displayName: () => LocalizedString /** - * Type of SMS subscription to cancel + * The unique identifier for the contact. */ shortDesc: () => LocalizedString /** - * The type of SMS subscription to cancel (marketing, transactional, or both) + * Select the unique identifier of the contact to be deleted. */ longDesc: () => LocalizedString } } } - update_profile: { - groups: { - /** - * Profiles - */ - '0': () => LocalizedString - } + 'create-event': { /** - * Update Profile + * Create Event */ displayName: () => LocalizedString /** - * Updates an existing profile + * Create a new event in your Outlook calendar. */ shortDesc: () => LocalizedString /** - * Updates an existing profile with new information and optionally adds them to a list + * Create a new event or meeting in your Microsoft Outlook calendar with details such as title, start and end times, location, and attendees. */ longDesc: () => LocalizedString options: { - id: { - /** - * Profile ID - */ - displayName: () => LocalizedString - /** - * The ID of the profile to update - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the profile you want to update - */ - longDesc: () => LocalizedString - } - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * Email address - */ - shortDesc: () => LocalizedString - /** - * The new email address for the profile - */ - longDesc: () => LocalizedString - } - phoneNumber: { - /** - * Phone Number - */ - displayName: () => LocalizedString - /** - * Phone number - */ - shortDesc: () => LocalizedString - /** - * The new phone number for the profile - */ - longDesc: () => LocalizedString - } - firstName: { - /** - * First Name - */ - displayName: () => LocalizedString - /** - * First name - */ - shortDesc: () => LocalizedString - /** - * The first name of the profile - */ - longDesc: () => LocalizedString - } - lastName: { + calendarId: { /** - * Last Name + * Calendar ID */ displayName: () => LocalizedString /** - * Last name + * The calendar where the event will be created. */ shortDesc: () => LocalizedString /** - * The last name of the profile + * Select the calendar where you want to create the new event. */ longDesc: () => LocalizedString } @@ -224005,2115 +228526,1959 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Job title + * The title or subject of the event. */ shortDesc: () => LocalizedString /** - * The job title of the profile + * Enter a title or subject for the event that will appear in your calendar. */ longDesc: () => LocalizedString } - organization: { + start: { /** - * Organization + * Start Time */ displayName: () => LocalizedString /** - * Organization name + * When the event begins. */ shortDesc: () => LocalizedString /** - * The organization or company name for the profile + * Enter the date and time when the event will start. */ longDesc: () => LocalizedString } - city: { + timezone: { /** - * City + * Time Zone */ displayName: () => LocalizedString /** - * City + * The time zone for the event times. */ shortDesc: () => LocalizedString /** - * The city where the profile is located + * Select the time zone that applies to the start and end times of the event. */ longDesc: () => LocalizedString } - region: { + end: { /** - * Region + * End Time */ displayName: () => LocalizedString /** - * State or region + * When the event ends. */ shortDesc: () => LocalizedString /** - * The state or region where the profile is located + * Enter the date and time when the event will end. If not specified, defaults to 1 hour after start time. */ longDesc: () => LocalizedString } - country: { + location: { /** - * Country + * Location */ displayName: () => LocalizedString /** - * Country + * Where the event will take place. */ shortDesc: () => LocalizedString /** - * The country where the profile is located + * Enter the physical location or virtual meeting place for the event. */ longDesc: () => LocalizedString } - zip: { + attendees: { /** - * ZIP Code + * Attendees */ displayName: () => LocalizedString /** - * ZIP or postal code + * People invited to the event. */ shortDesc: () => LocalizedString /** - * The ZIP or postal code for the profile location + * Add one or more attendees to invite to the event. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + address: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * The attendee's email address. + */ + shortDesc: () => LocalizedString + /** + * Enter the email address of the person you want to invite. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Display Name + */ + displayName: () => LocalizedString + /** + * The attendee's display name. + */ + shortDesc: () => LocalizedString + /** + * Optionally enter a display name for the attendee. + */ + longDesc: () => LocalizedString + } + } + } + } } - imageUrl: { + body: { /** - * Image URL + * Body */ displayName: () => LocalizedString /** - * Profile image URL + * The body content of the event. */ shortDesc: () => LocalizedString /** - * URL to the profile image + * Enter the description or details of the event that attendees will see in the invitation. */ longDesc: () => LocalizedString } - externalId: { + bodyContentType: { /** - * External ID + * Body Content Type */ displayName: () => LocalizedString /** - * External identifier + * Format of the body content. */ shortDesc: () => LocalizedString /** - * External identifier for the profile from your system + * Select whether the body content is plain text or HTML formatted. */ longDesc: () => LocalizedString } - customProperties: { + isOnlineMeeting: { /** - * Custom Properties + * Online Meeting */ displayName: () => LocalizedString /** - * Custom profile properties + * Whether this is an online meeting. */ shortDesc: () => LocalizedString /** - * Additional custom properties to set on the profile + * Enable this option to make this event an online meeting and generate a meeting link. */ longDesc: () => LocalizedString } } } - add_tag_to_list: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - /** - * Lists - */ - '1': () => LocalizedString - } + 'delete-event': { /** - * Add Tag to List + * Delete Event */ displayName: () => LocalizedString /** - * Adds an existing tag to a list + * Delete an event from your Outlook calendar. */ shortDesc: () => LocalizedString /** - * Associates an existing tag with a specified list in Klaviyo + * Permanently remove an event or meeting from your Microsoft Outlook calendar. */ longDesc: () => LocalizedString options: { - tag: { + calendarId: { /** - * Tag + * Calendar ID */ displayName: () => LocalizedString /** - * Tag to add + * The calendar containing the event. */ shortDesc: () => LocalizedString /** - * The tag to add to the list + * Select the calendar that contains the event you want to delete. */ longDesc: () => LocalizedString } - list: { + eventId: { /** - * List + * Event ID */ displayName: () => LocalizedString /** - * Target list + * The unique identifier for the event. */ shortDesc: () => LocalizedString /** - * The list to add the tag to + * Select the unique identifier of the event to be deleted. */ longDesc: () => LocalizedString } } } - add_tag_to_segment: { - groups: { - /** - * Tags - */ - '0': () => LocalizedString - /** - * Segments - */ - '1': () => LocalizedString - } + 'list-contacts': { /** - * Add Tag to Segment + * List Contacts */ displayName: () => LocalizedString /** - * Adds an existing tag to a segment + * Retrieve a list of contacts from your Outlook contacts. */ shortDesc: () => LocalizedString /** - * Associates an existing tag with a specified segment in Klaviyo + * Get a list of contacts from your Microsoft Outlook contacts with optional filtering and limit. */ longDesc: () => LocalizedString options: { - tag: { + limit: { /** - * Tag + * Limit */ displayName: () => LocalizedString /** - * Tag to add + * The maximum number of contacts to retrieve. */ shortDesc: () => LocalizedString /** - * The tag to add to the segment + * Specify the maximum number of contacts to retrieve from the Outlook account. */ longDesc: () => LocalizedString } - segment: { + filter: { /** - * Segment + * Filter */ displayName: () => LocalizedString /** - * Target segment + * Filter contacts by name or email. */ shortDesc: () => LocalizedString /** - * The segment to add the tag to + * Enter text to filter contacts by name or email address. Only contacts matching the filter will be returned. */ longDesc: () => LocalizedString } } } - create_event: { - groups: { - /** - * Events - */ - '0': () => LocalizedString - } + 'list-events': { /** - * Create Event + * List Events */ displayName: () => LocalizedString /** - * Creates a new event + * Retrieve a list of events from your Outlook calendar. */ shortDesc: () => LocalizedString /** - * Creates a new event for a specific metric in Klaviyo + * Get a list of events from your Microsoft Outlook calendar with optional filtering by date range and limit. */ longDesc: () => LocalizedString options: { - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * Email address - */ - shortDesc: () => LocalizedString - /** - * The email address of the profile for the event - */ - longDesc: () => LocalizedString - } - metric: { - /** - * Metric - */ - displayName: () => LocalizedString - /** - * Event metric - */ - shortDesc: () => LocalizedString - /** - * The metric or event type to track - */ - longDesc: () => LocalizedString - } - profile: { - /** - * Profile - */ - displayName: () => LocalizedString - /** - * Profile ID - */ - shortDesc: () => LocalizedString - /** - * The profile ID to associate with the event - */ - longDesc: () => LocalizedString - } - time: { - /** - * Time - */ - displayName: () => LocalizedString - /** - * Event timestamp - */ - shortDesc: () => LocalizedString - /** - * The timestamp when the event occurred - */ - longDesc: () => LocalizedString - } - value: { + calendarId: { /** - * Value + * Calendar ID */ displayName: () => LocalizedString /** - * Event value + * The calendar to retrieve events from. */ shortDesc: () => LocalizedString /** - * The monetary value associated with the event + * Select the calendar from which you want to retrieve events. */ longDesc: () => LocalizedString } - customId: { + startDateTime: { /** - * Custom ID + * Start Date and Time */ displayName: () => LocalizedString /** - * Unique event identifier + * The start date and time for filtering events. */ shortDesc: () => LocalizedString /** - * A custom unique identifier for the event + * Enter a date and time to retrieve events that start on or after this time. */ longDesc: () => LocalizedString } - customProperties: { + endDateTime: { /** - * Custom Properties + * End Date and Time */ displayName: () => LocalizedString /** - * Event properties + * The end date and time for filtering events. */ shortDesc: () => LocalizedString /** - * Additional custom properties for the event + * Enter a date and time to retrieve events that end on or before this time. */ longDesc: () => LocalizedString } - } - } - create_list: { - groups: { - /** - * Lists - */ - '0': () => LocalizedString - } - /** - * Create List - */ - displayName: () => LocalizedString - /** - * Creates a new list - */ - shortDesc: () => LocalizedString - /** - * Creates a new list in Klaviyo with the specified configuration - */ - longDesc: () => LocalizedString - options: { - name: { + limit: { /** - * Name + * Limit */ displayName: () => LocalizedString /** - * List name + * The maximum number of events to retrieve. */ shortDesc: () => LocalizedString /** - * The name of the new list + * Specify the maximum number of events to retrieve from the Outlook calendar. */ longDesc: () => LocalizedString } } } - create_or_update_profile: { - groups: { - /** - * Profiles - */ - '0': () => LocalizedString - } + 'send-email': { /** - * Create Or Update Profile + * Send Email */ displayName: () => LocalizedString /** - * Creates a new profile or updates an existing one + * Send an email from your Outlook account. */ shortDesc: () => LocalizedString /** - * Creates a new profile or updates an existing profile and optionally adds it to a list + * Compose and send an email message from your Microsoft Outlook account to one or more recipients. */ longDesc: () => LocalizedString options: { - id: { + toRecipients: { /** - * Profile ID + * To Recipients */ displayName: () => LocalizedString /** - * Profile ID (for update) + * The primary recipients of the email. */ shortDesc: () => LocalizedString /** - * The ID of an existing profile to update (leave empty to create new) + * Enter one or more email addresses for the primary recipients of the email. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + address: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * Recipient's email address. + */ + shortDesc: () => LocalizedString + /** + * Enter the email address of the recipient. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Display Name + */ + displayName: () => LocalizedString + /** + * Recipient's display name. + */ + shortDesc: () => LocalizedString + /** + * Optionally enter a display name for the recipient. + */ + longDesc: () => LocalizedString + } + } + } + } } - email: { + ccRecipients: { /** - * Email + * CC Recipients */ displayName: () => LocalizedString /** - * Email address + * The carbon copy recipients of the email. */ shortDesc: () => LocalizedString /** - * The email address for the profile + * Optionally enter one or more email addresses for recipients to be copied on the email. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + address: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * CC recipient's email address. + */ + shortDesc: () => LocalizedString + /** + * Enter the email address of the CC recipient. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Display Name + */ + displayName: () => LocalizedString + /** + * CC recipient's display name. + */ + shortDesc: () => LocalizedString + /** + * Optionally enter a display name for the CC recipient. + */ + longDesc: () => LocalizedString + } + } + } + } } - phoneNumber: { + bccRecipients: { /** - * Phone Number + * BCC Recipients */ displayName: () => LocalizedString /** - * Phone number + * The blind carbon copy recipients of the email. */ shortDesc: () => LocalizedString /** - * The phone number for the profile + * Optionally enter one or more email addresses for recipients to be blind copied on the email. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + address: { + /** + * Email Address + */ + displayName: () => LocalizedString + /** + * BCC recipient's email address. + */ + shortDesc: () => LocalizedString + /** + * Enter the email address of the BCC recipient. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Display Name + */ + displayName: () => LocalizedString + /** + * BCC recipient's display name. + */ + shortDesc: () => LocalizedString + /** + * Optionally enter a display name for the BCC recipient. + */ + longDesc: () => LocalizedString + } + } + } + } } - firstName: { + subject: { /** - * First Name + * Subject */ displayName: () => LocalizedString /** - * First name + * The subject line of the email. */ shortDesc: () => LocalizedString /** - * The first name of the profile + * Enter the subject line that will appear in the recipient's inbox. */ longDesc: () => LocalizedString } - lastName: { + body: { /** - * Last Name + * Body */ displayName: () => LocalizedString /** - * Last name + * The content of the email. */ shortDesc: () => LocalizedString /** - * The last name of the profile + * Enter the main message content of the email. */ longDesc: () => LocalizedString } - title: { + bodyContentType: { /** - * Title + * Body Content Type */ displayName: () => LocalizedString /** - * Job title + * Format of the email body. */ shortDesc: () => LocalizedString /** - * The job title of the profile + * Select whether the email body is plain text or HTML formatted. */ longDesc: () => LocalizedString } - organization: { + saveToSentItems: { /** - * Organization + * Save to Sent Items */ displayName: () => LocalizedString /** - * Organization name + * Whether to save a copy in Sent Items. */ shortDesc: () => LocalizedString /** - * The organization or company name for the profile + * Choose whether to save a copy of the email in your Sent Items folder. */ longDesc: () => LocalizedString } - city: { + attachments: { /** - * City + * Attachments */ displayName: () => LocalizedString /** - * City + * Files to attach to the email. */ shortDesc: () => LocalizedString /** - * The city where the profile is located + * Optionally attach files to the email. You can add one or more files to be sent with the email. */ longDesc: () => LocalizedString } - region: { + } + } + } + triggers: { + 'new-email-with-attachment': { + /** + * New Email with Attachment + */ + displayName: () => LocalizedString + /** + * Triggers when an email with attachments is received, processing each matching attachment individually. + */ + shortDesc: () => LocalizedString + /** + * Monitors an Outlook mailbox for new emails with attachments. When an email with attachments is received, each attachment that matches the specified filters will trigger a separate event. This allows for processing individual attachments from emails while maintaining the full email context. + */ + longDesc: () => LocalizedString + options: { + senderFilter: { /** - * Region + * Sender Filter */ displayName: () => LocalizedString /** - * State or region + * Only process emails from this sender */ shortDesc: () => LocalizedString /** - * The state or region where the profile is located + * If specified, only emails from this exact sender email address will be processed. Leave empty to process emails from any sender. */ longDesc: () => LocalizedString } - country: { + subjectFilter: { /** - * Country + * Subject Filter */ displayName: () => LocalizedString /** - * Country + * Only process emails with this text in the subject */ shortDesc: () => LocalizedString /** - * The country where the profile is located + * If specified, only emails containing this text in the subject line will be processed. Leave empty to process emails with any subject. */ longDesc: () => LocalizedString } - zip: { + filenameFilters: { /** - * ZIP Code + * Filename Filters */ displayName: () => LocalizedString /** - * ZIP or postal code + * Only process attachments with matching filenames */ shortDesc: () => LocalizedString /** - * The ZIP or postal code for the profile location + * A list of text strings to match against attachment filenames. If provided, only attachments with filenames containing any of these strings will be processed. Matching is case-insensitive. Leave empty to process all attachments regardless of filename. */ longDesc: () => LocalizedString } - imageUrl: { + mimeTypeFilters: { /** - * Image URL + * MIME Type Filters */ displayName: () => LocalizedString /** - * Profile image URL + * Only process attachments with matching MIME types */ shortDesc: () => LocalizedString /** - * URL to the profile image + * A list of MIME type strings to match against attachment content types. If provided, only attachments with content types containing any of these strings will be processed. For example, use "pdf" to match PDF files, "image/" to match all images, or "spreadsheet" to match Excel files. Matching is case-insensitive. Leave empty to process all attachments regardless of MIME type. */ longDesc: () => LocalizedString } - externalId: { + action: { /** - * External ID + * Email Action */ displayName: () => LocalizedString /** - * External identifier + * Action to perform on the email after processing its attachments */ shortDesc: () => LocalizedString /** - * External identifier for the profile from your system + * Specify what should happen to the email after all matching attachments have been processed. Options include: None (leave the email as is), Delete (permanently remove the email), or Move (relocate the email to another folder). */ longDesc: () => LocalizedString } - customProperties: { + targetFolderId: { /** - * Custom Properties + * Target Folder */ displayName: () => LocalizedString /** - * Custom profile properties + * Destination folder for emails when using Move action */ shortDesc: () => LocalizedString /** - * Additional custom properties to set on the profile + * If the Email Action is set to "Move", specify the folder where the email should be moved after all attachments have been processed. This option is only used when Move is selected. */ longDesc: () => LocalizedString } } - } - create_profile: { - groups: { + event_info: { /** - * Profiles + * Contains the email data along with information about a single matching attachment. */ - '0': () => LocalizedString + desc: () => LocalizedString } + } + 'new-contact': { /** - * Create Profile + * New Contact */ displayName: () => LocalizedString /** - * Creates a new profile + * Triggered when a new contact is created in Outlook. */ shortDesc: () => LocalizedString /** - * Creates a new profile in Klaviyo with the specified information + * This trigger is activated whenever a new contact is added to your Microsoft Outlook contacts. + */ + longDesc: () => LocalizedString + } + 'new-email': { + /** + * New Email Trigger + */ + displayName: () => LocalizedString + /** + * Triggers when a new email is received in your Outlook inbox + */ + shortDesc: () => LocalizedString + /** + * Monitors your Outlook inbox and triggers when new emails arrive. Supports filtering by sender, subject, or attachments, and can optionally delete or move processed emails. */ longDesc: () => LocalizedString options: { - email: { + senderFilter: { /** - * Email + * Sender Filter */ displayName: () => LocalizedString /** - * Email address + * Filter emails by sender address */ shortDesc: () => LocalizedString /** - * The email address for the new profile + * Only trigger for emails from this specific sender email address. Leave empty to trigger for all senders. */ longDesc: () => LocalizedString } - phoneNumber: { + subjectFilter: { /** - * Phone Number + * Subject Filter */ displayName: () => LocalizedString /** - * Phone number + * Filter emails by subject content */ shortDesc: () => LocalizedString /** - * The phone number for the new profile + * Only trigger for emails containing this text in the subject line. Leave empty to match any subject. */ longDesc: () => LocalizedString } - firstName: { + hasAttachments: { /** - * First Name + * Has Attachments */ displayName: () => LocalizedString /** - * First name + * Filter by attachment presence */ shortDesc: () => LocalizedString /** - * The first name of the profile + * Filter emails based on whether they have attachments. Set to true to only trigger for emails with attachments, false for emails without attachments, or leave empty to trigger for both. */ longDesc: () => LocalizedString } - lastName: { + includeAttachmentData: { /** - * Last Name + * Include Attachment Data */ displayName: () => LocalizedString /** - * Last name + * Include attachment content in trigger data */ shortDesc: () => LocalizedString /** - * The last name of the profile + * When enabled, the trigger will fetch and include the actual attachment content in the trigger data. This may increase processing time for large attachments. */ longDesc: () => LocalizedString } - title: { + action: { /** - * Title + * Email Action */ displayName: () => LocalizedString /** - * Job title + * Action to perform after triggering */ shortDesc: () => LocalizedString /** - * The job title of the profile + * Optional action to perform on emails after the trigger runs. Choose "None" to leave emails unchanged, "Delete" to remove the email, or "Move" to relocate the email to another folder. */ longDesc: () => LocalizedString } - organization: { + targetFolderId: { + /** + * Target Folder + */ + displayName: () => LocalizedString + /** + * Destination folder for moved emails + */ + shortDesc: () => LocalizedString + /** + * The folder where emails will be moved if the "Move" action is selected. Only required when action is set to "Move". + */ + longDesc: () => LocalizedString + } + } + event_info: { + /** + * Data from the received email, including metadata and content + */ + desc: () => LocalizedString + } + } + 'new-event': { + /** + * New Event + */ + displayName: () => LocalizedString + /** + * Triggered when a new event is created in an Outlook calendar. + */ + shortDesc: () => LocalizedString + /** + * This trigger is activated whenever a new event or meeting is created in your Microsoft Outlook calendar. + */ + longDesc: () => LocalizedString + options: { + calendarId: { /** - * Organization + * Calendar ID */ displayName: () => LocalizedString /** - * Organization name + * The calendar to monitor for new events. */ shortDesc: () => LocalizedString /** - * The organization or company name for the profile + * Optionally select a specific calendar to monitor. If not specified, all calendars will be monitored. */ longDesc: () => LocalizedString } - city: { + } + } + } + } + Trello: { + groups: { + /** + * Project & Task Management + */ + '0': () => LocalizedString + } + /** + * Trello + */ + displayName: () => LocalizedString + /** + * Trello is a collaboration tool that organizes your projects into boards. + */ + shortDesc: () => LocalizedString + /** + * Trello is a collaboration tool that organizes your projects into boards. It is a web-based Kanban-style list-making application and is a subsidiary of Atlassian. + */ + longDesc: () => LocalizedString + triggers: { + 'card-due': { + /** + * Card Due + */ + displayName: () => LocalizedString + /** + * Triggers when a card becomes overdue. + */ + shortDesc: () => LocalizedString + /** + * This trigger fires when a card has passed its due date and has not been marked as complete. + */ + longDesc: () => LocalizedString + options: { + source: { /** - * City + * Source */ displayName: () => LocalizedString /** - * City + * Choose whether to monitor an entire board or a specific list. */ shortDesc: () => LocalizedString /** - * The city where the profile is located + * Select "board" to monitor all lists on a board, or "list" to monitor a specific list only. */ longDesc: () => LocalizedString } - region: { + boardId: { /** - * Region + * Board */ displayName: () => LocalizedString /** - * State or region + * The board containing the cards to monitor. */ shortDesc: () => LocalizedString /** - * The state or region where the profile is located + * Select the Trello board that contains the cards you want to monitor for due dates. */ longDesc: () => LocalizedString } - country: { + listId: { /** - * Country + * List */ displayName: () => LocalizedString /** - * Country + * The specific list containing the cards to monitor. */ shortDesc: () => LocalizedString /** - * The country where the profile is located + * Select a specific list to monitor for overdue cards. Only required if Source is set to "list". */ longDesc: () => LocalizedString } - zip: { + includeDueComplete: { /** - * ZIP Code + * Include Completed Cards */ displayName: () => LocalizedString /** - * ZIP or postal code + * Include cards marked as complete. */ shortDesc: () => LocalizedString /** - * The ZIP or postal code for the profile location + * When enabled, the trigger will include overdue cards that have been marked as complete. By default, only incomplete overdue cards are included. */ longDesc: () => LocalizedString } - imageUrl: { + } + } + 'new-board': { + /** + * New Board + */ + displayName: () => LocalizedString + /** + * Triggers when a new board is created. + */ + shortDesc: () => LocalizedString + /** + * This trigger fires when a new Trello board is created or shared with the authenticated user. + */ + longDesc: () => LocalizedString + } + 'new-card': { + /** + * New Card + */ + displayName: () => LocalizedString + /** + * Triggers when a new card is created. + */ + shortDesc: () => LocalizedString + /** + * This trigger fires when a new card is added to a specified board or list in Trello. + */ + longDesc: () => LocalizedString + options: { + source: { /** - * Image URL + * Source */ displayName: () => LocalizedString /** - * Profile image URL + * Choose whether to monitor an entire board or a specific list. */ shortDesc: () => LocalizedString /** - * URL to the profile image + * Select "board" to monitor all lists on a board, or "list" to monitor a specific list only. */ longDesc: () => LocalizedString } - externalId: { + boardId: { /** - * External ID + * Board */ displayName: () => LocalizedString /** - * External identifier + * The board to monitor for new cards. */ shortDesc: () => LocalizedString /** - * External identifier for the profile from your system + * Select the Trello board where you want to monitor for new cards being created. */ longDesc: () => LocalizedString } - customProperties: { + listId: { /** - * Custom Properties + * List */ displayName: () => LocalizedString /** - * Custom profile properties + * The specific list to monitor for new cards. */ shortDesc: () => LocalizedString /** - * Additional custom properties to set on the profile + * Select a specific list to monitor for new cards. Only required if Source is set to "list". */ longDesc: () => LocalizedString } } } - get_campaign: { - groups: { - /** - * Campaigns - */ - '0': () => LocalizedString - } + 'new-label': { /** - * Get Campaign + * New Label */ displayName: () => LocalizedString /** - * Retrieves a specific campaign + * Triggers when a new label is created. */ shortDesc: () => LocalizedString /** - * Retrieves detailed information about a specific campaign by its ID + * This trigger fires when a new label is created on a specified Trello board. */ longDesc: () => LocalizedString options: { - id: { + boardId: { /** - * Campaign ID + * Board */ displayName: () => LocalizedString /** - * The ID of the campaign to retrieve + * The board to monitor for new labels. */ shortDesc: () => LocalizedString /** - * The unique identifier of the campaign you want to retrieve + * Select the Trello board where you want to monitor for new labels being created. */ longDesc: () => LocalizedString } } } - add_profile_to_list: { - groups: { - /** - * Lists - */ - '0': () => LocalizedString - } + 'new-list': { /** - * Add Profile to List + * New List */ displayName: () => LocalizedString /** - * Adds an existing profile to a list + * Triggers when a new list is created. */ shortDesc: () => LocalizedString /** - * Adds an existing profile to a specified list in Klaviyo + * This trigger fires when a new list is added to a specified Trello board. */ longDesc: () => LocalizedString options: { - profile: { + boardId: { /** - * Profile + * Board */ displayName: () => LocalizedString /** - * Profile to add + * The board to monitor for new lists. */ shortDesc: () => LocalizedString /** - * The profile to add to the list + * Select the Trello board where you want to monitor for new lists being created. */ longDesc: () => LocalizedString } - list: { + includeArchivedLists: { /** - * List + * Include Archived Lists */ displayName: () => LocalizedString /** - * Target list + * Include lists that are archived. */ shortDesc: () => LocalizedString /** - * The list to add the profile to + * When enabled, the trigger will include new lists that are archived. By default, only open lists are included. */ longDesc: () => LocalizedString } } } - } - triggers: { - new_event: { + 'new-member': { /** - * New Event + * New Member */ displayName: () => LocalizedString /** - * Triggers when a new event occurs + * Triggers when a new member is added to a board. */ shortDesc: () => LocalizedString /** - * Triggers when a new event occurs for a specific metric in Klaviyo + * This trigger fires when a new member is added to a specified Trello board. */ longDesc: () => LocalizedString options: { - metric: { + boardId: { /** - * Metric + * Board */ displayName: () => LocalizedString /** - * Event metric to monitor + * The board to monitor for new members. */ shortDesc: () => LocalizedString /** - * The specific metric or event type to monitor for new events + * Select the Trello board where you want to monitor for new members being added. */ longDesc: () => LocalizedString } } } - new_profile: { + } + expressions: { + '&&': { /** - * New Profile + * And */ displayName: () => LocalizedString /** - * Triggers when a new profile is created + * Logical AND operator */ shortDesc: () => LocalizedString /** - * Triggers when a new profile is created in Klaviyo + * Combines multiple conditions where all must be true */ longDesc: () => LocalizedString } - new_list_profile: { + '||': { /** - * Profile Added to List + * Or */ displayName: () => LocalizedString /** - * Triggers when a profile is added to a list + * Logical OR operator */ shortDesc: () => LocalizedString /** - * Triggers when a profile is added to a specific list in Klaviyo + * Combines multiple conditions where at least one must be true */ longDesc: () => LocalizedString - options: { - list: { - /** - * List - */ - displayName: () => LocalizedString - /** - * List to monitor - */ - shortDesc: () => LocalizedString - /** - * The specific list to monitor for new profile additions - */ - longDesc: () => LocalizedString - } - } } - new_segment_profile: { + '==': { /** - * Profile Added to Segment + * Equals */ displayName: () => LocalizedString /** - * Triggers when a profile is added to a segment + * Field equals value */ shortDesc: () => LocalizedString /** - * Triggers when a profile is added to a specific segment in Klaviyo + * Matches records where the field equals the specified value */ longDesc: () => LocalizedString - options: { - segment: { - /** - * Segment - */ - displayName: () => LocalizedString - /** - * Segment to monitor - */ - shortDesc: () => LocalizedString - /** - * The specific segment to monitor for new profile additions - */ - longDesc: () => LocalizedString + } + '!=': { + /** + * Not Equals + */ + displayName: () => LocalizedString + /** + * Field does not equal value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field does not equal the specified value + */ + longDesc: () => LocalizedString + } + '>': { + /** + * Greater Than + */ + displayName: () => LocalizedString + /** + * Field is greater than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than the specified value + */ + longDesc: () => LocalizedString + } + '>=': { + /** + * Greater Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is greater than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than or equal to the specified value + */ + longDesc: () => LocalizedString + } + '<': { + /** + * Less Than + */ + displayName: () => LocalizedString + /** + * Field is less than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than the specified value + */ + longDesc: () => LocalizedString + } + '<=': { + /** + * Less Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is less than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than or equal to the specified value + */ + longDesc: () => LocalizedString + } + 'is-set': { + /** + * Is Set + */ + displayName: () => LocalizedString + /** + * Field has a value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has a value (is not empty) + */ + longDesc: () => LocalizedString + } + 'is-not-set': { + /** + * Is Not Set + */ + displayName: () => LocalizedString + /** + * Field has no value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has no value (is empty) + */ + longDesc: () => LocalizedString + } + contains: { + /** + * Contains + */ + displayName: () => LocalizedString + /** + * Field contains value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field contains the specified substring + */ + longDesc: () => LocalizedString + } + } + searchOptions: { + orderBy: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for sorting results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } } } } } } - Outlook: { + Teams: { /** - * Microsoft Outlook + * Microsoft Teams */ displayName: () => LocalizedString groups: { /** - * Email & Email Marketing + * Messaging & Real-time Communication */ '0': () => LocalizedString } /** - * Get access to your calendar events, contacts, and emails in Microsoft Outlook. + * Collaborate with your team using channels, meetings, and messages */ shortDesc: () => LocalizedString /** - * Microsoft Outlook is a personal information manager software system from Microsoft, available as a part of the Microsoft Office suite. Primarily an email application, it also includes a calendar, task manager, contact manager, note taking, journal, and web browsing. Connect your Outlook account to create and manage contacts, calendar events, and send emails. + * Microsoft Teams is a collaboration platform that enables messaging, file sharing, video meetings, and app integration within your organization. */ longDesc: () => LocalizedString actions: { - 'manage-email': { + 'create-channel': { /** - * Manage Email + * Create Channel */ displayName: () => LocalizedString /** - * Delete or move an email message to another folder. + * Create a new channel in a team */ shortDesc: () => LocalizedString /** - * Performs operations on an existing email message, allowing you to either delete it permanently or move it to another folder in your Outlook mailbox. + * Create a new channel within a specified team where members can collaborate through conversations, files, and integrated apps. */ longDesc: () => LocalizedString options: { - messageId: { + teamId: { /** - * Message ID + * Team ID */ displayName: () => LocalizedString /** - * ID of the email message + * Unique identifier for the team */ shortDesc: () => LocalizedString /** - * The unique identifier of the email message to be moved or deleted. + * The unique identifier (GUID) for the team where the new channel will be created. */ longDesc: () => LocalizedString } - action: { + displayName: { /** - * Action + * Channel Name */ displayName: () => LocalizedString /** - * Action to perform on the email + * Name of the new channel */ shortDesc: () => LocalizedString /** - * Specify whether to delete the email permanently or move it to another folder. + * The display name for the new channel. Must be unique within the team and between 1-50 characters. */ longDesc: () => LocalizedString } - targetFolderId: { + description: { /** - * Target Folder ID + * Description */ displayName: () => LocalizedString /** - * ID of the target folder + * Description of the channel purpose */ shortDesc: () => LocalizedString /** - * The ID of the folder where you want to move the email. This field is required only when the action is set to "move". + * Optional description explaining the purpose or topic of the channel. Limited to 1024 characters. + */ + longDesc: () => LocalizedString + } + membershipType: { + /** + * Membership Type + */ + displayName: () => LocalizedString + /** + * Channel privacy setting + */ + shortDesc: () => LocalizedString + /** + * Defines the privacy level of the channel. Options include "standard" (visible to all team members) or "private" (visible only to specific members). */ longDesc: () => LocalizedString } } } - 'search-emails': { + 'create-meeting': { /** - * Search Emails + * Create Meeting */ displayName: () => LocalizedString /** - * Search for emails using various filter criteria including advanced attachment filters. + * Schedule a new Teams meeting */ shortDesc: () => LocalizedString /** - * Search and retrieve emails from Outlook based on dates, senders, recipients, subject, body content, and detailed attachment properties like names, patterns, MIME types, and sizes. + * Schedule a new meeting in Microsoft Teams with specified participants, time, location, and other meeting details. */ longDesc: () => LocalizedString options: { - sort: { - /** - * Sort - */ - displayName: () => LocalizedString - /** - * Sort emails by a specific field - */ - shortDesc: () => LocalizedString - /** - * Sort the email results by a specific field. The default is to sort by received date in descending order. - */ - longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Sort Field - */ - displayName: () => LocalizedString - /** - * Field to sort by - */ - shortDesc: () => LocalizedString - /** - * Select the field by which to sort the email results. - */ - longDesc: () => LocalizedString - } - order: { - /** - * Sort Order - */ - displayName: () => LocalizedString - /** - * Order of sorting - */ - shortDesc: () => LocalizedString - /** - * Choose the order in which to sort the results. Options include Ascending and Descending. - */ - longDesc: () => LocalizedString - } - } - } - } - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * Maximum number of emails to return - */ - shortDesc: () => LocalizedString - /** - * Sets the maximum number of email results to return. Default is 50. - */ - longDesc: () => LocalizedString - } - startDateTime: { - /** - * Start Date - */ - displayName: () => LocalizedString - /** - * Filter emails received on or after this date - */ - shortDesc: () => LocalizedString - /** - * Only include emails that were received on or after this date and time. - */ - longDesc: () => LocalizedString - } - endDateTime: { - /** - * End Date - */ - displayName: () => LocalizedString - /** - * Filter emails received on or before this date - */ - shortDesc: () => LocalizedString - /** - * Only include emails that were received on or before this date and time. - */ - longDesc: () => LocalizedString - } - fromSender: { - /** - * From Sender - */ - displayName: () => LocalizedString - /** - * Filter emails from a specific sender - */ - shortDesc: () => LocalizedString - /** - * Only include emails from this specific sender email address. - */ - longDesc: () => LocalizedString - } - toRecipient: { - /** - * To Recipient - */ - displayName: () => LocalizedString - /** - * Filter emails sent to a specific recipient - */ - shortDesc: () => LocalizedString - /** - * Only include emails sent to this specific recipient email address. - */ - longDesc: () => LocalizedString - } subject: { /** * Subject */ displayName: () => LocalizedString /** - * Filter emails by subject line text - */ - shortDesc: () => LocalizedString - /** - * Only include emails with this text in the subject line. - */ - longDesc: () => LocalizedString - } - hasAttachments: { - /** - * Has Attachments - */ - displayName: () => LocalizedString - /** - * Filter emails with or without attachments + * Meeting title */ shortDesc: () => LocalizedString /** - * When set to true, only include emails that have attachments. When false, only include emails without attachments. + * The title or subject of the meeting that will appear in calendar invitations and the meeting list. */ longDesc: () => LocalizedString } - isRead: { + startDateTime: { /** - * Is Read + * Start Time */ displayName: () => LocalizedString /** - * Filter read or unread emails + * Meeting start date and time */ shortDesc: () => LocalizedString /** - * When set to true, only include emails that have been read. When false, only include unread emails. + * The date and time when the meeting begins in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). */ longDesc: () => LocalizedString } - attachmentNames: { + endDateTime: { /** - * Attachment Names + * End Time */ displayName: () => LocalizedString /** - * Filter emails by specific attachment names + * Meeting end date and time */ shortDesc: () => LocalizedString /** - * Only include emails that have attachments with these filenames. + * The date and time when the meeting ends in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). */ longDesc: () => LocalizedString } - bodyContains: { + teamId: { /** - * Body Contains + * Team ID */ displayName: () => LocalizedString /** - * Filter emails by body content + * Associated team identifier */ shortDesc: () => LocalizedString /** - * Only include emails that contain this text in the body content. + * Optional team identifier if the meeting is associated with a specific team. */ longDesc: () => LocalizedString } - includeAttachments: { + channelId: { /** - * Include Attachments + * Channel ID */ displayName: () => LocalizedString /** - * Include attachment content in results + * Associated channel identifier */ shortDesc: () => LocalizedString /** - * When set to true, the content of email attachments will be included in the results. This may increase response size significantly. + * Optional channel identifier if the meeting is associated with a specific channel within a team. */ longDesc: () => LocalizedString } - folder: { + content: { /** - * Folder + * Meeting Content */ displayName: () => LocalizedString /** - * Email folder to search in + * Meeting agenda or notes */ shortDesc: () => LocalizedString /** - * The email folder to search in. Defaults to Inbox if not specified. + * Optional text describing the meeting agenda, preparation materials, or other relevant information. */ longDesc: () => LocalizedString } - attachmentFilenamePattern: { + location: { /** - * Attachment Filename Pattern + * Location */ displayName: () => LocalizedString /** - * Filter by attachment filename pattern (regex) + * Physical or virtual meeting location */ shortDesc: () => LocalizedString /** - * Filter emails by a regular expression pattern that matches attachment filenames. Example: ".*\.pdf$" would match all PDF files. + * The physical location where the meeting will take place, or a custom virtual location description. */ longDesc: () => LocalizedString } - attachmentMimeTypes: { + attendees: { /** - * Attachment MIME Types + * Attendees */ displayName: () => LocalizedString /** - * Filter by attachment MIME types + * Meeting participants */ shortDesc: () => LocalizedString /** - * Only include emails with attachments matching these MIME types (e.g., "application/pdf", "image/jpeg"). + * List of email addresses or user IDs for people who should be invited to the meeting. */ longDesc: () => LocalizedString } - attachmentMinSize: { + isOnlineMeeting: { /** - * Attachment Minimum Size + * Online Meeting */ displayName: () => LocalizedString /** - * Filter by attachment minimum size in bytes + * Enable Teams online meeting features */ shortDesc: () => LocalizedString /** - * Only include emails with attachments larger than or equal to this size in bytes. + * When set to true, creates a Teams online meeting with video conferencing capabilities and a join link. */ longDesc: () => LocalizedString } - attachmentMaxSize: { + timeZone: { /** - * Attachment Maximum Size + * Time Zone */ displayName: () => LocalizedString /** - * Filter by attachment maximum size in bytes + * Meeting time zone */ shortDesc: () => LocalizedString /** - * Only include emails with attachments smaller than or equal to this size in bytes. + * The time zone for the meeting start and end times, such as "Pacific Standard Time" or "UTC". */ longDesc: () => LocalizedString } } } - 'create-contact': { + 'delete-meeting': { /** - * Create Contact + * Delete Meeting */ displayName: () => LocalizedString /** - * Create a new contact in your Outlook contacts. + * Cancel an existing meeting */ shortDesc: () => LocalizedString /** - * Create a new contact with details such as name, email, phone numbers, and job information in your Microsoft Outlook contacts. + * Permanently cancels and removes a scheduled meeting from all participants' calendars. */ longDesc: () => LocalizedString options: { - givenName: { - /** - * First Name - */ - displayName: () => LocalizedString - /** - * The contact's first name. - */ - shortDesc: () => LocalizedString - /** - * Enter the first name or given name of the contact. - */ - longDesc: () => LocalizedString - } - surname: { - /** - * Last Name - */ - displayName: () => LocalizedString - /** - * The contact's last name. - */ - shortDesc: () => LocalizedString - /** - * Enter the last name or surname of the contact. - */ - longDesc: () => LocalizedString - } - emailAddresses: { - /** - * Email Addresses - */ - displayName: () => LocalizedString - /** - * Email addresses for the contact. - */ - shortDesc: () => LocalizedString - /** - * Enter one or more email addresses for the contact. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - address: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * The email address of the contact. - */ - shortDesc: () => LocalizedString - /** - * Enter a valid email address for the contact. - */ - longDesc: () => LocalizedString - } - name: { - /** - * Display Name - */ - displayName: () => LocalizedString - /** - * The display name for this email address. - */ - shortDesc: () => LocalizedString - /** - * Enter how you want the name to appear for this email address. - */ - longDesc: () => LocalizedString - } - } - } - } - } - businessPhones: { - /** - * Business Phones - */ - displayName: () => LocalizedString - /** - * Business phone numbers for the contact. - */ - shortDesc: () => LocalizedString - /** - * Enter one or more business phone numbers for the contact. - */ - longDesc: () => LocalizedString - } - mobilePhone: { - /** - * Mobile Phone - */ - displayName: () => LocalizedString - /** - * The contact's mobile phone number. - */ - shortDesc: () => LocalizedString - /** - * Enter the mobile or cell phone number for the contact. - */ - longDesc: () => LocalizedString - } - jobTitle: { - /** - * Job Title - */ - displayName: () => LocalizedString - /** - * The contact's job title. - */ - shortDesc: () => LocalizedString - /** - * Enter the professional title or role of the contact. - */ - longDesc: () => LocalizedString - } - companyName: { - /** - * Company Name - */ - displayName: () => LocalizedString - /** - * The name of the contact's company. - */ - shortDesc: () => LocalizedString - /** - * Enter the organization or company where the contact works. - */ - longDesc: () => LocalizedString - } - department: { + meetingId: { /** - * Department + * Meeting ID */ displayName: () => LocalizedString /** - * The contact's department. + * Unique meeting identifier */ shortDesc: () => LocalizedString /** - * Enter the department or division within the company where the contact works. + * The unique identifier (GUID) of the meeting to be canceled. */ longDesc: () => LocalizedString } - officeLocation: { + meetingSource: { /** - * Office Location + * Meeting Source */ displayName: () => LocalizedString /** - * The contact's office location. + * Origin of the meeting */ shortDesc: () => LocalizedString /** - * Enter the physical location or office where the contact works. + * Specifies where the meeting was created, such as "private" or "team". */ longDesc: () => LocalizedString } - businessAddress: { + teamId: { /** - * Business Address + * Team ID */ displayName: () => LocalizedString /** - * The contact's business address. + * Associated team identifier */ shortDesc: () => LocalizedString /** - * Enter the full business address details for the contact. + * The team identifier if the meeting is associated with a specific team. */ longDesc: () => LocalizedString - type: { - fields: { - street: { - /** - * Street - */ - displayName: () => LocalizedString - /** - * Street address. - */ - shortDesc: () => LocalizedString - /** - * Enter the street address including building number and street name. - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * City name. - */ - shortDesc: () => LocalizedString - /** - * Enter the city or town for the business address. - */ - longDesc: () => LocalizedString - } - state: { - /** - * State/Province - */ - displayName: () => LocalizedString - /** - * State or province. - */ - shortDesc: () => LocalizedString - /** - * Enter the state, province, or region for the business address. - */ - longDesc: () => LocalizedString - } - countryOrRegion: { - /** - * Country/Region - */ - displayName: () => LocalizedString - /** - * Country or region. - */ - shortDesc: () => LocalizedString - /** - * Enter the country or region for the business address. - */ - longDesc: () => LocalizedString - } - postalCode: { - /** - * Postal Code - */ - displayName: () => LocalizedString - /** - * Postal or zip code. - */ - shortDesc: () => LocalizedString - /** - * Enter the postal code or zip code for the business address. - */ - longDesc: () => LocalizedString - } - } - } } } } - 'update-contact': { + 'send-channel-message': { /** - * Update Contact + * Send Channel Message */ displayName: () => LocalizedString /** - * Update an existing contact in your Outlook contacts. + * Post a message to a team channel */ shortDesc: () => LocalizedString /** - * Modify details of an existing contact in your Microsoft Outlook contacts, such as name, email, phone numbers, or job information. + * Send a new message to a specific channel within a team that all channel members can view and respond to. */ longDesc: () => LocalizedString options: { - contactId: { + channelId: { /** - * Contact ID + * Channel ID */ displayName: () => LocalizedString /** - * The unique identifier for the contact. + * Target channel identifier */ shortDesc: () => LocalizedString /** - * Select the unique identifier of the contact you want to update. + * The unique identifier of the channel where the message will be posted. */ longDesc: () => LocalizedString } - givenName: { + teamId: { /** - * First Name + * Team ID */ displayName: () => LocalizedString /** - * The contact's first name. + * Team identifier */ shortDesc: () => LocalizedString /** - * Update the first name or given name of the contact. + * The unique identifier of the team containing the target channel. */ longDesc: () => LocalizedString } - surname: { + message: { /** - * Last Name + * Message */ displayName: () => LocalizedString /** - * The contact's last name. + * Message content */ shortDesc: () => LocalizedString /** - * Update the last name or surname of the contact. + * The text content of the message to be posted in the channel. */ longDesc: () => LocalizedString } - emailAddresses: { + contentType: { /** - * Email Addresses + * Content Type */ displayName: () => LocalizedString /** - * Email addresses for the contact. + * Format of the message content */ shortDesc: () => LocalizedString /** - * Update one or more email addresses for the contact. + * Specifies the format of the message content, such as "text" for plain text or "html" for formatted content. + */ + longDesc: () => LocalizedString + } + } + } + 'send-chat-message': { + /** + * Send Chat Message + */ + displayName: () => LocalizedString + /** + * Send a message to a chat conversation + */ + shortDesc: () => LocalizedString + /** + * Send a new message to a direct chat or group chat conversation outside of a team channel. + */ + longDesc: () => LocalizedString + options: { + chatId: { + /** + * Chat ID + */ + displayName: () => LocalizedString + /** + * Target chat identifier + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the direct chat or group chat where the message will be sent. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - address: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * The email address of the contact. - */ - shortDesc: () => LocalizedString - /** - * Enter a valid email address for the contact. - */ - longDesc: () => LocalizedString - } - name: { - /** - * Display Name - */ - displayName: () => LocalizedString - /** - * The display name for this email address. - */ - shortDesc: () => LocalizedString - /** - * Enter how you want the name to appear for this email address. - */ - longDesc: () => LocalizedString - } - } - } - } } - businessPhones: { + message: { /** - * Business Phones + * Message */ displayName: () => LocalizedString /** - * Business phone numbers for the contact. + * Message content */ shortDesc: () => LocalizedString /** - * Update one or more business phone numbers for the contact. + * The text content of the message to be sent in the chat. */ longDesc: () => LocalizedString } - mobilePhone: { + contentType: { /** - * Mobile Phone + * Content Type */ displayName: () => LocalizedString /** - * The contact's mobile phone number. + * Format of the message content */ shortDesc: () => LocalizedString /** - * Update the mobile or cell phone number for the contact. + * Specifies the format of the message content, such as "text" for plain text or "html" for formatted content. */ longDesc: () => LocalizedString } - jobTitle: { + } + } + 'update-channel': { + /** + * Update Channel + */ + displayName: () => LocalizedString + /** + * Modify an existing channel + */ + shortDesc: () => LocalizedString + /** + * Update the properties or membership of an existing channel within a team. + */ + longDesc: () => LocalizedString + options: { + channelId: { /** - * Job Title + * Channel ID */ displayName: () => LocalizedString /** - * The contact's job title. + * Target channel identifier */ shortDesc: () => LocalizedString /** - * Update the professional title or role of the contact. + * The unique identifier of the channel to be updated. */ longDesc: () => LocalizedString } - companyName: { + teamId: { /** - * Company Name + * Team ID */ displayName: () => LocalizedString /** - * The name of the contact's company. + * Team identifier */ shortDesc: () => LocalizedString /** - * Update the organization or company where the contact works. + * The unique identifier of the team containing the channel to be updated. */ longDesc: () => LocalizedString } - department: { + displayName: { /** - * Department + * Channel Name */ displayName: () => LocalizedString /** - * The contact's department. + * New channel name */ shortDesc: () => LocalizedString /** - * Update the department or division within the company where the contact works. + * The new display name for the channel. Must be unique within the team and between 1-50 characters. */ longDesc: () => LocalizedString } - officeLocation: { + description: { /** - * Office Location + * Description */ displayName: () => LocalizedString /** - * The contact's office location. + * New channel description */ shortDesc: () => LocalizedString /** - * Update the physical location or office where the contact works. + * Updated description explaining the purpose or topic of the channel. Limited to 1024 characters. */ longDesc: () => LocalizedString } - businessAddress: { + addMembers: { /** - * Business Address + * Add Members */ displayName: () => LocalizedString /** - * The contact's business address. + * Users to add to the channel */ shortDesc: () => LocalizedString /** - * Update the full business address details for the contact. + * List of user IDs to add as members to the channel. Only applicable for private channels. */ longDesc: () => LocalizedString - type: { - fields: { - street: { - /** - * Street - */ - displayName: () => LocalizedString - /** - * Street address. - */ - shortDesc: () => LocalizedString - /** - * Update the street address including building number and street name. - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * City name. - */ - shortDesc: () => LocalizedString - /** - * Update the city or town for the business address. - */ - longDesc: () => LocalizedString - } - state: { - /** - * State/Province - */ - displayName: () => LocalizedString - /** - * State or province. - */ - shortDesc: () => LocalizedString - /** - * Update the state, province, or region for the business address. - */ - longDesc: () => LocalizedString - } - countryOrRegion: { - /** - * Country/Region - */ - displayName: () => LocalizedString - /** - * Country or region. - */ - shortDesc: () => LocalizedString - /** - * Update the country or region for the business address. - */ - longDesc: () => LocalizedString - } - postalCode: { - /** - * Postal Code - */ - displayName: () => LocalizedString - /** - * Postal or zip code. - */ - shortDesc: () => LocalizedString - /** - * Update the postal code or zip code for the business address. - */ - longDesc: () => LocalizedString - } - } - } } - } - } - 'delete-contact': { - /** - * Delete Contact - */ - displayName: () => LocalizedString - /** - * Delete a contact from your Outlook contacts. - */ - shortDesc: () => LocalizedString - /** - * Permanently remove a contact from your Microsoft Outlook contacts. - */ - longDesc: () => LocalizedString - options: { - contactId: { + removeMembers: { /** - * Contact ID + * Remove Members */ displayName: () => LocalizedString /** - * The unique identifier for the contact. + * Users to remove from the channel */ shortDesc: () => LocalizedString /** - * Select the unique identifier of the contact to be deleted. + * List of user IDs to remove from the channel membership. Only applicable for private channels. */ longDesc: () => LocalizedString } } } - 'create-event': { + 'update-meeting': { /** - * Create Event + * Update Meeting */ displayName: () => LocalizedString /** - * Create a new event in your Outlook calendar. + * Modify an existing meeting */ shortDesc: () => LocalizedString /** - * Create a new event or meeting in your Microsoft Outlook calendar with details such as title, start and end times, location, and attendees. + * Update the details of a scheduled meeting, such as time, location, attendees, or other properties. */ longDesc: () => LocalizedString options: { - calendarId: { + meetingId: { /** - * Calendar ID + * Meeting ID */ displayName: () => LocalizedString /** - * The calendar where the event will be created. + * Target meeting identifier */ shortDesc: () => LocalizedString /** - * Select the calendar where you want to create the new event. + * The unique identifier of the meeting to be updated. */ longDesc: () => LocalizedString } - title: { + subject: { /** - * Title + * Subject */ displayName: () => LocalizedString /** - * The title or subject of the event. + * Updated meeting title */ shortDesc: () => LocalizedString /** - * Enter a title or subject for the event that will appear in your calendar. + * The new title or subject of the meeting that will appear in calendar invitations and the meeting list. */ longDesc: () => LocalizedString } - start: { + startDateTime: { /** * Start Time */ displayName: () => LocalizedString /** - * When the event begins. + * Updated meeting start time */ shortDesc: () => LocalizedString /** - * Enter the date and time when the event will start. + * The new date and time when the meeting begins in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). */ longDesc: () => LocalizedString } - timezone: { + endDateTime: { /** - * Time Zone + * End Time */ displayName: () => LocalizedString /** - * The time zone for the event times. + * Updated meeting end time */ shortDesc: () => LocalizedString /** - * Select the time zone that applies to the start and end times of the event. + * The new date and time when the meeting ends in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). */ longDesc: () => LocalizedString } - end: { + teamId: { /** - * End Time + * Team ID */ displayName: () => LocalizedString /** - * When the event ends. + * Associated team identifier */ shortDesc: () => LocalizedString /** - * Enter the date and time when the event will end. If not specified, defaults to 1 hour after start time. + * Updated team identifier if the meeting is associated with a specific team. */ longDesc: () => LocalizedString } - location: { + channelId: { /** - * Location + * Channel ID */ displayName: () => LocalizedString /** - * Where the event will take place. + * Associated channel identifier */ shortDesc: () => LocalizedString /** - * Enter the physical location or virtual meeting place for the event. + * Updated channel identifier if the meeting is associated with a specific channel within a team. */ longDesc: () => LocalizedString } - attendees: { + content: { /** - * Attendees + * Meeting Content */ displayName: () => LocalizedString /** - * People invited to the event. + * Updated meeting agenda or notes */ shortDesc: () => LocalizedString /** - * Add one or more attendees to invite to the event. + * Updated text describing the meeting agenda, preparation materials, or other relevant information. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - address: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * The attendee's email address. - */ - shortDesc: () => LocalizedString - /** - * Enter the email address of the person you want to invite. - */ - longDesc: () => LocalizedString - } - name: { - /** - * Display Name - */ - displayName: () => LocalizedString - /** - * The attendee's display name. - */ - shortDesc: () => LocalizedString - /** - * Optionally enter a display name for the attendee. - */ - longDesc: () => LocalizedString - } - } - } - } } - body: { + location: { /** - * Body + * Location */ displayName: () => LocalizedString /** - * The body content of the event. + * Updated meeting location */ shortDesc: () => LocalizedString /** - * Enter the description or details of the event that attendees will see in the invitation. + * The new physical location where the meeting will take place, or a custom virtual location description. */ longDesc: () => LocalizedString } - bodyContentType: { + attendees: { /** - * Body Content Type + * Attendees */ displayName: () => LocalizedString /** - * Format of the body content. + * Updated meeting participants */ shortDesc: () => LocalizedString /** - * Select whether the body content is plain text or HTML formatted. + * Updated list of email addresses or user IDs for people who should be invited to the meeting. */ longDesc: () => LocalizedString } @@ -226123,327 +230488,279 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Whether this is an online meeting. + * Enable/disable Teams online meeting features */ shortDesc: () => LocalizedString /** - * Enable this option to make this event an online meeting and generate a meeting link. + * When set to true, ensures the meeting has Teams online meeting capabilities with video conferencing and a join link. + */ + longDesc: () => LocalizedString + } + timeZone: { + /** + * Time Zone + */ + displayName: () => LocalizedString + /** + * Updated meeting time zone + */ + shortDesc: () => LocalizedString + /** + * The new time zone for the meeting start and end times, such as "Pacific Standard Time" or "UTC". */ longDesc: () => LocalizedString } } } - 'delete-event': { + } + triggers: { + 'new-channel-message': { /** - * Delete Event + * New Channel Message */ displayName: () => LocalizedString /** - * Delete an event from your Outlook calendar. + * Trigger when a message is posted in a channel */ shortDesc: () => LocalizedString /** - * Permanently remove an event or meeting from your Microsoft Outlook calendar. + * This trigger fires when a new message is posted in a specified channel within a team. */ longDesc: () => LocalizedString options: { - calendarId: { + channelId: { /** - * Calendar ID + * Channel ID */ displayName: () => LocalizedString /** - * The calendar containing the event. + * Channel to monitor for messages */ shortDesc: () => LocalizedString /** - * Select the calendar that contains the event you want to delete. + * The unique identifier of the channel to monitor for new messages. */ longDesc: () => LocalizedString } - eventId: { + teamId: { /** - * Event ID + * Team ID */ displayName: () => LocalizedString /** - * The unique identifier for the event. + * Team identifier */ shortDesc: () => LocalizedString /** - * Select the unique identifier of the event to be deleted. + * The unique identifier of the team containing the channel to monitor. */ longDesc: () => LocalizedString } } } - 'list-contacts': { + 'new-chat-message': { /** - * List Contacts + * New Chat Message */ displayName: () => LocalizedString /** - * Retrieve a list of contacts from your Outlook contacts. + * Trigger when a message is sent in a chat */ shortDesc: () => LocalizedString /** - * Get a list of contacts from your Microsoft Outlook contacts with optional filtering and limit. + * This trigger fires when a new message is sent in a direct chat or group chat conversation. */ longDesc: () => LocalizedString options: { - limit: { - /** - * Limit - */ - displayName: () => LocalizedString - /** - * The maximum number of contacts to retrieve. - */ - shortDesc: () => LocalizedString - /** - * Specify the maximum number of contacts to retrieve from the Outlook account. - */ - longDesc: () => LocalizedString - } - filter: { + chatId: { /** - * Filter + * Chat ID */ displayName: () => LocalizedString /** - * Filter contacts by name or email. + * Chat to monitor for messages */ shortDesc: () => LocalizedString /** - * Enter text to filter contacts by name or email address. Only contacts matching the filter will be returned. + * The unique identifier of the direct chat or group chat to monitor for new messages. */ longDesc: () => LocalizedString } } } - 'list-events': { + 'new-meeting': { /** - * List Events + * New Meeting */ displayName: () => LocalizedString /** - * Retrieve a list of events from your Outlook calendar. + * Trigger when a meeting is created */ shortDesc: () => LocalizedString /** - * Get a list of events from your Microsoft Outlook calendar with optional filtering by date range and limit. + * This trigger fires when a new meeting is scheduled that matches the specified criteria. */ longDesc: () => LocalizedString options: { - calendarId: { - /** - * Calendar ID - */ - displayName: () => LocalizedString - /** - * The calendar to retrieve events from. - */ - shortDesc: () => LocalizedString - /** - * Select the calendar from which you want to retrieve events. - */ - longDesc: () => LocalizedString - } - startDateTime: { - /** - * Start Date and Time - */ - displayName: () => LocalizedString - /** - * The start date and time for filtering events. - */ - shortDesc: () => LocalizedString - /** - * Enter a date and time to retrieve events that start on or after this time. - */ - longDesc: () => LocalizedString - } - endDateTime: { + meetingSource: { /** - * End Date and Time + * Meeting Source */ displayName: () => LocalizedString /** - * The end date and time for filtering events. + * Origin of the meeting */ shortDesc: () => LocalizedString /** - * Enter a date and time to retrieve events that end on or before this time. + * Specifies which type of meetings to monitor, such as "private" or "team" meetings. */ longDesc: () => LocalizedString } - limit: { + teamId: { /** - * Limit + * Team ID */ displayName: () => LocalizedString /** - * The maximum number of events to retrieve. + * Associated team identifier */ shortDesc: () => LocalizedString /** - * Specify the maximum number of events to retrieve from the Outlook calendar. + * Optional filter to only trigger for meetings associated with a specific team. */ longDesc: () => LocalizedString } } } - 'send-email': { + } + } + Serenity: { + /** + * Serenity + */ + displayName: () => LocalizedString + groups: { + /** + * AI & Language Models + */ + '0': () => LocalizedString + } + /** + * Create conversations, execute agents and manage interactions with Serenity AI Hub. + */ + shortDesc: () => LocalizedString + /** + * Enterprise AI ecosystem that enables businesses to create, manage, and scale AI agents effortlessly, enhancing productivity and innovation across various processes. + */ + longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to Serenity AI Hub + */ + title: () => LocalizedString + /** + * To connect to Serenity AI Hub, you will need your **API Key**. + + ## Getting Your API Key + + 1. Sign in to your [Serenity AI Hub](https://serenity.qore.ai/) account + 2. Navigate to **Developer Tools** or **API Settings** + 3. Generate a new API key or copy your existing key + 4. Give your API key a descriptive name for identification + + ## Connection Details + + ### API Key + Your Serenity API key that authenticates requests to execute agents, manage conversations, and interact with the Serenity AI Hub platform. + + **Note:** Keep your API key secure and never share it publicly. Your API key grants access to your organization's AI agents and conversations. + */ + content: () => LocalizedString + } + actions: { + 'create-conversation': { /** - * Send Email + * Create Conversation */ displayName: () => LocalizedString /** - * Send an email from your Outlook account. + * Create a conversation with a conversation agent */ shortDesc: () => LocalizedString /** - * Compose and send an email message from your Microsoft Outlook account to one or more recipients. + * Creates a conversation with the given agent code. This is required before executing an agent. */ longDesc: () => LocalizedString options: { - toRecipients: { + agentCode: { /** - * To Recipients + * Agent Code */ displayName: () => LocalizedString /** - * The primary recipients of the email. + * The code of the agent to create a conversation with */ shortDesc: () => LocalizedString /** - * Enter one or more email addresses for the primary recipients of the email. + * The code of the agent to create a conversation with */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - address: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * Recipient's email address. - */ - shortDesc: () => LocalizedString - /** - * Enter the email address of the recipient. - */ - longDesc: () => LocalizedString - } - name: { - /** - * Display Name - */ - displayName: () => LocalizedString - /** - * Recipient's display name. - */ - shortDesc: () => LocalizedString - /** - * Optionally enter a display name for the recipient. - */ - longDesc: () => LocalizedString - } - } - } - } } - ccRecipients: { + userIdentifier: { /** - * CC Recipients + * User Identifier */ displayName: () => LocalizedString /** - * The carbon copy recipients of the email. + * Used to uniquely identify a user in a conversation. */ shortDesc: () => LocalizedString /** - * Optionally enter one or more email addresses for recipients to be copied on the email. + * It helps maintain context across interactions. For example, you might use `"userIdentifier": "landing-page-user"` to track a specific user session. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - address: { - /** - * Email Address - */ - displayName: () => LocalizedString - /** - * CC recipient's email address. - */ - shortDesc: () => LocalizedString - /** - * Enter the email address of the CC recipient. - */ - longDesc: () => LocalizedString - } - name: { - /** - * Display Name - */ - displayName: () => LocalizedString - /** - * CC recipient's display name. - */ - shortDesc: () => LocalizedString - /** - * Optionally enter a display name for the CC recipient. - */ - longDesc: () => LocalizedString - } - } - } - } } - bccRecipients: { + inputParameters: { /** - * BCC Recipients + * Input Parameters */ displayName: () => LocalizedString /** - * The blind carbon copy recipients of the email. + * An array of key-value pairs for additional context. */ shortDesc: () => LocalizedString /** - * Optionally enter one or more email addresses for recipients to be blind copied on the email. + * An array of key-value pairs for additional context. */ longDesc: () => LocalizedString type: { element_type: { fields: { - address: { + key: { /** - * Email Address + * Key */ displayName: () => LocalizedString /** - * BCC recipient's email address. + * The key of the parameter */ shortDesc: () => LocalizedString /** - * Enter the email address of the BCC recipient. + * The key of the parameter */ longDesc: () => LocalizedString } - name: { + value: { /** - * Display Name + * Value */ displayName: () => LocalizedString /** - * BCC recipient's display name. + * The value of the parameter */ shortDesc: () => LocalizedString /** - * Optionally enter a display name for the BCC recipient. + * The value of the parameter */ longDesc: () => LocalizedString } @@ -226451,331 +230768,269 @@ export type TranslationFunctions = { } } } - subject: { + } + } + 'execute-agent': { + /** + * Execute Agent + */ + displayName: () => LocalizedString + /** + * Executes an agent with the given code. + */ + shortDesc: () => LocalizedString + /** + * Executes an agent with the given code. + */ + longDesc: () => LocalizedString + options: { + agentCode: { /** - * Subject + * Agent Code */ displayName: () => LocalizedString /** - * The subject line of the email. + * Used to identify and execute a specific agent within the Serenity* AI Hub */ shortDesc: () => LocalizedString /** - * Enter the subject line that will appear in the recipient's inbox. + * Used to identify and execute a specific agent within the Serenity* AI Hub */ longDesc: () => LocalizedString } - body: { + culture: { /** - * Body + * Culture */ displayName: () => LocalizedString /** - * The content of the email. + * Use this param to override the culture of the response. */ shortDesc: () => LocalizedString /** - * Enter the main message content of the email. + * Use this param to override the culture of the response. */ longDesc: () => LocalizedString } - bodyContentType: { + userLanguage: { /** - * Body Content Type + * User Language */ displayName: () => LocalizedString /** - * Format of the email body. + * The preferred language of the response */ shortDesc: () => LocalizedString /** - * Select whether the email body is plain text or HTML formatted. + * The preferred language of the response */ longDesc: () => LocalizedString } - saveToSentItems: { + params: { /** - * Save to Sent Items + * Params */ displayName: () => LocalizedString /** - * Whether to save a copy in Sent Items. + * An array of key-value pairs for execution context. */ shortDesc: () => LocalizedString /** - * Choose whether to save a copy of the email in your Sent Items folder. + * An array of key-value pairs for execution context. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + Key: { + /** + * Key + */ + displayName: () => LocalizedString + /** + * The key of the parameter + */ + shortDesc: () => LocalizedString + /** + * The key of the parameter + */ + longDesc: () => LocalizedString + } + Value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * The value of the parameter + */ + shortDesc: () => LocalizedString + /** + * The value of the parameter + */ + longDesc: () => LocalizedString + } + } + } + } } - attachments: { + volatileKnowledgeIds: { /** - * Attachments + * Volatile Knowledge IDs */ displayName: () => LocalizedString /** - * Files to attach to the email. + * Unique identifiers (UUIDs) used to retrieve specific pieces of volatile knowledge in the Serenity* AI Hub */ shortDesc: () => LocalizedString /** - * Optionally attach files to the email. You can add one or more files to be sent with the email. + * Unique identifiers (UUIDs) used to retrieve specific pieces of volatile knowledge in the Serenity* AI Hub */ longDesc: () => LocalizedString } } } - } - triggers: { - 'new-email-with-attachment': { + 'execute-conversation': { /** - * New Email with Attachment + * Execute Conversation */ displayName: () => LocalizedString /** - * Triggers when an email with attachments is received, processing each matching attachment individually. + * Send a message to a chat with agent */ shortDesc: () => LocalizedString /** - * Monitors an Outlook mailbox for new emails with attachments. When an email with attachments is received, each attachment that matches the specified filters will trigger a separate event. This allows for processing individual attachments from emails while maintaining the full email context. + * Send a message to a chat with agent */ longDesc: () => LocalizedString options: { - senderFilter: { - /** - * Sender Filter - */ - displayName: () => LocalizedString - /** - * Only process emails from this sender - */ - shortDesc: () => LocalizedString - /** - * If specified, only emails from this exact sender email address will be processed. Leave empty to process emails from any sender. - */ - longDesc: () => LocalizedString - } - subjectFilter: { + agentCode: { /** - * Subject Filter + * Agent Code */ displayName: () => LocalizedString /** - * Only process emails with this text in the subject + * The agent to check for conversations with */ shortDesc: () => LocalizedString /** - * If specified, only emails containing this text in the subject line will be processed. Leave empty to process emails with any subject. + * The agent to check for conversations with */ longDesc: () => LocalizedString } - filenameFilters: { + conversationId: { /** - * Filename Filters + * Conversation ID */ displayName: () => LocalizedString /** - * Only process attachments with matching filenames + * The conversation to send the message to */ shortDesc: () => LocalizedString /** - * A list of text strings to match against attachment filenames. If provided, only attachments with filenames containing any of these strings will be processed. Matching is case-insensitive. Leave empty to process all attachments regardless of filename. + * The conversation to send the message to */ longDesc: () => LocalizedString } - mimeTypeFilters: { + userLanguage: { /** - * MIME Type Filters + * User Language */ displayName: () => LocalizedString /** - * Only process attachments with matching MIME types + * The preferred language of the response */ shortDesc: () => LocalizedString /** - * A list of MIME type strings to match against attachment content types. If provided, only attachments with content types containing any of these strings will be processed. For example, use "pdf" to match PDF files, "image/" to match all images, or "spreadsheet" to match Excel files. Matching is case-insensitive. Leave empty to process all attachments regardless of MIME type. + * The preferred language of the response */ longDesc: () => LocalizedString } - action: { + message: { /** - * Email Action + * Message */ displayName: () => LocalizedString /** - * Action to perform on the email after processing its attachments + * Message to send to the agent */ shortDesc: () => LocalizedString /** - * Specify what should happen to the email after all matching attachments have been processed. Options include: None (leave the email as is), Delete (permanently remove the email), or Move (relocate the email to another folder). + * Message to send to the agent */ longDesc: () => LocalizedString } - targetFolderId: { + culture: { /** - * Target Folder + * Culture */ displayName: () => LocalizedString /** - * Destination folder for emails when using Move action + * Use this param to override the culture of the response. */ shortDesc: () => LocalizedString /** - * If the Email Action is set to "Move", specify the folder where the email should be moved after all attachments have been processed. This option is only used when Move is selected. + * Use this param to override the culture of the response. */ longDesc: () => LocalizedString } } - event_info: { - /** - * Contains the email data along with information about a single matching attachment. - */ - desc: () => LocalizedString - } - } - 'new-contact': { - /** - * New Contact - */ - displayName: () => LocalizedString - /** - * Triggered when a new contact is created in Outlook. - */ - shortDesc: () => LocalizedString - /** - * This trigger is activated whenever a new contact is added to your Microsoft Outlook contacts. - */ - longDesc: () => LocalizedString } - 'new-email': { + } + triggers: { + 'new-conversation-message': { /** - * New Email Trigger + * New Conversation Message */ displayName: () => LocalizedString /** - * Triggers when a new email is received in your Outlook inbox + * Triggered when a new message is posted in a conversation. */ shortDesc: () => LocalizedString /** - * Monitors your Outlook inbox and triggers when new emails arrive. Supports filtering by sender, subject, or attachments, and can optionally delete or move processed emails. + * This trigger activates when a new message is posted in a conversation. */ longDesc: () => LocalizedString options: { - senderFilter: { - /** - * Sender Filter - */ - displayName: () => LocalizedString - /** - * Filter emails by sender address - */ - shortDesc: () => LocalizedString - /** - * Only trigger for emails from this specific sender email address. Leave empty to trigger for all senders. - */ - longDesc: () => LocalizedString - } - subjectFilter: { - /** - * Subject Filter - */ - displayName: () => LocalizedString - /** - * Filter emails by subject content - */ - shortDesc: () => LocalizedString - /** - * Only trigger for emails containing this text in the subject line. Leave empty to match any subject. - */ - longDesc: () => LocalizedString - } - hasAttachments: { - /** - * Has Attachments - */ - displayName: () => LocalizedString - /** - * Filter by attachment presence - */ - shortDesc: () => LocalizedString - /** - * Filter emails based on whether they have attachments. Set to true to only trigger for emails with attachments, false for emails without attachments, or leave empty to trigger for both. - */ - longDesc: () => LocalizedString - } - includeAttachmentData: { - /** - * Include Attachment Data - */ - displayName: () => LocalizedString - /** - * Include attachment content in trigger data - */ - shortDesc: () => LocalizedString - /** - * When enabled, the trigger will fetch and include the actual attachment content in the trigger data. This may increase processing time for large attachments. - */ - longDesc: () => LocalizedString - } - action: { + conversationId: { /** - * Email Action + * Conversation ID */ displayName: () => LocalizedString /** - * Action to perform after triggering + * The unique identifier for the conversation. */ shortDesc: () => LocalizedString /** - * Optional action to perform on emails after the trigger runs. Choose "None" to leave emails unchanged, "Delete" to remove the email, or "Move" to relocate the email to another folder. + * Enter the Conversation ID to specify the conversation where you want to monitor new messages. */ longDesc: () => LocalizedString } - targetFolderId: { + agentCode: { /** - * Target Folder + * Agent ID */ displayName: () => LocalizedString /** - * Destination folder for moved emails + * The unique identifier for the agent. */ shortDesc: () => LocalizedString /** - * The folder where emails will be moved if the "Move" action is selected. Only required when action is set to "Move". + * Agent ID to check for available conversations from */ longDesc: () => LocalizedString } - } - event_info: { - /** - * Data from the received email, including metadata and content - */ - desc: () => LocalizedString - } - } - 'new-event': { - /** - * New Event - */ - displayName: () => LocalizedString - /** - * Triggered when a new event is created in an Outlook calendar. - */ - shortDesc: () => LocalizedString - /** - * This trigger is activated whenever a new event or meeting is created in your Microsoft Outlook calendar. - */ - longDesc: () => LocalizedString - options: { - calendarId: { + sender: { /** - * Calendar ID + * Sender */ displayName: () => LocalizedString /** - * The calendar to monitor for new events. + * Filter the messages by the sender. */ shortDesc: () => LocalizedString /** - * Optionally select a specific calendar to monitor. If not specified, all calendars will be monitored. + * Choose the sender the messages should be filtered by. */ longDesc: () => LocalizedString } @@ -226783,269 +231038,231 @@ export type TranslationFunctions = { } } } - Trello: { + Pipedrive: { + /** + * Pipedrive + */ + displayName: () => LocalizedString groups: { /** - * Project & Task Management + * CRM & Sales Management */ '0': () => LocalizedString } /** - * Trello - */ - displayName: () => LocalizedString - /** - * Trello is a collaboration tool that organizes your projects into boards. + * Manage your sales pipeline and customer relationships with Pipedrive. */ shortDesc: () => LocalizedString /** - * Trello is a collaboration tool that organizes your projects into boards. It is a web-based Kanban-style list-making application and is a subsidiary of Atlassian. + * Pipedrive is a sales management tool designed to help small sales teams manage intricate or lengthy sales processes. */ longDesc: () => LocalizedString triggers: { - 'card-due': { + pipedrive_activity_trigger: { /** - * Card Due + * Activity Action */ displayName: () => LocalizedString /** - * Triggers when a card becomes overdue. + * Triggers when an action is performed on an activity */ shortDesc: () => LocalizedString /** - * This trigger fires when a card has passed its due date and has not been marked as complete. + * This trigger activates when a selected action is performed on an activity in Pipedrive. Actions include creating, updating, deleting an activity or any change. */ longDesc: () => LocalizedString options: { - source: { - /** - * Source - */ - displayName: () => LocalizedString - /** - * Choose whether to monitor an entire board or a specific list. - */ - shortDesc: () => LocalizedString - /** - * Select "board" to monitor all lists on a board, or "list" to monitor a specific list only. - */ - longDesc: () => LocalizedString - } - boardId: { - /** - * Board - */ - displayName: () => LocalizedString - /** - * The board containing the cards to monitor. - */ - shortDesc: () => LocalizedString - /** - * Select the Trello board that contains the cards you want to monitor for due dates. - */ - longDesc: () => LocalizedString - } - listId: { - /** - * List - */ - displayName: () => LocalizedString - /** - * The specific list containing the cards to monitor. - */ - shortDesc: () => LocalizedString - /** - * Select a specific list to monitor for overdue cards. Only required if Source is set to "list". - */ - longDesc: () => LocalizedString - } - includeDueComplete: { + action: { /** - * Include Completed Cards + * Action */ displayName: () => LocalizedString /** - * Include cards marked as complete. + * Select the action that triggers the flow */ shortDesc: () => LocalizedString /** - * When enabled, the trigger will include overdue cards that have been marked as complete. By default, only incomplete overdue cards are included. + * Select the action that triggers the flow. Choose from: create, update, delete, or any change. */ longDesc: () => LocalizedString } } } - 'new-board': { - /** - * New Board - */ - displayName: () => LocalizedString - /** - * Triggers when a new board is created. - */ - shortDesc: () => LocalizedString - /** - * This trigger fires when a new Trello board is created or shared with the authenticated user. - */ - longDesc: () => LocalizedString - } - 'new-card': { + pipedrive_deal_trigger: { /** - * New Card + * Deal Action */ displayName: () => LocalizedString /** - * Triggers when a new card is created. + * Triggers when an action is performed on a deal */ shortDesc: () => LocalizedString /** - * This trigger fires when a new card is added to a specified board or list in Trello. + * This trigger activates when a selected action is performed on a deal in Pipedrive. Actions include creating, updating, deleting a deal or any change. */ longDesc: () => LocalizedString options: { - source: { + action: { /** - * Source + * Action */ displayName: () => LocalizedString /** - * Choose whether to monitor an entire board or a specific list. + * Select the action that triggers the flow */ shortDesc: () => LocalizedString /** - * Select "board" to monitor all lists on a board, or "list" to monitor a specific list only. + * Select the action that triggers the flow. Choose from: create, update, delete, or any change. */ longDesc: () => LocalizedString } - boardId: { + } + } + pipedrive_lead_trigger: { + /** + * Lead Action + */ + displayName: () => LocalizedString + /** + * Triggers when an action is performed on a lead + */ + shortDesc: () => LocalizedString + /** + * This trigger activates when a selected action is performed on a lead in Pipedrive. Actions include creating, updating, deleting a lead or any change. + */ + longDesc: () => LocalizedString + options: { + action: { /** - * Board + * Action */ displayName: () => LocalizedString /** - * The board to monitor for new cards. + * Select the action that triggers the flow */ shortDesc: () => LocalizedString /** - * Select the Trello board where you want to monitor for new cards being created. + * Select the action that triggers the flow. Choose from: create, update, delete, or any change. */ longDesc: () => LocalizedString } - listId: { + } + } + pipedrive_note_trigger: { + /** + * Note Action + */ + displayName: () => LocalizedString + /** + * Triggers when an action is performed on a note + */ + shortDesc: () => LocalizedString + /** + * This trigger activates when a selected action is performed on a note in Pipedrive. Actions include creating, updating, deleting a note or any change. + */ + longDesc: () => LocalizedString + options: { + action: { /** - * List + * Action */ displayName: () => LocalizedString /** - * The specific list to monitor for new cards. + * Select the action that triggers the flow */ shortDesc: () => LocalizedString /** - * Select a specific list to monitor for new cards. Only required if Source is set to "list". + * Select the action that triggers the flow. Choose from: create, update, delete, or any change. */ longDesc: () => LocalizedString } } } - 'new-label': { + pipedrive_organization_trigger: { /** - * New Label + * Organization Action */ displayName: () => LocalizedString /** - * Triggers when a new label is created. + * Triggers when an action is performed on an organization */ shortDesc: () => LocalizedString /** - * This trigger fires when a new label is created on a specified Trello board. + * This trigger activates when a selected action is performed on an organization in Pipedrive. Actions include creating, updating, deleting an organization or any change. */ longDesc: () => LocalizedString options: { - boardId: { + action: { /** - * Board + * Action */ displayName: () => LocalizedString /** - * The board to monitor for new labels. + * Select the action that triggers the flow */ shortDesc: () => LocalizedString /** - * Select the Trello board where you want to monitor for new labels being created. + * Select the action that triggers the flow. Choose from: create, update, delete, or any change. */ longDesc: () => LocalizedString } } } - 'new-list': { + pipedrive_person_trigger: { /** - * New List + * Person Action */ displayName: () => LocalizedString /** - * Triggers when a new list is created. + * Triggers when an action is performed on a person */ shortDesc: () => LocalizedString /** - * This trigger fires when a new list is added to a specified Trello board. + * This trigger activates when a selected action is performed on a person in Pipedrive. Actions include creating, updating, deleting a person or any change. */ longDesc: () => LocalizedString options: { - boardId: { - /** - * Board - */ - displayName: () => LocalizedString - /** - * The board to monitor for new lists. - */ - shortDesc: () => LocalizedString - /** - * Select the Trello board where you want to monitor for new lists being created. - */ - longDesc: () => LocalizedString - } - includeArchivedLists: { + action: { /** - * Include Archived Lists + * Action */ displayName: () => LocalizedString /** - * Include lists that are archived. + * Select the action that triggers the flow */ shortDesc: () => LocalizedString /** - * When enabled, the trigger will include new lists that are archived. By default, only open lists are included. + * Select the action that triggers the flow. Choose from: create, update, delete, or any change. */ longDesc: () => LocalizedString } } } - 'new-member': { + pipedrive_user_trigger: { /** - * New Member + * User Action */ displayName: () => LocalizedString /** - * Triggers when a new member is added to a board. + * Triggers when an action is performed on a user */ shortDesc: () => LocalizedString /** - * This trigger fires when a new member is added to a specified Trello board. + * This trigger activates when a selected action is performed on a user in Pipedrive. Actions include creating, updating, deleting a user or any change. */ longDesc: () => LocalizedString options: { - boardId: { + action: { /** - * Board + * Action */ displayName: () => LocalizedString /** - * The board to monitor for new members. + * Select the action that triggers the flow */ shortDesc: () => LocalizedString /** - * Select the Trello board where you want to monitor for new members being added. + * Select the action that triggers the flow. Choose from: create, update, delete, or any change. */ longDesc: () => LocalizedString } @@ -227055,157 +231272,431 @@ export type TranslationFunctions = { expressions: { '&&': { /** - * And + * and (&&) */ displayName: () => LocalizedString /** - * Logical AND operator + * Returns True if all arguments are True */ shortDesc: () => LocalizedString /** - * Combines multiple conditions where all must be true + * Returns `True` if all arguments are `True` with logic short-circuiting */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Condition + */ + displayName: () => LocalizedString + /** + * Boolean condition to evaluate + */ + shortDesc: () => LocalizedString + /** + * A boolean expression or condition that evaluates to True or False + */ + longDesc: () => LocalizedString + } + } } '||': { /** - * Or + * or (||) */ displayName: () => LocalizedString /** - * Logical OR operator + * Returns True if any argument is True */ shortDesc: () => LocalizedString /** - * Combines multiple conditions where at least one must be true + * Returns `True` if any argument is `True` with logic short-circuiting */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Condition + */ + displayName: () => LocalizedString + /** + * Boolean condition to evaluate + */ + shortDesc: () => LocalizedString + /** + * A boolean expression or condition that evaluates to True or False + */ + longDesc: () => LocalizedString + } + } } '==': { /** - * Equals + * equal (==) */ displayName: () => LocalizedString /** - * Field equals value + * Equality comparison */ shortDesc: () => LocalizedString /** - * Matches records where the field equals the specified value + * Returns `True` if the field value equals the specified value */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } } '!=': { /** - * Not Equals + * not equal (!=) */ displayName: () => LocalizedString /** - * Field does not equal value + * Inequality comparison */ shortDesc: () => LocalizedString /** - * Matches records where the field does not equal the specified value + * Returns `True` if the field value does not equal the specified value */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } } '>': { /** - * Greater Than + * greater than (>) */ displayName: () => LocalizedString /** - * Field is greater than value + * Greater than comparison */ shortDesc: () => LocalizedString /** - * Matches records where the field value is greater than the specified value + * Returns `True` if the field value is greater than the specified value */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } } '>=': { /** - * Greater Than or Equal + * greater than or equal (>=) */ displayName: () => LocalizedString /** - * Field is greater than or equal to value + * Greater than or equal comparison */ shortDesc: () => LocalizedString /** - * Matches records where the field value is greater than or equal to the specified value + * Returns `True` if the field value is greater than or equal to the specified value */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } } '<': { /** - * Less Than + * less than (<) */ displayName: () => LocalizedString /** - * Field is less than value + * Less than comparison */ shortDesc: () => LocalizedString /** - * Matches records where the field value is less than the specified value + * Returns `True` if the field value is less than the specified value */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } } '<=': { /** - * Less Than or Equal + * less than or equal (<=) */ displayName: () => LocalizedString /** - * Field is less than or equal to value + * Less than or equal comparison */ shortDesc: () => LocalizedString /** - * Matches records where the field value is less than or equal to the specified value + * Returns `True` if the field value is less than or equal to the specified value */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to compare + */ + shortDesc: () => LocalizedString + /** + * The field whose value will be compared + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Value to compare against + */ + shortDesc: () => LocalizedString + /** + * The value to compare the field against + */ + longDesc: () => LocalizedString + } + } } - 'is-set': { + like: { /** - * Is Set + * like */ displayName: () => LocalizedString /** - * Field has a value + * Pattern matching */ shortDesc: () => LocalizedString /** - * Matches records where the field has a value (is not empty) + * Returns `True` if the field value matches the specified pattern */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Text field to search + */ + shortDesc: () => LocalizedString + /** + * The text field to perform pattern matching on + */ + longDesc: () => LocalizedString + } + '1': { + /** + * Pattern + */ + displayName: () => LocalizedString + /** + * Pattern to match + */ + shortDesc: () => LocalizedString + /** + * The pattern to match against the field value + */ + longDesc: () => LocalizedString + } + } } - 'is-not-set': { + 'is-null': { /** - * Is Not Set + * is null */ displayName: () => LocalizedString /** - * Field has no value + * Field is null */ shortDesc: () => LocalizedString /** - * Matches records where the field has no value (is empty) + * Returns `True` if the field is null or has no value */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to check + */ + shortDesc: () => LocalizedString + /** + * The field to check for null value + */ + longDesc: () => LocalizedString + } + } } - contains: { + 'is-not-null': { /** - * Contains + * is not null */ displayName: () => LocalizedString /** - * Field contains value + * Field is not null */ shortDesc: () => LocalizedString /** - * Matches records where the field contains the specified substring + * Returns `True` if the field has a value and is not null */ longDesc: () => LocalizedString + args: { + '0': { + /** + * Field + */ + displayName: () => LocalizedString + /** + * Field to check + */ + shortDesc: () => LocalizedString + /** + * The field to check for a non-null value + */ + longDesc: () => LocalizedString + } + } } } searchOptions: { @@ -227224,31 +231715,31 @@ export type TranslationFunctions = { longDesc: () => LocalizedString type: { fields: { - field: { + column: { /** - * Field + * Column */ displayName: () => LocalizedString /** - * The field to sort by + * The column to sort by */ shortDesc: () => LocalizedString /** - * The name of the field to use for sorting results + * The name of the column to use for sorting results */ longDesc: () => LocalizedString } - direction: { + ascending: { /** - * Direction + * Ascending */ displayName: () => LocalizedString /** - * Sort direction + * Sort in ascending order */ shortDesc: () => LocalizedString /** - * The direction to sort results (ascending or descending) + * When enabled, results are sorted in ascending order (A-Z, 0-9) */ longDesc: () => LocalizedString } @@ -227257,3623 +231748,3069 @@ export type TranslationFunctions = { } } } - Teams: { + Magento: { /** - * Microsoft Teams + * Magento */ displayName: () => LocalizedString groups: { /** - * Messaging & Real-time Communication + * E-commerce Platforms */ '0': () => LocalizedString } /** - * Collaborate with your team using channels, meetings, and messages + * E-commerce platform for building online stores and managing customers, products, and orders */ shortDesc: () => LocalizedString /** - * Microsoft Teams is a collaboration platform that enables messaging, file sharing, video meetings, and app integration within your organization. + * Magento is a flexible e-commerce platform that provides businesses with a complete solution for building and managing online stores. This integration allows you to automate workflows when customer, product, order, invoice, or shipment events occur in your Magento store. */ longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to Magento + */ + title: () => LocalizedString + /** + * To connect to Magento, you will need your **Store URL** and an **Integration Access Token**. + + ## Creating an Integration Token + + 1. Log in to your Magento Admin Panel + 2. Navigate to **System** → **Integrations** + 3. Click **Add New Integration** + 4. Fill in the integration details: + - **Name**: Give it a descriptive name (e.g., "Qore Integration") + - **Email**: Your admin email + - **Callback URL** and **Identity Link URL**: Can be left empty for token-based access + 5. Go to the **API** tab + 6. Select the **Resource Access** level: + - Choose **All** for full access, or + - Choose **Custom** and select specific resources needed + 7. Click **Save** + 8. Click **Activate** on the integration + 9. Click **Allow** in the confirmation popup + 10. Copy the **Access Token** from the displayed credentials + + ## Connection Details + + ### Store URL + Your Magento store's base URL (e.g., `https://your-store.com`). Include the protocol (https://) but do not include trailing slashes. + + ### Access Token + The integration access token generated when you activated the integration. This token authenticates all API requests. + + ## For Magento 2.4.4 and Later + + If you're using Magento 2.4.4+, you may need to enable bearer token authentication: + + ```bash + bin/magento config:set oauth/consumer/enable_integration_as_bearer 1 + ``` + + **Note:** Integration tokens do not expire unless manually revoked. Store your access token securely and limit the integration's API access to only the resources needed for your use case. + */ + content: () => LocalizedString + } actions: { - 'create-channel': { + customerCustomerRepositoryV1GetByIdGet: { + groups: { + /** + * Customers + */ + '0': () => LocalizedString + } /** - * Create Channel + * Get Customer by ID */ displayName: () => LocalizedString /** - * Create a new channel in a team + * Retrieve a specific customer account by ID */ shortDesc: () => LocalizedString /** - * Create a new channel within a specified team where members can collaborate through conversations, files, and integrated apps. + * Retrieves detailed information about a customer account using the customer ID. Returns all customer attributes including address information, account status, and custom attributes. + */ + longDesc: () => LocalizedString + } + customerCustomerRepositoryV1SavePut: { + groups: { + /** + * Customers + */ + '0': () => LocalizedString + } + /** + * Update Customer + */ + displayName: () => LocalizedString + /** + * Update an existing customer account + */ + shortDesc: () => LocalizedString + /** + * Updates customer information for an existing account. This endpoint allows modification of personal information, addresses, custom attributes, and other account details. The customer ID must be included in the request. + */ + longDesc: () => LocalizedString + } + customerCustomerRepositoryV1DeleteByIdDelete: { + groups: { + /** + * Customers + */ + '0': () => LocalizedString + } + /** + * Delete Customer + */ + displayName: () => LocalizedString + /** + * Remove a customer account by ID + */ + shortDesc: () => LocalizedString + /** + * Permanently deletes a customer account from the system. This operation cannot be undone and will remove all customer data associated with the specified ID, including addresses and order history references. + */ + longDesc: () => LocalizedString + } + customerCustomerRepositoryV1GetListGet: { + groups: { + /** + * Customers + */ + '0': () => LocalizedString + } + /** + * List Customers + */ + displayName: () => LocalizedString + /** + * Retrieve a list of customer accounts + */ + shortDesc: () => LocalizedString + /** + * Returns a list of customer accounts that match specified search criteria. Results can be filtered, sorted, and paginated. Use search criteria parameters to narrow results by email, name, creation date, or other customer attributes. */ longDesc: () => LocalizedString options: { - teamId: { + 'searchCriteria[filterGroups][0][filters][0][field]': { /** - * Team ID + * Filter Field */ displayName: () => LocalizedString /** - * Unique identifier for the team + * Field to filter by */ shortDesc: () => LocalizedString /** - * The unique identifier (GUID) for the team where the new channel will be created. + * Specifies which product field to apply the filter condition to */ longDesc: () => LocalizedString } - displayName: { + 'searchCriteria[filterGroups][0][filters][0][value]': { /** - * Channel Name + * Filter Value */ displayName: () => LocalizedString /** - * Name of the new channel + * Value to filter with */ shortDesc: () => LocalizedString /** - * The display name for the new channel. Must be unique within the team and between 1-50 characters. + * The value to match against the specified field */ longDesc: () => LocalizedString } - description: { + 'searchCriteria[filterGroups][0][filters][0][conditionType]': { /** - * Description + * Filter Condition */ displayName: () => LocalizedString /** - * Description of the channel purpose + * Type of comparison to use */ shortDesc: () => LocalizedString /** - * Optional description explaining the purpose or topic of the channel. Limited to 1024 characters. + * Condition type for the filter (eq, neq, like, gt, lt, etc.) */ longDesc: () => LocalizedString } - membershipType: { + 'searchCriteria[sortOrders][0][field]': { /** - * Membership Type + * Sort Field */ displayName: () => LocalizedString /** - * Channel privacy setting + * Field to sort by */ shortDesc: () => LocalizedString /** - * Defines the privacy level of the channel. Options include "standard" (visible to all team members) or "private" (visible only to specific members). + * Specifies which product field to use for sorting the results */ longDesc: () => LocalizedString } - } - } - 'create-meeting': { - /** - * Create Meeting - */ - displayName: () => LocalizedString - /** - * Schedule a new Teams meeting - */ - shortDesc: () => LocalizedString - /** - * Schedule a new meeting in Microsoft Teams with specified participants, time, location, and other meeting details. - */ - longDesc: () => LocalizedString - options: { - subject: { + 'searchCriteria[sortOrders][0][direction]': { /** - * Subject + * Sort Direction */ displayName: () => LocalizedString /** - * Meeting title + * Direction to sort in */ shortDesc: () => LocalizedString /** - * The title or subject of the meeting that will appear in calendar invitations and the meeting list. + * Determines whether to sort in ascending or descending order */ longDesc: () => LocalizedString } - startDateTime: { + 'searchCriteria[pageSize]': { /** - * Start Time + * Page Size */ displayName: () => LocalizedString /** - * Meeting start date and time + * Number of results per page */ shortDesc: () => LocalizedString /** - * The date and time when the meeting begins in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). + * Specifies how many items to return in a single result set */ longDesc: () => LocalizedString } - endDateTime: { + 'searchCriteria[currentPage]': { /** - * End Time + * Current Page */ displayName: () => LocalizedString /** - * Meeting end date and time + * Page number to return */ shortDesc: () => LocalizedString /** - * The date and time when the meeting ends in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). + * Specifies which page of results to return */ longDesc: () => LocalizedString } - teamId: { + } + } + customerAccountManagementV1CreateAccountPost: { + groups: { + /** + * Customers + */ + '0': () => LocalizedString + } + /** + * Create Customer Account + */ + displayName: () => LocalizedString + /** + * Register a new customer account + */ + shortDesc: () => LocalizedString + /** + * Creates a new customer account with the provided information. Required fields include email, password, and first/last name. Optional details include addresses, date of birth, and custom attributes. Returns the newly created customer ID upon success. + */ + longDesc: () => LocalizedString + } + catalogProductRepositoryV1SavePost: { + groups: { + /** + * Products + */ + '0': () => LocalizedString + } + /** + * Create Product + */ + displayName: () => LocalizedString + /** + * Add a new product to the catalog + */ + shortDesc: () => LocalizedString + /** + * Creates a new product in the catalog with specified attributes, pricing, and inventory information. Products can be simple, configurable, bundled, grouped, virtual, or downloadable. Media gallery entries, tier prices, and custom options can also be defined. + */ + longDesc: () => LocalizedString + } + catalogProductRepositoryV1GetListGet: { + groups: { + /** + * Products + */ + '0': () => LocalizedString + } + /** + * List Products + */ + displayName: () => LocalizedString + /** + * Retrieve a list of products from the catalog + */ + shortDesc: () => LocalizedString + /** + * Returns a collection of products that match the specified search criteria. Results can be filtered by attributes like name, SKU, price, and status. Supports pagination, sorting, and inclusion of custom attributes in the response. + */ + longDesc: () => LocalizedString + options: { + 'searchCriteria[filterGroups][0][filters][0][field]': { /** - * Team ID + * Filter Field */ displayName: () => LocalizedString /** - * Associated team identifier + * Field to filter by */ shortDesc: () => LocalizedString /** - * Optional team identifier if the meeting is associated with a specific team. + * Specifies which product field to apply the filter condition to */ longDesc: () => LocalizedString } - channelId: { + 'searchCriteria[filterGroups][0][filters][0][value]': { /** - * Channel ID + * Filter Value */ displayName: () => LocalizedString /** - * Associated channel identifier + * Value to filter with */ shortDesc: () => LocalizedString /** - * Optional channel identifier if the meeting is associated with a specific channel within a team. + * The value to match against the specified field */ longDesc: () => LocalizedString } - content: { + 'searchCriteria[filterGroups][0][filters][0][conditionType]': { /** - * Meeting Content + * Filter Condition */ displayName: () => LocalizedString /** - * Meeting agenda or notes + * Type of comparison to use */ shortDesc: () => LocalizedString /** - * Optional text describing the meeting agenda, preparation materials, or other relevant information. + * Condition type for the filter (eq, neq, like, gt, lt, etc.) */ longDesc: () => LocalizedString } - location: { + 'searchCriteria[sortOrders][0][field]': { /** - * Location + * Sort Field */ displayName: () => LocalizedString /** - * Physical or virtual meeting location + * Field to sort by */ shortDesc: () => LocalizedString /** - * The physical location where the meeting will take place, or a custom virtual location description. + * Specifies which product field to use for sorting the results */ longDesc: () => LocalizedString } - attendees: { + 'searchCriteria[sortOrders][0][direction]': { /** - * Attendees + * Sort Direction */ displayName: () => LocalizedString /** - * Meeting participants + * Direction to sort in */ shortDesc: () => LocalizedString /** - * List of email addresses or user IDs for people who should be invited to the meeting. + * Determines whether to sort in ascending or descending order */ longDesc: () => LocalizedString } - isOnlineMeeting: { + 'searchCriteria[pageSize]': { /** - * Online Meeting + * Page Size */ displayName: () => LocalizedString /** - * Enable Teams online meeting features + * Number of results per page */ shortDesc: () => LocalizedString /** - * When set to true, creates a Teams online meeting with video conferencing capabilities and a join link. + * Specifies how many items to return in a single result set */ longDesc: () => LocalizedString } - timeZone: { + 'searchCriteria[currentPage]': { /** - * Time Zone + * Current Page */ displayName: () => LocalizedString /** - * Meeting time zone + * Page number to return */ shortDesc: () => LocalizedString /** - * The time zone for the meeting start and end times, such as "Pacific Standard Time" or "UTC". + * Specifies which page of results to return */ longDesc: () => LocalizedString } } } - 'delete-meeting': { + catalogProductRepositoryV1SavePut: { + groups: { + /** + * Products + */ + '0': () => LocalizedString + } /** - * Delete Meeting + * Update Product */ displayName: () => LocalizedString /** - * Cancel an existing meeting + * Modify an existing product */ shortDesc: () => LocalizedString /** - * Permanently cancels and removes a scheduled meeting from all participants' calendars. + * Updates an existing product in the catalog. Can modify any product attribute including name, price, description, images, inventory, and category assignments. The product SKU or ID must be specified in the request. */ longDesc: () => LocalizedString options: { - meetingId: { - /** - * Meeting ID - */ - displayName: () => LocalizedString - /** - * Unique meeting identifier - */ - shortDesc: () => LocalizedString - /** - * The unique identifier (GUID) of the meeting to be canceled. - */ - longDesc: () => LocalizedString - } - meetingSource: { - /** - * Meeting Source - */ - displayName: () => LocalizedString - /** - * Origin of the meeting - */ - shortDesc: () => LocalizedString - /** - * Specifies where the meeting was created, such as "private" or "team". - */ - longDesc: () => LocalizedString - } - teamId: { + sku: { /** - * Team ID + * Product SKU */ displayName: () => LocalizedString /** - * Associated team identifier + * Stock Keeping Unit identifier for the product */ shortDesc: () => LocalizedString /** - * The team identifier if the meeting is associated with a specific team. + * A unique alphanumeric identifier assigned to a product for inventory tracking and management purposes. The SKU helps in identifying specific product variations including size, color, and other attributes. */ longDesc: () => LocalizedString } } } - 'send-channel-message': { + catalogProductRepositoryV1DeleteByIdDelete: { + groups: { + /** + * Products + */ + '0': () => LocalizedString + } /** - * Send Channel Message + * Delete Product */ displayName: () => LocalizedString /** - * Post a message to a team channel + * Remove a product from the catalog */ shortDesc: () => LocalizedString /** - * Send a new message to a specific channel within a team that all channel members can view and respond to. + * Permanently removes a product from the catalog by ID or SKU. This operation cannot be undone and may affect existing orders and carts that reference the deleted product. */ longDesc: () => LocalizedString options: { - channelId: { - /** - * Channel ID - */ - displayName: () => LocalizedString - /** - * Target channel identifier - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the channel where the message will be posted. - */ - longDesc: () => LocalizedString - } - teamId: { - /** - * Team ID - */ - displayName: () => LocalizedString - /** - * Team identifier - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the team containing the target channel. - */ - longDesc: () => LocalizedString - } - message: { - /** - * Message - */ - displayName: () => LocalizedString - /** - * Message content - */ - shortDesc: () => LocalizedString - /** - * The text content of the message to be posted in the channel. - */ - longDesc: () => LocalizedString - } - contentType: { + sku: { /** - * Content Type + * Product SKU */ displayName: () => LocalizedString /** - * Format of the message content + * Stock Keeping Unit identifier for the product */ shortDesc: () => LocalizedString /** - * Specifies the format of the message content, such as "text" for plain text or "html" for formatted content. + * A unique alphanumeric identifier assigned to a product for inventory tracking and management purposes. The SKU helps in identifying specific product variations including size, color, and other attributes. */ longDesc: () => LocalizedString } } } - 'send-chat-message': { + catalogProductRepositoryV1GetGet: { + groups: { + /** + * Products + */ + '0': () => LocalizedString + } /** - * Send Chat Message + * Get Product Details */ displayName: () => LocalizedString /** - * Send a message to a chat conversation + * Retrieve detailed information about a specific product */ shortDesc: () => LocalizedString /** - * Send a new message to a direct chat or group chat conversation outside of a team channel. + * Retrieves comprehensive information about a specific product by SKU or ID. The response includes all product attributes, images, pricing information, inventory status, and category assignments. Additional parameters can control which data is included. */ longDesc: () => LocalizedString options: { - chatId: { - /** - * Chat ID - */ - displayName: () => LocalizedString - /** - * Target chat identifier - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the direct chat or group chat where the message will be sent. - */ - longDesc: () => LocalizedString - } - message: { - /** - * Message - */ - displayName: () => LocalizedString - /** - * Message content - */ - shortDesc: () => LocalizedString - /** - * The text content of the message to be sent in the chat. - */ - longDesc: () => LocalizedString - } - contentType: { + sku: { /** - * Content Type + * Product SKU */ displayName: () => LocalizedString /** - * Format of the message content + * Stock Keeping Unit identifier for the product */ shortDesc: () => LocalizedString /** - * Specifies the format of the message content, such as "text" for plain text or "html" for formatted content. + * A unique alphanumeric identifier assigned to a product for inventory tracking and management purposes. The SKU helps in identifying specific product variations including size, color, and other attributes. */ longDesc: () => LocalizedString } } } - 'update-channel': { + quoteCartRepositoryV1GetListGet: { + groups: { + /** + * Shopping Carts + */ + '0': () => LocalizedString + } /** - * Update Channel + * List Shopping Carts */ displayName: () => LocalizedString /** - * Modify an existing channel + * Retrieve a list of active shopping carts */ shortDesc: () => LocalizedString /** - * Update the properties or membership of an existing channel within a team. + * Returns a collection of active shopping carts that match the specified search criteria. Results can be filtered by customer ID, creation date, and cart status. Each cart includes items, applied coupons, and shipping/billing information if available. */ longDesc: () => LocalizedString options: { - channelId: { - /** - * Channel ID - */ - displayName: () => LocalizedString - /** - * Target channel identifier - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the channel to be updated. - */ - longDesc: () => LocalizedString - } - teamId: { - /** - * Team ID - */ - displayName: () => LocalizedString - /** - * Team identifier - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the team containing the channel to be updated. - */ - longDesc: () => LocalizedString - } - displayName: { - /** - * Channel Name - */ - displayName: () => LocalizedString - /** - * New channel name - */ - shortDesc: () => LocalizedString - /** - * The new display name for the channel. Must be unique within the team and between 1-50 characters. - */ - longDesc: () => LocalizedString - } - description: { + 'searchCriteria[filterGroups][0][filters][0][field]': { /** - * Description + * Filter Field */ displayName: () => LocalizedString /** - * New channel description + * Field to filter by */ shortDesc: () => LocalizedString /** - * Updated description explaining the purpose or topic of the channel. Limited to 1024 characters. + * Specifies which product field to apply the filter condition to */ longDesc: () => LocalizedString } - addMembers: { + 'searchCriteria[filterGroups][0][filters][0][value]': { /** - * Add Members + * Filter Value */ displayName: () => LocalizedString /** - * Users to add to the channel + * Value to filter with */ shortDesc: () => LocalizedString /** - * List of user IDs to add as members to the channel. Only applicable for private channels. + * The value to match against the specified field */ longDesc: () => LocalizedString } - removeMembers: { + 'searchCriteria[filterGroups][0][filters][0][conditionType]': { /** - * Remove Members + * Filter Condition */ displayName: () => LocalizedString /** - * Users to remove from the channel + * Type of comparison to use */ shortDesc: () => LocalizedString /** - * List of user IDs to remove from the channel membership. Only applicable for private channels. + * Condition type for the filter (eq, neq, like, gt, lt, etc.) */ longDesc: () => LocalizedString } - } - } - 'update-meeting': { - /** - * Update Meeting - */ - displayName: () => LocalizedString - /** - * Modify an existing meeting - */ - shortDesc: () => LocalizedString - /** - * Update the details of a scheduled meeting, such as time, location, attendees, or other properties. - */ - longDesc: () => LocalizedString - options: { - meetingId: { + 'searchCriteria[sortOrders][0][field]': { /** - * Meeting ID + * Sort Field */ displayName: () => LocalizedString /** - * Target meeting identifier + * Field to sort by */ shortDesc: () => LocalizedString /** - * The unique identifier of the meeting to be updated. + * Specifies which product field to use for sorting the results */ longDesc: () => LocalizedString } - subject: { + 'searchCriteria[sortOrders][0][direction]': { /** - * Subject + * Sort Direction */ displayName: () => LocalizedString /** - * Updated meeting title + * Direction to sort in */ shortDesc: () => LocalizedString /** - * The new title or subject of the meeting that will appear in calendar invitations and the meeting list. + * Determines whether to sort in ascending or descending order */ longDesc: () => LocalizedString } - startDateTime: { + 'searchCriteria[pageSize]': { /** - * Start Time + * Page Size */ displayName: () => LocalizedString /** - * Updated meeting start time + * Number of results per page */ shortDesc: () => LocalizedString /** - * The new date and time when the meeting begins in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). + * Specifies how many items to return in a single result set */ longDesc: () => LocalizedString } - endDateTime: { + 'searchCriteria[currentPage]': { /** - * End Time + * Current Page */ displayName: () => LocalizedString /** - * Updated meeting end time + * Page number to return */ shortDesc: () => LocalizedString /** - * The new date and time when the meeting ends in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). + * Specifies which page of results to return */ longDesc: () => LocalizedString } - teamId: { + } + } + salesOrderRepositoryV1GetGet: { + groups: { + /** + * Orders + */ + '0': () => LocalizedString + } + /** + * Get Order Details + */ + displayName: () => LocalizedString + /** + * Retrieve detailed information about a specific order + */ + shortDesc: () => LocalizedString + /** + * Retrieves comprehensive information about a specific order by ID. Includes order items, billing and shipping addresses, payment information, applied discounts, and order status history. Useful for order processing and customer service inquiries. + */ + longDesc: () => LocalizedString + } + salesOrderRepositoryV1GetListGet: { + groups: { + /** + * Orders + */ + '0': () => LocalizedString + } + /** + * List Orders + */ + displayName: () => LocalizedString + /** + * Retrieve a list of orders based on search criteria + */ + shortDesc: () => LocalizedString + /** + * Returns a collection of orders that match the specified search criteria. Results can be filtered by customer, status, date range, and total amount. Supports pagination and sorting to efficiently browse large order volumes. + */ + longDesc: () => LocalizedString + options: { + 'searchCriteria[filterGroups][0][filters][0][field]': { /** - * Team ID + * Filter Field */ displayName: () => LocalizedString /** - * Associated team identifier + * Field to filter by */ shortDesc: () => LocalizedString /** - * Updated team identifier if the meeting is associated with a specific team. + * Specifies which product field to apply the filter condition to */ longDesc: () => LocalizedString } - channelId: { + 'searchCriteria[filterGroups][0][filters][0][value]': { /** - * Channel ID + * Filter Value */ displayName: () => LocalizedString /** - * Associated channel identifier + * Value to filter with */ shortDesc: () => LocalizedString /** - * Updated channel identifier if the meeting is associated with a specific channel within a team. + * The value to match against the specified field */ longDesc: () => LocalizedString } - content: { + 'searchCriteria[filterGroups][0][filters][0][conditionType]': { /** - * Meeting Content + * Filter Condition */ displayName: () => LocalizedString /** - * Updated meeting agenda or notes + * Type of comparison to use */ shortDesc: () => LocalizedString /** - * Updated text describing the meeting agenda, preparation materials, or other relevant information. + * Condition type for the filter (eq, neq, like, gt, lt, etc.) */ longDesc: () => LocalizedString } - location: { + 'searchCriteria[sortOrders][0][field]': { /** - * Location + * Sort Field */ displayName: () => LocalizedString /** - * Updated meeting location + * Field to sort by */ shortDesc: () => LocalizedString /** - * The new physical location where the meeting will take place, or a custom virtual location description. + * Specifies which product field to use for sorting the results */ longDesc: () => LocalizedString } - attendees: { + 'searchCriteria[sortOrders][0][direction]': { /** - * Attendees + * Sort Direction */ displayName: () => LocalizedString /** - * Updated meeting participants + * Direction to sort in */ shortDesc: () => LocalizedString /** - * Updated list of email addresses or user IDs for people who should be invited to the meeting. + * Determines whether to sort in ascending or descending order */ longDesc: () => LocalizedString } - isOnlineMeeting: { + 'searchCriteria[pageSize]': { /** - * Online Meeting + * Page Size */ displayName: () => LocalizedString /** - * Enable/disable Teams online meeting features + * Number of results per page */ shortDesc: () => LocalizedString /** - * When set to true, ensures the meeting has Teams online meeting capabilities with video conferencing and a join link. + * Specifies how many items to return in a single result set */ longDesc: () => LocalizedString } - timeZone: { + 'searchCriteria[currentPage]': { /** - * Time Zone + * Current Page */ displayName: () => LocalizedString /** - * Updated meeting time zone + * Page number to return */ shortDesc: () => LocalizedString /** - * The new time zone for the meeting start and end times, such as "Pacific Standard Time" or "UTC". + * Specifies which page of results to return */ longDesc: () => LocalizedString } } } - } - triggers: { - 'new-channel-message': { + salesShipmentRepositoryV1SavePost: { + groups: { + /** + * Shipments + */ + '0': () => LocalizedString + } /** - * New Channel Message + * Create Shipment */ displayName: () => LocalizedString /** - * Trigger when a message is posted in a channel + * Creates a new shipment for an order */ shortDesc: () => LocalizedString /** - * This trigger fires when a new message is posted in a specified channel within a team. + * Creates a new shipment record for an existing order, allowing you to document and track the physical sending of order items to the customer. Includes options for specifying tracking numbers, shipping carriers, and shipped items with their quantities. */ longDesc: () => LocalizedString - options: { - channelId: { - /** - * Channel ID - */ - displayName: () => LocalizedString - /** - * Channel to monitor for messages - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the channel to monitor for new messages. - */ - longDesc: () => LocalizedString - } - teamId: { - /** - * Team ID - */ - displayName: () => LocalizedString - /** - * Team identifier - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the team containing the channel to monitor. - */ - longDesc: () => LocalizedString - } + } + salesInvoiceRepositoryV1SavePost: { + groups: { + /** + * Invoices + */ + '0': () => LocalizedString } + /** + * Create Invoice + */ + displayName: () => LocalizedString + /** + * Creates a new invoice for an order + */ + shortDesc: () => LocalizedString + /** + * Creates a new invoice record for an existing order, documenting the financial transaction and payment request. Allows for specifying line items to be invoiced, payment details, and comments that will appear on the customer's invoice. + */ + longDesc: () => LocalizedString } - 'new-chat-message': { + salesOrderRepositoryV1SavePut: { + groups: { + /** + * Orders + */ + '0': () => LocalizedString + } /** - * New Chat Message + * Create Order */ displayName: () => LocalizedString /** - * Trigger when a message is sent in a chat + * Persists order information to the system */ shortDesc: () => LocalizedString /** - * This trigger fires when a new message is sent in a direct chat or group chat conversation. + * Performs persist operations for a specified order. Saves the order data to the database, including customer information, line items, payment details, shipping information, and other relevant order metadata. + */ + longDesc: () => LocalizedString + } + salesOrderManagementV1AddCommentPost: { + groups: { + /** + * Orders + */ + '0': () => LocalizedString + } + /** + * Add Order Comment + */ + displayName: () => LocalizedString + /** + * Append a comment to an existing order + */ + shortDesc: () => LocalizedString + /** + * Adds a comment to the order history. Comments can be internal (visible only to administrators) or customer-visible. Each comment is timestamped and attributed to the author. Useful for documenting order processing steps and customer communications. */ longDesc: () => LocalizedString options: { - chatId: { + id: { /** - * Chat ID + * Order ID */ displayName: () => LocalizedString /** - * Chat to monitor for messages + * The ID of the order to which the comment will be added */ shortDesc: () => LocalizedString /** - * The unique identifier of the direct chat or group chat to monitor for new messages. + * The ID of the order to which the comment will be added */ longDesc: () => LocalizedString } } } - 'new-meeting': { + salesOrderManagementV1GetCommentsListGet: { + groups: { + /** + * Orders + */ + '0': () => LocalizedString + } /** - * New Meeting + * Get Order Comments */ displayName: () => LocalizedString /** - * Trigger when a meeting is created + * Retrieve the comment history for an order */ shortDesc: () => LocalizedString /** - * This trigger fires when a new meeting is scheduled that matches the specified criteria. + * Returns the complete comment history for a specific order. Results include comment text, timestamp, author information, and visibility status (customer-visible or admin-only). Comments are returned in chronological order. + */ + longDesc: () => LocalizedString + } + salesInvoiceRepositoryV1GetListGet: { + groups: { + /** + * Invoices + */ + '0': () => LocalizedString + } + /** + * List Invoices + */ + displayName: () => LocalizedString + /** + * Retrieve a collection of invoices + */ + shortDesc: () => LocalizedString + /** + * Returns a list of invoices based on specified search criteria. Results can be filtered by order ID, customer, date, and amount. Each invoice includes line items, payment information, and related order details. Supports pagination and sorting. */ longDesc: () => LocalizedString options: { - meetingSource: { + 'searchCriteria[filterGroups][0][filters][0][field]': { /** - * Meeting Source + * Filter Field */ displayName: () => LocalizedString /** - * Origin of the meeting + * Field to filter by */ shortDesc: () => LocalizedString /** - * Specifies which type of meetings to monitor, such as "private" or "team" meetings. + * Specifies which product field to apply the filter condition to */ longDesc: () => LocalizedString } - teamId: { + 'searchCriteria[filterGroups][0][filters][0][value]': { /** - * Team ID + * Filter Value */ displayName: () => LocalizedString /** - * Associated team identifier + * Value to filter with */ shortDesc: () => LocalizedString /** - * Optional filter to only trigger for meetings associated with a specific team. + * The value to match against the specified field */ longDesc: () => LocalizedString } - } - } - } - } - Serenity: { - /** - * Serenity - */ - displayName: () => LocalizedString - groups: { - /** - * AI & Language Models - */ - '0': () => LocalizedString - } - /** - * Create conversations, execute agents and manage interactions with Serenity AI Hub. - */ - shortDesc: () => LocalizedString - /** - * Enterprise AI ecosystem that enables businesses to create, manage, and scale AI agents effortlessly, enhancing productivity and innovation across various processes. - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to Serenity AI Hub - */ - title: () => LocalizedString - /** - * To connect to Serenity AI Hub, you will need your **API Key**. - - ## Getting Your API Key - - 1. Sign in to your [Serenity AI Hub](https://serenity.qore.ai/) account - 2. Navigate to **Developer Tools** or **API Settings** - 3. Generate a new API key or copy your existing key - 4. Give your API key a descriptive name for identification - - ## Connection Details - - ### API Key - Your Serenity API key that authenticates requests to execute agents, manage conversations, and interact with the Serenity AI Hub platform. - - **Note:** Keep your API key secure and never share it publicly. Your API key grants access to your organization's AI agents and conversations. - */ - content: () => LocalizedString - } - actions: { - 'create-conversation': { - /** - * Create Conversation - */ - displayName: () => LocalizedString - /** - * Create a conversation with a conversation agent - */ - shortDesc: () => LocalizedString - /** - * Creates a conversation with the given agent code. This is required before executing an agent. - */ - longDesc: () => LocalizedString - options: { - agentCode: { + 'searchCriteria[filterGroups][0][filters][0][conditionType]': { /** - * Agent Code + * Filter Condition */ displayName: () => LocalizedString /** - * The code of the agent to create a conversation with + * Type of comparison to use */ shortDesc: () => LocalizedString /** - * The code of the agent to create a conversation with + * Condition type for the filter (eq, neq, like, gt, lt, etc.) */ longDesc: () => LocalizedString } - userIdentifier: { + 'searchCriteria[sortOrders][0][field]': { /** - * User Identifier + * Sort Field */ displayName: () => LocalizedString /** - * Used to uniquely identify a user in a conversation. + * Field to sort by */ shortDesc: () => LocalizedString /** - * It helps maintain context across interactions. For example, you might use `"userIdentifier": "landing-page-user"` to track a specific user session. + * Specifies which product field to use for sorting the results */ longDesc: () => LocalizedString } - inputParameters: { + 'searchCriteria[sortOrders][0][direction]': { /** - * Input Parameters + * Sort Direction */ displayName: () => LocalizedString /** - * An array of key-value pairs for additional context. + * Direction to sort in */ shortDesc: () => LocalizedString /** - * An array of key-value pairs for additional context. + * Determines whether to sort in ascending or descending order + */ + longDesc: () => LocalizedString + } + 'searchCriteria[pageSize]': { + /** + * Page Size + */ + displayName: () => LocalizedString + /** + * Number of results per page + */ + shortDesc: () => LocalizedString + /** + * Specifies how many items to return in a single result set + */ + longDesc: () => LocalizedString + } + 'searchCriteria[currentPage]': { + /** + * Current Page + */ + displayName: () => LocalizedString + /** + * Page number to return + */ + shortDesc: () => LocalizedString + /** + * Specifies which page of results to return */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - key: { - /** - * Key - */ - displayName: () => LocalizedString - /** - * The key of the parameter - */ - shortDesc: () => LocalizedString - /** - * The key of the parameter - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value of the parameter - */ - shortDesc: () => LocalizedString - /** - * The value of the parameter - */ - longDesc: () => LocalizedString - } - } - } - } } } } - 'execute-agent': { + salesShipmentRepositoryV1GetListGet: { + groups: { + /** + * Shipments + */ + '0': () => LocalizedString + } /** - * Execute Agent + * List Shipments */ displayName: () => LocalizedString /** - * Executes an agent with the given code. + * Retrieve a collection of order shipments */ shortDesc: () => LocalizedString /** - * Executes an agent with the given code. + * Returns a list of shipments based on specified search criteria. Results can be filtered by order ID, customer, creation date, and tracking information. Each shipment includes items shipped, quantities, tracking numbers, and carrier information. */ longDesc: () => LocalizedString options: { - agentCode: { + 'searchCriteria[filterGroups][0][filters][0][field]': { /** - * Agent Code + * Filter Field */ displayName: () => LocalizedString /** - * Used to identify and execute a specific agent within the Serenity* AI Hub + * Field to filter by */ shortDesc: () => LocalizedString /** - * Used to identify and execute a specific agent within the Serenity* AI Hub + * Specifies which product field to apply the filter condition to */ longDesc: () => LocalizedString } - culture: { + 'searchCriteria[filterGroups][0][filters][0][value]': { /** - * Culture + * Filter Value */ displayName: () => LocalizedString /** - * Use this param to override the culture of the response. + * Value to filter with */ shortDesc: () => LocalizedString /** - * Use this param to override the culture of the response. + * The value to match against the specified field */ longDesc: () => LocalizedString } - userLanguage: { + 'searchCriteria[filterGroups][0][filters][0][conditionType]': { /** - * User Language + * Filter Condition */ displayName: () => LocalizedString /** - * The preferred language of the response + * Type of comparison to use */ shortDesc: () => LocalizedString /** - * The preferred language of the response + * Condition type for the filter (eq, neq, like, gt, lt, etc.) */ longDesc: () => LocalizedString } - params: { + 'searchCriteria[sortOrders][0][field]': { /** - * Params + * Sort Field */ displayName: () => LocalizedString /** - * An array of key-value pairs for execution context. + * Field to sort by */ shortDesc: () => LocalizedString /** - * An array of key-value pairs for execution context. + * Specifies which product field to use for sorting the results */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - Key: { - /** - * Key - */ - displayName: () => LocalizedString - /** - * The key of the parameter - */ - shortDesc: () => LocalizedString - /** - * The key of the parameter - */ - longDesc: () => LocalizedString - } - Value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * The value of the parameter - */ - shortDesc: () => LocalizedString - /** - * The value of the parameter - */ - longDesc: () => LocalizedString - } - } - } - } } - volatileKnowledgeIds: { + 'searchCriteria[sortOrders][0][direction]': { /** - * Volatile Knowledge IDs + * Sort Direction */ displayName: () => LocalizedString /** - * Unique identifiers (UUIDs) used to retrieve specific pieces of volatile knowledge in the Serenity* AI Hub + * Direction to sort in */ shortDesc: () => LocalizedString /** - * Unique identifiers (UUIDs) used to retrieve specific pieces of volatile knowledge in the Serenity* AI Hub + * Determines whether to sort in ascending or descending order + */ + longDesc: () => LocalizedString + } + 'searchCriteria[pageSize]': { + /** + * Page Size + */ + displayName: () => LocalizedString + /** + * Number of results per page + */ + shortDesc: () => LocalizedString + /** + * Specifies how many items to return in a single result set + */ + longDesc: () => LocalizedString + } + 'searchCriteria[currentPage]': { + /** + * Current Page + */ + displayName: () => LocalizedString + /** + * Page number to return + */ + shortDesc: () => LocalizedString + /** + * Specifies which page of results to return */ longDesc: () => LocalizedString } } } - 'execute-conversation': { + salesTransactionRepositoryV1GetListGet: { + groups: { + /** + * Payments + */ + '0': () => LocalizedString + } /** - * Execute Conversation + * List Payment Transactions */ displayName: () => LocalizedString /** - * Send a message to a chat with agent + * Retrieve a collection of payment transactions */ shortDesc: () => LocalizedString /** - * Send a message to a chat with agent + * Returns a list of payment transactions based on specified search criteria. Results can be filtered by order ID, payment method, transaction type, and status. Each transaction includes amount, status, and related payment gateway information. */ longDesc: () => LocalizedString options: { - agentCode: { - /** - * Agent Code - */ - displayName: () => LocalizedString - /** - * The agent to check for conversations with - */ - shortDesc: () => LocalizedString - /** - * The agent to check for conversations with - */ - longDesc: () => LocalizedString - } - conversationId: { + 'searchCriteria[filterGroups][0][filters][0][field]': { /** - * Conversation ID + * Filter Field */ displayName: () => LocalizedString /** - * The conversation to send the message to + * Field to filter by */ shortDesc: () => LocalizedString /** - * The conversation to send the message to + * Specifies which product field to apply the filter condition to */ longDesc: () => LocalizedString } - userLanguage: { + 'searchCriteria[filterGroups][0][filters][0][value]': { /** - * User Language + * Filter Value */ displayName: () => LocalizedString /** - * The preferred language of the response + * Value to filter with */ shortDesc: () => LocalizedString /** - * The preferred language of the response + * The value to match against the specified field */ longDesc: () => LocalizedString } - message: { + 'searchCriteria[filterGroups][0][filters][0][conditionType]': { /** - * Message + * Filter Condition */ displayName: () => LocalizedString /** - * Message to send to the agent + * Type of comparison to use */ shortDesc: () => LocalizedString /** - * Message to send to the agent + * Condition type for the filter (eq, neq, like, gt, lt, etc.) */ longDesc: () => LocalizedString } - culture: { + 'searchCriteria[sortOrders][0][field]': { /** - * Culture + * Sort Field */ displayName: () => LocalizedString /** - * Use this param to override the culture of the response. + * Field to sort by */ shortDesc: () => LocalizedString /** - * Use this param to override the culture of the response. + * Specifies which product field to use for sorting the results */ longDesc: () => LocalizedString } - } - } - } - triggers: { - 'new-conversation-message': { - /** - * New Conversation Message - */ - displayName: () => LocalizedString - /** - * Triggered when a new message is posted in a conversation. - */ - shortDesc: () => LocalizedString - /** - * This trigger activates when a new message is posted in a conversation. - */ - longDesc: () => LocalizedString - options: { - conversationId: { + 'searchCriteria[sortOrders][0][direction]': { /** - * Conversation ID + * Sort Direction */ displayName: () => LocalizedString /** - * The unique identifier for the conversation. + * Direction to sort in */ shortDesc: () => LocalizedString /** - * Enter the Conversation ID to specify the conversation where you want to monitor new messages. + * Determines whether to sort in ascending or descending order */ longDesc: () => LocalizedString } - agentCode: { + 'searchCriteria[pageSize]': { /** - * Agent ID + * Page Size */ displayName: () => LocalizedString /** - * The unique identifier for the agent. + * Number of results per page */ shortDesc: () => LocalizedString /** - * Agent ID to check for available conversations from + * Specifies how many items to return in a single result set */ longDesc: () => LocalizedString } - sender: { + 'searchCriteria[currentPage]': { /** - * Sender + * Current Page */ displayName: () => LocalizedString /** - * Filter the messages by the sender. + * Page number to return */ shortDesc: () => LocalizedString /** - * Choose the sender the messages should be filtered by. + * Specifies which page of results to return */ longDesc: () => LocalizedString } } } - } - } - Pipedrive: { - /** - * Pipedrive - */ - displayName: () => LocalizedString - groups: { - /** - * CRM & Sales Management - */ - '0': () => LocalizedString - } - /** - * Manage your sales pipeline and customer relationships with Pipedrive. - */ - shortDesc: () => LocalizedString - /** - * Pipedrive is a sales management tool designed to help small sales teams manage intricate or lengthy sales processes. - */ - longDesc: () => LocalizedString - triggers: { - pipedrive_activity_trigger: { + rmaRmaRepositoryV1DeleteDelete: { + groups: { + /** + * Returns & RMAs + */ + '0': () => LocalizedString + } /** - * Activity Action + * Delete Return Request */ displayName: () => LocalizedString /** - * Triggers when an action is performed on an activity + * Remove a Return Merchandise Authorization (RMA) */ shortDesc: () => LocalizedString /** - * This trigger activates when a selected action is performed on an activity in Pipedrive. Actions include creating, updating, deleting an activity or any change. + * Permanently deletes a Return Merchandise Authorization (RMA) request from the system. This operation cannot be undone and removes all associated return information including submitted items, reason codes, and processing history. */ longDesc: () => LocalizedString - options: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Select the action that triggers the flow - */ - shortDesc: () => LocalizedString - /** - * Select the action that triggers the flow. Choose from: create, update, delete, or any change. - */ - longDesc: () => LocalizedString - } - } } - pipedrive_deal_trigger: { + rmaRmaManagementV1SaveRmaPost: { + groups: { + /** + * Returns & RMAs + */ + '0': () => LocalizedString + } /** - * Deal Action + * Create Return Request */ displayName: () => LocalizedString /** - * Triggers when an action is performed on a deal + * Submit a new Return Merchandise Authorization (RMA) */ shortDesc: () => LocalizedString /** - * This trigger activates when a selected action is performed on a deal in Pipedrive. Actions include creating, updating, deleting a deal or any change. + * Creates a new Return Merchandise Authorization (RMA) request for an existing order. The request includes items to be returned, quantities, reason codes, and customer comments. Additional documentation such as images can be attached to support the return request. */ longDesc: () => LocalizedString - options: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Select the action that triggers the flow - */ - shortDesc: () => LocalizedString - /** - * Select the action that triggers the flow. Choose from: create, update, delete, or any change. - */ - longDesc: () => LocalizedString - } + } + rmaRmaManagementV1SearchGet: { + groups: { + /** + * Returns & RMAs + */ + '0': () => LocalizedString } + /** + * Search Return Requests + */ + displayName: () => LocalizedString + /** + * Find Return Merchandise Authorizations (RMAs) + */ + shortDesc: () => LocalizedString + /** + * Searches for Return Merchandise Authorization (RMA) requests based on specified criteria. Results can be filtered by order ID, customer, status, and date range. Each RMA includes return items, processing status, and communication history. + */ + longDesc: () => LocalizedString } - pipedrive_lead_trigger: { + } + triggers: { + 'customer-created-or-updated': { /** - * Lead Action + * Customer Created or Updated */ displayName: () => LocalizedString /** - * Triggers when an action is performed on a lead + * Triggers when a customer is created or updated in Magento */ shortDesc: () => LocalizedString /** - * This trigger activates when a selected action is performed on a lead in Pipedrive. Actions include creating, updating, deleting a lead or any change. + * This trigger activates when a new customer is created in your Magento store or when an existing customer's information is updated. */ longDesc: () => LocalizedString options: { - action: { + activationCriteria: { /** - * Action + * Activation Criteria */ displayName: () => LocalizedString /** - * Select the action that triggers the flow + * Specify when this trigger should activate */ shortDesc: () => LocalizedString /** - * Select the action that triggers the flow. Choose from: create, update, delete, or any change. + * Select whether this trigger should activate on customer creation or on customer updates. */ longDesc: () => LocalizedString } } } - pipedrive_note_trigger: { + 'invoice-created-or-updated': { /** - * Note Action + * Invoice Created or Updated */ displayName: () => LocalizedString /** - * Triggers when an action is performed on a note + * Triggers when an invoice is created or updated in Magento */ shortDesc: () => LocalizedString /** - * This trigger activates when a selected action is performed on a note in Pipedrive. Actions include creating, updating, deleting a note or any change. + * This trigger activates when a new invoice is generated in your Magento store or when an existing invoice is modified. */ longDesc: () => LocalizedString options: { - action: { + activationCriteria: { /** - * Action + * Activation Criteria */ displayName: () => LocalizedString /** - * Select the action that triggers the flow + * Specify when this trigger should activate */ shortDesc: () => LocalizedString /** - * Select the action that triggers the flow. Choose from: create, update, delete, or any change. + * Select whether this trigger should activate on invoice creation or on invoice updates. */ longDesc: () => LocalizedString } } } - pipedrive_organization_trigger: { + 'product-created-or-updated': { /** - * Organization Action + * Product Created or Updated */ displayName: () => LocalizedString /** - * Triggers when an action is performed on an organization + * Triggers when a product is created or updated in Magento */ shortDesc: () => LocalizedString /** - * This trigger activates when a selected action is performed on an organization in Pipedrive. Actions include creating, updating, deleting an organization or any change. + * This trigger activates when a new product is added to your Magento catalog or when an existing product's information is modified. */ longDesc: () => LocalizedString options: { - action: { + activationCriteria: { /** - * Action + * Activation Criteria */ displayName: () => LocalizedString /** - * Select the action that triggers the flow + * Specify when this trigger should activate */ shortDesc: () => LocalizedString /** - * Select the action that triggers the flow. Choose from: create, update, delete, or any change. + * Select whether this trigger should activate on product creation or on product updates. */ longDesc: () => LocalizedString } } } - pipedrive_person_trigger: { + 'order-created': { /** - * Person Action + * Order Created */ displayName: () => LocalizedString /** - * Triggers when an action is performed on a person + * Triggers when a new order is placed in Magento */ shortDesc: () => LocalizedString /** - * This trigger activates when a selected action is performed on a person in Pipedrive. Actions include creating, updating, deleting a person or any change. + * This trigger activates when a customer completes the checkout process and places a new order in your Magento store. */ longDesc: () => LocalizedString - options: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Select the action that triggers the flow - */ - shortDesc: () => LocalizedString - /** - * Select the action that triggers the flow. Choose from: create, update, delete, or any change. - */ - longDesc: () => LocalizedString - } - } } - pipedrive_user_trigger: { + 'shipment-created': { /** - * User Action + * Shipment Created */ displayName: () => LocalizedString /** - * Triggers when an action is performed on a user + * Triggers when a new shipment is created in Magento */ shortDesc: () => LocalizedString /** - * This trigger activates when a selected action is performed on a user in Pipedrive. Actions include creating, updating, deleting a user or any change. + * This trigger activates when a new shipment is created for an order in your Magento store, indicating that products have been shipped to the customer. */ longDesc: () => LocalizedString - options: { - action: { - /** - * Action - */ - displayName: () => LocalizedString - /** - * Select the action that triggers the flow - */ - shortDesc: () => LocalizedString - /** - * Select the action that triggers the flow. Choose from: create, update, delete, or any change. - */ - longDesc: () => LocalizedString - } - } } } - expressions: { - '&&': { + } + Shopify: { + /** + * Shopify + */ + displayName: () => LocalizedString + groups: { + /** + * E-commerce Platforms + */ + '0': () => LocalizedString + } + /** + * E-commerce platform for online stores and retail point of sale + */ + shortDesc: () => LocalizedString + /** + * Shopify is a comprehensive commerce platform that allows businesses to start, grow, and manage an online store, sell in multiple places, and synchronize online and in-person sales. + */ + longDesc: () => LocalizedString + actions: { + 'find-product': { /** - * and (&&) + * Find Products */ displayName: () => LocalizedString /** - * Returns True if all arguments are True + * Search for products in your store */ shortDesc: () => LocalizedString /** - * Returns `True` if all arguments are `True` with logic short-circuiting + * Search and filter products in your Shopify store based on various criteria including title, vendor, product type, and more. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + titleQuery: { /** - * Condition + * Title */ displayName: () => LocalizedString /** - * Boolean condition to evaluate + * Search by product title */ shortDesc: () => LocalizedString /** - * A boolean expression or condition that evaluates to True or False + * Filter products by matching text in their titles. Supports partial matches. */ longDesc: () => LocalizedString } - } - } - '||': { - /** - * or (||) - */ - displayName: () => LocalizedString - /** - * Returns True if any argument is True - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if any argument is `True` with logic short-circuiting - */ - longDesc: () => LocalizedString - args: { - '0': { + vendorQuery: { /** - * Condition + * Vendor */ displayName: () => LocalizedString /** - * Boolean condition to evaluate + * Filter by product vendor */ shortDesc: () => LocalizedString /** - * A boolean expression or condition that evaluates to True or False + * Find products from specific vendors or suppliers in your store. */ longDesc: () => LocalizedString } - } - } - '==': { - /** - * equal (==) - */ - displayName: () => LocalizedString - /** - * Equality comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value equals the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + productTypeQuery: { /** - * Field + * Product Type */ displayName: () => LocalizedString /** - * Field to compare + * Filter by product type */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Search for products based on their assigned product type category. */ longDesc: () => LocalizedString } - '1': { + tagQuery: { /** - * Value + * Tags */ displayName: () => LocalizedString /** - * Value to compare against + * Search by product tags */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Find products that have been tagged with specific keywords or labels. */ longDesc: () => LocalizedString } - } - } - '!=': { - /** - * not equal (!=) - */ - displayName: () => LocalizedString - /** - * Inequality comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value does not equal the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + skuQuery: { /** - * Field + * SKU */ displayName: () => LocalizedString /** - * Field to compare + * Search by product SKU */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Look up products using their Stock Keeping Unit (SKU) identifier. */ longDesc: () => LocalizedString } - '1': { + barcodeQuery: { /** - * Value + * Barcode */ displayName: () => LocalizedString /** - * Value to compare against + * Search by barcode */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Find products using their UPC, ISBN, or other barcode identifiers. */ longDesc: () => LocalizedString } - } - } - '>': { - /** - * greater than (>) - */ - displayName: () => LocalizedString - /** - * Greater than comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is greater than the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + productIdQuery: { /** - * Field + * Product ID */ displayName: () => LocalizedString /** - * Field to compare + * Search by product ID */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Look up a specific product using its unique Shopify product ID. */ longDesc: () => LocalizedString } - '1': { + collectionIdQuery: { /** - * Value + * Collection */ displayName: () => LocalizedString /** - * Value to compare against + * Filter by collection ID */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Find products that belong to a specific collection in your store. */ longDesc: () => LocalizedString } - } - } - '>=': { - /** - * greater than or equal (>=) - */ - displayName: () => LocalizedString - /** - * Greater than or equal comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is greater than or equal to the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + sortKey: { + /** + * Sort By + */ + displayName: () => LocalizedString + /** + * Sort the results + */ + shortDesc: () => LocalizedString + /** + * Choose how to order the results (e.g., by title, price, created date). + */ + longDesc: () => LocalizedString + } + reverse: { /** - * Field + * Reverse Order */ displayName: () => LocalizedString /** - * Field to compare + * Reverse the sort order */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Toggle between ascending and descending sort order for the results. */ longDesc: () => LocalizedString } - '1': { + rawQuery: { /** - * Value + * Advanced Query */ displayName: () => LocalizedString /** - * Value to compare against + * Use custom search syntax */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Enter a custom search query for advanced filtering using Shopify search syntax. */ longDesc: () => LocalizedString } - } - } - '<': { - /** - * less than (<) - */ - displayName: () => LocalizedString - /** - * Less than comparison - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value is less than the specified value - */ - longDesc: () => LocalizedString - args: { - '0': { + limit: { /** - * Field + * Results Limit */ displayName: () => LocalizedString /** - * Field to compare + * Maximum number of results */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Specify the maximum number of products to return in the search results. */ longDesc: () => LocalizedString } - '1': { + cursor: { /** - * Value + * Pagination Cursor */ displayName: () => LocalizedString /** - * Value to compare against + * Navigate through pages of results */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Use a cursor to paginate through large sets of search results. */ longDesc: () => LocalizedString } } } - '<=': { + 'find-order': { /** - * less than or equal (<=) + * Find Orders */ displayName: () => LocalizedString /** - * Less than or equal comparison + * Search for customer orders */ shortDesc: () => LocalizedString /** - * Returns `True` if the field value is less than or equal to the specified value + * Search and filter orders in your Shopify store based on various criteria including customer name, email, order number, and more. */ longDesc: () => LocalizedString - args: { - '0': { + options: { + name: { /** - * Field + * Order Number */ displayName: () => LocalizedString /** - * Field to compare + * Search by order number */ shortDesc: () => LocalizedString /** - * The field whose value will be compared + * Look up orders using their confirmation or order number. */ longDesc: () => LocalizedString } - '1': { + email: { /** - * Value + * Email */ displayName: () => LocalizedString /** - * Value to compare against + * Search by customer email */ shortDesc: () => LocalizedString /** - * The value to compare the field against + * Find orders associated with a specific customer email address. */ longDesc: () => LocalizedString } - } - } - like: { - /** - * like - */ - displayName: () => LocalizedString - /** - * Pattern matching - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field value matches the specified pattern - */ - longDesc: () => LocalizedString - args: { - '0': { + customer_id: { /** - * Field + * Customer ID */ displayName: () => LocalizedString /** - * Text field to search + * Filter by customer ID */ shortDesc: () => LocalizedString /** - * The text field to perform pattern matching on + * Find all orders placed by a specific customer using their Shopify customer ID. */ longDesc: () => LocalizedString } - '1': { + confirmation_number: { /** - * Pattern + * Confirmation Number */ displayName: () => LocalizedString /** - * Pattern to match + * Search by confirmation number */ shortDesc: () => LocalizedString /** - * The pattern to match against the field value + * Find orders by their unique confirmation number provided to customers. */ longDesc: () => LocalizedString } - } - } - 'is-null': { - /** - * is null - */ - displayName: () => LocalizedString - /** - * Field is null - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field is null or has no value - */ - longDesc: () => LocalizedString - args: { - '0': { + id: { /** - * Field + * Order ID */ displayName: () => LocalizedString /** - * Field to check + * Search by order ID */ shortDesc: () => LocalizedString /** - * The field to check for null value + * Look up a specific order using its unique Shopify order ID. */ longDesc: () => LocalizedString } - } - } - 'is-not-null': { - /** - * is not null - */ - displayName: () => LocalizedString - /** - * Field is not null - */ - shortDesc: () => LocalizedString - /** - * Returns `True` if the field has a value and is not null - */ - longDesc: () => LocalizedString - args: { - '0': { + financial_status: { /** - * Field + * Payment Status */ displayName: () => LocalizedString /** - * Field to check + * Filter by payment status */ shortDesc: () => LocalizedString /** - * The field to check for a non-null value + * Find orders with a specific payment status (paid, pending, refunded, etc.). */ longDesc: () => LocalizedString } - } - } - } - searchOptions: { - orderBy: { - /** - * Order By - */ - displayName: () => LocalizedString - /** - * Sort results by a specific field - */ - shortDesc: () => LocalizedString - /** - * Define the field and direction to sort search results - */ - longDesc: () => LocalizedString - type: { - fields: { - column: { - /** - * Column - */ - displayName: () => LocalizedString - /** - * The column to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the column to use for sorting results - */ - longDesc: () => LocalizedString - } - ascending: { - /** - * Ascending - */ - displayName: () => LocalizedString - /** - * Sort in ascending order - */ - shortDesc: () => LocalizedString - /** - * When enabled, results are sorted in ascending order (A-Z, 0-9) - */ - longDesc: () => LocalizedString - } + fulfillment_status: { + /** + * Fulfillment Status + */ + displayName: () => LocalizedString + /** + * Filter by shipping status + */ + shortDesc: () => LocalizedString + /** + * Find orders with a specific fulfillment status (fulfilled, unfulfilled, shipped, etc.). + */ + longDesc: () => LocalizedString } - } - } - } - } - Magento: { - /** - * Magento - */ - displayName: () => LocalizedString - groups: { - /** - * E-commerce Platforms - */ - '0': () => LocalizedString - } - /** - * E-commerce platform for building online stores and managing customers, products, and orders - */ - shortDesc: () => LocalizedString - /** - * Magento is a flexible e-commerce platform that provides businesses with a complete solution for building and managing online stores. This integration allows you to automate workflows when customer, product, order, invoice, or shipment events occur in your Magento store. - */ - longDesc: () => LocalizedString - connectionMessage: { - /** - * Connect to Magento - */ - title: () => LocalizedString - /** - * To connect to Magento, you will need your **Store URL** and an **Integration Access Token**. - - ## Creating an Integration Token - - 1. Log in to your Magento Admin Panel - 2. Navigate to **System** → **Integrations** - 3. Click **Add New Integration** - 4. Fill in the integration details: - - **Name**: Give it a descriptive name (e.g., "Qore Integration") - - **Email**: Your admin email - - **Callback URL** and **Identity Link URL**: Can be left empty for token-based access - 5. Go to the **API** tab - 6. Select the **Resource Access** level: - - Choose **All** for full access, or - - Choose **Custom** and select specific resources needed - 7. Click **Save** - 8. Click **Activate** on the integration - 9. Click **Allow** in the confirmation popup - 10. Copy the **Access Token** from the displayed credentials - - ## Connection Details - - ### Store URL - Your Magento store's base URL (e.g., `https://your-store.com`). Include the protocol (https://) but do not include trailing slashes. - - ### Access Token - The integration access token generated when you activated the integration. This token authenticates all API requests. - - ## For Magento 2.4.4 and Later - - If you're using Magento 2.4.4+, you may need to enable bearer token authentication: - - ```bash - bin/magento config:set oauth/consumer/enable_integration_as_bearer 1 - ``` - - **Note:** Integration tokens do not expire unless manually revoked. Store your access token securely and limit the integration's API access to only the resources needed for your use case. - */ - content: () => LocalizedString - } - actions: { - customerCustomerRepositoryV1GetByIdGet: { - groups: { - /** - * Customers - */ - '0': () => LocalizedString - } - /** - * Get Customer by ID - */ - displayName: () => LocalizedString - /** - * Retrieve a specific customer account by ID - */ - shortDesc: () => LocalizedString - /** - * Retrieves detailed information about a customer account using the customer ID. Returns all customer attributes including address information, account status, and custom attributes. - */ - longDesc: () => LocalizedString - } - customerCustomerRepositoryV1SavePut: { - groups: { - /** - * Customers - */ - '0': () => LocalizedString - } - /** - * Update Customer - */ - displayName: () => LocalizedString - /** - * Update an existing customer account - */ - shortDesc: () => LocalizedString - /** - * Updates customer information for an existing account. This endpoint allows modification of personal information, addresses, custom attributes, and other account details. The customer ID must be included in the request. - */ - longDesc: () => LocalizedString - } - customerCustomerRepositoryV1DeleteByIdDelete: { - groups: { - /** - * Customers - */ - '0': () => LocalizedString - } - /** - * Delete Customer - */ - displayName: () => LocalizedString - /** - * Remove a customer account by ID - */ - shortDesc: () => LocalizedString - /** - * Permanently deletes a customer account from the system. This operation cannot be undone and will remove all customer data associated with the specified ID, including addresses and order history references. - */ - longDesc: () => LocalizedString - } - customerCustomerRepositoryV1GetListGet: { - groups: { - /** - * Customers - */ - '0': () => LocalizedString - } - /** - * List Customers - */ - displayName: () => LocalizedString - /** - * Retrieve a list of customer accounts - */ - shortDesc: () => LocalizedString - /** - * Returns a list of customer accounts that match specified search criteria. Results can be filtered, sorted, and paginated. Use search criteria parameters to narrow results by email, name, creation date, or other customer attributes. - */ - longDesc: () => LocalizedString - options: { - 'searchCriteria[filterGroups][0][filters][0][field]': { + status: { /** - * Filter Field + * Order Status */ displayName: () => LocalizedString /** - * Field to filter by + * Filter by order status */ shortDesc: () => LocalizedString /** - * Specifies which product field to apply the filter condition to + * Find orders based on their overall status (open, closed, cancelled). */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][value]': { + source_name: { /** - * Filter Value + * Source */ displayName: () => LocalizedString /** - * Value to filter with + * Filter by order source */ shortDesc: () => LocalizedString /** - * The value to match against the specified field + * Find orders from specific sources (e.g., web, draft orders, POS). */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][conditionType]': { + sales_channel: { /** - * Filter Condition + * Sales Channel */ displayName: () => LocalizedString /** - * Type of comparison to use + * Filter by sales channel */ shortDesc: () => LocalizedString /** - * Condition type for the filter (eq, neq, like, gt, lt, etc.) + * Find orders from specific sales channels configured in your Shopify store. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][field]': { + sku: { /** - * Sort Field + * Product SKU */ displayName: () => LocalizedString /** - * Field to sort by + * Search by product SKU */ shortDesc: () => LocalizedString /** - * Specifies which product field to use for sorting the results + * Find orders containing products with a specific SKU. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][direction]': { + created_at: { /** - * Sort Direction + * Created Date */ displayName: () => LocalizedString /** - * Direction to sort in + * Filter by creation date */ shortDesc: () => LocalizedString /** - * Determines whether to sort in ascending or descending order + * Find orders created on a specific date or within a date range (e.g., 2021-01-01, LocalizedString } - 'searchCriteria[pageSize]': { + updated_at: { /** - * Page Size + * Updated Date */ displayName: () => LocalizedString /** - * Number of results per page + * Filter by last update date */ shortDesc: () => LocalizedString /** - * Specifies how many items to return in a single result set + * Find orders last updated on a specific date or within a date range. */ longDesc: () => LocalizedString } - 'searchCriteria[currentPage]': { + processed_at: { /** - * Current Page + * Processed Date */ displayName: () => LocalizedString /** - * Page number to return + * Filter by processed date */ shortDesc: () => LocalizedString /** - * Specifies which page of results to return + * Find orders processed on a specific date or within a date range. */ longDesc: () => LocalizedString } - } - } - customerAccountManagementV1CreateAccountPost: { - groups: { - /** - * Customers - */ - '0': () => LocalizedString - } - /** - * Create Customer Account - */ - displayName: () => LocalizedString - /** - * Register a new customer account - */ - shortDesc: () => LocalizedString - /** - * Creates a new customer account with the provided information. Required fields include email, password, and first/last name. Optional details include addresses, date of birth, and custom attributes. Returns the newly created customer ID upon success. - */ - longDesc: () => LocalizedString - } - catalogProductRepositoryV1SavePost: { - groups: { - /** - * Products - */ - '0': () => LocalizedString - } - /** - * Create Product - */ - displayName: () => LocalizedString - /** - * Add a new product to the catalog - */ - shortDesc: () => LocalizedString - /** - * Creates a new product in the catalog with specified attributes, pricing, and inventory information. Products can be simple, configurable, bundled, grouped, virtual, or downloadable. Media gallery entries, tier prices, and custom options can also be defined. - */ - longDesc: () => LocalizedString - } - catalogProductRepositoryV1GetListGet: { - groups: { - /** - * Products - */ - '0': () => LocalizedString - } - /** - * List Products - */ - displayName: () => LocalizedString - /** - * Retrieve a list of products from the catalog - */ - shortDesc: () => LocalizedString - /** - * Returns a collection of products that match the specified search criteria. Results can be filtered by attributes like name, SKU, price, and status. Supports pagination, sorting, and inclusion of custom attributes in the response. - */ - longDesc: () => LocalizedString - options: { - 'searchCriteria[filterGroups][0][filters][0][field]': { + tag: { /** - * Filter Field + * Tag */ displayName: () => LocalizedString /** - * Field to filter by + * Filter by order tag */ shortDesc: () => LocalizedString /** - * Specifies which product field to apply the filter condition to + * Find orders that have been tagged with specific labels in Shopify. */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][value]': { + test: { /** - * Filter Value + * Test Orders */ displayName: () => LocalizedString /** - * Value to filter with + * Include/exclude test orders */ shortDesc: () => LocalizedString /** - * The value to match against the specified field + * Filter to show only test orders (true) or exclude test orders (false). */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][conditionType]': { + location_id: { /** - * Filter Condition + * Location */ displayName: () => LocalizedString /** - * Type of comparison to use + * Filter by store location */ shortDesc: () => LocalizedString /** - * Condition type for the filter (eq, neq, like, gt, lt, etc.) + * Find orders associated with a specific store location or fulfillment center. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][field]': { + po_number: { /** - * Sort Field + * Purchase Order Number */ displayName: () => LocalizedString /** - * Field to sort by + * Search by PO number */ shortDesc: () => LocalizedString /** - * Specifies which product field to use for sorting the results + * Find orders associated with a specific purchase order number. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][direction]': { + rawQuery: { /** - * Sort Direction + * Advanced Query */ displayName: () => LocalizedString /** - * Direction to sort in + * Use custom search syntax */ shortDesc: () => LocalizedString /** - * Determines whether to sort in ascending or descending order + * Enter a custom search query for advanced filtering using Shopify search syntax. */ longDesc: () => LocalizedString } - 'searchCriteria[pageSize]': { + sortKey: { /** - * Page Size + * Sort By */ displayName: () => LocalizedString /** - * Number of results per page + * Sort the results */ shortDesc: () => LocalizedString /** - * Specifies how many items to return in a single result set + * Choose how to order the results (e.g., by date, order number, total value). */ longDesc: () => LocalizedString } - 'searchCriteria[currentPage]': { + reverse: { /** - * Current Page + * Reverse Order */ displayName: () => LocalizedString /** - * Page number to return + * Reverse the sort order */ shortDesc: () => LocalizedString /** - * Specifies which page of results to return + * Toggle between ascending and descending sort order for the results. */ longDesc: () => LocalizedString } - } - } - catalogProductRepositoryV1SavePut: { - groups: { - /** - * Products - */ - '0': () => LocalizedString - } - /** - * Update Product - */ - displayName: () => LocalizedString - /** - * Modify an existing product - */ - shortDesc: () => LocalizedString - /** - * Updates an existing product in the catalog. Can modify any product attribute including name, price, description, images, inventory, and category assignments. The product SKU or ID must be specified in the request. - */ - longDesc: () => LocalizedString - options: { - sku: { + limit: { /** - * Product SKU + * Results Limit */ displayName: () => LocalizedString /** - * Stock Keeping Unit identifier for the product + * Maximum number of results */ shortDesc: () => LocalizedString /** - * A unique alphanumeric identifier assigned to a product for inventory tracking and management purposes. The SKU helps in identifying specific product variations including size, color, and other attributes. + * Specify the maximum number of orders to return in the search results (max: 250). */ longDesc: () => LocalizedString } - } - } - catalogProductRepositoryV1DeleteByIdDelete: { - groups: { - /** - * Products - */ - '0': () => LocalizedString - } - /** - * Delete Product - */ - displayName: () => LocalizedString - /** - * Remove a product from the catalog - */ - shortDesc: () => LocalizedString - /** - * Permanently removes a product from the catalog by ID or SKU. This operation cannot be undone and may affect existing orders and carts that reference the deleted product. - */ - longDesc: () => LocalizedString - options: { - sku: { + cursor: { /** - * Product SKU + * Pagination Cursor */ displayName: () => LocalizedString /** - * Stock Keeping Unit identifier for the product + * Navigate through pages of results */ shortDesc: () => LocalizedString /** - * A unique alphanumeric identifier assigned to a product for inventory tracking and management purposes. The SKU helps in identifying specific product variations including size, color, and other attributes. + * Use a cursor to paginate through large sets of search results. */ longDesc: () => LocalizedString } } } - catalogProductRepositoryV1GetGet: { - groups: { - /** - * Products - */ - '0': () => LocalizedString - } + 'find-customer': { /** - * Get Product Details + * Find Customers */ displayName: () => LocalizedString /** - * Retrieve detailed information about a specific product + * Search for customers */ shortDesc: () => LocalizedString /** - * Retrieves comprehensive information about a specific product by SKU or ID. The response includes all product attributes, images, pricing information, inventory status, and category assignments. Additional parameters can control which data is included. + * Search and filter customers in your Shopify store based on names, emails, or other attributes. */ longDesc: () => LocalizedString options: { - sku: { + query: { /** - * Product SKU + * Search Query */ displayName: () => LocalizedString /** - * Stock Keeping Unit identifier for the product + * Search by name or email */ shortDesc: () => LocalizedString /** - * A unique alphanumeric identifier assigned to a product for inventory tracking and management purposes. The SKU helps in identifying specific product variations including size, color, and other attributes. + * Search for customers by their name, email, or other identifying information. */ longDesc: () => LocalizedString } - } - } - quoteCartRepositoryV1GetListGet: { - groups: { - /** - * Shopping Carts - */ - '0': () => LocalizedString - } - /** - * List Shopping Carts - */ - displayName: () => LocalizedString - /** - * Retrieve a list of active shopping carts - */ - shortDesc: () => LocalizedString - /** - * Returns a collection of active shopping carts that match the specified search criteria. Results can be filtered by customer ID, creation date, and cart status. Each cart includes items, applied coupons, and shipping/billing information if available. - */ - longDesc: () => LocalizedString - options: { - 'searchCriteria[filterGroups][0][filters][0][field]': { + limit: { /** - * Filter Field + * Results Limit */ displayName: () => LocalizedString /** - * Field to filter by + * Maximum number of results */ shortDesc: () => LocalizedString /** - * Specifies which product field to apply the filter condition to + * Specify the maximum number of customers to return in the search results. */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][value]': { + cursor: { /** - * Filter Value + * Pagination Cursor */ displayName: () => LocalizedString /** - * Value to filter with + * Navigate through pages of results */ shortDesc: () => LocalizedString /** - * The value to match against the specified field + * Use a cursor to paginate through large sets of search results. */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][conditionType]': { + sortKey: { /** - * Filter Condition + * Sort By */ displayName: () => LocalizedString /** - * Type of comparison to use + * Sort the results */ shortDesc: () => LocalizedString /** - * Condition type for the filter (eq, neq, like, gt, lt, etc.) + * Choose how to order the results (e.g., by name, date created, total spent). */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][field]': { + reverse: { /** - * Sort Field + * Reverse Order */ displayName: () => LocalizedString /** - * Field to sort by + * Reverse the sort order */ shortDesc: () => LocalizedString /** - * Specifies which product field to use for sorting the results + * Toggle between ascending and descending sort order for the results. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][direction]': { + } + } + 'find-variant': { + /** + * Find Product Variants + */ + displayName: () => LocalizedString + /** + * Search for specific product variants + */ + shortDesc: () => LocalizedString + /** + * Search and filter product variants in your Shopify store based on criteria like SKU, barcode, price, or inventory status. + */ + longDesc: () => LocalizedString + options: { + productId: { /** - * Sort Direction + * Product ID */ displayName: () => LocalizedString /** - * Direction to sort in + * Filter by parent product */ shortDesc: () => LocalizedString /** - * Determines whether to sort in ascending or descending order + * Find variants that belong to a specific parent product using its Shopify product ID. */ longDesc: () => LocalizedString } - 'searchCriteria[pageSize]': { + title: { /** - * Page Size + * Variant Title */ displayName: () => LocalizedString /** - * Number of results per page + * Search by variant title */ shortDesc: () => LocalizedString /** - * Specifies how many items to return in a single result set + * Filter variants by matching text in their titles or option values. */ longDesc: () => LocalizedString } - 'searchCriteria[currentPage]': { + sku: { /** - * Current Page + * SKU */ displayName: () => LocalizedString /** - * Page number to return + * Search by variant SKU */ shortDesc: () => LocalizedString /** - * Specifies which page of results to return + * Look up variants using their Stock Keeping Unit (SKU) identifier. */ longDesc: () => LocalizedString } - } - } - salesOrderRepositoryV1GetGet: { - groups: { - /** - * Orders - */ - '0': () => LocalizedString - } - /** - * Get Order Details - */ - displayName: () => LocalizedString - /** - * Retrieve detailed information about a specific order - */ - shortDesc: () => LocalizedString - /** - * Retrieves comprehensive information about a specific order by ID. Includes order items, billing and shipping addresses, payment information, applied discounts, and order status history. Useful for order processing and customer service inquiries. - */ - longDesc: () => LocalizedString - } - salesOrderRepositoryV1GetListGet: { - groups: { - /** - * Orders - */ - '0': () => LocalizedString - } - /** - * List Orders - */ - displayName: () => LocalizedString - /** - * Retrieve a list of orders based on search criteria - */ - shortDesc: () => LocalizedString - /** - * Returns a collection of orders that match the specified search criteria. Results can be filtered by customer, status, date range, and total amount. Supports pagination and sorting to efficiently browse large order volumes. - */ - longDesc: () => LocalizedString - options: { - 'searchCriteria[filterGroups][0][filters][0][field]': { + barcode: { /** - * Filter Field + * Barcode */ displayName: () => LocalizedString /** - * Field to filter by + * Search by barcode */ shortDesc: () => LocalizedString /** - * Specifies which product field to apply the filter condition to + * Find variants using their UPC, ISBN, or other barcode identifiers. */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][value]': { + id: { /** - * Filter Value + * Variant ID */ displayName: () => LocalizedString /** - * Value to filter with + * Search by variant ID */ shortDesc: () => LocalizedString /** - * The value to match against the specified field + * Look up a specific variant using its unique Shopify variant ID. */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][conditionType]': { + inventoryQuantity: { /** - * Filter Condition + * Inventory Quantity */ displayName: () => LocalizedString /** - * Type of comparison to use + * Filter by inventory quantity */ shortDesc: () => LocalizedString /** - * Condition type for the filter (eq, neq, like, gt, lt, etc.) + * Find variants based on their exact inventory quantity or range (e.g., "inventory_quantity:10" or "inventory_quantity:>5"). */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][field]': { + productStatus: { /** - * Sort Field + * Product Status */ displayName: () => LocalizedString /** - * Field to sort by + * Filter by product status */ shortDesc: () => LocalizedString /** - * Specifies which product field to use for sorting the results + * Find variants based on whether their parent product is active, draft, or archived. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][direction]': { + productType: { /** - * Sort Direction + * Product Type */ displayName: () => LocalizedString /** - * Direction to sort in + * Filter by product type */ shortDesc: () => LocalizedString /** - * Determines whether to sort in ascending or descending order + * Find variants belonging to products of a specific type or category. */ longDesc: () => LocalizedString } - 'searchCriteria[pageSize]': { + tag: { /** - * Page Size + * Product Tag */ displayName: () => LocalizedString /** - * Number of results per page + * Filter by product tag */ shortDesc: () => LocalizedString /** - * Specifies how many items to return in a single result set + * Find variants belonging to products that have a specific tag. */ longDesc: () => LocalizedString } - 'searchCriteria[currentPage]': { + tagNot: { /** - * Current Page + * Exclude Tag */ displayName: () => LocalizedString /** - * Page number to return + * Filter out products with tag */ shortDesc: () => LocalizedString /** - * Specifies which page of results to return + * Find variants belonging to products that do not have a specific tag. */ longDesc: () => LocalizedString } - } - } - salesShipmentRepositoryV1SavePost: { - groups: { - /** - * Shipments - */ - '0': () => LocalizedString - } - /** - * Create Shipment - */ - displayName: () => LocalizedString - /** - * Creates a new shipment for an order - */ - shortDesc: () => LocalizedString - /** - * Creates a new shipment record for an existing order, allowing you to document and track the physical sending of order items to the customer. Includes options for specifying tracking numbers, shipping carriers, and shipped items with their quantities. - */ - longDesc: () => LocalizedString - } - salesInvoiceRepositoryV1SavePost: { - groups: { - /** - * Invoices - */ - '0': () => LocalizedString - } - /** - * Create Invoice - */ - displayName: () => LocalizedString - /** - * Creates a new invoice for an order - */ - shortDesc: () => LocalizedString - /** - * Creates a new invoice record for an existing order, documenting the financial transaction and payment request. Allows for specifying line items to be invoiced, payment details, and comments that will appear on the customer's invoice. - */ - longDesc: () => LocalizedString - } - salesOrderRepositoryV1SavePut: { - groups: { - /** - * Orders - */ - '0': () => LocalizedString - } - /** - * Create Order - */ - displayName: () => LocalizedString - /** - * Persists order information to the system - */ - shortDesc: () => LocalizedString - /** - * Performs persist operations for a specified order. Saves the order data to the database, including customer information, line items, payment details, shipping information, and other relevant order metadata. - */ - longDesc: () => LocalizedString - } - salesOrderManagementV1AddCommentPost: { - groups: { - /** - * Orders - */ - '0': () => LocalizedString - } - /** - * Add Order Comment - */ - displayName: () => LocalizedString - /** - * Append a comment to an existing order - */ - shortDesc: () => LocalizedString - /** - * Adds a comment to the order history. Comments can be internal (visible only to administrators) or customer-visible. Each comment is timestamped and attributed to the author. Useful for documenting order processing steps and customer communications. - */ - longDesc: () => LocalizedString - options: { - id: { + vendor: { /** - * Order ID + * Vendor */ displayName: () => LocalizedString /** - * The ID of the order to which the comment will be added + * Filter by vendor or supplier */ shortDesc: () => LocalizedString /** - * The ID of the order to which the comment will be added + * Find variants belonging to products from a specific vendor or supplier. */ longDesc: () => LocalizedString } - } - } - salesOrderManagementV1GetCommentsListGet: { - groups: { - /** - * Orders - */ - '0': () => LocalizedString - } - /** - * Get Order Comments - */ - displayName: () => LocalizedString - /** - * Retrieve the comment history for an order - */ - shortDesc: () => LocalizedString - /** - * Returns the complete comment history for a specific order. Results include comment text, timestamp, author information, and visibility status (customer-visible or admin-only). Comments are returned in chronological order. - */ - longDesc: () => LocalizedString - } - salesInvoiceRepositoryV1GetListGet: { - groups: { - /** - * Invoices - */ - '0': () => LocalizedString - } - /** - * List Invoices - */ - displayName: () => LocalizedString - /** - * Retrieve a collection of invoices - */ - shortDesc: () => LocalizedString - /** - * Returns a list of invoices based on specified search criteria. Results can be filtered by order ID, customer, date, and amount. Each invoice includes line items, payment information, and related order details. Supports pagination and sorting. - */ - longDesc: () => LocalizedString - options: { - 'searchCriteria[filterGroups][0][filters][0][field]': { + collection: { /** - * Filter Field + * Collection */ displayName: () => LocalizedString /** - * Field to filter by + * Filter by collection */ shortDesc: () => LocalizedString /** - * Specifies which product field to apply the filter condition to + * Find variants belonging to products in a specific collection using the collection ID. */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][value]': { + option1: { /** - * Filter Value + * Option 1 */ displayName: () => LocalizedString /** - * Value to filter with + * Filter by first option */ shortDesc: () => LocalizedString /** - * The value to match against the specified field + * Find variants with a specific value for their first option (e.g., Size, Color). */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][conditionType]': { + option2: { /** - * Filter Condition + * Option 2 */ displayName: () => LocalizedString /** - * Type of comparison to use + * Filter by second option */ shortDesc: () => LocalizedString /** - * Condition type for the filter (eq, neq, like, gt, lt, etc.) + * Find variants with a specific value for their second option. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][field]': { + option3: { /** - * Sort Field + * Option 3 */ displayName: () => LocalizedString /** - * Field to sort by + * Filter by third option */ shortDesc: () => LocalizedString /** - * Specifies which product field to use for sorting the results + * Find variants with a specific value for their third option. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][direction]': { + taxable: { /** - * Sort Direction + * Taxable */ displayName: () => LocalizedString /** - * Direction to sort in + * Filter by tax status */ shortDesc: () => LocalizedString /** - * Determines whether to sort in ascending or descending order + * Find variants based on whether they are taxable or non-taxable. */ longDesc: () => LocalizedString } - 'searchCriteria[pageSize]': { + updatedAt: { /** - * Page Size + * Updated At */ displayName: () => LocalizedString /** - * Number of results per page + * Filter by update time */ shortDesc: () => LocalizedString /** - * Specifies how many items to return in a single result set + * Find variants based on when they were last updated (e.g., "updated_at:>2023-01-01" or "updated_at: LocalizedString } - 'searchCriteria[currentPage]': { + rawQuery: { /** - * Current Page + * Advanced Query */ displayName: () => LocalizedString /** - * Page number to return + * Use custom search syntax */ shortDesc: () => LocalizedString /** - * Specifies which page of results to return + * Enter a custom search query for advanced filtering using Shopify search syntax. */ longDesc: () => LocalizedString } - } - } - salesShipmentRepositoryV1GetListGet: { - groups: { - /** - * Shipments - */ - '0': () => LocalizedString - } - /** - * List Shipments - */ - displayName: () => LocalizedString - /** - * Retrieve a collection of order shipments - */ - shortDesc: () => LocalizedString - /** - * Returns a list of shipments based on specified search criteria. Results can be filtered by order ID, customer, creation date, and tracking information. Each shipment includes items shipped, quantities, tracking numbers, and carrier information. - */ - longDesc: () => LocalizedString - options: { - 'searchCriteria[filterGroups][0][filters][0][field]': { + sortKey: { /** - * Filter Field + * Sort By */ displayName: () => LocalizedString /** - * Field to filter by + * Order results by field */ shortDesc: () => LocalizedString /** - * Specifies which product field to apply the filter condition to + * Specify which field to use for sorting the results. */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][value]': { + reverse: { /** - * Filter Value + * Reverse Order */ displayName: () => LocalizedString /** - * Value to filter with + * Reverse the sort order */ shortDesc: () => LocalizedString /** - * The value to match against the specified field + * When enabled, reverses the order of the results (e.g., Z-A instead of A-Z). */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][conditionType]': { + limit: { /** - * Filter Condition + * Results Limit */ displayName: () => LocalizedString /** - * Type of comparison to use + * Maximum number of results */ shortDesc: () => LocalizedString /** - * Condition type for the filter (eq, neq, like, gt, lt, etc.) + * Specify the maximum number of variants to return in the search results (max: 250). */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][field]': { + cursor: { /** - * Sort Field + * Pagination Cursor */ displayName: () => LocalizedString /** - * Field to sort by + * Navigate through pages of results */ shortDesc: () => LocalizedString /** - * Specifies which product field to use for sorting the results + * Use a cursor to paginate through large sets of search results. */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][direction]': { + } + } + 'add-line-item-to-order': { + /** + * Add Line Item to Order + */ + displayName: () => LocalizedString + /** + * Add a new product line to an existing order + */ + shortDesc: () => LocalizedString + /** + * Allows adding a new line item to an existing order, with options for quantity, pricing, and other product details + */ + longDesc: () => LocalizedString + options: { + orderId: { /** - * Sort Direction + * Order ID */ displayName: () => LocalizedString /** - * Direction to sort in + * Unique identifier of the order */ shortDesc: () => LocalizedString /** - * Determines whether to sort in ascending or descending order + * The specific order to which the line item will be added */ longDesc: () => LocalizedString } - 'searchCriteria[pageSize]': { + type: { /** - * Page Size + * Line Item Type */ displayName: () => LocalizedString /** - * Number of results per page + * Type of line item being added */ shortDesc: () => LocalizedString /** - * Specifies how many items to return in a single result set + * Specifies the nature of the line item (e.g., product, shipping, tax) */ longDesc: () => LocalizedString } - 'searchCriteria[currentPage]': { + quantity: { /** - * Current Page + * Quantity */ displayName: () => LocalizedString /** - * Page number to return + * Number of items to add */ shortDesc: () => LocalizedString /** - * Specifies which page of results to return + * The quantity of the specific product being added to the order */ longDesc: () => LocalizedString } - } - } - salesTransactionRepositoryV1GetListGet: { - groups: { - /** - * Payments - */ - '0': () => LocalizedString - } - /** - * List Payment Transactions - */ - displayName: () => LocalizedString - /** - * Retrieve a collection of payment transactions - */ - shortDesc: () => LocalizedString - /** - * Returns a list of payment transactions based on specified search criteria. Results can be filtered by order ID, payment method, transaction type, and status. Each transaction includes amount, status, and related payment gateway information. - */ - longDesc: () => LocalizedString - options: { - 'searchCriteria[filterGroups][0][filters][0][field]': { + locationId: { /** - * Filter Field + * Location ID */ displayName: () => LocalizedString /** - * Field to filter by + * Inventory location */ shortDesc: () => LocalizedString /** - * Specifies which product field to apply the filter condition to + * The specific warehouse or store location where the item is stocked */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][value]': { + reason: { /** - * Filter Value + * Reason */ displayName: () => LocalizedString /** - * Value to filter with + * Reason for adding line item */ shortDesc: () => LocalizedString /** - * The value to match against the specified field + * Explanation for why the line item is being added to the order */ longDesc: () => LocalizedString } - 'searchCriteria[filterGroups][0][filters][0][conditionType]': { + notifyCustomer: { /** - * Filter Condition + * Notify Customer */ displayName: () => LocalizedString /** - * Type of comparison to use + * Send notification about order change */ shortDesc: () => LocalizedString /** - * Condition type for the filter (eq, neq, like, gt, lt, etc.) + * Determines whether the customer should be notified about the line item addition */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][field]': { + variantId: { /** - * Sort Field + * Variant ID */ displayName: () => LocalizedString /** - * Field to sort by + * Specific product variant */ shortDesc: () => LocalizedString /** - * Specifies which product field to use for sorting the results + * Unique identifier for the specific product variant being added */ longDesc: () => LocalizedString } - 'searchCriteria[sortOrders][0][direction]': { + allowDuplicates: { /** - * Sort Direction + * Allow Duplicates */ displayName: () => LocalizedString /** - * Direction to sort in + * Permit duplicate line items */ shortDesc: () => LocalizedString /** - * Determines whether to sort in ascending or descending order + * Whether identical line items can be added multiple times to the order */ longDesc: () => LocalizedString } - 'searchCriteria[pageSize]': { + itemName: { /** - * Page Size + * Item Name */ displayName: () => LocalizedString /** - * Number of results per page + * Name of the product */ shortDesc: () => LocalizedString /** - * Specifies how many items to return in a single result set + * The display name or title of the product being added */ longDesc: () => LocalizedString } - 'searchCriteria[currentPage]': { + price: { /** - * Current Page + * Price */ displayName: () => LocalizedString /** - * Page number to return + * Price of the line item */ shortDesc: () => LocalizedString /** - * Specifies which page of results to return + * The unit price of the product being added to the order */ longDesc: () => LocalizedString } - } - } - rmaRmaRepositoryV1DeleteDelete: { - groups: { - /** - * Returns & RMAs - */ - '0': () => LocalizedString - } - /** - * Delete Return Request - */ - displayName: () => LocalizedString - /** - * Remove a Return Merchandise Authorization (RMA) - */ - shortDesc: () => LocalizedString - /** - * Permanently deletes a Return Merchandise Authorization (RMA) request from the system. This operation cannot be undone and removes all associated return information including submitted items, reason codes, and processing history. - */ - longDesc: () => LocalizedString - } - rmaRmaManagementV1SaveRmaPost: { - groups: { - /** - * Returns & RMAs - */ - '0': () => LocalizedString - } - /** - * Create Return Request - */ - displayName: () => LocalizedString - /** - * Submit a new Return Merchandise Authorization (RMA) - */ - shortDesc: () => LocalizedString - /** - * Creates a new Return Merchandise Authorization (RMA) request for an existing order. The request includes items to be returned, quantities, reason codes, and customer comments. Additional documentation such as images can be attached to support the return request. - */ - longDesc: () => LocalizedString - } - rmaRmaManagementV1SearchGet: { - groups: { - /** - * Returns & RMAs - */ - '0': () => LocalizedString - } - /** - * Search Return Requests - */ - displayName: () => LocalizedString - /** - * Find Return Merchandise Authorizations (RMAs) - */ - shortDesc: () => LocalizedString - /** - * Searches for Return Merchandise Authorization (RMA) requests based on specified criteria. Results can be filtered by order ID, customer, status, and date range. Each RMA includes return items, processing status, and communication history. - */ - longDesc: () => LocalizedString - } - } - triggers: { - 'customer-created-or-updated': { - /** - * Customer Created or Updated - */ - displayName: () => LocalizedString - /** - * Triggers when a customer is created or updated in Magento - */ - shortDesc: () => LocalizedString - /** - * This trigger activates when a new customer is created in your Magento store or when an existing customer's information is updated. - */ - longDesc: () => LocalizedString - options: { - activationCriteria: { + currency: { /** - * Activation Criteria + * Currency */ displayName: () => LocalizedString /** - * Specify when this trigger should activate + * Currency of the price */ shortDesc: () => LocalizedString /** - * Select whether this trigger should activate on customer creation or on customer updates. + * The currency in which the price is specified */ longDesc: () => LocalizedString } - } - } - 'invoice-created-or-updated': { - /** - * Invoice Created or Updated - */ - displayName: () => LocalizedString - /** - * Triggers when an invoice is created or updated in Magento - */ - shortDesc: () => LocalizedString - /** - * This trigger activates when a new invoice is generated in your Magento store or when an existing invoice is modified. - */ - longDesc: () => LocalizedString - options: { - activationCriteria: { + isTaxable: { /** - * Activation Criteria + * Is Taxable */ displayName: () => LocalizedString /** - * Specify when this trigger should activate + * Whether item is subject to tax */ shortDesc: () => LocalizedString /** - * Select whether this trigger should activate on invoice creation or on invoice updates. + * Indicates if the line item should have tax applied */ longDesc: () => LocalizedString } - } - } - 'product-created-or-updated': { - /** - * Product Created or Updated - */ - displayName: () => LocalizedString - /** - * Triggers when a product is created or updated in Magento - */ - shortDesc: () => LocalizedString - /** - * This trigger activates when a new product is added to your Magento catalog or when an existing product's information is modified. - */ - longDesc: () => LocalizedString - options: { - activationCriteria: { + isPhysical: { /** - * Activation Criteria + * Is Physical */ displayName: () => LocalizedString /** - * Specify when this trigger should activate + * Physical vs digital product */ shortDesc: () => LocalizedString /** - * Select whether this trigger should activate on product creation or on product updates. + * Specifies whether the item is a physical product requiring shipping */ longDesc: () => LocalizedString } } } - 'order-created': { - /** - * Order Created - */ - displayName: () => LocalizedString - /** - * Triggers when a new order is placed in Magento - */ - shortDesc: () => LocalizedString - /** - * This trigger activates when a customer completes the checkout process and places a new order in your Magento store. - */ - longDesc: () => LocalizedString - } - 'shipment-created': { - /** - * Shipment Created - */ - displayName: () => LocalizedString - /** - * Triggers when a new shipment is created in Magento - */ - shortDesc: () => LocalizedString - /** - * This trigger activates when a new shipment is created for an order in your Magento store, indicating that products have been shipped to the customer. - */ - longDesc: () => LocalizedString - } - } - } - Shopify: { - /** - * Shopify - */ - displayName: () => LocalizedString - groups: { - /** - * E-commerce Platforms - */ - '0': () => LocalizedString - } - /** - * E-commerce platform for online stores and retail point of sale - */ - shortDesc: () => LocalizedString - /** - * Shopify is a comprehensive commerce platform that allows businesses to start, grow, and manage an online store, sell in multiple places, and synchronize online and in-person sales. - */ - longDesc: () => LocalizedString - actions: { - 'find-product': { + 'create-gift-card': { /** - * Find Products + * Create Gift Card */ displayName: () => LocalizedString /** - * Search for products in your store + * Generate a new gift card */ shortDesc: () => LocalizedString /** - * Search and filter products in your Shopify store based on various criteria including title, vendor, product type, and more. + * Create a gift card with customizable parameters like initial value, expiration, and recipient details */ longDesc: () => LocalizedString options: { - titleQuery: { + initialValue: { /** - * Title + * Initial Value */ displayName: () => LocalizedString /** - * Search by product title + * Starting balance of gift card */ shortDesc: () => LocalizedString /** - * Filter products by matching text in their titles. Supports partial matches. + * The initial monetary amount loaded onto the gift card */ longDesc: () => LocalizedString } - vendorQuery: { + customerId: { /** - * Vendor + * Customer ID */ displayName: () => LocalizedString /** - * Filter by product vendor + * ID of gift card recipient */ shortDesc: () => LocalizedString /** - * Find products from specific vendors or suppliers in your store. + * The unique identifier of the customer receiving the gift card */ longDesc: () => LocalizedString } - productTypeQuery: { + note: { /** - * Product Type + * Note */ displayName: () => LocalizedString /** - * Filter by product type + * Additional gift card information */ shortDesc: () => LocalizedString /** - * Search for products based on their assigned product type category. + * A personal message or additional details about the gift card */ longDesc: () => LocalizedString } - tagQuery: { + expiresOn: { /** - * Tags + * Expiration Date */ displayName: () => LocalizedString /** - * Search by product tags + * Date when gift card expires */ shortDesc: () => LocalizedString /** - * Find products that have been tagged with specific keywords or labels. + * The date after which the gift card will no longer be valid */ longDesc: () => LocalizedString } - skuQuery: { + code: { /** - * SKU + * Gift Card Code */ displayName: () => LocalizedString /** - * Search by product SKU + * Unique gift card identifier */ shortDesc: () => LocalizedString /** - * Look up products using their Stock Keeping Unit (SKU) identifier. + * The specific code used to redeem the gift card */ longDesc: () => LocalizedString } - barcodeQuery: { + templateSuffix: { /** - * Barcode + * Template Suffix */ displayName: () => LocalizedString /** - * Search by barcode + * Customization of gift card template */ shortDesc: () => LocalizedString /** - * Find products using their UPC, ISBN, or other barcode identifiers. + * Optional suffix to customize the gift card's appearance or template */ longDesc: () => LocalizedString } - productIdQuery: { + recipientAttributes: { /** - * Product ID + * Recipient Attributes */ displayName: () => LocalizedString /** - * Search by product ID + * Details about gift card recipient */ shortDesc: () => LocalizedString /** - * Look up a specific product using its unique Shopify product ID. + * Additional information about the person receiving the gift card */ longDesc: () => LocalizedString + type: { + fields: { + id: { + /** + * Recipient ID + */ + displayName: () => LocalizedString + /** + * Unique identifier for recipient + */ + shortDesc: () => LocalizedString + /** + * A unique identifier for the gift card recipient + */ + longDesc: () => LocalizedString + } + message: { + /** + * Recipient Message + */ + displayName: () => LocalizedString + /** + * Personal message to recipient + */ + shortDesc: () => LocalizedString + /** + * A personalized message to accompany the gift card + */ + longDesc: () => LocalizedString + } + preferredName: { + /** + * Preferred Name + */ + displayName: () => LocalizedString + /** + * Recipient's preferred name + */ + shortDesc: () => LocalizedString + /** + * The name the recipient prefers to be called + */ + longDesc: () => LocalizedString + } + sendNotificationAt: { + /** + * Notification Timing + */ + displayName: () => LocalizedString + /** + * When to send gift card notification + */ + shortDesc: () => LocalizedString + /** + * The specific time or date to send the gift card notification + */ + longDesc: () => LocalizedString + } + } + } } - collectionIdQuery: { + } + } + 'create-fulfillment': { + /** + * Create Fulfillment + */ + displayName: () => LocalizedString + /** + * Process and ship an order + */ + shortDesc: () => LocalizedString + /** + * Create a fulfillment for an order, handling shipping and tracking information + */ + longDesc: () => LocalizedString + options: { + fulfillmentOrderId: { /** - * Collection + * Fulfillment Order ID */ displayName: () => LocalizedString /** - * Filter by collection ID + * Unique fulfillment order identifier */ shortDesc: () => LocalizedString /** - * Find products that belong to a specific collection in your store. + * The specific fulfillment order being processed */ longDesc: () => LocalizedString } - sortKey: { + fulfillmentOrderLineItems: { /** - * Sort By + * Fulfillment Order Line Items */ displayName: () => LocalizedString /** - * Sort the results + * Items in the fulfillment order */ shortDesc: () => LocalizedString /** - * Choose how to order the results (e.g., by title, price, created date). + * Specific line items within the fulfillment order */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + id: { + /** + * Line Item ID + */ + displayName: () => LocalizedString + /** + * Unique identifier for line item + */ + shortDesc: () => LocalizedString + /** + * The specific identifier for an individual line item + */ + longDesc: () => LocalizedString + } + quantity: { + /** + * Quantity + */ + displayName: () => LocalizedString + /** + * Number of items to fulfill + */ + shortDesc: () => LocalizedString + /** + * The quantity of the specific item being fulfilled + */ + longDesc: () => LocalizedString + } + } + } + } } - reverse: { + notifyCustomer: { /** - * Reverse Order + * Notify Customer */ displayName: () => LocalizedString /** - * Reverse the sort order + * Send shipping notification */ shortDesc: () => LocalizedString /** - * Toggle between ascending and descending sort order for the results. + * Determines whether to send a notification to the customer about the fulfillment */ longDesc: () => LocalizedString } - rawQuery: { + trackingInfo: { /** - * Advanced Query + * Tracking Information */ displayName: () => LocalizedString /** - * Use custom search syntax + * Shipping tracking details */ shortDesc: () => LocalizedString /** - * Enter a custom search query for advanced filtering using Shopify search syntax. + * Information for tracking the shipment */ longDesc: () => LocalizedString + type: { + fields: { + number: { + /** + * Tracking Number + */ + displayName: () => LocalizedString + /** + * Shipment tracking number + */ + shortDesc: () => LocalizedString + /** + * The unique identifier for tracking the shipment + */ + longDesc: () => LocalizedString + } + url: { + /** + * Tracking URL + */ + displayName: () => LocalizedString + /** + * Link to track shipment + */ + shortDesc: () => LocalizedString + /** + * The web address where the shipment can be tracked + */ + longDesc: () => LocalizedString + } + company: { + /** + * Shipping Company + */ + displayName: () => LocalizedString + /** + * Name of shipping carrier + */ + shortDesc: () => LocalizedString + /** + * The name of the company responsible for shipping + */ + longDesc: () => LocalizedString + } + } + } } - limit: { + message: { /** - * Results Limit + * Message */ displayName: () => LocalizedString /** - * Maximum number of results + * Additional fulfillment notes */ shortDesc: () => LocalizedString /** - * Specify the maximum number of products to return in the search results. + * Any additional information or notes about the fulfillment */ longDesc: () => LocalizedString } - cursor: { + originAddress: { /** - * Pagination Cursor + * Origin Address */ displayName: () => LocalizedString /** - * Navigate through pages of results + * Shipping origin location */ shortDesc: () => LocalizedString /** - * Use a cursor to paginate through large sets of search results. + * The address from which the items are being shipped */ longDesc: () => LocalizedString + type: { + fields: { + address1: { + /** + * Address Line 1 + */ + displayName: () => LocalizedString + /** + * Primary address line + */ + shortDesc: () => LocalizedString + /** + * The first line of the shipping origin address + */ + longDesc: () => LocalizedString + } + address2: { + /** + * Address Line 2 + */ + displayName: () => LocalizedString + /** + * Secondary address line + */ + shortDesc: () => LocalizedString + /** + * Optional additional address information + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * City of origin + */ + shortDesc: () => LocalizedString + /** + * The city from which the shipment originates + */ + longDesc: () => LocalizedString + } + countryCode: { + /** + * Country Code + */ + displayName: () => LocalizedString + /** + * Origin country code + */ + shortDesc: () => LocalizedString + /** + * The two-letter country code for the shipping origin + */ + longDesc: () => LocalizedString + } + provinceCode: { + /** + * Province Code + */ + displayName: () => LocalizedString + /** + * State or province code + */ + shortDesc: () => LocalizedString + /** + * The code representing the state or province of origin + */ + longDesc: () => LocalizedString + } + zip: { + /** + * Postal Code + */ + displayName: () => LocalizedString + /** + * Origin postal code + */ + shortDesc: () => LocalizedString + /** + * The postal code of the shipping origin + */ + longDesc: () => LocalizedString + } + } + } } } } - 'find-order': { + 'create-draft-order': { /** - * Find Orders + * Create Draft Order */ displayName: () => LocalizedString /** - * Search for customer orders + * Creates a new draft order in Shopify */ shortDesc: () => LocalizedString /** - * Search and filter orders in your Shopify store based on various criteria including customer name, email, order number, and more. + * Generates a draft order that can be used to create an order manually, send invoices, or process payments later. Draft orders are useful for custom sales, wholesale orders, or pre-orders. */ longDesc: () => LocalizedString options: { - name: { + customerId: { /** - * Order Number + * Customer ID */ displayName: () => LocalizedString /** - * Search by order number + * The ID of the customer for the draft order */ shortDesc: () => LocalizedString /** - * Look up orders using their confirmation or order number. + * Specifies the unique identifier of the customer to associate with this draft order. Required if not using default address. */ longDesc: () => LocalizedString } @@ -230883,957 +234820,2559 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Search by customer email - */ - shortDesc: () => LocalizedString - /** - * Find orders associated with a specific customer email address. - */ - longDesc: () => LocalizedString - } - customer_id: { - /** - * Customer ID - */ - displayName: () => LocalizedString - /** - * Filter by customer ID - */ - shortDesc: () => LocalizedString - /** - * Find all orders placed by a specific customer using their Shopify customer ID. - */ - longDesc: () => LocalizedString - } - confirmation_number: { - /** - * Confirmation Number - */ - displayName: () => LocalizedString - /** - * Search by confirmation number + * Customer email address */ shortDesc: () => LocalizedString /** - * Find orders by their unique confirmation number provided to customers. + * The email address of the customer, used for notifications and order confirmation. */ longDesc: () => LocalizedString } - id: { + phone: { /** - * Order ID + * Phone */ displayName: () => LocalizedString /** - * Search by order ID + * Customer phone number */ shortDesc: () => LocalizedString /** - * Look up a specific order using its unique Shopify order ID. + * The phone number of the customer, useful for shipping updates or contact purposes. */ longDesc: () => LocalizedString } - financial_status: { + note: { /** - * Payment Status + * Note */ displayName: () => LocalizedString /** - * Filter by payment status + * Additional notes for the draft order */ shortDesc: () => LocalizedString /** - * Find orders with a specific payment status (paid, pending, refunded, etc.). + * A field for adding internal notes about the draft order, such as special instructions or context. */ longDesc: () => LocalizedString } - fulfillment_status: { + taxExempt: { /** - * Fulfillment Status + * Tax Exempt */ displayName: () => LocalizedString /** - * Filter by shipping status + * Exempt order from taxes */ shortDesc: () => LocalizedString /** - * Find orders with a specific fulfillment status (fulfilled, unfulfilled, shipped, etc.). + * Indicates whether the entire order is exempt from taxes. Set to true for tax-exempt customers. */ longDesc: () => LocalizedString } - status: { + taxExemptions: { /** - * Order Status + * Tax Exemptions */ displayName: () => LocalizedString /** - * Filter by order status + * Specific tax exemptions */ shortDesc: () => LocalizedString /** - * Find orders based on their overall status (open, closed, cancelled). + * List of specific tax exemptions applied to the draft order, such as regional or product-specific exemptions. */ longDesc: () => LocalizedString + type: { + element_type: { + /** + * Tax Exemption Type + */ + displayName: () => LocalizedString + /** + * Type of tax exemption + */ + shortDesc: () => LocalizedString + /** + * Defines the specific tax exemption applied, e.g., GST, VAT, or sales tax. + */ + longDesc: () => LocalizedString + } + } } - source_name: { + tags: { /** - * Source + * Tags */ displayName: () => LocalizedString /** - * Filter by order source + * Tags for the draft order */ shortDesc: () => LocalizedString /** - * Find orders from specific sources (e.g., web, draft orders, POS). + * A list of tags to categorize or filter the draft order, e.g., "wholesale", "pre-order". */ longDesc: () => LocalizedString + type: { + element_type: { + /** + * Tag + */ + displayName: () => LocalizedString + /** + * Single tag value + */ + shortDesc: () => LocalizedString + /** + * A single string value used to tag the draft order for organization or search purposes. + */ + longDesc: () => LocalizedString + } + } } - sales_channel: { + shippingAddress: { /** - * Sales Channel + * Shipping Address */ displayName: () => LocalizedString /** - * Filter by sales channel + * Customer shipping address */ shortDesc: () => LocalizedString /** - * Find orders from specific sales channels configured in your Shopify store. + * The full shipping address where the order will be delivered, including all relevant fields. */ longDesc: () => LocalizedString + type: { + fields: { + address1: { + /** + * Address Line 1 + */ + displayName: () => LocalizedString + /** + * Primary address line + */ + shortDesc: () => LocalizedString + /** + * The street address or PO Box for shipping. + */ + longDesc: () => LocalizedString + } + address2: { + /** + * Address Line 2 + */ + displayName: () => LocalizedString + /** + * Secondary address line + */ + shortDesc: () => LocalizedString + /** + * Additional address information like apartment or suite number. + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * Shipping city + */ + shortDesc: () => LocalizedString + /** + * The city for the shipping address. + */ + longDesc: () => LocalizedString + } + province: { + /** + * Province/State + */ + displayName: () => LocalizedString + /** + * Shipping province or state + */ + shortDesc: () => LocalizedString + /** + * The province, state, or region for the shipping address. + */ + longDesc: () => LocalizedString + } + country: { + /** + * Country + */ + displayName: () => LocalizedString + /** + * Shipping country + */ + shortDesc: () => LocalizedString + /** + * The country for the shipping address. + */ + longDesc: () => LocalizedString + } + zip: { + /** + * ZIP/Postal Code + */ + displayName: () => LocalizedString + /** + * Shipping postal code + */ + shortDesc: () => LocalizedString + /** + * The ZIP or postal code for the shipping address. + */ + longDesc: () => LocalizedString + } + firstName: { + /** + * First Name + */ + displayName: () => LocalizedString + /** + * Recipient first name + */ + shortDesc: () => LocalizedString + /** + * The first name of the shipping recipient. + */ + longDesc: () => LocalizedString + } + lastName: { + /** + * Last Name + */ + displayName: () => LocalizedString + /** + * Recipient last name + */ + shortDesc: () => LocalizedString + /** + * The last name of the shipping recipient. + */ + longDesc: () => LocalizedString + } + company: { + /** + * Company + */ + displayName: () => LocalizedString + /** + * Shipping company name + */ + shortDesc: () => LocalizedString + /** + * The company name associated with the shipping address, if applicable. + */ + longDesc: () => LocalizedString + } + phone: { + /** + * Phone + */ + displayName: () => LocalizedString + /** + * Shipping contact phone + */ + shortDesc: () => LocalizedString + /** + * The phone number for the shipping recipient. + */ + longDesc: () => LocalizedString + } + } + } } - sku: { + billingAddress: { /** - * Product SKU + * Billing Address */ displayName: () => LocalizedString /** - * Search by product SKU + * Customer billing address */ shortDesc: () => LocalizedString /** - * Find orders containing products with a specific SKU. + * The address used for billing purposes, which may differ from the shipping address. */ longDesc: () => LocalizedString + type: { + fields: { + address1: { + /** + * Address Line 1 + */ + displayName: () => LocalizedString + /** + * Primary billing address line + */ + shortDesc: () => LocalizedString + /** + * The street address or PO Box for billing. + */ + longDesc: () => LocalizedString + } + address2: { + /** + * Address Line 2 + */ + displayName: () => LocalizedString + /** + * Secondary billing address line + */ + shortDesc: () => LocalizedString + /** + * Additional billing address information like apartment or suite number. + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * Billing city + */ + shortDesc: () => LocalizedString + /** + * The city for the billing address. + */ + longDesc: () => LocalizedString + } + province: { + /** + * Province/State + */ + displayName: () => LocalizedString + /** + * Billing province or state + */ + shortDesc: () => LocalizedString + /** + * The province, state, or region for the billing address. + */ + longDesc: () => LocalizedString + } + country: { + /** + * Country + */ + displayName: () => LocalizedString + /** + * Billing country + */ + shortDesc: () => LocalizedString + /** + * The country for the billing address. + */ + longDesc: () => LocalizedString + } + zip: { + /** + * ZIP/Postal Code + */ + displayName: () => LocalizedString + /** + * Billing postal code + */ + shortDesc: () => LocalizedString + /** + * The ZIP or postal code for the billing address. + */ + longDesc: () => LocalizedString + } + firstName: { + /** + * First Name + */ + displayName: () => LocalizedString + /** + * Billing first name + */ + shortDesc: () => LocalizedString + /** + * The first name of the billing contact. + */ + longDesc: () => LocalizedString + } + lastName: { + /** + * Last Name + */ + displayName: () => LocalizedString + /** + * Billing last name + */ + shortDesc: () => LocalizedString + /** + * The last name of the billing contact. + */ + longDesc: () => LocalizedString + } + company: { + /** + * Company + */ + displayName: () => LocalizedString + /** + * Billing company name + */ + shortDesc: () => LocalizedString + /** + * The company name associated with the billing address, if applicable. + */ + longDesc: () => LocalizedString + } + phone: { + /** + * Phone + */ + displayName: () => LocalizedString + /** + * Billing contact phone + */ + shortDesc: () => LocalizedString + /** + * The phone number for the billing contact. + */ + longDesc: () => LocalizedString + } + } + } } - created_at: { + useCustomerDefaultAddress: { /** - * Created Date + * Use Customer Default Address */ displayName: () => LocalizedString /** - * Filter by creation date + * Use customer’s default address */ shortDesc: () => LocalizedString /** - * Find orders created on a specific date or within a date range (e.g., 2021-01-01, LocalizedString } - updated_at: { + lineItems: { /** - * Updated Date + * Line Items */ displayName: () => LocalizedString /** - * Filter by last update date + * Products in the draft order */ shortDesc: () => LocalizedString /** - * Find orders last updated on a specific date or within a date range. + * A list of products or variants included in the draft order, with details like quantity and price. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + variantId: { + /** + * Variant ID + */ + displayName: () => LocalizedString + /** + * Product variant ID + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the product variant to include in the order. + */ + longDesc: () => LocalizedString + } + quantity: { + /** + * Quantity + */ + displayName: () => LocalizedString + /** + * Number of items + */ + shortDesc: () => LocalizedString + /** + * The number of units of this variant to include in the draft order. + */ + longDesc: () => LocalizedString + } + title: { + /** + * Title + */ + displayName: () => LocalizedString + /** + * Item title + */ + shortDesc: () => LocalizedString + /** + * The display name of the line item, typically the product or variant name. + */ + longDesc: () => LocalizedString + } + originalUnitPrice: { + /** + * Original Unit Price + */ + displayName: () => LocalizedString + /** + * Price per unit + */ + shortDesc: () => LocalizedString + /** + * The original price per unit of the item before discounts. + */ + longDesc: () => LocalizedString + } + originalUnitPriceWithCurrency: { + /** + * Original Unit Price with Currency + */ + displayName: () => LocalizedString + /** + * Price with currency details + */ + shortDesc: () => LocalizedString + /** + * The original unit price including currency specification. + */ + longDesc: () => LocalizedString + type: { + fields: { + amount: { + /** + * Amount + */ + displayName: () => LocalizedString + /** + * Price amount + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the unit price. + */ + longDesc: () => LocalizedString + } + currencyCode: { + /** + * Currency Code + */ + displayName: () => LocalizedString + /** + * Currency code + */ + shortDesc: () => LocalizedString + /** + * The ISO 4217 currency code for the price, e.g., USD, EUR. + */ + longDesc: () => LocalizedString + } + } + } + } + sku: { + /** + * SKU + */ + displayName: () => LocalizedString + /** + * Stock Keeping Unit + */ + shortDesc: () => LocalizedString + /** + * The stock keeping unit identifier for the product variant. + */ + longDesc: () => LocalizedString + } + requiresShipping: { + /** + * Requires Shipping + */ + displayName: () => LocalizedString + /** + * Needs shipping + */ + shortDesc: () => LocalizedString + /** + * Indicates if the item requires physical shipping. + */ + longDesc: () => LocalizedString + } + taxable: { + /** + * Taxable + */ + displayName: () => LocalizedString + /** + * Subject to tax + */ + shortDesc: () => LocalizedString + /** + * Specifies whether the item is taxable. + */ + longDesc: () => LocalizedString + } + weight: { + /** + * Weight + */ + displayName: () => LocalizedString + /** + * Item weight + */ + shortDesc: () => LocalizedString + /** + * The weight of the item, used for shipping calculations. + */ + longDesc: () => LocalizedString + type: { + fields: { + value: { + /** + * Weight Value + */ + displayName: () => LocalizedString + /** + * Numerical weight + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the item’s weight. + */ + longDesc: () => LocalizedString + } + unit: { + /** + * Weight Unit + */ + displayName: () => LocalizedString + /** + * Unit of weight + */ + shortDesc: () => LocalizedString + /** + * The unit of measurement for the weight, e.g., kg, lb. + */ + longDesc: () => LocalizedString + } + } + } + } + customAttributes: { + /** + * Custom Attributes + */ + displayName: () => LocalizedString + /** + * Additional item attributes + */ + shortDesc: () => LocalizedString + /** + * Key-value pairs for adding custom metadata to the line item. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + key: { + /** + * Key + */ + displayName: () => LocalizedString + /** + * Attribute key + */ + shortDesc: () => LocalizedString + /** + * The identifier for the custom attribute. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Attribute value + */ + shortDesc: () => LocalizedString + /** + * The value associated with the custom attribute key. + */ + longDesc: () => LocalizedString + } + } + } + } + } + appliedDiscount: { + /** + * Applied Discount + */ + displayName: () => LocalizedString + /** + * Discount on item + */ + shortDesc: () => LocalizedString + /** + * Details of any discount applied to this specific line item. + */ + longDesc: () => LocalizedString + type: { + fields: { + title: { + /** + * Discount Title + */ + displayName: () => LocalizedString + /** + * Discount name + */ + shortDesc: () => LocalizedString + /** + * The name or title of the discount. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Discount Description + */ + displayName: () => LocalizedString + /** + * Discount details + */ + shortDesc: () => LocalizedString + /** + * A description of the discount applied. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Discount Value + */ + displayName: () => LocalizedString + /** + * Discount amount or percentage + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the discount, either as a fixed amount or percentage. + */ + longDesc: () => LocalizedString + } + valueType: { + /** + * Value Type + */ + displayName: () => LocalizedString + /** + * Type of discount value + */ + shortDesc: () => LocalizedString + /** + * Specifies if the discount is a fixed amount or percentage (e.g., "FIXED_AMOUNT", "PERCENTAGE"). + */ + longDesc: () => LocalizedString + } + amountWithCurrency: { + /** + * Amount with Currency + */ + displayName: () => LocalizedString + /** + * Discount amount with currency + */ + shortDesc: () => LocalizedString + /** + * The discount amount including currency details. + */ + longDesc: () => LocalizedString + type: { + fields: { + amount: { + /** + * Amount + */ + displayName: () => LocalizedString + /** + * Discount amount + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the discount. + */ + longDesc: () => LocalizedString + } + currencyCode: { + /** + * Currency Code + */ + displayName: () => LocalizedString + /** + * Discount currency + */ + shortDesc: () => LocalizedString + /** + * The ISO 4217 currency code for the discount amount. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + } + generatePriceOverride: { + /** + * Generate Price Override + */ + displayName: () => LocalizedString + /** + * Override item price + */ + shortDesc: () => LocalizedString + /** + * If true, allows setting a custom price for the item instead of the original price. + */ + longDesc: () => LocalizedString + } + priceOverride: { + /** + * Price Override + */ + displayName: () => LocalizedString + /** + * Custom item price + */ + shortDesc: () => LocalizedString + /** + * The custom price to override the original unit price. + */ + longDesc: () => LocalizedString + type: { + fields: { + amount: { + /** + * Amount + */ + displayName: () => LocalizedString + /** + * Override amount + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the custom price. + */ + longDesc: () => LocalizedString + } + currencyCode: { + /** + * Currency Code + */ + displayName: () => LocalizedString + /** + * Override currency + */ + shortDesc: () => LocalizedString + /** + * The ISO 4217 currency code for the custom price. + */ + longDesc: () => LocalizedString + } + } + } + } + components: { + /** + * Components + */ + displayName: () => LocalizedString + /** + * Bundle components + */ + shortDesc: () => LocalizedString + /** + * Details of components if the item is a bundle or composite product. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + quantity: { + /** + * Quantity + */ + displayName: () => LocalizedString + /** + * Component quantity + */ + shortDesc: () => LocalizedString + /** + * The number of units of this component in the bundle. + */ + longDesc: () => LocalizedString + } + variantId: { + /** + * Variant ID + */ + displayName: () => LocalizedString + /** + * Component variant ID + */ + shortDesc: () => LocalizedString + /** + * The unique identifier of the variant included as a component. + */ + longDesc: () => LocalizedString + } + } + } + } + } + uuid: { + /** + * UUID + */ + displayName: () => LocalizedString + /** + * Unique identifier + */ + shortDesc: () => LocalizedString + /** + * A unique identifier for the line item, often used for tracking or external systems. + */ + longDesc: () => LocalizedString + } + } + } + } } - processed_at: { + appliedDiscount: { /** - * Processed Date + * Applied Discount */ displayName: () => LocalizedString /** - * Filter by processed date + * Order-wide discount */ shortDesc: () => LocalizedString /** - * Find orders processed on a specific date or within a date range. + * Details of a discount applied to the entire draft order. */ longDesc: () => LocalizedString + type: { + fields: { + title: { + /** + * Discount Title + */ + displayName: () => LocalizedString + /** + * Discount name + */ + shortDesc: () => LocalizedString + /** + * The name or title of the order-wide discount. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Discount Description + */ + displayName: () => LocalizedString + /** + * Discount details + */ + shortDesc: () => LocalizedString + /** + * A description of the order-wide discount. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Discount Value + */ + displayName: () => LocalizedString + /** + * Discount amount or percentage + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the discount, either as a fixed amount or percentage. + */ + longDesc: () => LocalizedString + } + valueType: { + /** + * Value Type + */ + displayName: () => LocalizedString + /** + * Type of discount value + */ + shortDesc: () => LocalizedString + /** + * Specifies if the discount is a fixed amount or percentage (e.g., "FIXED_AMOUNT", "PERCENTAGE"). + */ + longDesc: () => LocalizedString + } + amountWithCurrency: { + /** + * Amount with Currency + */ + displayName: () => LocalizedString + /** + * Discount amount with currency + */ + shortDesc: () => LocalizedString + /** + * The discount amount including currency details. + */ + longDesc: () => LocalizedString + type: { + fields: { + amount: { + /** + * Amount + */ + displayName: () => LocalizedString + /** + * Discount amount + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the discount. + */ + longDesc: () => LocalizedString + } + currencyCode: { + /** + * Currency Code + */ + displayName: () => LocalizedString + /** + * Discount currency + */ + shortDesc: () => LocalizedString + /** + * The ISO 4217 currency code for the discount amount. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } } - tag: { + shippingLine: { /** - * Tag + * Shipping Line */ displayName: () => LocalizedString /** - * Filter by order tag + * Shipping details */ shortDesc: () => LocalizedString /** - * Find orders that have been tagged with specific labels in Shopify. + * Details about the shipping method and cost for the draft order. */ longDesc: () => LocalizedString + type: { + fields: { + price: { + /** + * Price + */ + displayName: () => LocalizedString + /** + * Shipping cost + */ + shortDesc: () => LocalizedString + /** + * The cost of shipping as a numerical value. + */ + longDesc: () => LocalizedString + } + priceWithCurrency: { + /** + * Price with Currency + */ + displayName: () => LocalizedString + /** + * Shipping cost with currency + */ + shortDesc: () => LocalizedString + /** + * The shipping cost including currency specification. + */ + longDesc: () => LocalizedString + type: { + fields: { + amount: { + /** + * Amount + */ + displayName: () => LocalizedString + /** + * Shipping amount + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the shipping cost. + */ + longDesc: () => LocalizedString + } + currencyCode: { + /** + * Currency Code + */ + displayName: () => LocalizedString + /** + * Shipping currency + */ + shortDesc: () => LocalizedString + /** + * The ISO 4217 currency code for the shipping cost. + */ + longDesc: () => LocalizedString + } + } + } + } + title: { + /** + * Title + */ + displayName: () => LocalizedString + /** + * Shipping method name + */ + shortDesc: () => LocalizedString + /** + * The name of the shipping method, e.g., "Standard Shipping". + */ + longDesc: () => LocalizedString + } + shippingRateHandle: { + /** + * Shipping Rate Handle + */ + displayName: () => LocalizedString + /** + * Shipping rate identifier + */ + shortDesc: () => LocalizedString + /** + * A unique identifier for the shipping rate, often tied to a predefined rate in Shopify. + */ + longDesc: () => LocalizedString + } + } + } } - test: { + customAttributes: { /** - * Test Orders + * Custom Attributes */ displayName: () => LocalizedString /** - * Include/exclude test orders + * Order custom attributes */ shortDesc: () => LocalizedString /** - * Filter to show only test orders (true) or exclude test orders (false). + * Key-value pairs for adding custom metadata to the draft order. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + key: { + /** + * Key + */ + displayName: () => LocalizedString + /** + * Attribute key + */ + shortDesc: () => LocalizedString + /** + * The identifier for the custom attribute. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Attribute value + */ + shortDesc: () => LocalizedString + /** + * The value associated with the custom attribute key. + */ + longDesc: () => LocalizedString + } + } + } + } } - location_id: { + allowDiscountCodesInCheckout: { /** - * Location + * Allow Discount Codes in Checkout */ displayName: () => LocalizedString /** - * Filter by store location + * Enable discount codes */ shortDesc: () => LocalizedString /** - * Find orders associated with a specific store location or fulfillment center. + * If true, allows customers to apply discount codes during checkout from this draft order. */ longDesc: () => LocalizedString } - po_number: { + acceptAutomaticDiscounts: { /** - * Purchase Order Number + * Accept Automatic Discounts */ displayName: () => LocalizedString /** - * Search by PO number + * Apply automatic discounts */ shortDesc: () => LocalizedString /** - * Find orders associated with a specific purchase order number. + * If true, automatically applies any eligible store-wide discounts to the draft order. */ longDesc: () => LocalizedString } - rawQuery: { + discountCodes: { /** - * Advanced Query + * Discount Codes */ displayName: () => LocalizedString /** - * Use custom search syntax + * List of discount codes */ shortDesc: () => LocalizedString /** - * Enter a custom search query for advanced filtering using Shopify search syntax. + * A list of discount codes to apply to the draft order. */ longDesc: () => LocalizedString + type: { + element_type: { + /** + * Discount Code + */ + displayName: () => LocalizedString + /** + * Single discount code + */ + shortDesc: () => LocalizedString + /** + * A specific discount code to apply to the order. + */ + longDesc: () => LocalizedString + } + } } - sortKey: { + metafields: { /** - * Sort By + * Metafields */ displayName: () => LocalizedString /** - * Sort the results + * Custom metadata */ shortDesc: () => LocalizedString /** - * Choose how to order the results (e.g., by date, order number, total value). + * Additional metadata fields for the draft order, useful for custom integrations. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + namespace: { + /** + * Namespace + */ + displayName: () => LocalizedString + /** + * Metafield namespace + */ + shortDesc: () => LocalizedString + /** + * A grouping identifier for the metafield. + */ + longDesc: () => LocalizedString + } + key: { + /** + * Key + */ + displayName: () => LocalizedString + /** + * Metafield key + */ + shortDesc: () => LocalizedString + /** + * The specific identifier for the metafield. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Metafield value + */ + shortDesc: () => LocalizedString + /** + * The value stored in the metafield. + */ + longDesc: () => LocalizedString + } + type: { + /** + * Type + */ + displayName: () => LocalizedString + /** + * Metafield data type + */ + shortDesc: () => LocalizedString + /** + * The data type of the metafield value, e.g., string, integer, JSON. + */ + longDesc: () => LocalizedString + } + } + } + } } - reverse: { + localizedFields: { /** - * Reverse Order + * Localized Fields */ displayName: () => LocalizedString /** - * Reverse the sort order + * Localized content */ shortDesc: () => LocalizedString /** - * Toggle between ascending and descending sort order for the results. + * Fields that support localized content for different regions or languages. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Localized value + */ + shortDesc: () => LocalizedString + /** + * The localized content value. + */ + longDesc: () => LocalizedString + } + key: { + /** + * Key + */ + displayName: () => LocalizedString + /** + * Localized field key + */ + shortDesc: () => LocalizedString + /** + * The identifier for the localized field. + */ + longDesc: () => LocalizedString + } + locale: { + /** + * Locale + */ + displayName: () => LocalizedString + /** + * Language/region code + */ + shortDesc: () => LocalizedString + /** + * The locale code for the localized content, e.g., "en-US", "fr-CA". + */ + longDesc: () => LocalizedString + } + } + } + } } - limit: { + presentmentCurrencyCode: { /** - * Results Limit + * Presentment Currency Code */ displayName: () => LocalizedString /** - * Maximum number of results + * Display currency */ shortDesc: () => LocalizedString /** - * Specify the maximum number of orders to return in the search results (max: 250). + * The ISO 4217 currency code for displaying prices to the customer, e.g., USD, CAD. */ longDesc: () => LocalizedString } - cursor: { + poNumber: { /** - * Pagination Cursor + * PO Number */ displayName: () => LocalizedString /** - * Navigate through pages of results + * Purchase order number */ shortDesc: () => LocalizedString /** - * Use a cursor to paginate through large sets of search results. + * The purchase order number associated with the draft order, often used for B2B transactions. */ longDesc: () => LocalizedString } - } - } - 'find-customer': { - /** - * Find Customers - */ - displayName: () => LocalizedString - /** - * Search for customers - */ - shortDesc: () => LocalizedString - /** - * Search and filter customers in your Shopify store based on names, emails, or other attributes. - */ - longDesc: () => LocalizedString - options: { - query: { + paymentTerms: { /** - * Search Query + * Payment Terms */ displayName: () => LocalizedString /** - * Search by name or email + * Payment conditions */ shortDesc: () => LocalizedString /** - * Search for customers by their name, email, or other identifying information. + * Defines the payment terms for the draft order, such as due dates or schedules. */ longDesc: () => LocalizedString + type: { + fields: { + paymentTermsTemplateId: { + /** + * Payment Terms Template ID + */ + displayName: () => LocalizedString + /** + * Template identifier + */ + shortDesc: () => LocalizedString + /** + * The ID of a predefined payment terms template in Shopify. + */ + longDesc: () => LocalizedString + } + paymentSchedules: { + /** + * Payment Schedules + */ + displayName: () => LocalizedString + /** + * Payment due dates + */ + shortDesc: () => LocalizedString + /** + * A list of scheduled payments with due dates and amounts. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + dueAt: { + /** + * Due At + */ + displayName: () => LocalizedString + /** + * Due date + */ + shortDesc: () => LocalizedString + /** + * The date when the payment is due. + */ + longDesc: () => LocalizedString + } + amount: { + /** + * Amount + */ + displayName: () => LocalizedString + /** + * Payment amount + */ + shortDesc: () => LocalizedString + /** + * The numerical value of the payment due. + */ + longDesc: () => LocalizedString + } + currencyCode: { + /** + * Currency Code + */ + displayName: () => LocalizedString + /** + * Payment currency + */ + shortDesc: () => LocalizedString + /** + * The ISO 4217 currency code for the payment amount. + */ + longDesc: () => LocalizedString + } + issuedAt: { + /** + * Issued At + */ + displayName: () => LocalizedString + /** + * Issue date + */ + shortDesc: () => LocalizedString + /** + * The date when the payment schedule was issued. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } + } } - limit: { + purchasingEntity: { /** - * Results Limit + * Purchasing Entity */ displayName: () => LocalizedString /** - * Maximum number of results + * Buyer details */ shortDesc: () => LocalizedString /** - * Specify the maximum number of customers to return in the search results. + * Details about the entity making the purchase, such as a company or individual. */ longDesc: () => LocalizedString + type: { + fields: { + customerId: { + /** + * Customer ID + */ + displayName: () => LocalizedString + /** + * Purchaser customer ID + */ + shortDesc: () => LocalizedString + /** + * The ID of the customer making the purchase. + */ + longDesc: () => LocalizedString + } + companyId: { + /** + * Company ID + */ + displayName: () => LocalizedString + /** + * Purchaser company ID + */ + shortDesc: () => LocalizedString + /** + * The ID of the company making the purchase. + */ + longDesc: () => LocalizedString + } + companyLocationId: { + /** + * Company Location ID + */ + displayName: () => LocalizedString + /** + * Company location ID + */ + shortDesc: () => LocalizedString + /** + * The ID of the specific company location making the purchase. + */ + longDesc: () => LocalizedString + } + companyContactId: { + /** + * Company Contact ID + */ + displayName: () => LocalizedString + /** + * Contact ID + */ + shortDesc: () => LocalizedString + /** + * The ID of the company contact responsible for the purchase. + */ + longDesc: () => LocalizedString + } + } + } } - cursor: { + reserveInventoryUntil: { /** - * Pagination Cursor + * Reserve Inventory Until */ displayName: () => LocalizedString /** - * Navigate through pages of results + * Inventory reservation deadline */ shortDesc: () => LocalizedString /** - * Use a cursor to paginate through large sets of search results. + * The date and time until which the inventory is reserved for this draft order. */ longDesc: () => LocalizedString } - sortKey: { + sourceName: { /** - * Sort By + * Source Name */ displayName: () => LocalizedString /** - * Sort the results + * Order source */ shortDesc: () => LocalizedString /** - * Choose how to order the results (e.g., by name, date created, total spent). + * The source of the draft order, e.g., "web", "manual", or an app name. */ longDesc: () => LocalizedString } - reverse: { + visibleToCustomer: { /** - * Reverse Order + * Visible to Customer */ displayName: () => LocalizedString /** - * Reverse the sort order + * Customer visibility */ shortDesc: () => LocalizedString /** - * Toggle between ascending and descending sort order for the results. + * If true, the draft order is visible to the customer, e.g., in their account. */ longDesc: () => LocalizedString } } } - 'find-variant': { + 'create-customer': { /** - * Find Product Variants + * Create Customer */ displayName: () => LocalizedString /** - * Search for specific product variants + * Creates a new customer in Shopify */ shortDesc: () => LocalizedString /** - * Search and filter product variants in your Shopify store based on criteria like SKU, barcode, price, or inventory status. + * Adds a new customer to the Shopify store, allowing you to store their contact information, addresses, and marketing preferences for future orders and engagement. */ longDesc: () => LocalizedString options: { - productId: { - /** - * Product ID - */ - displayName: () => LocalizedString - /** - * Filter by parent product - */ - shortDesc: () => LocalizedString - /** - * Find variants that belong to a specific parent product using its Shopify product ID. - */ - longDesc: () => LocalizedString - } - title: { + email: { /** - * Variant Title + * Email */ displayName: () => LocalizedString /** - * Search by variant title + * Customer email address */ shortDesc: () => LocalizedString /** - * Filter variants by matching text in their titles or option values. + * The primary email address of the customer, used for account creation, notifications, and marketing. */ longDesc: () => LocalizedString } - sku: { + phone: { /** - * SKU + * Phone */ displayName: () => LocalizedString /** - * Search by variant SKU + * Customer phone number */ shortDesc: () => LocalizedString /** - * Look up variants using their Stock Keeping Unit (SKU) identifier. + * The customer’s phone number, useful for contact purposes and SMS marketing if consented. */ longDesc: () => LocalizedString } - barcode: { + firstName: { /** - * Barcode + * First Name */ displayName: () => LocalizedString /** - * Search by barcode + * Customer first name */ shortDesc: () => LocalizedString /** - * Find variants using their UPC, ISBN, or other barcode identifiers. + * The first name of the customer, used for personalization and address details. */ longDesc: () => LocalizedString } - id: { + lastName: { /** - * Variant ID + * Last Name */ displayName: () => LocalizedString /** - * Search by variant ID + * Customer last name */ shortDesc: () => LocalizedString /** - * Look up a specific variant using its unique Shopify variant ID. + * The last name of the customer, completing their full name for identification and shipping. */ longDesc: () => LocalizedString } - inventoryQuantity: { + locale: { /** - * Inventory Quantity + * Locale */ displayName: () => LocalizedString /** - * Filter by inventory quantity + * Customer language/region */ shortDesc: () => LocalizedString /** - * Find variants based on their exact inventory quantity or range (e.g., "inventory_quantity:10" or "inventory_quantity:>5"). + * The preferred language and region code for the customer, e.g., "en-US" or "fr-CA", affecting communication and formatting. */ longDesc: () => LocalizedString } - productStatus: { + note: { /** - * Product Status + * Note */ displayName: () => LocalizedString /** - * Filter by product status + * Notes about the customer */ shortDesc: () => LocalizedString /** - * Find variants based on whether their parent product is active, draft, or archived. + * Internal notes about the customer, such as preferences, special instructions, or account details. */ longDesc: () => LocalizedString } - productType: { + taxExempt: { /** - * Product Type + * Tax Exempt */ displayName: () => LocalizedString /** - * Filter by product type + * Exempt customer from taxes */ shortDesc: () => LocalizedString /** - * Find variants belonging to products of a specific type or category. + * Indicates whether the customer is exempt from taxes on all purchases. Set to true for tax-exempt entities. */ longDesc: () => LocalizedString } - tag: { + taxExemptions: { /** - * Product Tag + * Tax Exemptions */ displayName: () => LocalizedString /** - * Filter by product tag + * Specific tax exemptions */ shortDesc: () => LocalizedString /** - * Find variants belonging to products that have a specific tag. + * A list of specific tax exemptions applied to the customer, such as regional or category-specific exemptions. */ longDesc: () => LocalizedString + type: { + element_type: { + /** + * Tax Exemption Type + */ + displayName: () => LocalizedString + /** + * Type of tax exemption + */ + shortDesc: () => LocalizedString + /** + * Defines the specific tax exemption applied, e.g., GST, VAT, or sales tax. + */ + longDesc: () => LocalizedString + } + } } - tagNot: { + tags: { /** - * Exclude Tag + * Tags */ displayName: () => LocalizedString /** - * Filter out products with tag + * Customer tags */ shortDesc: () => LocalizedString /** - * Find variants belonging to products that do not have a specific tag. + * A list of tags to categorize or filter the customer, e.g., "VIP", "wholesale", "new". */ longDesc: () => LocalizedString + type: { + element_type: { + /** + * Tag + */ + displayName: () => LocalizedString + /** + * Single tag value + */ + shortDesc: () => LocalizedString + /** + * A single string value used to tag the customer for organization or segmentation. + */ + longDesc: () => LocalizedString + } + } } - vendor: { + addresses: { /** - * Vendor + * Addresses */ displayName: () => LocalizedString /** - * Filter by vendor or supplier + * Customer addresses */ shortDesc: () => LocalizedString /** - * Find variants belonging to products from a specific vendor or supplier. + * A list of addresses associated with the customer, such as shipping or billing addresses. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + address1: { + /** + * Address Line 1 + */ + displayName: () => LocalizedString + /** + * Primary address line + */ + shortDesc: () => LocalizedString + /** + * The street address or PO Box for the customer. + */ + longDesc: () => LocalizedString + } + address2: { + /** + * Address Line 2 + */ + displayName: () => LocalizedString + /** + * Secondary address line + */ + shortDesc: () => LocalizedString + /** + * Additional address information like apartment or suite number. + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * Customer city + */ + shortDesc: () => LocalizedString + /** + * The city associated with the customer’s address. + */ + longDesc: () => LocalizedString + } + province: { + /** + * Province/State + */ + displayName: () => LocalizedString + /** + * Customer province or state + */ + shortDesc: () => LocalizedString + /** + * The province, state, or region for the customer’s address. + */ + longDesc: () => LocalizedString + } + country: { + /** + * Country + */ + displayName: () => LocalizedString + /** + * Customer country + */ + shortDesc: () => LocalizedString + /** + * The country for the customer’s address. + */ + longDesc: () => LocalizedString + } + zip: { + /** + * ZIP/Postal Code + */ + displayName: () => LocalizedString + /** + * Customer postal code + */ + shortDesc: () => LocalizedString + /** + * The ZIP or postal code for the customer’s address. + */ + longDesc: () => LocalizedString + } + firstName: { + /** + * First Name + */ + displayName: () => LocalizedString + /** + * Address first name + */ + shortDesc: () => LocalizedString + /** + * The first name associated with this specific address. + */ + longDesc: () => LocalizedString + } + lastName: { + /** + * Last Name + */ + displayName: () => LocalizedString + /** + * Address last name + */ + shortDesc: () => LocalizedString + /** + * The last name associated with this specific address. + */ + longDesc: () => LocalizedString + } + company: { + /** + * Company + */ + displayName: () => LocalizedString + /** + * Address company name + */ + shortDesc: () => LocalizedString + /** + * The company name tied to this address, if applicable. + */ + longDesc: () => LocalizedString + } + phone: { + /** + * Phone + */ + displayName: () => LocalizedString + /** + * Address phone number + */ + shortDesc: () => LocalizedString + /** + * The phone number linked to this specific address. + */ + longDesc: () => LocalizedString + } + } + } + } } - collection: { + emailMarketingConsent: { /** - * Collection + * Email Marketing Consent */ displayName: () => LocalizedString /** - * Filter by collection + * Email marketing preferences */ shortDesc: () => LocalizedString /** - * Find variants belonging to products in a specific collection using the collection ID. + * Details about the customer’s consent to receive email marketing communications. */ longDesc: () => LocalizedString + type: { + fields: { + marketingState: { + /** + * Marketing State + */ + displayName: () => LocalizedString + /** + * Consent status + */ + shortDesc: () => LocalizedString + /** + * The current state of email marketing consent, e.g., "SUBSCRIBED", "UNSUBSCRIBED", or "PENDING". + */ + longDesc: () => LocalizedString + } + marketingOptInLevel: { + /** + * Marketing Opt-In Level + */ + displayName: () => LocalizedString + /** + * Opt-in level + */ + shortDesc: () => LocalizedString + /** + * The level of consent provided, e.g., "SINGLE_OPT_IN" or "CONFIRMED_OPT_IN", based on how consent was obtained. + */ + longDesc: () => LocalizedString + } + } + } } - option1: { + smsMarketingConsent: { /** - * Option 1 + * SMS Marketing Consent */ displayName: () => LocalizedString /** - * Filter by first option + * SMS marketing preferences */ shortDesc: () => LocalizedString /** - * Find variants with a specific value for their first option (e.g., Size, Color). + * Details about the customer’s consent to receive SMS marketing messages. */ longDesc: () => LocalizedString + type: { + fields: { + marketingState: { + /** + * Marketing State + */ + displayName: () => LocalizedString + /** + * Consent status + */ + shortDesc: () => LocalizedString + /** + * The current state of SMS marketing consent, e.g., "SUBSCRIBED", "UNSUBSCRIBED", or "PENDING". + */ + longDesc: () => LocalizedString + } + marketingOptInLevel: { + /** + * Marketing Opt-In Level + */ + displayName: () => LocalizedString + /** + * Opt-in level + */ + shortDesc: () => LocalizedString + /** + * The level of consent provided for SMS, e.g., "SINGLE_OPT_IN" or "CONFIRMED_OPT_IN". + */ + longDesc: () => LocalizedString + } + } + } } - option2: { + metafields: { /** - * Option 2 + * Metafields */ displayName: () => LocalizedString /** - * Filter by second option + * Custom metadata */ shortDesc: () => LocalizedString /** - * Find variants with a specific value for their second option. + * Additional metadata fields for the customer, useful for custom integrations or data storage. */ longDesc: () => LocalizedString + type: { + element_type: { + fields: { + namespace: { + /** + * Namespace + */ + displayName: () => LocalizedString + /** + * Metafield namespace + */ + shortDesc: () => LocalizedString + /** + * A grouping identifier for the metafield to organize related data. + */ + longDesc: () => LocalizedString + } + key: { + /** + * Key + */ + displayName: () => LocalizedString + /** + * Metafield key + */ + shortDesc: () => LocalizedString + /** + * The specific identifier for the metafield. + */ + longDesc: () => LocalizedString + } + value: { + /** + * Value + */ + displayName: () => LocalizedString + /** + * Metafield value + */ + shortDesc: () => LocalizedString + /** + * The value stored in the metafield, which can be a string, number, or JSON. + */ + longDesc: () => LocalizedString + } + type: { + /** + * Type + */ + displayName: () => LocalizedString + /** + * Metafield data type + */ + shortDesc: () => LocalizedString + /** + * The data type of the metafield value, e.g., "string", "integer", "json". + */ + longDesc: () => LocalizedString + } + } + } + } } - option3: { + } + } + 'create-blog-entry': { + /** + * Create Blog Entry + */ + displayName: () => LocalizedString + /** + * Creates a new blog post in Shopify + */ + shortDesc: () => LocalizedString + /** + * Adds a new blog post to a specified blog in your Shopify store, allowing you to publish content such as articles, news, or updates for customers. + */ + longDesc: () => LocalizedString + options: { + blogId: { /** - * Option 3 + * Blog ID */ displayName: () => LocalizedString /** - * Filter by third option + * ID of the target blog */ shortDesc: () => LocalizedString /** - * Find variants with a specific value for their third option. + * The unique identifier of the blog where the new entry will be created. Required to associate the post with a specific blog. */ longDesc: () => LocalizedString } - taxable: { + title: { /** - * Taxable + * Title */ displayName: () => LocalizedString /** - * Filter by tax status + * Blog post title */ shortDesc: () => LocalizedString /** - * Find variants based on whether they are taxable or non-taxable. + * The headline or title of the blog post, displayed prominently to readers. */ longDesc: () => LocalizedString } - updatedAt: { + content: { /** - * Updated At + * Content */ displayName: () => LocalizedString /** - * Filter by update time + * Blog post content */ shortDesc: () => LocalizedString /** - * Find variants based on when they were last updated (e.g., "updated_at:>2023-01-01" or "updated_at: LocalizedString } - rawQuery: { + author: { /** - * Advanced Query + * Author */ displayName: () => LocalizedString /** - * Use custom search syntax + * Author of the blog post */ shortDesc: () => LocalizedString /** - * Enter a custom search query for advanced filtering using Shopify search syntax. + * The name of the person or entity credited with writing the blog post, displayed as the author. */ longDesc: () => LocalizedString } - sortKey: { + tags: { /** - * Sort By + * Tags */ displayName: () => LocalizedString /** - * Order results by field + * Tags for the blog post */ shortDesc: () => LocalizedString /** - * Specify which field to use for sorting the results. + * A list of keywords or categories to tag the blog post, aiding in searchability and organization. */ longDesc: () => LocalizedString + type: { + element_type: { + /** + * Tag + */ + displayName: () => LocalizedString + /** + * Single tag value + */ + shortDesc: () => LocalizedString + /** + * A single string value used to tag the blog post, e.g., "news", "tutorial", "promotion". + */ + longDesc: () => LocalizedString + } + } } - reverse: { + summary: { /** - * Reverse Order + * Summary */ displayName: () => LocalizedString /** - * Reverse the sort order + * Blog post summary */ shortDesc: () => LocalizedString /** - * When enabled, reverses the order of the results (e.g., Z-A instead of A-Z). + * A brief overview or excerpt of the blog post, often used as a teaser or preview in blog listings. */ longDesc: () => LocalizedString } - limit: { + published: { /** - * Results Limit + * Published */ displayName: () => LocalizedString /** - * Maximum number of results + * Publication status */ shortDesc: () => LocalizedString /** - * Specify the maximum number of variants to return in the search results (max: 250). + * Indicates whether the blog post is published (true) or saved as a draft (false) upon creation. */ longDesc: () => LocalizedString } - cursor: { + image: { /** - * Pagination Cursor + * Image */ displayName: () => LocalizedString /** - * Navigate through pages of results + * Featured image for the post */ shortDesc: () => LocalizedString /** - * Use a cursor to paginate through large sets of search results. + * The primary image associated with the blog post, used for visual appeal in previews or headers. */ longDesc: () => LocalizedString + type: { + fields: { + altText: { + /** + * Alt Text + */ + displayName: () => LocalizedString + /** + * Image alt text + */ + shortDesc: () => LocalizedString + /** + * Descriptive text for the image, used for accessibility and SEO purposes. + */ + longDesc: () => LocalizedString + } + url: { + /** + * URL + */ + displayName: () => LocalizedString + /** + * Image URL + */ + shortDesc: () => LocalizedString + /** + * The web address or source location of the image file to be used in the blog post. + */ + longDesc: () => LocalizedString + } + } + } } } } - 'add-line-item-to-order': { + 'add-tag-to-customer': { /** - * Add Line Item to Order + * Add Tag to Customer */ displayName: () => LocalizedString /** - * Add a new product line to an existing order + * Adds tags to an existing customer */ shortDesc: () => LocalizedString /** - * Allows adding a new line item to an existing order, with options for quantity, pricing, and other product details + * Appends or replaces tags for a specified customer in Shopify, useful for categorization, segmentation, or tracking purposes. */ longDesc: () => LocalizedString options: { - orderId: { - /** - * Order ID - */ - displayName: () => LocalizedString - /** - * Unique identifier of the order - */ - shortDesc: () => LocalizedString - /** - * The specific order to which the line item will be added - */ - longDesc: () => LocalizedString - } - type: { - /** - * Line Item Type - */ - displayName: () => LocalizedString - /** - * Type of line item being added - */ - shortDesc: () => LocalizedString - /** - * Specifies the nature of the line item (e.g., product, shipping, tax) - */ - longDesc: () => LocalizedString - } - quantity: { - /** - * Quantity - */ - displayName: () => LocalizedString - /** - * Number of items to add - */ - shortDesc: () => LocalizedString - /** - * The quantity of the specific product being added to the order - */ - longDesc: () => LocalizedString - } - locationId: { + customerId: { /** - * Location ID + * Customer ID */ displayName: () => LocalizedString /** - * Inventory location + * ID of the customer */ shortDesc: () => LocalizedString /** - * The specific warehouse or store location where the item is stocked + * The unique identifier of the customer to whom tags will be added. Required to target the correct customer. */ longDesc: () => LocalizedString } - reason: { + tags: { /** - * Reason + * Tags */ displayName: () => LocalizedString /** - * Reason for adding line item + * Tags to add */ shortDesc: () => LocalizedString /** - * Explanation for why the line item is being added to the order + * A list of tags to apply to the customer, such as "VIP", "loyal", or "newsletter". Can be appended or replace existing tags based on the append option. */ longDesc: () => LocalizedString } - notifyCustomer: { + append: { /** - * Notify Customer + * Append */ displayName: () => LocalizedString /** - * Send notification about order change + * Append or replace tags */ shortDesc: () => LocalizedString /** - * Determines whether the customer should be notified about the line item addition + * If true, adds the new tags to the existing ones; if false, replaces all existing tags with the new ones. */ longDesc: () => LocalizedString } - variantId: { + } + } + 'create-transaction': { + /** + * Create Transaction + */ + displayName: () => LocalizedString + /** + * Creates a transaction for an order + */ + shortDesc: () => LocalizedString + /** + * Records a financial transaction (e.g., payment, refund) for a specific order in Shopify, linked to a payment gateway. + */ + longDesc: () => LocalizedString + options: { + orderId: { /** - * Variant ID + * Order ID */ displayName: () => LocalizedString /** - * Specific product variant + * ID of the order */ shortDesc: () => LocalizedString /** - * Unique identifier for the specific product variant being added + * The unique identifier of the order to which this transaction applies. Required to associate the transaction correctly. */ longDesc: () => LocalizedString } - allowDuplicates: { + amount: { /** - * Allow Duplicates + * Amount */ displayName: () => LocalizedString /** - * Permit duplicate line items + * Transaction amount */ shortDesc: () => LocalizedString /** - * Whether identical line items can be added multiple times to the order + * The numerical value of the transaction, such as the amount paid or refunded. */ longDesc: () => LocalizedString } - itemName: { + currency: { /** - * Item Name + * Currency */ displayName: () => LocalizedString /** - * Name of the product + * Transaction currency */ shortDesc: () => LocalizedString /** - * The display name or title of the product being added + * The ISO 4217 currency code for the transaction amount, e.g., "USD", "EUR". */ longDesc: () => LocalizedString } - price: { + type: { /** - * Price + * Type */ displayName: () => LocalizedString /** - * Price of the line item + * Transaction type */ shortDesc: () => LocalizedString /** - * The unit price of the product being added to the order + * The type of transaction, such as "authorization", "capture", "sale", or "refund". Defines the transaction’s purpose. */ longDesc: () => LocalizedString } - currency: { + parentTransactionId: { /** - * Currency + * Parent Transaction ID */ displayName: () => LocalizedString /** - * Currency of the price + * ID of parent transaction */ shortDesc: () => LocalizedString /** - * The currency in which the price is specified + * The ID of a previous transaction this one relates to, e.g., for refunds or captures linked to an authorization. */ longDesc: () => LocalizedString } - isTaxable: { + gateway: { /** - * Is Taxable + * Gateway */ displayName: () => LocalizedString /** - * Whether item is subject to tax + * Payment gateway */ shortDesc: () => LocalizedString /** - * Indicates if the line item should have tax applied + * The payment gateway used for the transaction, e.g., "shopify_payments", "paypal", or a custom gateway name. */ longDesc: () => LocalizedString } - isPhysical: { + finalCapture: { /** - * Is Physical + * Final Capture */ displayName: () => LocalizedString /** - * Physical vs digital product + * Complete capture flag */ shortDesc: () => LocalizedString /** - * Specifies whether the item is a physical product requiring shipping + * If true, indicates this is the final capture of funds for an authorization; if false, partial captures may follow. */ longDesc: () => LocalizedString } } } - 'create-gift-card': { + 'create-company': { /** - * Create Gift Card + * Create Company */ displayName: () => LocalizedString /** - * Generate a new gift card + * Creates a new company in Shopify */ shortDesc: () => LocalizedString /** - * Create a gift card with customizable parameters like initial value, expiration, and recipient details + * Adds a new company entity to Shopify, typically for B2B purposes, including contact and location details for wholesale or enterprise customers. */ longDesc: () => LocalizedString options: { - initialValue: { + companyName: { /** - * Initial Value + * Name */ displayName: () => LocalizedString /** - * Starting balance of gift card + * Company name */ shortDesc: () => LocalizedString /** - * The initial monetary amount loaded onto the gift card + * The official name of the company, used for identification and display purposes. */ longDesc: () => LocalizedString } - customerId: { + externalId: { /** - * Customer ID + * External ID */ displayName: () => LocalizedString /** - * ID of gift card recipient + * External identifier */ shortDesc: () => LocalizedString /** - * The unique identifier of the customer receiving the gift card + * A unique identifier from an external system, useful for syncing or referencing the company outside Shopify. */ longDesc: () => LocalizedString } @@ -231843,1747 +237382,1524 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Additional gift card information - */ - shortDesc: () => LocalizedString - /** - * A personal message or additional details about the gift card - */ - longDesc: () => LocalizedString - } - expiresOn: { - /** - * Expiration Date - */ - displayName: () => LocalizedString - /** - * Date when gift card expires - */ - shortDesc: () => LocalizedString - /** - * The date after which the gift card will no longer be valid - */ - longDesc: () => LocalizedString - } - code: { - /** - * Gift Card Code - */ - displayName: () => LocalizedString - /** - * Unique gift card identifier + * Company notes */ shortDesc: () => LocalizedString /** - * The specific code used to redeem the gift card + * Internal notes about the company, such as account details or special instructions. */ longDesc: () => LocalizedString } - templateSuffix: { + customerSince: { /** - * Template Suffix + * Customer Since */ displayName: () => LocalizedString /** - * Customization of gift card template + * Start date */ shortDesc: () => LocalizedString /** - * Optional suffix to customize the gift card's appearance or template + * The date the company became a customer, formatted as a timestamp, useful for tracking tenure. */ longDesc: () => LocalizedString } - recipientAttributes: { + contactProperties: { /** - * Recipient Attributes + * Contact Properties */ displayName: () => LocalizedString /** - * Details about gift card recipient + * Primary contact details */ shortDesc: () => LocalizedString /** - * Additional information about the person receiving the gift card + * Details about the primary contact person for the company. */ longDesc: () => LocalizedString type: { fields: { - id: { + firstName: { /** - * Recipient ID + * First Name */ displayName: () => LocalizedString /** - * Unique identifier for recipient + * Contact first name + */ + shortDesc: () => LocalizedString + /** + * The first name of the company’s primary contact. + */ + longDesc: () => LocalizedString + } + lastName: { + /** + * Last Name + */ + displayName: () => LocalizedString + /** + * Contact last name + */ + shortDesc: () => LocalizedString + /** + * The last name of the company’s primary contact. + */ + longDesc: () => LocalizedString + } + email: { + /** + * Email + */ + displayName: () => LocalizedString + /** + * Contact email */ shortDesc: () => LocalizedString /** - * A unique identifier for the gift card recipient + * The email address of the primary contact, used for communication. */ longDesc: () => LocalizedString } - message: { + phone: { /** - * Recipient Message + * Phone */ displayName: () => LocalizedString /** - * Personal message to recipient + * Contact phone */ shortDesc: () => LocalizedString /** - * A personalized message to accompany the gift card + * The phone number of the primary contact. */ longDesc: () => LocalizedString } - preferredName: { + title: { /** - * Preferred Name + * Title */ displayName: () => LocalizedString /** - * Recipient's preferred name + * Contact job title */ shortDesc: () => LocalizedString /** - * The name the recipient prefers to be called + * The job title or role of the primary contact within the company. */ longDesc: () => LocalizedString } - sendNotificationAt: { + locale: { /** - * Notification Timing + * Locale */ displayName: () => LocalizedString /** - * When to send gift card notification + * Contact language/region */ shortDesc: () => LocalizedString /** - * The specific time or date to send the gift card notification + * The preferred language and region code for the contact, e.g., "en-US". */ longDesc: () => LocalizedString } } } } - } - } - 'create-fulfillment': { - /** - * Create Fulfillment - */ - displayName: () => LocalizedString - /** - * Process and ship an order - */ - shortDesc: () => LocalizedString - /** - * Create a fulfillment for an order, handling shipping and tracking information - */ - longDesc: () => LocalizedString - options: { - fulfillmentOrderId: { - /** - * Fulfillment Order ID - */ - displayName: () => LocalizedString - /** - * Unique fulfillment order identifier - */ - shortDesc: () => LocalizedString - /** - * The specific fulfillment order being processed - */ - longDesc: () => LocalizedString - } - fulfillmentOrderLineItems: { - /** - * Fulfillment Order Line Items - */ - displayName: () => LocalizedString - /** - * Items in the fulfillment order - */ - shortDesc: () => LocalizedString - /** - * Specific line items within the fulfillment order - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - id: { - /** - * Line Item ID - */ - displayName: () => LocalizedString - /** - * Unique identifier for line item - */ - shortDesc: () => LocalizedString - /** - * The specific identifier for an individual line item - */ - longDesc: () => LocalizedString - } - quantity: { - /** - * Quantity - */ - displayName: () => LocalizedString - /** - * Number of items to fulfill - */ - shortDesc: () => LocalizedString - /** - * The quantity of the specific item being fulfilled - */ - longDesc: () => LocalizedString - } - } - } - } - } - notifyCustomer: { - /** - * Notify Customer - */ - displayName: () => LocalizedString - /** - * Send shipping notification - */ - shortDesc: () => LocalizedString - /** - * Determines whether to send a notification to the customer about the fulfillment - */ - longDesc: () => LocalizedString - } - trackingInfo: { + locationProperties: { /** - * Tracking Information + * Location Properties */ displayName: () => LocalizedString /** - * Shipping tracking details + * Company location details */ shortDesc: () => LocalizedString /** - * Information for tracking the shipment + * Details about the company’s physical location, including shipping and billing addresses. */ longDesc: () => LocalizedString type: { fields: { - number: { + locationName: { /** - * Tracking Number + * Location Name */ displayName: () => LocalizedString /** - * Shipment tracking number + * Name of location */ shortDesc: () => LocalizedString /** - * The unique identifier for tracking the shipment + * A descriptive name for this company location, e.g., "Headquarters". */ longDesc: () => LocalizedString } - url: { + phone: { /** - * Tracking URL + * Phone */ displayName: () => LocalizedString /** - * Link to track shipment + * Location phone */ shortDesc: () => LocalizedString /** - * The web address where the shipment can be tracked + * The phone number associated with this company location. */ longDesc: () => LocalizedString } - company: { + note: { /** - * Shipping Company + * Note */ displayName: () => LocalizedString /** - * Name of shipping carrier + * Location notes */ shortDesc: () => LocalizedString /** - * The name of the company responsible for shipping + * Internal notes about this location, such as delivery instructions. */ longDesc: () => LocalizedString } - } - } - } - message: { - /** - * Message - */ - displayName: () => LocalizedString - /** - * Additional fulfillment notes - */ - shortDesc: () => LocalizedString - /** - * Any additional information or notes about the fulfillment - */ - longDesc: () => LocalizedString - } - originAddress: { - /** - * Origin Address - */ - displayName: () => LocalizedString - /** - * Shipping origin location - */ - shortDesc: () => LocalizedString - /** - * The address from which the items are being shipped - */ - longDesc: () => LocalizedString - type: { - fields: { - address1: { + externalId: { /** - * Address Line 1 + * External ID */ displayName: () => LocalizedString /** - * Primary address line + * Location external ID */ shortDesc: () => LocalizedString /** - * The first line of the shipping origin address + * An external identifier for this location, useful for integration with other systems. */ longDesc: () => LocalizedString } - address2: { + taxExempt: { /** - * Address Line 2 + * Tax Exempt */ displayName: () => LocalizedString /** - * Secondary address line + * Tax exemption status */ shortDesc: () => LocalizedString /** - * Optional additional address information + * Indicates if this location is exempt from taxes. */ longDesc: () => LocalizedString } - city: { + taxRegistrationId: { /** - * City + * Tax Registration ID */ displayName: () => LocalizedString /** - * City of origin + * Tax ID */ shortDesc: () => LocalizedString /** - * The city from which the shipment originates + * The tax registration number for this location, e.g., VAT or EIN. */ longDesc: () => LocalizedString } - countryCode: { + taxExemptions: { /** - * Country Code + * Tax Exemptions */ displayName: () => LocalizedString /** - * Origin country code + * Specific tax exemptions */ shortDesc: () => LocalizedString /** - * The two-letter country code for the shipping origin + * A list of specific tax exemptions applied to this location. */ longDesc: () => LocalizedString + type: { + element_type: { + /** + * Tax Exemption Type + */ + displayName: () => LocalizedString + /** + * Type of exemption + */ + shortDesc: () => LocalizedString + /** + * Defines the specific tax exemption, e.g., "GST", "VAT". + */ + longDesc: () => LocalizedString + } + } } - provinceCode: { + locale: { /** - * Province Code + * Locale */ displayName: () => LocalizedString /** - * State or province code + * Location language/region */ shortDesc: () => LocalizedString /** - * The code representing the state or province of origin + * The preferred language and region code for this location, e.g., "en-CA". */ longDesc: () => LocalizedString } - zip: { + shippingAddress: { /** - * Postal Code + * Shipping Address */ displayName: () => LocalizedString /** - * Origin postal code + * Shipping address */ shortDesc: () => LocalizedString /** - * The postal code of the shipping origin + * The address where goods are shipped for this company location. + */ + longDesc: () => LocalizedString + type: { + fields: { + address1: { + /** + * Address Line 1 + */ + displayName: () => LocalizedString + /** + * Primary shipping line + */ + shortDesc: () => LocalizedString + /** + * The street address or PO Box for shipping. + */ + longDesc: () => LocalizedString + } + address2: { + /** + * Address Line 2 + */ + displayName: () => LocalizedString + /** + * Secondary shipping line + */ + shortDesc: () => LocalizedString + /** + * Additional shipping address details, e.g., suite number. + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * Shipping city + */ + shortDesc: () => LocalizedString + /** + * The city for the shipping address. + */ + longDesc: () => LocalizedString + } + zoneCode: { + /** + * Zone Code + */ + displayName: () => LocalizedString + /** + * Province/state code + */ + shortDesc: () => LocalizedString + /** + * The code for the province or state, e.g., "CA" for California. + */ + longDesc: () => LocalizedString + } + countryCode: { + /** + * Country Code + */ + displayName: () => LocalizedString + /** + * Country code + */ + shortDesc: () => LocalizedString + /** + * The ISO 3166-1 alpha-2 country code, e.g., "US". + */ + longDesc: () => LocalizedString + } + zip: { + /** + * ZIP/Postal Code + */ + displayName: () => LocalizedString + /** + * Shipping postal code + */ + shortDesc: () => LocalizedString + /** + * The ZIP or postal code for the shipping address. + */ + longDesc: () => LocalizedString + } + } + } + } + billingSameAsShipping: { + /** + * Billing Same as Shipping + */ + displayName: () => LocalizedString + /** + * Use shipping for billing + */ + shortDesc: () => LocalizedString + /** + * If true, the shipping address is also used as the billing address. + */ + longDesc: () => LocalizedString + } + billingAddress: { + /** + * Billing Address + */ + displayName: () => LocalizedString + /** + * Billing address + */ + shortDesc: () => LocalizedString + /** + * The address used for billing purposes, if different from shipping. */ longDesc: () => LocalizedString + type: { + fields: { + address1: { + /** + * Address Line 1 + */ + displayName: () => LocalizedString + /** + * Primary billing line + */ + shortDesc: () => LocalizedString + /** + * The street address or PO Box for billing. + */ + longDesc: () => LocalizedString + } + address2: { + /** + * Address Line 2 + */ + displayName: () => LocalizedString + /** + * Secondary billing line + */ + shortDesc: () => LocalizedString + /** + * Additional billing address details, e.g., apartment number. + */ + longDesc: () => LocalizedString + } + city: { + /** + * City + */ + displayName: () => LocalizedString + /** + * Billing city + */ + shortDesc: () => LocalizedString + /** + * The city for the billing address. + */ + longDesc: () => LocalizedString + } + zoneCode: { + /** + * Zone Code + */ + displayName: () => LocalizedString + /** + * Province/state code + */ + shortDesc: () => LocalizedString + /** + * The code for the province or state, e.g., "NY". + */ + longDesc: () => LocalizedString + } + countryCode: { + /** + * Country Code + */ + displayName: () => LocalizedString + /** + * Country code + */ + shortDesc: () => LocalizedString + /** + * The ISO 3166-1 alpha-2 country code, e.g., "CA". + */ + longDesc: () => LocalizedString + } + zip: { + /** + * ZIP/Postal Code + */ + displayName: () => LocalizedString + /** + * Billing postal code + */ + shortDesc: () => LocalizedString + /** + * The ZIP or postal code for the billing address. + */ + longDesc: () => LocalizedString + } + } + } } } } } } } - 'create-draft-order': { + } + expressions: { + '&&': { + /** + * And + */ + displayName: () => LocalizedString + /** + * Logical AND operator + */ + shortDesc: () => LocalizedString + /** + * Combines multiple conditions where all must be true + */ + longDesc: () => LocalizedString + } + '||': { + /** + * Or + */ + displayName: () => LocalizedString + /** + * Logical OR operator + */ + shortDesc: () => LocalizedString + /** + * Combines multiple conditions where at least one must be true + */ + longDesc: () => LocalizedString + } + '==': { + /** + * Equals + */ + displayName: () => LocalizedString + /** + * Field equals value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field equals the specified value + */ + longDesc: () => LocalizedString + } + '!=': { + /** + * Not Equals + */ + displayName: () => LocalizedString + /** + * Field does not equal value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field does not equal the specified value + */ + longDesc: () => LocalizedString + } + '>': { + /** + * Greater Than + */ + displayName: () => LocalizedString + /** + * Field is greater than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than the specified value + */ + longDesc: () => LocalizedString + } + '>=': { + /** + * Greater Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is greater than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is greater than or equal to the specified value + */ + longDesc: () => LocalizedString + } + '<': { + /** + * Less Than + */ + displayName: () => LocalizedString + /** + * Field is less than value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than the specified value + */ + longDesc: () => LocalizedString + } + '<=': { + /** + * Less Than or Equal + */ + displayName: () => LocalizedString + /** + * Field is less than or equal to value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field value is less than or equal to the specified value + */ + longDesc: () => LocalizedString + } + contains: { + /** + * Contains + */ + displayName: () => LocalizedString + /** + * Field contains value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field contains the specified text (case-insensitive) + */ + longDesc: () => LocalizedString + } + 'is-set': { + /** + * Is Set + */ + displayName: () => LocalizedString + /** + * Field has a value + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field has a non-empty value + */ + longDesc: () => LocalizedString + } + 'is-not-set': { + /** + * Is Not Set + */ + displayName: () => LocalizedString + /** + * Field is empty + */ + shortDesc: () => LocalizedString + /** + * Matches records where the field is empty or not set + */ + longDesc: () => LocalizedString + } + } + searchOptions: { + orderBy: { + /** + * Order By + */ + displayName: () => LocalizedString + /** + * Sort results by a specific field + */ + shortDesc: () => LocalizedString + /** + * Define the field and direction to sort search results + */ + longDesc: () => LocalizedString + type: { + fields: { + field: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to sort by + */ + shortDesc: () => LocalizedString + /** + * The name of the field to use for sorting results + */ + longDesc: () => LocalizedString + } + direction: { + /** + * Direction + */ + displayName: () => LocalizedString + /** + * Sort direction + */ + shortDesc: () => LocalizedString + /** + * The direction to sort results (ascending or descending) + */ + longDesc: () => LocalizedString + } + } + } + } + } + triggers: { + 'shopify-abandoned-cart-trigger': { + /** + * Shopify New Abandoned Cart + */ + displayName: () => LocalizedString + /** + * Triggers when a customer abandons a checkout in Shopify + */ + shortDesc: () => LocalizedString + /** + * This trigger activates when a Shopify checkout is created but not completed within the specified time window. Use this to send recovery emails, offer discounts, or analyze cart abandonment patterns. + */ + longDesc: () => LocalizedString + options: { + abandonedHours: { + /** + * Abandoned Hours + */ + displayName: () => LocalizedString + /** + * Time window to consider a cart abandoned + */ + shortDesc: () => LocalizedString + /** + * Specify how many hours must pass since cart creation without completion for it to be considered abandoned. Values range from 1 hour to 168 hours (one week). + */ + longDesc: () => LocalizedString + } + } + } + 'shopify-blog-trigger': { + /** + * Shopify Blog Created + */ + displayName: () => LocalizedString + /** + * Triggers when a new blog is created in Shopify + */ + shortDesc: () => LocalizedString + /** + * This trigger activates whenever a new blog (not an article) is created in your Shopify store. Use this to monitor blog creation or automate follow-up tasks. + */ + longDesc: () => LocalizedString + } + 'shopify-blog-entry-trigger': { + /** + * Shopify New Blog Article + */ + displayName: () => LocalizedString + /** + * Triggers when a blog article is created or published + */ + shortDesc: () => LocalizedString + /** + * This trigger activates when a new article is created or published in a specified Shopify blog. Use this to automate social media sharing, email notifications, or content distribution workflows. + */ + longDesc: () => LocalizedString + options: { + blog_title: { + /** + * Blog + */ + displayName: () => LocalizedString + /** + * Select the blog to monitor + */ + shortDesc: () => LocalizedString + /** + * Choose which Shopify blog to monitor for new articles. + */ + longDesc: () => LocalizedString + } + entryStatus: { + /** + * Article Status + */ + displayName: () => LocalizedString + /** + * Filter articles by publication status + */ + shortDesc: () => LocalizedString + /** + * Choose whether to trigger on all articles, only published articles, or only draft articles. + */ + longDesc: () => LocalizedString + } + } + } + 'shopify-customer-created-trigger': { + /** + * Shopify Customer Created + */ + displayName: () => LocalizedString + /** + * Triggers when a new customer account is created + */ + shortDesc: () => LocalizedString + /** + * This trigger activates whenever a new customer registers or is created in your Shopify store. Use this to send welcome emails, add customers to marketing lists, or create records in other systems. + */ + longDesc: () => LocalizedString + } + 'shopify-customer-updated-trigger': { + /** + * Shopify Customer Updated + */ + displayName: () => LocalizedString + /** + * Triggers when customer information is modified + */ + shortDesc: () => LocalizedString + /** + * This trigger activates whenever customer information is updated in your Shopify store. Use this to sync customer data with other systems, track specific customer changes, or update marketing preferences. + */ + longDesc: () => LocalizedString + } + 'shopify-new-order-trigger': { + /** + * Shopify New Order + */ + displayName: () => LocalizedString + /** + * Triggers when a new order is placed with the specified status + */ + shortDesc: () => LocalizedString + /** + * This trigger activates when a new order is created in your Shopify store that matches the specified status filter. Use this to process orders, update inventory in other systems, or send custom notifications based on order status. + */ + longDesc: () => LocalizedString + options: { + orderStatus: { + /** + * Order Status + */ + displayName: () => LocalizedString + /** + * Filter orders by their status + */ + shortDesc: () => LocalizedString + /** + * Select which type of orders to monitor based on their status (e.g., any, paid, fulfilled, cancelled). This lets you create different workflows for different order conditions. + */ + longDesc: () => LocalizedString + } + } + } + } + } + Zoom: { + /** + * Zoom + */ + displayName: () => LocalizedString + groups: { + /** + * Video Conferencing & Meetings + */ + '0': () => LocalizedString + } + /** + * Video conferencing and online meeting platform + */ + shortDesc: () => LocalizedString + /** + * Zoom is a video conferencing and online meeting platform that allows users to host and join virtual meetings, webinars, and video conferences. It offers features such as screen sharing, recording, and chat functionalities to enhance collaboration and communication among participants. + */ + longDesc: () => LocalizedString + actions: { + meetingDelete: { + groups: { + /** + * Meetings + */ + '0': () => LocalizedString + } + } + meeting: { + groups: { + /** + * Meetings + */ + '0': () => LocalizedString + } + } + meetingUpdate: { + groups: { + /** + * Meetings + */ + '0': () => LocalizedString + } + } + meetings: { + groups: { + /** + * Meetings + */ + '0': () => LocalizedString + } + } + meetingCreate: { + groups: { + /** + * Meetings + */ + '0': () => LocalizedString + } + } + Getameetingsummary: { + groups: { + /** + * Meetings + */ + '0': () => LocalizedString + } + } + meetingRegistrants: { + groups: { + /** + * Meeting Registrants + */ + '0': () => LocalizedString + } + } + meetingRegistrantCreate: { + groups: { + /** + * Meeting Registrants + */ + '0': () => LocalizedString + } + } + pastMeetingParticipants: { + groups: { + /** + * Meeting Participants + */ + '0': () => LocalizedString + } + } + recordingDelete: { + groups: { + /** + * Recordings + */ + '0': () => LocalizedString + } + } + recordingGet: { + groups: { + /** + * Recordings + */ + '0': () => LocalizedString + } + } + recordingsList: { + groups: { + /** + * Recordings + */ + '0': () => LocalizedString + } + } + webinars: { + groups: { + /** + * Webinars + */ + '0': () => LocalizedString + } + } + webinarCreate: { + groups: { + /** + * Webinars + */ + '0': () => LocalizedString + } + } + webinarDelete: { + groups: { + /** + * Webinars + */ + '0': () => LocalizedString + } + } + webinar: { + groups: { + /** + * Webinars + */ + '0': () => LocalizedString + } + } + webinarUpdate: { + groups: { + /** + * Webinars + */ + '0': () => LocalizedString + } + } + webinarRegistrants: { + groups: { + /** + * Webinar Registrants + */ + '0': () => LocalizedString + } + } + webinarRegistrantCreate: { + groups: { + /** + * Webinar Registrants + */ + '0': () => LocalizedString + } + } + listWebinarParticipants: { + groups: { + /** + * Webinar Participants + */ + '0': () => LocalizedString + } + } + } + triggers: { + new_meeting: { + /** + * New Meeting + */ + displayName: () => LocalizedString + /** + * Triggers when a Zoom meeting is created, started, or ended. + */ + shortDesc: () => LocalizedString + /** + * Monitors Zoom meetings and triggers when meetings are created, started (live), or ended (previous meetings) based on the selected event type. Returns meeting details including topic, duration, join URL, and meeting type. + */ + longDesc: () => LocalizedString + options: { + meeting_event_type: { + /** + * Meeting Event Type + */ + displayName: () => LocalizedString + /** + * Type of meeting event to monitor + */ + shortDesc: () => LocalizedString + /** + * Specifies which type of meeting event should trigger this action. Choose "any" to trigger on all meeting creations, "live" for when meetings start, or "previous_meetings" for when meetings end. + */ + longDesc: () => LocalizedString + } + } + } + new_webinar: { + /** + * New Webinar + */ + displayName: () => LocalizedString + /** + * Triggers when a new Zoom webinar is created. + */ + shortDesc: () => LocalizedString + /** + * Monitors Zoom webinars and triggers when new webinars are created. Returns webinar details including topic, duration, join URL, registration URL, and webinar type. + */ + longDesc: () => LocalizedString + } + new_meeting_summary: { /** - * Create Draft Order + * New Meeting Summary */ displayName: () => LocalizedString /** - * Creates a new draft order in Shopify + * Triggers when a new Zoom meeting summary is created. */ shortDesc: () => LocalizedString /** - * Generates a draft order that can be used to create an order manually, send invoices, or process payments later. Draft orders are useful for custom sales, wholesale orders, or pre-orders. + * Monitors Zoom meeting summaries and triggers when new summaries are generated after meetings end. Returns summary details including meeting information, host details, and summary timestamps. + */ + longDesc: () => LocalizedString + } + } + } + Confluence: { + /** + * Confluence + */ + displayName: () => LocalizedString + groups: { + /** + * Documents & Documentation + */ + '0': () => LocalizedString + } + /** + * Confluence is a collaboration tool used to help teams collaborate and share knowledge efficiently. + */ + shortDesc: () => LocalizedString + /** + * Confluence is a powerful collaboration tool that allows teams to create, share, and manage content in a centralized platform. It is designed to enhance team productivity by providing a space for documentation, project management, and knowledge sharing. With features like real-time editing, commenting, and integration with other tools, Confluence helps teams work together more effectively. + */ + longDesc: () => LocalizedString + triggers: { + new_attachment: { + /** + * New Attachment + */ + displayName: () => LocalizedString + /** + * Triggers when a new attachment is uploaded to Confluence. + */ + shortDesc: () => LocalizedString + /** + * Monitors Confluence for newly uploaded attachments with optional filtering by status and media type. Triggers when new attachments are detected. */ longDesc: () => LocalizedString options: { - customerId: { - /** - * Customer ID - */ - displayName: () => LocalizedString - /** - * The ID of the customer for the draft order - */ - shortDesc: () => LocalizedString - /** - * Specifies the unique identifier of the customer to associate with this draft order. Required if not using default address. - */ - longDesc: () => LocalizedString - } - email: { + status: { /** - * Email + * Status */ displayName: () => LocalizedString /** - * Customer email address + * Filter by attachment status */ shortDesc: () => LocalizedString /** - * The email address of the customer, used for notifications and order confirmation. + * Filter attachments by their status (current, archived, or trashed). */ longDesc: () => LocalizedString } - phone: { + mediaType: { /** - * Phone + * Media Type */ displayName: () => LocalizedString /** - * Customer phone number + * Filter by media type */ shortDesc: () => LocalizedString /** - * The phone number of the customer, useful for shipping updates or contact purposes. + * Filter attachments by their media type (e.g., image/png, application/pdf). */ longDesc: () => LocalizedString } - note: { + } + } + new_blogpost: { + /** + * New Blogpost + */ + displayName: () => LocalizedString + /** + * Triggers when a new blogpost is created in Confluence. + */ + shortDesc: () => LocalizedString + /** + * Monitors Confluence for newly created blogposts with optional filtering by space, status, and body format. Triggers when new blogposts are detected. + */ + longDesc: () => LocalizedString + options: { + space_id: { /** - * Note + * Space ID */ displayName: () => LocalizedString /** - * Additional notes for the draft order + * Filter by Confluence space */ shortDesc: () => LocalizedString /** - * A field for adding internal notes about the draft order, such as special instructions or context. + * Filter blogposts by the Confluence space they belong to. */ longDesc: () => LocalizedString } - taxExempt: { + status: { /** - * Tax Exempt + * Status */ displayName: () => LocalizedString /** - * Exempt order from taxes + * Filter by blogpost status */ shortDesc: () => LocalizedString /** - * Indicates whether the entire order is exempt from taxes. Set to true for tax-exempt customers. + * Filter blogposts by their status (current, deleted, or trashed). */ longDesc: () => LocalizedString } - taxExemptions: { + body_format: { /** - * Tax Exemptions + * Body Format */ displayName: () => LocalizedString /** - * Specific tax exemptions + * Content format to retrieve */ shortDesc: () => LocalizedString /** - * List of specific tax exemptions applied to the draft order, such as regional or product-specific exemptions. + * The format to retrieve the blogpost content in (storage format or Atlas Document Format). */ longDesc: () => LocalizedString - type: { - element_type: { - /** - * Tax Exemption Type - */ - displayName: () => LocalizedString - /** - * Type of tax exemption - */ - shortDesc: () => LocalizedString - /** - * Defines the specific tax exemption applied, e.g., GST, VAT, or sales tax. - */ - longDesc: () => LocalizedString - } - } } - tags: { + } + } + new_page: { + /** + * New Page + */ + displayName: () => LocalizedString + /** + * Triggers when a new page is created in Confluence. + */ + shortDesc: () => LocalizedString + /** + * Monitors Confluence for newly created pages with optional filtering by space, status, body format, and subtype. Triggers when new pages are detected. + */ + longDesc: () => LocalizedString + options: { + space_id: { /** - * Tags + * Space ID */ displayName: () => LocalizedString /** - * Tags for the draft order + * Filter by Confluence space */ shortDesc: () => LocalizedString /** - * A list of tags to categorize or filter the draft order, e.g., "wholesale", "pre-order". + * Filter pages by the Confluence space they belong to. */ longDesc: () => LocalizedString - type: { - element_type: { - /** - * Tag - */ - displayName: () => LocalizedString - /** - * Single tag value - */ - shortDesc: () => LocalizedString - /** - * A single string value used to tag the draft order for organization or search purposes. - */ - longDesc: () => LocalizedString - } - } } - shippingAddress: { + status: { /** - * Shipping Address + * Status */ displayName: () => LocalizedString /** - * Customer shipping address + * Filter by page status */ shortDesc: () => LocalizedString /** - * The full shipping address where the order will be delivered, including all relevant fields. + * Filter pages by their status (current, archived, deleted, or trashed). */ longDesc: () => LocalizedString - type: { - fields: { - address1: { - /** - * Address Line 1 - */ - displayName: () => LocalizedString - /** - * Primary address line - */ - shortDesc: () => LocalizedString - /** - * The street address or PO Box for shipping. - */ - longDesc: () => LocalizedString - } - address2: { - /** - * Address Line 2 - */ - displayName: () => LocalizedString - /** - * Secondary address line - */ - shortDesc: () => LocalizedString - /** - * Additional address information like apartment or suite number. - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * Shipping city - */ - shortDesc: () => LocalizedString - /** - * The city for the shipping address. - */ - longDesc: () => LocalizedString - } - province: { - /** - * Province/State - */ - displayName: () => LocalizedString - /** - * Shipping province or state - */ - shortDesc: () => LocalizedString - /** - * The province, state, or region for the shipping address. - */ - longDesc: () => LocalizedString - } - country: { - /** - * Country - */ - displayName: () => LocalizedString - /** - * Shipping country - */ - shortDesc: () => LocalizedString - /** - * The country for the shipping address. - */ - longDesc: () => LocalizedString - } - zip: { - /** - * ZIP/Postal Code - */ - displayName: () => LocalizedString - /** - * Shipping postal code - */ - shortDesc: () => LocalizedString - /** - * The ZIP or postal code for the shipping address. - */ - longDesc: () => LocalizedString - } - firstName: { - /** - * First Name - */ - displayName: () => LocalizedString - /** - * Recipient first name - */ - shortDesc: () => LocalizedString - /** - * The first name of the shipping recipient. - */ - longDesc: () => LocalizedString - } - lastName: { - /** - * Last Name - */ - displayName: () => LocalizedString - /** - * Recipient last name - */ - shortDesc: () => LocalizedString - /** - * The last name of the shipping recipient. - */ - longDesc: () => LocalizedString - } - company: { - /** - * Company - */ - displayName: () => LocalizedString - /** - * Shipping company name - */ - shortDesc: () => LocalizedString - /** - * The company name associated with the shipping address, if applicable. - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone - */ - displayName: () => LocalizedString - /** - * Shipping contact phone - */ - shortDesc: () => LocalizedString - /** - * The phone number for the shipping recipient. - */ - longDesc: () => LocalizedString - } - } - } } - billingAddress: { + body_format: { /** - * Billing Address + * Body Format */ displayName: () => LocalizedString /** - * Customer billing address + * Content format to retrieve */ shortDesc: () => LocalizedString /** - * The address used for billing purposes, which may differ from the shipping address. + * The format to retrieve the page content in (storage format or Atlas Document Format). */ longDesc: () => LocalizedString - type: { - fields: { - address1: { - /** - * Address Line 1 - */ - displayName: () => LocalizedString - /** - * Primary billing address line - */ - shortDesc: () => LocalizedString - /** - * The street address or PO Box for billing. - */ - longDesc: () => LocalizedString - } - address2: { - /** - * Address Line 2 - */ - displayName: () => LocalizedString - /** - * Secondary billing address line - */ - shortDesc: () => LocalizedString - /** - * Additional billing address information like apartment or suite number. - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * Billing city - */ - shortDesc: () => LocalizedString - /** - * The city for the billing address. - */ - longDesc: () => LocalizedString - } - province: { - /** - * Province/State - */ - displayName: () => LocalizedString - /** - * Billing province or state - */ - shortDesc: () => LocalizedString - /** - * The province, state, or region for the billing address. - */ - longDesc: () => LocalizedString - } - country: { - /** - * Country - */ - displayName: () => LocalizedString - /** - * Billing country - */ - shortDesc: () => LocalizedString - /** - * The country for the billing address. - */ - longDesc: () => LocalizedString - } - zip: { - /** - * ZIP/Postal Code - */ - displayName: () => LocalizedString - /** - * Billing postal code - */ - shortDesc: () => LocalizedString - /** - * The ZIP or postal code for the billing address. - */ - longDesc: () => LocalizedString - } - firstName: { - /** - * First Name - */ - displayName: () => LocalizedString - /** - * Billing first name - */ - shortDesc: () => LocalizedString - /** - * The first name of the billing contact. - */ - longDesc: () => LocalizedString - } - lastName: { - /** - * Last Name - */ - displayName: () => LocalizedString - /** - * Billing last name - */ - shortDesc: () => LocalizedString - /** - * The last name of the billing contact. - */ - longDesc: () => LocalizedString - } - company: { - /** - * Company - */ - displayName: () => LocalizedString - /** - * Billing company name - */ - shortDesc: () => LocalizedString - /** - * The company name associated with the billing address, if applicable. - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone - */ - displayName: () => LocalizedString - /** - * Billing contact phone - */ - shortDesc: () => LocalizedString - /** - * The phone number for the billing contact. - */ - longDesc: () => LocalizedString - } - } - } } - useCustomerDefaultAddress: { + subtype: { /** - * Use Customer Default Address + * Subtype */ displayName: () => LocalizedString /** - * Use customer’s default address + * Filter by page subtype */ shortDesc: () => LocalizedString /** - * If true, uses the customer’s default shipping and billing address instead of custom ones. + * Filter pages by their subtype (live pages or regular pages). */ longDesc: () => LocalizedString } - lineItems: { - /** - * Line Items - */ - displayName: () => LocalizedString - /** - * Products in the draft order - */ - shortDesc: () => LocalizedString - /** - * A list of products or variants included in the draft order, with details like quantity and price. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - variantId: { - /** - * Variant ID - */ - displayName: () => LocalizedString - /** - * Product variant ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the product variant to include in the order. - */ - longDesc: () => LocalizedString - } - quantity: { - /** - * Quantity - */ - displayName: () => LocalizedString - /** - * Number of items - */ - shortDesc: () => LocalizedString - /** - * The number of units of this variant to include in the draft order. - */ - longDesc: () => LocalizedString - } - title: { - /** - * Title - */ - displayName: () => LocalizedString - /** - * Item title - */ - shortDesc: () => LocalizedString - /** - * The display name of the line item, typically the product or variant name. - */ - longDesc: () => LocalizedString - } - originalUnitPrice: { - /** - * Original Unit Price - */ - displayName: () => LocalizedString - /** - * Price per unit - */ - shortDesc: () => LocalizedString - /** - * The original price per unit of the item before discounts. - */ - longDesc: () => LocalizedString - } - originalUnitPriceWithCurrency: { - /** - * Original Unit Price with Currency - */ - displayName: () => LocalizedString - /** - * Price with currency details - */ - shortDesc: () => LocalizedString - /** - * The original unit price including currency specification. - */ - longDesc: () => LocalizedString - type: { - fields: { - amount: { - /** - * Amount - */ - displayName: () => LocalizedString - /** - * Price amount - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the unit price. - */ - longDesc: () => LocalizedString - } - currencyCode: { - /** - * Currency Code - */ - displayName: () => LocalizedString - /** - * Currency code - */ - shortDesc: () => LocalizedString - /** - * The ISO 4217 currency code for the price, e.g., USD, EUR. - */ - longDesc: () => LocalizedString - } - } - } - } - sku: { - /** - * SKU - */ - displayName: () => LocalizedString - /** - * Stock Keeping Unit - */ - shortDesc: () => LocalizedString - /** - * The stock keeping unit identifier for the product variant. - */ - longDesc: () => LocalizedString - } - requiresShipping: { - /** - * Requires Shipping - */ - displayName: () => LocalizedString - /** - * Needs shipping - */ - shortDesc: () => LocalizedString - /** - * Indicates if the item requires physical shipping. - */ - longDesc: () => LocalizedString - } - taxable: { - /** - * Taxable - */ - displayName: () => LocalizedString - /** - * Subject to tax - */ - shortDesc: () => LocalizedString - /** - * Specifies whether the item is taxable. - */ - longDesc: () => LocalizedString - } - weight: { - /** - * Weight - */ - displayName: () => LocalizedString - /** - * Item weight - */ - shortDesc: () => LocalizedString - /** - * The weight of the item, used for shipping calculations. - */ - longDesc: () => LocalizedString - type: { - fields: { - value: { - /** - * Weight Value - */ - displayName: () => LocalizedString - /** - * Numerical weight - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the item’s weight. - */ - longDesc: () => LocalizedString - } - unit: { - /** - * Weight Unit - */ - displayName: () => LocalizedString - /** - * Unit of weight - */ - shortDesc: () => LocalizedString - /** - * The unit of measurement for the weight, e.g., kg, lb. - */ - longDesc: () => LocalizedString - } - } - } - } - customAttributes: { - /** - * Custom Attributes - */ - displayName: () => LocalizedString - /** - * Additional item attributes - */ - shortDesc: () => LocalizedString - /** - * Key-value pairs for adding custom metadata to the line item. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - key: { - /** - * Key - */ - displayName: () => LocalizedString - /** - * Attribute key - */ - shortDesc: () => LocalizedString - /** - * The identifier for the custom attribute. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Attribute value - */ - shortDesc: () => LocalizedString - /** - * The value associated with the custom attribute key. - */ - longDesc: () => LocalizedString - } - } - } - } - } - appliedDiscount: { - /** - * Applied Discount - */ - displayName: () => LocalizedString - /** - * Discount on item - */ - shortDesc: () => LocalizedString - /** - * Details of any discount applied to this specific line item. - */ - longDesc: () => LocalizedString - type: { - fields: { - title: { - /** - * Discount Title - */ - displayName: () => LocalizedString - /** - * Discount name - */ - shortDesc: () => LocalizedString - /** - * The name or title of the discount. - */ - longDesc: () => LocalizedString - } - description: { - /** - * Discount Description - */ - displayName: () => LocalizedString - /** - * Discount details - */ - shortDesc: () => LocalizedString - /** - * A description of the discount applied. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Discount Value - */ - displayName: () => LocalizedString - /** - * Discount amount or percentage - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the discount, either as a fixed amount or percentage. - */ - longDesc: () => LocalizedString - } - valueType: { - /** - * Value Type - */ - displayName: () => LocalizedString - /** - * Type of discount value - */ - shortDesc: () => LocalizedString - /** - * Specifies if the discount is a fixed amount or percentage (e.g., "FIXED_AMOUNT", "PERCENTAGE"). - */ - longDesc: () => LocalizedString - } - amountWithCurrency: { - /** - * Amount with Currency - */ - displayName: () => LocalizedString - /** - * Discount amount with currency - */ - shortDesc: () => LocalizedString - /** - * The discount amount including currency details. - */ - longDesc: () => LocalizedString - type: { - fields: { - amount: { - /** - * Amount - */ - displayName: () => LocalizedString - /** - * Discount amount - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the discount. - */ - longDesc: () => LocalizedString - } - currencyCode: { - /** - * Currency Code - */ - displayName: () => LocalizedString - /** - * Discount currency - */ - shortDesc: () => LocalizedString - /** - * The ISO 4217 currency code for the discount amount. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } - } - generatePriceOverride: { - /** - * Generate Price Override - */ - displayName: () => LocalizedString - /** - * Override item price - */ - shortDesc: () => LocalizedString - /** - * If true, allows setting a custom price for the item instead of the original price. - */ - longDesc: () => LocalizedString - } - priceOverride: { - /** - * Price Override - */ - displayName: () => LocalizedString - /** - * Custom item price - */ - shortDesc: () => LocalizedString - /** - * The custom price to override the original unit price. - */ - longDesc: () => LocalizedString - type: { - fields: { - amount: { - /** - * Amount - */ - displayName: () => LocalizedString - /** - * Override amount - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the custom price. - */ - longDesc: () => LocalizedString - } - currencyCode: { - /** - * Currency Code - */ - displayName: () => LocalizedString - /** - * Override currency - */ - shortDesc: () => LocalizedString - /** - * The ISO 4217 currency code for the custom price. - */ - longDesc: () => LocalizedString - } - } - } - } - components: { - /** - * Components - */ - displayName: () => LocalizedString - /** - * Bundle components - */ - shortDesc: () => LocalizedString - /** - * Details of components if the item is a bundle or composite product. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - quantity: { - /** - * Quantity - */ - displayName: () => LocalizedString - /** - * Component quantity - */ - shortDesc: () => LocalizedString - /** - * The number of units of this component in the bundle. - */ - longDesc: () => LocalizedString - } - variantId: { - /** - * Variant ID - */ - displayName: () => LocalizedString - /** - * Component variant ID - */ - shortDesc: () => LocalizedString - /** - * The unique identifier of the variant included as a component. - */ - longDesc: () => LocalizedString - } - } - } - } - } - uuid: { - /** - * UUID - */ - displayName: () => LocalizedString - /** - * Unique identifier - */ - shortDesc: () => LocalizedString - /** - * A unique identifier for the line item, often used for tracking or external systems. - */ - longDesc: () => LocalizedString - } - } - } - } + } + } + } + } + Contentful: { + /** + * Contentful + */ + displayName: () => LocalizedString + groups: { + /** + * Documents & Documentation + */ + '0': () => LocalizedString + } + /** + * Connect to Contentful to manage your content, assets, and content models + */ + shortDesc: () => LocalizedString + /** + * Integrate with Contentful to automate content management workflows. Create, update, publish, and manage entries, assets, and content types. Monitor content changes with real-time webhook triggers. This integration provides full access to the Contentful Content Management API for comprehensive headless CMS automation. + */ + longDesc: () => LocalizedString + connectionMessage: { + /** + * Connect to Contentful + */ + title: () => LocalizedString + /** + * To connect to Contentful, you will need a **Content Management API (CMA) Token**. + + ## Getting Your CMA Token + + 1. Log in to your [Contentful](https://app.contentful.com) account + 2. Go to **Settings** (gear icon in the top navigation) + 3. Select **CMA tokens** from the left sidebar + 4. Click **Create personal access token** + 5. Give your token a descriptive name (e.g., "Qore Integration") + 6. Click **Generate** and copy the generated token + + **Important:** The token is only shown once. Make sure to copy and save it securely. + + ## Authorizing Your Token for an Organization + + If your Contentful account belongs to an organization, you must **authorize your token** for that organization before it can access spaces: + + 1. Go to your [Personal Access Tokens](https://app.contentful.com/account/profile/cma_tokens) page + 2. Find your token in the list + 3. Click **Authorize** next to the organization you want the token to access + + Without this step, API requests will fail with an `OrganizationAccessGrantRequired` error, even though the token is valid. + + ## Permissions + + The CMA token inherits the permissions of the user who created it. Ensure the user has appropriate access to the spaces and environments you want to manage. + */ + content: () => LocalizedString + } + actions: { + get_entry: { + /** + * Get an Entry + */ + displayName: () => LocalizedString + /** + * Returns attributes of a specific entry + */ + shortDesc: () => LocalizedString + /** + * Retrieves a single entry by its ID from the specified space and environment. Returns all entry fields with their values in the default locale. + */ + longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space containing the entry. + */ + longDesc: () => LocalizedString } - appliedDiscount: { + environment_id: { /** - * Applied Discount + * Environment */ displayName: () => LocalizedString /** - * Order-wide discount + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Details of a discount applied to the entire draft order. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString - type: { - fields: { - title: { - /** - * Discount Title - */ - displayName: () => LocalizedString - /** - * Discount name - */ - shortDesc: () => LocalizedString - /** - * The name or title of the order-wide discount. - */ - longDesc: () => LocalizedString - } - description: { - /** - * Discount Description - */ - displayName: () => LocalizedString - /** - * Discount details - */ - shortDesc: () => LocalizedString - /** - * A description of the order-wide discount. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Discount Value - */ - displayName: () => LocalizedString - /** - * Discount amount or percentage - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the discount, either as a fixed amount or percentage. - */ - longDesc: () => LocalizedString - } - valueType: { - /** - * Value Type - */ - displayName: () => LocalizedString - /** - * Type of discount value - */ - shortDesc: () => LocalizedString - /** - * Specifies if the discount is a fixed amount or percentage (e.g., "FIXED_AMOUNT", "PERCENTAGE"). - */ - longDesc: () => LocalizedString - } - amountWithCurrency: { - /** - * Amount with Currency - */ - displayName: () => LocalizedString - /** - * Discount amount with currency - */ - shortDesc: () => LocalizedString - /** - * The discount amount including currency details. - */ - longDesc: () => LocalizedString - type: { - fields: { - amount: { - /** - * Amount - */ - displayName: () => LocalizedString - /** - * Discount amount - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the discount. - */ - longDesc: () => LocalizedString - } - currencyCode: { - /** - * Currency Code - */ - displayName: () => LocalizedString - /** - * Discount currency - */ - shortDesc: () => LocalizedString - /** - * The ISO 4217 currency code for the discount amount. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } } - shippingLine: { + content_type_id: { /** - * Shipping Line + * Content Type */ displayName: () => LocalizedString /** - * Shipping details + * The content type of the entry */ shortDesc: () => LocalizedString /** - * Details about the shipping method and cost for the draft order. + * Select the content type to filter entries by type. */ longDesc: () => LocalizedString - type: { - fields: { - price: { - /** - * Price - */ - displayName: () => LocalizedString - /** - * Shipping cost - */ - shortDesc: () => LocalizedString - /** - * The cost of shipping as a numerical value. - */ - longDesc: () => LocalizedString - } - priceWithCurrency: { - /** - * Price with Currency - */ - displayName: () => LocalizedString - /** - * Shipping cost with currency - */ - shortDesc: () => LocalizedString - /** - * The shipping cost including currency specification. - */ - longDesc: () => LocalizedString - type: { - fields: { - amount: { - /** - * Amount - */ - displayName: () => LocalizedString - /** - * Shipping amount - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the shipping cost. - */ - longDesc: () => LocalizedString - } - currencyCode: { - /** - * Currency Code - */ - displayName: () => LocalizedString - /** - * Shipping currency - */ - shortDesc: () => LocalizedString - /** - * The ISO 4217 currency code for the shipping cost. - */ - longDesc: () => LocalizedString - } - } - } - } - title: { - /** - * Title - */ - displayName: () => LocalizedString - /** - * Shipping method name - */ - shortDesc: () => LocalizedString - /** - * The name of the shipping method, e.g., "Standard Shipping". - */ - longDesc: () => LocalizedString - } - shippingRateHandle: { - /** - * Shipping Rate Handle - */ - displayName: () => LocalizedString - /** - * Shipping rate identifier - */ - shortDesc: () => LocalizedString - /** - * A unique identifier for the shipping rate, often tied to a predefined rate in Shopify. - */ - longDesc: () => LocalizedString - } - } - } } - customAttributes: { + entry_id: { /** - * Custom Attributes + * Entry */ displayName: () => LocalizedString /** - * Order custom attributes + * The entry to retrieve */ shortDesc: () => LocalizedString /** - * Key-value pairs for adding custom metadata to the draft order. + * Select or enter the ID of the entry to retrieve. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - key: { - /** - * Key - */ - displayName: () => LocalizedString - /** - * Attribute key - */ - shortDesc: () => LocalizedString - /** - * The identifier for the custom attribute. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Attribute value - */ - shortDesc: () => LocalizedString - /** - * The value associated with the custom attribute key. - */ - longDesc: () => LocalizedString - } - } - } - } } - allowDiscountCodesInCheckout: { + } + } + get_entry_with_replacement: { + /** + * Get an Entry with Replacement + */ + displayName: () => LocalizedString + /** + * Replaces text fields with new values using specific tags; returns new values as output + */ + shortDesc: () => LocalizedString + /** + * Retrieves an entry and performs text replacements on all string fields. For each replacement pair, all occurrences of the tag are replaced with the specified value. Useful for template-based content. + */ + longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } + options: { + space_id: { /** - * Allow Discount Codes in Checkout + * Space */ displayName: () => LocalizedString /** - * Enable discount codes + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * If true, allows customers to apply discount codes during checkout from this draft order. + * Select the Contentful space containing the entry. */ longDesc: () => LocalizedString } - acceptAutomaticDiscounts: { + environment_id: { /** - * Accept Automatic Discounts + * Environment */ displayName: () => LocalizedString /** - * Apply automatic discounts + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * If true, automatically applies any eligible store-wide discounts to the draft order. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - discountCodes: { + content_type_id: { /** - * Discount Codes + * Content Type */ displayName: () => LocalizedString /** - * List of discount codes + * The content type of the entry */ shortDesc: () => LocalizedString /** - * A list of discount codes to apply to the draft order. + * Select the content type to filter entries by type. */ longDesc: () => LocalizedString - type: { - element_type: { - /** - * Discount Code - */ - displayName: () => LocalizedString - /** - * Single discount code - */ - shortDesc: () => LocalizedString - /** - * A specific discount code to apply to the order. - */ - longDesc: () => LocalizedString - } - } } - metafields: { + entry_id: { /** - * Metafields + * Entry */ displayName: () => LocalizedString /** - * Custom metadata + * The entry to retrieve and apply replacements to */ shortDesc: () => LocalizedString /** - * Additional metadata fields for the draft order, useful for custom integrations. + * Select or enter the ID of the entry to retrieve. + */ + longDesc: () => LocalizedString + } + replacements: { + /** + * Replacements + */ + displayName: () => LocalizedString + /** + * List of tag/value pairs for text replacement + */ + shortDesc: () => LocalizedString + /** + * Provide a list of replacement pairs. Each pair has a "tag" (placeholder to find) and a "value" (text to replace it with). All string fields in the entry will be processed. */ longDesc: () => LocalizedString type: { element_type: { fields: { - namespace: { - /** - * Namespace - */ - displayName: () => LocalizedString - /** - * Metafield namespace - */ - shortDesc: () => LocalizedString - /** - * A grouping identifier for the metafield. - */ - longDesc: () => LocalizedString - } - key: { + tag: { /** - * Key + * Tag */ displayName: () => LocalizedString /** - * Metafield key + * The tag/placeholder to search for in text fields */ shortDesc: () => LocalizedString /** - * The specific identifier for the metafield. + * The tag or placeholder text to search for within all string fields of the entry. */ longDesc: () => LocalizedString } @@ -233593,25 +238909,11 @@ export type TranslationFunctions = { */ displayName: () => LocalizedString /** - * Metafield value - */ - shortDesc: () => LocalizedString - /** - * The value stored in the metafield. - */ - longDesc: () => LocalizedString - } - type: { - /** - * Type - */ - displayName: () => LocalizedString - /** - * Metafield data type + * The replacement value */ shortDesc: () => LocalizedString /** - * The data type of the metafield value, e.g., string, integer, JSON. + * The text that will replace all occurrences of the tag. */ longDesc: () => LocalizedString } @@ -233619,2495 +238921,2291 @@ export type TranslationFunctions = { } } } - localizedFields: { + } + } + create_entry: { + /** + * Create an Entry + */ + displayName: () => LocalizedString + /** + * Creates a new entry + */ + shortDesc: () => LocalizedString + /** + * Creates a new entry of the specified content type in the given space and environment. Optionally publishes the entry immediately after creation. + */ + longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } + options: { + space_id: { /** - * Localized Fields + * Space */ displayName: () => LocalizedString /** - * Localized content + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * Fields that support localized content for different regions or languages. + * Select the Contentful space where the entry will be created. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Localized value - */ - shortDesc: () => LocalizedString - /** - * The localized content value. - */ - longDesc: () => LocalizedString - } - key: { - /** - * Key - */ - displayName: () => LocalizedString - /** - * Localized field key - */ - shortDesc: () => LocalizedString - /** - * The identifier for the localized field. - */ - longDesc: () => LocalizedString - } - locale: { - /** - * Locale - */ - displayName: () => LocalizedString - /** - * Language/region code - */ - shortDesc: () => LocalizedString - /** - * The locale code for the localized content, e.g., "en-US", "fr-CA". - */ - longDesc: () => LocalizedString - } - } - } - } } - presentmentCurrencyCode: { + environment_id: { /** - * Presentment Currency Code + * Environment */ displayName: () => LocalizedString /** - * Display currency + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * The ISO 4217 currency code for displaying prices to the customer, e.g., USD, CAD. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - poNumber: { + content_type_id: { /** - * PO Number + * Content Type */ displayName: () => LocalizedString /** - * Purchase order number + * The content type for the new entry */ shortDesc: () => LocalizedString /** - * The purchase order number associated with the draft order, often used for B2B transactions. + * Select the content type that defines the schema for the new entry. */ longDesc: () => LocalizedString } - paymentTerms: { + fields: { /** - * Payment Terms + * Fields */ displayName: () => LocalizedString /** - * Payment conditions + * The field values for the new entry */ shortDesc: () => LocalizedString /** - * Defines the payment terms for the draft order, such as due dates or schedules. + * Provide the field values as a key-value object. Keys should match the field IDs of the content type. */ longDesc: () => LocalizedString - type: { - fields: { - paymentTermsTemplateId: { - /** - * Payment Terms Template ID - */ - displayName: () => LocalizedString - /** - * Template identifier - */ - shortDesc: () => LocalizedString - /** - * The ID of a predefined payment terms template in Shopify. - */ - longDesc: () => LocalizedString - } - paymentSchedules: { - /** - * Payment Schedules - */ - displayName: () => LocalizedString - /** - * Payment due dates - */ - shortDesc: () => LocalizedString - /** - * A list of scheduled payments with due dates and amounts. - */ - longDesc: () => LocalizedString - type: { - element_type: { - fields: { - dueAt: { - /** - * Due At - */ - displayName: () => LocalizedString - /** - * Due date - */ - shortDesc: () => LocalizedString - /** - * The date when the payment is due. - */ - longDesc: () => LocalizedString - } - amount: { - /** - * Amount - */ - displayName: () => LocalizedString - /** - * Payment amount - */ - shortDesc: () => LocalizedString - /** - * The numerical value of the payment due. - */ - longDesc: () => LocalizedString - } - currencyCode: { - /** - * Currency Code - */ - displayName: () => LocalizedString - /** - * Payment currency - */ - shortDesc: () => LocalizedString - /** - * The ISO 4217 currency code for the payment amount. - */ - longDesc: () => LocalizedString - } - issuedAt: { - /** - * Issued At - */ - displayName: () => LocalizedString - /** - * Issue date - */ - shortDesc: () => LocalizedString - /** - * The date when the payment schedule was issued. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } - } } - purchasingEntity: { + publish: { /** - * Purchasing Entity + * Publish */ displayName: () => LocalizedString /** - * Buyer details + * Whether to publish the entry after creation */ shortDesc: () => LocalizedString /** - * Details about the entity making the purchase, such as a company or individual. + * If enabled, the entry will be published immediately after creation. Otherwise, it will be saved as a draft. */ longDesc: () => LocalizedString - type: { - fields: { - customerId: { - /** - * Customer ID - */ - displayName: () => LocalizedString - /** - * Purchaser customer ID - */ - shortDesc: () => LocalizedString - /** - * The ID of the customer making the purchase. - */ - longDesc: () => LocalizedString - } - companyId: { - /** - * Company ID - */ - displayName: () => LocalizedString - /** - * Purchaser company ID - */ - shortDesc: () => LocalizedString - /** - * The ID of the company making the purchase. - */ - longDesc: () => LocalizedString - } - companyLocationId: { - /** - * Company Location ID - */ - displayName: () => LocalizedString - /** - * Company location ID - */ - shortDesc: () => LocalizedString - /** - * The ID of the specific company location making the purchase. - */ - longDesc: () => LocalizedString - } - companyContactId: { - /** - * Company Contact ID - */ - displayName: () => LocalizedString - /** - * Contact ID - */ - shortDesc: () => LocalizedString - /** - * The ID of the company contact responsible for the purchase. - */ - longDesc: () => LocalizedString - } - } - } } - reserveInventoryUntil: { + } + } + update_entry: { + /** + * Update an Entry + */ + displayName: () => LocalizedString + /** + * Updates a specific entry by its ID + */ + shortDesc: () => LocalizedString + /** + * Updates an existing entry with new field values. Only the specified fields are updated; other fields remain unchanged. + */ + longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } + options: { + space_id: { /** - * Reserve Inventory Until + * Space */ displayName: () => LocalizedString /** - * Inventory reservation deadline + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * The date and time until which the inventory is reserved for this draft order. + * Select the Contentful space containing the entry. */ longDesc: () => LocalizedString } - sourceName: { + environment_id: { /** - * Source Name + * Environment */ displayName: () => LocalizedString /** - * Order source + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * The source of the draft order, e.g., "web", "manual", or an app name. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - visibleToCustomer: { + content_type_id: { /** - * Visible to Customer + * Content Type */ displayName: () => LocalizedString /** - * Customer visibility + * The content type of the entry */ shortDesc: () => LocalizedString /** - * If true, the draft order is visible to the customer, e.g., in their account. + * Select the content type to filter entries by type. + */ + longDesc: () => LocalizedString + } + entry_id: { + /** + * Entry + */ + displayName: () => LocalizedString + /** + * The entry to update + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the entry to update. + */ + longDesc: () => LocalizedString + } + fields: { + /** + * Fields + */ + displayName: () => LocalizedString + /** + * The field values to update + */ + shortDesc: () => LocalizedString + /** + * Provide the field values to update as a key-value object. Only the specified fields will be changed. */ longDesc: () => LocalizedString } } } - 'create-customer': { + delete_entry: { /** - * Create Customer + * Delete an Entry */ displayName: () => LocalizedString /** - * Creates a new customer in Shopify + * Permanently removes a specific entry */ shortDesc: () => LocalizedString /** - * Adds a new customer to the Shopify store, allowing you to store their contact information, addresses, and marketing preferences for future orders and engagement. + * Permanently deletes an entry from the space. If the entry is published, it will be unpublished first. This action is irreversible. */ longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } options: { - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * Customer email address - */ - shortDesc: () => LocalizedString - /** - * The primary email address of the customer, used for account creation, notifications, and marketing. - */ - longDesc: () => LocalizedString - } - phone: { + space_id: { /** - * Phone + * Space */ displayName: () => LocalizedString /** - * Customer phone number + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * The customer’s phone number, useful for contact purposes and SMS marketing if consented. + * Select the Contentful space containing the entry. */ longDesc: () => LocalizedString } - firstName: { + environment_id: { /** - * First Name + * Environment */ displayName: () => LocalizedString /** - * Customer first name + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * The first name of the customer, used for personalization and address details. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - lastName: { + content_type_id: { /** - * Last Name + * Content Type */ displayName: () => LocalizedString /** - * Customer last name + * The content type of the entry */ shortDesc: () => LocalizedString /** - * The last name of the customer, completing their full name for identification and shipping. + * Select the content type to filter entries by type. */ longDesc: () => LocalizedString } - locale: { + entry_id: { /** - * Locale + * Entry */ displayName: () => LocalizedString /** - * Customer language/region + * The entry to delete */ shortDesc: () => LocalizedString /** - * The preferred language and region code for the customer, e.g., "en-US" or "fr-CA", affecting communication and formatting. + * Select or enter the ID of the entry to permanently remove. */ longDesc: () => LocalizedString } - note: { + } + } + publish_entry: { + /** + * Publish an Entry + */ + displayName: () => LocalizedString + /** + * Changes entry status to "published" + */ + shortDesc: () => LocalizedString + /** + * Publishes a draft entry, making it available through the Content Delivery API. + */ + longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } + options: { + space_id: { /** - * Note + * Space */ displayName: () => LocalizedString /** - * Notes about the customer + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * Internal notes about the customer, such as preferences, special instructions, or account details. + * Select the Contentful space containing the entry. */ longDesc: () => LocalizedString } - taxExempt: { + environment_id: { /** - * Tax Exempt + * Environment */ displayName: () => LocalizedString /** - * Exempt customer from taxes + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Indicates whether the customer is exempt from taxes on all purchases. Set to true for tax-exempt entities. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - taxExemptions: { + content_type_id: { /** - * Tax Exemptions + * Content Type */ displayName: () => LocalizedString /** - * Specific tax exemptions + * The content type to filter entries */ shortDesc: () => LocalizedString /** - * A list of specific tax exemptions applied to the customer, such as regional or category-specific exemptions. + * Select the content type to filter the entry dropdown. */ longDesc: () => LocalizedString - type: { - element_type: { - /** - * Tax Exemption Type - */ - displayName: () => LocalizedString - /** - * Type of tax exemption - */ - shortDesc: () => LocalizedString - /** - * Defines the specific tax exemption applied, e.g., GST, VAT, or sales tax. - */ - longDesc: () => LocalizedString - } - } } - tags: { + entry_id: { /** - * Tags + * Entry */ displayName: () => LocalizedString /** - * Customer tags + * The entry to publish */ shortDesc: () => LocalizedString /** - * A list of tags to categorize or filter the customer, e.g., "VIP", "wholesale", "new". + * Select or enter the ID of the entry to publish. */ longDesc: () => LocalizedString - type: { - element_type: { - /** - * Tag - */ - displayName: () => LocalizedString - /** - * Single tag value - */ - shortDesc: () => LocalizedString - /** - * A single string value used to tag the customer for organization or segmentation. - */ - longDesc: () => LocalizedString - } - } } - addresses: { + } + } + unpublish_entry: { + /** + * Unpublish an Entry + */ + displayName: () => LocalizedString + /** + * Puts an entry back into "draft" state + */ + shortDesc: () => LocalizedString + /** + * Unpublishes an entry, removing it from the Content Delivery API and reverting it to draft state. + */ + longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } + options: { + space_id: { /** - * Addresses + * Space */ displayName: () => LocalizedString /** - * Customer addresses + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * A list of addresses associated with the customer, such as shipping or billing addresses. + * Select the Contentful space containing the entry. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - address1: { - /** - * Address Line 1 - */ - displayName: () => LocalizedString - /** - * Primary address line - */ - shortDesc: () => LocalizedString - /** - * The street address or PO Box for the customer. - */ - longDesc: () => LocalizedString - } - address2: { - /** - * Address Line 2 - */ - displayName: () => LocalizedString - /** - * Secondary address line - */ - shortDesc: () => LocalizedString - /** - * Additional address information like apartment or suite number. - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * Customer city - */ - shortDesc: () => LocalizedString - /** - * The city associated with the customer’s address. - */ - longDesc: () => LocalizedString - } - province: { - /** - * Province/State - */ - displayName: () => LocalizedString - /** - * Customer province or state - */ - shortDesc: () => LocalizedString - /** - * The province, state, or region for the customer’s address. - */ - longDesc: () => LocalizedString - } - country: { - /** - * Country - */ - displayName: () => LocalizedString - /** - * Customer country - */ - shortDesc: () => LocalizedString - /** - * The country for the customer’s address. - */ - longDesc: () => LocalizedString - } - zip: { - /** - * ZIP/Postal Code - */ - displayName: () => LocalizedString - /** - * Customer postal code - */ - shortDesc: () => LocalizedString - /** - * The ZIP or postal code for the customer’s address. - */ - longDesc: () => LocalizedString - } - firstName: { - /** - * First Name - */ - displayName: () => LocalizedString - /** - * Address first name - */ - shortDesc: () => LocalizedString - /** - * The first name associated with this specific address. - */ - longDesc: () => LocalizedString - } - lastName: { - /** - * Last Name - */ - displayName: () => LocalizedString - /** - * Address last name - */ - shortDesc: () => LocalizedString - /** - * The last name associated with this specific address. - */ - longDesc: () => LocalizedString - } - company: { - /** - * Company - */ - displayName: () => LocalizedString - /** - * Address company name - */ - shortDesc: () => LocalizedString - /** - * The company name tied to this address, if applicable. - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone - */ - displayName: () => LocalizedString - /** - * Address phone number - */ - shortDesc: () => LocalizedString - /** - * The phone number linked to this specific address. - */ - longDesc: () => LocalizedString - } - } - } - } } - emailMarketingConsent: { + environment_id: { /** - * Email Marketing Consent + * Environment */ displayName: () => LocalizedString /** - * Email marketing preferences + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Details about the customer’s consent to receive email marketing communications. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString - type: { - fields: { - marketingState: { - /** - * Marketing State - */ - displayName: () => LocalizedString - /** - * Consent status - */ - shortDesc: () => LocalizedString - /** - * The current state of email marketing consent, e.g., "SUBSCRIBED", "UNSUBSCRIBED", or "PENDING". - */ - longDesc: () => LocalizedString - } - marketingOptInLevel: { - /** - * Marketing Opt-In Level - */ - displayName: () => LocalizedString - /** - * Opt-in level - */ - shortDesc: () => LocalizedString - /** - * The level of consent provided, e.g., "SINGLE_OPT_IN" or "CONFIRMED_OPT_IN", based on how consent was obtained. - */ - longDesc: () => LocalizedString - } - } - } } - smsMarketingConsent: { + content_type_id: { /** - * SMS Marketing Consent + * Content Type */ displayName: () => LocalizedString /** - * SMS marketing preferences + * The content type to filter entries */ shortDesc: () => LocalizedString /** - * Details about the customer’s consent to receive SMS marketing messages. + * Select the content type to filter the entry dropdown. */ longDesc: () => LocalizedString - type: { - fields: { - marketingState: { - /** - * Marketing State - */ - displayName: () => LocalizedString - /** - * Consent status - */ - shortDesc: () => LocalizedString - /** - * The current state of SMS marketing consent, e.g., "SUBSCRIBED", "UNSUBSCRIBED", or "PENDING". - */ - longDesc: () => LocalizedString - } - marketingOptInLevel: { - /** - * Marketing Opt-In Level - */ - displayName: () => LocalizedString - /** - * Opt-in level - */ - shortDesc: () => LocalizedString - /** - * The level of consent provided for SMS, e.g., "SINGLE_OPT_IN" or "CONFIRMED_OPT_IN". - */ - longDesc: () => LocalizedString - } - } - } } - metafields: { + entry_id: { /** - * Metafields + * Entry */ displayName: () => LocalizedString /** - * Custom metadata + * The entry to unpublish */ shortDesc: () => LocalizedString /** - * Additional metadata fields for the customer, useful for custom integrations or data storage. + * Select or enter the ID of the entry to unpublish. */ longDesc: () => LocalizedString - type: { - element_type: { - fields: { - namespace: { - /** - * Namespace - */ - displayName: () => LocalizedString - /** - * Metafield namespace - */ - shortDesc: () => LocalizedString - /** - * A grouping identifier for the metafield to organize related data. - */ - longDesc: () => LocalizedString - } - key: { - /** - * Key - */ - displayName: () => LocalizedString - /** - * Metafield key - */ - shortDesc: () => LocalizedString - /** - * The specific identifier for the metafield. - */ - longDesc: () => LocalizedString - } - value: { - /** - * Value - */ - displayName: () => LocalizedString - /** - * Metafield value - */ - shortDesc: () => LocalizedString - /** - * The value stored in the metafield, which can be a string, number, or JSON. - */ - longDesc: () => LocalizedString - } - type: { - /** - * Type - */ - displayName: () => LocalizedString - /** - * Metafield data type - */ - shortDesc: () => LocalizedString - /** - * The data type of the metafield value, e.g., "string", "integer", "json". - */ - longDesc: () => LocalizedString - } - } - } - } } } } - 'create-blog-entry': { + archive_entry: { /** - * Create Blog Entry + * Archive/Unarchive an Entry */ displayName: () => LocalizedString /** - * Creates a new blog post in Shopify + * Archives/Unarchives an unpublished entry */ shortDesc: () => LocalizedString /** - * Adds a new blog post to a specified blog in your Shopify store, allowing you to publish content such as articles, news, or updates for customers. + * Archives or unarchives an entry. The entry must be unpublished before it can be archived. Archived entries are hidden from the default entry list. */ longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } options: { - blogId: { + space_id: { /** - * Blog ID + * Space */ displayName: () => LocalizedString /** - * ID of the target blog + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * The unique identifier of the blog where the new entry will be created. Required to associate the post with a specific blog. + * Select the Contentful space containing the entry. */ longDesc: () => LocalizedString } - title: { + environment_id: { /** - * Title + * Environment */ displayName: () => LocalizedString /** - * Blog post title + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * The headline or title of the blog post, displayed prominently to readers. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - content: { + content_type_id: { /** - * Content + * Content Type */ displayName: () => LocalizedString /** - * Blog post content + * The content type to filter entries */ shortDesc: () => LocalizedString /** - * The main body of the blog post, which can include text, HTML, or other formatted content to convey the message or story. + * Select the content type to filter the entry dropdown. */ longDesc: () => LocalizedString } - author: { + entry_id: { /** - * Author + * Entry */ displayName: () => LocalizedString /** - * Author of the blog post + * The entry to archive or unarchive */ shortDesc: () => LocalizedString /** - * The name of the person or entity credited with writing the blog post, displayed as the author. + * Select or enter the ID of the entry. */ longDesc: () => LocalizedString } - tags: { + archive: { /** - * Tags + * Archive */ displayName: () => LocalizedString /** - * Tags for the blog post + * Set to true to archive, false to unarchive */ shortDesc: () => LocalizedString /** - * A list of keywords or categories to tag the blog post, aiding in searchability and organization. + * When enabled, the entry will be archived. When disabled, the entry will be unarchived. */ longDesc: () => LocalizedString - type: { - element_type: { - /** - * Tag - */ - displayName: () => LocalizedString - /** - * Single tag value - */ - shortDesc: () => LocalizedString - /** - * A single string value used to tag the blog post, e.g., "news", "tutorial", "promotion". - */ - longDesc: () => LocalizedString - } - } } - summary: { + } + } + search_entries: { + /** + * Search Entries + */ + displayName: () => LocalizedString + /** + * Searches for entries + */ + shortDesc: () => LocalizedString + /** + * Searches for entries of a specific content type with optional full-text search. Returns a paginated list of entries. + */ + longDesc: () => LocalizedString + groups: { + /** + * Entries + */ + '0': () => LocalizedString + } + options: { + space_id: { /** - * Summary + * Space */ displayName: () => LocalizedString /** - * Blog post summary + * The Contentful space to search */ shortDesc: () => LocalizedString /** - * A brief overview or excerpt of the blog post, often used as a teaser or preview in blog listings. + * Select the Contentful space to search in. */ longDesc: () => LocalizedString } - published: { + environment_id: { /** - * Published + * Environment */ displayName: () => LocalizedString /** - * Publication status + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Indicates whether the blog post is published (true) or saved as a draft (false) upon creation. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - image: { + content_type_id: { /** - * Image + * Content Type */ displayName: () => LocalizedString /** - * Featured image for the post + * The content type to search */ shortDesc: () => LocalizedString /** - * The primary image associated with the blog post, used for visual appeal in previews or headers. + * Select the content type to filter results by. + */ + longDesc: () => LocalizedString + } + query: { + /** + * Search Query + */ + displayName: () => LocalizedString + /** + * Full-text search query + */ + shortDesc: () => LocalizedString + /** + * Optional text to search across all text fields of the entries. + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of entries to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of entries to return. Default is 100, maximum is 1000. + */ + longDesc: () => LocalizedString + } + skip: { + /** + * Skip + */ + displayName: () => LocalizedString + /** + * Number of entries to skip + */ + shortDesc: () => LocalizedString + /** + * The number of entries to skip for pagination. Default is 0. */ longDesc: () => LocalizedString - type: { - fields: { - altText: { - /** - * Alt Text - */ - displayName: () => LocalizedString - /** - * Image alt text - */ - shortDesc: () => LocalizedString - /** - * Descriptive text for the image, used for accessibility and SEO purposes. - */ - longDesc: () => LocalizedString - } - url: { - /** - * URL - */ - displayName: () => LocalizedString - /** - * Image URL - */ - shortDesc: () => LocalizedString - /** - * The web address or source location of the image file to be used in the blog post. - */ - longDesc: () => LocalizedString - } - } - } } } } - 'add-tag-to-customer': { + get_asset: { /** - * Add Tag to Customer + * Get an Asset */ displayName: () => LocalizedString /** - * Adds tags to an existing customer + * Returns attributes of a specific asset */ shortDesc: () => LocalizedString /** - * Appends or replaces tags for a specified customer in Shopify, useful for categorization, segmentation, or tracking purposes. + * Retrieves a single asset by its ID, returning metadata including title, description, file URL, MIME type, and size. */ longDesc: () => LocalizedString + groups: { + /** + * Assets + */ + '0': () => LocalizedString + } options: { - customerId: { + space_id: { /** - * Customer ID + * Space */ displayName: () => LocalizedString /** - * ID of the customer + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * The unique identifier of the customer to whom tags will be added. Required to target the correct customer. + * Select the Contentful space containing the asset. */ longDesc: () => LocalizedString } - tags: { + environment_id: { /** - * Tags + * Environment */ displayName: () => LocalizedString /** - * Tags to add + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * A list of tags to apply to the customer, such as "VIP", "loyal", or "newsletter". Can be appended or replace existing tags based on the append option. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - append: { + asset_id: { /** - * Append + * Asset */ displayName: () => LocalizedString /** - * Append or replace tags + * The asset to retrieve */ shortDesc: () => LocalizedString /** - * If true, adds the new tags to the existing ones; if false, replaces all existing tags with the new ones. + * Select or enter the ID of the asset to retrieve. */ longDesc: () => LocalizedString } } } - 'create-transaction': { + create_asset: { /** - * Create Transaction + * Create an Asset */ displayName: () => LocalizedString /** - * Creates a transaction for an order + * Creates a new asset */ shortDesc: () => LocalizedString /** - * Records a financial transaction (e.g., payment, refund) for a specific order in Shopify, linked to a payment gateway. + * Creates a new asset from a URL. The asset will be processed (downloaded and stored) automatically. Optionally publishes the asset after creation. */ longDesc: () => LocalizedString + groups: { + /** + * Assets + */ + '0': () => LocalizedString + } options: { - orderId: { + space_id: { /** - * Order ID + * Space */ displayName: () => LocalizedString /** - * ID of the order + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * The unique identifier of the order to which this transaction applies. Required to associate the transaction correctly. + * Select the Contentful space where the asset will be created. */ longDesc: () => LocalizedString } - amount: { + environment_id: { /** - * Amount + * Environment */ displayName: () => LocalizedString /** - * Transaction amount + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * The numerical value of the transaction, such as the amount paid or refunded. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - currency: { + title: { /** - * Currency + * Title */ displayName: () => LocalizedString /** - * Transaction currency + * The asset title */ shortDesc: () => LocalizedString /** - * The ISO 4217 currency code for the transaction amount, e.g., "USD", "EUR". + * A descriptive title for the asset. */ longDesc: () => LocalizedString } - type: { + description: { /** - * Type + * Description */ displayName: () => LocalizedString /** - * Transaction type + * The asset description */ shortDesc: () => LocalizedString /** - * The type of transaction, such as "authorization", "capture", "sale", or "refund". Defines the transaction’s purpose. + * An optional description for the asset. */ longDesc: () => LocalizedString } - parentTransactionId: { + file_name: { /** - * Parent Transaction ID + * File Name */ displayName: () => LocalizedString /** - * ID of parent transaction + * The file name for the asset */ shortDesc: () => LocalizedString /** - * The ID of a previous transaction this one relates to, e.g., for refunds or captures linked to an authorization. + * The file name including extension (e.g., "photo.jpg"). */ longDesc: () => LocalizedString } - gateway: { + file_url: { /** - * Gateway + * File URL */ displayName: () => LocalizedString /** - * Payment gateway + * The URL of the file to upload */ shortDesc: () => LocalizedString /** - * The payment gateway used for the transaction, e.g., "shopify_payments", "paypal", or a custom gateway name. + * The publicly accessible URL from which Contentful will download the file. */ longDesc: () => LocalizedString } - finalCapture: { + content_type: { /** - * Final Capture + * Content Type */ displayName: () => LocalizedString /** - * Complete capture flag + * The MIME type of the file */ shortDesc: () => LocalizedString /** - * If true, indicates this is the final capture of funds for an authorization; if false, partial captures may follow. + * The MIME type of the file (e.g., "image/jpeg", "application/pdf"). + */ + longDesc: () => LocalizedString + } + publish: { + /** + * Publish + */ + displayName: () => LocalizedString + /** + * Whether to publish the asset after creation + */ + shortDesc: () => LocalizedString + /** + * If enabled, the asset will be published immediately after processing. */ longDesc: () => LocalizedString } } } - 'create-company': { + update_asset: { /** - * Create Company + * Update an Asset */ displayName: () => LocalizedString /** - * Creates a new company in Shopify + * Updates an asset by its ID */ shortDesc: () => LocalizedString /** - * Adds a new company entity to Shopify, typically for B2B purposes, including contact and location details for wholesale or enterprise customers. + * Updates the title and/or description of an existing asset. */ longDesc: () => LocalizedString + groups: { + /** + * Assets + */ + '0': () => LocalizedString + } options: { - companyName: { - /** - * Name - */ - displayName: () => LocalizedString - /** - * Company name - */ - shortDesc: () => LocalizedString - /** - * The official name of the company, used for identification and display purposes. - */ - longDesc: () => LocalizedString - } - externalId: { + space_id: { /** - * External ID + * Space */ displayName: () => LocalizedString /** - * External identifier + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * A unique identifier from an external system, useful for syncing or referencing the company outside Shopify. + * Select the Contentful space containing the asset. */ longDesc: () => LocalizedString } - note: { + environment_id: { /** - * Note + * Environment */ displayName: () => LocalizedString /** - * Company notes + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Internal notes about the company, such as account details or special instructions. + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - customerSince: { + asset_id: { /** - * Customer Since + * Asset */ displayName: () => LocalizedString /** - * Start date + * The asset to update */ shortDesc: () => LocalizedString /** - * The date the company became a customer, formatted as a timestamp, useful for tracking tenure. + * Select or enter the ID of the asset to update. */ longDesc: () => LocalizedString } - contactProperties: { + title: { /** - * Contact Properties + * Title */ displayName: () => LocalizedString /** - * Primary contact details + * New title for the asset */ shortDesc: () => LocalizedString /** - * Details about the primary contact person for the company. + * The updated title for the asset. */ longDesc: () => LocalizedString - type: { - fields: { - firstName: { - /** - * First Name - */ - displayName: () => LocalizedString - /** - * Contact first name - */ - shortDesc: () => LocalizedString - /** - * The first name of the company’s primary contact. - */ - longDesc: () => LocalizedString - } - lastName: { - /** - * Last Name - */ - displayName: () => LocalizedString - /** - * Contact last name - */ - shortDesc: () => LocalizedString - /** - * The last name of the company’s primary contact. - */ - longDesc: () => LocalizedString - } - email: { - /** - * Email - */ - displayName: () => LocalizedString - /** - * Contact email - */ - shortDesc: () => LocalizedString - /** - * The email address of the primary contact, used for communication. - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone - */ - displayName: () => LocalizedString - /** - * Contact phone - */ - shortDesc: () => LocalizedString - /** - * The phone number of the primary contact. - */ - longDesc: () => LocalizedString - } - title: { - /** - * Title - */ - displayName: () => LocalizedString - /** - * Contact job title - */ - shortDesc: () => LocalizedString - /** - * The job title or role of the primary contact within the company. - */ - longDesc: () => LocalizedString - } - locale: { - /** - * Locale - */ - displayName: () => LocalizedString - /** - * Contact language/region - */ - shortDesc: () => LocalizedString - /** - * The preferred language and region code for the contact, e.g., "en-US". - */ - longDesc: () => LocalizedString - } - } - } } - locationProperties: { + description: { /** - * Location Properties + * Description */ displayName: () => LocalizedString /** - * Company location details + * New description for the asset */ shortDesc: () => LocalizedString /** - * Details about the company’s physical location, including shipping and billing addresses. + * The updated description for the asset. */ longDesc: () => LocalizedString - type: { - fields: { - locationName: { - /** - * Location Name - */ - displayName: () => LocalizedString - /** - * Name of location - */ - shortDesc: () => LocalizedString - /** - * A descriptive name for this company location, e.g., "Headquarters". - */ - longDesc: () => LocalizedString - } - phone: { - /** - * Phone - */ - displayName: () => LocalizedString - /** - * Location phone - */ - shortDesc: () => LocalizedString - /** - * The phone number associated with this company location. - */ - longDesc: () => LocalizedString - } - note: { - /** - * Note - */ - displayName: () => LocalizedString - /** - * Location notes - */ - shortDesc: () => LocalizedString - /** - * Internal notes about this location, such as delivery instructions. - */ - longDesc: () => LocalizedString - } - externalId: { - /** - * External ID - */ - displayName: () => LocalizedString - /** - * Location external ID - */ - shortDesc: () => LocalizedString - /** - * An external identifier for this location, useful for integration with other systems. - */ - longDesc: () => LocalizedString - } - taxExempt: { - /** - * Tax Exempt - */ - displayName: () => LocalizedString - /** - * Tax exemption status - */ - shortDesc: () => LocalizedString - /** - * Indicates if this location is exempt from taxes. - */ - longDesc: () => LocalizedString - } - taxRegistrationId: { - /** - * Tax Registration ID - */ - displayName: () => LocalizedString - /** - * Tax ID - */ - shortDesc: () => LocalizedString - /** - * The tax registration number for this location, e.g., VAT or EIN. - */ - longDesc: () => LocalizedString - } - taxExemptions: { - /** - * Tax Exemptions - */ - displayName: () => LocalizedString - /** - * Specific tax exemptions - */ - shortDesc: () => LocalizedString - /** - * A list of specific tax exemptions applied to this location. - */ - longDesc: () => LocalizedString - type: { - element_type: { - /** - * Tax Exemption Type - */ - displayName: () => LocalizedString - /** - * Type of exemption - */ - shortDesc: () => LocalizedString - /** - * Defines the specific tax exemption, e.g., "GST", "VAT". - */ - longDesc: () => LocalizedString - } - } - } - locale: { - /** - * Locale - */ - displayName: () => LocalizedString - /** - * Location language/region - */ - shortDesc: () => LocalizedString - /** - * The preferred language and region code for this location, e.g., "en-CA". - */ - longDesc: () => LocalizedString - } - shippingAddress: { - /** - * Shipping Address - */ - displayName: () => LocalizedString - /** - * Shipping address - */ - shortDesc: () => LocalizedString - /** - * The address where goods are shipped for this company location. - */ - longDesc: () => LocalizedString - type: { - fields: { - address1: { - /** - * Address Line 1 - */ - displayName: () => LocalizedString - /** - * Primary shipping line - */ - shortDesc: () => LocalizedString - /** - * The street address or PO Box for shipping. - */ - longDesc: () => LocalizedString - } - address2: { - /** - * Address Line 2 - */ - displayName: () => LocalizedString - /** - * Secondary shipping line - */ - shortDesc: () => LocalizedString - /** - * Additional shipping address details, e.g., suite number. - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * Shipping city - */ - shortDesc: () => LocalizedString - /** - * The city for the shipping address. - */ - longDesc: () => LocalizedString - } - zoneCode: { - /** - * Zone Code - */ - displayName: () => LocalizedString - /** - * Province/state code - */ - shortDesc: () => LocalizedString - /** - * The code for the province or state, e.g., "CA" for California. - */ - longDesc: () => LocalizedString - } - countryCode: { - /** - * Country Code - */ - displayName: () => LocalizedString - /** - * Country code - */ - shortDesc: () => LocalizedString - /** - * The ISO 3166-1 alpha-2 country code, e.g., "US". - */ - longDesc: () => LocalizedString - } - zip: { - /** - * ZIP/Postal Code - */ - displayName: () => LocalizedString - /** - * Shipping postal code - */ - shortDesc: () => LocalizedString - /** - * The ZIP or postal code for the shipping address. - */ - longDesc: () => LocalizedString - } - } - } - } - billingSameAsShipping: { - /** - * Billing Same as Shipping - */ - displayName: () => LocalizedString - /** - * Use shipping for billing - */ - shortDesc: () => LocalizedString - /** - * If true, the shipping address is also used as the billing address. - */ - longDesc: () => LocalizedString - } - billingAddress: { - /** - * Billing Address - */ - displayName: () => LocalizedString - /** - * Billing address - */ - shortDesc: () => LocalizedString - /** - * The address used for billing purposes, if different from shipping. - */ - longDesc: () => LocalizedString - type: { - fields: { - address1: { - /** - * Address Line 1 - */ - displayName: () => LocalizedString - /** - * Primary billing line - */ - shortDesc: () => LocalizedString - /** - * The street address or PO Box for billing. - */ - longDesc: () => LocalizedString - } - address2: { - /** - * Address Line 2 - */ - displayName: () => LocalizedString - /** - * Secondary billing line - */ - shortDesc: () => LocalizedString - /** - * Additional billing address details, e.g., apartment number. - */ - longDesc: () => LocalizedString - } - city: { - /** - * City - */ - displayName: () => LocalizedString - /** - * Billing city - */ - shortDesc: () => LocalizedString - /** - * The city for the billing address. - */ - longDesc: () => LocalizedString - } - zoneCode: { - /** - * Zone Code - */ - displayName: () => LocalizedString - /** - * Province/state code - */ - shortDesc: () => LocalizedString - /** - * The code for the province or state, e.g., "NY". - */ - longDesc: () => LocalizedString - } - countryCode: { - /** - * Country Code - */ - displayName: () => LocalizedString - /** - * Country code - */ - shortDesc: () => LocalizedString - /** - * The ISO 3166-1 alpha-2 country code, e.g., "CA". - */ - longDesc: () => LocalizedString - } - zip: { - /** - * ZIP/Postal Code - */ - displayName: () => LocalizedString - /** - * Billing postal code - */ - shortDesc: () => LocalizedString - /** - * The ZIP or postal code for the billing address. - */ - longDesc: () => LocalizedString - } - } - } - } - } - } } } } - } - expressions: { - '&&': { - /** - * And - */ - displayName: () => LocalizedString - /** - * Logical AND operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where all must be true - */ - longDesc: () => LocalizedString - } - '||': { - /** - * Or - */ - displayName: () => LocalizedString - /** - * Logical OR operator - */ - shortDesc: () => LocalizedString - /** - * Combines multiple conditions where at least one must be true - */ - longDesc: () => LocalizedString - } - '==': { - /** - * Equals - */ - displayName: () => LocalizedString - /** - * Field equals value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field equals the specified value - */ - longDesc: () => LocalizedString - } - '!=': { - /** - * Not Equals - */ - displayName: () => LocalizedString - /** - * Field does not equal value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field does not equal the specified value - */ - longDesc: () => LocalizedString - } - '>': { - /** - * Greater Than - */ - displayName: () => LocalizedString - /** - * Field is greater than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than the specified value - */ - longDesc: () => LocalizedString - } - '>=': { - /** - * Greater Than or Equal - */ - displayName: () => LocalizedString - /** - * Field is greater than or equal to value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is greater than or equal to the specified value - */ - longDesc: () => LocalizedString - } - '<': { - /** - * Less Than - */ - displayName: () => LocalizedString - /** - * Field is less than value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is less than the specified value - */ - longDesc: () => LocalizedString - } - '<=': { - /** - * Less Than or Equal - */ - displayName: () => LocalizedString - /** - * Field is less than or equal to value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field value is less than or equal to the specified value - */ - longDesc: () => LocalizedString - } - contains: { - /** - * Contains - */ - displayName: () => LocalizedString - /** - * Field contains value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field contains the specified text (case-insensitive) - */ - longDesc: () => LocalizedString - } - 'is-set': { - /** - * Is Set - */ - displayName: () => LocalizedString - /** - * Field has a value - */ - shortDesc: () => LocalizedString - /** - * Matches records where the field has a non-empty value - */ - longDesc: () => LocalizedString - } - 'is-not-set': { + delete_asset: { /** - * Is Not Set + * Delete an Asset */ displayName: () => LocalizedString /** - * Field is empty + * Permanently removes an unpublished asset */ shortDesc: () => LocalizedString /** - * Matches records where the field is empty or not set + * Permanently deletes an asset. If the asset is published, it will be unpublished first. This action is irreversible. */ longDesc: () => LocalizedString + groups: { + /** + * Assets + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space containing the asset. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + asset_id: { + /** + * Asset + */ + displayName: () => LocalizedString + /** + * The asset to delete + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the asset to permanently remove. + */ + longDesc: () => LocalizedString + } + } } - } - searchOptions: { - orderBy: { + publish_asset: { /** - * Order By + * Publish an Asset */ displayName: () => LocalizedString /** - * Sort results by a specific field + * Changes asset status to "published" */ shortDesc: () => LocalizedString /** - * Define the field and direction to sort search results + * Publishes a draft asset, making it available through the Content Delivery API. */ longDesc: () => LocalizedString - type: { - fields: { - field: { - /** - * Field - */ - displayName: () => LocalizedString - /** - * The field to sort by - */ - shortDesc: () => LocalizedString - /** - * The name of the field to use for sorting results - */ - longDesc: () => LocalizedString - } - direction: { - /** - * Direction - */ - displayName: () => LocalizedString - /** - * Sort direction - */ - shortDesc: () => LocalizedString - /** - * The direction to sort results (ascending or descending) - */ - longDesc: () => LocalizedString - } + groups: { + /** + * Assets + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space containing the asset. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + asset_id: { + /** + * Asset + */ + displayName: () => LocalizedString + /** + * The asset to publish + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the asset to publish. + */ + longDesc: () => LocalizedString } } } - } - triggers: { - 'shopify-abandoned-cart-trigger': { + unpublish_asset: { /** - * Shopify New Abandoned Cart + * Unpublish an Asset */ displayName: () => LocalizedString /** - * Triggers when a customer abandons a checkout in Shopify + * Puts an asset back into "draft" state */ shortDesc: () => LocalizedString /** - * This trigger activates when a Shopify checkout is created but not completed within the specified time window. Use this to send recovery emails, offer discounts, or analyze cart abandonment patterns. + * Unpublishes an asset, removing it from the Content Delivery API and reverting it to draft state. */ longDesc: () => LocalizedString + groups: { + /** + * Assets + */ + '0': () => LocalizedString + } options: { - abandonedHours: { + space_id: { /** - * Abandoned Hours + * Space */ displayName: () => LocalizedString /** - * Time window to consider a cart abandoned + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * Specify how many hours must pass since cart creation without completion for it to be considered abandoned. Values range from 1 hour to 168 hours (one week). + * Select the Contentful space containing the asset. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + asset_id: { + /** + * Asset + */ + displayName: () => LocalizedString + /** + * The asset to unpublish + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the asset to unpublish. */ longDesc: () => LocalizedString } } } - 'shopify-blog-trigger': { + archive_asset: { /** - * Shopify Blog Created + * Archive/Unarchive an Asset */ displayName: () => LocalizedString /** - * Triggers when a new blog is created in Shopify + * Archives/Unarchives an unpublished asset */ shortDesc: () => LocalizedString /** - * This trigger activates whenever a new blog (not an article) is created in your Shopify store. Use this to monitor blog creation or automate follow-up tasks. + * Archives or unarchives an asset. The asset must be unpublished before it can be archived. */ longDesc: () => LocalizedString + groups: { + /** + * Assets + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space containing the asset. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + asset_id: { + /** + * Asset + */ + displayName: () => LocalizedString + /** + * The asset to archive or unarchive + */ + shortDesc: () => LocalizedString + /** + * Select or enter the ID of the asset. + */ + longDesc: () => LocalizedString + } + archive: { + /** + * Archive + */ + displayName: () => LocalizedString + /** + * Set to true to archive, false to unarchive + */ + shortDesc: () => LocalizedString + /** + * When enabled, the asset will be archived. When disabled, the asset will be unarchived. + */ + longDesc: () => LocalizedString + } + } } - 'shopify-blog-entry-trigger': { + search_assets: { /** - * Shopify New Blog Article + * Search Assets */ displayName: () => LocalizedString /** - * Triggers when a blog article is created or published + * Searches for assets */ shortDesc: () => LocalizedString /** - * This trigger activates when a new article is created or published in a specified Shopify blog. Use this to automate social media sharing, email notifications, or content distribution workflows. + * Searches for assets with optional full-text search and MIME type filtering. Returns a paginated list of assets. */ longDesc: () => LocalizedString + groups: { + /** + * Assets + */ + '0': () => LocalizedString + } options: { - blog_title: { + space_id: { /** - * Blog + * Space */ displayName: () => LocalizedString /** - * Select the blog to monitor + * The Contentful space to search */ shortDesc: () => LocalizedString /** - * Choose which Shopify blog to monitor for new articles. + * Select the Contentful space to search in. */ longDesc: () => LocalizedString } - entryStatus: { + environment_id: { /** - * Article Status + * Environment */ displayName: () => LocalizedString /** - * Filter articles by publication status + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Choose whether to trigger on all articles, only published articles, or only draft articles. + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + query: { + /** + * Search Query + */ + displayName: () => LocalizedString + /** + * Full-text search query + */ + shortDesc: () => LocalizedString + /** + * Optional text to search across asset titles and descriptions. + */ + longDesc: () => LocalizedString + } + mime_type_group: { + /** + * MIME Type Group + */ + displayName: () => LocalizedString + /** + * Filter by file type group + */ + shortDesc: () => LocalizedString + /** + * Optionally filter assets by MIME type group (e.g., image, video, audio, pdfdocument). + */ + longDesc: () => LocalizedString + } + limit: { + /** + * Limit + */ + displayName: () => LocalizedString + /** + * Maximum number of assets to return + */ + shortDesc: () => LocalizedString + /** + * The maximum number of assets to return. Default is 100, maximum is 1000. + */ + longDesc: () => LocalizedString + } + skip: { + /** + * Skip + */ + displayName: () => LocalizedString + /** + * Number of assets to skip + */ + shortDesc: () => LocalizedString + /** + * The number of assets to skip for pagination. Default is 0. */ longDesc: () => LocalizedString } } } - 'shopify-customer-created-trigger': { + get_content_type: { /** - * Shopify Customer Created + * Get a Content Type */ displayName: () => LocalizedString /** - * Triggers when a new customer account is created + * Returns attributes of a specific content type */ shortDesc: () => LocalizedString /** - * This trigger activates whenever a new customer registers or is created in your Shopify store. Use this to send welcome emails, add customers to marketing lists, or create records in other systems. + * Retrieves a content type by its ID, including its name, description, and field definitions. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space containing the content type. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + content_type_id: { + /** + * Content Type + */ + displayName: () => LocalizedString + /** + * The content type to retrieve + */ + shortDesc: () => LocalizedString + /** + * Select the content type to retrieve details for. + */ + longDesc: () => LocalizedString + } + } } - 'shopify-customer-updated-trigger': { + create_content_type: { /** - * Shopify Customer Updated + * Create a Content Type */ displayName: () => LocalizedString /** - * Triggers when customer information is modified + * Creates a new content type */ shortDesc: () => LocalizedString /** - * This trigger activates whenever customer information is updated in your Shopify store. Use this to sync customer data with other systems, track specific customer changes, or update marketing preferences. + * Creates a new content type with the specified name, description, and field definitions. The content type will be created in draft state. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space where the content type will be created. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * The content type name + */ + shortDesc: () => LocalizedString + /** + * A descriptive name for the content type (e.g., "Blog Post", "Product"). + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * The content type description + */ + shortDesc: () => LocalizedString + /** + * An optional description explaining the purpose of this content type. + */ + longDesc: () => LocalizedString + } + fields: { + /** + * Fields + */ + displayName: () => LocalizedString + /** + * The field definitions for the content type + */ + shortDesc: () => LocalizedString + /** + * A list of field definitions. Each field requires an ID, name, and type. Supported types: Symbol, Text, Integer, Number, Date, Boolean, RichText, Link, Array, Object, Location. + */ + longDesc: () => LocalizedString + type: { + element_type: { + fields: { + id: { + /** + * Field ID + */ + displayName: () => LocalizedString + /** + * Unique identifier for the field + */ + shortDesc: () => LocalizedString + /** + * A unique ID for the field (e.g., "heroImage", "publishDate"). Must be unique within the content type. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Field Name + */ + displayName: () => LocalizedString + /** + * Display name for the field + */ + shortDesc: () => LocalizedString + /** + * A human-readable name for the field (e.g., "Hero Image", "Publish Date"). + */ + longDesc: () => LocalizedString + } + type: { + /** + * Field Type + */ + displayName: () => LocalizedString + /** + * Data type (Symbol, Text, Integer, Number, Date, Boolean, RichText, Link, Array, Object, Location) + */ + shortDesc: () => LocalizedString + /** + * The data type for the field. Supported types: Symbol (short text), Text (long text), Integer, Number, Date, Boolean, RichText, Link, Array, Object, Location. + */ + longDesc: () => LocalizedString + } + required: { + /** + * Required + */ + displayName: () => LocalizedString + /** + * Whether the field is required + */ + shortDesc: () => LocalizedString + /** + * If enabled, entries must provide a value for this field. + */ + longDesc: () => LocalizedString + } + localized: { + /** + * Localized + */ + displayName: () => LocalizedString + /** + * Whether the field supports localization + */ + shortDesc: () => LocalizedString + /** + * If enabled, the field can have different values for different locales. + */ + longDesc: () => LocalizedString + } + } + } + } + } + } } - 'shopify-new-order-trigger': { + update_content_type: { /** - * Shopify New Order + * Update a Content Type */ displayName: () => LocalizedString /** - * Triggers when a new order is placed with the specified status + * Updates a specific content type by its ID */ shortDesc: () => LocalizedString /** - * This trigger activates when a new order is created in your Shopify store that matches the specified status filter. Use this to process orders, update inventory in other systems, or send custom notifications based on order status. + * Updates the name and/or description of an existing content type. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } options: { - orderStatus: { + space_id: { /** - * Order Status + * Space */ displayName: () => LocalizedString /** - * Filter orders by their status + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * Select which type of orders to monitor based on their status (e.g., any, paid, fulfilled, cancelled). This lets you create different workflows for different order conditions. + * Select the Contentful space containing the content type. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + content_type_id: { + /** + * Content Type + */ + displayName: () => LocalizedString + /** + * The content type to update + */ + shortDesc: () => LocalizedString + /** + * Select the content type to update. + */ + longDesc: () => LocalizedString + } + name: { + /** + * Name + */ + displayName: () => LocalizedString + /** + * New name for the content type + */ + shortDesc: () => LocalizedString + /** + * The updated name for the content type. + */ + longDesc: () => LocalizedString + } + description: { + /** + * Description + */ + displayName: () => LocalizedString + /** + * New description for the content type + */ + shortDesc: () => LocalizedString + /** + * The updated description for the content type. */ longDesc: () => LocalizedString } } } - } - } - Zoom: { - /** - * Zoom - */ - displayName: () => LocalizedString - groups: { - /** - * Video Conferencing & Meetings - */ - '0': () => LocalizedString - } - /** - * Video conferencing and online meeting platform - */ - shortDesc: () => LocalizedString - /** - * Zoom is a video conferencing and online meeting platform that allows users to host and join virtual meetings, webinars, and video conferences. It offers features such as screen sharing, recording, and chat functionalities to enhance collaboration and communication among participants. - */ - longDesc: () => LocalizedString - actions: { - meetingDelete: { - groups: { - /** - * Meetings - */ - '0': () => LocalizedString - } - } - meeting: { - groups: { - /** - * Meetings - */ - '0': () => LocalizedString - } - } - meetingUpdate: { - groups: { - /** - * Meetings - */ - '0': () => LocalizedString - } - } - meetings: { - groups: { - /** - * Meetings - */ - '0': () => LocalizedString - } - } - meetingCreate: { - groups: { - /** - * Meetings - */ - '0': () => LocalizedString - } - } - Getameetingsummary: { - groups: { - /** - * Meetings - */ - '0': () => LocalizedString - } - } - meetingRegistrants: { - groups: { - /** - * Meeting Registrants - */ - '0': () => LocalizedString - } - } - meetingRegistrantCreate: { - groups: { - /** - * Meeting Registrants - */ - '0': () => LocalizedString - } - } - pastMeetingParticipants: { - groups: { - /** - * Meeting Participants - */ - '0': () => LocalizedString - } - } - recordingDelete: { - groups: { - /** - * Recordings - */ - '0': () => LocalizedString - } - } - recordingGet: { - groups: { - /** - * Recordings - */ - '0': () => LocalizedString - } - } - recordingsList: { - groups: { - /** - * Recordings - */ - '0': () => LocalizedString - } - } - webinars: { - groups: { - /** - * Webinars - */ - '0': () => LocalizedString - } - } - webinarCreate: { - groups: { - /** - * Webinars - */ - '0': () => LocalizedString - } - } - webinarDelete: { - groups: { - /** - * Webinars - */ - '0': () => LocalizedString - } - } - webinar: { - groups: { - /** - * Webinars - */ - '0': () => LocalizedString - } - } - webinarUpdate: { - groups: { - /** - * Webinars - */ - '0': () => LocalizedString - } - } - webinarRegistrants: { - groups: { - /** - * Webinar Registrants - */ - '0': () => LocalizedString - } - } - webinarRegistrantCreate: { + delete_content_type: { + /** + * Delete a Content Type + */ + displayName: () => LocalizedString + /** + * Permanently removes a deactivated content type + */ + shortDesc: () => LocalizedString + /** + * Permanently deletes a content type. The content type must be deactivated (unpublished) first. This action is irreversible. + */ + longDesc: () => LocalizedString groups: { /** - * Webinar Registrants + * Content Types */ '0': () => LocalizedString } - } - listWebinarParticipants: { - groups: { - /** - * Webinar Participants - */ - '0': () => LocalizedString + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space containing the content type. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + content_type_id: { + /** + * Content Type + */ + displayName: () => LocalizedString + /** + * The content type to delete + */ + shortDesc: () => LocalizedString + /** + * Select the content type to permanently remove. + */ + longDesc: () => LocalizedString + } } } - } - triggers: { - new_meeting: { + activate_content_type: { /** - * New Meeting + * Activate a Content Type */ displayName: () => LocalizedString /** - * Triggers when a Zoom meeting is created, started, or ended. + * Activates a content type by its ID */ shortDesc: () => LocalizedString /** - * Monitors Zoom meetings and triggers when meetings are created, started (live), or ended (previous meetings) based on the selected event type. Returns meeting details including topic, duration, join URL, and meeting type. + * Publishes (activates) a content type, making it available for creating entries. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } options: { - meeting_event_type: { + space_id: { /** - * Meeting Event Type + * Space */ displayName: () => LocalizedString /** - * Type of meeting event to monitor + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * Specifies which type of meeting event should trigger this action. Choose "any" to trigger on all meeting creations, "live" for when meetings start, or "previous_meetings" for when meetings end. + * Select the Contentful space containing the content type. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + content_type_id: { + /** + * Content Type + */ + displayName: () => LocalizedString + /** + * The content type to activate + */ + shortDesc: () => LocalizedString + /** + * Select the content type to activate (publish). */ longDesc: () => LocalizedString } } } - new_webinar: { + deactivate_content_type: { /** - * New Webinar + * Deactivate a Content Type */ displayName: () => LocalizedString /** - * Triggers when a new Zoom webinar is created. + * Changes a content type status to "draft" */ shortDesc: () => LocalizedString /** - * Monitors Zoom webinars and triggers when new webinars are created. Returns webinar details including topic, duration, join URL, registration URL, and webinar type. + * Unpublishes (deactivates) a content type, reverting it to draft state. No new entries can be created for a deactivated content type. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space containing the content type. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + content_type_id: { + /** + * Content Type + */ + displayName: () => LocalizedString + /** + * The content type to deactivate + */ + shortDesc: () => LocalizedString + /** + * Select the content type to deactivate (unpublish). + */ + longDesc: () => LocalizedString + } + } } - new_meeting_summary: { + add_field_to_content_type: { /** - * New Meeting Summary + * Add a Field to a Content Type */ displayName: () => LocalizedString /** - * Triggers when a new Zoom meeting summary is created. + * Adds a new field to a specific content type */ shortDesc: () => LocalizedString /** - * Monitors Zoom meeting summaries and triggers when new summaries are generated after meetings end. Returns summary details including meeting information, host details, and summary timestamps. + * Adds a new field definition to an existing content type. The content type will need to be re-activated after adding the field. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to use + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space containing the content type. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + content_type_id: { + /** + * Content Type + */ + displayName: () => LocalizedString + /** + * The content type to add the field to + */ + shortDesc: () => LocalizedString + /** + * Select the content type to modify. + */ + longDesc: () => LocalizedString + } + field_id: { + /** + * Field ID + */ + displayName: () => LocalizedString + /** + * Unique identifier for the new field + */ + shortDesc: () => LocalizedString + /** + * A unique ID for the field (e.g., "heroImage", "publishDate"). Must be unique within the content type. + */ + longDesc: () => LocalizedString + } + field_name: { + /** + * Field Name + */ + displayName: () => LocalizedString + /** + * Display name for the new field + */ + shortDesc: () => LocalizedString + /** + * A human-readable name for the field (e.g., "Hero Image", "Publish Date"). + */ + longDesc: () => LocalizedString + } + field_type: { + /** + * Field Type + */ + displayName: () => LocalizedString + /** + * The data type for the field + */ + shortDesc: () => LocalizedString + /** + * Select the data type: Symbol (short text), Text (long text), Integer, Number, Date, Boolean, RichText, Link, Array, Object, or Location. + */ + longDesc: () => LocalizedString + } + required: { + /** + * Required + */ + displayName: () => LocalizedString + /** + * Whether the field is required + */ + shortDesc: () => LocalizedString + /** + * If enabled, entries must provide a value for this field. + */ + longDesc: () => LocalizedString + } + localized: { + /** + * Localized + */ + displayName: () => LocalizedString + /** + * Whether the field supports localization + */ + shortDesc: () => LocalizedString + /** + * If enabled, the field can have different values for different locales. + */ + longDesc: () => LocalizedString + } + } } - } - } - Confluence: { - /** - * Confluence - */ - displayName: () => LocalizedString - groups: { - /** - * Documents & Documentation - */ - '0': () => LocalizedString - } - /** - * Confluence is a collaboration tool used to help teams collaborate and share knowledge efficiently. - */ - shortDesc: () => LocalizedString - /** - * Confluence is a powerful collaboration tool that allows teams to create, share, and manage content in a centralized platform. It is designed to enhance team productivity by providing a space for documentation, project management, and knowledge sharing. With features like real-time editing, commenting, and integration with other tools, Confluence helps teams work together more effectively. - */ - longDesc: () => LocalizedString - triggers: { - new_attachment: { + update_field_of_content_type: { /** - * New Attachment + * Update a Field of a Content Type */ displayName: () => LocalizedString /** - * Triggers when a new attachment is uploaded to Confluence. + * Updates a field inside a specific content type */ shortDesc: () => LocalizedString /** - * Monitors Confluence for newly uploaded attachments with optional filtering by status and media type. Triggers when new attachments are detected. + * Updates the properties of an existing field in a content type. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } options: { - status: { + space_id: { /** - * Status + * Space */ displayName: () => LocalizedString /** - * Filter by attachment status + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * Filter attachments by their status (current, archived, or trashed). + * Select the Contentful space containing the content type. */ longDesc: () => LocalizedString } - mediaType: { + environment_id: { /** - * Media Type + * Environment */ displayName: () => LocalizedString /** - * Filter by media type + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Filter attachments by their media type (e.g., image/png, application/pdf). + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + content_type_id: { + /** + * Content Type + */ + displayName: () => LocalizedString + /** + * The content type containing the field + */ + shortDesc: () => LocalizedString + /** + * Select the content type to modify. + */ + longDesc: () => LocalizedString + } + field_id: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to update + */ + shortDesc: () => LocalizedString + /** + * Select the field to update. + */ + longDesc: () => LocalizedString + } + field_name: { + /** + * Field Name + */ + displayName: () => LocalizedString + /** + * New display name for the field + */ + shortDesc: () => LocalizedString + /** + * The updated display name for the field. + */ + longDesc: () => LocalizedString + } + required: { + /** + * Required + */ + displayName: () => LocalizedString + /** + * Whether the field is required + */ + shortDesc: () => LocalizedString + /** + * Update whether entries must provide a value for this field. + */ + longDesc: () => LocalizedString + } + localized: { + /** + * Localized + */ + displayName: () => LocalizedString + /** + * Whether the field supports localization + */ + shortDesc: () => LocalizedString + /** + * Update whether the field can have different values for different locales. */ longDesc: () => LocalizedString } } } - new_blogpost: { + delete_field_from_content_type: { /** - * New Blogpost + * Delete a Field from a Content Type */ displayName: () => LocalizedString /** - * Triggers when a new blogpost is created in Confluence. + * Removes a field from a specific content type */ shortDesc: () => LocalizedString /** - * Monitors Confluence for newly created blogposts with optional filtering by space, status, and body format. Triggers when new blogposts are detected. + * Removes a field from a content type. The field is first marked as omitted, then removed entirely. Existing entry data for this field will be lost. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } options: { space_id: { /** - * Space ID + * Space */ displayName: () => LocalizedString /** - * Filter by Confluence space + * The Contentful space to use */ shortDesc: () => LocalizedString /** - * Filter blogposts by the Confluence space they belong to. + * Select the Contentful space containing the content type. */ longDesc: () => LocalizedString } - status: { + environment_id: { /** - * Status + * Environment */ displayName: () => LocalizedString /** - * Filter by blogpost status + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Filter blogposts by their status (current, deleted, or trashed). + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - body_format: { + content_type_id: { /** - * Body Format + * Content Type */ displayName: () => LocalizedString /** - * Content format to retrieve + * The content type containing the field */ shortDesc: () => LocalizedString /** - * The format to retrieve the blogpost content in (storage format or Atlas Document Format). + * Select the content type to modify. + */ + longDesc: () => LocalizedString + } + field_id: { + /** + * Field + */ + displayName: () => LocalizedString + /** + * The field to remove + */ + shortDesc: () => LocalizedString + /** + * Select the field to permanently remove from the content type. */ longDesc: () => LocalizedString } } } - new_page: { + search_content_types: { /** - * New Page + * Search Content Types */ displayName: () => LocalizedString /** - * Triggers when a new page is created in Confluence. + * Searches for content types */ shortDesc: () => LocalizedString /** - * Monitors Confluence for newly created pages with optional filtering by space, status, body format, and subtype. Triggers when new pages are detected. + * Searches for content types with optional text filtering. Returns a paginated list of content types with their field definitions. */ longDesc: () => LocalizedString + groups: { + /** + * Content Types + */ + '0': () => LocalizedString + } options: { space_id: { /** - * Space ID + * Space */ displayName: () => LocalizedString /** - * Filter by Confluence space + * The Contentful space to search */ shortDesc: () => LocalizedString /** - * Filter pages by the Confluence space they belong to. + * Select the Contentful space to search in. */ longDesc: () => LocalizedString } - status: { + environment_id: { /** - * Status + * Environment */ displayName: () => LocalizedString /** - * Filter by page status + * The environment to use (default: master) */ shortDesc: () => LocalizedString /** - * Filter pages by their status (current, archived, deleted, or trashed). + * Select the environment within the space. Defaults to "master" if not specified. */ longDesc: () => LocalizedString } - body_format: { + query: { /** - * Body Format + * Search Query */ displayName: () => LocalizedString /** - * Content format to retrieve + * Text search query */ shortDesc: () => LocalizedString /** - * The format to retrieve the page content in (storage format or Atlas Document Format). + * Optional text to search across content type names and descriptions. */ longDesc: () => LocalizedString } - subtype: { + limit: { /** - * Subtype + * Limit */ displayName: () => LocalizedString /** - * Filter by page subtype + * Maximum number of results to return */ shortDesc: () => LocalizedString /** - * Filter pages by their subtype (live pages or regular pages). + * The maximum number of content types to return. Default is 100. + */ + longDesc: () => LocalizedString + } + skip: { + /** + * Skip + */ + displayName: () => LocalizedString + /** + * Number of results to skip + */ + shortDesc: () => LocalizedString + /** + * The number of content types to skip for pagination. Default is 0. + */ + longDesc: () => LocalizedString + } + } + } + } + triggers: { + watch_event: { + /** + * Watch an Event + */ + displayName: () => LocalizedString + /** + * Triggers when a new event occurs + */ + shortDesc: () => LocalizedString + /** + * Creates a webhook in Contentful that triggers when selected events occur. Supports entry, asset, and content type events such as creation, updates, publishing, and deletion. + */ + longDesc: () => LocalizedString + groups: { + /** + * Events + */ + '0': () => LocalizedString + } + options: { + space_id: { + /** + * Space + */ + displayName: () => LocalizedString + /** + * The Contentful space to monitor + */ + shortDesc: () => LocalizedString + /** + * Select the Contentful space to monitor for events. + */ + longDesc: () => LocalizedString + } + environment_id: { + /** + * Environment + */ + displayName: () => LocalizedString + /** + * The environment to use (default: master) + */ + shortDesc: () => LocalizedString + /** + * Select the environment within the space. Defaults to "master" if not specified. + */ + longDesc: () => LocalizedString + } + event_types: { + /** + * Event Types + */ + displayName: () => LocalizedString + /** + * The types of events to watch for + */ + shortDesc: () => LocalizedString + /** + * Select one or more event types to trigger on. Events include entry, asset, and content type lifecycle events. */ longDesc: () => LocalizedString } diff --git a/ts/src/tests/attio.test.ts b/ts/src/tests/attio.test.ts index b465861a..ed8f8804 100644 --- a/ts/src/tests/attio.test.ts +++ b/ts/src/tests/attio.test.ts @@ -346,7 +346,7 @@ describe('Should test attio actions', () => { }); describe('Should test attio record based helpers', () => { - const table = 'test_objects'; + const table = 'objects'; it('Should get table list', async () => { const result = await getAttioTableList(baseContext); diff --git a/ts/src/tests/contentful.test.ts b/ts/src/tests/contentful.test.ts new file mode 100644 index 00000000..48f3bb34 --- /dev/null +++ b/ts/src/tests/contentful.test.ts @@ -0,0 +1,944 @@ +import { TQoreAppActionWithWebhook } from '@qoretechnologies/ts-toolkit'; +import { configDotenv } from 'dotenv'; +import { ContentfulError } from '../apps/contentful/constants'; +import { getContentfulSpaceAllowedValues } from '../apps/contentful/helpers/get-space-allowed-values'; +import { getContentfulEnvironmentAllowedValues } from '../apps/contentful/helpers/get-environment-allowed-values'; +import { getContentfulContentTypeAllowedValues } from '../apps/contentful/helpers/get-content-type-allowed-values'; +import { getContentfulEntryAllowedValues } from '../apps/contentful/helpers/get-entry-allowed-values'; +import { getContentfulFieldAllowedValues } from '../apps/contentful/helpers/get-field-allowed-values'; +import { getContentfulAssetAllowedValues } from '../apps/contentful/helpers/get-asset-allowed-values'; +import GetEntry from '../apps/contentful/actions/entries/get-entry.action'; +import GetEntryWithReplacement from '../apps/contentful/actions/entries/get-entry-with-replacement.action'; +import CreateEntry from '../apps/contentful/actions/entries/create-entry.action'; +import UpdateEntry from '../apps/contentful/actions/entries/update-entry.action'; +import DeleteEntry from '../apps/contentful/actions/entries/delete-entry.action'; +import PublishEntry from '../apps/contentful/actions/entries/publish-entry.action'; +import UnpublishEntry from '../apps/contentful/actions/entries/unpublish-entry.action'; +import ArchiveEntry from '../apps/contentful/actions/entries/archive-entry.action'; +import SearchEntries from '../apps/contentful/actions/entries/search-entries.action'; +import GetAsset from '../apps/contentful/actions/assets/get-asset.action'; +import CreateAsset from '../apps/contentful/actions/assets/create-asset.action'; +import UpdateAsset from '../apps/contentful/actions/assets/update-asset.action'; +import DeleteAsset from '../apps/contentful/actions/assets/delete-asset.action'; +import PublishAsset from '../apps/contentful/actions/assets/publish-asset.action'; +import UnpublishAsset from '../apps/contentful/actions/assets/unpublish-asset.action'; +import ArchiveAsset from '../apps/contentful/actions/assets/archive-asset.action'; +import SearchAssets from '../apps/contentful/actions/assets/search-assets.action'; +import GetContentType from '../apps/contentful/actions/content-types/get-content-type.action'; +import CreateContentType from '../apps/contentful/actions/content-types/create-content-type.action'; +import UpdateContentType from '../apps/contentful/actions/content-types/update-content-type.action'; +import DeleteContentType from '../apps/contentful/actions/content-types/delete-content-type.action'; +import ActivateContentType from '../apps/contentful/actions/content-types/activate-content-type.action'; +import DeactivateContentType from '../apps/contentful/actions/content-types/deactivate-content-type.action'; +import AddField from '../apps/contentful/actions/content-types/add-field.action'; +import UpdateField from '../apps/contentful/actions/content-types/update-field.action'; +import DeleteField from '../apps/contentful/actions/content-types/delete-field.action'; +import SearchContentTypes from '../apps/contentful/actions/content-types/search-content-types.action'; +import WatchEvent from '../apps/contentful/triggers/watch-event.trigger'; +import { getContentfulEntryFieldOptions, getContentfulEntryDynamicResponseType } from '../apps/contentful/helpers/get-dynamic-entry-type'; +import { getContentfulScopedClient } from '../apps/contentful/client'; +import { CONTENTFUL_API_URL } from '../apps/contentful/constants'; +import { delay } from '../global/helpers'; +import { checkAllowedValues, skipOnTransientError } from './utils'; +import { Debugger, DebugLevels } from '../utils/Debugger'; + +Debugger.level = DebugLevels.Verbose; +configDotenv({ path: '.env' }); + +/** + * Safely call api_function on an action, narrowing the type via `in` check. + */ +const callAction = async ( + action: Record, + opts: Record, + context: Record +): Promise> => { + if (!('api_function' in action) || typeof action.api_function !== 'function') { + throw new Error('api_function not found in action'); + } + return action.api_function(opts, undefined, context); +}; + +describe('Should test Contentful actions', () => { + const accessToken = process.env.CONTENTFUL_ACCESS_TOKEN; + const spaceId = process.env.CONTENTFUL_SPACE_ID; + const hasCredentials = !!(accessToken); + + const baseContext = { + conn_opts: { + token: accessToken || '', + } as Record, + }; + + const baseOpts = { + space_id: spaceId || '', + environment_id: 'master', + }; + + let testContentTypeId: string | undefined; + + // ==================== Ping URL Test ==================== + describe('Should test Contentful ping URL', () => { + it('Should successfully ping the Contentful API', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const response = await fetch(`${CONTENTFUL_API_URL}/spaces`, { + method: 'GET', + headers: { + Authorization: `Bearer ${accessToken}`, + }, + }); + expect(response.ok).toBe(true); + const data = await response.json(); + expect(data).toBeDefined(); + expect(data.items).toBeDefined(); + expect(Array.isArray(data.items)).toBe(true); + })); + + it('Should fail to ping with invalid credentials', async () => { + const response = await fetch(`${CONTENTFUL_API_URL}/spaces`, { + method: 'GET', + headers: { + Authorization: 'Bearer invalid-token-12345', + }, + }); + expect(response.ok).toBe(false); + expect(response.status).toBe(401); + }); + }); + + // ==================== Allowed Values Tests ==================== + describe('Should test Contentful allowed values', () => { + afterEach(async () => { + await delay(500); + }); + + it('Should return space allowed values', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const allowedValues = await getContentfulSpaceAllowedValues(baseContext); + checkAllowedValues(allowedValues, { checkNonEmpty: true }); + if(!baseOpts.space_id && spaceId) { + expect(allowedValues.some(av => av.value === spaceId)).toBe(true); + baseOpts.space_id = spaceId; + } + })); + + it('Should return empty space allowed values when connection options are missing', async () => { + const allowedValues = await getContentfulSpaceAllowedValues({}); + checkAllowedValues(allowedValues, { checkNonEmpty: false }); + expect(allowedValues.length).toBe(0); + }); + + it('Should return environment allowed values', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const allowedValues = await getContentfulEnvironmentAllowedValues({ + ...baseContext, + opts: { space_id: spaceId }, + }); + checkAllowedValues(allowedValues, { checkNonEmpty: true }); + })); + + it('Should return empty environment allowed values when space_id is missing', async () => { + const allowedValues = await getContentfulEnvironmentAllowedValues(baseContext); + checkAllowedValues(allowedValues, { checkNonEmpty: false }); + expect(allowedValues.length).toBe(0); + }); + + it('Should return content type allowed values', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const allowedValues = await getContentfulContentTypeAllowedValues({ + ...baseContext, + opts: { space_id: spaceId }, + }); + checkAllowedValues(allowedValues, { checkNonEmpty: true }); + testContentTypeId = allowedValues[0]?.value as string; + })); + + it('Should return empty content type allowed values when space_id is missing', async () => { + const allowedValues = await getContentfulContentTypeAllowedValues(baseContext); + checkAllowedValues(allowedValues, { checkNonEmpty: false }); + expect(allowedValues.length).toBe(0); + }); + + it('Should return entry allowed values', skipOnTransientError(async () => { + if (!hasCredentials || !testContentTypeId) { + return; + } + const allowedValues = await getContentfulEntryAllowedValues({ + ...baseContext, + opts: { space_id: spaceId, content_type_id: testContentTypeId }, + }); + checkAllowedValues(allowedValues, { checkNonEmpty: false }); + })); + + it('Should return empty entry allowed values when space_id is missing', async () => { + const allowedValues = await getContentfulEntryAllowedValues(baseContext); + checkAllowedValues(allowedValues, { checkNonEmpty: false }); + expect(allowedValues.length).toBe(0); + }); + + it('Should return field allowed values', skipOnTransientError(async () => { + if (!hasCredentials || !testContentTypeId) { + return; + } + const allowedValues = await getContentfulFieldAllowedValues({ + ...baseContext, + opts: { space_id: spaceId, content_type_id: testContentTypeId }, + }); + checkAllowedValues(allowedValues, { checkNonEmpty: true }); + })); + + it('Should return empty field allowed values when content_type_id is missing', async () => { + const allowedValues = await getContentfulFieldAllowedValues({ + ...baseContext, + opts: { space_id: spaceId }, + }); + checkAllowedValues(allowedValues, { checkNonEmpty: false }); + expect(allowedValues.length).toBe(0); + }); + + it('Should return asset allowed values', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const allowedValues = await getContentfulAssetAllowedValues({ + ...baseContext, + opts: { space_id: spaceId }, + }); + checkAllowedValues(allowedValues, { checkNonEmpty: false }); + })); + + it('Should return empty asset allowed values when space_id is missing', async () => { + const allowedValues = await getContentfulAssetAllowedValues(baseContext); + checkAllowedValues(allowedValues, { checkNonEmpty: false }); + expect(allowedValues.length).toBe(0); + }); + }); + + // ==================== Dynamic Type Tests ==================== + describe('Should test Contentful dynamic types', () => { + afterEach(async () => { + await delay(500); + }); + + it('Should return dynamic field options for a content type', skipOnTransientError(async () => { + if (!hasCredentials || !testContentTypeId) { + return; + } + const dynamicType = await getContentfulEntryFieldOptions({ + ...baseContext, + opts: { space_id: spaceId, content_type_id: testContentTypeId }, + } as unknown as Record) as unknown as Record; + expect(dynamicType).toBeDefined(); + expect(dynamicType.type).toBe('hash'); + expect(dynamicType.fields).toBeDefined(); + const fields = dynamicType.fields as Record; + expect(Object.keys(fields).length).toBeGreaterThan(0); + // The 'test' content type has a 'something' field of type Symbol + expect(fields.something).toBeDefined(); + })); + + it('Should return dynamic response type for a content type', skipOnTransientError(async () => { + if (!hasCredentials || !testContentTypeId) { + return; + } + const dynamicType = await getContentfulEntryDynamicResponseType({ + ...baseContext, + opts: { space_id: spaceId, content_type_id: testContentTypeId }, + } as unknown as Record) as unknown as Record; + expect(dynamicType).toBeDefined(); + expect(dynamicType.type).toBe('hash'); + expect(dynamicType.fields).toBeDefined(); + const fields = dynamicType.fields as Record; + // Should include system fields + expect(fields.id).toBeDefined(); + expect(fields.content_type).toBeDefined(); + expect(fields.created_at).toBeDefined(); + expect(fields.updated_at).toBeDefined(); + expect(fields.version).toBeDefined(); + // Should include content type-specific fields + expect(fields.something).toBeDefined(); + })); + + it('Should return fallback hash type when content_type_id is missing', async () => { + try { + await getContentfulEntryFieldOptions({ + ...baseContext, + opts: { space_id: spaceId }, + } as unknown as Record); + fail('Should have thrown'); + } catch (error) { + expect(error).toBeInstanceOf(ContentfulError); + } + }); + }); + + // ==================== Content Type Actions Tests ==================== + describe('Should test Contentful content type actions', () => { + let createdContentTypeId: string | undefined; + + afterEach(async () => { + await delay(1000); + }); + + afterAll(async () => { + if (!hasCredentials || !createdContentTypeId) { + return; + } + try { + const client = getContentfulScopedClient(baseContext, spaceId!, 'master'); + try { + await client.contentType.unpublish({ contentTypeId: createdContentTypeId }); + } catch { + // May already be unpublished + } + await client.contentType.delete({ contentTypeId: createdContentTypeId }); + } catch { + // Best-effort cleanup + } + }); + + it('Should search content types', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const result = await callAction( + SearchContentTypes as unknown as Record, + { ...baseOpts, limit: 5 }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(Array.isArray(result)).toBe(true); + })); + + it('Should get a content type', skipOnTransientError(async () => { + if (!hasCredentials || !testContentTypeId) { + return; + } + const result = await callAction( + GetContentType as unknown as Record, + { ...baseOpts, content_type_id: testContentTypeId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(testContentTypeId); + expect(result.name).toBeDefined(); + expect(result.fields).toBeDefined(); + })); + + it('Should create a content type', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const uniqueName = `Test CT ${Date.now()}`; + const result = await callAction( + CreateContentType as unknown as Record, + { + ...baseOpts, + name: uniqueName, + description: 'Test content type created by integration tests', + fields: [ + { id: 'title', name: 'Title', type: 'Symbol', required: true, localized: false }, + { id: 'body', name: 'Body', type: 'Text', required: false, localized: false }, + ], + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBeDefined(); + expect(result.name).toBe(uniqueName); + expect(result.fields).toBeDefined(); + expect((result.fields as unknown[]).length).toBe(2); + createdContentTypeId = result.id as string; + })); + + it('Should update a content type', skipOnTransientError(async () => { + if (!hasCredentials || !createdContentTypeId) { + return; + } + const updatedName = `Updated CT ${Date.now()}`; + const result = await callAction( + UpdateContentType as unknown as Record, + { + ...baseOpts, + content_type_id: createdContentTypeId, + name: updatedName, + description: 'Updated description', + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.name).toBe(updatedName); + })); + + it('Should add a field to a content type', skipOnTransientError(async () => { + if (!hasCredentials || !createdContentTypeId) { + return; + } + const result = await callAction( + AddField as unknown as Record, + { + ...baseOpts, + content_type_id: createdContentTypeId, + field_id: 'testNumber', + field_name: 'Test Number', + field_type: 'Integer', + required: false, + localized: false, + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + const fields = result.fields as Record[]; + expect(fields.length).toBe(3); + expect(fields.some((f) => f.id === 'testNumber')).toBe(true); + })); + + it('Should update a field of a content type', skipOnTransientError(async () => { + if (!hasCredentials || !createdContentTypeId) { + return; + } + const result = await callAction( + UpdateField as unknown as Record, + { + ...baseOpts, + content_type_id: createdContentTypeId, + field_id: 'testNumber', + field_name: 'Updated Number Field', + required: true, + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + const fields = result.fields as Record[]; + const updatedField = fields.find((f) => f.id === 'testNumber'); + expect(updatedField).toBeDefined(); + expect(updatedField!.name).toBe('Updated Number Field'); + })); + + it('Should activate a content type', skipOnTransientError(async () => { + if (!hasCredentials || !createdContentTypeId) { + return; + } + const result = await callAction( + ActivateContentType as unknown as Record, + { ...baseOpts, content_type_id: createdContentTypeId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdContentTypeId); + })); + + it('Should deactivate a content type', skipOnTransientError(async () => { + if (!hasCredentials || !createdContentTypeId) { + return; + } + const result = await callAction( + DeactivateContentType as unknown as Record, + { ...baseOpts, content_type_id: createdContentTypeId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdContentTypeId); + })); + + it('Should delete a field from a content type', skipOnTransientError(async () => { + if (!hasCredentials || !createdContentTypeId) { + return; + } + const result = await callAction( + DeleteField as unknown as Record, + { + ...baseOpts, + content_type_id: createdContentTypeId, + field_id: 'testNumber', + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + const fields = result.fields as Record[]; + expect(fields.every((f) => f.id !== 'testNumber')).toBe(true); + })); + + it('Should delete a content type', skipOnTransientError(async () => { + if (!hasCredentials || !createdContentTypeId) { + return; + } + const result = await callAction( + DeleteContentType as unknown as Record, + { ...baseOpts, content_type_id: createdContentTypeId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdContentTypeId); + expect(result.deleted).toBe(true); + createdContentTypeId = undefined; + })); + }); + + // ==================== Entry Actions Tests ==================== + describe('Should test Contentful entry actions', () => { + let createdEntryId: string | undefined; + + afterEach(async () => { + await delay(1000); + }); + + afterAll(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + try { + const client = getContentfulScopedClient(baseContext, spaceId!, 'master'); + try { + await client.entry.unpublish({ entryId: createdEntryId }); + } catch { + // May already be unpublished + } + try { + const entry = await client.entry.get({ entryId: createdEntryId }); + if ((entry.sys as unknown as Record).archivedVersion) { + await client.entry.unarchive({ entryId: createdEntryId }); + } + } catch { + // May not exist + } + await client.entry.delete({ entryId: createdEntryId }); + } catch { + // Best-effort cleanup + } + }); + + it('Should search entries', skipOnTransientError(async () => { + if (!hasCredentials || !testContentTypeId) { + return; + } + const result = await callAction( + SearchEntries as unknown as Record, + { ...baseOpts, content_type_id: testContentTypeId, limit: 5 }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(Array.isArray(result)).toBe(true); + })); + + it('Should create an entry', skipOnTransientError(async () => { + if (!hasCredentials || !testContentTypeId) { + return; + } + const result = await callAction( + CreateEntry as unknown as Record, + { + ...baseOpts, + content_type_id: testContentTypeId, + fields: { something: `Test Entry ${Date.now()}` }, + publish: false, + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBeDefined(); + createdEntryId = result.id as string; + })); + + it('Should get an entry', skipOnTransientError(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + const result = await callAction( + GetEntry as unknown as Record, + { ...baseOpts, content_type_id: testContentTypeId, entry_id: createdEntryId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdEntryId); + })); + + it('Should update an entry', skipOnTransientError(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + const updatedValue = `Updated Entry ${Date.now()}`; + const result = await callAction( + UpdateEntry as unknown as Record, + { + ...baseOpts, + content_type_id: testContentTypeId, + entry_id: createdEntryId, + fields: { something: updatedValue }, + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.something).toBe(updatedValue); + })); + + it('Should get an entry with replacement', skipOnTransientError(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + const result = await callAction( + GetEntryWithReplacement as unknown as Record, + { + ...baseOpts, + content_type_id: testContentTypeId, + entry_id: createdEntryId, + replacements: [{ tag: 'Updated', value: 'Replaced' }], + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdEntryId); + if (typeof result.something === 'string') { + expect(result.something).toContain('Replaced'); + } + })); + + it('Should publish an entry', skipOnTransientError(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + const result = await callAction( + PublishEntry as unknown as Record, + { ...baseOpts, entry_id: createdEntryId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdEntryId); + expect(result.version).toBeDefined(); + })); + + it('Should unpublish an entry', skipOnTransientError(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + const result = await callAction( + UnpublishEntry as unknown as Record, + { ...baseOpts, entry_id: createdEntryId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdEntryId); + })); + + it('Should archive an entry', skipOnTransientError(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + const result = await callAction( + ArchiveEntry as unknown as Record, + { ...baseOpts, entry_id: createdEntryId, archive: true }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdEntryId); + expect(result.archived).toBe(true); + })); + + it('Should unarchive an entry', skipOnTransientError(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + const result = await callAction( + ArchiveEntry as unknown as Record, + { ...baseOpts, entry_id: createdEntryId, archive: false }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdEntryId); + expect(result.archived).toBe(false); + })); + + it('Should delete an entry', skipOnTransientError(async () => { + if (!hasCredentials || !createdEntryId) { + return; + } + const result = await callAction( + DeleteEntry as unknown as Record, + { ...baseOpts, content_type_id: testContentTypeId, entry_id: createdEntryId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdEntryId); + expect(result.deleted).toBe(true); + createdEntryId = undefined; + })); + }); + + // ==================== Asset Actions Tests ==================== + describe('Should test Contentful asset actions', () => { + let createdAssetId: string | undefined; + + afterEach(async () => { + await delay(1000); + }); + + afterAll(async () => { + if (!hasCredentials || !createdAssetId) { + return; + } + try { + const client = getContentfulScopedClient(baseContext, spaceId!, 'master'); + try { + await client.asset.unpublish({ assetId: createdAssetId }); + } catch { + // May already be unpublished + } + try { + const asset = await client.asset.get({ assetId: createdAssetId }); + if ((asset.sys as unknown as Record).archivedVersion) { + await client.asset.unarchive({ assetId: createdAssetId }); + } + } catch { + // May not exist + } + await client.asset.delete({ assetId: createdAssetId }); + } catch { + // Best-effort cleanup + } + }); + + it('Should search assets', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const result = await callAction( + SearchAssets as unknown as Record, + { ...baseOpts, limit: 5 }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(Array.isArray(result)).toBe(true); + })); + + it('Should create an asset', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const result = await callAction( + CreateAsset as unknown as Record, + { + ...baseOpts, + title: `Test Asset ${Date.now()}`, + description: 'Test asset created by integration tests', + file_name: 'test-image.png', + file_url: 'https://upload.wikimedia.org/wikipedia/commons/thumb/4/47/PNG_transparency_demonstration_1.png/100px-PNG_transparency_demonstration_1.png', + content_type: 'image/png', + publish: false, + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBeDefined(); + createdAssetId = result.id as string; + }), 60000); + + it('Should get an asset', skipOnTransientError(async () => { + if (!hasCredentials || !createdAssetId) { + return; + } + const result = await callAction( + GetAsset as unknown as Record, + { ...baseOpts, asset_id: createdAssetId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdAssetId); + })); + + it('Should update an asset', skipOnTransientError(async () => { + if (!hasCredentials || !createdAssetId) { + return; + } + const updatedTitle = `Updated Asset ${Date.now()}`; + const result = await callAction( + UpdateAsset as unknown as Record, + { + ...baseOpts, + asset_id: createdAssetId, + title: updatedTitle, + }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.title).toBe(updatedTitle); + })); + + it('Should publish an asset', skipOnTransientError(async () => { + if (!hasCredentials || !createdAssetId) { + return; + } + const result = await callAction( + PublishAsset as unknown as Record, + { ...baseOpts, asset_id: createdAssetId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdAssetId); + })); + + it('Should unpublish an asset', skipOnTransientError(async () => { + if (!hasCredentials || !createdAssetId) { + return; + } + const result = await callAction( + UnpublishAsset as unknown as Record, + { ...baseOpts, asset_id: createdAssetId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdAssetId); + })); + + it('Should archive an asset', skipOnTransientError(async () => { + if (!hasCredentials || !createdAssetId) { + return; + } + const result = await callAction( + ArchiveAsset as unknown as Record, + { ...baseOpts, asset_id: createdAssetId, archive: true }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdAssetId); + expect(result.archived).toBe(true); + })); + + it('Should unarchive an asset', skipOnTransientError(async () => { + if (!hasCredentials || !createdAssetId) { + return; + } + const result = await callAction( + ArchiveAsset as unknown as Record, + { ...baseOpts, asset_id: createdAssetId, archive: false }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdAssetId); + expect(result.archived).toBe(false); + })); + + it('Should delete an asset', skipOnTransientError(async () => { + if (!hasCredentials || !createdAssetId) { + return; + } + const result = await callAction( + DeleteAsset as unknown as Record, + { ...baseOpts, asset_id: createdAssetId }, + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + expect(result.id).toBe(createdAssetId); + expect(result.deleted).toBe(true); + createdAssetId = undefined; + })); + }); + + // ==================== Trigger Tests ==================== + describe('Should test Contentful trigger', () => { + it('Should return example data matching event_info schema', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + const trigger = WatchEvent as TQoreAppActionWithWebhook; + + if (!('get_example_event_data' in trigger) || !trigger.get_example_event_data) { + throw new Error('get_example_event_data not found in trigger'); + } + + const result = await trigger.get_example_event_data( + baseContext as unknown as Record + ); + expect(result).toBeDefined(); + + const eventInfo = trigger.event_info!; + const eventType = eventInfo.type as { fields: Record }; + const eventInfoFields = Object.keys(eventType.fields); + const exampleFields = Object.keys(result); + + const missingFields = eventInfoFields.filter((f) => !exampleFields.includes(f)); + expect(missingFields).toEqual([]); + + const extraFields = exampleFields.filter((f) => !eventInfoFields.includes(f)); + expect(extraFields).toEqual([]); + })); + }); + + // ==================== Negative Tests ==================== + describe('Should test Contentful negative cases', () => { + it('Should throw error with invalid access token', async () => { + const invalidContext = { + conn_opts: { + token: 'invalid-token-12345', + } as Record, + }; + + await expect( + callAction( + GetEntry as unknown as Record, + { space_id: spaceId || 'test', entry_id: 'nonexistent' }, + invalidContext as unknown as Record + ) + ).rejects.toThrow(ContentfulError); + }); + + it('Should throw error when entry does not exist', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + await expect( + callAction( + GetEntry as unknown as Record, + { ...baseOpts, content_type_id: testContentTypeId, entry_id: 'nonexistent-entry-id' }, + baseContext as unknown as Record + ) + ).rejects.toThrow(ContentfulError); + })); + + it('Should throw error when asset does not exist', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + await expect( + callAction( + GetAsset as unknown as Record, + { ...baseOpts, asset_id: 'nonexistent-asset-id' }, + baseContext as unknown as Record + ) + ).rejects.toThrow(ContentfulError); + })); + + it('Should throw error when content type does not exist', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + await expect( + callAction( + GetContentType as unknown as Record, + { ...baseOpts, content_type_id: 'nonexistent-content-type-id' }, + baseContext as unknown as Record + ) + ).rejects.toThrow(ContentfulError); + })); + + it('Should throw error when required fields are missing', skipOnTransientError(async () => { + if (!hasCredentials) { + return; + } + await expect( + callAction( + CreateEntry as unknown as Record, + { space_id: spaceId } as Record, + baseContext as unknown as Record + ) + ).rejects.toThrow(); + })); + }); +}); diff --git a/ts/src/tests/slack.test.ts b/ts/src/tests/slack.test.ts index a828cff9..0b0421ca 100644 --- a/ts/src/tests/slack.test.ts +++ b/ts/src/tests/slack.test.ts @@ -154,6 +154,9 @@ describe('Should test Slack', () => { it('Should get channel allowed values', async () => { const allowedValues = await getSlackChannelsAllowedValues(baseContext); + console.log('Length of allowed values:', allowedValues.length); + console.dir(allowedValues, { depth: null }); + expect(allowedValues).toBeDefined(); expect(Array.isArray(allowedValues)).toBe(true); diff --git a/ts/yarn.lock b/ts/yarn.lock index bb364ad7..94ae890e 100644 --- a/ts/yarn.lock +++ b/ts/yarn.lock @@ -1457,6 +1457,13 @@ __metadata: languageName: node linkType: hard +"@contentful/rich-text-types@npm:^16.6.1": + version: 16.8.5 + resolution: "@contentful/rich-text-types@npm:16.8.5" + checksum: 10c0/0af82d501bb26d854fa3bc68136db1f0738428135066876062370637f219cd51f10abecf8e02a72c2cf9eb012523add21f4a3f72af4981a7ad4c95a9bbcb237f + languageName: node + linkType: hard + "@cspotcode/source-map-support@npm:^0.8.0": version: 0.8.1 resolution: "@cspotcode/source-map-support@npm:0.8.1" @@ -4906,6 +4913,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-x64-gnu@npm:^4.18.0": + version: 4.59.0 + resolution: "@rollup/rollup-linux-x64-gnu@npm:4.59.0" + conditions: os=linux & cpu=x64 & libc=glibc + languageName: node + linkType: hard + "@rtsao/scc@npm:^1.1.0": version: 1.1.0 resolution: "@rtsao/scc@npm:1.1.0" @@ -6844,7 +6858,7 @@ __metadata: languageName: node linkType: hard -"axios@npm:^1.6.7": +"axios@npm:^1.13.5, axios@npm:^1.6.7": version: 1.13.6 resolution: "axios@npm:1.13.6" dependencies: @@ -7628,6 +7642,35 @@ __metadata: languageName: node linkType: hard +"contentful-management@npm:^11.74.0": + version: 11.74.0 + resolution: "contentful-management@npm:11.74.0" + dependencies: + "@contentful/rich-text-types": "npm:^16.6.1" + axios: "npm:^1.13.5" + contentful-sdk-core: "npm:^9.4.4" + fast-copy: "npm:^3.0.0" + globals: "npm:^15.15.0" + checksum: 10c0/9b53bb096a3319d4287fd1697dc51ce99a09ed253f1d1bc9d2572e7ba1e178efe032c1ee1d49aa7df4fdca22c1b4955dd9ffbf659f864e6523f47c244cdf8c1a + languageName: node + linkType: hard + +"contentful-sdk-core@npm:^9.4.4": + version: 9.4.4 + resolution: "contentful-sdk-core@npm:9.4.4" + dependencies: + "@rollup/rollup-linux-x64-gnu": "npm:^4.18.0" + fast-copy: "npm:^3.0.2" + lodash: "npm:^4.17.23" + process: "npm:^0.11.10" + qs: "npm:^6.15.0" + dependenciesMeta: + "@rollup/rollup-linux-x64-gnu": + optional: true + checksum: 10c0/70d011fded18274a13bf86213b71916e4b94057e0393b0d3c1da5478002ffbe816db4803644b3f8fb3cec488062645241504eca2121313c6df09f61b85012cfd + languageName: node + linkType: hard + "convert-source-map@npm:^2.0.0": version: 2.0.0 resolution: "convert-source-map@npm:2.0.0" @@ -9012,6 +9055,13 @@ __metadata: languageName: node linkType: hard +"fast-copy@npm:^3.0.0, fast-copy@npm:^3.0.2": + version: 3.0.2 + resolution: "fast-copy@npm:3.0.2" + checksum: 10c0/02e8b9fd03c8c024d2987760ce126456a0e17470850b51e11a1c3254eed6832e4733ded2d93316c82bc0b36aeb991ad1ff48d1ba95effe7add7c3ab8d8eb554a + languageName: node + linkType: hard + "fast-deep-equal@npm:^3.1.1, fast-deep-equal@npm:^3.1.3": version: 3.1.3 resolution: "fast-deep-equal@npm:3.1.3" @@ -9618,7 +9668,7 @@ __metadata: languageName: node linkType: hard -"globals@npm:^15.11.0": +"globals@npm:^15.11.0, globals@npm:^15.15.0": version: 15.15.0 resolution: "globals@npm:15.15.0" checksum: 10c0/f9ae80996392ca71316495a39bec88ac43ae3525a438b5626cd9d5ce9d5500d0a98a266409605f8cd7241c7acf57c354a48111ea02a767ba4f374b806d6861fe @@ -11606,6 +11656,13 @@ __metadata: languageName: node linkType: hard +"lodash@npm:^4.17.23": + version: 4.17.23 + resolution: "lodash@npm:4.17.23" + checksum: 10c0/1264a90469f5bb95d4739c43eb6277d15b6d9e186df4ac68c3620443160fc669e2f14c11e7d8b2ccf078b81d06147c01a8ccced9aab9f9f63d50dcf8cace6bf6 + languageName: node + linkType: hard + "long@npm:^4.0.0": version: 4.0.0 resolution: "long@npm:4.0.0" @@ -13813,6 +13870,7 @@ __metadata: axios: "npm:^1.12.0" azure-devops-node-api: "npm:^15.1.1" brace-expansion: "npm:^4.0.1" + contentful-management: "npm:^11.74.0" copyfiles: "npm:^2.4.1" cross-env: "npm:^10.1.0" dayjs: "npm:^1.11.18" @@ -13876,6 +13934,15 @@ __metadata: languageName: node linkType: hard +"qs@npm:^6.15.0": + version: 6.15.0 + resolution: "qs@npm:6.15.0" + dependencies: + side-channel: "npm:^1.1.0" + checksum: 10c0/ff341078a78a991d8a48b4524d52949211447b4b1ad907f489cac0770cbc346a28e47304455c0320e5fb000f8762d64b03331e3b71865f663bf351bcba8cdb4b + languageName: node + linkType: hard + "querystringify@npm:^2.1.1": version: 2.2.0 resolution: "querystringify@npm:2.2.0"