@trycourier/courier 9.2.0 → 9.4.0

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 (40) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/client.d.mts +2 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +2 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/index.d.mts +1 -1
  10. package/resources/index.d.mts.map +1 -1
  11. package/resources/index.d.ts +1 -1
  12. package/resources/index.d.ts.map +1 -1
  13. package/resources/index.js.map +1 -1
  14. package/resources/index.mjs.map +1 -1
  15. package/resources/journeys/index.d.mts +1 -1
  16. package/resources/journeys/index.d.mts.map +1 -1
  17. package/resources/journeys/index.d.ts +1 -1
  18. package/resources/journeys/index.d.ts.map +1 -1
  19. package/resources/journeys/index.js.map +1 -1
  20. package/resources/journeys/index.mjs.map +1 -1
  21. package/resources/journeys/journeys.d.mts +121 -1
  22. package/resources/journeys/journeys.d.mts.map +1 -1
  23. package/resources/journeys/journeys.d.ts +121 -1
  24. package/resources/journeys/journeys.d.ts.map +1 -1
  25. package/resources/journeys/journeys.js.map +1 -1
  26. package/resources/journeys/journeys.mjs.map +1 -1
  27. package/resources/shared.d.mts +45 -10
  28. package/resources/shared.d.mts.map +1 -1
  29. package/resources/shared.d.ts +45 -10
  30. package/resources/shared.d.ts.map +1 -1
  31. package/src/client.ts +10 -0
  32. package/src/resources/index.ts +5 -0
  33. package/src/resources/journeys/index.ts +5 -0
  34. package/src/resources/journeys/journeys.ts +145 -0
  35. package/src/resources/shared.ts +47 -12
  36. package/src/version.ts +1 -1
  37. package/version.d.mts +1 -1
  38. package/version.d.ts +1 -1
  39. package/version.js +1 -1
  40. package/version.mjs +1 -1
@@ -383,6 +383,10 @@ export interface Metadata {
383
383
  utm?: Utm | null;
384
384
  }
385
385
 
386
+ /**
387
+ * Provide at least one of `tenant_id` or `service_url`. If you provide both, they
388
+ * must agree.
389
+ */
386
390
  export type MsTeams =
387
391
  | SendToMsTeamsUserID
388
392
  | SendToMsTeamsEmail
@@ -390,16 +394,26 @@ export type MsTeams =
390
394
  | SendToMsTeamsConversationID
391
395
  | SendToMsTeamsChannelName;
392
396
 
397
+ /**
398
+ * Tenant context shared by every MS Teams send variant. Provide at least one of
399
+ * `tenant_id` or `service_url`. If you provide both, they must agree — a
400
+ * `service_url` pointing at a different Microsoft tenant than `tenant_id` is
401
+ * rejected.
402
+ */
393
403
  export interface MsTeamsBaseProperties {
394
- service_url: string;
404
+ service_url?: string;
395
405
 
396
- tenant_id: string;
406
+ tenant_id?: string;
397
407
  }
398
408
 
399
409
  /**
400
410
  * Send via Microsoft Teams
401
411
  */
402
412
  export interface MsTeamsRecipient {
413
+ /**
414
+ * Provide at least one of `tenant_id` or `service_url`. If you provide both, they
415
+ * must agree.
416
+ */
403
417
  ms_teams: MsTeams;
404
418
  }
405
419
 
@@ -474,22 +488,31 @@ export interface SendToChannel {
474
488
  channel_id: string;
475
489
  }
476
490
 
491
+ /**
492
+ * Sends directly to a Microsoft Teams channel by its Bot Framework ID. Still
493
+ * provide at least one of `tenant_id` or `service_url` — sends without either have
494
+ * failed Bot Framework authentication in testing.
495
+ */
477
496
  export interface SendToMsTeamsChannelID {
478
497
  channel_id: string;
479
498
 
480
- service_url: string;
499
+ service_url?: string;
481
500
 
482
- tenant_id: string;
501
+ tenant_id?: string;
483
502
  }
484
503
 
504
+ /**
505
+ * `team_id` is required alongside `channel_name`. Also provide at least one of
506
+ * `tenant_id` or `service_url`; if you provide both, they must agree.
507
+ */
485
508
  export interface SendToMsTeamsChannelName {
486
509
  channel_name: string;
487
510
 
488
- service_url: string;
489
-
490
511
  team_id: string;
491
512
 
492
- tenant_id: string;
513
+ service_url?: string;
514
+
515
+ tenant_id?: string;
493
516
  }
494
517
 
495
518
  export interface SendToMsTeamsConversationID {
@@ -500,20 +523,28 @@ export interface SendToMsTeamsConversationID {
500
523
  tenant_id: string;
501
524
  }
502
525
 
526
+ /**
527
+ * Provide at least one of `tenant_id` or `service_url`. If you provide both, they
528
+ * must agree.
529
+ */
503
530
  export interface SendToMsTeamsEmail {
504
531
  email: string;
505
532
 
506
- service_url: string;
533
+ service_url?: string;
507
534
 
508
- tenant_id: string;
535
+ tenant_id?: string;
509
536
  }
510
537
 
538
+ /**
539
+ * Provide at least one of `tenant_id` or `service_url`. If you provide both, they
540
+ * must agree.
541
+ */
511
542
  export interface SendToMsTeamsUserID {
512
- service_url: string;
543
+ user_id: string;
513
544
 
514
- tenant_id: string;
545
+ service_url?: string;
515
546
 
516
- user_id: string;
547
+ tenant_id?: string;
517
548
  }
518
549
 
519
550
  export interface SendToSlackChannel {
@@ -613,6 +644,10 @@ export interface UserProfile {
613
644
 
614
645
  middle_name?: string | null;
615
646
 
647
+ /**
648
+ * Provide at least one of `tenant_id` or `service_url`. If you provide both, they
649
+ * must agree.
650
+ */
616
651
  ms_teams?: MsTeams | null;
617
652
 
618
653
  name?: string | null;
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '9.2.0'; // x-release-please-version
1
+ export const VERSION = '9.4.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "9.2.0";
1
+ export declare const VERSION = "9.4.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "9.2.0";
1
+ export declare const VERSION = "9.4.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '9.2.0'; // x-release-please-version
4
+ exports.VERSION = '9.4.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '9.2.0'; // x-release-please-version
1
+ export const VERSION = '9.4.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map