@d19n/youfibre-odin-sdk 2.0.322 → 2.0.323

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.
@@ -22,7 +22,7 @@ export interface CreateOutboundDialSessionMessage extends OdinRecordCreatedEvent
22
22
  * Properties for CreateOutboundDialSession action
23
23
  *
24
24
  * @property Required fields: 9
25
- * @property Optional fields: 0
25
+ * @property Optional fields: 2
26
26
  */
27
27
  export interface CreateOutboundDialSessionProperties {
28
28
  /**
@@ -101,6 +101,20 @@ export interface CreateOutboundDialSessionProperties {
101
101
  * @default 0
102
102
  */
103
103
  NoAnswerCount: number;
104
+ /**
105
+ * BusyCount
106
+ *
107
+ * Dial attempts in this session that ended BUSY. Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
108
+ * @type {NUMBER}
109
+ */
110
+ BusyCount?: number | null;
111
+ /**
112
+ * FailedCount
113
+ *
114
+ * Dial attempts in this session that ended FAILED (carrier failure / cancelled). Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
115
+ * @type {NUMBER}
116
+ */
117
+ FailedCount?: number | null;
104
118
  }
105
119
  /**
106
120
  * CreateOutboundDialSession
@@ -22,7 +22,7 @@ export interface UpdateOutboundDialCampaignCaseMessage extends OdinRecordUpdated
22
22
  * Properties for UpdateOutboundDialCampaignCase action
23
23
  *
24
24
  * @property Required fields: 0
25
- * @property Optional fields: 3
25
+ * @property Optional fields: 7
26
26
  */
27
27
  export interface UpdateOutboundDialCampaignCaseProperties {
28
28
  /**
@@ -46,6 +46,34 @@ export interface UpdateOutboundDialCampaignCaseProperties {
46
46
  * @type {ENUM}
47
47
  */
48
48
  Status?: string | null;
49
+ /**
50
+ * DialAttemptCount
51
+ *
52
+ * How many times this campaign has dialled this case. Per-campaign successor to Case.DialAttemptCount, whose single budget was shared by every campaign the case was enrolled in (CASES-1829). Compared against the campaign MaxRetries to decide PENDING vs EXHAUSTED.
53
+ * @type {NUMBER}
54
+ */
55
+ DialAttemptCount?: number | null;
56
+ /**
57
+ * NextDialAt
58
+ *
59
+ * When the retry backoff elapses and this junction becomes dialable again in THIS campaign. Null when no retry is scheduled (connected, exhausted, or never dialled). Per-campaign successor to Case.NextDialAt.
60
+ * @type {DATE_TIME}
61
+ */
62
+ NextDialAt?: string | null;
63
+ /**
64
+ * LastDialAt
65
+ *
66
+ * When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt.
67
+ * @type {DATE_TIME}
68
+ */
69
+ LastDialAt?: string | null;
70
+ /**
71
+ * LastDialOutcome
72
+ *
73
+ * Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome.
74
+ * @type {TEXT}
75
+ */
76
+ LastDialOutcome?: string | null;
49
77
  }
50
78
  /**
51
79
  * UpdateOutboundDialCampaignCase
@@ -22,7 +22,7 @@ export interface UpdateOutboundDialCampaignCaseOnDialEndMessage extends OdinReco
22
22
  * Properties for UpdateOutboundDialCampaignCaseOnDialEnd action
23
23
  *
24
24
  * @property Required fields: 1
25
- * @property Optional fields: 1
25
+ * @property Optional fields: 5
26
26
  */
27
27
  export interface UpdateOutboundDialCampaignCaseOnDialEndProperties {
28
28
  /**
@@ -40,6 +40,34 @@ export interface UpdateOutboundDialCampaignCaseOnDialEndProperties {
40
40
  * @type {LOOKUP}
41
41
  */
42
42
  CurrentCallId?: string | null;
43
+ /**
44
+ * DialAttemptCount
45
+ *
46
+ * How many times this campaign has dialled this case. Per-campaign successor to Case.DialAttemptCount, whose single budget was shared by every campaign the case was enrolled in (CASES-1829). Compared against the campaign MaxRetries to decide PENDING vs EXHAUSTED.
47
+ * @type {NUMBER}
48
+ */
49
+ DialAttemptCount?: number | null;
50
+ /**
51
+ * NextDialAt
52
+ *
53
+ * When the retry backoff elapses and this junction becomes dialable again in THIS campaign. Null when no retry is scheduled (connected, exhausted, or never dialled). Per-campaign successor to Case.NextDialAt.
54
+ * @type {DATE_TIME}
55
+ */
56
+ NextDialAt?: string | null;
57
+ /**
58
+ * LastDialAt
59
+ *
60
+ * When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt.
61
+ * @type {DATE_TIME}
62
+ */
63
+ LastDialAt?: string | null;
64
+ /**
65
+ * LastDialOutcome
66
+ *
67
+ * Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome.
68
+ * @type {TEXT}
69
+ */
70
+ LastDialOutcome?: string | null;
43
71
  }
44
72
  /**
45
73
  * UpdateOutboundDialCampaignCaseOnDialEnd
@@ -22,7 +22,7 @@ export interface UpdateOutboundDialSessionOnAmdResultMessage extends OdinRecordU
22
22
  * Properties for UpdateOutboundDialSessionOnAmdResult action
23
23
  *
24
24
  * @property Required fields: 1
25
- * @property Optional fields: 3
25
+ * @property Optional fields: 5
26
26
  */
27
27
  export interface UpdateOutboundDialSessionOnAmdResultProperties {
28
28
  /**
@@ -54,6 +54,20 @@ export interface UpdateOutboundDialSessionOnAmdResultProperties {
54
54
  * @type {NUMBER}
55
55
  */
56
56
  NoAnswerCount?: number | null;
57
+ /**
58
+ * BusyCount
59
+ *
60
+ * Dial attempts in this session that ended BUSY. Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
61
+ * @type {NUMBER}
62
+ */
63
+ BusyCount?: number | null;
64
+ /**
65
+ * FailedCount
66
+ *
67
+ * Dial attempts in this session that ended FAILED (carrier failure / cancelled). Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
68
+ * @type {NUMBER}
69
+ */
70
+ FailedCount?: number | null;
57
71
  }
58
72
  /**
59
73
  * UpdateOutboundDialSessionOnAmdResult
@@ -54,7 +54,15 @@ export declare enum OutboundDialCampaignCasePropertyKeys {
54
54
  /** Lower = dialled first */
55
55
  Priority = "Priority",
56
56
  /** Status */
57
- Status = "Status"
57
+ Status = "Status",
58
+ /** How many times this campaign has dialled this case. Per-campaign successor to Case.DialAttemptCount, whose single budget was shared by every campaign the case was enrolled in (CASES-1829). Compared against the campaign MaxRetries to decide PENDING vs EXHAUSTED. */
59
+ DialAttemptCount = "DialAttemptCount",
60
+ /** When the retry backoff elapses and this junction becomes dialable again in THIS campaign. Null when no retry is scheduled (connected, exhausted, or never dialled). Per-campaign successor to Case.NextDialAt. */
61
+ NextDialAt = "NextDialAt",
62
+ /** When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt. */
63
+ LastDialAt = "LastDialAt",
64
+ /** Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome. */
65
+ LastDialOutcome = "LastDialOutcome"
58
66
  }
59
67
  /**
60
68
  * Properties for OutboundDialCampaignCase records
@@ -90,6 +98,30 @@ export interface OutboundDialCampaignCaseProperties {
90
98
  * @enum {OutboundDialCampaignCaseStatus}
91
99
  */
92
100
  Status: OutboundDialCampaignCaseStatus;
101
+ /** How many times this campaign has dialled this case. Per-campaign successor to Case.DialAttemptCount, whose single budget was shared by every campaign the case was enrolled in (CASES-1829). Compared against the campaign MaxRetries to decide PENDING vs EXHAUSTED.
102
+ *
103
+ * @type {NUMBER}
104
+ * @default 0
105
+ */
106
+ DialAttemptCount: number;
107
+ /** When the retry backoff elapses and this junction becomes dialable again in THIS campaign. Null when no retry is scheduled (connected, exhausted, or never dialled). Per-campaign successor to Case.NextDialAt.
108
+ *
109
+ * @type {DATE_TIME}
110
+ * @default
111
+ */
112
+ NextDialAt: string;
113
+ /** When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt.
114
+ *
115
+ * @type {DATE_TIME}
116
+ * @default
117
+ */
118
+ LastDialAt: string;
119
+ /** Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome.
120
+ *
121
+ * @type {TEXT}
122
+ * @default
123
+ */
124
+ LastDialOutcome: string;
93
125
  }
94
126
  /**
95
127
  * OutboundDialCampaignCase entity from SupportModule
@@ -58,6 +58,14 @@ var OutboundDialCampaignCasePropertyKeys;
58
58
  OutboundDialCampaignCasePropertyKeys["Priority"] = "Priority";
59
59
  /** Status */
60
60
  OutboundDialCampaignCasePropertyKeys["Status"] = "Status";
61
+ /** How many times this campaign has dialled this case. Per-campaign successor to Case.DialAttemptCount, whose single budget was shared by every campaign the case was enrolled in (CASES-1829). Compared against the campaign MaxRetries to decide PENDING vs EXHAUSTED. */
62
+ OutboundDialCampaignCasePropertyKeys["DialAttemptCount"] = "DialAttemptCount";
63
+ /** When the retry backoff elapses and this junction becomes dialable again in THIS campaign. Null when no retry is scheduled (connected, exhausted, or never dialled). Per-campaign successor to Case.NextDialAt. */
64
+ OutboundDialCampaignCasePropertyKeys["NextDialAt"] = "NextDialAt";
65
+ /** When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt. */
66
+ OutboundDialCampaignCasePropertyKeys["LastDialAt"] = "LastDialAt";
67
+ /** Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome. */
68
+ OutboundDialCampaignCasePropertyKeys["LastDialOutcome"] = "LastDialOutcome";
61
69
  })(OutboundDialCampaignCasePropertyKeys = exports.OutboundDialCampaignCasePropertyKeys || (exports.OutboundDialCampaignCasePropertyKeys = {}));
62
70
  /**
63
71
  * OutboundDialCampaignCase entity from SupportModule
@@ -82,7 +82,11 @@ export declare enum OutboundDialSessionPropertyKeys {
82
82
  /** MachineCount */
83
83
  MachineCount = "MachineCount",
84
84
  /** NoAnswerCount */
85
- NoAnswerCount = "NoAnswerCount"
85
+ NoAnswerCount = "NoAnswerCount",
86
+ /** Dial attempts in this session that ended BUSY. Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them. */
87
+ BusyCount = "BusyCount",
88
+ /** Dial attempts in this session that ended FAILED (carrier failure / cancelled). Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them. */
89
+ FailedCount = "FailedCount"
86
90
  }
87
91
  /**
88
92
  * Properties for OutboundDialSession records
@@ -152,6 +156,18 @@ export interface OutboundDialSessionProperties {
152
156
  * @type {NUMBER}
153
157
  */
154
158
  NoAnswerCount: number;
159
+ /** Dial attempts in this session that ended BUSY. Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
160
+ *
161
+ * @type {NUMBER}
162
+ * @default
163
+ */
164
+ BusyCount: number;
165
+ /** Dial attempts in this session that ended FAILED (carrier failure / cancelled). Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
166
+ *
167
+ * @type {NUMBER}
168
+ * @default
169
+ */
170
+ FailedCount: number;
155
171
  }
156
172
  /**
157
173
  * OutboundDialSession entity from SupportModule
@@ -86,6 +86,10 @@ var OutboundDialSessionPropertyKeys;
86
86
  OutboundDialSessionPropertyKeys["MachineCount"] = "MachineCount";
87
87
  /** NoAnswerCount */
88
88
  OutboundDialSessionPropertyKeys["NoAnswerCount"] = "NoAnswerCount";
89
+ /** Dial attempts in this session that ended BUSY. Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them. */
90
+ OutboundDialSessionPropertyKeys["BusyCount"] = "BusyCount";
91
+ /** Dial attempts in this session that ended FAILED (carrier failure / cancelled). Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them. */
92
+ OutboundDialSessionPropertyKeys["FailedCount"] = "FailedCount";
89
93
  })(OutboundDialSessionPropertyKeys = exports.OutboundDialSessionPropertyKeys || (exports.OutboundDialSessionPropertyKeys = {}));
90
94
  /**
91
95
  * OutboundDialSession entity from SupportModule
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.322",
3
+ "version": "2.0.323",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",