@d19n/youfibre-odin-sdk 2.0.322 → 2.0.324
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.
- package/README.md +12 -9
- package/dist/actions-v2/CancelPaymentMethodDto.d.ts +73 -0
- package/dist/actions-v2/CancelPaymentMethodDto.js +56 -0
- package/dist/actions-v2/CreateOutboundDialSessionDto.d.ts +15 -1
- package/dist/actions-v2/MovePgPaymentMethodToCancellationRequestedDto.d.ts +2 -0
- package/dist/actions-v2/MovePgPaymentMethodToCancellationRequestedDto.js +2 -0
- package/dist/actions-v2/UpdateOutboundDialCampaignCaseDto.d.ts +29 -1
- package/dist/actions-v2/UpdateOutboundDialCampaignCaseOnDialEndDto.d.ts +29 -1
- package/dist/actions-v2/UpdateOutboundDialSessionOnAmdResultDto.d.ts +15 -1
- package/dist/actions-v2/UpdatePaymentMethodDto.d.ts +9 -1
- package/dist/entities-v2/OutboundDialCampaignCase.d.ts +33 -1
- package/dist/entities-v2/OutboundDialCampaignCase.js +8 -0
- package/dist/entities-v2/OutboundDialSession.d.ts +17 -1
- package/dist/entities-v2/OutboundDialSession.js +4 -0
- package/dist/entities-v2/PaymentMethod.d.ts +3 -1
- package/dist/entities-v2/PaymentMethod.js +3 -1
- package/dist/records-v2/PaymentMethodRecord.d.ts +28 -0
- package/dist/records-v2/PaymentMethodRecord.js +37 -0
- package/dist/records-v2/PgPaymentMethodRecord.d.ts +10 -13
- package/dist/records-v2/PgPaymentMethodRecord.js +11 -19
- package/dist/records-v2/index.d.ts +1 -1
- package/dist/records-v2/index.js +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -375,7 +375,7 @@ This SDK includes **187** entities across **12** modules.
|
|
|
375
375
|
|
|
376
376
|
## Actions
|
|
377
377
|
|
|
378
|
-
This SDK includes **
|
|
378
|
+
This SDK includes **883** actions.
|
|
379
379
|
|
|
380
380
|
### Action Types
|
|
381
381
|
|
|
@@ -1204,6 +1204,14 @@ This SDK includes **882** actions.
|
|
|
1204
1204
|
|
|
1205
1205
|
**VoidPayment Target Stages:** `PaymentStageVoided`
|
|
1206
1206
|
|
|
1207
|
+
#### PaymentMethod
|
|
1208
|
+
|
|
1209
|
+
| Action | Type | Event |
|
|
1210
|
+
|--------|------|-------|
|
|
1211
|
+
| `CancelPaymentMethod` | UPDATE | k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.CancelPaymentMethod |
|
|
1212
|
+
| `CreatePaymentMethod` | CREATE | k1.t-hEOJjsDb.BillingModule.PaymentMethod.Create.CreatePaymentMethod |
|
|
1213
|
+
| `UpdatePaymentMethod` | UPDATE | k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.UpdatePaymentMethod |
|
|
1214
|
+
|
|
1207
1215
|
#### Transaction
|
|
1208
1216
|
|
|
1209
1217
|
| Action | Type | Event |
|
|
@@ -1821,13 +1829,6 @@ This SDK includes **882** actions.
|
|
|
1821
1829
|
| `RecordSmsSurveyRating` | UPDATE | k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsSurveyRating |
|
|
1822
1830
|
| `UpdateSmsDeliveryStatus` | UPDATE | k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.UpdateSmsDeliveryStatus |
|
|
1823
1831
|
|
|
1824
|
-
#### PaymentMethod
|
|
1825
|
-
|
|
1826
|
-
| Action | Type | Event |
|
|
1827
|
-
|--------|------|-------|
|
|
1828
|
-
| `CreatePaymentMethod` | CREATE | k1.t-hEOJjsDb.BillingModule.PaymentMethod.Create.CreatePaymentMethod |
|
|
1829
|
-
| `UpdatePaymentMethod` | UPDATE | k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.UpdatePaymentMethod |
|
|
1830
|
-
|
|
1831
1832
|
#### PgContact
|
|
1832
1833
|
|
|
1833
1834
|
| Action | Type | Event |
|
|
@@ -1878,7 +1879,7 @@ This SDK includes **882** actions.
|
|
|
1878
1879
|
| `MovePgPaymentMethodToActive` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToActive |
|
|
1879
1880
|
| `MovePgPaymentMethodToAllocated` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToAllocated |
|
|
1880
1881
|
| `MovePgPaymentMethodToCancellationPending` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationPending |
|
|
1881
|
-
| `MovePgPaymentMethodToCancellationRequested` |
|
|
1882
|
+
| `MovePgPaymentMethodToCancellationRequested` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Update.MovePgPaymentMethodToCancellationRequested |
|
|
1882
1883
|
| `MovePgPaymentMethodToCancelled` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancelled |
|
|
1883
1884
|
| `MovePgPaymentMethodToCreated` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCreated |
|
|
1884
1885
|
| `MovePgPaymentMethodToFileRejected` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToFileRejected |
|
|
@@ -1903,6 +1904,8 @@ This SDK includes **882** actions.
|
|
|
1903
1904
|
|
|
1904
1905
|
**MovePgPaymentMethodToCancellationPending Target Stages:** `StatusStageCancellationPending`
|
|
1905
1906
|
|
|
1907
|
+
**MovePgPaymentMethodToCancellationRequested Target Stages:** `StatusStageCancellationRequested`
|
|
1908
|
+
|
|
1906
1909
|
**MovePgPaymentMethodToCancelled Target Stages:** `StatusStageCancelled`
|
|
1907
1910
|
|
|
1908
1911
|
**MovePgPaymentMethodToCreated Target Stages:** `StatusStageCreated`
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CancelPaymentMethod Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Cancel this direct debit mandate. Sets the status to Cancellation Requested; a scheduled job then asks the payment gateway to take the instruction down at the bank.
|
|
5
|
+
*
|
|
6
|
+
* @module BillingModule
|
|
7
|
+
* @entity PaymentMethod
|
|
8
|
+
* @actionKey CancelPaymentMethod
|
|
9
|
+
* @event k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.CancelPaymentMethod
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for CancelPaymentMethod updated events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.CancelPaymentMethod
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelPaymentMethodMessage extends OdinRecordUpdatedEvent<CancelPaymentMethodDto, CancelPaymentMethodProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for CancelPaymentMethod action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 0
|
|
25
|
+
* @property Optional fields: 1
|
|
26
|
+
*/
|
|
27
|
+
export interface CancelPaymentMethodProperties {
|
|
28
|
+
/**
|
|
29
|
+
* Status
|
|
30
|
+
*
|
|
31
|
+
* payment method status (Finance - PaymentMethod)
|
|
32
|
+
* @type {ENUM}
|
|
33
|
+
* @default CANCELLATION_REQUESTED
|
|
34
|
+
*/
|
|
35
|
+
Status?: string | null;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Cancel mandate
|
|
39
|
+
*
|
|
40
|
+
* Cancel this direct debit mandate. Sets the status to Cancellation Requested; a scheduled job then asks the payment gateway to take the instruction down at the bank.
|
|
41
|
+
*
|
|
42
|
+
* @actionType UPDATE - Updates an existing PaymentMethod record
|
|
43
|
+
* @module BillingModule
|
|
44
|
+
* @entity PaymentMethod
|
|
45
|
+
* @event k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.CancelPaymentMethod
|
|
46
|
+
* @permission schema.action.cancelpaymentmethod.trigger
|
|
47
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
48
|
+
*/
|
|
49
|
+
export declare class CancelPaymentMethodDto extends OdinRecordUpdateDto<CancelPaymentMethodProperties> {
|
|
50
|
+
/** Used by SDK generators to identify action type */
|
|
51
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
52
|
+
static readonly ACTION_KEY = "CancelPaymentMethod";
|
|
53
|
+
static readonly MODULE_NAME = "BillingModule";
|
|
54
|
+
static readonly ENTITIES: string[];
|
|
55
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.CancelPaymentMethod";
|
|
56
|
+
static readonly PERMISSION = "schema.action.cancelpaymentmethod.trigger";
|
|
57
|
+
/** Step metadata - entity this action targets */
|
|
58
|
+
static readonly STEP_ENTITY = "BillingModule:PaymentMethod";
|
|
59
|
+
static readonly STEP_SCHEMA_ID = "29a21375-b036-43b4-b64e-c0322370c85d";
|
|
60
|
+
static readonly STEP_SCHEMA_ACTION_ID = "063cf205-8737-4164-86f6-caa20ddea8fd";
|
|
61
|
+
static readonly AUTO_LINK_PARENT = false;
|
|
62
|
+
readonly actionName: string;
|
|
63
|
+
readonly schemaActionId: string;
|
|
64
|
+
readonly entity: string;
|
|
65
|
+
constructor(record: OdinRecord<any> | {
|
|
66
|
+
id: string;
|
|
67
|
+
entity: string;
|
|
68
|
+
type?: string;
|
|
69
|
+
}, properties: CancelPaymentMethodProperties, options?: {
|
|
70
|
+
journeyId?: string;
|
|
71
|
+
stageKey?: string;
|
|
72
|
+
});
|
|
73
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CancelPaymentMethod Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Cancel this direct debit mandate. Sets the status to Cancellation Requested; a scheduled job then asks the payment gateway to take the instruction down at the bank.
|
|
6
|
+
*
|
|
7
|
+
* @module BillingModule
|
|
8
|
+
* @entity PaymentMethod
|
|
9
|
+
* @actionKey CancelPaymentMethod
|
|
10
|
+
* @event k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.CancelPaymentMethod
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.CancelPaymentMethodDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* Cancel mandate
|
|
19
|
+
*
|
|
20
|
+
* Cancel this direct debit mandate. Sets the status to Cancellation Requested; a scheduled job then asks the payment gateway to take the instruction down at the bank.
|
|
21
|
+
*
|
|
22
|
+
* @actionType UPDATE - Updates an existing PaymentMethod record
|
|
23
|
+
* @module BillingModule
|
|
24
|
+
* @entity PaymentMethod
|
|
25
|
+
* @event k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.CancelPaymentMethod
|
|
26
|
+
* @permission schema.action.cancelpaymentmethod.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class CancelPaymentMethodDto extends core_1.OdinRecordUpdateDto {
|
|
30
|
+
constructor(record, properties, options) {
|
|
31
|
+
super({
|
|
32
|
+
id: record.id,
|
|
33
|
+
entity: record.entity,
|
|
34
|
+
type: record.type,
|
|
35
|
+
properties,
|
|
36
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
37
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'CancelPaymentMethod';
|
|
40
|
+
this.schemaActionId = '063cf205-8737-4164-86f6-caa20ddea8fd';
|
|
41
|
+
this.entity = 'BillingModule:PaymentMethod';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CancelPaymentMethodDto = CancelPaymentMethodDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CancelPaymentMethodDto.ACTION_TYPE = 'UPDATE';
|
|
47
|
+
CancelPaymentMethodDto.ACTION_KEY = 'CancelPaymentMethod';
|
|
48
|
+
CancelPaymentMethodDto.MODULE_NAME = 'BillingModule';
|
|
49
|
+
CancelPaymentMethodDto.ENTITIES = ['PaymentMethod'];
|
|
50
|
+
CancelPaymentMethodDto.EVENT_NAME = 'k1.t-hEOJjsDb.BillingModule.PaymentMethod.Update.CancelPaymentMethod';
|
|
51
|
+
CancelPaymentMethodDto.PERMISSION = 'schema.action.cancelpaymentmethod.trigger';
|
|
52
|
+
/** Step metadata - entity this action targets */
|
|
53
|
+
CancelPaymentMethodDto.STEP_ENTITY = 'BillingModule:PaymentMethod';
|
|
54
|
+
CancelPaymentMethodDto.STEP_SCHEMA_ID = '29a21375-b036-43b4-b64e-c0322370c85d';
|
|
55
|
+
CancelPaymentMethodDto.STEP_SCHEMA_ACTION_ID = '063cf205-8737-4164-86f6-caa20ddea8fd';
|
|
56
|
+
CancelPaymentMethodDto.AUTO_LINK_PARENT = false;
|
|
@@ -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:
|
|
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
|
|
@@ -34,6 +34,7 @@ export interface MovePgPaymentMethodToCancellationRequestedProperties {
|
|
|
34
34
|
* @module BillingModule
|
|
35
35
|
* @entity PgPaymentMethod
|
|
36
36
|
* @entityType DEFAULT (Default)
|
|
37
|
+
* @targetStages StatusStageCancellationRequested
|
|
37
38
|
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Update.MovePgPaymentMethodToCancellationRequested
|
|
38
39
|
* @permission schema.action.movepgpaymentmethodtocancellationrequested.trigger
|
|
39
40
|
* @benchmark This action is tracked for performance benchmarks
|
|
@@ -47,6 +48,7 @@ export declare class MovePgPaymentMethodToCancellationRequestedDto extends OdinR
|
|
|
47
48
|
static readonly ENTITY_TYPE = "DEFAULT";
|
|
48
49
|
static readonly EVENT_NAME = "k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Update.MovePgPaymentMethodToCancellationRequested";
|
|
49
50
|
static readonly PERMISSION = "schema.action.movepgpaymentmethodtocancellationrequested.trigger";
|
|
51
|
+
static readonly TARGET_STAGES: readonly ["StatusStageCancellationRequested"];
|
|
50
52
|
/** Step metadata - entity this action targets */
|
|
51
53
|
static readonly STEP_ENTITY = "BillingModule:PgPaymentMethod";
|
|
52
54
|
static readonly STEP_SCHEMA_ID = "e853a183-c7a1-4cb9-a3de-7429443aea38";
|
|
@@ -24,6 +24,7 @@ const core_1 = require("@d19n/odin-types/dist/core");
|
|
|
24
24
|
* @module BillingModule
|
|
25
25
|
* @entity PgPaymentMethod
|
|
26
26
|
* @entityType DEFAULT (Default)
|
|
27
|
+
* @targetStages StatusStageCancellationRequested
|
|
27
28
|
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Update.MovePgPaymentMethodToCancellationRequested
|
|
28
29
|
* @permission schema.action.movepgpaymentmethodtocancellationrequested.trigger
|
|
29
30
|
* @benchmark This action is tracked for performance benchmarks
|
|
@@ -52,6 +53,7 @@ MovePgPaymentMethodToCancellationRequestedDto.ENTITIES = ['PgPaymentMethod'];
|
|
|
52
53
|
MovePgPaymentMethodToCancellationRequestedDto.ENTITY_TYPE = 'DEFAULT';
|
|
53
54
|
MovePgPaymentMethodToCancellationRequestedDto.EVENT_NAME = 'k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Update.MovePgPaymentMethodToCancellationRequested';
|
|
54
55
|
MovePgPaymentMethodToCancellationRequestedDto.PERMISSION = 'schema.action.movepgpaymentmethodtocancellationrequested.trigger';
|
|
56
|
+
MovePgPaymentMethodToCancellationRequestedDto.TARGET_STAGES = ['StatusStageCancellationRequested'];
|
|
55
57
|
/** Step metadata - entity this action targets */
|
|
56
58
|
MovePgPaymentMethodToCancellationRequestedDto.STEP_ENTITY = 'BillingModule:PgPaymentMethod';
|
|
57
59
|
MovePgPaymentMethodToCancellationRequestedDto.STEP_SCHEMA_ID = 'e853a183-c7a1-4cb9-a3de-7429443aea38';
|
|
@@ -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:
|
|
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:
|
|
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:
|
|
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
|
|
@@ -22,7 +22,7 @@ export interface UpdatePaymentMethodMessage extends OdinRecordUpdatedEvent<Updat
|
|
|
22
22
|
* Properties for UpdatePaymentMethod action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 2
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 1
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdatePaymentMethodProperties {
|
|
28
28
|
/**
|
|
@@ -41,6 +41,14 @@ export interface UpdatePaymentMethodProperties {
|
|
|
41
41
|
* @required
|
|
42
42
|
*/
|
|
43
43
|
Status: string;
|
|
44
|
+
/**
|
|
45
|
+
* Status Updated At
|
|
46
|
+
*
|
|
47
|
+
* the date the mandate last changed statuses (Finance - PaymentMethod)
|
|
48
|
+
* @type {DATE}
|
|
49
|
+
* @format DD/MM/YYYY
|
|
50
|
+
*/
|
|
51
|
+
StatusUpdatedAt?: string | null;
|
|
44
52
|
}
|
|
45
53
|
/**
|
|
46
54
|
* UpdatePaymentMethod
|
|
@@ -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
|
|
@@ -48,6 +48,7 @@ export declare enum PaymentMethodProvider {
|
|
|
48
48
|
* @remarks Available options:
|
|
49
49
|
* - `ACTIVE` - Active
|
|
50
50
|
* - `BLOCKED` - Blocked
|
|
51
|
+
* - `CANCELLATION_REQUESTED` - Cancellation Requested
|
|
51
52
|
* - `CANCELLED` - Cancelled
|
|
52
53
|
* - `CREATED` - Created
|
|
53
54
|
* - `CUSTOMER_APPROVAL_GRANTED` - Customer approval granted
|
|
@@ -60,11 +61,12 @@ export declare enum PaymentMethodProvider {
|
|
|
60
61
|
* - `REPLACED` - Replaced
|
|
61
62
|
* - `RESUBMISSION_REQUESTED` - Resubmission requested
|
|
62
63
|
* - `SUBMITTED` - Submitted
|
|
63
|
-
* -
|
|
64
|
+
* - ... and 1 more
|
|
64
65
|
*/
|
|
65
66
|
export declare enum PaymentMethodStatus {
|
|
66
67
|
ACTIVE = "ACTIVE",
|
|
67
68
|
BLOCKED = "BLOCKED",
|
|
69
|
+
CANCELLATION_REQUESTED = "CANCELLATION_REQUESTED",
|
|
68
70
|
CANCELLED = "CANCELLED",
|
|
69
71
|
CREATED = "CREATED",
|
|
70
72
|
CUSTOMER_APPROVAL_GRANTED = "CUSTOMER_APPROVAL_GRANTED",
|
|
@@ -46,6 +46,7 @@ var PaymentMethodProvider;
|
|
|
46
46
|
* @remarks Available options:
|
|
47
47
|
* - `ACTIVE` - Active
|
|
48
48
|
* - `BLOCKED` - Blocked
|
|
49
|
+
* - `CANCELLATION_REQUESTED` - Cancellation Requested
|
|
49
50
|
* - `CANCELLED` - Cancelled
|
|
50
51
|
* - `CREATED` - Created
|
|
51
52
|
* - `CUSTOMER_APPROVAL_GRANTED` - Customer approval granted
|
|
@@ -58,12 +59,13 @@ var PaymentMethodProvider;
|
|
|
58
59
|
* - `REPLACED` - Replaced
|
|
59
60
|
* - `RESUBMISSION_REQUESTED` - Resubmission requested
|
|
60
61
|
* - `SUBMITTED` - Submitted
|
|
61
|
-
* -
|
|
62
|
+
* - ... and 1 more
|
|
62
63
|
*/
|
|
63
64
|
var PaymentMethodStatus;
|
|
64
65
|
(function (PaymentMethodStatus) {
|
|
65
66
|
PaymentMethodStatus["ACTIVE"] = "ACTIVE";
|
|
66
67
|
PaymentMethodStatus["BLOCKED"] = "BLOCKED";
|
|
68
|
+
PaymentMethodStatus["CANCELLATION_REQUESTED"] = "CANCELLATION_REQUESTED";
|
|
67
69
|
PaymentMethodStatus["CANCELLED"] = "CANCELLED";
|
|
68
70
|
PaymentMethodStatus["CREATED"] = "CREATED";
|
|
69
71
|
PaymentMethodStatus["CUSTOMER_APPROVAL_GRANTED"] = "CUSTOMER_APPROVAL_GRANTED";
|
|
@@ -21,6 +21,7 @@ import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/
|
|
|
21
21
|
import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
22
22
|
import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
|
|
23
23
|
import { PaymentMethodProperties } from '../entities-v2/PaymentMethod';
|
|
24
|
+
import { CancelPaymentMethodProperties } from '../actions-v2/CancelPaymentMethodDto';
|
|
24
25
|
import { CreatePaymentMethodProperties } from '../actions-v2/CreatePaymentMethodDto';
|
|
25
26
|
import { UpdatePaymentMethodProperties } from '../actions-v2/UpdatePaymentMethodDto';
|
|
26
27
|
import { NoteRecord } from './NoteRecord';
|
|
@@ -302,6 +303,33 @@ export declare class PaymentMethodRecord<TProps = PaymentMethodProperties> {
|
|
|
302
303
|
journeyId?: string;
|
|
303
304
|
stageKey?: string;
|
|
304
305
|
}): ActionBuilder;
|
|
306
|
+
/**
|
|
307
|
+
* CancelPaymentMethod
|
|
308
|
+
*
|
|
309
|
+
* Updates this PaymentMethod record.
|
|
310
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
311
|
+
*
|
|
312
|
+
* @param propertiesOrOptions - Properties to update, or options object
|
|
313
|
+
* @param options - Optional settings (journeyId, stageKey)
|
|
314
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
315
|
+
* @throws Error if called on a new (unsaved) record
|
|
316
|
+
*
|
|
317
|
+
* @example
|
|
318
|
+
* ```typescript
|
|
319
|
+
* const record = await odinClient.paymentMethods.get(id);
|
|
320
|
+
* await record.cancelPaymentMethod({ ... }).execute();
|
|
321
|
+
*
|
|
322
|
+
* // Dry run (for debugging)
|
|
323
|
+
* const payload = record.cancelPaymentMethod({ ... }).dryRun();
|
|
324
|
+
* ```
|
|
325
|
+
*/
|
|
326
|
+
cancelPaymentMethod(propertiesOrOptions?: CancelPaymentMethodProperties | {
|
|
327
|
+
journeyId?: string;
|
|
328
|
+
stageKey?: string;
|
|
329
|
+
}, options?: {
|
|
330
|
+
journeyId?: string;
|
|
331
|
+
stageKey?: string;
|
|
332
|
+
}): ActionBuilder;
|
|
305
333
|
/**
|
|
306
334
|
* UpdatePaymentMethod
|
|
307
335
|
*
|
|
@@ -436,6 +436,43 @@ class PaymentMethodRecord {
|
|
|
436
436
|
// ============================================
|
|
437
437
|
// UPDATE ACTIONS (require existing record)
|
|
438
438
|
// ============================================
|
|
439
|
+
/**
|
|
440
|
+
* CancelPaymentMethod
|
|
441
|
+
*
|
|
442
|
+
* Updates this PaymentMethod record.
|
|
443
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
444
|
+
*
|
|
445
|
+
* @param propertiesOrOptions - Properties to update, or options object
|
|
446
|
+
* @param options - Optional settings (journeyId, stageKey)
|
|
447
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
448
|
+
* @throws Error if called on a new (unsaved) record
|
|
449
|
+
*
|
|
450
|
+
* @example
|
|
451
|
+
* ```typescript
|
|
452
|
+
* const record = await odinClient.paymentMethods.get(id);
|
|
453
|
+
* await record.cancelPaymentMethod({ ... }).execute();
|
|
454
|
+
*
|
|
455
|
+
* // Dry run (for debugging)
|
|
456
|
+
* const payload = record.cancelPaymentMethod({ ... }).dryRun();
|
|
457
|
+
* ```
|
|
458
|
+
*/
|
|
459
|
+
cancelPaymentMethod(propertiesOrOptions, options) {
|
|
460
|
+
var _a;
|
|
461
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
462
|
+
throw new Error('cancelPaymentMethod requires an existing record. Use accessor.get() first.');
|
|
463
|
+
let properties = {};
|
|
464
|
+
let opts = options;
|
|
465
|
+
if (propertiesOrOptions) {
|
|
466
|
+
if ('journeyId' in propertiesOrOptions || 'stageKey' in propertiesOrOptions) {
|
|
467
|
+
opts = propertiesOrOptions;
|
|
468
|
+
}
|
|
469
|
+
else {
|
|
470
|
+
properties = propertiesOrOptions;
|
|
471
|
+
}
|
|
472
|
+
}
|
|
473
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'CancelPaymentMethod', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, opts);
|
|
474
|
+
return new ActionBuilder(this._provider, 'BillingModule', 'PaymentMethod', payload, () => { this._pendingLinks = []; });
|
|
475
|
+
}
|
|
439
476
|
/**
|
|
440
477
|
* UpdatePaymentMethod
|
|
441
478
|
*
|
|
@@ -24,7 +24,6 @@ import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
|
24
24
|
import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
|
|
25
25
|
import { PgPaymentMethodProperties } from '../entities-v2/PgPaymentMethod';
|
|
26
26
|
import { CreatePgPaymentMethodProperties } from '../actions-v2/CreatePgPaymentMethodDto';
|
|
27
|
-
import { MovePgPaymentMethodToCancellationRequestedProperties } from '../actions-v2/MovePgPaymentMethodToCancellationRequestedDto';
|
|
28
27
|
import { UpdatePgPaymentMethodActivatedDatetimeProperties } from '../actions-v2/UpdatePgPaymentMethodActivatedDatetimeDto';
|
|
29
28
|
import { UpdatePgPaymentMethodProperties } from '../actions-v2/UpdatePgPaymentMethodDto';
|
|
30
29
|
import { UpdatePgPaymentMethodFirstTransactionProcessedProperties } from '../actions-v2/UpdatePgPaymentMethodFirstTransactionProcessedDto';
|
|
@@ -390,29 +389,27 @@ export declare class PgPaymentMethodRecord<TProps = PgPaymentMethodProperties> {
|
|
|
390
389
|
/**
|
|
391
390
|
* MovePgPaymentMethodToCancellationRequested
|
|
392
391
|
*
|
|
393
|
-
*
|
|
394
|
-
* Returns an ActionBuilder - call .execute() to
|
|
392
|
+
* Transitions this PgPaymentMethod record to a new pipeline stage.
|
|
393
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
395
394
|
*
|
|
396
|
-
* @
|
|
397
|
-
*
|
|
398
|
-
* @
|
|
395
|
+
* @remarks Transitions to stage: StatusStageCancellationRequested
|
|
396
|
+
*
|
|
397
|
+
* @param options - Optional settings
|
|
398
|
+
* @param options.journeyId - Associate with a journey
|
|
399
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
399
400
|
* @throws Error if called on a new (unsaved) record
|
|
400
401
|
*
|
|
401
402
|
* @example
|
|
402
403
|
* ```typescript
|
|
403
404
|
* const record = await odinClient.pgPaymentMethods.get(id);
|
|
404
|
-
* await record.movePgPaymentMethodToCancellationRequested(
|
|
405
|
+
* await record.movePgPaymentMethodToCancellationRequested().execute();
|
|
405
406
|
*
|
|
406
407
|
* // Dry run (for debugging)
|
|
407
|
-
* const payload = record.movePgPaymentMethodToCancellationRequested(
|
|
408
|
+
* const payload = record.movePgPaymentMethodToCancellationRequested().dryRun();
|
|
408
409
|
* ```
|
|
409
410
|
*/
|
|
410
|
-
movePgPaymentMethodToCancellationRequested(
|
|
411
|
+
movePgPaymentMethodToCancellationRequested(options?: {
|
|
411
412
|
journeyId?: string;
|
|
412
|
-
stageKey?: string;
|
|
413
|
-
}, options?: {
|
|
414
|
-
journeyId?: string;
|
|
415
|
-
stageKey?: string;
|
|
416
413
|
}): ActionBuilder;
|
|
417
414
|
/**
|
|
418
415
|
* MovePgPaymentMethodToCancelled
|
|
@@ -514,38 +514,30 @@ class PgPaymentMethodRecord {
|
|
|
514
514
|
/**
|
|
515
515
|
* MovePgPaymentMethodToCancellationRequested
|
|
516
516
|
*
|
|
517
|
-
*
|
|
518
|
-
* Returns an ActionBuilder - call .execute() to
|
|
517
|
+
* Transitions this PgPaymentMethod record to a new pipeline stage.
|
|
518
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
519
519
|
*
|
|
520
|
-
* @
|
|
521
|
-
*
|
|
522
|
-
* @
|
|
520
|
+
* @remarks Transitions to stage: StatusStageCancellationRequested
|
|
521
|
+
*
|
|
522
|
+
* @param options - Optional settings
|
|
523
|
+
* @param options.journeyId - Associate with a journey
|
|
524
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
523
525
|
* @throws Error if called on a new (unsaved) record
|
|
524
526
|
*
|
|
525
527
|
* @example
|
|
526
528
|
* ```typescript
|
|
527
529
|
* const record = await odinClient.pgPaymentMethods.get(id);
|
|
528
|
-
* await record.movePgPaymentMethodToCancellationRequested(
|
|
530
|
+
* await record.movePgPaymentMethodToCancellationRequested().execute();
|
|
529
531
|
*
|
|
530
532
|
* // Dry run (for debugging)
|
|
531
|
-
* const payload = record.movePgPaymentMethodToCancellationRequested(
|
|
533
|
+
* const payload = record.movePgPaymentMethodToCancellationRequested().dryRun();
|
|
532
534
|
* ```
|
|
533
535
|
*/
|
|
534
|
-
movePgPaymentMethodToCancellationRequested(
|
|
536
|
+
movePgPaymentMethodToCancellationRequested(options) {
|
|
535
537
|
var _a;
|
|
536
538
|
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
537
539
|
throw new Error('movePgPaymentMethodToCancellationRequested requires an existing record. Use accessor.get() first.');
|
|
538
|
-
|
|
539
|
-
let opts = options;
|
|
540
|
-
if (propertiesOrOptions) {
|
|
541
|
-
if ('journeyId' in propertiesOrOptions || 'stageKey' in propertiesOrOptions) {
|
|
542
|
-
opts = propertiesOrOptions;
|
|
543
|
-
}
|
|
544
|
-
else {
|
|
545
|
-
properties = propertiesOrOptions;
|
|
546
|
-
}
|
|
547
|
-
}
|
|
548
|
-
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MovePgPaymentMethodToCancellationRequested', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, opts);
|
|
540
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MovePgPaymentMethodToCancellationRequested', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'StatusStageCancellationRequested' }, options);
|
|
549
541
|
return new ActionBuilder(this._provider, 'BillingModule', 'PgPaymentMethod', payload, () => { this._pendingLinks = []; });
|
|
550
542
|
}
|
|
551
543
|
/**
|
|
@@ -25,6 +25,7 @@ export { ChurnRequestRecord, isChurnRequestRecord } from './ChurnRequestRecord';
|
|
|
25
25
|
export { ChangeReasonRecord, isChangeReasonRecord } from './ChangeReasonRecord';
|
|
26
26
|
export { PICRequestRecord, isPICRequestRecord } from './PICRequestRecord';
|
|
27
27
|
export { PaymentRecord, isPaymentRecord } from './PaymentRecord';
|
|
28
|
+
export { PaymentMethodRecord, isPaymentMethodRecord } from './PaymentMethodRecord';
|
|
28
29
|
export { TransactionRecord, isTransactionRecord } from './TransactionRecord';
|
|
29
30
|
export { PermissionToFailRecord, isPermissionToFailRecord } from './PermissionToFailRecord';
|
|
30
31
|
export { AccountRecord, isAccountRecord } from './AccountRecord';
|
|
@@ -79,7 +80,6 @@ export { ReferralRecord, isReferralRecord } from './ReferralRecord';
|
|
|
79
80
|
export { OutboundDialCampaignRecord, isOutboundDialCampaignRecord } from './OutboundDialCampaignRecord';
|
|
80
81
|
export { OutboundDialSessionRecord, isOutboundDialSessionRecord } from './OutboundDialSessionRecord';
|
|
81
82
|
export { SmsMessageRecord, isSmsMessageRecord } from './SmsMessageRecord';
|
|
82
|
-
export { PaymentMethodRecord, isPaymentMethodRecord } from './PaymentMethodRecord';
|
|
83
83
|
export { PgContactRecord, isPgContactRecord } from './PgContactRecord';
|
|
84
84
|
export { PgDisputeRecord, isPgDisputeRecord } from './PgDisputeRecord';
|
|
85
85
|
export { PgLogRecord, isPgLogRecord } from './PgLogRecord';
|
package/dist/records-v2/index.js
CHANGED
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
12
|
*/
|
|
13
13
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
-
exports.
|
|
15
|
-
exports.
|
|
16
|
-
exports.isPgPaymentMethodRecord = exports.PgPaymentMethodRecord = exports.isPgLogRecord = exports.PgLogRecord = exports.isPgDisputeRecord = exports.PgDisputeRecord = exports.isPgContactRecord = exports.PgContactRecord = exports.
|
|
14
|
+
exports.isUgExternalAuditRecord = exports.UgExternalAuditRecord = exports.isPaymentMethodRefundRecord = exports.PaymentMethodRefundRecord = exports.isCustomerDeviceRouterRecord = exports.CustomerDeviceRouterRecord = exports.isConversationRecord = exports.ConversationRecord = exports.isOntReplacementApprovalRecord = exports.OntReplacementApprovalRecord = exports.isAccountRecord = exports.AccountRecord = exports.isPermissionToFailRecord = exports.PermissionToFailRecord = exports.isTransactionRecord = exports.TransactionRecord = exports.isPaymentMethodRecord = exports.PaymentMethodRecord = exports.isPaymentRecord = exports.PaymentRecord = exports.isPICRequestRecord = exports.PICRequestRecord = exports.isChangeReasonRecord = exports.ChangeReasonRecord = exports.isChurnRequestRecord = exports.ChurnRequestRecord = exports.isBillingRequestRecord = exports.BillingRequestRecord = exports.isBillingAdjustmentRecord = exports.BillingAdjustmentRecord = exports.isServiceAppointmentConfigRecord = exports.ServiceAppointmentConfigRecord = exports.isCrmDatasetRecord = exports.CrmDatasetRecord = exports.isNoteRecord = exports.NoteRecord = exports.isDataIssueRecord = exports.DataIssueRecord = exports.isContractBuyOutRecord = exports.ContractBuyOutRecord = exports.isAddressInteractionRecord = exports.AddressInteractionRecord = exports.isAddressRecord = exports.AddressRecord = exports.isCaseRecord = exports.CaseRecord = exports.isWorkOrderRecord = exports.WorkOrderRecord = exports.isOrderRecord = exports.OrderRecord = void 0;
|
|
15
|
+
exports.isCustomerDeviceOntRecord = exports.CustomerDeviceOntRecord = exports.isCustomerDeviceConfigurationRecord = exports.CustomerDeviceConfigurationRecord = exports.isCustomerDeviceRecord = exports.CustomerDeviceRecord = exports.isConversationSummaryFeedbackRecord = exports.ConversationSummaryFeedbackRecord = exports.isContactIdentityRecord = exports.ContactIdentityRecord = exports.isConfigRecord = exports.ConfigRecord = exports.isMessageRecord = exports.MessageRecord = exports.isOrderKciRecord = exports.OrderKciRecord = exports.isRewardRecord = exports.RewardRecord = exports.isContactRecord = exports.ContactRecord = exports.isCallRecord = exports.CallRecord = exports.isTwilioCallEventRecord = exports.TwilioCallEventRecord = exports.isProductRecord = exports.ProductRecord = exports.isBrskEntityMigrationErrorRecord = exports.BrskEntityMigrationErrorRecord = exports.isBngProvisionRecord = exports.BngProvisionRecord = exports.isPgFileAllocationRecord = exports.PgFileAllocationRecord = exports.isAppointmentRecord = exports.AppointmentRecord = exports.isEmailRecord = exports.EmailRecord = exports.isCallLegRecord = exports.CallLegRecord = exports.isAffiliateCodeRecord = exports.AffiliateCodeRecord = exports.isActivityLogRecord = exports.ActivityLogRecord = exports.isAccountCreditRecord = exports.AccountCreditRecord = exports.isYfFieldVisitOutcomeFormRecord = exports.YfFieldVisitOutcomeFormRecord = exports.isRemediationOutcomeFormRecord = exports.RemediationOutcomeFormRecord = exports.isOhExternalAuditRecord = exports.OhExternalAuditRecord = void 0;
|
|
16
|
+
exports.isPgPaymentMethodRecord = exports.PgPaymentMethodRecord = exports.isPgLogRecord = exports.PgLogRecord = exports.isPgDisputeRecord = exports.PgDisputeRecord = exports.isPgContactRecord = exports.PgContactRecord = exports.isSmsMessageRecord = exports.SmsMessageRecord = exports.isOutboundDialSessionRecord = exports.OutboundDialSessionRecord = exports.isOutboundDialCampaignRecord = exports.OutboundDialCampaignRecord = exports.isReferralRecord = exports.ReferralRecord = exports.isOrderCheckRecord = exports.OrderCheckRecord = exports.isCampaignRecord = exports.CampaignRecord = exports.isOneTouchSwitchRecord = exports.OneTouchSwitchRecord = exports.isOfferTemplateRecord = exports.OfferTemplateRecord = exports.isReturnsRecord = exports.ReturnsRecord = exports.isNetworkDeviceRecord = exports.NetworkDeviceRecord = exports.isModifyServiceRequestRecord = exports.ModifyServiceRequestRecord = exports.isLeadRecord = exports.LeadRecord = exports.isInvoiceItemRecord = exports.InvoiceItemRecord = exports.isImpersonationTrackerRecord = exports.ImpersonationTrackerRecord = exports.isActivityRecord = exports.ActivityRecord = exports.isFileRecord = exports.FileRecord = exports.isFieldServiceProductRecord = exports.FieldServiceProductRecord = exports.isFieldServiceDispatchedProductRecord = exports.FieldServiceDispatchedProductRecord = exports.isExchangeRecord = exports.ExchangeRecord = exports.isEmailTemplateRecord = exports.EmailTemplateRecord = exports.isEmailSenderRecord = exports.EmailSenderRecord = void 0;
|
|
17
17
|
exports.isYfAgentLocationRecord = exports.YfAgentLocationRecord = exports.isWorkOrderStatusUpdateRecord = exports.WorkOrderStatusUpdateRecord = exports.isWayleaveAuditRecord = exports.WayleaveAuditRecord = exports.isUserRecord = exports.UserRecord = exports.isTwilioWorkerRecord = exports.TwilioWorkerRecord = exports.isTwilioUserUpdateRecord = exports.TwilioUserUpdateRecord = exports.isTwilioTaskQueueRecord = exports.TwilioTaskQueueRecord = exports.isTwilioActivityRecord = exports.TwilioActivityRecord = exports.isTimeSlotRecord = exports.TimeSlotRecord = exports.isTeamRecord = exports.TeamRecord = exports.isSalesTerritoryRecord = exports.SalesTerritoryRecord = exports.isRegionRecord = exports.RegionRecord = exports.isVoiceConfigurationRecord = exports.VoiceConfigurationRecord = exports.isOrderItemRecord = exports.OrderItemRecord = exports.isRecontractRecord = exports.RecontractRecord = exports.isQaReportRecord = exports.QaReportRecord = exports.isPushNotificationRecord = exports.PushNotificationRecord = exports.isPgWebhookRecord = exports.PgWebhookRecord = exports.isPgWebhookAttemptRecord = exports.PgWebhookAttemptRecord = exports.isPgAccountValidationRecord = exports.PgAccountValidationRecord = exports.isPgTransactionRecord = exports.PgTransactionRecord = exports.isPgSortCodeSubstitutionRecord = exports.PgSortCodeSubstitutionRecord = exports.isPgVocalinkRecord = exports.PgVocalinkRecord = exports.isPgDirectDebitFileRecord = exports.PgDirectDebitFileRecord = exports.isPgReportEventRecord = exports.PgReportEventRecord = void 0;
|
|
18
18
|
exports.isCustomerPhonePortingRecord = exports.CustomerPhonePortingRecord = exports.isVisitRecord = exports.VisitRecord = exports.isSmsTemplateRecord = exports.SmsTemplateRecord = exports.isServiceRecord = exports.ServiceRecord = exports.isNotificationTemplateRecord = exports.NotificationTemplateRecord = exports.isAgentStatusRecord = exports.AgentStatusRecord = exports.isScheduleSlotRecord = exports.ScheduleSlotRecord = exports.isPriceBookRecord = exports.PriceBookRecord = exports.isOverlayRealA55Record = exports.OverlayRealA55Record = exports.isOfferRecord = exports.OfferRecord = exports.isServiceAppointmentRecord = exports.ServiceAppointmentRecord = exports.isOutageRecord = exports.OutageRecord = exports.isSiteSpecificRiskAssessmentOutcomeFormRecord = exports.SiteSpecificRiskAssessmentOutcomeFormRecord = exports.isRemediationRequiredReasonRecord = exports.RemediationRequiredReasonRecord = exports.isKnowledgeArticleRecord = exports.KnowledgeArticleRecord = exports.isInvoiceRecord = exports.InvoiceRecord = exports.isDiscountRecord = exports.DiscountRecord = exports.isCustomerDeviceAtaRecord = exports.CustomerDeviceAtaRecord = exports.isCreditNoteRecord = exports.CreditNoteRecord = exports.isOutboundDialCampaignCaseRecord = exports.OutboundDialCampaignCaseRecord = exports.isYfWifiSurveyRecord = exports.YfWifiSurveyRecord = void 0;
|
|
19
19
|
var OrderRecord_1 = require("./OrderRecord");
|
|
@@ -64,6 +64,9 @@ Object.defineProperty(exports, "isPICRequestRecord", { enumerable: true, get: fu
|
|
|
64
64
|
var PaymentRecord_1 = require("./PaymentRecord");
|
|
65
65
|
Object.defineProperty(exports, "PaymentRecord", { enumerable: true, get: function () { return PaymentRecord_1.PaymentRecord; } });
|
|
66
66
|
Object.defineProperty(exports, "isPaymentRecord", { enumerable: true, get: function () { return PaymentRecord_1.isPaymentRecord; } });
|
|
67
|
+
var PaymentMethodRecord_1 = require("./PaymentMethodRecord");
|
|
68
|
+
Object.defineProperty(exports, "PaymentMethodRecord", { enumerable: true, get: function () { return PaymentMethodRecord_1.PaymentMethodRecord; } });
|
|
69
|
+
Object.defineProperty(exports, "isPaymentMethodRecord", { enumerable: true, get: function () { return PaymentMethodRecord_1.isPaymentMethodRecord; } });
|
|
67
70
|
var TransactionRecord_1 = require("./TransactionRecord");
|
|
68
71
|
Object.defineProperty(exports, "TransactionRecord", { enumerable: true, get: function () { return TransactionRecord_1.TransactionRecord; } });
|
|
69
72
|
Object.defineProperty(exports, "isTransactionRecord", { enumerable: true, get: function () { return TransactionRecord_1.isTransactionRecord; } });
|
|
@@ -226,9 +229,6 @@ Object.defineProperty(exports, "isOutboundDialSessionRecord", { enumerable: true
|
|
|
226
229
|
var SmsMessageRecord_1 = require("./SmsMessageRecord");
|
|
227
230
|
Object.defineProperty(exports, "SmsMessageRecord", { enumerable: true, get: function () { return SmsMessageRecord_1.SmsMessageRecord; } });
|
|
228
231
|
Object.defineProperty(exports, "isSmsMessageRecord", { enumerable: true, get: function () { return SmsMessageRecord_1.isSmsMessageRecord; } });
|
|
229
|
-
var PaymentMethodRecord_1 = require("./PaymentMethodRecord");
|
|
230
|
-
Object.defineProperty(exports, "PaymentMethodRecord", { enumerable: true, get: function () { return PaymentMethodRecord_1.PaymentMethodRecord; } });
|
|
231
|
-
Object.defineProperty(exports, "isPaymentMethodRecord", { enumerable: true, get: function () { return PaymentMethodRecord_1.isPaymentMethodRecord; } });
|
|
232
232
|
var PgContactRecord_1 = require("./PgContactRecord");
|
|
233
233
|
Object.defineProperty(exports, "PgContactRecord", { enumerable: true, get: function () { return PgContactRecord_1.PgContactRecord; } });
|
|
234
234
|
Object.defineProperty(exports, "isPgContactRecord", { enumerable: true, get: function () { return PgContactRecord_1.isPgContactRecord; } });
|