Class SourceService

Index

Constructors

Methods

createSource deleteSource getSource listSource updateSource

Constructors

constructor

new SourceService(): SourceService
Returns SourceService

Methods

`Static`createSource

createSource<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & CreateSourceData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Source, unknown, ThrowOnError>
Create source Create a new source
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & CreateSourceData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Source, unknown, ThrowOnError>
- Defined in sdk.gen.ts:331

`Static`deleteSource

deleteSource<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DeleteSourceData,
): RequestResult<entity_Source, unknown, ThrowOnError>
Delete source Delete specified source by ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DeleteSourceData
Returns RequestResult<entity_Source, unknown, ThrowOnError>
- Defined in sdk.gen.ts:342

`Static`getSource

getSource<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetSourceData,
): RequestResult<entity_Source, unknown, ThrowOnError>
Get source Get source information by source ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetSourceData
Returns RequestResult<entity_Source, unknown, ThrowOnError>
- Defined in sdk.gen.ts:353

`Static`listSource

listSource<ThrowOnError extends boolean = false>(
options?: OmitKeys<RequestOptions<ThrowOnError, string>, "url">,
): RequestResult<entity_Source, unknown, ThrowOnError>
List source List source information by source ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- Optionaloptions: OmitKeys<RequestOptions<ThrowOnError, string>, "url">
Returns RequestResult<entity_Source, unknown, ThrowOnError>
- Defined in sdk.gen.ts:320

`Static`updateSource

updateSource<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateSourceData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Source, unknown, ThrowOnError>
Update source Update the specified source
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateSourceData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Source, unknown, ThrowOnError>
- Defined in sdk.gen.ts:364