@herd/angular-client
Version:
Swagger generated client for @herd/angular-client
82 lines (81 loc) • 6.29 kB
TypeScript
/**
* herd
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* OpenAPI spec version: 0.219.0-SNAPSHOT
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { ExternalInterface } from '../model/externalInterface';
import { ExternalInterfaceCreateRequest } from '../model/externalInterfaceCreateRequest';
import { ExternalInterfaceKeys } from '../model/externalInterfaceKeys';
import { ExternalInterfaceUpdateRequest } from '../model/externalInterfaceUpdateRequest';
import { Configuration } from '../configuration';
export declare class ExternalInterfaceService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
/**
* @param consumes string[] mime-types
* @return true: consumes contains 'multipart/form-data', false: otherwise
*/
private canConsumeForm;
/**
* createExternalInterface
* Creates a new external interface.
* @param externalInterfaceCreateRequest the information needed to create an external interface
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
externalInterfaceCreateExternalInterface(externalInterfaceCreateRequest: ExternalInterfaceCreateRequest, observe?: 'body', reportProgress?: boolean): Observable<ExternalInterface>;
externalInterfaceCreateExternalInterface(externalInterfaceCreateRequest: ExternalInterfaceCreateRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExternalInterface>>;
externalInterfaceCreateExternalInterface(externalInterfaceCreateRequest: ExternalInterfaceCreateRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExternalInterface>>;
/**
* deleteExternalInterface
* Deletes an existing external interface by external interface name.
* @param externalInterfaceName the external interface name
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
externalInterfaceDeleteExternalInterface(externalInterfaceName: string, observe?: 'body', reportProgress?: boolean): Observable<ExternalInterface>;
externalInterfaceDeleteExternalInterface(externalInterfaceName: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExternalInterface>>;
externalInterfaceDeleteExternalInterface(externalInterfaceName: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExternalInterface>>;
/**
* getExternalInterface
* Retrieves an existing external interface by external interface name.
* @param externalInterfaceName the external interface name
* @param includeBusinessObjectFormatExternalInterfaces specifies to include a list of business object format to external interface mappings in the response
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
externalInterfaceGetExternalInterface(externalInterfaceName: string, includeBusinessObjectFormatExternalInterfaces?: boolean, observe?: 'body', reportProgress?: boolean): Observable<ExternalInterface>;
externalInterfaceGetExternalInterface(externalInterfaceName: string, includeBusinessObjectFormatExternalInterfaces?: boolean, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExternalInterface>>;
externalInterfaceGetExternalInterface(externalInterfaceName: string, includeBusinessObjectFormatExternalInterfaces?: boolean, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExternalInterface>>;
/**
* getExternalInterfaces
* Gets a list of external interface keys for all external interfaces defined in the system. The result list is sorted by external interface name in ascending order.
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
externalInterfaceGetExternalInterfaces(observe?: 'body', reportProgress?: boolean): Observable<ExternalInterfaceKeys>;
externalInterfaceGetExternalInterfaces(observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExternalInterfaceKeys>>;
externalInterfaceGetExternalInterfaces(observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExternalInterfaceKeys>>;
/**
* updateExternalInterface
* Updates an existing external interface.
* @param externalInterfaceName
* @param externalInterfaceUpdateRequest the information needed to update an external interface
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
externalInterfaceUpdateExternalInterface(externalInterfaceName: string, externalInterfaceUpdateRequest: ExternalInterfaceUpdateRequest, observe?: 'body', reportProgress?: boolean): Observable<ExternalInterface>;
externalInterfaceUpdateExternalInterface(externalInterfaceName: string, externalInterfaceUpdateRequest: ExternalInterfaceUpdateRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExternalInterface>>;
externalInterfaceUpdateExternalInterface(externalInterfaceName: string, externalInterfaceUpdateRequest: ExternalInterfaceUpdateRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExternalInterface>>;
}