octopian-configuration-apis 1.0.0

package/src/modals/output-modals/GetDefaultConfigurationOutput.ts

@@ -0,0 +1,273 @@
+export interface GetDefaultConfigurationOutput {
+    GetCurrentUserPermissionOutputDto: GetCurrentUserPermissionOutputDto
+    StakeholderDtos: StakeholderDto[]
+    AttributeTypeDtos: AttributeTypeDto[]
+    PositionTypeDtos: PositionTypeDto[]
+    StepTypeDtos: StepTypeDto[]
+    AttributeSetDtos: AttributeSetDto[]
+    FormatTypeDtos: FormatTypeDto[]
+    RoleTypeDtos: RoleTypeDto[]
+    CompanyLanguageDtos: CompanyLanguageDto[]
+    IntegrationConnectionDtos: IntegrationConnectionDto[]
+    AttributeTypeValueTypeDtos: AttributeTypeValueTypeDto[]
+    CompanyEncryptionCertificateDtos: CompanyEncryptionCertificateDto[]
+    QuestionnaireTemplateDtos: QuestionnaireTemplateDto[]
+    GroupDtos: GroupDto[]
+    CloudPrinterDtos: CloudPrinterDto[]
+    AccountingBookTypeDtos: AccountingBookTypeDto[]
+    RequestStatusDtos: RequestStatusDto[]
+    CountryDtos: CountryDto[]
+    DefaultBlobs: any
+    DocumentCategoryDtos: any
+    RoleDtos: RoleDto[]
+    PriceBookTypeDtos: PriceBookTypeDto[]
+    UnitOfMeasureTypeDtos: UnitOfMeasureTypeDto[]
+    NotificationMessageDtos: NotificationMessageDto[]
+  }
+  
+  export interface GetCurrentUserPermissionOutputDto {
+    AllowAccessToOldPortal: boolean
+    IsReadOnlyPermision: boolean
+    RestrucitAccessToCustomPortal: boolean
+  }
+  
+  export interface StakeholderDto {
+    StakeholderId: number
+    Name: string
+    IsSystemGenerated: boolean
+    Translations?: string
+    Weight?: string
+    Alias: string
+    CompanyContextId?: number
+    CopyFromDefault: boolean
+    CopyAllDetails: boolean
+    IsDefaultContext: boolean
+    DtoState: number
+  }
+  
+  export interface AttributeTypeDto {
+    AttributeTypeId: number
+    FormatTypeId: number
+    AttributeTypeValueTypeId: number
+    IsIntegration: boolean
+    ReturnType: number
+    HideValue: boolean
+    HideLabel: boolean
+    HideImage: boolean
+    IsPicker: boolean
+    IsMultipleChoice: boolean
+    ShowInQuestionnaire: boolean
+    CustomRegex?: string
+    CustomHint?: string
+    CounterMinValue?: string
+    CounterMaxValue?: string
+    CounterStepValue?: string
+    OfflineSupport: boolean
+    OfflineFilePath?: string
+    IsPasswordMask: boolean
+    IsEncryptionEnabled: boolean
+    CompanyEncryptionCertificateId: any
+    AllowOthers: boolean
+    UseGridControl: boolean
+    UIControlAlias?: string
+    Name: string
+    FormatTypeName: string
+    Regex: string
+    Hint: string
+    FormatCategoryId: number
+    ClientFormatCategoryId: number
+    AttributeTypeValueTypeName: string
+    DtoState: number
+    FriendlyAttributeTypeValueTypeName: string
+    Translations: any
+    AttributeLength?: string
+    CustomHintTranslations: string
+  }
+  
+  export interface PositionTypeDto {
+    PositionTypeId: number
+    Name: string
+    Translations?: string
+    DtoState: number
+  }
+  
+  export interface StepTypeDto {
+    StepTypeId: number
+    Name: string
+    DtoState: number
+    Translations?: string
+  }
+  
+  export interface AttributeSetDto {
+    AttributeSetId: number
+    IsRecord: boolean
+    RecordContextAttributeId: any
+    Name: string
+    Translations?: string
+    DtoState: number
+  }
+  
+  export interface FormatTypeDto {
+    FormatTypeId: number
+    Regex: string
+    Hint: string
+    CategoryId: number
+    Name: string
+    DTOState: number
+  }
+  
+  export interface RoleTypeDto {
+    RoleTypeId: number
+    IsProvider: boolean
+    IsRequester: boolean
+    IsAgent: boolean
+    IsSystem: boolean
+    SystemName: string
+  }
+  
+  export interface CompanyLanguageDto {
+    CompanyLanguageId: number
+    LanguageId: number
+    Key: string
+    IsDefault: boolean
+    Name: string
+    Rtl: boolean
+    IsAutoTranslate: boolean
+    IsKeywordTranslationReady: boolean
+    IsCustomTranslationReady: boolean
+    IsDeletionReady: boolean
+    IsReTranslationReady: boolean
+    DtoState: number
+  }
+  
+  export interface IntegrationConnectionDto {
+    IntegrationConnectionId: number
+    Url: string
+    UserName?: string
+    Password: string
+    Name: string
+    DtoState: number
+  }
+  
+  export interface AttributeTypeValueTypeDto {
+    AttributeTypeValueTypeId: number
+    SystemName: string
+    Name: string
+  }
+  
+  export interface CompanyEncryptionCertificateDto {
+    CompanyEncryptionCertificateId: number
+    CertificateFilePath: string
+    FullCertificateFilePath: string
+    Alias: string
+    ExpiryDate: string
+    NotificationEmail: string
+    DtoState: number
+  }
+  
+  export interface QuestionnaireTemplateDto {
+    QuestionnaireTemplateId: number
+    Name: string
+    Translations?: string
+    QuestionnaireFilePath?: string
+    Weight: string
+    IsActive: boolean
+    IsChatbot?: boolean
+    ChatbotExtra?: string
+    DtoState: number
+  }
+  
+  export interface GroupDto {
+    GroupId: number
+    Name: string
+    SequenceNo: number
+    InteractorTypeId: number
+    Translations?: string
+    IsSystemGenerated: boolean
+    UiviewAlias?: string
+    DtoState: number
+  }
+  
+  export interface CloudPrinterDto {
+    CloudPrinterId: number
+    CloudAccountId: number
+    PrinterOriginalId: string
+    Name: string
+    Description: string
+    Proxy: string
+    DisplayName: string
+    Type: string
+    IsTosAccepted: boolean
+    DtoState: number
+  }
+  
+  export interface AccountingBookTypeDto {
+    AccountingBookTypeId: number
+    BookTypeId: number
+    Weight?: string
+    Description?: string
+    DescriptionTranslations?: string
+    Name: string
+    Translations?: string
+    DtoState: number
+  }
+  
+  export interface RequestStatusDto {
+    RequestStatusId: number
+    SystemName: string
+    IsClosed: boolean
+  }
+  
+  export interface CountryDto {
+    CountryId: number
+    Name: string
+    CountryIsoCode1: string
+    CountryIsoCode2: string
+    CountryCode: string
+    DtoState: number
+  }
+  
+  export interface RoleDto {
+    RoleId: number
+    Name: string
+    RoleTypeId: number
+    IsDerived: boolean
+    IsSystemGenerated: boolean
+    IsRequester: boolean
+    IsAgent: boolean
+    IsProvider: boolean
+    IsSystem: boolean
+    InteractorTypeId: number
+    ObjectId?: number
+    SystemName: string
+    Translations?: string
+    UiviewAlias: any
+    DtoState: number
+  }
+  
+  export interface PriceBookTypeDto {
+    PriceBookTypeId: number
+    Name: string
+    DtoState: number
+    Translations: string
+    Details: string
+  }
+  
+  export interface UnitOfMeasureTypeDto {
+    UnitOfMeasureTypeId: number
+    Name: string
+    DtoState: number
+    Translations: string
+    Details: string
+  }
+  
+  export interface NotificationMessageDto {
+    NotificationMessageId: number
+    CompanyId: number
+    NotificationMessageTypeId: number
+    Name: string
+    StepActionId: number
+    DtoState: number
+    Message: string
+  }
+  

package/src/modals/output-modals/GetDocumentTypesOutput.ts

@@ -0,0 +1,23 @@
+export interface GetDocumentTypesOutput
+{
+    DocumentTypeId: number;
+    Name: string;
+    InteractorTypeId: number;
+    DtoState: number;
+    DocumentSubTypeList: DocumentSubTypeDto[];
+    Translations: string;
+}
+
+export interface DocumentSubTypeDto
+{
+    DocumentSubTypeId: number;
+    DocumentTypeId: number;
+    Name: string;
+    DocumentSuperiorManagerRoleId: number;
+    DocumentDirectManagerRoleId: number;
+    DtoState: number;
+    Translations: string;
+    AttributeSetId: number;
+    DocumentSuperiorManagerRoleName: string;
+    DocumentDirectManagerRoleName: string;
+}

package/src/modals/output-modals/GetInteractorListOutput.ts

@@ -0,0 +1,81 @@
+export interface GetInteractorListOutput {
+    InteractorId: number
+    UnitId: number
+    FirstName: string
+    LastName: string
+    IsUser: boolean
+    FullName: string
+    Email: string
+    IsSystem: boolean
+    ImagePath: any
+    FullImagePath: string
+    IsSystemGenerated: boolean
+    Mobile: any
+    PersonalRoleId: number
+    Translations: any
+    QrimagePath: string
+    FullQrimagePath: any
+    ExternalId: any
+    BarcodeId: any
+    ExternalIdChanged: boolean
+    ExternalImagePath: any
+    GalleryImagesString: any
+    FullGalleryImagesString: any
+    BarcodeContent: any
+    BarcodeChanged: boolean
+    BarcodeFormatId: number
+    BarcodeImagePath: any
+    FullBarcodeImagePath: any
+    Qrid: string
+    IsPublicSearchEnabled: boolean
+    SearchCategory: any
+    SearchSubCategory: any
+    SearchTags: any
+    IbeaconId: any
+    Location: any
+    Rfidtags: any
+    GeoRange: any
+    GeoRangeUitype: any
+    GeoRangeUivalue: any
+    HasAssets: boolean
+    HasItems: boolean
+    DisableNotification: boolean
+    EnableIntegrationTracing: boolean
+    CloudPrinterId: any
+    IsCustomReceipt: boolean
+    CustomReceiptAlias: any
+    IsSocialUser: boolean
+    UserTypeId: number
+    WalletAddress: any
+    LinkedInteractorId: any
+    IsApiUser: any
+    ApiUserToken: any
+    DtoState: number
+    RowsCount: number
+    UnitName: any
+    InteractorTypeId: number
+    IsNewUser: boolean
+    Username: string
+    Password: any
+    SocialId: string
+    IsActive: boolean
+    IsSocialActive: boolean
+    UnitDto: any
+    AllowAccessToOldPortal: boolean
+    IsReadOnlyPermision: boolean
+    RestrucitAccessToCustomPortal: boolean
+    IsInteractorMailActivationRequired: boolean
+    MailActivationId: any
+    IsInteractorSmsActivationRequired: boolean
+    SmsActivationId: any
+    SocialDetails: any
+    IsTraceable: boolean
+    IsLiveLocation: boolean
+    IsDemand: boolean
+    IsSupply: boolean
+    CopyPasswordToKeyVault: boolean
+    OpenPgppublicKey: any
+    SearchTextConcat: any
+    PrivilegeLevel: number
+    DeploymentEnvironment: string
+  }

package/src/modals/output-modals/GetInteractorTypeListOutput.ts

@@ -0,0 +1,59 @@
+export interface GetInteractorTypeListOutput {
+    InteractorTypeId: number
+    Name: string
+    IsDefault: boolean
+    Translations?: string
+    IsPublicRegistrationEnabled: boolean
+    StakeholderId: number
+    IsMailActivationRequired: boolean
+    IsSmsactivationRequired: boolean
+    IsAnonymousUserEnabled: boolean
+    OfflineShortcutServiceListFilePath?: string
+    FullOfflineShortcutServiceListFilePath: string
+    IsRestrictedToCustomApp: boolean
+    IsExternalIdrequired: boolean
+    OfflineAnonymousCatalogFilePath?: string
+    FullOfflineAnonymousCatalogFilePath: string
+    IsCreateDefaultAssetSubGroup: boolean
+    IsCreateDefaultItemSubGroup: boolean
+    DefaultAssetGroupId?: number
+    DefaultItemGroupId?: number
+    IsAutoFollowAsset: boolean
+    IsAutoFollowItem: boolean
+    IsAutoAddRole: boolean
+    LastAnonymousExportFilePath: any
+    FullLastAnonymousExportFilePath: string
+    DefaultAssetList?: string
+    DefaultAssetSubGroupAttributeSetId?: number
+    DefaultItemSubGroupAttributeSetId?: number
+    DefaultItemList?: string
+    LastIndivitiualFilesExportFilePath: any
+    FullLastIndivitiualFilesExportFilePath: string
+    Weight: string
+    Alias: string
+    IsInterDomainAuthentication: boolean
+    InterDomainAuthenticationName?: string
+    InterDomainAuthenticationUserId?: number
+    Uitemplate?: string
+    EnableAdvancedSecurity?: boolean
+    WalletSessionsDefaultAzureConnection?: string
+    EnforceSingleLogin?: boolean
+    SessionTimeoutInMinutes: any
+    AttributeSetId: any
+    IsTraceable: any
+    IsDemand: any
+    IsSupply: any
+    IsLiveLocation: any
+    IsPublicSearchEnabled: any
+    DefaultNewWallet?: boolean
+    GPTModel?: string
+    GPTStyle?: string
+    GPTPrompt?: string
+    GPTIntentionList?: string
+    IsPrivate?: boolean
+    OpenPgppublicKey: any
+    PrivilegeLevel: number
+    DtoState: number
+    DeploymentEnvironment: string
+  }
+  

package/src/modals/output-modals/GetItemListOutput.ts

@@ -0,0 +1,92 @@
+export interface GetItemListOutput {
+    ItemId: number;
+    Name: string;
+    ItemSubGroupId: number;
+    Flag1: boolean;
+    Flag2: boolean;
+    Description?: string;
+    IsActive: boolean;
+    Weight?: string;
+    ImagePath?: string;
+    FullImagePath?: string;
+    Translations?: string;
+    DescriptionTranslations?: string;
+    IsRecommended: boolean;
+    IsNew: boolean;
+    ShortcutItemId?: number;
+    ShortcutInteractorTypeId?: number;
+    ShortcutItemGroupId?: number;
+    ShortcutItemSubGroupId?: number;
+    IsShortcut: boolean;
+    ExternalId?: string;
+    ExternalIdChanged: boolean;
+    QrimagePath?: string;
+    FullQrimagePath?: string;
+    BarcodeId?: number;
+    IsGuestPublic?: boolean;
+    IsQrguestPublic: boolean;
+    IsSocialMediaGuestPublic: boolean;
+    Key?: string;
+    ExternalImagePath?: string;
+    GalleryImagesString?: string;
+    FullGalleryImagesString?: string;
+    BarcodeContent?: string;
+    BarcodeFormatId?: number;
+    BarcodeImagePath?: string;
+    FullBarcodeImagePath?: string;
+    BarcodeChanged: boolean;
+    Qrid?: string;
+    HasAssets: boolean;
+    Extra1?: string;
+    Extra2?: string;
+    Keywords?: string;
+    IsDeleted: boolean;
+    DeletionDate?: Date;
+    HasStaticAttributes: boolean;
+    IsPublicSearchEnabled: boolean;
+    SearchCategory?: string;
+    SearchSubCategory?: string;
+    SearchTags?: string;
+    IbeaconId?: string;
+    Location?: string;
+    Rfidtags?: string;
+    IsAssetSearchKeysFilter: boolean;
+    TimeStamp?: Date;
+    Rv?: Uint8Array;
+    ItemGuid?: string;
+    GeoRange?: number;
+    GeoRangeUitype?: number;
+    GeoRangeUivalue?: number;
+    SearchTextConcat?: string;
+    HideAttributes: boolean;
+    OnClickShow?: string;
+    Balance?: string;
+    Cost?: string;
+    Price?: string;
+    IsExpired: boolean;
+    IsRedeemed: boolean;
+    ActiveSchedulerData?: string;
+    ExpirySchedulerData?: string;
+    RedeemSchedulerData?: string;
+    ExpireyDate?: Date;
+    ActivationDate?: Date;
+    RedeemDate?: Date;
+    DeleteIfExpire: boolean;
+    Quantity?: string;
+    ReservedQuantity?: string;
+    Version?: string;
+    WalletAddress?: string;
+    Variations?: string;
+    Options?: string;
+    UnitOfMeasure?: string;
+    ValueOfMeasure?: number;
+    PriceDetails?: string;
+    CostDetails?: string;
+    ItemKindId?: number;
+    StockKeepingUnit?: string;
+    GPTIntention?: string;
+    GPTPrompt?: string;
+    DtoState: number;
+    DeploymentEnvironment: string;
+  }
+  

package/src/modals/output-modals/GetPositionsOutput.ts

@@ -0,0 +1,10 @@
+  export interface GetPositionsOutput {
+    positionId?: number;
+    name: string;
+    unitId: number;
+    isVacant: boolean;
+    positionTypeId: number;
+    requesterRoleId?: number;
+    providerRoleId?: number;
+    dtoState?: number;
+  }

package/src/modals/output-modals/GetRoleListByPermissionOutput.ts

@@ -0,0 +1,18 @@
+export interface GetRoleListByPermissionOutput {
+    RoleId: number
+    Name: string
+    RoleTypeId: number
+    IsDerived: boolean
+    IsSystemGenerated: boolean
+    IsRequester: boolean
+    IsAgent: boolean
+    IsProvider: boolean
+    IsSystem: boolean
+    InteractorTypeId: number
+    ObjectId?: number
+    SystemName: string
+    Translations: any
+    UiviewAlias?: string
+    DtoState: number
+  }
+  

package/src/modals/output-modals/GetServiceAttributeListOutput.ts

@@ -0,0 +1,95 @@
+export class GetServiceAttributeListOutput {
+    AttributeId: number = 0;
+    Name: string = '';
+    ObjectId: number = 0;
+    AttributeTypeId: number = 0;
+    IsRequired: boolean = false;
+    Value: string = '';
+    IsRequesterVisible: boolean | null = null;
+    IsProviderVisible: boolean | null = null;
+    IsRequesterEditable: boolean = false;
+    IsProviderEditable: boolean = false;
+    SequenceNo: number = 0;
+    IsComputed: boolean = false;
+    Formula: string = '';
+    Group: string = '';
+    GroupSequenceNo: number | null = null;
+    ExtendedValue: string = '';
+    GroupId: number | null = null;
+    ShowInProfile: boolean | null = null;
+    Translations: string = '';
+    Alias: string = '';
+    PlaceHolder: string = '';
+    CopyToRequest: boolean | null = null;
+    ShowInReport: boolean | null = true;
+    Description: string = '';
+    DescriptionTranslations: string = '';
+    PlaceHolderTranslations: string = '';
+    ValueTranslations: string = '';
+    IsFiltered: boolean = false;
+    FilterAttributeAlias: string = '';
+    IsParameter: boolean = false;
+    IsAutoCapture: boolean = false;
+    SchedulerData: string = '';
+    IsComputedInitialValue: boolean = false;
+    InitialValueFormula: string = '';
+    IsValidationEnabled: boolean = false;
+    ValidationRule: string = '';
+    ValidationRuleFailedComment: string = '';
+    ValidationRuleFailedCommentTranslation: string = '';
+    IsIntegrationEditable: boolean = false;
+    IsRequiredCondition: string = '';
+    OnChangeRecalculate: boolean = false;
+    UseInService: boolean | null = null;
+    AttachmentOriginalName: string = '';
+    FullFilePath: string = '';
+    PageNumber: number = 1;
+    IsPhantomVisible: boolean | null = null;
+    IsResetIf: boolean | null = null;
+    ResetIfFormula: string = '';
+    IsAsynchronousIntegration: boolean = false;
+    ApplyToExisting: boolean = false;
+    DtoState: number = 0;
+    AttributeGroupId: number = 0;
+    SourceAttributeId: number = 0;
+    AlternateValue: string = '';
+    AlternateName: string = '';
+    AlternateGroup: string = '';
+    AlternateDescription: string = '';
+    AlternatePlaceHolder: string = '';
+    Extra1: string = '';
+    Extra2: string = '';
+    IsGroupChecked: boolean = false;
+    IsChecked: boolean = false;
+    IsDisabledViewFile: boolean = false;
+    FileStorage: Array<any> = [];
+    FormatName: string = '';
+    IsProfileDocument: boolean | null = true;
+    IsRequesterEditableCondition: string = '';
+    IsProviderEditableCondition: string = '';
+    IsActionAttribute: boolean | null = null;
+    ActionAttributeDetails: string = '';
+    ObjectType: number = 0;
+  
+    constructor(objectId: number, isParameter: boolean, pageName: string) {
+      this.ObjectId = objectId;
+      this.IsParameter = isParameter;
+      this.FormatName = `${this.Name}:[${this.Alias}],`;
+      
+      if (pageName === 'ServiceAttribute' || pageName === 'ServiceParameter' || pageName === 'ServiceStepAttribute') {
+        this.IsProviderEditable = true;
+        this.IsRequesterEditable = true;
+        this.IsProviderVisible = true;
+        this.IsRequesterVisible = true;
+      }
+      if (pageName === 'AssetSubGroupAttributeList' || pageName === 'ItemSubGroupAttributeList') {
+        this.IsProviderVisible = true;
+        this.IsRequesterVisible = true;
+        this.PageNumber = 1;
+      }
+      if (pageName === 'AssetAttributeList' || pageName === 'ItemAttributeList') {
+        this.PageNumber = 1;
+      }
+    }
+  }
+