@d19n/youfibre-odin-sdk 2.0.262 → 2.0.264
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 +3 -2
- package/dist/actions-v2/CaseTransitionEscalatedToBlockedDto.d.ts +36 -2
- package/dist/actions-v2/CaseTransitionOpenToBlockedDto.d.ts +36 -2
- package/dist/actions-v2/CaseTransitionPendingAgentToBlockedDto.d.ts +36 -2
- package/dist/actions-v2/CaseTransitionPendingReplyToBlockedDto.d.ts +36 -2
- package/dist/actions-v2/CasedefaultstageblockedDto.d.ts +36 -2
- package/dist/actions-v2/CreateOrderPreviousConnectionEmailDto.d.ts +136 -0
- package/dist/actions-v2/CreateOrderPreviousConnectionEmailDto.js +59 -0
- package/dist/actions-v2/MoveCaseToBlockedActionDto.d.ts +36 -2
- package/dist/actions-v2/MoveCaseToBlockedTransitionDto.d.ts +36 -2
- package/dist/actions-v2/SendRefundTransactionEmailDto.d.ts +5 -0
- package/dist/actions-v2/SendRefundTransactionEmailDto.js +6 -1
- package/dist/db-sdk-v2/FileDb.d.ts +122 -122
- package/dist/db-sdk-v2/FileDb.js +247 -247
- package/dist/entities-v2/Case.d.ts +78 -0
- package/dist/entities-v2/Case.js +48 -2
- package/dist/entities-v2/FieldServiceProduct.d.ts +70 -1
- package/dist/entities-v2/FieldServiceProduct.js +9 -1
- package/dist/entities-v2/File.d.ts +6 -0
- package/dist/entities-v2/File.js +5 -1
- package/dist/entities-v2/Offer.d.ts +20 -0
- package/dist/entities-v2/Offer.js +2 -0
- package/dist/entities-v2/Recontract.d.ts +56 -0
- package/dist/entities-v2/Recontract.js +14 -0
- package/dist/entities-v2/WorkOrder.d.ts +50 -2
- package/dist/entities-v2/WorkOrder.js +48 -0
- package/dist/records-v2/EmailRecord.d.ts +31 -2
- package/dist/records-v2/EmailRecord.js +39 -3
- package/dist/records-v2/FieldServiceProductRecord.d.ts +19 -3
- package/dist/records-v2/FieldServiceProductRecord.js +17 -1
- package/package.json +1 -1
|
@@ -35,6 +35,7 @@ import { CreateGenericRemediationRequiredProperties } from '../actions-v2/Create
|
|
|
35
35
|
import { CreateNewCreditNoteProperties } from '../actions-v2/CreateNewCreditNoteDto';
|
|
36
36
|
import { CreateNewInvoiceProperties } from '../actions-v2/CreateNewInvoiceDto';
|
|
37
37
|
import { CreateOrderConfirmationProperties } from '../actions-v2/CreateOrderConfirmationDto';
|
|
38
|
+
import { CreateOrderPreviousConnectionEmailProperties } from '../actions-v2/CreateOrderPreviousConnectionEmailDto';
|
|
38
39
|
import { CreateOrderReferralRefereeCancelledEmailProperties } from '../actions-v2/CreateOrderReferralRefereeCancelledEmailDto';
|
|
39
40
|
import { CreateOrderReferralRefereeNotQualifiedEmailProperties } from '../actions-v2/CreateOrderReferralRefereeNotQualifiedEmailDto';
|
|
40
41
|
import { CreateOrderReferralRefereePendingEmailProperties } from '../actions-v2/CreateOrderReferralRefereePendingEmailDto';
|
|
@@ -744,6 +745,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
744
745
|
journeyId?: string;
|
|
745
746
|
stageKey?: string;
|
|
746
747
|
}): ActionBuilder;
|
|
748
|
+
/**
|
|
749
|
+
* CreateOrderPreviousConnectionEmail
|
|
750
|
+
*
|
|
751
|
+
* Creates a new Email record with the specified properties.
|
|
752
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
753
|
+
*
|
|
754
|
+
* @remarks Record type: TRANSACTIONAL
|
|
755
|
+
*
|
|
756
|
+
* @param properties - The properties for the new record
|
|
757
|
+
* @param options - Optional settings
|
|
758
|
+
* @param options.journeyId - Associate with a journey
|
|
759
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
760
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
761
|
+
*
|
|
762
|
+
* @example
|
|
763
|
+
* ```typescript
|
|
764
|
+
* // Create with properties
|
|
765
|
+
* const record = odinClient.emails.new();
|
|
766
|
+
* await record.createOrderPreviousConnectionEmail({ ... }).execute();
|
|
767
|
+
*
|
|
768
|
+
* // Dry run (for debugging)
|
|
769
|
+
* const payload = record.createOrderPreviousConnectionEmail({ ... }).dryRun();
|
|
770
|
+
* ```
|
|
771
|
+
*/
|
|
772
|
+
createOrderPreviousConnectionEmail(properties?: CreateOrderPreviousConnectionEmailProperties, options?: {
|
|
773
|
+
journeyId?: string;
|
|
774
|
+
stageKey?: string;
|
|
775
|
+
}): ActionBuilder;
|
|
747
776
|
/**
|
|
748
777
|
* CreateOrderReferralRefereeCancelledEmail
|
|
749
778
|
*
|
|
@@ -1702,9 +1731,10 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
1702
1731
|
* Creates a new Email record with the specified properties.
|
|
1703
1732
|
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
1704
1733
|
*
|
|
1734
|
+
* @remarks Record type: TRANSACTIONAL
|
|
1735
|
+
*
|
|
1705
1736
|
* @param properties - The properties for the new record
|
|
1706
1737
|
* @param options - Optional settings
|
|
1707
|
-
* @param options.type - Override the record type
|
|
1708
1738
|
* @param options.journeyId - Associate with a journey
|
|
1709
1739
|
* @param options.stageKey - Set initial pipeline stage
|
|
1710
1740
|
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
@@ -1720,7 +1750,6 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
1720
1750
|
* ```
|
|
1721
1751
|
*/
|
|
1722
1752
|
sendRefundTransactionEmail(properties?: SendRefundTransactionEmailProperties, options?: {
|
|
1723
|
-
type?: string;
|
|
1724
1753
|
journeyId?: string;
|
|
1725
1754
|
stageKey?: string;
|
|
1726
1755
|
}): ActionBuilder;
|
|
@@ -926,6 +926,42 @@ class EmailRecord {
|
|
|
926
926
|
};
|
|
927
927
|
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
928
928
|
}
|
|
929
|
+
/**
|
|
930
|
+
* CreateOrderPreviousConnectionEmail
|
|
931
|
+
*
|
|
932
|
+
* Creates a new Email record with the specified properties.
|
|
933
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
934
|
+
*
|
|
935
|
+
* @remarks Record type: TRANSACTIONAL
|
|
936
|
+
*
|
|
937
|
+
* @param properties - The properties for the new record
|
|
938
|
+
* @param options - Optional settings
|
|
939
|
+
* @param options.journeyId - Associate with a journey
|
|
940
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
941
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
942
|
+
*
|
|
943
|
+
* @example
|
|
944
|
+
* ```typescript
|
|
945
|
+
* // Create with properties
|
|
946
|
+
* const record = odinClient.emails.new();
|
|
947
|
+
* await record.createOrderPreviousConnectionEmail({ ... }).execute();
|
|
948
|
+
*
|
|
949
|
+
* // Dry run (for debugging)
|
|
950
|
+
* const payload = record.createOrderPreviousConnectionEmail({ ... }).dryRun();
|
|
951
|
+
* ```
|
|
952
|
+
*/
|
|
953
|
+
createOrderPreviousConnectionEmail(properties, options) {
|
|
954
|
+
const payload = {
|
|
955
|
+
entity: 'NotificationModule:Email',
|
|
956
|
+
type: 'TRANSACTIONAL',
|
|
957
|
+
actionName: 'CreateOrderPreviousConnectionEmail',
|
|
958
|
+
properties: properties || {},
|
|
959
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
960
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
961
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
962
|
+
};
|
|
963
|
+
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
964
|
+
}
|
|
929
965
|
/**
|
|
930
966
|
* CreateOrderReferralRefereeCancelledEmail
|
|
931
967
|
*
|
|
@@ -2156,9 +2192,10 @@ class EmailRecord {
|
|
|
2156
2192
|
* Creates a new Email record with the specified properties.
|
|
2157
2193
|
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
2158
2194
|
*
|
|
2195
|
+
* @remarks Record type: TRANSACTIONAL
|
|
2196
|
+
*
|
|
2159
2197
|
* @param properties - The properties for the new record
|
|
2160
2198
|
* @param options - Optional settings
|
|
2161
|
-
* @param options.type - Override the record type
|
|
2162
2199
|
* @param options.journeyId - Associate with a journey
|
|
2163
2200
|
* @param options.stageKey - Set initial pipeline stage
|
|
2164
2201
|
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
@@ -2174,10 +2211,9 @@ class EmailRecord {
|
|
|
2174
2211
|
* ```
|
|
2175
2212
|
*/
|
|
2176
2213
|
sendRefundTransactionEmail(properties, options) {
|
|
2177
|
-
var _a, _b;
|
|
2178
2214
|
const payload = {
|
|
2179
2215
|
entity: 'NotificationModule:Email',
|
|
2180
|
-
type:
|
|
2216
|
+
type: 'TRANSACTIONAL',
|
|
2181
2217
|
actionName: 'SendRefundTransactionEmail',
|
|
2182
2218
|
properties: properties || {},
|
|
2183
2219
|
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* await record.createFieldServiceProduct({ ... }).execute();
|
|
14
14
|
* ```
|
|
15
15
|
*
|
|
16
|
-
* Entity Types: CPE_ROUTER, MESH, MISC
|
|
16
|
+
* Entity Types: CPE_ROUTER, MESH, MISC, RETURNS_BAG
|
|
17
17
|
*
|
|
18
18
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
19
19
|
*/
|
|
@@ -21,7 +21,7 @@ import { OdinRecord, OdinRecordLinkDto } from '@d19n/odin-types/dist/core';
|
|
|
21
21
|
import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
|
|
22
22
|
import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
23
23
|
import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
|
|
24
|
-
import { FieldServiceProductProperties, CpeRouterFieldServiceProductProperties, MeshFieldServiceProductProperties, MiscFieldServiceProductProperties } from '../entities-v2/FieldServiceProduct';
|
|
24
|
+
import { FieldServiceProductProperties, CpeRouterFieldServiceProductProperties, MeshFieldServiceProductProperties, MiscFieldServiceProductProperties, ReturnsBagFieldServiceProductProperties } from '../entities-v2/FieldServiceProduct';
|
|
25
25
|
import { CreateFieldServiceMeshProductProperties } from '../actions-v2/CreateFieldServiceMeshProductDto';
|
|
26
26
|
import { CreateFieldServiceMeshProductBuilder } from '../actions-v2/CreateFieldServiceMeshProductDto';
|
|
27
27
|
import { CreateFieldServiceProductProperties } from '../actions-v2/CreateFieldServiceProductDto';
|
|
@@ -34,7 +34,7 @@ import { ProductRecord } from './ProductRecord';
|
|
|
34
34
|
import { FieldServiceDispatchedProductRecord } from './FieldServiceDispatchedProductRecord';
|
|
35
35
|
import { WorkOrderRecord } from './WorkOrderRecord';
|
|
36
36
|
/** Valid entity types for FieldServiceProduct */
|
|
37
|
-
export declare type FieldServiceProductType = 'CPE_ROUTER' | 'MESH' | 'MISC';
|
|
37
|
+
export declare type FieldServiceProductType = 'CPE_ROUTER' | 'MESH' | 'MISC' | 'RETURNS_BAG';
|
|
38
38
|
export declare class FieldServiceProductRecord<TProps = FieldServiceProductProperties> {
|
|
39
39
|
private _record;
|
|
40
40
|
private _provider;
|
|
@@ -116,6 +116,22 @@ export declare class FieldServiceProductRecord<TProps = FieldServiceProductPrope
|
|
|
116
116
|
* @remarks MISC
|
|
117
117
|
*/
|
|
118
118
|
isMisc(): this is FieldServiceProductRecord<MiscFieldServiceProductProperties>;
|
|
119
|
+
/**
|
|
120
|
+
* Type guard: check if this record is of type RETURNS_BAG
|
|
121
|
+
*
|
|
122
|
+
* When this returns true, TypeScript automatically narrows the type,
|
|
123
|
+
* giving you access to RETURNS_BAG-specific properties.
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```typescript
|
|
127
|
+
* if (record.isReturnsBag()) {
|
|
128
|
+
* // TypeScript knows record.properties is ReturnsBagFieldServiceProductProperties
|
|
129
|
+
* console.log(record.properties.SomeTypeSpecificField);
|
|
130
|
+
* }
|
|
131
|
+
* ```
|
|
132
|
+
* @remarks Return Bag
|
|
133
|
+
*/
|
|
134
|
+
isReturnsBag(): this is FieldServiceProductRecord<ReturnsBagFieldServiceProductProperties>;
|
|
119
135
|
/** Valid labels for Product associations */
|
|
120
136
|
static readonly productsLabels: readonly ["FieldServiceProduct__CompatibleProducts"];
|
|
121
137
|
/**
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* await record.createFieldServiceProduct({ ... }).execute();
|
|
15
15
|
* ```
|
|
16
16
|
*
|
|
17
|
-
* Entity Types: CPE_ROUTER, MESH, MISC
|
|
17
|
+
* Entity Types: CPE_ROUTER, MESH, MISC, RETURNS_BAG
|
|
18
18
|
*
|
|
19
19
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
20
20
|
*/
|
|
@@ -200,6 +200,22 @@ class FieldServiceProductRecord {
|
|
|
200
200
|
* @remarks MISC
|
|
201
201
|
*/
|
|
202
202
|
isMisc() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'MISC'; }
|
|
203
|
+
/**
|
|
204
|
+
* Type guard: check if this record is of type RETURNS_BAG
|
|
205
|
+
*
|
|
206
|
+
* When this returns true, TypeScript automatically narrows the type,
|
|
207
|
+
* giving you access to RETURNS_BAG-specific properties.
|
|
208
|
+
*
|
|
209
|
+
* @example
|
|
210
|
+
* ```typescript
|
|
211
|
+
* if (record.isReturnsBag()) {
|
|
212
|
+
* // TypeScript knows record.properties is ReturnsBagFieldServiceProductProperties
|
|
213
|
+
* console.log(record.properties.SomeTypeSpecificField);
|
|
214
|
+
* }
|
|
215
|
+
* ```
|
|
216
|
+
* @remarks Return Bag
|
|
217
|
+
*/
|
|
218
|
+
isReturnsBag() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'RETURNS_BAG'; }
|
|
203
219
|
/**
|
|
204
220
|
* Access linked Product records
|
|
205
221
|
* @remarks Available labels: FieldServiceProduct__CompatibleProducts
|