@herd/angular-client/dist/api/uploadAndDownload.service.d.ts

Swagger generated client for @herd/angular-client

/**
 * 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 { DownloadBusinessObjectDataStorageFileSingleInitiationRequest } from '../model/downloadBusinessObjectDataStorageFileSingleInitiationRequest';
import { DownloadBusinessObjectDataStorageFileSingleInitiationResponse } from '../model/downloadBusinessObjectDataStorageFileSingleInitiationResponse';
import { DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest } from '../model/downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest';
import { DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse } from '../model/downloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse';
import { DownloadSingleInitiationResponse } from '../model/downloadSingleInitiationResponse';
import { UploadBusinessObjectDefinitionSampleDataFileInitiationRequest } from '../model/uploadBusinessObjectDefinitionSampleDataFileInitiationRequest';
import { UploadBusinessObjectDefinitionSampleDataFileInitiationResponse } from '../model/uploadBusinessObjectDefinitionSampleDataFileInitiationResponse';
import { UploadSingleCredentialExtensionResponse } from '../model/uploadSingleCredentialExtensionResponse';
import { UploadSingleInitiationRequest } from '../model/uploadSingleInitiationRequest';
import { UploadSingleInitiationResponse } from '../model/uploadSingleInitiationResponse';
import { Configuration } from '../configuration';
export declare class UploadAndDownloadService {
    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;
    /**
     * extendUploadSingleCredentials
     * Extends the credentials for a previously initiated upload. <p>Requires WRITE permission on namespace</p>
     * @param namespace the namespace.
     * @param businessObjectDefinitionName the business object definition name.
     * @param businessObjectFormatUsage the business object format usage.
     * @param businessObjectFormatFileType the business object format file type.
     * @param businessObjectFormatVersion the business object format version.
     * @param partitionValue the partition value.
     * @param businessObjectDataVersion the business object data version.
     * @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.
     */
    uploadandDownloadExtendUploadSingleCredentials(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, observe?: 'body', reportProgress?: boolean): Observable<UploadSingleCredentialExtensionResponse>;
    uploadandDownloadExtendUploadSingleCredentials(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UploadSingleCredentialExtensionResponse>>;
    uploadandDownloadExtendUploadSingleCredentials(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UploadSingleCredentialExtensionResponse>>;
    /**
     * initiateDownloadSingle
     * Initiates a download of a single file. &lt;p&gt;Requires READ permission on namespace&lt;/p&gt;
     * @param namespace the namespace.
     * @param businessObjectDefinitionName the business object definition name.
     * @param businessObjectFormatUsage the business object format usage.
     * @param businessObjectFormatFileType the business object format file type.
     * @param businessObjectFormatVersion the business object format version.
     * @param partitionValue the partition value.
     * @param businessObjectDataVersion the business object data version.
     * @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.
     */
    uploadandDownloadInitiateDownloadSingle(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, observe?: 'body', reportProgress?: boolean): Observable<DownloadSingleInitiationResponse>;
    uploadandDownloadInitiateDownloadSingle(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DownloadSingleInitiationResponse>>;
    uploadandDownloadInitiateDownloadSingle(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DownloadSingleInitiationResponse>>;
    /**
     * initiateDownloadSingleBusinessObjectDataStorageFile
     * Download a single business object data storage file
     * @param downloadBusinessObjectDataStorageFileSingleInitiationRequest the download request for single business object data storage file
     * @param preSignedUrlDurationSeconds the duration in seconds for which pre-signed URL should be valid
     * @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.
     */
    uploadandDownloadInitiateDownloadSingleBusinessObjectDataStorageFile(downloadBusinessObjectDataStorageFileSingleInitiationRequest: DownloadBusinessObjectDataStorageFileSingleInitiationRequest, preSignedUrlDurationSeconds?: number, observe?: 'body', reportProgress?: boolean): Observable<DownloadBusinessObjectDataStorageFileSingleInitiationResponse>;
    uploadandDownloadInitiateDownloadSingleBusinessObjectDataStorageFile(downloadBusinessObjectDataStorageFileSingleInitiationRequest: DownloadBusinessObjectDataStorageFileSingleInitiationRequest, preSignedUrlDurationSeconds?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DownloadBusinessObjectDataStorageFileSingleInitiationResponse>>;
    uploadandDownloadInitiateDownloadSingleBusinessObjectDataStorageFile(downloadBusinessObjectDataStorageFileSingleInitiationRequest: DownloadBusinessObjectDataStorageFileSingleInitiationRequest, preSignedUrlDurationSeconds?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DownloadBusinessObjectDataStorageFileSingleInitiationResponse>>;
    /**
     * initiateDownloadSingleSampleFile
     * Download a single business object definition sample file
     * @param downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest
     * @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.
     */
    uploadandDownloadInitiateDownloadSingleSampleFile(downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest: DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest, observe?: 'body', reportProgress?: boolean): Observable<DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse>;
    uploadandDownloadInitiateDownloadSingleSampleFile(downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest: DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse>>;
    uploadandDownloadInitiateDownloadSingleSampleFile(downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest: DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse>>;
    /**
     * initiateUploadSampleFile
     * Provide the location and credentials prior to upload a Sample Data file &lt;p&gt;Requires WRITE or WRITE_DESCRIPTIVE_CONTENT permission on namespace&lt;/p&gt;
     * @param uploadBusinessObjectDefinitionSampleDataFileInitiationRequest request to upload
     * @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.
     */
    uploadandDownloadInitiateUploadSampleFile(uploadBusinessObjectDefinitionSampleDataFileInitiationRequest: UploadBusinessObjectDefinitionSampleDataFileInitiationRequest, observe?: 'body', reportProgress?: boolean): Observable<UploadBusinessObjectDefinitionSampleDataFileInitiationResponse>;
    uploadandDownloadInitiateUploadSampleFile(uploadBusinessObjectDefinitionSampleDataFileInitiationRequest: UploadBusinessObjectDefinitionSampleDataFileInitiationRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UploadBusinessObjectDefinitionSampleDataFileInitiationResponse>>;
    uploadandDownloadInitiateUploadSampleFile(uploadBusinessObjectDefinitionSampleDataFileInitiationRequest: UploadBusinessObjectDefinitionSampleDataFileInitiationRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UploadBusinessObjectDefinitionSampleDataFileInitiationResponse>>;
    /**
     * initiateUploadSingle
     * Initiates a single file upload capability by creating the relative business object data instance in UPLOADING state and allowing write access to a specific location in S3_MANAGED_LOADING_DOCK storage. &lt;p&gt;Requires WRITE permission on namespace&lt;/p&gt;
     * @param uploadSingleInitiationRequest the information needed to initiate a file upload
     * @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.
     */
    uploadandDownloadInitiateUploadSingle(uploadSingleInitiationRequest: UploadSingleInitiationRequest, observe?: 'body', reportProgress?: boolean): Observable<UploadSingleInitiationResponse>;
    uploadandDownloadInitiateUploadSingle(uploadSingleInitiationRequest: UploadSingleInitiationRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UploadSingleInitiationResponse>>;
    uploadandDownloadInitiateUploadSingle(uploadSingleInitiationRequest: UploadSingleInitiationRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UploadSingleInitiationResponse>>;
}