@indigina/dcm-api 0.0.85 → 0.0.87

package/{index.d.ts → types/indigina-dcm-api.d.ts}

@@ -219,6 +219,64 @@ declare class Configuration {
     private defaultEncodeParam;
 }
 
+declare enum QueryParamStyle {
+    Json = 0,
+    Form = 1,
+    DeepObject = 2,
+    SpaceDelimited = 3,
+    PipeDelimited = 4
+}
+type Delimiter = "," | " " | "|" | "\t";
+interface ParamOptions {
+    /** When true, serialized as multiple repeated key=value pairs. When false, serialized as a single key with joined values using `delimiter`. */
+    explode?: boolean;
+    /** Delimiter used when explode=false. The delimiter itself is inserted unencoded between encoded values. */
+    delimiter?: Delimiter;
+}
+declare class OpenApiHttpParams {
+    private params;
+    private defaults;
+    private encoder;
+    /**
+     * @param encoder  Parameter serializer
+     * @param defaults Global defaults used when a specific parameter has no explicit options.
+     *                 By OpenAPI default, explode is true for query params with style=form.
+     */
+    constructor(encoder?: HttpParameterCodec, defaults?: {
+        explode?: boolean;
+        delimiter?: Delimiter;
+    });
+    private resolveOptions;
+    /**
+     * Replace the parameter's values and (optionally) its options.
+     * Options are stored per-parameter (not global).
+     */
+    set(key: string, values: string[] | string, options?: ParamOptions): this;
+    /**
+     * Append a single value to the parameter. If the parameter didn't exist it will be created
+     * and use resolved options (global defaults merged with any provided options).
+     */
+    append(key: string, value: string, options?: ParamOptions): this;
+    /**
+     * Serialize to a query string according to per-parameter OpenAPI options.
+     * - If explode=true for that parameter → repeated key=value pairs (each value encoded).
+     * - If explode=false for that parameter → single key=value where values are individually encoded
+     *   and joined using the configured delimiter. The delimiter character is inserted AS-IS
+     *   (not percent-encoded).
+     */
+    toString(): string;
+    /**
+     * Return parameters as a plain record.
+     * - If a parameter has exactly one value, returns that value directly.
+     * - If a parameter has multiple values, returns a readonly array of values.
+     */
+    toRecord(): Record<string, string | number | boolean | ReadonlyArray<string | number | boolean>>;
+    /**
+     * Return an Angular's HttpParams with an identity parameter codec as the parameters are already encoded.
+     */
+    toHttpParams(): HttpParams;
+}
+
 /**
  * Dcm.API.Client
  *
@@ -236,8 +294,7 @@ declare class BaseService {
     encoder: HttpParameterCodec;
     constructor(basePath?: string | string[], configuration?: Configuration);
     protected canConsumeForm(consumes: string[]): boolean;
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep?: boolean): HttpParams;
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep?: boolean): HttpParams;
+    protected addToHttpParams(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined, paramStyle: QueryParamStyle, explode: boolean): OpenApiHttpParams;
 }
 
 declare class AuditLogsService extends BaseService {
@@ -245,6 +302,7 @@ declare class AuditLogsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Getting a shipment logs
+     * @endpoint get /auditLogs/{recordId}/{recordType}
      * @param recordId
      * @param recordType
      * @param $skip
@@ -254,6 +312,7 @@ declare class AuditLogsService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getShipmentLogs(recordId: string, recordType: RecordTypes, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -292,8 +351,10 @@ declare class BookingsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Get vendor draft bookings count
+     * @endpoint get /bookings/vendorDrafts/count
      * @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.
+     * @param options additional options
      */
     getVendorDraftBookingsCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -349,6 +410,7 @@ declare class CompaniesService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Getting  user companies
+     * @endpoint get /companies/userCompanies
      * @param $skip
      * @param $top
      * @param $orderby
@@ -356,6 +418,7 @@ declare class CompaniesService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getUserCompanies($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -932,9 +995,9 @@ interface ContainerGridView {
     id: string;
     shipmentId: string;
     number: string;
-    bookedState?: ContainerBookedState;
-    size?: ContainerSize;
-    containerType?: ContainerType;
+    bookedState?: ContainerBookedState | null;
+    size?: ContainerSize | null;
+    containerType?: ContainerType | null;
     goh?: boolean;
     gateInDate?: string | null;
     projectedDeliveryDate?: string | null;
@@ -1064,6 +1127,7 @@ declare class ContainersService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Container delivery list
+     * @endpoint get /containers/deliveries
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1071,6 +1135,7 @@ declare class ContainersService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getContainerDeliveries($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1089,6 +1154,7 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainerDeliveries>>;
     /**
      * Container delivery list
+     * @endpoint get /containers/deliveries/search
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1096,6 +1162,7 @@ declare class ContainersService extends BaseService {
      * @param searchTerm
      * @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.
+     * @param options additional options
      */
     getContainerDeliveriesFromIndex($skip?: number, $top?: number, $orderby?: string, $filter?: string, searchTerm?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1114,9 +1181,11 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainerDeliveries>>;
     /**
      * Getting container delivery booking items
+     * @endpoint get /containers/delivery-booking-items
      * @param dcClientDeliveryBookingId
      * @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.
+     * @param options additional options
      */
     getContainerDeliveryBookingItems(dcClientDeliveryBookingId: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1135,9 +1204,11 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainerDeliveryItems>>;
     /**
      * Getting container delivery items
+     * @endpoint get /containers/delivery-items
      * @param containerIds
      * @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.
+     * @param options additional options
      */
     getContainerDeliveryItems(containerIds: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1156,9 +1227,11 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainerDeliveryItems>>;
     /**
      * Getting container delivery summary
+     * @endpoint get /containers/delivery/summary
      * @param containerIds
      * @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.
+     * @param options additional options
      */
     getContainerDeliverySummary(containerIds: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1177,6 +1250,7 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainerDeliverySummaries>>;
     /**
      * Getting container items
+     * @endpoint get /containers/{id}/items
      * @param id
      * @param $skip
      * @param $top
@@ -1185,6 +1259,7 @@ declare class ContainersService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getContainerItems(id: string, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1203,6 +1278,7 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainerItems>>;
     /**
      * Container purchase order list
+     * @endpoint get /containers/pos
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1210,6 +1286,7 @@ declare class ContainersService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getContainerPurchaseOrders($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1228,6 +1305,7 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainerPos>>;
     /**
      * Container purchase order list
+     * @endpoint get /containers/pos/search
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1235,6 +1313,7 @@ declare class ContainersService extends BaseService {
      * @param searchTerm
      * @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.
+     * @param options additional options
      */
     getContainerPurchaseOrdersFromIndex($skip?: number, $top?: number, $orderby?: string, $filter?: string, searchTerm?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1253,6 +1332,7 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainerPos>>;
     /**
      * Containers list
+     * @endpoint get /containers
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1260,6 +1340,7 @@ declare class ContainersService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getContainers($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1278,6 +1359,7 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<Containers>>;
     /**
      * Containers list
+     * @endpoint get /containers/search
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1285,6 +1367,7 @@ declare class ContainersService extends BaseService {
      * @param searchTerm
      * @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.
+     * @param options additional options
      */
     getContainersFromIndex($skip?: number, $top?: number, $orderby?: string, $filter?: string, searchTerm?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1303,8 +1386,10 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<Containers>>;
     /**
      * Containers to deliver
+     * @endpoint get /containers/todeliver/count
      * @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.
+     * @param options additional options
      */
     getContainersToDeliverCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1323,8 +1408,10 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainersToDeliverCount>>;
     /**
      * Get destination agent Deliveries Require Amend Confirmation count
+     * @endpoint get /containers/deliveriesRequireAmendConfirmation/count
      * @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.
+     * @param options additional options
      */
     getDeliveriesRequireAmendConfirmationCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1343,8 +1430,10 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainersCount>>;
     /**
      * Get destination agent Deliveries Require Cancel Confirmation count
+     * @endpoint get /containers/deliveriesRequireCancelConfirmation/count
      * @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.
+     * @param options additional options
      */
     getDeliveriesRequireCancelConfirmationCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1363,8 +1452,10 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainersCount>>;
     /**
      * Get destination agent Deliveries Require Confirmation count
+     * @endpoint get /containers/deliveriesRequireConfirmation/count
      * @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.
+     * @param options additional options
      */
     getDeliveriesRequireConfirmationCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1383,8 +1474,10 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainersCount>>;
     /**
      * Get destination agent Deliveries To Book count
+     * @endpoint get /containers/deliveriesToBook/count
      * @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.
+     * @param options additional options
      */
     getDeliveriesToBookCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1403,8 +1496,10 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainersCount>>;
     /**
      * Get destination agent Deliveries To Reschedule count
+     * @endpoint get /containers/deliveriesToReschedule/count
      * @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.
+     * @param options additional options
      */
     getDeliveriesToRescheduleCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1423,8 +1518,10 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainersCount>>;
     /**
      * Get destination agent Planned Deliveries and Deliveries Require POD and Customs count
+     * @endpoint get /containers/plannedDeliveriesAndPod/count
      * @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.
+     * @param options additional options
      */
     getPlannedDeliveriesAndPodCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1443,6 +1540,7 @@ declare class ContainersService extends BaseService {
     }): Observable<HttpEvent<ContainersCount>>;
     /**
      * Getting a shipment containers
+     * @endpoint get /containers/shipment/{shipmentId}/
      * @param shipmentId
      * @param $skip
      * @param $top
@@ -1451,6 +1549,7 @@ declare class ContainersService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getShipmentContainers(shipmentId: string, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1508,9 +1607,11 @@ declare class DcsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Getting dc by id
+     * @endpoint get /dcs/{id}
      * @param id
      * @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.
+     * @param options additional options
      */
     getDc(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1529,6 +1630,7 @@ declare class DcsService extends BaseService {
     }): Observable<HttpEvent<Dc>>;
     /**
      * Getting dcs
+     * @endpoint get /dcs
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1536,6 +1638,7 @@ declare class DcsService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getDcs($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1575,9 +1678,11 @@ declare class DeliveryBookingDcsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Getting deliveryBooking dcs
+     * @endpoint get /deliveryBookings/dcs
      * @param containerIds
      * @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.
+     * @param options additional options
      */
     getDeliveryBookingDcs(containerIds: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1800,9 +1905,11 @@ declare class DeliveryBookingsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Create delivery booking
+     * @endpoint post /deliveryBookings
      * @param createDcClientDeliveryBooking
      * @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.
+     * @param options additional options
      */
     createDeliveryBooking(createDcClientDeliveryBooking: CreateDcClientDeliveryBooking, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1821,9 +1928,11 @@ declare class DeliveryBookingsService extends BaseService {
     }): Observable<HttpEvent<boolean>>;
     /**
      * Getting a delivery booking summary by id
+     * @endpoint get /deliveryBookings/{id}
      * @param id
      * @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.
+     * @param options additional options
      */
     getDeliveryBooking(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1842,6 +1951,7 @@ declare class DeliveryBookingsService extends BaseService {
     }): Observable<HttpEvent<DcClientDeliveryBooking>>;
     /**
      * Delivery booking list
+     * @endpoint get /deliveryBookings
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1849,6 +1959,7 @@ declare class DeliveryBookingsService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getDeliveryBookings($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1867,6 +1978,7 @@ declare class DeliveryBookingsService extends BaseService {
     }): Observable<HttpEvent<DeliveryBookings>>;
     /**
      * Delivery booking list
+     * @endpoint get /deliveryBookings/search
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1874,6 +1986,7 @@ declare class DeliveryBookingsService extends BaseService {
      * @param searchTerm
      * @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.
+     * @param options additional options
      */
     getDeliveryBookingsFromIndex($skip?: number, $top?: number, $orderby?: string, $filter?: string, searchTerm?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1982,6 +2095,7 @@ declare class DocumentsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Getting a shipment documents
+     * @endpoint get /documents/{recordId}/{artifact}
      * @param recordId
      * @param artifact
      * @param $skip
@@ -1991,6 +2105,7 @@ declare class DocumentsService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getShipmentDocuments(recordId: string, artifact: WorkflowArtifacts, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2016,8 +2131,10 @@ declare class HealthService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Api health check
+     * @endpoint get /health
      * @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.
+     * @param options additional options
      */
     getHealth(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'text/plain' | 'application/json';
@@ -2128,9 +2245,11 @@ declare class NotesService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Create new note
+     * @endpoint post /notes
      * @param note
      * @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.
+     * @param options additional options
      */
     createNote(note?: Note, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2149,6 +2268,7 @@ declare class NotesService extends BaseService {
     }): Observable<HttpEvent<Note>>;
     /**
      * Getting  notes
+     * @endpoint get /notes/{sourceId}/{type}
      * @param sourceId
      * @param type
      * @param $skip
@@ -2158,6 +2278,7 @@ declare class NotesService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getNotes(sourceId: string, type: NoteSourceType, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2176,6 +2297,7 @@ declare class NotesService extends BaseService {
     }): Observable<HttpEvent<Notes>>;
     /**
      * Getting notes by category
+     * @endpoint get /notes/{sourceId}/{type}/{category}
      * @param sourceId
      * @param type
      * @param category
@@ -2186,6 +2308,7 @@ declare class NotesService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getNotesByCategory(sourceId: string, type: NoteSourceType, category: NoteCategory, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2211,8 +2334,10 @@ declare class PendoService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Retrieve the Pendo API key
+     * @endpoint get /pendo/api-key
      * @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.
+     * @param options additional options
      */
     getPendoApiKey(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2252,8 +2377,10 @@ declare class PermissionsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * User permissions
+     * @endpoint get /user/permissions
      * @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.
+     * @param options additional options
      */
     getUserPermissions(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2300,9 +2427,11 @@ declare class PoItemsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Getting a po item summary  by id
+     * @endpoint get /poItems/{id}/summary
      * @param id
      * @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.
+     * @param options additional options
      */
     getPoItemSummary(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2475,9 +2604,9 @@ interface PurchaseOrderSummary {
     poDate: string;
     shippingTermLocation: string;
     deliveryDate: string | null;
-    state: PurchaseOrderState;
-    shippingTerms: ShipmentTerm;
-    transportMode: TransportMode;
+    state: PurchaseOrderState | null;
+    shippingTerms: ShipmentTerm | null;
+    transportMode: TransportMode | null;
     noOfLines: number;
     totalUnits: number;
     exDate: string | null;
@@ -2518,9 +2647,9 @@ interface PurchaseOrderGridView {
     poDate: string;
     shippingTermLocation: string;
     deliveryDate: string | null;
-    state: PurchaseOrderState;
-    shippingTerms: ShipmentTerm;
-    transportMode: TransportMode;
+    state: PurchaseOrderState | null;
+    shippingTerms: ShipmentTerm | null;
+    transportMode: TransportMode | null;
     noOfLines: number;
     totalUnits: number;
     exDate: string | null;
@@ -2583,12 +2712,12 @@ interface UnbookedPoLineItem {
     colour: string;
     attributeList: string;
     size: string;
-    state: PoItemState;
+    state: PoItemState | null;
     customerDeliveryRef: string;
     restrictSplit: boolean | null;
     buyersItemNumber: string;
     latestExDate: string | null;
-    shippingTerms: ShipmentTerm;
+    shippingTerms: ShipmentTerm | null;
     purchaseOrderId: string | null;
     dcId: string | null;
     dc?: PoItemDc;
@@ -2625,9 +2754,11 @@ declare class PurchaseOrdersService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Getting a Po Item totals
+     * @endpoint get /purchaseOrders/{purchaseOrderId}/itemTotals
      * @param purchaseOrderId
      * @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.
+     * @param options additional options
      */
     getPoItemTotals(purchaseOrderId: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2646,6 +2777,7 @@ declare class PurchaseOrdersService extends BaseService {
     }): Observable<HttpEvent<PoItemTotals>>;
     /**
      * Getting purchas order items
+     * @endpoint get /purchaseOrders/{id}/items
      * @param id
      * @param $skip
      * @param $top
@@ -2654,6 +2786,7 @@ declare class PurchaseOrdersService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getPurchaseOrderProducts(id: string, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2672,9 +2805,11 @@ declare class PurchaseOrdersService extends BaseService {
     }): Observable<HttpEvent<PurchaseOrderItems>>;
     /**
      * Getting a purchas order summary by id
+     * @endpoint get /purchaseOrders/{id}/summary
      * @param id
      * @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.
+     * @param options additional options
      */
     getPurchaseOrderSummary(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2693,6 +2828,7 @@ declare class PurchaseOrdersService extends BaseService {
     }): Observable<HttpEvent<PurchaseOrderSummary>>;
     /**
      * Purchase orders list
+     * @endpoint get /purchaseOrders
      * @param $skip
      * @param $top
      * @param $orderby
@@ -2700,6 +2836,7 @@ declare class PurchaseOrdersService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getPurchaseOrders($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2718,6 +2855,7 @@ declare class PurchaseOrdersService extends BaseService {
     }): Observable<HttpEvent<PurchaseOrders>>;
     /**
      * Purchase orders list
+     * @endpoint get /purchaseOrders/search
      * @param $skip
      * @param $top
      * @param $orderby
@@ -2725,6 +2863,7 @@ declare class PurchaseOrdersService extends BaseService {
      * @param searchTerm
      * @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.
+     * @param options additional options
      */
     getPurchaseOrdersFromIndex($skip?: number, $top?: number, $orderby?: string, $filter?: string, searchTerm?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2743,6 +2882,7 @@ declare class PurchaseOrdersService extends BaseService {
     }): Observable<HttpEvent<PurchaseOrders>>;
     /**
      * Get Unbooked Purchase Order Line Items
+     * @endpoint get /purchaseOrders/unbookedPoLineItems
      * @param $skip
      * @param $top
      * @param $orderby
@@ -2750,6 +2890,7 @@ declare class PurchaseOrdersService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getUnbookedPoLineItems($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2915,8 +3056,10 @@ declare class ReportsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Request DCM dashboard reports list
+     * @endpoint get /reports/dashboard-dcm
      * @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.
+     * @param options additional options
      */
     getDcmReports(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2935,8 +3078,10 @@ declare class ReportsService extends BaseService {
     }): Observable<HttpEvent<DashboardReports>>;
     /**
      * Request DCM summary dashboard report embedding links
+     * @endpoint get /reports/summary-dashboard
      * @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.
+     * @param options additional options
      */
     getSummaryDashboardReports(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -2991,10 +3136,12 @@ declare class SettingsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Delete a specific setting by group and key
+     * @endpoint delete /users/me/settings/groups/{group}/{key}
      * @param key
      * @param group
      * @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.
+     * @param options additional options
      */
     deleteSettingByGroupAndKey(key: string, group: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: undefined;
@@ -3013,9 +3160,11 @@ declare class SettingsService extends BaseService {
     }): Observable<HttpEvent<any>>;
     /**
      * Delete a specific setting by key
+     * @endpoint delete /users/me/settings/{key}
      * @param key
      * @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.
+     * @param options additional options
      */
     deleteSettingByKey(key: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: undefined;
@@ -3034,10 +3183,12 @@ declare class SettingsService extends BaseService {
     }): Observable<HttpEvent<any>>;
     /**
      * Get a specific setting by group and key
+     * @endpoint get /users/me/settings/groups/{group}/{key}
      * @param key
      * @param group
      * @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.
+     * @param options additional options
      */
     getSettingByGroupAndKey(key: string, group: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -3056,9 +3207,11 @@ declare class SettingsService extends BaseService {
     }): Observable<HttpEvent<SettingValue>>;
     /**
      * Get a specific setting by key
+     * @endpoint get /users/me/settings/{key}
      * @param key
      * @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.
+     * @param options additional options
      */
     getSettingByKey(key: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -3077,9 +3230,11 @@ declare class SettingsService extends BaseService {
     }): Observable<HttpEvent<SettingValue>>;
     /**
      * Get settings by group
+     * @endpoint get /users/me/settings/groups/{group}
      * @param group
      * @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.
+     * @param options additional options
      */
     getSettingsByGroup(group: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -3098,10 +3253,12 @@ declare class SettingsService extends BaseService {
     }): Observable<HttpEvent<Array<SettingView>>>;
     /**
      * Create or update a specific setting by key
+     * @endpoint put /users/me/settings/{key}
      * @param key
      * @param settingValue
      * @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.
+     * @param options additional options
      */
     setSettingByKey(key: string, settingValue: SettingValue, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -3481,13 +3638,13 @@ interface ShipmentAirRouting {
     arrivalCountry: string;
     originPort: string;
     destinationPort: string;
-    type: JourneySegmentType;
+    type: JourneySegmentType | null;
     closingDate: string | null;
     atd: string | null;
     ata: string | null;
     legNumber: number | null;
-    transportMode: TransportMode;
-    routingLegType: RoutingLegType;
+    transportMode: TransportMode | null;
+    routingLegType: RoutingLegType | null;
     vehicleNumber: string;
     arrivalTerminal: string;
     departureTerminal: string;
@@ -3514,13 +3671,13 @@ interface ShipmentRoadRouting {
     arrivalCountry: string;
     originPort: string;
     destinationPort: string;
-    type: JourneySegmentType;
+    type: JourneySegmentType | null;
     closingDate: string | null;
     atd: string | null;
     ata: string | null;
     legNumber: number | null;
-    transportMode: TransportMode;
-    routingLegType: RoutingLegType;
+    transportMode: TransportMode | null;
+    routingLegType: RoutingLegType | null;
     vehicleNumber: string;
     cmrNumber: string;
 }
@@ -3546,13 +3703,13 @@ interface ShipmentSeaRouting {
     arrivalCountry: string;
     originPort: string;
     destinationPort: string;
-    type: JourneySegmentType;
+    type: JourneySegmentType | null;
     closingDate: string | null;
     atd: string | null;
     ata: string | null;
     legNumber: number | null;
-    transportMode: TransportMode;
-    routingLegType: RoutingLegType;
+    transportMode: TransportMode | null;
+    routingLegType: RoutingLegType | null;
     vehicleNumber: string;
     voyage: string;
 }
@@ -3799,6 +3956,8 @@ declare const CwStates: {
     readonly Booked: "Booked";
     readonly Planned: "Planned";
     readonly Confirmed: "Confirmed";
+    readonly Loading: "Loading";
+    readonly Secured: "Secured";
 };
 type CwStates = typeof CwStates[keyof typeof CwStates];
 
@@ -3935,6 +4094,7 @@ declare class ShipmentsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Shipment approvals list
+     * @endpoint get /shipments/approvals
      * @param $skip
      * @param $top
      * @param $orderby
@@ -3942,6 +4102,7 @@ declare class ShipmentsService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getShipmentApprovals($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -3960,6 +4121,7 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentApprovals>>;
     /**
      * Shipment approvals list
+     * @endpoint get /shipments/approvals/search
      * @param $skip
      * @param $top
      * @param $orderby
@@ -3967,6 +4129,7 @@ declare class ShipmentsService extends BaseService {
      * @param searchTerm
      * @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.
+     * @param options additional options
      */
     getShipmentApprovalsFromIndex($skip?: number, $top?: number, $orderby?: string, $filter?: string, searchTerm?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -3985,9 +4148,11 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentApprovals>>;
     /**
      * Shipment items list
+     * @endpoint get /shipments/{id}/items
      * @param id
      * @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.
+     * @param options additional options
      */
     getShipmentItems(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4006,9 +4171,11 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentItems>>;
     /**
      * Getting a shipment product totals
+     * @endpoint get /shipments/{shipmentId}/productTotals
      * @param shipmentId
      * @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.
+     * @param options additional options
      */
     getShipmentProductTotals(shipmentId: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4027,6 +4194,7 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentProductTotals>>;
     /**
      * Getting a shipment products
+     * @endpoint get /shipments/{id}/products
      * @param id
      * @param $skip
      * @param $top
@@ -4035,6 +4203,7 @@ declare class ShipmentsService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getShipmentProducts(id: string, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4053,10 +4222,12 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentProducts>>;
     /**
      * Getting a shipment routing by shipmentId
+     * @endpoint get /shipments/{shipmentId}/{type}/routing
      * @param shipmentId
      * @param type
      * @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.
+     * @param options additional options
      */
     getShipmentRouting(shipmentId: string, type: TransportMode, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4075,9 +4246,11 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<Array<ShipmentRoutingsInner>>>;
     /**
      * Getting a shipment summary by id
+     * @endpoint get /shipments/{id}/summary
      * @param id
      * @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.
+     * @param options additional options
      */
     getShipmentSummary(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4096,9 +4269,11 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentSummary>>;
     /**
      * Getting a shipment timeline
+     * @endpoint get /shipments/{id}/timeline
      * @param id
      * @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.
+     * @param options additional options
      */
     getShipmentTimeline(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4117,6 +4292,7 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<Array<ShipmentTimelineInner>>>;
     /**
      * Shipments list
+     * @endpoint get /shipments/list
      * @param $skip
      * @param $top
      * @param $orderby
@@ -4124,6 +4300,7 @@ declare class ShipmentsService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getShipments($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4142,8 +4319,10 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<Shipments>>;
     /**
      * Approval waiting shipments
+     * @endpoint get /shipments/approvals/count
      * @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.
+     * @param options additional options
      */
     getShipmentsApprovalCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4162,9 +4341,11 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentsApprovalCount>>;
     /**
      * Get shipments count by state
+     * @endpoint get /shipments/byStateCount/{state}
      * @param state
      * @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.
+     * @param options additional options
      */
     getShipmentsCountByState(state: ShipmentState, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4183,6 +4364,7 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentsCount>>;
     /**
      * Shipments list
+     * @endpoint get /shipments/search
      * @param $skip
      * @param $top
      * @param $orderby
@@ -4190,6 +4372,7 @@ declare class ShipmentsService extends BaseService {
      * @param searchTerm
      * @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.
+     * @param options additional options
      */
     getShipmentsFromIndex($skip?: number, $top?: number, $orderby?: string, $filter?: string, searchTerm?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4208,8 +4391,10 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<Shipments>>;
     /**
      * In transit shipments
+     * @endpoint get /shipments/intransit/count
      * @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.
+     * @param options additional options
      */
     getShipmentsInTransitCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4228,8 +4413,10 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentsInTransitCount>>;
     /**
      * Get shipments pending documents
+     * @endpoint get /shipments/vendorPendingDocuments/count
      * @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.
+     * @param options additional options
      */
     getShipmentsPendingDocuments(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4248,8 +4435,10 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentsCount>>;
     /**
      * Get pending shipment instructions
+     * @endpoint get /shipments/vendorPendingInstructions/count
      * @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.
+     * @param options additional options
      */
     getShipmentsPendingInstructions(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4268,10 +4457,12 @@ declare class ShipmentsService extends BaseService {
     }): Observable<HttpEvent<ShipmentsCount>>;
     /**
      * Update the shipment state
+     * @endpoint put /shipments/{id}/{state}
      * @param id
      * @param state
      * @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.
+     * @param options additional options
      */
     updateShipmentState(id: string, state: ShipmentState, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4337,6 +4528,7 @@ declare class SipmetItemsService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Getting shipment items summary list
+     * @endpoint get /shipmentItems/summaries
      * @param id
      * @param $skip
      * @param $top
@@ -4345,6 +4537,7 @@ declare class SipmetItemsService extends BaseService {
      * @param $search
      * @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.
+     * @param options additional options
      */
     getShipmentItemSummaries(id: string, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4483,8 +4676,10 @@ declare class UserService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Chat messages pending count
+     * @endpoint get /user/chatCount
      * @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.
+     * @param options additional options
      */
     getChatPendingCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4503,8 +4698,10 @@ declare class UserService extends BaseService {
     }): Observable<HttpEvent<PendingMessagesCount>>;
     /**
      * Mail messages pending count
+     * @endpoint get /user/mailCount
      * @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.
+     * @param options additional options
      */
     getMailPendingCount(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4523,8 +4720,10 @@ declare class UserService extends BaseService {
     }): Observable<HttpEvent<PendingMessagesCount>>;
     /**
      * Get User application list
+     * @endpoint get /users/me/applications
      * @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.
+     * @param options additional options
      */
     getUserApplicationList(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4543,8 +4742,10 @@ declare class UserService extends BaseService {
     }): Observable<HttpEvent<UserApplications>>;
     /**
      * User information
+     * @endpoint get /user/me
      * @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.
+     * @param options additional options
      */
     getUserInfo(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -4563,9 +4764,11 @@ declare class UserService extends BaseService {
     }): Observable<HttpEvent<CurrentUser>>;
     /**
      * Set NewFeaturesVisibility setting
+     * @endpoint put /user/me/settings/newfeaturevisibility
      * @param setNewFeaturesVisibilityCommand
      * @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.
+     * @param options additional options
      */
     setNewFeaturesVisibility(setNewFeaturesVisibilityCommand?: SetNewFeaturesVisibilityCommand, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';