@messagebird/n8n-nodes-bird 0.12.0 → 0.13.1

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.
@@ -662,7 +662,7 @@ exports.birdProperties = [
662
662
  name: "scheduled_at",
663
663
  type: "dateTime",
664
664
  default: "",
665
- description: "Schedule the message to send at a future time instead of immediately. Must be at least 30 seconds and at most 30 days ahead. Outside that range the request is rejected with `422`. The message returns with status `accepted` and shows as `scheduled` on reads until it sends. Cancel it before then with the message cancel endpoint. Scheduled sends count against your plan's monthly scheduled-email allowance. Exceeding it is rejected with a `422`. A scheduled message has inline content: `scheduled_at` and `template` are mutually exclusive, and combining them is rejected with a `422`. Batch items take this field too, so one batch can mix scheduled and immediate messages.",
665
+ description: "Schedule the message to send at a future time instead of immediately. Must be at least 30 seconds and at most 30 days ahead. Outside that range the request is rejected with `422`. The message returns with status `accepted` and shows as `scheduled` on reads until it sends. Cancel it before then with the message cancel endpoint. Scheduled sends count against your plan's monthly scheduled-email allowance. Exceeding it is rejected with a `422`. For a stored template, the published version, language and parameter values are pinned when we accept the request, so a later publication does not change what sends. If the template is deleted before the message is due, the message is rejected with `generation_failure`. We also check sender eligibility and send-volume allowance when the message is due. Batch items take this field too, so one batch can mix scheduled and immediate messages.",
666
666
  },
667
667
  {
668
668
  displayName: "Subject",
@@ -708,7 +708,7 @@ exports.birdProperties = [
708
708
  type: "collection",
709
709
  placeholder: "Add Field",
710
710
  default: {},
711
- description: "Send a stored template instead of inline content. When set, omit `subject`, `html` and `text`, because the template supplies them. Personalize with `template.parameters`. A template send goes out immediately: `template` and `scheduled_at` are mutually exclusive, and combining them is rejected with a `422`.",
711
+ description: "Send a stored template instead of inline content. When set, omit `subject`, `html` and `text`, because the template supplies them. Personalize with `template.parameters`. Add `scheduled_at` to send it later.",
712
712
  options: [
713
713
  {
714
714
  displayName: "ID",
@@ -947,7 +947,7 @@ exports.birdProperties = [
947
947
  name: "category",
948
948
  type: "string",
949
949
  default: "",
950
- description: "Restrict the statistics to a single category: `transactional` or `marketing`. Mutually exclusive with the other dimension filters; only one may be set per request.",
950
+ description: "Restrict the statistics to a category or a comma-separated union of categories: `transactional` or `marketing`. Mutually exclusive with the other dimension filters; only one may be set per request.",
951
951
  },
952
952
  {
953
953
  displayName: "Compare",
@@ -972,35 +972,35 @@ exports.birdProperties = [
972
972
  name: "recipient_domain",
973
973
  type: "string",
974
974
  default: "",
975
- description: "Restrict the statistics to a single recipient mailbox domain (the part of the recipient address after the `@`, for example `gmail.com`). Mutually exclusive with the other dimension filters; only one may be set per request.",
975
+ description: "Restrict the statistics to a recipient mailbox domain or a comma-separated union of domains (the part of the recipient address after the `@`, for example `gmail.com`). Mutually exclusive with the other dimension filters; only one may be set per request.",
976
976
  },
977
977
  {
978
978
  displayName: "Sending Domain",
979
979
  name: "sending_domain",
980
980
  type: "string",
981
981
  default: "",
982
- description: "Restrict the statistics to a single sending domain (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.",
982
+ description: "Restrict the statistics to a sending domain or a comma-separated union of sending domains (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.",
983
983
  },
984
984
  {
985
985
  displayName: "Sending IP",
986
986
  name: "sending_ip",
987
987
  type: "string",
988
988
  default: "",
989
- description: "Restrict the statistics to a single sending IP. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are `0`, and processing latency is `null`. Complaint, open, and click rates are `0` when deliveries exist and `null` otherwise.",
989
+ description: "Restrict the statistics to a sending IP or a comma-separated union of IPs. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are `0`, and processing latency is `null`. Complaint, open, and click rates are `0` when deliveries exist and `null` otherwise.",
990
990
  },
991
991
  {
992
992
  displayName: "Tag",
993
993
  name: "tag",
994
994
  type: "string",
995
995
  default: "",
996
- description: "Restrict the statistics to a single tag. Use `name` to match any value of a tag, or `name:value` for a specific pair (for example `campaign:spring_launch`). Mutually exclusive with the other dimension filters; only one may be set per request.",
996
+ description: "Restrict the statistics to a tag. Use `name` to match any value of a tag, or `name:value` for a specific pair (for example `campaign:spring_launch`). To combine values of one tag name, separate complete pairs with commas, such as `campaign:spring,campaign:summer`. Different tag names cannot be combined. Mutually exclusive with the other dimension filters; only one may be set per request.",
997
997
  },
998
998
  {
999
999
  displayName: "Template",
1000
1000
  name: "template",
1001
1001
  type: "string",
1002
1002
  default: "",
1003
- description: "Restricts the statistics to one template, identified by its ID (`emt_…`) or name. This parameter is mutually exclusive with other dimension filters.",
1003
+ description: "Restricts the statistics to a template or a comma-separated union of templates, identified by ID (`emt_…`) or name. This parameter is mutually exclusive with other dimension filters.",
1004
1004
  },
1005
1005
  {
1006
1006
  displayName: "Timezone",
@@ -1031,7 +1031,7 @@ exports.birdProperties = [
1031
1031
  name: "category",
1032
1032
  type: "string",
1033
1033
  default: "",
1034
- description: "Restrict the statistics to a single category: `transactional` or `marketing`. Mutually exclusive with the other dimension filters; only one may be set per request.",
1034
+ description: "Restrict the statistics to a category or a comma-separated union of categories: `transactional` or `marketing`. Mutually exclusive with the other dimension filters; only one may be set per request.",
1035
1035
  },
1036
1036
  {
1037
1037
  displayName: "From",
@@ -1045,35 +1045,35 @@ exports.birdProperties = [
1045
1045
  name: "recipient_domain",
1046
1046
  type: "string",
1047
1047
  default: "",
1048
- description: "Restrict the statistics to a single recipient mailbox domain (the part of the recipient address after the `@`, for example `gmail.com`). Mutually exclusive with the other dimension filters; only one may be set per request.",
1048
+ description: "Restrict the statistics to a recipient mailbox domain or a comma-separated union of domains (the part of the recipient address after the `@`, for example `gmail.com`). Mutually exclusive with the other dimension filters; only one may be set per request.",
1049
1049
  },
1050
1050
  {
1051
1051
  displayName: "Sending Domain",
1052
1052
  name: "sending_domain",
1053
1053
  type: "string",
1054
1054
  default: "",
1055
- description: "Restrict the statistics to a single sending domain (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.",
1055
+ description: "Restrict the statistics to a sending domain or a comma-separated union of sending domains (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.",
1056
1056
  },
1057
1057
  {
1058
1058
  displayName: "Sending IP",
1059
1059
  name: "sending_ip",
1060
1060
  type: "string",
1061
1061
  default: "",
1062
- description: "Restrict the statistics to a single sending IP. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are `0`, and processing latency is `null`. Complaint, open, and click rates are `0` when deliveries exist and `null` otherwise.",
1062
+ description: "Restrict the statistics to a sending IP or a comma-separated union of IPs. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are `0`, and processing latency is `null`. Complaint, open, and click rates are `0` when deliveries exist and `null` otherwise.",
1063
1063
  },
1064
1064
  {
1065
1065
  displayName: "Tag",
1066
1066
  name: "tag",
1067
1067
  type: "string",
1068
1068
  default: "",
1069
- description: "Restrict the statistics to a single tag. Use `name` to match any value of a tag, or `name:value` for a specific pair (for example `campaign:spring_launch`). Mutually exclusive with the other dimension filters; only one may be set per request.",
1069
+ description: "Restrict the statistics to a tag. Use `name` to match any value of a tag, or `name:value` for a specific pair (for example `campaign:spring_launch`). To combine values of one tag name, separate complete pairs with commas, such as `campaign:spring,campaign:summer`. Different tag names cannot be combined. Mutually exclusive with the other dimension filters; only one may be set per request.",
1070
1070
  },
1071
1071
  {
1072
1072
  displayName: "Template",
1073
1073
  name: "template",
1074
1074
  type: "string",
1075
1075
  default: "",
1076
- description: "Restricts the statistics to one template, identified by its ID (`emt_…`) or name. This parameter is mutually exclusive with other dimension filters.",
1076
+ description: "Restricts the statistics to a template or a comma-separated union of templates, identified by ID (`emt_…`) or name. This parameter is mutually exclusive with other dimension filters.",
1077
1077
  },
1078
1078
  {
1079
1079
  displayName: "Timezone",
@@ -1104,7 +1104,7 @@ exports.birdProperties = [
1104
1104
  name: "category",
1105
1105
  type: "string",
1106
1106
  default: "",
1107
- description: "Restrict the statistics to a single category: `transactional` or `marketing`. Mutually exclusive with the other dimension filters; only one may be set per request.",
1107
+ description: "Restrict the statistics to a category or a comma-separated union of categories: `transactional` or `marketing`. Mutually exclusive with the other dimension filters; only one may be set per request.",
1108
1108
  },
1109
1109
  {
1110
1110
  displayName: "From",
@@ -1118,35 +1118,35 @@ exports.birdProperties = [
1118
1118
  name: "recipient_domain",
1119
1119
  type: "string",
1120
1120
  default: "",
1121
- description: "Restrict the statistics to a single recipient mailbox domain (the part of the recipient address after the `@`, for example `gmail.com`). Mutually exclusive with the other dimension filters; only one may be set per request.",
1121
+ description: "Restrict the statistics to a recipient mailbox domain or a comma-separated union of domains (the part of the recipient address after the `@`, for example `gmail.com`). Mutually exclusive with the other dimension filters; only one may be set per request.",
1122
1122
  },
1123
1123
  {
1124
1124
  displayName: "Sending Domain",
1125
1125
  name: "sending_domain",
1126
1126
  type: "string",
1127
1127
  default: "",
1128
- description: "Restrict the statistics to a single sending domain (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.",
1128
+ description: "Restrict the statistics to a sending domain or a comma-separated union of sending domains (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.",
1129
1129
  },
1130
1130
  {
1131
1131
  displayName: "Sending IP",
1132
1132
  name: "sending_ip",
1133
1133
  type: "string",
1134
1134
  default: "",
1135
- description: "Restrict the statistics to a single sending IP. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are `0`, and processing latency is `null`. Complaint, open, and click rates are `0` when deliveries exist and `null` otherwise.",
1135
+ description: "Restrict the statistics to a sending IP or a comma-separated union of IPs. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are `0`, and processing latency is `null`. Complaint, open, and click rates are `0` when deliveries exist and `null` otherwise.",
1136
1136
  },
1137
1137
  {
1138
1138
  displayName: "Tag",
1139
1139
  name: "tag",
1140
1140
  type: "string",
1141
1141
  default: "",
1142
- description: "Restrict the statistics to a single tag. Use `name` to match any value of a tag, or `name:value` for a specific pair (for example `campaign:spring_launch`). Mutually exclusive with the other dimension filters; only one may be set per request.",
1142
+ description: "Restrict the statistics to a tag. Use `name` to match any value of a tag, or `name:value` for a specific pair (for example `campaign:spring_launch`). To combine values of one tag name, separate complete pairs with commas, such as `campaign:spring,campaign:summer`. Different tag names cannot be combined. Mutually exclusive with the other dimension filters; only one may be set per request.",
1143
1143
  },
1144
1144
  {
1145
1145
  displayName: "Template",
1146
1146
  name: "template",
1147
1147
  type: "string",
1148
1148
  default: "",
1149
- description: "Restricts the statistics to one template, identified by its ID (`emt_…`) or name. This parameter is mutually exclusive with other dimension filters.",
1149
+ description: "Restricts the statistics to a template or a comma-separated union of templates, identified by ID (`emt_…`) or name. This parameter is mutually exclusive with other dimension filters.",
1150
1150
  },
1151
1151
  {
1152
1152
  displayName: "Timezone",
@@ -1164,6 +1164,23 @@ exports.birdProperties = [
1164
1164
  },
1165
1165
  ],
1166
1166
  },
1167
+ {
1168
+ displayName: "Return All",
1169
+ name: "returnAll",
1170
+ type: "boolean",
1171
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_tag"] } },
1172
+ default: false,
1173
+ description: "Whether to return all results or only up to a given limit",
1174
+ },
1175
+ {
1176
+ displayName: "Limit",
1177
+ name: "limit",
1178
+ type: "number",
1179
+ typeOptions: { minValue: 1 },
1180
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_tag"] } },
1181
+ default: 50,
1182
+ description: "Max number of results to return",
1183
+ },
1167
1184
  {
1168
1185
  displayName: "Additional Fields",
1169
1186
  name: "additionalFields",
@@ -1200,6 +1217,13 @@ exports.birdProperties = [
1200
1217
  default: "",
1201
1218
  description: "Maximum number of tag rows to return, ranked by the `sort` field descending",
1202
1219
  },
1220
+ {
1221
+ displayName: "Name",
1222
+ name: "name",
1223
+ type: "string",
1224
+ default: "",
1225
+ description: "Restrict the breakdown to this tag name. Names match case-sensitively.",
1226
+ },
1203
1227
  {
1204
1228
  displayName: "Timezone",
1205
1229
  name: "timezone",
@@ -1278,6 +1302,23 @@ exports.birdProperties = [
1278
1302
  },
1279
1303
  ],
1280
1304
  },
1305
+ {
1306
+ displayName: "Return All",
1307
+ name: "returnAll",
1308
+ type: "boolean",
1309
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_category"] } },
1310
+ default: false,
1311
+ description: "Whether to return all results or only up to a given limit",
1312
+ },
1313
+ {
1314
+ displayName: "Limit",
1315
+ name: "limit",
1316
+ type: "number",
1317
+ typeOptions: { minValue: 1 },
1318
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_category"] } },
1319
+ default: 50,
1320
+ description: "Max number of results to return",
1321
+ },
1281
1322
  {
1282
1323
  displayName: "Additional Fields",
1283
1324
  name: "additionalFields",
@@ -1385,6 +1426,23 @@ exports.birdProperties = [
1385
1426
  },
1386
1427
  ],
1387
1428
  },
1429
+ {
1430
+ displayName: "Return All",
1431
+ name: "returnAll",
1432
+ type: "boolean",
1433
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_sending_ip"] } },
1434
+ default: false,
1435
+ description: "Whether to return all results or only up to a given limit",
1436
+ },
1437
+ {
1438
+ displayName: "Limit",
1439
+ name: "limit",
1440
+ type: "number",
1441
+ typeOptions: { minValue: 1 },
1442
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_sending_ip"] } },
1443
+ default: 50,
1444
+ description: "Max number of results to return",
1445
+ },
1388
1446
  {
1389
1447
  displayName: "Additional Fields",
1390
1448
  name: "additionalFields",
@@ -1486,6 +1544,23 @@ exports.birdProperties = [
1486
1544
  },
1487
1545
  ],
1488
1546
  },
1547
+ {
1548
+ displayName: "Return All",
1549
+ name: "returnAll",
1550
+ type: "boolean",
1551
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_sending_domain"] } },
1552
+ default: false,
1553
+ description: "Whether to return all results or only up to a given limit",
1554
+ },
1555
+ {
1556
+ displayName: "Limit",
1557
+ name: "limit",
1558
+ type: "number",
1559
+ typeOptions: { minValue: 1 },
1560
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_sending_domain"] } },
1561
+ default: 50,
1562
+ description: "Max number of results to return",
1563
+ },
1489
1564
  {
1490
1565
  displayName: "Additional Fields",
1491
1566
  name: "additionalFields",
@@ -1600,6 +1675,23 @@ exports.birdProperties = [
1600
1675
  },
1601
1676
  ],
1602
1677
  },
1678
+ {
1679
+ displayName: "Return All",
1680
+ name: "returnAll",
1681
+ type: "boolean",
1682
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_recipient_domain"] } },
1683
+ default: false,
1684
+ description: "Whether to return all results or only up to a given limit",
1685
+ },
1686
+ {
1687
+ displayName: "Limit",
1688
+ name: "limit",
1689
+ type: "number",
1690
+ typeOptions: { minValue: 1 },
1691
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_recipient_domain"] } },
1692
+ default: 50,
1693
+ description: "Max number of results to return",
1694
+ },
1603
1695
  {
1604
1696
  displayName: "Additional Fields",
1605
1697
  name: "additionalFields",
@@ -1714,6 +1806,23 @@ exports.birdProperties = [
1714
1806
  },
1715
1807
  ],
1716
1808
  },
1809
+ {
1810
+ displayName: "Return All",
1811
+ name: "returnAll",
1812
+ type: "boolean",
1813
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_mailbox_provider"] } },
1814
+ default: false,
1815
+ description: "Whether to return all results or only up to a given limit",
1816
+ },
1817
+ {
1818
+ displayName: "Limit",
1819
+ name: "limit",
1820
+ type: "number",
1821
+ typeOptions: { minValue: 1 },
1822
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_mailbox_provider"] } },
1823
+ default: 50,
1824
+ description: "Max number of results to return",
1825
+ },
1717
1826
  {
1718
1827
  displayName: "Additional Fields",
1719
1828
  name: "additionalFields",
@@ -1825,6 +1934,23 @@ exports.birdProperties = [
1825
1934
  },
1826
1935
  ],
1827
1936
  },
1937
+ {
1938
+ displayName: "Return All",
1939
+ name: "returnAll",
1940
+ type: "boolean",
1941
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_mailbox_provider_region"] } },
1942
+ default: false,
1943
+ description: "Whether to return all results or only up to a given limit",
1944
+ },
1945
+ {
1946
+ displayName: "Limit",
1947
+ name: "limit",
1948
+ type: "number",
1949
+ typeOptions: { minValue: 1 },
1950
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_mailbox_provider_region"] } },
1951
+ default: 50,
1952
+ description: "Max number of results to return",
1953
+ },
1828
1954
  {
1829
1955
  displayName: "Additional Fields",
1830
1956
  name: "additionalFields",
@@ -1936,6 +2062,23 @@ exports.birdProperties = [
1936
2062
  },
1937
2063
  ],
1938
2064
  },
2065
+ {
2066
+ displayName: "Return All",
2067
+ name: "returnAll",
2068
+ type: "boolean",
2069
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_template"] } },
2070
+ default: false,
2071
+ description: "Whether to return all results or only up to a given limit",
2072
+ },
2073
+ {
2074
+ displayName: "Limit",
2075
+ name: "limit",
2076
+ type: "number",
2077
+ typeOptions: { minValue: 1 },
2078
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_template"] } },
2079
+ default: 50,
2080
+ description: "Max number of results to return",
2081
+ },
1939
2082
  {
1940
2083
  displayName: "Additional Fields",
1941
2084
  name: "additionalFields",
@@ -2050,6 +2193,23 @@ exports.birdProperties = [
2050
2193
  },
2051
2194
  ],
2052
2195
  },
2196
+ {
2197
+ displayName: "Return All",
2198
+ name: "returnAll",
2199
+ type: "boolean",
2200
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_location"] } },
2201
+ default: false,
2202
+ description: "Whether to return all results or only up to a given limit",
2203
+ },
2204
+ {
2205
+ displayName: "Limit",
2206
+ name: "limit",
2207
+ type: "number",
2208
+ typeOptions: { minValue: 1 },
2209
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_location"] } },
2210
+ default: 50,
2211
+ description: "Max number of results to return",
2212
+ },
2053
2213
  {
2054
2214
  displayName: "Additional Fields",
2055
2215
  name: "additionalFields",
@@ -2134,6 +2294,23 @@ exports.birdProperties = [
2134
2294
  },
2135
2295
  ],
2136
2296
  },
2297
+ {
2298
+ displayName: "Return All",
2299
+ name: "returnAll",
2300
+ type: "boolean",
2301
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_client"] } },
2302
+ default: false,
2303
+ description: "Whether to return all results or only up to a given limit",
2304
+ },
2305
+ {
2306
+ displayName: "Limit",
2307
+ name: "limit",
2308
+ type: "number",
2309
+ typeOptions: { minValue: 1 },
2310
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_client"] } },
2311
+ default: 50,
2312
+ description: "Max number of results to return",
2313
+ },
2137
2314
  {
2138
2315
  displayName: "Additional Fields",
2139
2316
  name: "additionalFields",
@@ -2218,6 +2395,23 @@ exports.birdProperties = [
2218
2395
  },
2219
2396
  ],
2220
2397
  },
2398
+ {
2399
+ displayName: "Return All",
2400
+ name: "returnAll",
2401
+ type: "boolean",
2402
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_bounce_code"] } },
2403
+ default: false,
2404
+ description: "Whether to return all results or only up to a given limit",
2405
+ },
2406
+ {
2407
+ displayName: "Limit",
2408
+ name: "limit",
2409
+ type: "number",
2410
+ typeOptions: { minValue: 1 },
2411
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_bounce_code"] } },
2412
+ default: 50,
2413
+ description: "Max number of results to return",
2414
+ },
2221
2415
  {
2222
2416
  displayName: "Additional Fields",
2223
2417
  name: "additionalFields",
@@ -2289,6 +2483,23 @@ exports.birdProperties = [
2289
2483
  },
2290
2484
  ],
2291
2485
  },
2486
+ {
2487
+ displayName: "Return All",
2488
+ name: "returnAll",
2489
+ type: "boolean",
2490
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_complaint_type"] } },
2491
+ default: false,
2492
+ description: "Whether to return all results or only up to a given limit",
2493
+ },
2494
+ {
2495
+ displayName: "Limit",
2496
+ name: "limit",
2497
+ type: "number",
2498
+ typeOptions: { minValue: 1 },
2499
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_complaint_type"] } },
2500
+ default: 50,
2501
+ description: "Max number of results to return",
2502
+ },
2292
2503
  {
2293
2504
  displayName: "Additional Fields",
2294
2505
  name: "additionalFields",
@@ -2355,6 +2566,23 @@ exports.birdProperties = [
2355
2566
  },
2356
2567
  ],
2357
2568
  },
2569
+ {
2570
+ displayName: "Return All",
2571
+ name: "returnAll",
2572
+ type: "boolean",
2573
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_broadcast"] } },
2574
+ default: false,
2575
+ description: "Whether to return all results or only up to a given limit",
2576
+ },
2577
+ {
2578
+ displayName: "Limit",
2579
+ name: "limit",
2580
+ type: "number",
2581
+ typeOptions: { minValue: 1 },
2582
+ displayOptions: { show: { resource: ["email"], operation: ["stats_by_broadcast"] } },
2583
+ default: 50,
2584
+ description: "Max number of results to return",
2585
+ },
2358
2586
  {
2359
2587
  displayName: "Additional Fields",
2360
2588
  name: "additionalFields",
@@ -10,19 +10,19 @@ exports.birdRoutes = {
10
10
  "email:stats_summary": { method: "GET", path: "/v1/email/stats/summary", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "category", "sending_domain", "tag", "sending_ip", "recipient_domain", "template", "compare"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["emails"] },
11
11
  "email:stats_daily": { method: "GET", path: "/v1/email/stats/daily", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "category", "sending_domain", "tag", "sending_ip", "recipient_domain", "template"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
12
12
  "email:stats_hourly": { method: "GET", path: "/v1/email/stats/hourly", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "category", "sending_domain", "tag", "sending_ip", "recipient_domain", "template"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: ["from", "to"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
13
- "email:stats_by_tag": { method: "GET", path: "/v1/email/stats/tags", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
14
- "email:stats_by_category": { method: "GET", path: "/v1/email/stats/categories", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
15
- "email:stats_by_sending_ip": { method: "GET", path: "/v1/email/stats/sending-ips", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
16
- "email:stats_by_sending_domain": { method: "GET", path: "/v1/email/stats/sending-domains", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
17
- "email:stats_by_recipient_domain": { method: "GET", path: "/v1/email/stats/recipient-domains", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
18
- "email:stats_by_mailbox_provider": { method: "GET", path: "/v1/email/stats/mailbox-providers", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
19
- "email:stats_by_mailbox_provider_region": { method: "GET", path: "/v1/email/stats/mailbox-provider-regions", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
20
- "email:stats_by_template": { method: "GET", path: "/v1/email/stats/templates", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
21
- "email:stats_by_location": { method: "GET", path: "/v1/email/stats/locations", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "group_by", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
22
- "email:stats_by_client": { method: "GET", path: "/v1/email/stats/clients", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "group_by", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
23
- "email:stats_by_bounce_code": { method: "GET", path: "/v1/email/stats/bounce-codes", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
24
- "email:stats_by_complaint_type": { method: "GET", path: "/v1/email/stats/complaint-types", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
25
- "email:stats_by_broadcast": { method: "GET", path: "/v1/email/stats/broadcasts", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["email_marketing"] },
13
+ "email:stats_by_tag": { method: "GET", path: "/v1/email/stats/tags", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["name", "starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
14
+ "email:stats_by_category": { method: "GET", path: "/v1/email/stats/categories", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
15
+ "email:stats_by_sending_ip": { method: "GET", path: "/v1/email/stats/sending-ips", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
16
+ "email:stats_by_sending_domain": { method: "GET", path: "/v1/email/stats/sending-domains", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
17
+ "email:stats_by_recipient_domain": { method: "GET", path: "/v1/email/stats/recipient-domains", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
18
+ "email:stats_by_mailbox_provider": { method: "GET", path: "/v1/email/stats/mailbox-providers", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
19
+ "email:stats_by_mailbox_provider_region": { method: "GET", path: "/v1/email/stats/mailbox-provider-regions", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
20
+ "email:stats_by_template": { method: "GET", path: "/v1/email/stats/templates", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
21
+ "email:stats_by_location": { method: "GET", path: "/v1/email/stats/locations", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "group_by", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
22
+ "email:stats_by_client": { method: "GET", path: "/v1/email/stats/clients", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "group_by", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
23
+ "email:stats_by_bounce_code": { method: "GET", path: "/v1/email/stats/bounce-codes", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
24
+ "email:stats_by_complaint_type": { method: "GET", path: "/v1/email/stats/complaint-types", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
25
+ "email:stats_by_broadcast": { method: "GET", path: "/v1/email/stats/broadcasts", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["email_marketing"] },
26
26
  "email:templates_list": { method: "GET", path: "/v1/email/templates", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["scope", "category", "source", "theme", "q", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["email_management"] },
27
27
  "sms:send": { method: "POST", path: "/v1/sms/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "from", "text", "category", "tags", "metadata", "options", "template"], jsonFields: [], structured: { "tags": "list", "metadata": "map", "options": "struct", "template": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms"] },
28
28
  "sms:send_batch": { method: "POST", path: "/v1/sms/batches", pathParams: [], topLevel: ["messages"], collections: ["additionalFields"], query: [], body: ["messages"], jsonFields: ["messages"], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: true, scopes: ["sms"] },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@messagebird/n8n-nodes-bird",
3
- "version": "0.12.0",
3
+ "version": "0.13.1",
4
4
  "description": "The official Bird node for n8n: email, SMS, WhatsApp, and verification, plus a webhook trigger for Bird events.",
5
5
  "license": "MIT",
6
6
  "author": {