@d19n/youfibre-odin-sdk 1.0.1

package/dist/entities-v1/Lead.d.ts

@@ -0,0 +1,157 @@
+import { OdinPipelineStage, OdinGroup, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+import { OrganizationProperties } from './Organization';
+import { OfferProperties } from './Offer';
+import { DiscountProperties } from './Discount';
+import { NoteProperties } from './Note';
+import { AddressProperties } from './Address';
+import { ProductProperties } from './Product';
+import { ContactProperties } from './Contact';
+import { CommissionProperties } from './Commission';
+import { FileProperties } from './File';
+import { WorkOrderProperties } from './WorkOrder';
+import { CrmDatasetProperties } from './CrmDataset';
+import { OrderProperties } from './Order';
+import { VisitProperties } from './Visit';
+import { AppointmentProperties } from './Appointment';
+import { CallProperties } from './Call';
+import { FingerprintProperties } from './Fingerprint';
+export declare enum LeadEntityTypes {
+    DEFAULT = "DEFAULT"
+}
+export declare enum Type {
+    'BUSINESS' = "BUSINESS",
+    'LANDLORD' = "LANDLORD",
+    'RESIDENTIAL' = "RESIDENTIAL"
+}
+export declare enum Source {
+    'COMMUNITY_TEAM' = "COMMUNITY_TEAM",
+    'FACEBOOK' = "FACEBOOK",
+    'FIELD_SALES' = "FIELDSALES",
+    'GBVS' = "GBVS",
+    'NETOMNIA' = "NETOMNIA",
+    'PHONE' = "PHONE",
+    'REFERRAL' = "REFERRAL",
+    'SALES_APP' = "SALES_APP",
+    'TELE_SALES' = "TELESALES",
+    'TIME_TO_SWITCH' = "TIME_TO_SWITCH",
+    'TWITTER' = "TWITTER",
+    'WEBSITE' = "WEBSITE"
+}
+export declare enum Visit {
+    'IN_CONTRACT' = "IN_CONTRACT",
+    'INTERESTED' = "INTERESTED",
+    'NOT_INTERESTED' = "NOT_INTERESTED"
+}
+export declare enum LeadPropertyKeys {
+    Type = "Type",
+    Source = "Source",
+    Name = "Name",
+    UtmSource = "UtmSource",
+    UtmMedium = "UtmMedium",
+    UtmCampaign = "UtmCampaign",
+    UtmTerm = "UtmTerm",
+    UtmContent = "UtmContent",
+    UTRNumber = "UTRNumber",
+    CompanyPosition = "CompanyPosition",
+    CompanyName = "CompanyName",
+    VAT = "VAT",
+    CurrentSpeed = "CurrentSpeed",
+    DateOfConsent = "DateOfConsent",
+    DS_Status = "DS_Status",
+    CallCount = "CallCount",
+    LandingPage = "LandingPage",
+    Latitude = "Latitude",
+    DataSetId = "DataSetId",
+    Longitude = "Longitude",
+    ConnexContactId = "ConnexContactId",
+    FirstName = "FirstName",
+    AcceptingInstalls = "AcceptingInstalls",
+    IsPhoneNumberValid = "IsPhoneNumberValid",
+    TotalValue = "TotalValue",
+    Visit = "Visit",
+    EmailAddress = "EmailAddress",
+    LastName = "LastName",
+    IsHot = "IsHot",
+    Comment = "Comment"
+}
+export interface LeadProperties {
+    Type: Type;
+    Source: Source;
+    Name: string;
+    UtmSource: string;
+    UtmMedium: string;
+    UtmCampaign: string;
+    UtmTerm: string;
+    UtmContent: string;
+    UTRNumber: string;
+    CompanyPosition: string;
+    CompanyName: string;
+    VAT: number;
+    CurrentSpeed: number;
+    DateOfConsent: Date;
+    DS_Status: string;
+    CallCount: number;
+    LandingPage: string;
+    Latitude: string;
+    DataSetId: string;
+    Longitude: string;
+    ConnexContactId: string;
+    FirstName: string;
+    AcceptingInstalls: boolean;
+    IsPhoneNumberValid: boolean;
+    TotalValue: number;
+    Visit: Visit;
+    EmailAddress: string;
+    LastName: string;
+    IsHot: boolean;
+    Comment: string;
+}
+export interface Lead {
+    id: string;
+    title: string;
+    recordNumber: string;
+    entity: 'CrmModule:Lead';
+    type: LeadEntityTypes;
+    schemaTypeId: string;
+    schemaId: 'dc2440a6-651a-4013-aaaa-c54535873075';
+    externalId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date;
+    stageUpdatedAt: Date;
+    createdBy: {
+        id: string;
+        fullName: string;
+    };
+    lastModifiedBy: {
+        id: string;
+        fullName: string;
+    };
+    stage: OdinPipelineStage;
+    formattedProperties: Record<string, any>;
+    groups: OdinGroup[];
+    isArchived: boolean;
+    isLocked: boolean;
+    links: {
+        id: string;
+        title: string[];
+        entity: string;
+    };
+    properties: LeadProperties;
+    Organization: OdinLink<LinkedOdinRecord<OrganizationProperties>>;
+    Offer: OdinLink<LinkedOdinRecord<OfferProperties>>;
+    Discount: OdinLink<LinkedOdinRecord<DiscountProperties>>;
+    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
+    Address: OdinLink<LinkedOdinRecord<AddressProperties>>;
+    Product: OdinLink<LinkedOdinRecord<ProductProperties>>;
+    Contact: OdinLink<LinkedOdinRecord<ContactProperties>>;
+    Commission: OdinLink<LinkedOdinRecord<CommissionProperties>>;
+    File: OdinLink<LinkedOdinRecord<FileProperties>>;
+    WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>;
+    CrmDataset: OdinLink<LinkedOdinRecord<CrmDatasetProperties>>;
+    Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
+    Visit: OdinLink<LinkedOdinRecord<VisitProperties>>;
+    Appointment: OdinLink<LinkedOdinRecord<AppointmentProperties>>;
+    Call: OdinLink<LinkedOdinRecord<CallProperties>>;
+    Fingerprint: OdinLink<LinkedOdinRecord<FingerprintProperties>>;
+}

package/dist/entities-v1/Lead.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeadPropertyKeys = exports.Visit = exports.Source = exports.Type = exports.LeadEntityTypes = void 0;
+var LeadEntityTypes;
+(function (LeadEntityTypes) {
+    LeadEntityTypes["DEFAULT"] = "DEFAULT";
+})(LeadEntityTypes || (exports.LeadEntityTypes = LeadEntityTypes = {}));
+var Type;
+(function (Type) {
+    Type["BUSINESS"] = "BUSINESS";
+    Type["LANDLORD"] = "LANDLORD";
+    Type["RESIDENTIAL"] = "RESIDENTIAL";
+})(Type || (exports.Type = Type = {}));
+var Source;
+(function (Source) {
+    Source["COMMUNITY_TEAM"] = "COMMUNITY_TEAM";
+    Source["FACEBOOK"] = "FACEBOOK";
+    Source["FIELD_SALES"] = "FIELDSALES";
+    Source["GBVS"] = "GBVS";
+    Source["NETOMNIA"] = "NETOMNIA";
+    Source["PHONE"] = "PHONE";
+    Source["REFERRAL"] = "REFERRAL";
+    Source["SALES_APP"] = "SALES_APP";
+    Source["TELE_SALES"] = "TELESALES";
+    Source["TIME_TO_SWITCH"] = "TIME_TO_SWITCH";
+    Source["TWITTER"] = "TWITTER";
+    Source["WEBSITE"] = "WEBSITE";
+})(Source || (exports.Source = Source = {}));
+var Visit;
+(function (Visit) {
+    Visit["IN_CONTRACT"] = "IN_CONTRACT";
+    Visit["INTERESTED"] = "INTERESTED";
+    Visit["NOT_INTERESTED"] = "NOT_INTERESTED";
+})(Visit || (exports.Visit = Visit = {}));
+var LeadPropertyKeys;
+(function (LeadPropertyKeys) {
+    LeadPropertyKeys["Type"] = "Type";
+    LeadPropertyKeys["Source"] = "Source";
+    LeadPropertyKeys["Name"] = "Name";
+    LeadPropertyKeys["UtmSource"] = "UtmSource";
+    LeadPropertyKeys["UtmMedium"] = "UtmMedium";
+    LeadPropertyKeys["UtmCampaign"] = "UtmCampaign";
+    LeadPropertyKeys["UtmTerm"] = "UtmTerm";
+    LeadPropertyKeys["UtmContent"] = "UtmContent";
+    LeadPropertyKeys["UTRNumber"] = "UTRNumber";
+    LeadPropertyKeys["CompanyPosition"] = "CompanyPosition";
+    LeadPropertyKeys["CompanyName"] = "CompanyName";
+    LeadPropertyKeys["VAT"] = "VAT";
+    LeadPropertyKeys["CurrentSpeed"] = "CurrentSpeed";
+    LeadPropertyKeys["DateOfConsent"] = "DateOfConsent";
+    LeadPropertyKeys["DS_Status"] = "DS_Status";
+    LeadPropertyKeys["CallCount"] = "CallCount";
+    LeadPropertyKeys["LandingPage"] = "LandingPage";
+    LeadPropertyKeys["Latitude"] = "Latitude";
+    LeadPropertyKeys["DataSetId"] = "DataSetId";
+    LeadPropertyKeys["Longitude"] = "Longitude";
+    LeadPropertyKeys["ConnexContactId"] = "ConnexContactId";
+    LeadPropertyKeys["FirstName"] = "FirstName";
+    LeadPropertyKeys["AcceptingInstalls"] = "AcceptingInstalls";
+    LeadPropertyKeys["IsPhoneNumberValid"] = "IsPhoneNumberValid";
+    LeadPropertyKeys["TotalValue"] = "TotalValue";
+    LeadPropertyKeys["Visit"] = "Visit";
+    LeadPropertyKeys["EmailAddress"] = "EmailAddress";
+    LeadPropertyKeys["LastName"] = "LastName";
+    LeadPropertyKeys["IsHot"] = "IsHot";
+    LeadPropertyKeys["Comment"] = "Comment";
+})(LeadPropertyKeys || (exports.LeadPropertyKeys = LeadPropertyKeys = {}));

package/dist/entities-v1/LeadCrmDataset.d.ts

@@ -0,0 +1,74 @@
+import { OdinPipelineStage, OdinGroup, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+import { LeadProperties } from './Lead';
+import { NoteProperties } from './Note';
+import { UserProperties } from './User';
+import { SalesTerritoryProperties } from './SalesTerritory';
+import { ExchangeProperties } from './Exchange';
+export declare enum Process {
+    'APPROVAL' = "APPROVAL",
+    'TASK' = "TASK"
+}
+export declare enum Category {
+    'DAILY' = "DAILY",
+    'TARGETED_COHORT' = "TARGETED_COHORT"
+}
+export declare enum LeadCrmDatasetPropertyKeys {
+    Process = "Process",
+    Description = "Description",
+    Category = "Category",
+    QueryFromDate = "QueryFromDate",
+    Region = "Region",
+    Exchange = "Exchange",
+    QueryToDate = "QueryToDate",
+    SalesTerritory = "SalesTerritory",
+    Owner = "Owner",
+    OwnerUserId = "OwnerUserId"
+}
+export interface LeadCrmDatasetProperties {
+    Process: Process;
+    Description: string;
+    Category: Category;
+    QueryFromDate: Date;
+    QueryToDate: Date;
+    SalesTerritory: string;
+    Owner: string;
+    OwnerUserId: string;
+}
+export interface LeadCrmDataset {
+    id: string;
+    title: string;
+    recordNumber: string;
+    entity: 'CrmModule:CrmDataset';
+    type: 'LEAD';
+    schemaTypeId: 'fe993c07-59a7-4050-937e-edf30ad01401';
+    schemaId: '3fd3d1bd-d685-48dc-b2b4-d052a71d1a52';
+    externalId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date;
+    stageUpdatedAt: Date;
+    createdBy: {
+        id: string;
+        fullName: string;
+    };
+    lastModifiedBy: {
+        id: string;
+        fullName: string;
+    };
+    stage: OdinPipelineStage;
+    formattedProperties: Record<string, any>;
+    groups: OdinGroup[];
+    isArchived: boolean;
+    isLocked: boolean;
+    links: {
+        id: string;
+        title: string[];
+        entity: string;
+    };
+    properties: LeadCrmDatasetProperties;
+    Lead: OdinLink<LinkedOdinRecord<LeadProperties>>;
+    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
+    User: OdinLink<LinkedOdinRecord<UserProperties>>;
+    SalesTerritory: OdinLink<LinkedOdinRecord<SalesTerritoryProperties>>;
+    Exchange: OdinLink<LinkedOdinRecord<ExchangeProperties>>;
+}

package/dist/entities-v1/LeadCrmDataset.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeadCrmDatasetPropertyKeys = exports.Category = exports.Process = void 0;
+var Process;
+(function (Process) {
+    Process["APPROVAL"] = "APPROVAL";
+    Process["TASK"] = "TASK";
+})(Process || (exports.Process = Process = {}));
+var Category;
+(function (Category) {
+    Category["DAILY"] = "DAILY";
+    Category["TARGETED_COHORT"] = "TARGETED_COHORT";
+})(Category || (exports.Category = Category = {}));
+var LeadCrmDatasetPropertyKeys;
+(function (LeadCrmDatasetPropertyKeys) {
+    LeadCrmDatasetPropertyKeys["Process"] = "Process";
+    LeadCrmDatasetPropertyKeys["Description"] = "Description";
+    LeadCrmDatasetPropertyKeys["Category"] = "Category";
+    LeadCrmDatasetPropertyKeys["QueryFromDate"] = "QueryFromDate";
+    LeadCrmDatasetPropertyKeys["Region"] = "Region";
+    LeadCrmDatasetPropertyKeys["Exchange"] = "Exchange";
+    LeadCrmDatasetPropertyKeys["QueryToDate"] = "QueryToDate";
+    LeadCrmDatasetPropertyKeys["SalesTerritory"] = "SalesTerritory";
+    LeadCrmDatasetPropertyKeys["Owner"] = "Owner";
+    LeadCrmDatasetPropertyKeys["OwnerUserId"] = "OwnerUserId";
+})(LeadCrmDatasetPropertyKeys || (exports.LeadCrmDatasetPropertyKeys = LeadCrmDatasetPropertyKeys = {}));

package/dist/entities-v1/LinearIssue.d.ts

@@ -0,0 +1,41 @@
+import { OdinPipelineStage, OdinGroup } from '@d19n/odin-types/dist/types/odin.types';
+export declare enum LinearIssueEntityTypes {
+    DEFAULT = "DEFAULT"
+}
+export declare enum LinearIssuePropertyKeys {
+}
+export interface LinearIssueProperties {
+}
+export interface LinearIssue {
+    id: string;
+    title: string;
+    recordNumber: string;
+    entity: 'SupportModule:LinearIssue';
+    type: LinearIssueEntityTypes;
+    schemaTypeId: string;
+    schemaId: 'c1515a7c-92fb-46b0-b950-6dc5e131a4cd';
+    externalId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date;
+    stageUpdatedAt: Date;
+    createdBy: {
+        id: string;
+        fullName: string;
+    };
+    lastModifiedBy: {
+        id: string;
+        fullName: string;
+    };
+    stage: OdinPipelineStage;
+    formattedProperties: Record<string, any>;
+    groups: OdinGroup[];
+    isArchived: boolean;
+    isLocked: boolean;
+    links: {
+        id: string;
+        title: string[];
+        entity: string;
+    };
+    properties: LinearIssueProperties;
+}

package/dist/entities-v1/LinearIssue.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinearIssuePropertyKeys = exports.LinearIssueEntityTypes = void 0;
+var LinearIssueEntityTypes;
+(function (LinearIssueEntityTypes) {
+    LinearIssueEntityTypes["DEFAULT"] = "DEFAULT";
+})(LinearIssueEntityTypes || (exports.LinearIssueEntityTypes = LinearIssueEntityTypes = {}));
+var LinearIssuePropertyKeys;
+(function (LinearIssuePropertyKeys) {
+})(LinearIssuePropertyKeys || (exports.LinearIssuePropertyKeys = LinearIssuePropertyKeys = {}));

package/dist/entities-v1/LosingOneTouchSwitch.d.ts

@@ -0,0 +1,86 @@
+import { OdinPipelineStage, OdinGroup, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+import { ActivityProperties } from './Activity';
+import { InvoiceProperties } from './Invoice';
+import { OrderProperties } from './Order';
+import { OrderItemProperties } from './OrderItem';
+import { AddressProperties } from './Address';
+import { ContactProperties } from './Contact';
+import { AccountProperties } from './Account';
+export declare enum LosingOneTouchSwitchPropertyKeys {
+    OrderItems = "OrderItems",
+    ETFValue = "ETFValue",
+    CustomerEmail = "CustomerEmail",
+    SwitchOrderReference = "SwitchOrderReference",
+    Services = "Services",
+    PlannedSwitchDate = "PlannedSwitchDate",
+    ActivationDate = "ActivationDate",
+    GainingRCPID = "GainingRCPID",
+    LosingRCPID = "LosingRCPID",
+    GainingCorrelationID = "GainingCorrelationID",
+    CustomerConsent = "CustomerConsent",
+    Status = "Status",
+    LosingCorrelationID = "LosingCorrelationID",
+    OrderId = "OrderId",
+    ContactId = "ContactId",
+    AccountId = "AccountId",
+    AddressId = "AddressId"
+}
+export interface LosingOneTouchSwitchProperties {
+    OrderItems: string;
+    ETFValue: number;
+    CustomerEmail: string;
+    SwitchOrderReference: string;
+    Services: string;
+    PlannedSwitchDate: Date;
+    ActivationDate: Date;
+    GainingRCPID: string;
+    LosingRCPID: string;
+    GainingCorrelationID: string;
+    CustomerConsent: boolean;
+    Status: string;
+    LosingCorrelationID: string;
+    OrderId: string;
+    ContactId: string;
+    AccountId: string;
+    AddressId: string;
+}
+export interface LosingOneTouchSwitch {
+    id: string;
+    title: string;
+    recordNumber: string;
+    entity: 'OrderModule:OneTouchSwitch';
+    type: 'LOSING';
+    schemaTypeId: '00f4700d-5470-42c1-820f-b8b47e3af0bc';
+    schemaId: '8f00032e-6041-402b-a06a-29389cf7df55';
+    externalId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date;
+    stageUpdatedAt: Date;
+    createdBy: {
+        id: string;
+        fullName: string;
+    };
+    lastModifiedBy: {
+        id: string;
+        fullName: string;
+    };
+    stage: OdinPipelineStage;
+    formattedProperties: Record<string, any>;
+    groups: OdinGroup[];
+    isArchived: boolean;
+    isLocked: boolean;
+    links: {
+        id: string;
+        title: string[];
+        entity: string;
+    };
+    properties: LosingOneTouchSwitchProperties;
+    Activity: OdinLink<LinkedOdinRecord<ActivityProperties>>;
+    Invoice: OdinLink<LinkedOdinRecord<InvoiceProperties>>;
+    Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
+    OrderItem: OdinLink<LinkedOdinRecord<OrderItemProperties>>;
+    Address: OdinLink<LinkedOdinRecord<AddressProperties>>;
+    Contact: OdinLink<LinkedOdinRecord<ContactProperties>>;
+    Account: OdinLink<LinkedOdinRecord<AccountProperties>>;
+}

package/dist/entities-v1/LosingOneTouchSwitch.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LosingOneTouchSwitchPropertyKeys = void 0;
+var LosingOneTouchSwitchPropertyKeys;
+(function (LosingOneTouchSwitchPropertyKeys) {
+    LosingOneTouchSwitchPropertyKeys["OrderItems"] = "OrderItems";
+    LosingOneTouchSwitchPropertyKeys["ETFValue"] = "ETFValue";
+    LosingOneTouchSwitchPropertyKeys["CustomerEmail"] = "CustomerEmail";
+    LosingOneTouchSwitchPropertyKeys["SwitchOrderReference"] = "SwitchOrderReference";
+    LosingOneTouchSwitchPropertyKeys["Services"] = "Services";
+    LosingOneTouchSwitchPropertyKeys["PlannedSwitchDate"] = "PlannedSwitchDate";
+    LosingOneTouchSwitchPropertyKeys["ActivationDate"] = "ActivationDate";
+    LosingOneTouchSwitchPropertyKeys["GainingRCPID"] = "GainingRCPID";
+    LosingOneTouchSwitchPropertyKeys["LosingRCPID"] = "LosingRCPID";
+    LosingOneTouchSwitchPropertyKeys["GainingCorrelationID"] = "GainingCorrelationID";
+    LosingOneTouchSwitchPropertyKeys["CustomerConsent"] = "CustomerConsent";
+    LosingOneTouchSwitchPropertyKeys["Status"] = "Status";
+    LosingOneTouchSwitchPropertyKeys["LosingCorrelationID"] = "LosingCorrelationID";
+    LosingOneTouchSwitchPropertyKeys["OrderId"] = "OrderId";
+    LosingOneTouchSwitchPropertyKeys["ContactId"] = "ContactId";
+    LosingOneTouchSwitchPropertyKeys["AccountId"] = "AccountId";
+    LosingOneTouchSwitchPropertyKeys["AddressId"] = "AddressId";
+})(LosingOneTouchSwitchPropertyKeys || (exports.LosingOneTouchSwitchPropertyKeys = LosingOneTouchSwitchPropertyKeys = {}));

package/dist/entities-v1/MandateBillingRequest.d.ts

@@ -0,0 +1,113 @@
+import { OdinPipelineStage, OdinGroup, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+import { ContactProperties } from './Contact';
+import { BillingRequestProperties } from './BillingRequest';
+import { FileProperties } from './File';
+import { ActivityProperties } from './Activity';
+import { NoteProperties } from './Note';
+import { TransactionProperties } from './Transaction';
+import { InvoiceProperties } from './Invoice';
+export declare enum CurrencyCode {
+    'GBP' = "GBP"
+}
+export declare enum Status {
+    'BANK_AUTHORISATION_AUTHORISED' = "BANK_AUTHORISATION_AUTHORISED",
+    'BANK_AUTHORIZATION_DENIED' = "BANK_AUTHORIZATION_DENIED",
+    'BANK_AUTHORIZATION_FAILED' = "BANK_AUTHORIZATION_FAILED",
+    'BANK_AUTHORIZATION_VISITED' = "BANK_AUTHORIZATION_VISITED",
+    'CANCELLED' = "CANCELLED",
+    'CHOOSE_CURRENCY' = "CHOOSE_CURRENCY",
+    'COLLECT_BANK_ACCOUNT' = "COLLECT_BANK_ACCOUNT",
+    'COLLECT_CUSTOMER_DETAILS' = "COLLECT_CUSTOMER_DETAILS",
+    'CREATED' = "CREATED",
+    'DRAFT' = "DRAFT",
+    'ERROR' = "ERROR",
+    'FLOW_CREATED' = "FLOW_CREATED",
+    'FLOW_VISITED' = "FLOW_VISITED",
+    'FULFILLED' = "FULFILLED",
+    'PAYER_DETAILS_CONFIRMED' = "PAYER_DETAILS_CONFIRMED",
+    'PENDING' = "PENDING",
+    'READY_TO_FULFIL' = "READY_TO_FULFIL",
+    'SELECT_INSTITUTION' = "SELECT_INSTITUTION"
+}
+export declare enum MandateBillingRequestPropertyKeys {
+    BRFExpiresAt = "BRFExpiresAt",
+    Description = "Description",
+    Amount = "Amount",
+    CurrencyCode = "CurrencyCode",
+    ExternalRef = "ExternalRef",
+    BRFExternalRef = "BRFExternalRef",
+    AuthorizationUrl = "AuthorizationUrl",
+    ErrorMessage = "ErrorMessage",
+    PMExternalRef = "PMExternalRef",
+    PRQExternalRef = "PRQExternalRef",
+    MRQExternalRef = "MRQExternalRef",
+    MDExternalRef = "MDExternalRef",
+    CUExternalRef = "CUExternalRef",
+    BAExternalRef = "BAExternalRef",
+    Status = "Status",
+    ContactName = "ContactName",
+    ContactEmailAddress = "ContactEmailAddress",
+    GCStatus = "GCStatus",
+    StatusUpdatedAt = "StatusUpdatedAt"
+}
+export interface MandateBillingRequestProperties {
+    BRFExpiresAt: Date;
+    Description: string;
+    Amount: number;
+    CurrencyCode: CurrencyCode;
+    ExternalRef: string;
+    BRFExternalRef: string;
+    AuthorizationUrl: string;
+    ErrorMessage: string;
+    PMExternalRef: string;
+    PRQExternalRef: string;
+    MRQExternalRef: string;
+    MDExternalRef: string;
+    CUExternalRef: string;
+    BAExternalRef: string;
+    Status: Status;
+    ContactName: string;
+    ContactEmailAddress: string;
+    GCStatus: string;
+    StatusUpdatedAt: Date;
+}
+export interface MandateBillingRequest {
+    id: string;
+    title: string;
+    recordNumber: string;
+    entity: 'BillingModule:BillingRequest';
+    type: 'MANDATE';
+    schemaTypeId: '32e0c6f8-0b1f-4c2a-968e-448d8dabb5a6';
+    schemaId: '37378f57-803b-430c-8d26-198b55580118';
+    externalId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date;
+    stageUpdatedAt: Date;
+    createdBy: {
+        id: string;
+        fullName: string;
+    };
+    lastModifiedBy: {
+        id: string;
+        fullName: string;
+    };
+    stage: OdinPipelineStage;
+    formattedProperties: Record<string, any>;
+    groups: OdinGroup[];
+    isArchived: boolean;
+    isLocked: boolean;
+    links: {
+        id: string;
+        title: string[];
+        entity: string;
+    };
+    properties: MandateBillingRequestProperties;
+    Contact: OdinLink<LinkedOdinRecord<ContactProperties>>;
+    BillingRequest: OdinLink<LinkedOdinRecord<BillingRequestProperties>>;
+    File: OdinLink<LinkedOdinRecord<FileProperties>>;
+    Activity: OdinLink<LinkedOdinRecord<ActivityProperties>>;
+    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
+    Transaction: OdinLink<LinkedOdinRecord<TransactionProperties>>;
+    Invoice: OdinLink<LinkedOdinRecord<InvoiceProperties>>;
+}

package/dist/entities-v1/MandateBillingRequest.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MandateBillingRequestPropertyKeys = exports.Status = exports.CurrencyCode = void 0;
+var CurrencyCode;
+(function (CurrencyCode) {
+    CurrencyCode["GBP"] = "GBP";
+})(CurrencyCode || (exports.CurrencyCode = CurrencyCode = {}));
+var Status;
+(function (Status) {
+    Status["BANK_AUTHORISATION_AUTHORISED"] = "BANK_AUTHORISATION_AUTHORISED";
+    Status["BANK_AUTHORIZATION_DENIED"] = "BANK_AUTHORIZATION_DENIED";
+    Status["BANK_AUTHORIZATION_FAILED"] = "BANK_AUTHORIZATION_FAILED";
+    Status["BANK_AUTHORIZATION_VISITED"] = "BANK_AUTHORIZATION_VISITED";
+    Status["CANCELLED"] = "CANCELLED";
+    Status["CHOOSE_CURRENCY"] = "CHOOSE_CURRENCY";
+    Status["COLLECT_BANK_ACCOUNT"] = "COLLECT_BANK_ACCOUNT";
+    Status["COLLECT_CUSTOMER_DETAILS"] = "COLLECT_CUSTOMER_DETAILS";
+    Status["CREATED"] = "CREATED";
+    Status["DRAFT"] = "DRAFT";
+    Status["ERROR"] = "ERROR";
+    Status["FLOW_CREATED"] = "FLOW_CREATED";
+    Status["FLOW_VISITED"] = "FLOW_VISITED";
+    Status["FULFILLED"] = "FULFILLED";
+    Status["PAYER_DETAILS_CONFIRMED"] = "PAYER_DETAILS_CONFIRMED";
+    Status["PENDING"] = "PENDING";
+    Status["READY_TO_FULFIL"] = "READY_TO_FULFIL";
+    Status["SELECT_INSTITUTION"] = "SELECT_INSTITUTION";
+})(Status || (exports.Status = Status = {}));
+var MandateBillingRequestPropertyKeys;
+(function (MandateBillingRequestPropertyKeys) {
+    MandateBillingRequestPropertyKeys["BRFExpiresAt"] = "BRFExpiresAt";
+    MandateBillingRequestPropertyKeys["Description"] = "Description";
+    MandateBillingRequestPropertyKeys["Amount"] = "Amount";
+    MandateBillingRequestPropertyKeys["CurrencyCode"] = "CurrencyCode";
+    MandateBillingRequestPropertyKeys["ExternalRef"] = "ExternalRef";
+    MandateBillingRequestPropertyKeys["BRFExternalRef"] = "BRFExternalRef";
+    MandateBillingRequestPropertyKeys["AuthorizationUrl"] = "AuthorizationUrl";
+    MandateBillingRequestPropertyKeys["ErrorMessage"] = "ErrorMessage";
+    MandateBillingRequestPropertyKeys["PMExternalRef"] = "PMExternalRef";
+    MandateBillingRequestPropertyKeys["PRQExternalRef"] = "PRQExternalRef";
+    MandateBillingRequestPropertyKeys["MRQExternalRef"] = "MRQExternalRef";
+    MandateBillingRequestPropertyKeys["MDExternalRef"] = "MDExternalRef";
+    MandateBillingRequestPropertyKeys["CUExternalRef"] = "CUExternalRef";
+    MandateBillingRequestPropertyKeys["BAExternalRef"] = "BAExternalRef";
+    MandateBillingRequestPropertyKeys["Status"] = "Status";
+    MandateBillingRequestPropertyKeys["ContactName"] = "ContactName";
+    MandateBillingRequestPropertyKeys["ContactEmailAddress"] = "ContactEmailAddress";
+    MandateBillingRequestPropertyKeys["GCStatus"] = "GCStatus";
+    MandateBillingRequestPropertyKeys["StatusUpdatedAt"] = "StatusUpdatedAt";
+})(MandateBillingRequestPropertyKeys || (exports.MandateBillingRequestPropertyKeys = MandateBillingRequestPropertyKeys = {}));