/**
 * OpenAPI spec version: 1.0
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { OcTokenService } from './token.service';
import { ListShipment } from '../model/listShipment';
import { ListShipmentItem } from '../model/listShipmentItem';
import { Shipment } from '../model/shipment';
import { ShipmentItem } from '../model/shipmentItem';
import { Configuration } from '../configuration';
export declare class OcShipmentService {
    protected httpClient: HttpClient;
    protected ocTokenService: OcTokenService;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    private impersonating;
    constructor(httpClient: HttpClient, ocTokenService: OcTokenService, basePath: string, configuration: Configuration);
    /**
     * @description enable impersonation by calling this prior to any of the other methods in this service
     *
     */
    As(): this;
    /**
     *
     *
     * @param shipmentID ID of the shipment.
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    Delete(shipmentID: string, options?: {
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<any>;
    Delete(shipmentID: string, options?: {
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<any>>;
    Delete(shipmentID: string, options?: {
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<any>>;
    /**
     *
     *
     * @param shipment
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    Create<ShipmentXp = any, AddressXp = any>(shipment: Shipment, options?: {
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<Shipment<ShipmentXp, AddressXp>>;
    Create<ShipmentXp = any, AddressXp = any>(shipment: Shipment, options?: {
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<Shipment>>;
    Create<ShipmentXp = any, AddressXp = any>(shipment: Shipment, options?: {
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<Shipment>>;
    /**
     *
     *
     * @param shipmentID ID of the shipment.
     * @param orderID ID of the order.
     * @param lineItemID ID of the line item.
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    DeleteItem(shipmentID: string, orderID: string, lineItemID: string, options?: {
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<any>;
    DeleteItem(shipmentID: string, orderID: string, lineItemID: string, options?: {
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<any>>;
    DeleteItem(shipmentID: string, orderID: string, lineItemID: string, options?: {
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<any>>;
    /**
     *
     *
     * @param shipmentID ID of the shipment.
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    Get<ShipmentXp = any, AddressXp = any>(shipmentID: string, options?: {
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<Shipment<ShipmentXp, AddressXp>>;
    Get<ShipmentXp = any, AddressXp = any>(shipmentID: string, options?: {
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<Shipment>>;
    Get<ShipmentXp = any, AddressXp = any>(shipmentID: string, options?: {
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<Shipment>>;
    /**
     *
     *
     * @param shipmentID ID of the shipment.
     * @param orderID ID of the order.
     * @param lineItemID ID of the line item.
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    GetItem<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, orderID: string, lineItemID: string, options?: {
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<ShipmentItem<ShipmentItemXp, ProductXp, LineItemVariantXp>>;
    GetItem<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, orderID: string, lineItemID: string, options?: {
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<ShipmentItem>>;
    GetItem<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, orderID: string, lineItemID: string, options?: {
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<ShipmentItem>>;
    /**
     *
     *
     * @param options.orderID ID of the order.
     * @param options.search Word or phrase to search for.
     * @param options.searchOn Comma-delimited list of fields to search on.
     * @param options.sortBy Comma-delimited list of fields to sort by.
     * @param options.page Page of results to return. Default: 1
     * @param options.pageSize Number of results to return per page. Default: 20, max: 100.
     * @param options.filters Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    List<ShipmentXp = any, AddressXp = any>(options?: {
        orderID?: string;
        search?: string;
        searchOn?: string;
        sortBy?: string;
        page?: number;
        pageSize?: number;
        filters?: {
            [key: string]: string | Array<string>;
        };
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<ListShipment<ShipmentXp, AddressXp>>;
    List<ShipmentXp = any, AddressXp = any>(options?: {
        orderID?: string;
        search?: string;
        searchOn?: string;
        sortBy?: string;
        page?: number;
        pageSize?: number;
        filters?: {
            [key: string]: string | Array<string>;
        };
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<ListShipment>>;
    List<ShipmentXp = any, AddressXp = any>(options?: {
        orderID?: string;
        search?: string;
        searchOn?: string;
        sortBy?: string;
        page?: number;
        pageSize?: number;
        filters?: {
            [key: string]: string | Array<string>;
        };
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<ListShipment>>;
    /**
     *
     *
     * @param shipmentID ID of the shipment.
     * @param options.search Word or phrase to search for.
     * @param options.searchOn Comma-delimited list of fields to search on.
     * @param options.sortBy Comma-delimited list of fields to sort by.
     * @param options.page Page of results to return. Default: 1
     * @param options.pageSize Number of results to return per page. Default: 20, max: 100.
     * @param options.filters Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    ListItems<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, options?: {
        search?: string;
        searchOn?: string;
        sortBy?: string;
        page?: number;
        pageSize?: number;
        filters?: {
            [key: string]: string | Array<string>;
        };
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<ListShipmentItem<ShipmentItemXp, ProductXp, LineItemVariantXp>>;
    ListItems<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, options?: {
        search?: string;
        searchOn?: string;
        sortBy?: string;
        page?: number;
        pageSize?: number;
        filters?: {
            [key: string]: string | Array<string>;
        };
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<ListShipmentItem>>;
    ListItems<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, options?: {
        search?: string;
        searchOn?: string;
        sortBy?: string;
        page?: number;
        pageSize?: number;
        filters?: {
            [key: string]: string | Array<string>;
        };
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<ListShipmentItem>>;
    /**
     *
     *
     * @param shipmentID ID of the shipment.
     * @param partialShipment
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    Patch<ShipmentXp = any, AddressXp = any>(shipmentID: string, partialShipment: Shipment, options?: {
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<Shipment<ShipmentXp, AddressXp>>;
    Patch<ShipmentXp = any, AddressXp = any>(shipmentID: string, partialShipment: Shipment, options?: {
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<Shipment>>;
    Patch<ShipmentXp = any, AddressXp = any>(shipmentID: string, partialShipment: Shipment, options?: {
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<Shipment>>;
    /**
     *
     *
     * @param shipmentID ID of the shipment.
     * @param shipment
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    Save<ShipmentXp = any, AddressXp = any>(shipmentID: string, shipment: Shipment, options?: {
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<Shipment<ShipmentXp, AddressXp>>;
    Save<ShipmentXp = any, AddressXp = any>(shipmentID: string, shipment: Shipment, options?: {
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<Shipment>>;
    Save<ShipmentXp = any, AddressXp = any>(shipmentID: string, shipment: Shipment, options?: {
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<Shipment>>;
    /**
     *
     *
     * @param shipmentID ID of the shipment.
     * @param shipmentItem
     * @param options.observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param options.reportProgress flag to report request and response progress.
     */
    SaveItem<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, shipmentItem: ShipmentItem, options?: {
        observe?: 'body';
        reportProgress?: boolean;
    }): Observable<ShipmentItem<ShipmentItemXp, ProductXp, LineItemVariantXp>>;
    SaveItem<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, shipmentItem: ShipmentItem, options?: {
        observe?: 'response';
        reportProgress?: boolean;
    }): Observable<HttpResponse<ShipmentItem>>;
    SaveItem<ShipmentItemXp = any, ProductXp = any, LineItemVariantXp = any>(shipmentID: string, shipmentItem: ShipmentItem, options?: {
        observe?: 'events';
        reportProgress?: boolean;
    }): Observable<HttpEvent<ShipmentItem>>;
}
