@d19n/youfibre-odin-sdk 1.0.322 → 1.0.323
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/entities-v2/Config.d.ts +8 -8
- package/dist/entities-v2/Config.js +4 -4
- package/dist/records-v2/AccountRecord.d.ts +2 -306
- package/dist/records-v2/AccountRecord.js +0 -451
- package/dist/records-v2/ActivityLogRecord.d.ts +1 -122
- package/dist/records-v2/ActivityLogRecord.js +0 -190
- package/dist/records-v2/ActivityRecord.d.ts +2 -255
- package/dist/records-v2/ActivityRecord.js +0 -387
- package/dist/records-v2/AddressRecord.d.ts +0 -321
- package/dist/records-v2/AddressRecord.js +0 -532
- package/dist/records-v2/AffiliateCodeRecord.d.ts +1 -102
- package/dist/records-v2/AffiliateCodeRecord.js +0 -157
- package/dist/records-v2/AppointmentRecord.d.ts +0 -141
- package/dist/records-v2/AppointmentRecord.js +0 -235
- package/dist/records-v2/BillingAdjustmentRecord.d.ts +0 -81
- package/dist/records-v2/BillingAdjustmentRecord.js +0 -136
- package/dist/records-v2/BillingRequestRecord.d.ts +2 -178
- package/dist/records-v2/BillingRequestRecord.js +0 -271
- package/dist/records-v2/BlockageA55Record.d.ts +2 -103
- package/dist/records-v2/BlockageA55Record.js +0 -157
- package/dist/records-v2/CallEventRecord.d.ts +1 -82
- package/dist/records-v2/CallEventRecord.js +0 -124
- package/dist/records-v2/CallLegRecord.d.ts +1 -82
- package/dist/records-v2/CallLegRecord.js +0 -124
- package/dist/records-v2/CallRecord.d.ts +1 -202
- package/dist/records-v2/CallRecord.js +0 -322
- package/dist/records-v2/CallTransferRecord.d.ts +1 -102
- package/dist/records-v2/CallTransferRecord.js +0 -157
- package/dist/records-v2/CampaignRecord.d.ts +2 -83
- package/dist/records-v2/CampaignRecord.js +0 -124
- package/dist/records-v2/CaseRecord.d.ts +2 -358
- package/dist/records-v2/CaseRecord.js +0 -568
- package/dist/records-v2/ChangeReasonRecord.d.ts +2 -171
- package/dist/records-v2/ChangeReasonRecord.js +0 -238
- package/dist/records-v2/ChurnRequestRecord.d.ts +1 -62
- package/dist/records-v2/ChurnRequestRecord.js +0 -91
- package/dist/records-v2/ContactRecord.d.ts +0 -460
- package/dist/records-v2/ContactRecord.js +0 -762
- package/dist/records-v2/ContractBuyOutRecord.d.ts +1 -162
- package/dist/records-v2/ContractBuyOutRecord.js +0 -256
- package/dist/records-v2/ConversationRecord.d.ts +1 -62
- package/dist/records-v2/ConversationRecord.js +0 -91
- package/dist/records-v2/CreditNoteRecord.d.ts +0 -81
- package/dist/records-v2/CreditNoteRecord.js +0 -136
- package/dist/records-v2/CrmDatasetRecord.d.ts +2 -191
- package/dist/records-v2/CrmDatasetRecord.js +0 -271
- package/dist/records-v2/CustomerDeviceAtaRecord.d.ts +0 -21
- package/dist/records-v2/CustomerDeviceAtaRecord.js +0 -37
- package/dist/records-v2/CustomerDeviceOntRecord.d.ts +0 -181
- package/dist/records-v2/CustomerDeviceOntRecord.js +0 -301
- package/dist/records-v2/CustomerDeviceRouterRecord.d.ts +0 -141
- package/dist/records-v2/CustomerDeviceRouterRecord.js +0 -235
- package/dist/records-v2/CustomerPhonePortingRecord.d.ts +0 -21
- package/dist/records-v2/CustomerPhonePortingRecord.js +0 -37
- package/dist/records-v2/DiscountRecord.d.ts +0 -121
- package/dist/records-v2/DiscountRecord.js +0 -202
- package/dist/records-v2/EmailRecord.d.ts +2 -154
- package/dist/records-v2/EmailRecord.js +0 -221
- package/dist/records-v2/EmailTemplateRecord.d.ts +1 -21
- package/dist/records-v2/EmailTemplateRecord.js +0 -21
- package/dist/records-v2/FieldServiceDispatchedProductRecord.d.ts +2 -135
- package/dist/records-v2/FieldServiceDispatchedProductRecord.js +0 -189
- package/dist/records-v2/FieldServiceProductRecord.d.ts +2 -115
- package/dist/records-v2/FieldServiceProductRecord.js +0 -156
- package/dist/records-v2/FileRecord.d.ts +2 -1191
- package/dist/records-v2/FileRecord.js +0 -1869
- package/dist/records-v2/ImpersonationTrackerRecord.d.ts +1 -62
- package/dist/records-v2/ImpersonationTrackerRecord.js +0 -91
- package/dist/records-v2/InternalInstallAuditRecord.d.ts +2 -83
- package/dist/records-v2/InternalInstallAuditRecord.js +0 -124
- package/dist/records-v2/InvoiceItemRecord.d.ts +0 -40
- package/dist/records-v2/InvoiceItemRecord.js +0 -69
- package/dist/records-v2/InvoiceRecord.d.ts +2 -359
- package/dist/records-v2/InvoiceRecord.js +0 -569
- package/dist/records-v2/KnowledgeArticleRecord.d.ts +2 -98
- package/dist/records-v2/KnowledgeArticleRecord.js +0 -139
- package/dist/records-v2/LeadRecord.d.ts +0 -261
- package/dist/records-v2/LeadRecord.js +0 -433
- package/dist/records-v2/MessageRecord.d.ts +2 -79
- package/dist/records-v2/MessageRecord.js +0 -107
- package/dist/records-v2/NetworkDeviceRecord.d.ts +2 -43
- package/dist/records-v2/NetworkDeviceRecord.js +0 -58
- package/dist/records-v2/NoteRecord.d.ts +1 -1101
- package/dist/records-v2/NoteRecord.js +0 -1806
- package/dist/records-v2/OfferRecord.d.ts +2 -154
- package/dist/records-v2/OfferRecord.js +0 -221
- package/dist/records-v2/OhAuditOfInstallationRecord.d.ts +2 -83
- package/dist/records-v2/OhAuditOfInstallationRecord.js +0 -124
- package/dist/records-v2/OhExternalAuditRecord.d.ts +2 -83
- package/dist/records-v2/OhExternalAuditRecord.js +0 -124
- package/dist/records-v2/OhInProgressAuditRecord.d.ts +2 -83
- package/dist/records-v2/OhInProgressAuditRecord.js +0 -124
- package/dist/records-v2/OhInstallationAuditRecord.d.ts +2 -83
- package/dist/records-v2/OhInstallationAuditRecord.js +0 -124
- package/dist/records-v2/OhRetroAuditRecord.d.ts +2 -83
- package/dist/records-v2/OhRetroAuditRecord.js +0 -124
- package/dist/records-v2/OneTouchSwitchRecord.d.ts +2 -255
- package/dist/records-v2/OneTouchSwitchRecord.js +0 -387
- package/dist/records-v2/OntReplacementApprovalRecord.d.ts +1 -62
- package/dist/records-v2/OntReplacementApprovalRecord.js +0 -91
- package/dist/records-v2/OrderCheckRecord.d.ts +0 -21
- package/dist/records-v2/OrderCheckRecord.js +0 -37
- package/dist/records-v2/OrderItemRecord.d.ts +0 -280
- package/dist/records-v2/OrderItemRecord.js +0 -465
- package/dist/records-v2/OrderRecord.d.ts +0 -540
- package/dist/records-v2/OrderRecord.js +0 -894
- package/dist/records-v2/OutageRecord.d.ts +1 -42
- package/dist/records-v2/OutageRecord.js +0 -58
- package/dist/records-v2/OverlayRealA55Record.d.ts +2 -83
- package/dist/records-v2/OverlayRealA55Record.js +0 -124
- package/dist/records-v2/PICRequestRecord.d.ts +1 -62
- package/dist/records-v2/PICRequestRecord.js +0 -91
- package/dist/records-v2/PaymentMethodRecord.d.ts +0 -121
- package/dist/records-v2/PaymentMethodRecord.js +0 -202
- package/dist/records-v2/PaymentMethodRefundRecord.d.ts +0 -181
- package/dist/records-v2/PaymentMethodRefundRecord.js +0 -301
- package/dist/records-v2/PaymentRecord.d.ts +1 -82
- package/dist/records-v2/PaymentRecord.js +0 -124
- package/dist/records-v2/PermissionToFailRecord.d.ts +0 -61
- package/dist/records-v2/PermissionToFailRecord.js +0 -103
- package/dist/records-v2/PgAccountValidationRecord.d.ts +1 -21
- package/dist/records-v2/PgAccountValidationRecord.js +0 -21
- package/dist/records-v2/PgContactRecord.d.ts +1 -62
- package/dist/records-v2/PgContactRecord.js +0 -91
- package/dist/records-v2/PgDirectDebitFileRecord.d.ts +2 -95
- package/dist/records-v2/PgDirectDebitFileRecord.js +0 -123
- package/dist/records-v2/PgDisputeRecord.d.ts +1 -62
- package/dist/records-v2/PgDisputeRecord.js +0 -91
- package/dist/records-v2/PgFileAllocationRecord.d.ts +2 -115
- package/dist/records-v2/PgFileAllocationRecord.js +0 -156
- package/dist/records-v2/PgLogRecord.d.ts +1 -21
- package/dist/records-v2/PgLogRecord.js +0 -21
- package/dist/records-v2/PgPaymentMethodRecord.d.ts +1 -102
- package/dist/records-v2/PgPaymentMethodRecord.js +0 -157
- package/dist/records-v2/PgSortCodeSubstitutionRecord.d.ts +1 -21
- package/dist/records-v2/PgSortCodeSubstitutionRecord.js +0 -21
- package/dist/records-v2/PgTransactionRecord.d.ts +2 -135
- package/dist/records-v2/PgTransactionRecord.js +0 -189
- package/dist/records-v2/PgVocalinkRecord.d.ts +1 -21
- package/dist/records-v2/PgVocalinkRecord.js +0 -21
- package/dist/records-v2/PgWebhookAttemptRecord.d.ts +1 -42
- package/dist/records-v2/PgWebhookAttemptRecord.js +0 -58
- package/dist/records-v2/PgWebhookRecord.d.ts +1 -122
- package/dist/records-v2/PgWebhookRecord.js +0 -190
- package/dist/records-v2/PriceBookRecord.d.ts +0 -21
- package/dist/records-v2/PriceBookRecord.js +0 -37
- package/dist/records-v2/ProductRecord.d.ts +2 -242
- package/dist/records-v2/ProductRecord.js +0 -335
- package/dist/records-v2/PushNotificationRecord.d.ts +1 -42
- package/dist/records-v2/PushNotificationRecord.js +0 -58
- package/dist/records-v2/ReferralRecord.d.ts +2 -103
- package/dist/records-v2/ReferralRecord.js +0 -157
- package/dist/records-v2/RemediationOutcomeFormRecord.d.ts +2 -83
- package/dist/records-v2/RemediationOutcomeFormRecord.js +0 -124
- package/dist/records-v2/RemediationRequiredReasonRecord.d.ts +2 -103
- package/dist/records-v2/RemediationRequiredReasonRecord.js +0 -157
- package/dist/records-v2/ReturnsRecord.d.ts +1 -62
- package/dist/records-v2/ReturnsRecord.js +0 -91
- package/dist/records-v2/RewardRecord.d.ts +2 -103
- package/dist/records-v2/RewardRecord.js +0 -157
- package/dist/records-v2/SalesTerritoryRecord.d.ts +2 -79
- package/dist/records-v2/SalesTerritoryRecord.js +0 -107
- package/dist/records-v2/ScheduleSlotRecord.d.ts +1 -42
- package/dist/records-v2/ScheduleSlotRecord.js +0 -58
- package/dist/records-v2/ServiceAppointmentConfigRecord.d.ts +2 -287
- package/dist/records-v2/ServiceAppointmentConfigRecord.js +0 -367
- package/dist/records-v2/ServiceAppointmentRecord.d.ts +0 -81
- package/dist/records-v2/ServiceAppointmentRecord.js +0 -136
- package/dist/records-v2/ServiceRecord.d.ts +0 -40
- package/dist/records-v2/ServiceRecord.js +0 -69
- package/dist/records-v2/ServiceVisitAuditRecord.d.ts +2 -83
- package/dist/records-v2/ServiceVisitAuditRecord.js +0 -124
- package/dist/records-v2/SiteSpecificRiskAssessmentOutcomeFormRecord.d.ts +2 -83
- package/dist/records-v2/SiteSpecificRiskAssessmentOutcomeFormRecord.js +0 -124
- package/dist/records-v2/SweeperMaintenanceAuditRecord.d.ts +2 -83
- package/dist/records-v2/SweeperMaintenanceAuditRecord.js +0 -124
- package/dist/records-v2/TeamRecord.d.ts +0 -81
- package/dist/records-v2/TeamRecord.js +0 -136
- package/dist/records-v2/TimeSlotRecord.d.ts +0 -21
- package/dist/records-v2/TimeSlotRecord.js +0 -37
- package/dist/records-v2/TransactionRecord.d.ts +1 -181
- package/dist/records-v2/TransactionRecord.js +0 -288
- package/dist/records-v2/TwilioUserUpdateRecord.d.ts +1 -42
- package/dist/records-v2/TwilioUserUpdateRecord.js +0 -58
- package/dist/records-v2/UgAuditOfInstallationRecord.d.ts +2 -83
- package/dist/records-v2/UgAuditOfInstallationRecord.js +0 -124
- package/dist/records-v2/UgExternalAuditRecord.d.ts +2 -83
- package/dist/records-v2/UgExternalAuditRecord.js +0 -124
- package/dist/records-v2/UgInProgressAuditRecord.d.ts +2 -83
- package/dist/records-v2/UgInProgressAuditRecord.js +0 -124
- package/dist/records-v2/UgInstallationAuditRecord.d.ts +2 -83
- package/dist/records-v2/UgInstallationAuditRecord.js +0 -124
- package/dist/records-v2/UgRetroAuditRecord.d.ts +2 -83
- package/dist/records-v2/UgRetroAuditRecord.js +0 -124
- package/dist/records-v2/UserRecord.d.ts +0 -341
- package/dist/records-v2/UserRecord.js +0 -565
- package/dist/records-v2/VisitRecord.d.ts +0 -121
- package/dist/records-v2/VisitRecord.js +0 -202
- package/dist/records-v2/VoiceConfigurationRecord.d.ts +0 -21
- package/dist/records-v2/VoiceConfigurationRecord.js +0 -37
- package/dist/records-v2/WayleaveAuditRecord.d.ts +2 -83
- package/dist/records-v2/WayleaveAuditRecord.js +0 -124
- package/dist/records-v2/WorkOrderRecord.d.ts +2 -1186
- package/dist/records-v2/WorkOrderRecord.js +0 -1799
- package/dist/records-v2/WorkOrderStatusUpdateRecord.d.ts +2 -75
- package/dist/records-v2/WorkOrderStatusUpdateRecord.js +0 -90
- package/dist/records-v2/YfFieldServiceVisitRecord.d.ts +2 -83
- package/dist/records-v2/YfFieldServiceVisitRecord.js +0 -124
- package/dist/records-v2/YfStockAuditRecord.d.ts +2 -83
- package/dist/records-v2/YfStockAuditRecord.js +0 -124
- package/package.json +1 -1
|
@@ -23,12 +23,12 @@ export declare enum ConfigEntityTypes {
|
|
|
23
23
|
* Use these constants instead of string literals for type safety
|
|
24
24
|
*/
|
|
25
25
|
export declare enum ConfigPropertyKeys {
|
|
26
|
-
/**
|
|
27
|
-
|
|
26
|
+
/** the name of the app this config relates to (Platform - Config) */
|
|
27
|
+
AppName = "AppName",
|
|
28
28
|
/** object of { key: value } mappings (Platform - Config) */
|
|
29
29
|
Mappings = "Mappings",
|
|
30
|
-
/**
|
|
31
|
-
|
|
30
|
+
/** Data field for Config records. Used by Platform team. */
|
|
31
|
+
Test = "Test"
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
34
|
* Properties for Config records
|
|
@@ -36,21 +36,21 @@ export declare enum ConfigPropertyKeys {
|
|
|
36
36
|
* @see SchemaModule:Config
|
|
37
37
|
*/
|
|
38
38
|
export interface ConfigProperties {
|
|
39
|
-
/**
|
|
39
|
+
/** the name of the app this config relates to (Platform - Config)
|
|
40
40
|
*
|
|
41
41
|
* @type {TEXT}
|
|
42
42
|
*/
|
|
43
|
-
|
|
43
|
+
AppName: string;
|
|
44
44
|
/** object of { key: value } mappings (Platform - Config)
|
|
45
45
|
*
|
|
46
46
|
* @type {JSON}
|
|
47
47
|
*/
|
|
48
48
|
Mappings: string;
|
|
49
|
-
/**
|
|
49
|
+
/** Data field for Config records. Used by Platform team.
|
|
50
50
|
*
|
|
51
51
|
* @type {TEXT}
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
Test: string;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
56
|
* Config entity from SchemaModule
|
|
@@ -28,12 +28,12 @@ var ConfigEntityTypes;
|
|
|
28
28
|
*/
|
|
29
29
|
var ConfigPropertyKeys;
|
|
30
30
|
(function (ConfigPropertyKeys) {
|
|
31
|
-
/** Data field for Config records. Used by Platform team. */
|
|
32
|
-
ConfigPropertyKeys["Test"] = "Test";
|
|
33
|
-
/** object of { key: value } mappings (Platform - Config) */
|
|
34
|
-
ConfigPropertyKeys["Mappings"] = "Mappings";
|
|
35
31
|
/** the name of the app this config relates to (Platform - Config) */
|
|
36
32
|
ConfigPropertyKeys["AppName"] = "AppName";
|
|
33
|
+
/** object of { key: value } mappings (Platform - Config) */
|
|
34
|
+
ConfigPropertyKeys["Mappings"] = "Mappings";
|
|
35
|
+
/** Data field for Config records. Used by Platform team. */
|
|
36
|
+
ConfigPropertyKeys["Test"] = "Test";
|
|
37
37
|
})(ConfigPropertyKeys = exports.ConfigPropertyKeys || (exports.ConfigPropertyKeys = {}));
|
|
38
38
|
/**
|
|
39
39
|
* Config entity from SchemaModule
|
|
@@ -13,16 +13,13 @@
|
|
|
13
13
|
* await record.createAccount({ ... }).execute();
|
|
14
14
|
* ```
|
|
15
15
|
*
|
|
16
|
-
* Entity Types: BUSINESS, MULTIPLE, PRIMARY, RESELLER, SERVICE
|
|
17
|
-
*
|
|
18
16
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
19
17
|
*/
|
|
20
18
|
import { OdinRecord, OdinRecordLinkDto } from '@d19n/odin-types/dist/core';
|
|
21
19
|
import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
|
|
22
20
|
import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
|
|
23
21
|
import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
24
|
-
import {
|
|
25
|
-
import { AccountProperties, BusinessAccountProperties, MultipleAccountProperties, PrimaryAccountProperties, ResellerAccountProperties, ServiceAccountProperties } from '../entities-v2/Account';
|
|
22
|
+
import { AccountProperties } from '../entities-v2/Account';
|
|
26
23
|
import { ChangeBillingModeProperties } from '../actions-v2/ChangeBillingModeDto';
|
|
27
24
|
import { CreateBusinessAccountProperties } from '../actions-v2/CreateBusinessAccountDto';
|
|
28
25
|
import { CreatePrimaryAccountProperties } from '../actions-v2/CreatePrimaryAccountDto';
|
|
@@ -30,18 +27,6 @@ import { CreateResellerAccountProperties } from '../actions-v2/CreateResellerAcc
|
|
|
30
27
|
import { UpdateBusinessAccountProperties } from '../actions-v2/UpdateBusinessAccountDto';
|
|
31
28
|
import { UpdatePrimaryAccountProperties } from '../actions-v2/UpdatePrimaryAccountDto';
|
|
32
29
|
import { UpdateResellerAccountProperties } from '../actions-v2/UpdateResellerAccountDto';
|
|
33
|
-
import { WorkOrderRecord } from './WorkOrderRecord';
|
|
34
|
-
import { NoteRecord } from './NoteRecord';
|
|
35
|
-
import { OneTouchSwitchRecord } from './OneTouchSwitchRecord';
|
|
36
|
-
import { OrderRecord } from './OrderRecord';
|
|
37
|
-
import { InvoiceRecord } from './InvoiceRecord';
|
|
38
|
-
import { AddressRecord } from './AddressRecord';
|
|
39
|
-
import { CaseRecord } from './CaseRecord';
|
|
40
|
-
import { PaymentRecord } from './PaymentRecord';
|
|
41
|
-
import { ContactRecord } from './ContactRecord';
|
|
42
|
-
import { FileRecord } from './FileRecord';
|
|
43
|
-
/** Valid entity types for Account */
|
|
44
|
-
export declare type AccountType = 'BUSINESS' | 'MULTIPLE' | 'PRIMARY' | 'RESELLER' | 'SERVICE';
|
|
45
30
|
/**
|
|
46
31
|
* Builder for action execution with dryRun support
|
|
47
32
|
*
|
|
@@ -78,17 +63,6 @@ export declare class AccountRecord<TProps = AccountProperties> {
|
|
|
78
63
|
private _provider;
|
|
79
64
|
private _pendingLinks;
|
|
80
65
|
private _preGeneratedId;
|
|
81
|
-
private _workOrders?;
|
|
82
|
-
private _notes?;
|
|
83
|
-
private _oneTouchSwitches?;
|
|
84
|
-
private _orders?;
|
|
85
|
-
private _invoices?;
|
|
86
|
-
private _accounts?;
|
|
87
|
-
private _addresses?;
|
|
88
|
-
private _cases?;
|
|
89
|
-
private _payments?;
|
|
90
|
-
private _contacts?;
|
|
91
|
-
private _files?;
|
|
92
66
|
/**
|
|
93
67
|
* Create a record wrapper.
|
|
94
68
|
* @param record - The underlying record, or null for create operations
|
|
@@ -101,7 +75,7 @@ export declare class AccountRecord<TProps = AccountProperties> {
|
|
|
101
75
|
/** Record ID - always available (pre-generated for new records) */
|
|
102
76
|
get id(): string;
|
|
103
77
|
get entity(): string;
|
|
104
|
-
get type():
|
|
78
|
+
get type(): string | undefined;
|
|
105
79
|
/** Record properties - empty object for new (unsaved) records */
|
|
106
80
|
get properties(): TProps;
|
|
107
81
|
get title(): string | undefined;
|
|
@@ -111,284 +85,6 @@ export declare class AccountRecord<TProps = AccountProperties> {
|
|
|
111
85
|
get updatedAt(): string | undefined;
|
|
112
86
|
/** Access the underlying OdinRecord (null for new records) */
|
|
113
87
|
get record(): OdinRecord<TProps> | null;
|
|
114
|
-
/**
|
|
115
|
-
* Type guard: check if this record is of type BUSINESS
|
|
116
|
-
*
|
|
117
|
-
* When this returns true, TypeScript automatically narrows the type,
|
|
118
|
-
* giving you access to BUSINESS-specific properties.
|
|
119
|
-
*
|
|
120
|
-
* @example
|
|
121
|
-
* ```typescript
|
|
122
|
-
* if (record.isBusiness()) {
|
|
123
|
-
* // TypeScript knows record.properties is BusinessAccountProperties
|
|
124
|
-
* console.log(record.properties.SomeTypeSpecificField);
|
|
125
|
-
* }
|
|
126
|
-
* ```
|
|
127
|
-
* @remarks Business accounts
|
|
128
|
-
*/
|
|
129
|
-
isBusiness(): this is AccountRecord<BusinessAccountProperties>;
|
|
130
|
-
/**
|
|
131
|
-
* Type guard: check if this record is of type MULTIPLE
|
|
132
|
-
*
|
|
133
|
-
* When this returns true, TypeScript automatically narrows the type,
|
|
134
|
-
* giving you access to MULTIPLE-specific properties.
|
|
135
|
-
*
|
|
136
|
-
* @example
|
|
137
|
-
* ```typescript
|
|
138
|
-
* if (record.isMultiple()) {
|
|
139
|
-
* // TypeScript knows record.properties is MultipleAccountProperties
|
|
140
|
-
* console.log(record.properties.SomeTypeSpecificField);
|
|
141
|
-
* }
|
|
142
|
-
* ```
|
|
143
|
-
* @remarks Multiple accounts are for customers who want to purchase multiple services at many addresses
|
|
144
|
-
*/
|
|
145
|
-
isMultiple(): this is AccountRecord<MultipleAccountProperties>;
|
|
146
|
-
/**
|
|
147
|
-
* Type guard: check if this record is of type PRIMARY
|
|
148
|
-
*
|
|
149
|
-
* When this returns true, TypeScript automatically narrows the type,
|
|
150
|
-
* giving you access to PRIMARY-specific properties.
|
|
151
|
-
*
|
|
152
|
-
* @example
|
|
153
|
-
* ```typescript
|
|
154
|
-
* if (record.isPrimary()) {
|
|
155
|
-
* // TypeScript knows record.properties is PrimaryAccountProperties
|
|
156
|
-
* console.log(record.properties.SomeTypeSpecificField);
|
|
157
|
-
* }
|
|
158
|
-
* ```
|
|
159
|
-
* @remarks Primary account
|
|
160
|
-
*/
|
|
161
|
-
isPrimary(): this is AccountRecord<PrimaryAccountProperties>;
|
|
162
|
-
/**
|
|
163
|
-
* Type guard: check if this record is of type RESELLER
|
|
164
|
-
*
|
|
165
|
-
* When this returns true, TypeScript automatically narrows the type,
|
|
166
|
-
* giving you access to RESELLER-specific properties.
|
|
167
|
-
*
|
|
168
|
-
* @example
|
|
169
|
-
* ```typescript
|
|
170
|
-
* if (record.isReseller()) {
|
|
171
|
-
* // TypeScript knows record.properties is ResellerAccountProperties
|
|
172
|
-
* console.log(record.properties.SomeTypeSpecificField);
|
|
173
|
-
* }
|
|
174
|
-
* ```
|
|
175
|
-
* @remarks Reseller
|
|
176
|
-
*/
|
|
177
|
-
isReseller(): this is AccountRecord<ResellerAccountProperties>;
|
|
178
|
-
/**
|
|
179
|
-
* Type guard: check if this record is of type SERVICE
|
|
180
|
-
*
|
|
181
|
-
* When this returns true, TypeScript automatically narrows the type,
|
|
182
|
-
* giving you access to SERVICE-specific properties.
|
|
183
|
-
*
|
|
184
|
-
* @example
|
|
185
|
-
* ```typescript
|
|
186
|
-
* if (record.isService()) {
|
|
187
|
-
* // TypeScript knows record.properties is ServiceAccountProperties
|
|
188
|
-
* console.log(record.properties.SomeTypeSpecificField);
|
|
189
|
-
* }
|
|
190
|
-
* ```
|
|
191
|
-
* @remarks This is the account where service is being delivered
|
|
192
|
-
*/
|
|
193
|
-
isService(): this is AccountRecord<ServiceAccountProperties>;
|
|
194
|
-
/** Valid labels for WorkOrder associations */
|
|
195
|
-
static readonly workOrdersLabels: readonly ["Account__WorkOrder"];
|
|
196
|
-
/**
|
|
197
|
-
* Access linked WorkOrder records
|
|
198
|
-
* @remarks Available labels: Account__WorkOrder
|
|
199
|
-
* @throws Error if called on a new (unsaved) record
|
|
200
|
-
*
|
|
201
|
-
* @example
|
|
202
|
-
* ```typescript
|
|
203
|
-
* // Get all linked WorkOrder records
|
|
204
|
-
* const items = await record.workOrders.list();
|
|
205
|
-
* const first = await record.workOrders.first();
|
|
206
|
-
*
|
|
207
|
-
* // Filter by label
|
|
208
|
-
* const specific = await record.workOrders.first({ label: 'Account__WorkOrder' });
|
|
209
|
-
* ```
|
|
210
|
-
*/
|
|
211
|
-
get workOrders(): RecordLinkManager<WorkOrderRecord, typeof AccountRecord['workOrdersLabels'][number]>;
|
|
212
|
-
/** Valid labels for Note associations */
|
|
213
|
-
static readonly notesLabels: readonly ["Account__Note"];
|
|
214
|
-
/**
|
|
215
|
-
* Access linked Note records
|
|
216
|
-
* @remarks Available labels: Account__Note
|
|
217
|
-
* @throws Error if called on a new (unsaved) record
|
|
218
|
-
*
|
|
219
|
-
* @example
|
|
220
|
-
* ```typescript
|
|
221
|
-
* // Get all linked Note records
|
|
222
|
-
* const items = await record.notes.list();
|
|
223
|
-
* const first = await record.notes.first();
|
|
224
|
-
*
|
|
225
|
-
* // Filter by label
|
|
226
|
-
* const specific = await record.notes.first({ label: 'Account__Note' });
|
|
227
|
-
* ```
|
|
228
|
-
*/
|
|
229
|
-
get notes(): RecordLinkManager<NoteRecord, typeof AccountRecord['notesLabels'][number]>;
|
|
230
|
-
/** Valid labels for OneTouchSwitch associations */
|
|
231
|
-
static readonly oneTouchSwitchesLabels: readonly ["Account__OneTouchSwitch"];
|
|
232
|
-
/**
|
|
233
|
-
* Access linked OneTouchSwitch records
|
|
234
|
-
* @remarks Available labels: Account__OneTouchSwitch
|
|
235
|
-
* @throws Error if called on a new (unsaved) record
|
|
236
|
-
*
|
|
237
|
-
* @example
|
|
238
|
-
* ```typescript
|
|
239
|
-
* // Get all linked OneTouchSwitch records
|
|
240
|
-
* const items = await record.oneTouchSwitches.list();
|
|
241
|
-
* const first = await record.oneTouchSwitches.first();
|
|
242
|
-
*
|
|
243
|
-
* // Filter by label
|
|
244
|
-
* const specific = await record.oneTouchSwitches.first({ label: 'Account__OneTouchSwitch' });
|
|
245
|
-
* ```
|
|
246
|
-
*/
|
|
247
|
-
get oneTouchSwitches(): RecordLinkManager<OneTouchSwitchRecord, typeof AccountRecord['oneTouchSwitchesLabels'][number]>;
|
|
248
|
-
/** Valid labels for Order associations */
|
|
249
|
-
static readonly ordersLabels: readonly ["Account__Order"];
|
|
250
|
-
/**
|
|
251
|
-
* Access linked Order records
|
|
252
|
-
* @remarks Available labels: Account__Order
|
|
253
|
-
* @throws Error if called on a new (unsaved) record
|
|
254
|
-
*
|
|
255
|
-
* @example
|
|
256
|
-
* ```typescript
|
|
257
|
-
* // Get all linked Order records
|
|
258
|
-
* const items = await record.orders.list();
|
|
259
|
-
* const first = await record.orders.first();
|
|
260
|
-
*
|
|
261
|
-
* // Filter by label
|
|
262
|
-
* const specific = await record.orders.first({ label: 'Account__Order' });
|
|
263
|
-
* ```
|
|
264
|
-
*/
|
|
265
|
-
get orders(): RecordLinkManager<OrderRecord, typeof AccountRecord['ordersLabels'][number]>;
|
|
266
|
-
/** Valid labels for Invoice associations */
|
|
267
|
-
static readonly invoicesLabels: readonly ["Account__Invoice"];
|
|
268
|
-
/**
|
|
269
|
-
* Access linked Invoice records
|
|
270
|
-
* @remarks Available labels: Account__Invoice
|
|
271
|
-
* @throws Error if called on a new (unsaved) record
|
|
272
|
-
*
|
|
273
|
-
* @example
|
|
274
|
-
* ```typescript
|
|
275
|
-
* // Get all linked Invoice records
|
|
276
|
-
* const items = await record.invoices.list();
|
|
277
|
-
* const first = await record.invoices.first();
|
|
278
|
-
*
|
|
279
|
-
* // Filter by label
|
|
280
|
-
* const specific = await record.invoices.first({ label: 'Account__Invoice' });
|
|
281
|
-
* ```
|
|
282
|
-
*/
|
|
283
|
-
get invoices(): RecordLinkManager<InvoiceRecord, typeof AccountRecord['invoicesLabels'][number]>;
|
|
284
|
-
/** Valid labels for Account associations */
|
|
285
|
-
static readonly accountsLabels: readonly ["Account_Account"];
|
|
286
|
-
/**
|
|
287
|
-
* Access linked Account records
|
|
288
|
-
* @remarks Available labels: Account_Account
|
|
289
|
-
* @throws Error if called on a new (unsaved) record
|
|
290
|
-
*
|
|
291
|
-
* @example
|
|
292
|
-
* ```typescript
|
|
293
|
-
* // Get all linked Account records
|
|
294
|
-
* const items = await record.accounts.list();
|
|
295
|
-
* const first = await record.accounts.first();
|
|
296
|
-
*
|
|
297
|
-
* // Filter by label
|
|
298
|
-
* const specific = await record.accounts.first({ label: 'Account_Account' });
|
|
299
|
-
* ```
|
|
300
|
-
*/
|
|
301
|
-
get accounts(): RecordLinkManager<AccountRecord, typeof AccountRecord['accountsLabels'][number]>;
|
|
302
|
-
/** Valid labels for Address associations */
|
|
303
|
-
static readonly addressesLabels: readonly ["BillingAddress"];
|
|
304
|
-
/**
|
|
305
|
-
* Access linked Address records
|
|
306
|
-
* @remarks Available labels: BillingAddress
|
|
307
|
-
* @throws Error if called on a new (unsaved) record
|
|
308
|
-
*
|
|
309
|
-
* @example
|
|
310
|
-
* ```typescript
|
|
311
|
-
* // Get all linked Address records
|
|
312
|
-
* const items = await record.addresses.list();
|
|
313
|
-
* const first = await record.addresses.first();
|
|
314
|
-
*
|
|
315
|
-
* // Filter by label
|
|
316
|
-
* const specific = await record.addresses.first({ label: 'BillingAddress' });
|
|
317
|
-
* ```
|
|
318
|
-
*/
|
|
319
|
-
get addresses(): RecordLinkManager<AddressRecord, typeof AccountRecord['addressesLabels'][number]>;
|
|
320
|
-
/** Valid labels for Case associations */
|
|
321
|
-
static readonly casesLabels: readonly ["Account__Case"];
|
|
322
|
-
/**
|
|
323
|
-
* Access linked Case records
|
|
324
|
-
* @remarks Available labels: Account__Case
|
|
325
|
-
* @throws Error if called on a new (unsaved) record
|
|
326
|
-
*
|
|
327
|
-
* @example
|
|
328
|
-
* ```typescript
|
|
329
|
-
* // Get all linked Case records
|
|
330
|
-
* const items = await record.cases.list();
|
|
331
|
-
* const first = await record.cases.first();
|
|
332
|
-
*
|
|
333
|
-
* // Filter by label
|
|
334
|
-
* const specific = await record.cases.first({ label: 'Account__Case' });
|
|
335
|
-
* ```
|
|
336
|
-
*/
|
|
337
|
-
get cases(): RecordLinkManager<CaseRecord, typeof AccountRecord['casesLabels'][number]>;
|
|
338
|
-
/** Valid labels for Payment associations */
|
|
339
|
-
static readonly paymentsLabels: readonly ["Account_Payment"];
|
|
340
|
-
/**
|
|
341
|
-
* Access linked Payment records
|
|
342
|
-
* @remarks Available labels: Account_Payment
|
|
343
|
-
* @throws Error if called on a new (unsaved) record
|
|
344
|
-
*
|
|
345
|
-
* @example
|
|
346
|
-
* ```typescript
|
|
347
|
-
* // Get all linked Payment records
|
|
348
|
-
* const items = await record.payments.list();
|
|
349
|
-
* const first = await record.payments.first();
|
|
350
|
-
*
|
|
351
|
-
* // Filter by label
|
|
352
|
-
* const specific = await record.payments.first({ label: 'Account_Payment' });
|
|
353
|
-
* ```
|
|
354
|
-
*/
|
|
355
|
-
get payments(): RecordLinkManager<PaymentRecord, typeof AccountRecord['paymentsLabels'][number]>;
|
|
356
|
-
/** Valid labels for Contact associations */
|
|
357
|
-
static readonly contactsLabels: readonly ["BillingContact"];
|
|
358
|
-
/**
|
|
359
|
-
* Access linked Contact records
|
|
360
|
-
* @remarks Available labels: BillingContact
|
|
361
|
-
* @throws Error if called on a new (unsaved) record
|
|
362
|
-
*
|
|
363
|
-
* @example
|
|
364
|
-
* ```typescript
|
|
365
|
-
* // Get all linked Contact records
|
|
366
|
-
* const items = await record.contacts.list();
|
|
367
|
-
* const first = await record.contacts.first();
|
|
368
|
-
*
|
|
369
|
-
* // Filter by label
|
|
370
|
-
* const specific = await record.contacts.first({ label: 'BillingContact' });
|
|
371
|
-
* ```
|
|
372
|
-
*/
|
|
373
|
-
get contacts(): RecordLinkManager<ContactRecord, typeof AccountRecord['contactsLabels'][number]>;
|
|
374
|
-
/** Valid labels for File associations */
|
|
375
|
-
static readonly filesLabels: readonly ["Account__File"];
|
|
376
|
-
/**
|
|
377
|
-
* Access linked File records
|
|
378
|
-
* @remarks Available labels: Account__File
|
|
379
|
-
* @throws Error if called on a new (unsaved) record
|
|
380
|
-
*
|
|
381
|
-
* @example
|
|
382
|
-
* ```typescript
|
|
383
|
-
* // Get all linked File records
|
|
384
|
-
* const items = await record.files.list();
|
|
385
|
-
* const first = await record.files.first();
|
|
386
|
-
*
|
|
387
|
-
* // Filter by label
|
|
388
|
-
* const specific = await record.files.first({ label: 'Account__File' });
|
|
389
|
-
* ```
|
|
390
|
-
*/
|
|
391
|
-
get files(): RecordLinkManager<FileRecord, typeof AccountRecord['filesLabels'][number]>;
|
|
392
88
|
/**
|
|
393
89
|
* Queue a link to be created with the next action.
|
|
394
90
|
* Works for both create and update actions.
|