Type Alias RequestType

type RequestType = {
    createRequestType(
        typeData: RequestTypeSkeleton,
    ): Promise<RequestTypeSkeleton>;
    deleteRequestType(typeId: string): Promise<RequestTypeSkeleton>;
    deleteRequestTypeByName(typeName: string): Promise<RequestTypeSkeleton>;
    deleteRequestTypes(
        resultCallback?: ResultCallback<RequestTypeSkeleton>,
    ): Promise<RequestTypeSkeleton[]>;
    exportRequestType(
        typeId: string,
        options?: RequestTypeExportOptions,
    ): Promise<RequestTypeExportInterface>;
    exportRequestTypeByName(
        typeName: string,
        options?: RequestTypeExportOptions,
    ): Promise<RequestTypeExportInterface>;
    exportRequestTypes(
        options?: RequestTypeExportOptions,
    ): Promise<RequestTypeExportInterface>;
    importRequestTypes(
        importData: RequestTypeExportInterface,
        typeId?: string,
        typeName?: string,
        options?: RequestTypeImportOptions,
        resultCallback?: ResultCallback<RequestTypeSkeleton>,
    ): Promise<RequestTypeSkeleton[]>;
    readRequestType(typeId: string): Promise<RequestTypeSkeleton>;
    readRequestTypeByName(typeName: string): Promise<RequestTypeSkeleton>;
    readRequestTypes(): Promise<RequestTypeSkeleton[]>;
    updateRequestType(
        typeId: string,
        typeData: RequestTypeSkeleton,
    ): Promise<RequestTypeSkeleton>;
}

Index

Methods

createRequestType deleteRequestType deleteRequestTypeByName deleteRequestTypes exportRequestType exportRequestTypeByName exportRequestTypes importRequestTypes readRequestType readRequestTypeByName readRequestTypes updateRequestType

Methods

createRequestType

createRequestType(typeData: RequestTypeSkeleton): Promise<RequestTypeSkeleton>
Create request type
Parameters
- typeData: RequestTypeSkeleton
  the request type object
Returns Promise<RequestTypeSkeleton>
a promise that resolves to a request type object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:27

deleteRequestType

deleteRequestType(typeId: string): Promise<RequestTypeSkeleton>
Delete request type
Parameters
- typeId: string
  the request type id
Returns Promise<RequestTypeSkeleton>
a promise that resolves to a request type object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:106

deleteRequestTypeByName

deleteRequestTypeByName(typeName: string): Promise<RequestTypeSkeleton>
Delete request type by its display name
Parameters
- typeName: string
  the request type display name
Returns Promise<RequestTypeSkeleton>
a promise that resolves to a request type object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:112

deleteRequestTypes

deleteRequestTypes(
resultCallback?: ResultCallback<RequestTypeSkeleton>,
): Promise<RequestTypeSkeleton[]>
Delete request types
Parameters
- OptionalresultCallback: ResultCallback<RequestTypeSkeleton>
  Optional callback to process individual results
Returns Promise<RequestTypeSkeleton[]>
promise that resolves to an array of request type objects
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:118

exportRequestType

exportRequestType(
typeId: string,
options?: RequestTypeExportOptions,
): Promise<RequestTypeExportInterface>
Export request type
Parameters
- typeId: string
  the request type id
- Optionaloptions: RequestTypeExportOptions
  export options
Returns Promise<RequestTypeExportInterface>
a promise that resolves to a request type export object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:53

exportRequestTypeByName

exportRequestTypeByName(
typeName: string,
options?: RequestTypeExportOptions,
): Promise<RequestTypeExportInterface>
Export request type by its display name
Parameters
- typeName: string
  the request type display name
- Optionaloptions: RequestTypeExportOptions
  export options
Returns Promise<RequestTypeExportInterface>
a promise that resolves to a request type export object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:63

exportRequestTypes

exportRequestTypes(
options?: RequestTypeExportOptions,
): Promise<RequestTypeExportInterface>
Export all request types
Parameters
- Optionaloptions: RequestTypeExportOptions
  export options
Returns Promise<RequestTypeExportInterface>
a promise that resolves to a request type export object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:72

importRequestTypes

importRequestTypes(
    importData: RequestTypeExportInterface,
    typeId?: string,
    typeName?: string,
    options?: RequestTypeImportOptions,
    resultCallback?: ResultCallback<RequestTypeSkeleton>,
): Promise<RequestTypeSkeleton[]>
Import request types
Parameters
- importData: RequestTypeExportInterface
  request type import data
- OptionaltypeId: string
  The request type id. If supplied, only the request type of that id is imported. Takes priority over typeName if they are all provided.
- OptionaltypeName: string
  The request type display name. If supplied, only the request type of that display name is imported.
- Optionaloptions: RequestTypeImportOptions
  import options
- OptionalresultCallback: ResultCallback<RequestTypeSkeleton>
  Optional callback to process individual results
Returns Promise<RequestTypeSkeleton[]>
the imported request types
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:94

readRequestType

readRequestType(typeId: string): Promise<RequestTypeSkeleton>
Read request type
Parameters
- typeId: string
  the request type id
Returns Promise<RequestTypeSkeleton>
a promise that resolves to a request type object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:35

readRequestTypeByName

readRequestTypeByName(typeName: string): Promise<RequestTypeSkeleton>
Read request type by its display name
Parameters
- typeName: string
  the request type display name
Returns Promise<RequestTypeSkeleton>
a promise that resolves to a request type object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:41

readRequestTypes

readRequestTypes(): Promise<RequestTypeSkeleton[]>
Read all request types

Returns Promise<RequestTypeSkeleton[]>
a promise that resolves to an array of request type objects
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:46

updateRequestType

updateRequestType(
typeId: string,
typeData: RequestTypeSkeleton,
): Promise<RequestTypeSkeleton>
Update request type
Parameters
- typeId: string
  the request type id
- typeData: RequestTypeSkeleton
  the request type object
Returns Promise<RequestTypeSkeleton>
a promise that resolves to a request type object
- Defined in ops/cloud/iga/IgaRequestTypeOps.ts:81

Type Alias RequestType

Index

Methods

Methods

createRequestType

Parameters

Returns Promise<RequestTypeSkeleton>

deleteRequestType

Parameters

Returns Promise<RequestTypeSkeleton>

deleteRequestTypeByName

Parameters

Returns Promise<RequestTypeSkeleton>

deleteRequestTypes

Parameters

Returns Promise<RequestTypeSkeleton[]>

exportRequestType

Parameters

Returns Promise<RequestTypeExportInterface>

exportRequestTypeByName

Parameters

Returns Promise<RequestTypeExportInterface>

exportRequestTypes

Parameters

Returns Promise<RequestTypeExportInterface>

importRequestTypes

Parameters

Returns Promise<RequestTypeSkeleton[]>

readRequestType

Parameters

Returns Promise<RequestTypeSkeleton>

readRequestTypeByName

Parameters

Returns Promise<RequestTypeSkeleton>

readRequestTypes

Returns Promise<RequestTypeSkeleton[]>

updateRequestType

Parameters

Returns Promise<RequestTypeSkeleton>

Settings

On This Page