@indigina/myseko-api 0.0.17 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indigina/myseko-api",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "OpenAPI client for @indigina/myseko-api",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -13,17 +13,17 @@
   ],
   "license": "Unlicense",
   "peerDependencies": {
-    "@angular/core": "^20.1.3",
+    "@angular/core": "^21.1.0",
     "rxjs": "^7.4.0"
   },
   "module": "fesm2022/indigina-myseko-api.mjs",
-  "typings": "index.d.ts",
+  "typings": "types/indigina-myseko-api.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
     },
     ".": {
-      "types": "./index.d.ts",
+      "types": "./types/indigina-myseko-api.d.ts",
       "default": "./fesm2022/indigina-myseko-api.mjs"
     }
   },

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

@@ -146,6 +146,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;
+}
+
 /**
  * MySeko.API.Client
  *
@@ -163,8 +221,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 AuthService extends BaseService {
@@ -172,8 +229,10 @@ declare class AuthService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * User login
+     * @endpoint post /myseko/auth/login
      * @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
      */
     userLogin(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: undefined;
@@ -266,6 +325,7 @@ declare class CalendarService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Returns Calendar for a given range
+     * @endpoint get /myseko/shipments/calendar/{startDate}/{endDate}
      * @param startDate
      * @param endDate
      * @param viewBy
@@ -278,6 +338,7 @@ declare class CalendarService extends BaseService {
      * @param $skip
      * @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
      */
     getShipmentCalendarRange(startDate: string, endDate: string, viewBy?: CalendarViewBy, searchTerm?: string, $filter?: string, $orderby?: string, $select?: string, $expand?: string, $top?: number, $skip?: number, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -332,8 +393,10 @@ declare class DashboardService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Get active shipments statistics
+     * @endpoint get /myseko/dashboard/active-shipments
      * @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
      */
     getActiveShipments(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -352,8 +415,10 @@ declare class DashboardService extends BaseService {
     }): Observable<HttpEvent<ActiveShipment>>;
     /**
      * Get deliveries today statistics
+     * @endpoint get /myseko/dashboard/deliveries-today
      * @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
      */
     getDeliveriesToday(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -379,8 +444,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';
@@ -435,10 +502,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;
@@ -457,9 +526,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;
@@ -478,10 +549,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';
@@ -500,9 +573,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';
@@ -521,9 +596,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';
@@ -542,10 +619,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';
@@ -937,9 +1016,11 @@ declare class ShipmentService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Get shipment package details by ordOrderID
+     * @endpoint get /myseko/shipments/{ordOrderID}/package-details
      * @param ordOrderID
      * @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
      */
     getShipmentPackageDetails(ordOrderID: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -958,9 +1039,11 @@ declare class ShipmentService extends BaseService {
     }): Observable<HttpEvent<PackageDetails>>;
     /**
      * Get shipment purchase order details by ordOrderID
+     * @endpoint get /myseko/shipments/{ordOrderID}/purchase-order-details
      * @param ordOrderID
      * @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
      */
     getShipmentPurchaseOrderDetails(ordOrderID: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -979,9 +1062,11 @@ declare class ShipmentService extends BaseService {
     }): Observable<HttpEvent<ShipmentPurchaseOrderDetails>>;
     /**
      * Get shipment summary by ordOrderID
+     * @endpoint get /myseko/shipments/{ordOrderID}/summary
      * @param ordOrderID
      * @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(ordOrderID: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1000,9 +1085,11 @@ declare class ShipmentService extends BaseService {
     }): Observable<HttpEvent<ShipmentSummary>>;
     /**
      * Get shipment timeline events by ordOrderID
+     * @endpoint get /myseko/shipments/{ordOrderID}/timeline
      * @param ordOrderID
      * @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(ordOrderID: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1021,12 +1108,14 @@ declare class ShipmentService extends BaseService {
     }): Observable<HttpEvent<ShipmentTimeline>>;
     /**
      * Get all shipments
+     * @endpoint get /myseko/shipments
      * @param $skip
      * @param $top
      * @param $orderby
      * @param $filter
      * @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, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1045,6 +1134,7 @@ declare class ShipmentService extends BaseService {
     }): Observable<HttpEvent<Shipments>>;
     /**
      * Get all shipments
+     * @endpoint get /myseko/shipments/search
      * @param $skip
      * @param $top
      * @param $orderby
@@ -1052,6 +1142,7 @@ declare class ShipmentService 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
      */
     getShipmentsWithSearch($skip?: number, $top?: number, $orderby?: string, $filter?: string, searchTerm?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1127,8 +1218,10 @@ declare class UserService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Get current user information
+     * @endpoint get /myseko/users/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
      */
     getUser(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1154,8 +1247,10 @@ declare class UsergroupService extends BaseService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Get user group for current user
+     * @endpoint get /myseko/users/me/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
      */
     getUserGroup(observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -1174,9 +1269,11 @@ declare class UsergroupService extends BaseService {
     }): Observable<HttpEvent<RegGroup>>;
     /**
      * Set user group for current user
+     * @endpoint patch /myseko/users/me/group
      * @param regGroupID
      * @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
      */
     setUserGroup(regGroupID: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: undefined;