Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigurationsAPI

Configurations module

Hierarchy

  • default
    • ConfigurationsAPI

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

config

config: ManageConfig

paginate

paginate: (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>

Type declaration

    • (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]): Promise<unknown[]>
    • example
       cwm.paginate(cwm.FinanceAPI.getFinanceAgreements, {startPage: 1, pageSize: 500}, {conditions: 'inactiveFlag = false'})

      Parameters

      • apiMethod: Function
      • paginateArgs: PaginationOptions
      • Rest ...methodArgs: Record<string, unknown>[]

      Returns Promise<unknown[]>

request

request: (args: RequestOptions) => Promise<any>

Type declaration

Methods

getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdInfo

  • getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdInfo(grandparentId: number, parentId: number, id: number, params?: CommonParameters): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType?: null | "Date" | "EntryField" | "List" | "Option"; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question?: string; requiredFlag?: null | boolean; sequenceNumber?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType?: null | "Date" | "EntryField" | "List" | "Option"; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question?: string; requiredFlag?: null | boolean; sequenceNumber?: null | number }>

getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesInfo

  • getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesInfo(grandparentId: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value?: string }[]>

getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesInfoCount

  • getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesInfoCount(grandparentId: number, parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getConfigurationsTypesByParentIdQuestionsByIdInfo

  • getConfigurationsTypesByParentIdQuestionsByIdInfo(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType?: null | "Date" | "EntryField" | "List" | "Option"; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question?: string; requiredFlag?: null | boolean; sequenceNumber?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType?: null | "Date" | "EntryField" | "List" | "Option"; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question?: string; requiredFlag?: null | boolean; sequenceNumber?: null | number }>

getConfigurationsTypesByParentIdQuestionsInfo

  • getConfigurationsTypesByParentIdQuestionsInfo(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType?: null | "Date" | "EntryField" | "List" | "Option"; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question?: string; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType?: null | "Date" | "EntryField" | "List" | "Option"; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question?: string; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]>

getConfigurationsTypesByParentIdQuestionsInfoCount

  • getConfigurationsTypesByParentIdQuestionsInfoCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getConfigurationsTypesInfo

  • getConfigurationsTypesInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name?: string; systemFlag?: null | boolean }[]>

getConfigurationsTypesInfoCount

  • getConfigurationsTypesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

Generated using TypeDoc