@d19n/youfibre-odin-sdk 2.0.78 → 2.0.81

package/README.md

@@ -351,7 +351,7 @@ This SDK includes **163** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **604** actions.
+This SDK includes **605** actions.
 
 ### Action Types
 
@@ -1206,6 +1206,7 @@ This SDK includes **604** actions.
 | `CreateOrderReferralReferrerQualifiedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerQualifiedEmail |
 | `CreateTransactionalEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionalEmail |
 | `SendDirectDebitCreatedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail |
+| `SendDirectDebitFailedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail |
 | `SendDirectDebitSetupConfirmationEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail |
 | `SendRefundTransactionEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendRefundTransactionEmail |
 | `SendTlosNinjaCaseEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendTlosNinjaCaseEmail |

package/dist/actions-v2/SendDirectDebitCreatedEmailDto.d.ts

@@ -23,7 +23,7 @@ export interface SendDirectDebitCreatedEmailMessage extends OdinRecordCreatedEve
  * Properties for SendDirectDebitCreatedEmail action
  *
  * @property Required fields: 0
- * @property Optional fields: 7
+ * @property Optional fields: 8
  */
 export interface SendDirectDebitCreatedEmailProperties {
     /**
@@ -75,6 +75,13 @@ export interface SendDirectDebitCreatedEmailProperties {
      * @type {JSON}
      */
     DynamicData?: string | null;
+    /**
+     * Title
+     *
+     * Used for title
+     * @type {TEXT}
+     */
+    Title?: string | null;
 }
 /**
  * SendDirectDebitCreatedEmail

package/dist/actions-v2/SendDirectDebitFailedEmailDto.d.ts

@@ -0,0 +1,121 @@
+/**
+ * SendDirectDebitFailedEmail Action DTO
+ *
+ * Send Email when Payment method setup failed
+ *
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL
+ * @actionKey SendDirectDebitFailedEmail
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for SendDirectDebitFailedEmail created events
+ *
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail
+ */
+export interface SendDirectDebitFailedEmailMessage extends OdinRecordCreatedEvent<SendDirectDebitFailedEmailDto, SendDirectDebitFailedEmailProperties> {
+}
+/**
+ * Properties for SendDirectDebitFailedEmail action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 8
+ */
+export interface SendDirectDebitFailedEmailProperties {
+    /**
+     * Date
+     *
+     * Date field for Email records. Used by Communications team.
+     * @type {DATE_TIME}
+     */
+    Date?: string | null;
+    /**
+     * EmailingService
+     *
+     * The provider we use to send email (eg. Sendgrid)
+     * @type {ENUM}
+     */
+    EmailingService?: string | null;
+    /**
+     * ContactId
+     *
+     * The related Contact to send the email
+     * @type {LOOKUP}
+     */
+    ContactId?: string | null;
+    /**
+     * TemplateLabel
+     *
+     * The template label from email templates engine
+     * @type {TEXT}
+     */
+    TemplateLabel?: string | null;
+    /**
+     * MessageId
+     *
+     * SMTP Message Id (Communications - Email)
+     * @type {TEXT}
+     */
+    MessageId?: string | null;
+    /**
+     * EmailSenderId
+     *
+     * The Email Sender related entity
+     * @type {LOOKUP}
+     */
+    EmailSenderId?: string | null;
+    /**
+     * DynamicData
+     *
+     * Data will pass to emailing service (variables)
+     * @type {JSON}
+     */
+    DynamicData?: string | null;
+    /**
+     * Title
+     *
+     * Used for title
+     * @type {TEXT}
+     */
+    Title?: string | null;
+}
+/**
+ * SendDirectDebitFailedEmail
+ *
+ * Send Email when Payment method setup failed
+ *
+ * @actionType CREATE - Creates a new Email record
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail
+ * @permission schema.action.senddirectdebitfailedemail.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class SendDirectDebitFailedEmailDto extends OdinRecordCreateDto<SendDirectDebitFailedEmailProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "SendDirectDebitFailedEmail";
+    static readonly MODULE_NAME = "NotificationModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "TRANSACTIONAL";
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail";
+    static readonly PERMISSION = "schema.action.senddirectdebitfailedemail.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "NotificationModule:Email";
+    static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
+    static readonly STEP_SCHEMA_ACTION_ID = "3e331ae2-76ac-49a5-9759-ecbb9cde0da0";
+    static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
+    static readonly STEP_TYPE = "TRANSACTIONAL";
+    static readonly AUTO_LINK_PARENT = true;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(properties: SendDirectDebitFailedEmailProperties, options?: {
+        journeyId?: string;
+    });
+}

package/dist/actions-v2/SendDirectDebitFailedEmailDto.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * SendDirectDebitFailedEmail Action DTO
+ *
+ * Send Email when Payment method setup failed
+ *
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL
+ * @actionKey SendDirectDebitFailedEmail
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SendDirectDebitFailedEmailDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * SendDirectDebitFailedEmail
+ *
+ * Send Email when Payment method setup failed
+ *
+ * @actionType CREATE - Creates a new Email record
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail
+ * @permission schema.action.senddirectdebitfailedemail.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class SendDirectDebitFailedEmailDto extends core_1.OdinRecordCreateDto {
+    constructor(properties, options) {
+        super({
+            entity: 'NotificationModule:Email',
+            type: 'TRANSACTIONAL',
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'SendDirectDebitFailedEmail';
+        this.schemaActionId = '3e331ae2-76ac-49a5-9759-ecbb9cde0da0';
+        this.entity = 'NotificationModule:Email';
+    }
+}
+exports.SendDirectDebitFailedEmailDto = SendDirectDebitFailedEmailDto;
+/** Used by SDK generators to identify action type */
+SendDirectDebitFailedEmailDto.ACTION_TYPE = 'CREATE';
+SendDirectDebitFailedEmailDto.ACTION_KEY = 'SendDirectDebitFailedEmail';
+SendDirectDebitFailedEmailDto.MODULE_NAME = 'NotificationModule';
+SendDirectDebitFailedEmailDto.ENTITIES = ['Email'];
+SendDirectDebitFailedEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
+SendDirectDebitFailedEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail';
+SendDirectDebitFailedEmailDto.PERMISSION = 'schema.action.senddirectdebitfailedemail.trigger';
+/** Step metadata - entity this action targets */
+SendDirectDebitFailedEmailDto.STEP_ENTITY = 'NotificationModule:Email';
+SendDirectDebitFailedEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
+SendDirectDebitFailedEmailDto.STEP_SCHEMA_ACTION_ID = '3e331ae2-76ac-49a5-9759-ecbb9cde0da0';
+SendDirectDebitFailedEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
+SendDirectDebitFailedEmailDto.STEP_TYPE = 'TRANSACTIONAL';
+SendDirectDebitFailedEmailDto.AUTO_LINK_PARENT = true;

package/dist/actions-v2/SendDirectDebitSetupConfirmationEmailDto.d.ts

@@ -23,7 +23,7 @@ export interface SendDirectDebitSetupConfirmationEmailMessage extends OdinRecord
  * Properties for SendDirectDebitSetupConfirmationEmail action
  *
  * @property Required fields: 0
- * @property Optional fields: 7
+ * @property Optional fields: 8
  */
 export interface SendDirectDebitSetupConfirmationEmailProperties {
     /**
@@ -75,6 +75,13 @@ export interface SendDirectDebitSetupConfirmationEmailProperties {
      * @type {JSON}
      */
     DynamicData?: string | null;
+    /**
+     * Title
+     *
+     * Used for title
+     * @type {TEXT}
+     */
+    Title?: string | null;
 }
 /**
  * SendDirectDebitSetupConfirmationEmail

package/dist/actions-v2/SendRefundTransactionEmailDto.d.ts

@@ -22,7 +22,7 @@ export interface SendRefundTransactionEmailMessage extends OdinRecordCreatedEven
  * Properties for SendRefundTransactionEmail action
  *
  * @property Required fields: 0
- * @property Optional fields: 7
+ * @property Optional fields: 8
  */
 export interface SendRefundTransactionEmailProperties {
     /**
@@ -74,6 +74,13 @@ export interface SendRefundTransactionEmailProperties {
      * @type {JSON}
      */
     DynamicData?: string | null;
+    /**
+     * Title
+     *
+     * Used for title
+     * @type {TEXT}
+     */
+    Title?: string | null;
 }
 /**
  * SendRefundTransactionEmail

package/dist/api-sdk-v2/FileApi.d.ts

@@ -17,131 +17,131 @@ export declare class FileApi extends ApiProvider {
     private readonly moduleName;
     private readonly entityName;
     private sourceRecord;
-    private _servicevisitaudit?;
-    private _blockagea55?;
-    private _netomniaftth2stageinstallaudit?;
-    private _netomniaftth1stageinstallaudit?;
-    private _overlayreala55?;
-    private _appointment?;
-    private _ugexternalaudit?;
-    private _billingrequest?;
-    private _transaction?;
-    private _creditnote?;
-    private _address?;
-    private _changereason?;
-    private _discount?;
-    private _paymentmethodrefund?;
-    private _serviceappointment?;
-    private _customerdevicerouter?;
-    private _visit?;
-    private _fingerprint?;
-    private _yftoolaudit?;
-    private _wayleaveaudit?;
-    private _workorder?;
-    private _orderitem?;
-    private _internalinstallaudit?;
-    private _knowledgearticle?;
-    private _case?;
-    private _activity?;
-    private _netomniaftthservicevisitsheet?;
-    private _yfstockcount?;
-    private _onetouchswitch?;
-    private _remediationrequiredreason?;
-    private _invoice?;
-    private _yfvanaudit?;
-    private _uginstallationaudit?;
-    private _ohinstallationaudit?;
-    private _ugauditofinstallation?;
-    private _file__note?;
+    private _servicevisitaudit__file?;
+    private _blockagea55_file?;
+    private _netomniaftth2stageinstallaudit__file?;
+    private _netomniaftth1stageinstallaudit__file?;
+    private _overlayreala55_file?;
+    private _appointment__file?;
+    private _ugexternalaudit_file?;
+    private _billingrequest__file?;
+    private _transaction__file?;
+    private _creditnote__file?;
+    private _address__file?;
+    private _changereason__file?;
+    private _discount__file?;
+    private _paymentmethodrefund__file?;
+    private _serviceappointment__file?;
+    private _customerdevicerouter__file?;
+    private _visit__file?;
+    private _fingerprint__file?;
+    private _yftoolaudit_file?;
+    private _wayleaveaudit_file?;
+    private _workorder__file?;
+    private _orderitem__file?;
+    private _internalinstallaudit_file?;
+    private _knowledgearticle__file?;
+    private _case__file?;
+    private _activity__file?;
+    private _netomniaftthservicevisitsheet__file?;
+    private _yfstockcount__file?;
+    private _onetouchswitch_file?;
+    private _remediationrequiredreason__file?;
+    private _invoice__file?;
+    private _yfvanaudit_file?;
+    private _uginstallationaudit__file?;
+    private _ohinstallationaudit__file?;
+    private _ugauditofinstallation__file?;
     private _note__file?;
-    private _yfequipmentcollection?;
-    private _lead?;
-    private _account?;
-    private _paymentmethod?;
-    private _sweepermaintenanceaudit?;
-    private _blockagereporta55?;
-    private _ohauditofinstallation?;
-    private _ohinprogressaudit?;
-    private _contractbuyout?;
-    private _sitespecificriskassessmentoutcomeform?;
-    private _remediationoutcomeform?;
-    private _order?;
-    private _call?;
-    private _ohexternalaudit?;
-    private _customerdeviceont?;
-    private _yffieldservicevisit?;
-    private _billingadjustment?;
-    private _contact?;
-    private _message?;
-    private _netomniainstallverification?;
-    private _email?;
-    private _ugretroaudit?;
-    private _ohretroaudit?;
-    private _uginprogressaudit?;
-    private _pgdirectdebitfile?;
+    private _yfequipmentcollection__file?;
+    private _lead__file?;
+    private _account__file?;
+    private _paymentmethod__file?;
+    private _sweepermaintenanceaudit__file?;
+    private _blockagereporta55__file?;
+    private _ohauditofinstallation__file?;
+    private _ohinprogressaudit_file?;
+    private _contractbuyout__file?;
+    private _sitespecificriskassessmentoutcomeform__file?;
+    private _remediationoutcomeform_file?;
+    private _order__file?;
+    private _call__file?;
+    private _ohexternalaudit_file?;
+    private _customerdeviceont__file?;
+    private _yffieldservicevisit__file?;
+    private _billingadjustment__file?;
+    private _contact__file?;
+    private _message_file?;
+    private _netomniainstallverification__file?;
+    private _attachments?;
+    private _ugretroaudit__file?;
+    private _ohretroaudit__file?;
+    private _uginprogressaudit_file?;
+    private _pgdirectdebitfile__file?;
+    private _note?;
     constructor(authParams?: OauthParams, authToken?: string);
-    get servicevisitaudit(): ApiRecordLinkManager;
-    get blockagea55(): ApiRecordLinkManager;
-    get netomniaftth2stageinstallaudit(): ApiRecordLinkManager;
-    get netomniaftth1stageinstallaudit(): ApiRecordLinkManager;
-    get overlayreala55(): ApiRecordLinkManager;
-    get appointment(): ApiRecordLinkManager;
-    get ugexternalaudit(): ApiRecordLinkManager;
-    get billingrequest(): ApiRecordLinkManager;
-    get transaction(): ApiRecordLinkManager;
-    get creditnote(): ApiRecordLinkManager;
-    get address(): ApiRecordLinkManager;
-    get changereason(): ApiRecordLinkManager;
-    get discount(): ApiRecordLinkManager;
-    get paymentmethodrefund(): ApiRecordLinkManager;
-    get serviceappointment(): ApiRecordLinkManager;
-    get customerdevicerouter(): ApiRecordLinkManager;
-    get visit(): ApiRecordLinkManager;
-    get fingerprint(): ApiRecordLinkManager;
-    get yftoolaudit(): ApiRecordLinkManager;
-    get wayleaveaudit(): ApiRecordLinkManager;
-    get workorder(): ApiRecordLinkManager;
-    get orderitem(): ApiRecordLinkManager;
-    get internalinstallaudit(): ApiRecordLinkManager;
-    get knowledgearticle(): ApiRecordLinkManager;
-    get case(): ApiRecordLinkManager;
-    get activity(): ApiRecordLinkManager;
-    get netomniaftthservicevisitsheet(): ApiRecordLinkManager;
-    get yfstockcount(): ApiRecordLinkManager;
-    get onetouchswitch(): ApiRecordLinkManager;
-    get remediationrequiredreason(): ApiRecordLinkManager;
-    get invoice(): ApiRecordLinkManager;
-    get yfvanaudit(): ApiRecordLinkManager;
-    get uginstallationaudit(): ApiRecordLinkManager;
-    get ohinstallationaudit(): ApiRecordLinkManager;
-    get ugauditofinstallation(): ApiRecordLinkManager;
-    get file__note(): ApiRecordLinkManager;
+    get servicevisitaudit__file(): ApiRecordLinkManager;
+    get blockagea55_file(): ApiRecordLinkManager;
+    get netomniaftth2stageinstallaudit__file(): ApiRecordLinkManager;
+    get netomniaftth1stageinstallaudit__file(): ApiRecordLinkManager;
+    get overlayreala55_file(): ApiRecordLinkManager;
+    get appointment__file(): ApiRecordLinkManager;
+    get ugexternalaudit_file(): ApiRecordLinkManager;
+    get billingrequest__file(): ApiRecordLinkManager;
+    get transaction__file(): ApiRecordLinkManager;
+    get creditnote__file(): ApiRecordLinkManager;
+    get address__file(): ApiRecordLinkManager;
+    get changereason__file(): ApiRecordLinkManager;
+    get discount__file(): ApiRecordLinkManager;
+    get paymentmethodrefund__file(): ApiRecordLinkManager;
+    get serviceappointment__file(): ApiRecordLinkManager;
+    get customerdevicerouter__file(): ApiRecordLinkManager;
+    get visit__file(): ApiRecordLinkManager;
+    get fingerprint__file(): ApiRecordLinkManager;
+    get yftoolaudit_file(): ApiRecordLinkManager;
+    get wayleaveaudit_file(): ApiRecordLinkManager;
+    get workorder__file(): ApiRecordLinkManager;
+    get orderitem__file(): ApiRecordLinkManager;
+    get internalinstallaudit_file(): ApiRecordLinkManager;
+    get knowledgearticle__file(): ApiRecordLinkManager;
+    get case__file(): ApiRecordLinkManager;
+    get activity__file(): ApiRecordLinkManager;
+    get netomniaftthservicevisitsheet__file(): ApiRecordLinkManager;
+    get yfstockcount__file(): ApiRecordLinkManager;
+    get onetouchswitch_file(): ApiRecordLinkManager;
+    get remediationrequiredreason__file(): ApiRecordLinkManager;
+    get invoice__file(): ApiRecordLinkManager;
+    get yfvanaudit_file(): ApiRecordLinkManager;
+    get uginstallationaudit__file(): ApiRecordLinkManager;
+    get ohinstallationaudit__file(): ApiRecordLinkManager;
+    get ugauditofinstallation__file(): ApiRecordLinkManager;
     get note__file(): ApiRecordLinkManager;
-    get yfequipmentcollection(): ApiRecordLinkManager;
-    get lead(): ApiRecordLinkManager;
-    get account(): ApiRecordLinkManager;
-    get paymentmethod(): ApiRecordLinkManager;
-    get sweepermaintenanceaudit(): ApiRecordLinkManager;
-    get blockagereporta55(): ApiRecordLinkManager;
-    get ohauditofinstallation(): ApiRecordLinkManager;
-    get ohinprogressaudit(): ApiRecordLinkManager;
-    get contractbuyout(): ApiRecordLinkManager;
-    get sitespecificriskassessmentoutcomeform(): ApiRecordLinkManager;
-    get remediationoutcomeform(): ApiRecordLinkManager;
-    get order(): ApiRecordLinkManager;
-    get call(): ApiRecordLinkManager;
-    get ohexternalaudit(): ApiRecordLinkManager;
-    get customerdeviceont(): ApiRecordLinkManager;
-    get yffieldservicevisit(): ApiRecordLinkManager;
-    get billingadjustment(): ApiRecordLinkManager;
-    get contact(): ApiRecordLinkManager;
-    get message(): ApiRecordLinkManager;
-    get netomniainstallverification(): ApiRecordLinkManager;
-    get email(): ApiRecordLinkManager;
-    get ugretroaudit(): ApiRecordLinkManager;
-    get ohretroaudit(): ApiRecordLinkManager;
-    get uginprogressaudit(): ApiRecordLinkManager;
-    get pgdirectdebitfile(): ApiRecordLinkManager;
+    get yfequipmentcollection__file(): ApiRecordLinkManager;
+    get lead__file(): ApiRecordLinkManager;
+    get account__file(): ApiRecordLinkManager;
+    get paymentmethod__file(): ApiRecordLinkManager;
+    get sweepermaintenanceaudit__file(): ApiRecordLinkManager;
+    get blockagereporta55__file(): ApiRecordLinkManager;
+    get ohauditofinstallation__file(): ApiRecordLinkManager;
+    get ohinprogressaudit_file(): ApiRecordLinkManager;
+    get contractbuyout__file(): ApiRecordLinkManager;
+    get sitespecificriskassessmentoutcomeform__file(): ApiRecordLinkManager;
+    get remediationoutcomeform_file(): ApiRecordLinkManager;
+    get order__file(): ApiRecordLinkManager;
+    get call__file(): ApiRecordLinkManager;
+    get ohexternalaudit_file(): ApiRecordLinkManager;
+    get customerdeviceont__file(): ApiRecordLinkManager;
+    get yffieldservicevisit__file(): ApiRecordLinkManager;
+    get billingadjustment__file(): ApiRecordLinkManager;
+    get contact__file(): ApiRecordLinkManager;
+    get message_file(): ApiRecordLinkManager;
+    get netomniainstallverification__file(): ApiRecordLinkManager;
+    get attachments(): ApiRecordLinkManager;
+    get ugretroaudit__file(): ApiRecordLinkManager;
+    get ohretroaudit__file(): ApiRecordLinkManager;
+    get uginprogressaudit_file(): ApiRecordLinkManager;
+    get pgdirectdebitfile__file(): ApiRecordLinkManager;
+    get note(): ApiRecordLinkManager;
     setRecord(sourceRecord: any): void;
     schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
     search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<FileProperties>>>;