Skip to content

Commit b250766

Browse files
gmethvingmethvin
committed
update api client
1 parent b0ee669 commit b250766

3 files changed

Lines changed: 96 additions & 28 deletions

File tree

‎COMMANDS.md‎

Lines changed: 90 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1268,17 +1268,28 @@ iterable templates update-email <templateId>
12681268
| Option | Type | Required | Description |
12691269
|--------|------|----------|-------------|
12701270
| `templateId` | number | **yes** | Template ID to update |
1271+
| `--bccEmails` | string[] | no | BCC emails |
1272+
| `--cacheDataFeed` | boolean | no | Cache data feed lookups for 1 hour |
12711273
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
12721274
| `--campaignId` | number | no | Associated campaign ID |
1275+
| `--ccEmails` | string[] | no | CC emails |
12731276
| `--creatorUserId` | string | no | Creator user ID |
1274-
| `--fromEmail` | string | no | From email |
1277+
| `--dataFeedId` | number | no | [Deprecated - use dataFeedIds instead] ID for data feed used in template rendering |
1278+
| `--dataFeedIds` | number[] | no | Ids for data feeds used in template rendering |
1279+
| `--fromEmail` | string | no | From email (must be an authorized sender) |
12751280
| `--fromName` | string | no | From name |
1276-
| `--html` | string | no | HTML content |
1281+
| `--googleAnalyticsCampaignName` | string | no | Google analytics utm_campaign value |
1282+
| `--html` | string | no | HTML contents |
1283+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
1284+
| `--linkParams` | json[] | no | Parameters to append to each URL in html contents |
12771285
| `--locale` | string | no | Template locale |
1286+
| `--mergeDataFeedContext` | boolean | no | Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]] |
12781287
| `--messageTypeId` | number | no | Message type ID |
12791288
| `--name` | string | no | Template name |
1280-
| `--plainText` | string | no | Plain text content |
1281-
| `--subject` | string | no | Email subject |
1289+
| `--plainText` | string | no | Plain text contents |
1290+
| `--preheaderText` | string | no | Preheader text |
1291+
| `--replyToEmail` | string | no | Reply to email |
1292+
| `--subject` | string | no | Subject |
12821293

12831294
### update-inapp
12841295

@@ -1294,10 +1305,17 @@ iterable templates update-inapp <templateId>
12941305
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
12951306
| `--campaignId` | number | no | Associated campaign ID |
12961307
| `--creatorUserId` | string | no | Creator user ID |
1297-
| `--html` | string | no | HTML content of the in-app notification |
1308+
| `--expirationDateTime` | string | no | The in-app message's absolute expiration time. Format is YYYY-MM-DD HH:MM:SS (UTC timestamp, time zones not allowed) |
1309+
| `--expirationDuration` | string | no | The in-app message's expiration time, relative to its send time. Should be an expression such as now+90d |
1310+
| `--html` | string | no | Html of the in-app notification |
1311+
| `--inAppDisplaySettings` | json | no | Display settings |
1312+
| `--inboxMetadata` | json | no | Title, subtitle, and thumbnail |
1313+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
12981314
| `--locale` | string | no | Template locale |
12991315
| `--messageTypeId` | number | no | Message type ID |
13001316
| `--name` | string | no | Template name |
1317+
| `--payload` | json | no | Payload |
1318+
| `--webInAppDisplaySettings` | json | no | Web In-app Display settings |
13011319

13021320
### update-push
13031321

@@ -1310,17 +1328,28 @@ iterable templates update-push <templateId>
13101328
| Option | Type | Required | Description |
13111329
|--------|------|----------|-------------|
13121330
| `templateId` | number | **yes** | Template ID to update |
1313-
| `--badge` | number | no | Badge count |
1331+
| `--badge` | string | no | Badge to set for push notification |
1332+
| `--buttons` | json[] | no | Array of buttons that appear to respond to the push. Max of 3 |
1333+
| `--cacheDataFeed` | boolean | no | Cache data feed lookups for 1 hour |
13141334
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
13151335
| `--campaignId` | number | no | Associated campaign ID |
13161336
| `--creatorUserId` | string | no | Creator user ID |
1337+
| `--dataFeedIds` | number[] | no | Ids for data feeds used in template rendering |
1338+
| `--deeplink` | json | no | Deep Link. A mapping that accepts two optional properties: 'ios' & 'android' and their respective deep link values |
1339+
| `--interruptionLevel` | `passive` \| `active` \| `time-sensitive` \| `critical` | no | An interruption level helps iOS determine when to alert a user about the arrival of a push notification |
1340+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
1341+
| `--isSilentPush` | boolean | no | Whether or not this is a silent push notification template |
13171342
| `--locale` | string | no | Template locale |
1318-
| `--message` | string | no | Push notification message |
1343+
| `--mergeDataFeedContext` | boolean | no | Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]] |
1344+
| `--message` | string | no | Push message |
13191345
| `--messageTypeId` | number | no | Message type ID |
13201346
| `--name` | string | no | Template name |
1321-
| `--payload` | json | no | Custom payload |
1322-
| `--sound` | string | no | Sound file |
1323-
| `--title` | string | no | Push notification title |
1347+
| `--payload` | json | no | Payload to send with push notification |
1348+
| `--relevanceScore` | number | no | Relevance score for iOS notifications on iOS 15+. Number is clamped between 0 and 1.0 |
1349+
| `--richMedia` | json | no | Rich Media URL. A mapping that accepts two optional properties: 'ios' & 'android' and their respective rich media url values |
1350+
| `--sound` | string | no | Sound |
1351+
| `--title` | string | no | Push message title |
1352+
| `--wake` | boolean | no | Set the content-available flag on iOS notifications, which will wake the app in the background |
13241353

13251354
### update-sms
13261355

@@ -1336,10 +1365,15 @@ iterable templates update-sms <templateId>
13361365
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
13371366
| `--campaignId` | number | no | Associated campaign ID |
13381367
| `--creatorUserId` | string | no | Creator user ID |
1368+
| `--googleAnalyticsCampaignName` | string | no | Google analytics utm_campaign value |
1369+
| `--imageUrl` | string | no | Image URL |
1370+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
1371+
| `--linkParams` | json[] | no | Parameters to append to each URL in contents |
13391372
| `--locale` | string | no | Template locale |
1340-
| `--message` | string | no | SMS message content |
1373+
| `--message` | string | no | SMS message |
13411374
| `--messageTypeId` | number | no | Message type ID |
13421375
| `--name` | string | no | Template name |
1376+
| `--trackingDomain` | string | no | Tracking Domain |
13431377

13441378
### upsert-email
13451379

@@ -1352,17 +1386,28 @@ iterable templates upsert-email <clientTemplateId>
13521386
| Option | Type | Required | Description |
13531387
|--------|------|----------|-------------|
13541388
| `clientTemplateId` | string | **yes** | Client template ID |
1389+
| `--bccEmails` | string[] | no | BCC emails |
1390+
| `--cacheDataFeed` | boolean | no | Cache data feed lookups for 1 hour |
13551391
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
13561392
| `--campaignId` | number | no | Associated campaign ID |
1393+
| `--ccEmails` | string[] | no | CC emails |
13571394
| `--creatorUserId` | string | no | Creator user ID |
1358-
| `--fromEmail` | string | no | From email |
1395+
| `--dataFeedId` | number | no | [Deprecated - use dataFeedIds instead] ID for data feed used in template rendering |
1396+
| `--dataFeedIds` | number[] | no | Ids for data feeds used in template rendering |
1397+
| `--fromEmail` | string | no | From email (must be an authorized sender) |
13591398
| `--fromName` | string | no | From name |
1360-
| `--html` | string | no | HTML content |
1399+
| `--googleAnalyticsCampaignName` | string | no | Google analytics utm_campaign value |
1400+
| `--html` | string | no | HTML contents |
1401+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
1402+
| `--linkParams` | json[] | no | Parameters to append to each URL in html contents |
13611403
| `--locale` | string | no | Template locale |
1404+
| `--mergeDataFeedContext` | boolean | no | Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]] |
13621405
| `--messageTypeId` | number | no | Message type ID |
13631406
| `--name` | string | no | Template name |
1364-
| `--plainText` | string | no | Plain text content |
1365-
| `--subject` | string | no | Email subject |
1407+
| `--plainText` | string | no | Plain text contents |
1408+
| `--preheaderText` | string | no | Preheader text |
1409+
| `--replyToEmail` | string | no | Reply to email |
1410+
| `--subject` | string | no | Subject |
13661411

13671412
### upsert-inapp
13681413

@@ -1378,10 +1423,17 @@ iterable templates upsert-inapp <clientTemplateId>
13781423
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
13791424
| `--campaignId` | number | no | Associated campaign ID |
13801425
| `--creatorUserId` | string | no | Creator user ID |
1381-
| `--html` | string | no | HTML content of the in-app notification |
1426+
| `--expirationDateTime` | string | no | The in-app message's absolute expiration time. Format is YYYY-MM-DD HH:MM:SS (UTC timestamp, time zones not allowed) |
1427+
| `--expirationDuration` | string | no | The in-app message's expiration time, relative to its send time. Should be an expression such as now+90d |
1428+
| `--html` | string | no | Html of the in-app notification |
1429+
| `--inAppDisplaySettings` | json | no | Display settings |
1430+
| `--inboxMetadata` | json | no | Title, subtitle, and thumbnail |
1431+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
13821432
| `--locale` | string | no | Template locale |
13831433
| `--messageTypeId` | number | no | Message type ID |
13841434
| `--name` | string | no | Template name |
1435+
| `--payload` | json | no | Payload |
1436+
| `--webInAppDisplaySettings` | json | no | Web In-app Display settings |
13851437

13861438
### upsert-push
13871439

@@ -1394,17 +1446,28 @@ iterable templates upsert-push <clientTemplateId>
13941446
| Option | Type | Required | Description |
13951447
|--------|------|----------|-------------|
13961448
| `clientTemplateId` | string | **yes** | Client template ID |
1397-
| `--badge` | number | no | Badge count |
1449+
| `--badge` | string | no | Badge to set for push notification |
1450+
| `--buttons` | json[] | no | Array of buttons that appear to respond to the push. Max of 3 |
1451+
| `--cacheDataFeed` | boolean | no | Cache data feed lookups for 1 hour |
13981452
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
13991453
| `--campaignId` | number | no | Associated campaign ID |
14001454
| `--creatorUserId` | string | no | Creator user ID |
1455+
| `--dataFeedIds` | number[] | no | Ids for data feeds used in template rendering |
1456+
| `--deeplink` | json | no | Deep Link. A mapping that accepts two optional properties: 'ios' & 'android' and their respective deep link values |
1457+
| `--interruptionLevel` | `passive` \| `active` \| `time-sensitive` \| `critical` | no | An interruption level helps iOS determine when to alert a user about the arrival of a push notification |
1458+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
1459+
| `--isSilentPush` | boolean | no | Whether or not this is a silent push notification template |
14011460
| `--locale` | string | no | Template locale |
1402-
| `--message` | string | no | Push notification message |
1461+
| `--mergeDataFeedContext` | boolean | no | Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]] |
1462+
| `--message` | string | no | Push message |
14031463
| `--messageTypeId` | number | no | Message type ID |
14041464
| `--name` | string | no | Template name |
1405-
| `--payload` | json | no | Custom payload |
1406-
| `--sound` | string | no | Sound file |
1407-
| `--title` | string | no | Push notification title |
1465+
| `--payload` | json | no | Payload to send with push notification |
1466+
| `--relevanceScore` | number | no | Relevance score for iOS notifications on iOS 15+. Number is clamped between 0 and 1.0 |
1467+
| `--richMedia` | json | no | Rich Media URL. A mapping that accepts two optional properties: 'ios' & 'android' and their respective rich media url values |
1468+
| `--sound` | string | no | Sound |
1469+
| `--title` | string | no | Push message title |
1470+
| `--wake` | boolean | no | Set the content-available flag on iOS notifications, which will wake the app in the background |
14081471

14091472
### upsert-sms
14101473

@@ -1420,10 +1483,15 @@ iterable templates upsert-sms <clientTemplateId>
14201483
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
14211484
| `--campaignId` | number | no | Associated campaign ID |
14221485
| `--creatorUserId` | string | no | Creator user ID |
1486+
| `--googleAnalyticsCampaignName` | string | no | Google analytics utm_campaign value |
1487+
| `--imageUrl` | string | no | Image URL |
1488+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
1489+
| `--linkParams` | json[] | no | Parameters to append to each URL in contents |
14231490
| `--locale` | string | no | Template locale |
1424-
| `--message` | string | no | SMS message content |
1491+
| `--message` | string | no | SMS message |
14251492
| `--messageTypeId` | number | no | Message type ID |
14261493
| `--name` | string | no | Template name |
1494+
| `--trackingDomain` | string | no | Tracking Domain |
14271495

14281496

14291497
## users (13)

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
"update-commands": "node scripts/update-commands.js"
6060
},
6161
"dependencies": {
62-
"@iterable/api": "0.10.3",
62+
"@iterable/api": "0.11.1",
6363
"@primno/dpapi": "2.0.1",
6464
"boxen": "8.0.1",
6565
"chalk": "5.6.2",

‎pnpm-lock.yaml‎

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)