ampscript-data 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/index.js +22 -11
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ampscript-data",
3
- "version": "2.0.1",
3
+ "version": "2.0.3",
4
4
  "description": "Canonical AMPscript function catalog, keywords, and personalization strings for SFMC tooling",
5
5
  "type": "module",
6
6
  "main": "src/index.js",
package/src/index.js CHANGED
@@ -744,7 +744,11 @@ export const FUNCTIONS = [
744
744
  description:
745
745
  'Generates a secure, encrypted URL to a CloudPages landing page, optionally passing name-value parameters.',
746
746
  params: [
747
- { name: 'pageId', description: 'CloudPages page ID (number or string)' },
747
+ {
748
+ name: 'pageId',
749
+ description: 'CloudPages page ID (number or string)',
750
+ type: 'string|number',
751
+ },
748
752
  {
749
753
  name: 'paramName1',
750
754
  description: 'Query parameter name',
@@ -795,7 +799,7 @@ export const FUNCTIONS = [
795
799
  returnType: 'string',
796
800
  returnDescription: 'The concatenation of all supplied values as a single string.',
797
801
  repeat: [{ startIndex: 0, groupSize: 1, minGroups: 2 }],
798
- syntax: 'Concat(string1, string2[, ...])',
802
+ syntax: 'Concat(string1, string2[, stringN, ...])',
799
803
  example: "%%=Concat('Hello', ' ', 'World')=%%",
800
804
  },
801
805
  {
@@ -2681,7 +2685,7 @@ export const FUNCTIONS = [
2681
2685
  category: 'Marketing Cloud API',
2682
2686
  description: 'Calls the SOAP API Create method on the given API object.',
2683
2687
  params: [
2684
- { name: 'apiObject', description: 'API object to create' },
2688
+ { name: 'apiObject', description: 'API object to create', type: 'object' },
2685
2689
  {
2686
2690
  name: 'statusMessage',
2687
2691
  mcnSince: null,
@@ -2701,6 +2705,7 @@ export const FUNCTIONS = [
2701
2705
  mcnSince: null,
2702
2706
  mcnNotes: null,
2703
2707
  description: 'Optional CreateOptions API object',
2708
+ type: 'object',
2704
2709
  optional: true,
2705
2710
  },
2706
2711
  ],
@@ -2720,7 +2725,7 @@ export const FUNCTIONS = [
2720
2725
  category: 'Marketing Cloud API',
2721
2726
  description: 'Calls the SOAP API Delete method on the given API object.',
2722
2727
  params: [
2723
- { name: 'apiObject', description: 'API object to delete' },
2728
+ { name: 'apiObject', description: 'API object to delete', type: 'object' },
2724
2729
  {
2725
2730
  name: 'statusMessage',
2726
2731
  mcnSince: null,
@@ -2740,6 +2745,7 @@ export const FUNCTIONS = [
2740
2745
  mcnSince: null,
2741
2746
  mcnNotes: null,
2742
2747
  description: 'Optional DeleteOptions API object',
2748
+ type: 'object',
2743
2749
  optional: true,
2744
2750
  },
2745
2751
  ],
@@ -2760,7 +2766,7 @@ export const FUNCTIONS = [
2760
2766
  description:
2761
2767
  'Calls the SOAP API Execute method on the given API object and returns the API status code.',
2762
2768
  params: [
2763
- { name: 'apiObject', description: 'The API object to execute' },
2769
+ { name: 'apiObject', description: 'The API object to execute', type: 'object' },
2764
2770
  {
2765
2771
  name: 'statusMessage',
2766
2772
  mcnSince: null,
@@ -2793,7 +2799,7 @@ export const FUNCTIONS = [
2793
2799
  category: 'Marketing Cloud API',
2794
2800
  description: 'Calls the SOAP API Perform method on the given API object.',
2795
2801
  params: [
2796
- { name: 'apiObject', description: 'API object to perform on' },
2802
+ { name: 'apiObject', description: 'API object to perform on', type: 'object' },
2797
2803
  {
2798
2804
  name: 'actionToPerform',
2799
2805
  description: 'Action to perform; valid values vary by object type',
@@ -2824,7 +2830,11 @@ export const FUNCTIONS = [
2824
2830
  category: 'Marketing Cloud API',
2825
2831
  description: 'Calls the SOAP API Retrieve method and returns a rowset of results.',
2826
2832
  params: [
2827
- { name: 'apiObject', description: 'API object defining the retrieve filter' },
2833
+ {
2834
+ name: 'apiObject',
2835
+ description: 'API object defining the retrieve filter',
2836
+ type: 'object',
2837
+ },
2828
2838
  {
2829
2839
  name: 'statusMessage',
2830
2840
  mcnSince: null,
@@ -2858,7 +2868,7 @@ export const FUNCTIONS = [
2858
2868
  category: 'Marketing Cloud API',
2859
2869
  description: 'Calls the SOAP API Update method on the given API object.',
2860
2870
  params: [
2861
- { name: 'apiObject', description: 'API object to update' },
2871
+ { name: 'apiObject', description: 'API object to update', type: 'object' },
2862
2872
  {
2863
2873
  name: 'statusMessage',
2864
2874
  mcnSince: null,
@@ -2880,6 +2890,7 @@ export const FUNCTIONS = [
2880
2890
  mcnSince: null,
2881
2891
  mcnNotes: null,
2882
2892
  description: 'Optional UpdateOptions API object',
2893
+ type: 'object',
2883
2894
  optional: true,
2884
2895
  },
2885
2896
  ],
@@ -3967,7 +3978,7 @@ export const FUNCTIONS = [
3967
3978
  category: 'Data Extension',
3968
3979
  description: 'Returns a specific row from a rowset by its 1-based index.',
3969
3980
  params: [
3970
- { name: 'rowset', description: 'Rowset to access' },
3981
+ { name: 'rowset', description: 'Rowset to access', type: 'rowset' },
3971
3982
  { name: 'rowIndex', description: '1-based row index', type: 'number' },
3972
3983
  ],
3973
3984
  returnType: 'row',
@@ -3985,7 +3996,7 @@ export const FUNCTIONS = [
3985
3996
  maxArgs: 1,
3986
3997
  category: 'Data Extension',
3987
3998
  description: 'Returns the number of rows in a rowset.',
3988
- params: [{ name: 'rowset', description: 'Rowset to count' }],
3999
+ params: [{ name: 'rowset', description: 'Rowset to count', type: 'rowset' }],
3989
4000
  returnType: 'number',
3990
4001
  returnDescription: 'The number of rows in the rowset.',
3991
4002
  syntax: 'RowCount(rowset)',
@@ -4002,7 +4013,7 @@ export const FUNCTIONS = [
4002
4013
  category: 'Marketing Cloud API',
4003
4014
  description: 'Sets a property value on a Marketing Cloud API object.',
4004
4015
  params: [
4005
- { name: 'apiObject', description: 'API object reference' },
4016
+ { name: 'apiObject', description: 'API object reference', type: 'object' },
4006
4017
  {
4007
4018
  name: 'propertyName',
4008
4019
  description: 'The name of the property to assign a value to',