@d19n/youfibre-odin-sdk 1.0.190 → 1.0.191

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.
@@ -1,19 +1,18 @@
1
1
  import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
2
- interface ConfirmPaymentSuccessProperties {
2
+ export interface ConfirmPaymentSuccessMessage extends OdinRecordUpdatedEvent<ConfirmPaymentSuccessDto, {}> {
3
3
  }
4
- export declare class ConfirmPaymentSuccessDto extends OdinRecordUpdateDto<ConfirmPaymentSuccessProperties> {
4
+ export declare class ConfirmPaymentSuccessDto extends OdinRecordUpdateDto<Record<string, any>> {
5
5
  readonly actionName: string;
6
6
  readonly schemaActionId: string;
7
+ readonly stageKey: string;
7
8
  constructor(record: OdinRecord<any> | {
8
9
  id: string;
9
10
  entity: string;
10
11
  type?: string;
11
- }, properties: ConfirmPaymentSuccessProperties, options?: {
12
+ }, options?: {
12
13
  journeyId?: string;
13
- stageKey?: string;
14
14
  });
15
- }
16
- export interface ConfirmPaymentSuccessMessage extends OdinRecordUpdatedEvent<ConfirmPaymentSuccessDto, ConfirmPaymentSuccessProperties> {
15
+ static readonly stepClasses: readonly [];
16
+ steps: [];
17
17
  }
18
18
  export declare const ROUTING_KEY_CONFIRM_PAYMENT_SUCCESS = "ConfirmPaymentSuccess";
19
- export {};
@@ -3,18 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ROUTING_KEY_CONFIRM_PAYMENT_SUCCESS = exports.ConfirmPaymentSuccessDto = void 0;
4
4
  const core_1 = require("@d19n/odin-types/dist/core");
5
5
  class ConfirmPaymentSuccessDto extends core_1.OdinRecordUpdateDto {
6
- constructor(record, properties, options) {
6
+ constructor(record, options) {
7
7
  super({
8
8
  id: record.id,
9
9
  entity: record.entity,
10
10
  type: record.type,
11
- properties,
11
+ properties: {},
12
12
  journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
13
- stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
14
13
  });
15
14
  this.actionName = 'ConfirmPaymentSuccess';
16
15
  this.schemaActionId = 'eea6c593-3619-4c06-8ea7-997af2f3fba2';
16
+ this.stageKey = 'PaymentStageProcessed';
17
17
  }
18
18
  }
19
19
  exports.ConfirmPaymentSuccessDto = ConfirmPaymentSuccessDto;
20
+ ConfirmPaymentSuccessDto.stepClasses = [];
20
21
  exports.ROUTING_KEY_CONFIRM_PAYMENT_SUCCESS = 'ConfirmPaymentSuccess';
@@ -1,19 +1,18 @@
1
1
  import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
2
- interface FailPaymentProperties {
2
+ export interface FailPaymentMessage extends OdinRecordUpdatedEvent<FailPaymentDto, {}> {
3
3
  }
4
- export declare class FailPaymentDto extends OdinRecordUpdateDto<FailPaymentProperties> {
4
+ export declare class FailPaymentDto extends OdinRecordUpdateDto<Record<string, any>> {
5
5
  readonly actionName: string;
6
6
  readonly schemaActionId: string;
7
+ readonly stageKey: string;
7
8
  constructor(record: OdinRecord<any> | {
8
9
  id: string;
9
10
  entity: string;
10
11
  type?: string;
11
- }, properties: FailPaymentProperties, options?: {
12
+ }, options?: {
12
13
  journeyId?: string;
13
- stageKey?: string;
14
14
  });
15
- }
16
- export interface FailPaymentMessage extends OdinRecordUpdatedEvent<FailPaymentDto, FailPaymentProperties> {
15
+ static readonly stepClasses: readonly [];
16
+ steps: [];
17
17
  }
18
18
  export declare const ROUTING_KEY_FAIL_PAYMENT = "FailPayment";
19
- export {};
@@ -3,18 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ROUTING_KEY_FAIL_PAYMENT = exports.FailPaymentDto = void 0;
4
4
  const core_1 = require("@d19n/odin-types/dist/core");
5
5
  class FailPaymentDto extends core_1.OdinRecordUpdateDto {
6
- constructor(record, properties, options) {
6
+ constructor(record, options) {
7
7
  super({
8
8
  id: record.id,
9
9
  entity: record.entity,
10
10
  type: record.type,
11
- properties,
11
+ properties: {},
12
12
  journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
13
- stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
14
13
  });
15
14
  this.actionName = 'FailPayment';
16
15
  this.schemaActionId = 'd9d6cf25-8cf9-4e6d-a7e2-44f88543d853';
16
+ this.stageKey = 'PaymentStageError';
17
17
  }
18
18
  }
19
19
  exports.FailPaymentDto = FailPaymentDto;
20
+ FailPaymentDto.stepClasses = [];
20
21
  exports.ROUTING_KEY_FAIL_PAYMENT = 'FailPayment';
@@ -1,19 +1,18 @@
1
1
  import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
2
- interface VoidPaymentProperties {
2
+ export interface VoidPaymentMessage extends OdinRecordUpdatedEvent<VoidPaymentDto, {}> {
3
3
  }
4
- export declare class VoidPaymentDto extends OdinRecordUpdateDto<VoidPaymentProperties> {
4
+ export declare class VoidPaymentDto extends OdinRecordUpdateDto<Record<string, any>> {
5
5
  readonly actionName: string;
6
6
  readonly schemaActionId: string;
7
+ readonly stageKey: string;
7
8
  constructor(record: OdinRecord<any> | {
8
9
  id: string;
9
10
  entity: string;
10
11
  type?: string;
11
- }, properties: VoidPaymentProperties, options?: {
12
+ }, options?: {
12
13
  journeyId?: string;
13
- stageKey?: string;
14
14
  });
15
- }
16
- export interface VoidPaymentMessage extends OdinRecordUpdatedEvent<VoidPaymentDto, VoidPaymentProperties> {
15
+ static readonly stepClasses: readonly [];
16
+ steps: [];
17
17
  }
18
18
  export declare const ROUTING_KEY_VOID_PAYMENT = "VoidPayment";
19
- export {};
@@ -3,18 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ROUTING_KEY_VOID_PAYMENT = exports.VoidPaymentDto = void 0;
4
4
  const core_1 = require("@d19n/odin-types/dist/core");
5
5
  class VoidPaymentDto extends core_1.OdinRecordUpdateDto {
6
- constructor(record, properties, options) {
6
+ constructor(record, options) {
7
7
  super({
8
8
  id: record.id,
9
9
  entity: record.entity,
10
10
  type: record.type,
11
- properties,
11
+ properties: {},
12
12
  journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
13
- stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
14
13
  });
15
14
  this.actionName = 'VoidPayment';
16
15
  this.schemaActionId = '77689b76-4a08-4fa3-abec-8594c19768fd';
16
+ this.stageKey = 'PaymentStageVoided';
17
17
  }
18
18
  }
19
19
  exports.VoidPaymentDto = VoidPaymentDto;
20
+ VoidPaymentDto.stepClasses = [];
20
21
  exports.ROUTING_KEY_VOID_PAYMENT = 'VoidPayment';
@@ -6,14 +6,6 @@ import { FileProperties } from './File';
6
6
  export declare enum BillingAdjustmentEntityTypes {
7
7
  DEFAULT = "DEFAULT"
8
8
  }
9
- export declare enum BillingAdjustmentDiscountType {
10
- AMOUNT = "AMOUNT",
11
- PERCENT = "PERCENT"
12
- }
13
- export declare enum BillingAdjustmentProrationType {
14
- CHARGE = "CHARGE",
15
- CREDIT = "CREDIT"
16
- }
17
9
  export declare enum BillingAdjustmentReason {
18
10
  BILLING_DAY_ADJUSMENT_LEGACY = "BILLING_DAY_ADJUSTMENT",
19
11
  BILLING_DATE_CHANGE = "BILLING_DATE_CHANGE",
@@ -29,29 +21,37 @@ export declare enum BillingAdjustmentReason {
29
21
  SALES_MISSELLING_ADJUSTMENT = "SALES_MISSELLING_ADJUSTMENT",
30
22
  OUTAGE_COMPENSATION = "OUTAGE_COMPENSATION"
31
23
  }
24
+ export declare enum BillingAdjustmentDiscountType {
25
+ AMOUNT = "AMOUNT",
26
+ PERCENT = "PERCENT"
27
+ }
28
+ export declare enum BillingAdjustmentProrationType {
29
+ CHARGE = "CHARGE",
30
+ CREDIT = "CREDIT"
31
+ }
32
32
  export declare enum BillingAdjustmentPropertyKeys {
33
- Description = "Description",
33
+ FreePeriodLength = "FreePeriodLength",
34
+ Reason = "Reason",
34
35
  DiscountLength = "DiscountLength",
35
36
  DiscountType = "DiscountType",
36
37
  DiscountValue = "DiscountValue",
37
- FreePeriodLength = "FreePeriodLength",
38
- ProrationBillableDays = "ProrationBillableDays",
39
38
  ProrationType = "ProrationType",
40
- Reason = "Reason",
41
- Source = "Source",
42
- Title = "Title"
39
+ ProrationBillableDays = "ProrationBillableDays",
40
+ Title = "Title",
41
+ Description = "Description",
42
+ Source = "Source"
43
43
  }
44
44
  export interface BillingAdjustmentProperties {
45
- Description: string;
45
+ FreePeriodLength: number;
46
+ Reason: BillingAdjustmentReason;
46
47
  DiscountLength: number;
47
48
  DiscountType: BillingAdjustmentDiscountType;
48
49
  DiscountValue: number;
49
- FreePeriodLength: number;
50
- ProrationBillableDays: number;
51
50
  ProrationType: BillingAdjustmentProrationType;
52
- Reason: BillingAdjustmentReason;
53
- Source: string;
51
+ ProrationBillableDays: number;
54
52
  Title: string;
53
+ Description: string;
54
+ Source: string;
55
55
  }
56
56
  export declare class BillingAdjustment extends OdinRecord<BillingAdjustmentProperties> {
57
57
  entity: 'OrderModule:BillingAdjustment';
@@ -1,21 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_FILE_DELETED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_FILE_CREATED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_NOTE_DELETED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_NOTE_CREATED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_UPDATED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_CREATED = exports.BillingAdjustment = exports.BillingAdjustmentPropertyKeys = exports.BillingAdjustmentReason = exports.BillingAdjustmentProrationType = exports.BillingAdjustmentDiscountType = exports.BillingAdjustmentEntityTypes = void 0;
3
+ exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_FILE_DELETED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_FILE_CREATED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_NOTE_DELETED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_NOTE_CREATED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_UPDATED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_CREATED = exports.BillingAdjustment = exports.BillingAdjustmentPropertyKeys = exports.BillingAdjustmentProrationType = exports.BillingAdjustmentDiscountType = exports.BillingAdjustmentReason = exports.BillingAdjustmentEntityTypes = void 0;
4
4
  const core_1 = require("@d19n/odin-types/dist/core");
5
5
  var BillingAdjustmentEntityTypes;
6
6
  (function (BillingAdjustmentEntityTypes) {
7
7
  BillingAdjustmentEntityTypes["DEFAULT"] = "DEFAULT";
8
8
  })(BillingAdjustmentEntityTypes = exports.BillingAdjustmentEntityTypes || (exports.BillingAdjustmentEntityTypes = {}));
9
- var BillingAdjustmentDiscountType;
10
- (function (BillingAdjustmentDiscountType) {
11
- BillingAdjustmentDiscountType["AMOUNT"] = "AMOUNT";
12
- BillingAdjustmentDiscountType["PERCENT"] = "PERCENT";
13
- })(BillingAdjustmentDiscountType = exports.BillingAdjustmentDiscountType || (exports.BillingAdjustmentDiscountType = {}));
14
- var BillingAdjustmentProrationType;
15
- (function (BillingAdjustmentProrationType) {
16
- BillingAdjustmentProrationType["CHARGE"] = "CHARGE";
17
- BillingAdjustmentProrationType["CREDIT"] = "CREDIT";
18
- })(BillingAdjustmentProrationType = exports.BillingAdjustmentProrationType || (exports.BillingAdjustmentProrationType = {}));
19
9
  var BillingAdjustmentReason;
20
10
  (function (BillingAdjustmentReason) {
21
11
  BillingAdjustmentReason["BILLING_DAY_ADJUSMENT_LEGACY"] = "BILLING_DAY_ADJUSTMENT";
@@ -32,18 +22,28 @@ var BillingAdjustmentReason;
32
22
  BillingAdjustmentReason["SALES_MISSELLING_ADJUSTMENT"] = "SALES_MISSELLING_ADJUSTMENT";
33
23
  BillingAdjustmentReason["OUTAGE_COMPENSATION"] = "OUTAGE_COMPENSATION";
34
24
  })(BillingAdjustmentReason = exports.BillingAdjustmentReason || (exports.BillingAdjustmentReason = {}));
25
+ var BillingAdjustmentDiscountType;
26
+ (function (BillingAdjustmentDiscountType) {
27
+ BillingAdjustmentDiscountType["AMOUNT"] = "AMOUNT";
28
+ BillingAdjustmentDiscountType["PERCENT"] = "PERCENT";
29
+ })(BillingAdjustmentDiscountType = exports.BillingAdjustmentDiscountType || (exports.BillingAdjustmentDiscountType = {}));
30
+ var BillingAdjustmentProrationType;
31
+ (function (BillingAdjustmentProrationType) {
32
+ BillingAdjustmentProrationType["CHARGE"] = "CHARGE";
33
+ BillingAdjustmentProrationType["CREDIT"] = "CREDIT";
34
+ })(BillingAdjustmentProrationType = exports.BillingAdjustmentProrationType || (exports.BillingAdjustmentProrationType = {}));
35
35
  var BillingAdjustmentPropertyKeys;
36
36
  (function (BillingAdjustmentPropertyKeys) {
37
- BillingAdjustmentPropertyKeys["Description"] = "Description";
37
+ BillingAdjustmentPropertyKeys["FreePeriodLength"] = "FreePeriodLength";
38
+ BillingAdjustmentPropertyKeys["Reason"] = "Reason";
38
39
  BillingAdjustmentPropertyKeys["DiscountLength"] = "DiscountLength";
39
40
  BillingAdjustmentPropertyKeys["DiscountType"] = "DiscountType";
40
41
  BillingAdjustmentPropertyKeys["DiscountValue"] = "DiscountValue";
41
- BillingAdjustmentPropertyKeys["FreePeriodLength"] = "FreePeriodLength";
42
- BillingAdjustmentPropertyKeys["ProrationBillableDays"] = "ProrationBillableDays";
43
42
  BillingAdjustmentPropertyKeys["ProrationType"] = "ProrationType";
44
- BillingAdjustmentPropertyKeys["Reason"] = "Reason";
45
- BillingAdjustmentPropertyKeys["Source"] = "Source";
43
+ BillingAdjustmentPropertyKeys["ProrationBillableDays"] = "ProrationBillableDays";
46
44
  BillingAdjustmentPropertyKeys["Title"] = "Title";
45
+ BillingAdjustmentPropertyKeys["Description"] = "Description";
46
+ BillingAdjustmentPropertyKeys["Source"] = "Source";
47
47
  })(BillingAdjustmentPropertyKeys = exports.BillingAdjustmentPropertyKeys || (exports.BillingAdjustmentPropertyKeys = {}));
48
48
  class BillingAdjustment extends core_1.OdinRecord {
49
49
  }
@@ -28,20 +28,20 @@ export declare enum CreditNoteReason {
28
28
  ONE_TIME_CREDIT = "ONE_TIME_CREDIT"
29
29
  }
30
30
  export declare enum CreditNotePropertyKeys {
31
- Amount = "Amount",
32
31
  Description = "Description",
32
+ Amount = "Amount",
33
+ Status = "Status",
33
34
  InvoiceRef = "InvoiceRef",
34
- Reason = "Reason",
35
35
  ReasonCode = "ReasonCode",
36
- Status = "Status"
36
+ Reason = "Reason"
37
37
  }
38
38
  export interface CreditNoteProperties {
39
- Amount: number;
40
39
  Description: string;
40
+ Amount: number;
41
+ Status: string;
41
42
  InvoiceRef: string;
42
- Reason: CreditNoteReason;
43
43
  ReasonCode: string;
44
- Status: string;
44
+ Reason: CreditNoteReason;
45
45
  }
46
46
  export declare class CreditNote extends OdinRecord<CreditNoteProperties> {
47
47
  entity: 'BillingModule:CreditNote';
@@ -30,12 +30,12 @@ var CreditNoteReason;
30
30
  })(CreditNoteReason = exports.CreditNoteReason || (exports.CreditNoteReason = {}));
31
31
  var CreditNotePropertyKeys;
32
32
  (function (CreditNotePropertyKeys) {
33
- CreditNotePropertyKeys["Amount"] = "Amount";
34
33
  CreditNotePropertyKeys["Description"] = "Description";
34
+ CreditNotePropertyKeys["Amount"] = "Amount";
35
+ CreditNotePropertyKeys["Status"] = "Status";
35
36
  CreditNotePropertyKeys["InvoiceRef"] = "InvoiceRef";
36
- CreditNotePropertyKeys["Reason"] = "Reason";
37
37
  CreditNotePropertyKeys["ReasonCode"] = "ReasonCode";
38
- CreditNotePropertyKeys["Status"] = "Status";
38
+ CreditNotePropertyKeys["Reason"] = "Reason";
39
39
  })(CreditNotePropertyKeys = exports.CreditNotePropertyKeys || (exports.CreditNotePropertyKeys = {}));
40
40
  class CreditNote extends core_1.OdinRecord {
41
41
  }
@@ -8,8 +8,38 @@ import { AppointmentProperties } from './Appointment';
8
8
  export declare enum VisitEntityTypes {
9
9
  DEFAULT = "DEFAULT"
10
10
  }
11
+ export declare enum VisitOutcome {
12
+ NI_NO_REASON = "NI_NO_REASON",
13
+ KNOCKED_NO_ANSWER = "KNOCKED_NO_ANSWER",
14
+ NOT_INTERESTED = "NOT_INTERESTED",
15
+ COMMUNICATION_CHALLENGE = "COMMUNICATION_CHALLENGE",
16
+ CALL_COME_BACK_LATER = "COME_BACK_LATER",
17
+ LANDLORD_DECISION_REQUIRED = "LANDLORD_DECISSION_REQUIRED",
18
+ NI_ALREADY_HAVE_FF = "NI_ALREADY_HAVE_FF",
19
+ NI_HAPPY_WITH_PROVIDER = "NI_HAPPY_WITH_PROVIDER",
20
+ NI_NO_BUNDLE_OPTION = "NI_NO_BUNDLE_OPTION",
21
+ DO_NOT_KNOCK = "DO_NOT_KNOCK",
22
+ NI_MOVING_HOME_NON_YF_AREA = "NI_MOVING_HOME",
23
+ NI_OLDER_DEMOGRAPHIC = "NI_OLDER_DEMOGRAPHIC",
24
+ NI_TOO_EXPENSIVE = "NI_TOO_EXPENSIVE",
25
+ NO_ACCESS_TO_PROPERTY = "NO_ACCESS_TO_PROPERTY",
26
+ NO_COLD_CALL_STICKER = "NO_COLD_CALL_STICKER",
27
+ VULNERABLE_PERSON = "VULNERABLE_PERSON"
28
+ }
29
+ export declare enum VisitNotInterestedReason {
30
+ MOVING_HOUSE_NON_YF_AREA = "MOVING_HOUSE",
31
+ NO_BUNDLE_TV_SPORTS_ETC = "NO_BUNDLE",
32
+ OLDER_DEMOGRAPHIC = "OLDER_DEMOGRAPHIC",
33
+ HAPPY_WITH_CURRENT_PROVIDER = "HAPPY_WITH_CURRENT_PROVIDER",
34
+ NO_REASON_GIVEN = "NO_REASON_GIVEN",
35
+ TOO_EXPENSIVE = "TOO_EXPENSIVE"
36
+ }
11
37
  export declare enum VisitAgeBracket {
12
38
  }
39
+ export declare enum VisitStatus {
40
+ TODO = "TODO",
41
+ DONE = "DONE"
42
+ }
13
43
  export declare enum VisitCurrentProvider {
14
44
  BT = "BT",
15
45
  CUCKOO = "CUCKOO",
@@ -34,79 +64,49 @@ export declare enum VisitInterestedReason {
34
64
  NEEDS_TO_CHECK_CONTRACT = "NEEDS_TO_CHECK_CONTRACT",
35
65
  PITCHED_MISSED = "PITCHED_MISSED"
36
66
  }
37
- export declare enum VisitNotInterestedReason {
38
- MOVING_HOUSE_NON_YF_AREA = "MOVING_HOUSE",
39
- NO_BUNDLE_TV_SPORTS_ETC = "NO_BUNDLE",
40
- OLDER_DEMOGRAPHIC = "OLDER_DEMOGRAPHIC",
41
- HAPPY_WITH_CURRENT_PROVIDER = "HAPPY_WITH_CURRENT_PROVIDER",
42
- NO_REASON_GIVEN = "NO_REASON_GIVEN",
43
- TOO_EXPENSIVE = "TOO_EXPENSIVE"
44
- }
45
- export declare enum VisitOutcome {
46
- NI_NO_REASON = "NI_NO_REASON",
47
- KNOCKED_NO_ANSWER = "KNOCKED_NO_ANSWER",
48
- NOT_INTERESTED = "NOT_INTERESTED",
49
- COMMUNICATION_CHALLENGE = "COMMUNICATION_CHALLENGE",
50
- CALL_COME_BACK_LATER = "COME_BACK_LATER",
51
- LANDLORD_DECISION_REQUIRED = "LANDLORD_DECISSION_REQUIRED",
52
- NI_ALREADY_HAVE_FF = "NI_ALREADY_HAVE_FF",
53
- NI_HAPPY_WITH_PROVIDER = "NI_HAPPY_WITH_PROVIDER",
54
- NI_NO_BUNDLE_OPTION = "NI_NO_BUNDLE_OPTION",
55
- DO_NOT_KNOCK = "DO_NOT_KNOCK",
56
- NI_MOVING_HOME_NON_YF_AREA = "NI_MOVING_HOME",
57
- NI_OLDER_DEMOGRAPHIC = "NI_OLDER_DEMOGRAPHIC",
58
- NI_TOO_EXPENSIVE = "NI_TOO_EXPENSIVE",
59
- NO_ACCESS_TO_PROPERTY = "NO_ACCESS_TO_PROPERTY",
60
- NO_COLD_CALL_STICKER = "NO_COLD_CALL_STICKER",
61
- VULNERABLE_PERSON = "VULNERABLE_PERSON"
62
- }
63
- export declare enum VisitStatus {
64
- TODO = "TODO",
65
- DONE = "DONE"
66
- }
67
67
  export declare enum VisitPropertyKeys {
68
+ FollowUpDate = "FollowUpDate",
69
+ Umprn = "UMPRN",
70
+ Udprn = "UDPRN",
71
+ Outcome = "Outcome",
72
+ NotInterestedReason = "NotInterestedReason",
73
+ L2PolygonId = "L2PolygonId",
68
74
  AgeBracket = "AgeBracket",
69
- Comments = "Comments",
70
- ContractEndDate = "ContractEndDate",
75
+ FullAddress = "FullAddress",
71
76
  Coordinates = "Coordinates",
72
- CurrentPrice = "CurrentPrice",
73
- CurrentProvider = "CurrentProvider",
77
+ Status = "Status",
74
78
  DataSetId = "DataSetId",
75
- DoNotKnockReason = "DoNotKnockReason",
79
+ Longitude = "Longitude",
80
+ Latitude = "Latitude",
81
+ CurrentProvider = "CurrentProvider",
82
+ ContractEndDate = "ContractEndDate",
83
+ CurrentPrice = "CurrentPrice",
76
84
  DownloadSpeed = "DownloadSpeed",
77
- FollowUpDate = "FollowUpDate",
78
- FullAddress = "FullAddress",
85
+ DoNotKnockReason = "DoNotKnockReason",
79
86
  InterestedReason = "InterestedReason",
80
- L2PolygonId = "L2PolygonId",
81
- Latitude = "Latitude",
82
- Longitude = "Longitude",
83
- NotInterestedReason = "NotInterestedReason",
84
- Outcome = "Outcome",
85
- Status = "Status",
86
- Udprn = "UDPRN",
87
- Umprn = "UMPRN"
87
+ Comments = "Comments"
88
88
  }
89
89
  export interface VisitProperties {
90
+ FollowUpDate: Date;
91
+ Umprn: number;
92
+ Udprn: number;
93
+ Outcome: VisitOutcome;
94
+ NotInterestedReason: VisitNotInterestedReason;
95
+ L2PolygonId: number;
90
96
  AgeBracket: VisitAgeBracket;
91
- Comments: string;
92
- ContractEndDate: Date;
97
+ FullAddress: string;
93
98
  Coordinates: string;
94
- CurrentPrice: number;
95
- CurrentProvider: VisitCurrentProvider;
99
+ Status: VisitStatus;
96
100
  DataSetId: string;
97
- DoNotKnockReason: VisitDoNotKnockReason;
101
+ Longitude: string;
102
+ Latitude: string;
103
+ CurrentProvider: VisitCurrentProvider;
104
+ ContractEndDate: Date;
105
+ CurrentPrice: number;
98
106
  DownloadSpeed: string;
99
- FollowUpDate: Date;
100
- FullAddress: string;
107
+ DoNotKnockReason: VisitDoNotKnockReason;
101
108
  InterestedReason: VisitInterestedReason;
102
- L2PolygonId: number;
103
- Latitude: string;
104
- Longitude: string;
105
- NotInterestedReason: VisitNotInterestedReason;
106
- Outcome: VisitOutcome;
107
- Status: VisitStatus;
108
- Udprn: number;
109
- Umprn: number;
109
+ Comments: string;
110
110
  }
111
111
  export declare class Visit extends OdinRecord<VisitProperties> {
112
112
  entity: 'CrmModule:Visit';
@@ -1,14 +1,47 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ROUTING_KEY_LINK_VISIT_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_VISIT_APPOINTMENT_CREATED = exports.ROUTING_KEY_LINK_VISIT_FILE_DELETED = exports.ROUTING_KEY_LINK_VISIT_FILE_CREATED = exports.ROUTING_KEY_LINK_VISIT_NOTE_DELETED = exports.ROUTING_KEY_LINK_VISIT_NOTE_CREATED = exports.ROUTING_KEY_VISIT_DELETED = exports.ROUTING_KEY_VISIT_UPDATED = exports.ROUTING_KEY_VISIT_CREATED = exports.Visit = exports.VisitPropertyKeys = exports.VisitStatus = exports.VisitOutcome = exports.VisitNotInterestedReason = exports.VisitInterestedReason = exports.VisitDoNotKnockReason = exports.VisitCurrentProvider = exports.VisitAgeBracket = exports.VisitEntityTypes = void 0;
3
+ exports.ROUTING_KEY_LINK_VISIT_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_VISIT_APPOINTMENT_CREATED = exports.ROUTING_KEY_LINK_VISIT_FILE_DELETED = exports.ROUTING_KEY_LINK_VISIT_FILE_CREATED = exports.ROUTING_KEY_LINK_VISIT_NOTE_DELETED = exports.ROUTING_KEY_LINK_VISIT_NOTE_CREATED = exports.ROUTING_KEY_VISIT_DELETED = exports.ROUTING_KEY_VISIT_UPDATED = exports.ROUTING_KEY_VISIT_CREATED = exports.Visit = exports.VisitPropertyKeys = exports.VisitInterestedReason = exports.VisitDoNotKnockReason = exports.VisitCurrentProvider = exports.VisitStatus = exports.VisitAgeBracket = exports.VisitNotInterestedReason = exports.VisitOutcome = exports.VisitEntityTypes = void 0;
4
4
  const core_1 = require("@d19n/odin-types/dist/core");
5
5
  var VisitEntityTypes;
6
6
  (function (VisitEntityTypes) {
7
7
  VisitEntityTypes["DEFAULT"] = "DEFAULT";
8
8
  })(VisitEntityTypes = exports.VisitEntityTypes || (exports.VisitEntityTypes = {}));
9
+ var VisitOutcome;
10
+ (function (VisitOutcome) {
11
+ VisitOutcome["NI_NO_REASON"] = "NI_NO_REASON";
12
+ VisitOutcome["KNOCKED_NO_ANSWER"] = "KNOCKED_NO_ANSWER";
13
+ VisitOutcome["NOT_INTERESTED"] = "NOT_INTERESTED";
14
+ VisitOutcome["COMMUNICATION_CHALLENGE"] = "COMMUNICATION_CHALLENGE";
15
+ VisitOutcome["CALL_COME_BACK_LATER"] = "COME_BACK_LATER";
16
+ VisitOutcome["LANDLORD_DECISION_REQUIRED"] = "LANDLORD_DECISSION_REQUIRED";
17
+ VisitOutcome["NI_ALREADY_HAVE_FF"] = "NI_ALREADY_HAVE_FF";
18
+ VisitOutcome["NI_HAPPY_WITH_PROVIDER"] = "NI_HAPPY_WITH_PROVIDER";
19
+ VisitOutcome["NI_NO_BUNDLE_OPTION"] = "NI_NO_BUNDLE_OPTION";
20
+ VisitOutcome["DO_NOT_KNOCK"] = "DO_NOT_KNOCK";
21
+ VisitOutcome["NI_MOVING_HOME_NON_YF_AREA"] = "NI_MOVING_HOME";
22
+ VisitOutcome["NI_OLDER_DEMOGRAPHIC"] = "NI_OLDER_DEMOGRAPHIC";
23
+ VisitOutcome["NI_TOO_EXPENSIVE"] = "NI_TOO_EXPENSIVE";
24
+ VisitOutcome["NO_ACCESS_TO_PROPERTY"] = "NO_ACCESS_TO_PROPERTY";
25
+ VisitOutcome["NO_COLD_CALL_STICKER"] = "NO_COLD_CALL_STICKER";
26
+ VisitOutcome["VULNERABLE_PERSON"] = "VULNERABLE_PERSON";
27
+ })(VisitOutcome = exports.VisitOutcome || (exports.VisitOutcome = {}));
28
+ var VisitNotInterestedReason;
29
+ (function (VisitNotInterestedReason) {
30
+ VisitNotInterestedReason["MOVING_HOUSE_NON_YF_AREA"] = "MOVING_HOUSE";
31
+ VisitNotInterestedReason["NO_BUNDLE_TV_SPORTS_ETC"] = "NO_BUNDLE";
32
+ VisitNotInterestedReason["OLDER_DEMOGRAPHIC"] = "OLDER_DEMOGRAPHIC";
33
+ VisitNotInterestedReason["HAPPY_WITH_CURRENT_PROVIDER"] = "HAPPY_WITH_CURRENT_PROVIDER";
34
+ VisitNotInterestedReason["NO_REASON_GIVEN"] = "NO_REASON_GIVEN";
35
+ VisitNotInterestedReason["TOO_EXPENSIVE"] = "TOO_EXPENSIVE";
36
+ })(VisitNotInterestedReason = exports.VisitNotInterestedReason || (exports.VisitNotInterestedReason = {}));
9
37
  var VisitAgeBracket;
10
38
  (function (VisitAgeBracket) {
11
39
  })(VisitAgeBracket = exports.VisitAgeBracket || (exports.VisitAgeBracket = {}));
40
+ var VisitStatus;
41
+ (function (VisitStatus) {
42
+ VisitStatus["TODO"] = "TODO";
43
+ VisitStatus["DONE"] = "DONE";
44
+ })(VisitStatus = exports.VisitStatus || (exports.VisitStatus = {}));
12
45
  var VisitCurrentProvider;
13
46
  (function (VisitCurrentProvider) {
14
47
  VisitCurrentProvider["BT"] = "BT";
@@ -36,61 +69,28 @@ var VisitInterestedReason;
36
69
  VisitInterestedReason["NEEDS_TO_CHECK_CONTRACT"] = "NEEDS_TO_CHECK_CONTRACT";
37
70
  VisitInterestedReason["PITCHED_MISSED"] = "PITCHED_MISSED";
38
71
  })(VisitInterestedReason = exports.VisitInterestedReason || (exports.VisitInterestedReason = {}));
39
- var VisitNotInterestedReason;
40
- (function (VisitNotInterestedReason) {
41
- VisitNotInterestedReason["MOVING_HOUSE_NON_YF_AREA"] = "MOVING_HOUSE";
42
- VisitNotInterestedReason["NO_BUNDLE_TV_SPORTS_ETC"] = "NO_BUNDLE";
43
- VisitNotInterestedReason["OLDER_DEMOGRAPHIC"] = "OLDER_DEMOGRAPHIC";
44
- VisitNotInterestedReason["HAPPY_WITH_CURRENT_PROVIDER"] = "HAPPY_WITH_CURRENT_PROVIDER";
45
- VisitNotInterestedReason["NO_REASON_GIVEN"] = "NO_REASON_GIVEN";
46
- VisitNotInterestedReason["TOO_EXPENSIVE"] = "TOO_EXPENSIVE";
47
- })(VisitNotInterestedReason = exports.VisitNotInterestedReason || (exports.VisitNotInterestedReason = {}));
48
- var VisitOutcome;
49
- (function (VisitOutcome) {
50
- VisitOutcome["NI_NO_REASON"] = "NI_NO_REASON";
51
- VisitOutcome["KNOCKED_NO_ANSWER"] = "KNOCKED_NO_ANSWER";
52
- VisitOutcome["NOT_INTERESTED"] = "NOT_INTERESTED";
53
- VisitOutcome["COMMUNICATION_CHALLENGE"] = "COMMUNICATION_CHALLENGE";
54
- VisitOutcome["CALL_COME_BACK_LATER"] = "COME_BACK_LATER";
55
- VisitOutcome["LANDLORD_DECISION_REQUIRED"] = "LANDLORD_DECISSION_REQUIRED";
56
- VisitOutcome["NI_ALREADY_HAVE_FF"] = "NI_ALREADY_HAVE_FF";
57
- VisitOutcome["NI_HAPPY_WITH_PROVIDER"] = "NI_HAPPY_WITH_PROVIDER";
58
- VisitOutcome["NI_NO_BUNDLE_OPTION"] = "NI_NO_BUNDLE_OPTION";
59
- VisitOutcome["DO_NOT_KNOCK"] = "DO_NOT_KNOCK";
60
- VisitOutcome["NI_MOVING_HOME_NON_YF_AREA"] = "NI_MOVING_HOME";
61
- VisitOutcome["NI_OLDER_DEMOGRAPHIC"] = "NI_OLDER_DEMOGRAPHIC";
62
- VisitOutcome["NI_TOO_EXPENSIVE"] = "NI_TOO_EXPENSIVE";
63
- VisitOutcome["NO_ACCESS_TO_PROPERTY"] = "NO_ACCESS_TO_PROPERTY";
64
- VisitOutcome["NO_COLD_CALL_STICKER"] = "NO_COLD_CALL_STICKER";
65
- VisitOutcome["VULNERABLE_PERSON"] = "VULNERABLE_PERSON";
66
- })(VisitOutcome = exports.VisitOutcome || (exports.VisitOutcome = {}));
67
- var VisitStatus;
68
- (function (VisitStatus) {
69
- VisitStatus["TODO"] = "TODO";
70
- VisitStatus["DONE"] = "DONE";
71
- })(VisitStatus = exports.VisitStatus || (exports.VisitStatus = {}));
72
72
  var VisitPropertyKeys;
73
73
  (function (VisitPropertyKeys) {
74
+ VisitPropertyKeys["FollowUpDate"] = "FollowUpDate";
75
+ VisitPropertyKeys["Umprn"] = "UMPRN";
76
+ VisitPropertyKeys["Udprn"] = "UDPRN";
77
+ VisitPropertyKeys["Outcome"] = "Outcome";
78
+ VisitPropertyKeys["NotInterestedReason"] = "NotInterestedReason";
79
+ VisitPropertyKeys["L2PolygonId"] = "L2PolygonId";
74
80
  VisitPropertyKeys["AgeBracket"] = "AgeBracket";
75
- VisitPropertyKeys["Comments"] = "Comments";
76
- VisitPropertyKeys["ContractEndDate"] = "ContractEndDate";
81
+ VisitPropertyKeys["FullAddress"] = "FullAddress";
77
82
  VisitPropertyKeys["Coordinates"] = "Coordinates";
78
- VisitPropertyKeys["CurrentPrice"] = "CurrentPrice";
79
- VisitPropertyKeys["CurrentProvider"] = "CurrentProvider";
83
+ VisitPropertyKeys["Status"] = "Status";
80
84
  VisitPropertyKeys["DataSetId"] = "DataSetId";
81
- VisitPropertyKeys["DoNotKnockReason"] = "DoNotKnockReason";
85
+ VisitPropertyKeys["Longitude"] = "Longitude";
86
+ VisitPropertyKeys["Latitude"] = "Latitude";
87
+ VisitPropertyKeys["CurrentProvider"] = "CurrentProvider";
88
+ VisitPropertyKeys["ContractEndDate"] = "ContractEndDate";
89
+ VisitPropertyKeys["CurrentPrice"] = "CurrentPrice";
82
90
  VisitPropertyKeys["DownloadSpeed"] = "DownloadSpeed";
83
- VisitPropertyKeys["FollowUpDate"] = "FollowUpDate";
84
- VisitPropertyKeys["FullAddress"] = "FullAddress";
91
+ VisitPropertyKeys["DoNotKnockReason"] = "DoNotKnockReason";
85
92
  VisitPropertyKeys["InterestedReason"] = "InterestedReason";
86
- VisitPropertyKeys["L2PolygonId"] = "L2PolygonId";
87
- VisitPropertyKeys["Latitude"] = "Latitude";
88
- VisitPropertyKeys["Longitude"] = "Longitude";
89
- VisitPropertyKeys["NotInterestedReason"] = "NotInterestedReason";
90
- VisitPropertyKeys["Outcome"] = "Outcome";
91
- VisitPropertyKeys["Status"] = "Status";
92
- VisitPropertyKeys["Udprn"] = "UDPRN";
93
- VisitPropertyKeys["Umprn"] = "UMPRN";
93
+ VisitPropertyKeys["Comments"] = "Comments";
94
94
  })(VisitPropertyKeys = exports.VisitPropertyKeys || (exports.VisitPropertyKeys = {}));
95
95
  class Visit extends core_1.OdinRecord {
96
96
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "1.0.190",
3
+ "version": "1.0.191",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",
@@ -25,30 +25,38 @@ OdinRecordLinkCreatedEvent
25
25
  } from '@d19n/odin-types/dist/core';
26
26
  // ODIN ACTION
27
27
  // An Action is a single transaction that changes the properties of one or more objects.
28
- interface ConfirmPaymentSuccessProperties {
28
+ //================================================
29
+
30
+ type StepClassMap = {
29
31
  }
30
- export class ConfirmPaymentSuccessDto extends OdinRecordUpdateDto<ConfirmPaymentSuccessProperties> {
31
- public readonly actionName: string = 'ConfirmPaymentSuccess';
32
+
33
+
34
+
35
+ export interface ConfirmPaymentSuccessMessage extends OdinRecordUpdatedEvent<ConfirmPaymentSuccessDto, {}> {}
36
+
37
+
38
+ export class ConfirmPaymentSuccessDto extends OdinRecordUpdateDto<Record<string, any>> {
39
+ public readonly actionName: string = 'ConfirmPaymentSuccess'
32
40
  public readonly schemaActionId: string = 'eea6c593-3619-4c06-8ea7-997af2f3fba2';
41
+ public override readonly stageKey: string = 'PaymentStageProcessed'
33
42
  constructor(
34
43
  record: OdinRecord<any> | { id: string; entity: string; type?: string },
35
- properties: ConfirmPaymentSuccessProperties,
36
- options?: { journeyId?: string; stageKey?: string }
44
+ options?: { journeyId?: string }
37
45
  ) {
38
46
  super({
39
47
  id: record.id,
40
48
  entity: record.entity,
41
49
  type: record.type,
42
- properties,
50
+ properties: {},
43
51
  journeyId: options?.journeyId,
44
- stageKey: options?.stageKey,
45
52
  });
46
53
  }
47
- }
48
-
49
54
 
50
- export interface ConfirmPaymentSuccessMessage extends OdinRecordUpdatedEvent<ConfirmPaymentSuccessDto, ConfirmPaymentSuccessProperties> {}
51
-
55
+ public static readonly stepClasses = [] as const;
56
+
57
+ steps: [];
58
+
59
+ }
52
60
 
53
61
  export const ROUTING_KEY_CONFIRM_PAYMENT_SUCCESS = 'ConfirmPaymentSuccess';
54
62
 
@@ -25,30 +25,38 @@ OdinRecordLinkCreatedEvent
25
25
  } from '@d19n/odin-types/dist/core';
26
26
  // ODIN ACTION
27
27
  // An Action is a single transaction that changes the properties of one or more objects.
28
- interface FailPaymentProperties {
28
+ //================================================
29
+
30
+ type StepClassMap = {
29
31
  }
30
- export class FailPaymentDto extends OdinRecordUpdateDto<FailPaymentProperties> {
31
- public readonly actionName: string = 'FailPayment';
32
+
33
+
34
+
35
+ export interface FailPaymentMessage extends OdinRecordUpdatedEvent<FailPaymentDto, {}> {}
36
+
37
+
38
+ export class FailPaymentDto extends OdinRecordUpdateDto<Record<string, any>> {
39
+ public readonly actionName: string = 'FailPayment'
32
40
  public readonly schemaActionId: string = 'd9d6cf25-8cf9-4e6d-a7e2-44f88543d853';
41
+ public override readonly stageKey: string = 'PaymentStageError'
33
42
  constructor(
34
43
  record: OdinRecord<any> | { id: string; entity: string; type?: string },
35
- properties: FailPaymentProperties,
36
- options?: { journeyId?: string; stageKey?: string }
44
+ options?: { journeyId?: string }
37
45
  ) {
38
46
  super({
39
47
  id: record.id,
40
48
  entity: record.entity,
41
49
  type: record.type,
42
- properties,
50
+ properties: {},
43
51
  journeyId: options?.journeyId,
44
- stageKey: options?.stageKey,
45
52
  });
46
53
  }
47
- }
48
-
49
54
 
50
- export interface FailPaymentMessage extends OdinRecordUpdatedEvent<FailPaymentDto, FailPaymentProperties> {}
51
-
55
+ public static readonly stepClasses = [] as const;
56
+
57
+ steps: [];
58
+
59
+ }
52
60
 
53
61
  export const ROUTING_KEY_FAIL_PAYMENT = 'FailPayment';
54
62
 
@@ -25,30 +25,38 @@ OdinRecordLinkCreatedEvent
25
25
  } from '@d19n/odin-types/dist/core';
26
26
  // ODIN ACTION
27
27
  // An Action is a single transaction that changes the properties of one or more objects.
28
- interface VoidPaymentProperties {
28
+ //================================================
29
+
30
+ type StepClassMap = {
29
31
  }
30
- export class VoidPaymentDto extends OdinRecordUpdateDto<VoidPaymentProperties> {
31
- public readonly actionName: string = 'VoidPayment';
32
+
33
+
34
+
35
+ export interface VoidPaymentMessage extends OdinRecordUpdatedEvent<VoidPaymentDto, {}> {}
36
+
37
+
38
+ export class VoidPaymentDto extends OdinRecordUpdateDto<Record<string, any>> {
39
+ public readonly actionName: string = 'VoidPayment'
32
40
  public readonly schemaActionId: string = '77689b76-4a08-4fa3-abec-8594c19768fd';
41
+ public override readonly stageKey: string = 'PaymentStageVoided'
33
42
  constructor(
34
43
  record: OdinRecord<any> | { id: string; entity: string; type?: string },
35
- properties: VoidPaymentProperties,
36
- options?: { journeyId?: string; stageKey?: string }
44
+ options?: { journeyId?: string }
37
45
  ) {
38
46
  super({
39
47
  id: record.id,
40
48
  entity: record.entity,
41
49
  type: record.type,
42
- properties,
50
+ properties: {},
43
51
  journeyId: options?.journeyId,
44
- stageKey: options?.stageKey,
45
52
  });
46
53
  }
47
- }
48
-
49
54
 
50
- export interface VoidPaymentMessage extends OdinRecordUpdatedEvent<VoidPaymentDto, VoidPaymentProperties> {}
51
-
55
+ public static readonly stepClasses = [] as const;
56
+
57
+ steps: [];
58
+
59
+ }
52
60
 
53
61
  export const ROUTING_KEY_VOID_PAYMENT = 'VoidPayment';
54
62
 
@@ -20,14 +20,6 @@ export enum BillingAdjustmentEntityTypes {
20
20
  DEFAULT = 'DEFAULT',
21
21
  }
22
22
 
23
- export enum BillingAdjustmentDiscountType {
24
- AMOUNT = 'AMOUNT',
25
- PERCENT = 'PERCENT',
26
- }
27
- export enum BillingAdjustmentProrationType {
28
- CHARGE = 'CHARGE',
29
- CREDIT = 'CREDIT',
30
- }
31
23
  export enum BillingAdjustmentReason {
32
24
  BILLING_DAY_ADJUSMENT_LEGACY = 'BILLING_DAY_ADJUSTMENT',
33
25
  BILLING_DATE_CHANGE = 'BILLING_DATE_CHANGE',
@@ -43,43 +35,51 @@ export enum BillingAdjustmentReason {
43
35
  SALES_MISSELLING_ADJUSTMENT = 'SALES_MISSELLING_ADJUSTMENT',
44
36
  OUTAGE_COMPENSATION = 'OUTAGE_COMPENSATION',
45
37
  }
38
+ export enum BillingAdjustmentDiscountType {
39
+ AMOUNT = 'AMOUNT',
40
+ PERCENT = 'PERCENT',
41
+ }
42
+ export enum BillingAdjustmentProrationType {
43
+ CHARGE = 'CHARGE',
44
+ CREDIT = 'CREDIT',
45
+ }
46
46
 
47
47
 
48
48
  export enum BillingAdjustmentPropertyKeys {
49
- Description = 'Description',
49
+ FreePeriodLength = 'FreePeriodLength',
50
+ Reason = 'Reason',
50
51
  DiscountLength = 'DiscountLength',
51
52
  DiscountType = 'DiscountType',
52
53
  DiscountValue = 'DiscountValue',
53
- FreePeriodLength = 'FreePeriodLength',
54
- ProrationBillableDays = 'ProrationBillableDays',
55
54
  ProrationType = 'ProrationType',
56
- Reason = 'Reason',
57
- Source = 'Source',
55
+ ProrationBillableDays = 'ProrationBillableDays',
58
56
  Title = 'Title',
57
+ Description = 'Description',
58
+ Source = 'Source',
59
59
  }
60
60
 
61
61
 
62
62
  export interface BillingAdjustmentProperties {
63
- //Describe why this billing adjustment being applied
64
- Description: string
63
+ //The number of future invoices that should be free of charge
64
+ FreePeriodLength: number
65
+ //the billing adjustment reason
66
+ Reason: BillingAdjustmentReason
65
67
  //the length of the discount
66
68
  DiscountLength: number
67
69
  //the type of discount
68
70
  DiscountType: BillingAdjustmentDiscountType
69
71
  //the value of the discount to be applied
70
72
  DiscountValue: number
71
- //The number of future invoices that should be free of charge
72
- FreePeriodLength: number
73
- //The number of days being prorated
74
- ProrationBillableDays: number
75
73
  //proration type charge or credit
76
74
  ProrationType: BillingAdjustmentProrationType
77
- //the billing adjustment reason
78
- Reason: BillingAdjustmentReason
79
- //Source of payment date update
80
- Source: string
75
+ //The number of days being prorated
76
+ ProrationBillableDays: number
81
77
  //Billing Adjustment Title
82
78
  Title: string
79
+ //Describe why this billing adjustment being applied
80
+ Description: string
81
+ //Source of payment date update
82
+ Source: string
83
83
  }
84
84
 
85
85
 
@@ -44,28 +44,28 @@ export enum CreditNoteReason {
44
44
 
45
45
 
46
46
  export enum CreditNotePropertyKeys {
47
- Amount = 'Amount',
48
47
  Description = 'Description',
48
+ Amount = 'Amount',
49
+ Status = 'Status',
49
50
  InvoiceRef = 'InvoiceRef',
50
- Reason = 'Reason',
51
51
  ReasonCode = 'ReasonCode',
52
- Status = 'Status',
52
+ Reason = 'Reason',
53
53
  }
54
54
 
55
55
 
56
56
  export interface CreditNoteProperties {
57
- //amount of the credit note
58
- Amount: number
59
57
  //description of the credit note
60
58
  Description: string
59
+ //amount of the credit note
60
+ Amount: number
61
+ //credit note status
62
+ Status: string
61
63
  //the record # of the invoice
62
64
  InvoiceRef: string
63
- //credit note reason
64
- Reason: CreditNoteReason
65
65
  //reason code
66
66
  ReasonCode: string
67
- //credit note status
68
- Status: string
67
+ //credit note reason
68
+ Reason: CreditNoteReason
69
69
  }
70
70
 
71
71
 
@@ -22,8 +22,38 @@ export enum VisitEntityTypes {
22
22
  DEFAULT = 'DEFAULT',
23
23
  }
24
24
 
25
+ export enum VisitOutcome {
26
+ NI_NO_REASON = 'NI_NO_REASON',
27
+ KNOCKED_NO_ANSWER = 'KNOCKED_NO_ANSWER',
28
+ NOT_INTERESTED = 'NOT_INTERESTED',
29
+ COMMUNICATION_CHALLENGE = 'COMMUNICATION_CHALLENGE',
30
+ CALL_COME_BACK_LATER = 'COME_BACK_LATER',
31
+ LANDLORD_DECISION_REQUIRED = 'LANDLORD_DECISSION_REQUIRED',
32
+ NI_ALREADY_HAVE_FF = 'NI_ALREADY_HAVE_FF',
33
+ NI_HAPPY_WITH_PROVIDER = 'NI_HAPPY_WITH_PROVIDER',
34
+ NI_NO_BUNDLE_OPTION = 'NI_NO_BUNDLE_OPTION',
35
+ DO_NOT_KNOCK = 'DO_NOT_KNOCK',
36
+ NI_MOVING_HOME_NON_YF_AREA = 'NI_MOVING_HOME',
37
+ NI_OLDER_DEMOGRAPHIC = 'NI_OLDER_DEMOGRAPHIC',
38
+ NI_TOO_EXPENSIVE = 'NI_TOO_EXPENSIVE',
39
+ NO_ACCESS_TO_PROPERTY = 'NO_ACCESS_TO_PROPERTY',
40
+ NO_COLD_CALL_STICKER = 'NO_COLD_CALL_STICKER',
41
+ VULNERABLE_PERSON = 'VULNERABLE_PERSON',
42
+ }
43
+ export enum VisitNotInterestedReason {
44
+ MOVING_HOUSE_NON_YF_AREA = 'MOVING_HOUSE',
45
+ NO_BUNDLE_TV_SPORTS_ETC = 'NO_BUNDLE',
46
+ OLDER_DEMOGRAPHIC = 'OLDER_DEMOGRAPHIC',
47
+ HAPPY_WITH_CURRENT_PROVIDER = 'HAPPY_WITH_CURRENT_PROVIDER',
48
+ NO_REASON_GIVEN = 'NO_REASON_GIVEN',
49
+ TOO_EXPENSIVE = 'TOO_EXPENSIVE',
50
+ }
25
51
  export enum VisitAgeBracket {
26
52
  }
53
+ export enum VisitStatus {
54
+ TODO = 'TODO',
55
+ DONE = 'DONE',
56
+ }
27
57
  export enum VisitCurrentProvider {
28
58
  BT = 'BT',
29
59
  CUCKOO = 'CUCKOO',
@@ -48,103 +78,73 @@ export enum VisitInterestedReason {
48
78
  NEEDS_TO_CHECK_CONTRACT = 'NEEDS_TO_CHECK_CONTRACT',
49
79
  PITCHED_MISSED = 'PITCHED_MISSED',
50
80
  }
51
- export enum VisitNotInterestedReason {
52
- MOVING_HOUSE_NON_YF_AREA = 'MOVING_HOUSE',
53
- NO_BUNDLE_TV_SPORTS_ETC = 'NO_BUNDLE',
54
- OLDER_DEMOGRAPHIC = 'OLDER_DEMOGRAPHIC',
55
- HAPPY_WITH_CURRENT_PROVIDER = 'HAPPY_WITH_CURRENT_PROVIDER',
56
- NO_REASON_GIVEN = 'NO_REASON_GIVEN',
57
- TOO_EXPENSIVE = 'TOO_EXPENSIVE',
58
- }
59
- export enum VisitOutcome {
60
- NI_NO_REASON = 'NI_NO_REASON',
61
- KNOCKED_NO_ANSWER = 'KNOCKED_NO_ANSWER',
62
- NOT_INTERESTED = 'NOT_INTERESTED',
63
- COMMUNICATION_CHALLENGE = 'COMMUNICATION_CHALLENGE',
64
- CALL_COME_BACK_LATER = 'COME_BACK_LATER',
65
- LANDLORD_DECISION_REQUIRED = 'LANDLORD_DECISSION_REQUIRED',
66
- NI_ALREADY_HAVE_FF = 'NI_ALREADY_HAVE_FF',
67
- NI_HAPPY_WITH_PROVIDER = 'NI_HAPPY_WITH_PROVIDER',
68
- NI_NO_BUNDLE_OPTION = 'NI_NO_BUNDLE_OPTION',
69
- DO_NOT_KNOCK = 'DO_NOT_KNOCK',
70
- NI_MOVING_HOME_NON_YF_AREA = 'NI_MOVING_HOME',
71
- NI_OLDER_DEMOGRAPHIC = 'NI_OLDER_DEMOGRAPHIC',
72
- NI_TOO_EXPENSIVE = 'NI_TOO_EXPENSIVE',
73
- NO_ACCESS_TO_PROPERTY = 'NO_ACCESS_TO_PROPERTY',
74
- NO_COLD_CALL_STICKER = 'NO_COLD_CALL_STICKER',
75
- VULNERABLE_PERSON = 'VULNERABLE_PERSON',
76
- }
77
- export enum VisitStatus {
78
- TODO = 'TODO',
79
- DONE = 'DONE',
80
- }
81
81
 
82
82
 
83
83
  export enum VisitPropertyKeys {
84
+ FollowUpDate = 'FollowUpDate',
85
+ Umprn = 'UMPRN',
86
+ Udprn = 'UDPRN',
87
+ Outcome = 'Outcome',
88
+ NotInterestedReason = 'NotInterestedReason',
89
+ L2PolygonId = 'L2PolygonId',
84
90
  AgeBracket = 'AgeBracket',
85
- Comments = 'Comments',
86
- ContractEndDate = 'ContractEndDate',
91
+ FullAddress = 'FullAddress',
87
92
  Coordinates = 'Coordinates',
88
- CurrentPrice = 'CurrentPrice',
89
- CurrentProvider = 'CurrentProvider',
93
+ Status = 'Status',
90
94
  DataSetId = 'DataSetId',
91
- DoNotKnockReason = 'DoNotKnockReason',
95
+ Longitude = 'Longitude',
96
+ Latitude = 'Latitude',
97
+ CurrentProvider = 'CurrentProvider',
98
+ ContractEndDate = 'ContractEndDate',
99
+ CurrentPrice = 'CurrentPrice',
92
100
  DownloadSpeed = 'DownloadSpeed',
93
- FollowUpDate = 'FollowUpDate',
94
- FullAddress = 'FullAddress',
101
+ DoNotKnockReason = 'DoNotKnockReason',
95
102
  InterestedReason = 'InterestedReason',
96
- L2PolygonId = 'L2PolygonId',
97
- Latitude = 'Latitude',
98
- Longitude = 'Longitude',
99
- NotInterestedReason = 'NotInterestedReason',
100
- Outcome = 'Outcome',
101
- Status = 'Status',
102
- Udprn = 'UDPRN',
103
- Umprn = 'UMPRN',
103
+ Comments = 'Comments',
104
104
  }
105
105
 
106
106
 
107
107
  export interface VisitProperties {
108
+ //date to follow up with the address
109
+ FollowUpDate: Date
110
+ //unique multiple point reference number
111
+ Umprn: number
112
+ //Unique delivery point reference number
113
+ Udprn: number
114
+ //outcome of the visit
115
+ Outcome: VisitOutcome
116
+ //outcome not_interested additional information
117
+ NotInterestedReason: VisitNotInterestedReason
118
+ //the id of the l2 polygon
119
+ L2PolygonId: number
108
120
  //the age bracket of the person
109
121
  AgeBracket: VisitAgeBracket
110
- //Leave comments about the visit
111
- Comments: string
112
- //Contract end date
113
- ContractEndDate: Date
122
+ //the full address of the visit
123
+ FullAddress: string
114
124
  //longitude and latitude coordinates
115
125
  Coordinates: string
116
- //Current Price
117
- CurrentPrice: number
118
- //Current provider
119
- CurrentProvider: VisitCurrentProvider
126
+ //status
127
+ Status: VisitStatus
120
128
  //DataSetId
121
129
  DataSetId: string
122
- //DoNotKnockReason
123
- DoNotKnockReason: VisitDoNotKnockReason
130
+ //longitude
131
+ Longitude: string
132
+ //latitude
133
+ Latitude: string
134
+ //Current provider
135
+ CurrentProvider: VisitCurrentProvider
136
+ //Contract end date
137
+ ContractEndDate: Date
138
+ //Current Price
139
+ CurrentPrice: number
124
140
  //Download Speed
125
141
  DownloadSpeed: string
126
- //date to follow up with the address
127
- FollowUpDate: Date
128
- //the full address of the visit
129
- FullAddress: string
142
+ //DoNotKnockReason
143
+ DoNotKnockReason: VisitDoNotKnockReason
130
144
  //outcome Interested closer description
131
145
  InterestedReason: VisitInterestedReason
132
- //the id of the l2 polygon
133
- L2PolygonId: number
134
- //latitude
135
- Latitude: string
136
- //longitude
137
- Longitude: string
138
- //outcome not_interested additional information
139
- NotInterestedReason: VisitNotInterestedReason
140
- //outcome of the visit
141
- Outcome: VisitOutcome
142
- //status
143
- Status: VisitStatus
144
- //Unique delivery point reference number
145
- Udprn: number
146
- //unique multiple point reference number
147
- Umprn: number
146
+ //Leave comments about the visit
147
+ Comments: string
148
148
  }
149
149
 
150
150