@sap_oss/wdio-qmate-service 2.7.2 → 2.7.4

package/lib/reuse/modules/service/odata.d.ts

@@ -1,3 +1,9 @@
+interface IHeaders {
+    [key: string]: string;
+}
+interface IParams {
+    [key: string]: string;
+}
 /**
  * @class odata
  * @memberof service
@@ -11,48 +17,58 @@ export declare class OData {
     /**
      * @function init
      * @memberOf service.odata
-     * @description Initializes The service to work with.
+     * @description Initializes the OData Service.
      * XCSRF-Token will be automatically fetched and stored in the service instance.
      * Cookies will also automatically assembled and stored in the service instance.
-     * @param {String} url - The base url of the service
-     * @param {String} username - The username.
+     * @param {String} url - The base url of the service.
+     * @param {String} username - The username to authenticate the service.
      * @param {String} password - The password of the username.
-     * @param {boolean}  [loggingEnabled=false] - The boolean param to control whether user wants to see logs during build run
-     * @param {Object} [params={}] - JSON object with key-value pairs of parameter names and corresponding values
-     * by default we send {
+     * @param {Boolean}  [loggingEnabled=false] - The boolean param to control whether user wants to see logs during build run.
+     * @param {Object} [params={}] - JSON object with key-value pairs of parameter names and corresponding values.
+     * By default we send {
      *  "client": "715",
      *  "documentation": ["heading", "quickinfo"],
      *  "language": "EN"
      * }
-     * These can be overridden by sending params as JSON object with additional params as shown in example
+     * These can be overridden by sending params as JSON object with additional params as shown in example.
      * @param {String} [authType] - authentication type, in case you want to override the default
      * SAML authentication. Set this to "basic", to use basic authentication for communication users for whom SAML login doesn't work.
      * Or "none" for no authentication.
+     * @param {Object} [headers=undefined] - JSON object with key-value pairs of optional headers.
      * @returns {Object} The initialized service object.
      * @example const url = "<urlToSystem>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/";
      * const params = {
      *  "saml2": "disabled",
      *  "language": "de"
      * }
-     * srv = await service.odata.init(url, user, password, false, params);
+     * const srv = await service.odata.init(url, user, password, false, params);
+     * @example const base64Credentials = Buffer.from(`${user}:${password}`).toString("base64");
+     * const authHeaders = {
+     *   "Authorization": `Basic ${base64Credentials}`,
+     *   "DwC-Tenant": tenant
+     * };
+     *
+     * const srv = await service.odata.init(url, user, password, true, params, "headers", authHeaders);
      */
-    init(url: string, username: string, password: string, loggingEnabled?: boolean, params?: {}, authType?: string): Promise<any>;
+    init(url: string, username: string, password: string, loggingEnabled?: boolean, params?: {}, authType?: string, headers?: any): Promise<any>;
     /**
      * @function get
      * @memberOf service.odata
-     * @description makes a GET request.
-     * @param {Object} srv - Instance of the service
-     * @param {String} entitySet - The entitySet you want to GET from.
-     * @param {Object} keys - The required keys for the GET-request.
-     * @param {Boolean} raw - Response includes all header contents.
+     * @description Sends a GET request to retrieve data from the specified OData entity set.
+     * @param {Object} srv - An instance of the service.
+     * @param {String} entitySet - The entity set from which data is to be retrieved.
+     * @param {Object} keys - The required keys for the GET request.
+     * @param {Boolean} [raw=false] - Specifies whether the response should include all header contents.
+     * @param {Object} [headers] - Optional headers to be included in the request.
+     * @returns {Promise} A Promise that resolves to the response data.
      * @example const url = "<baseUrl>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/";
-     * srv = await service.odata.init(url, user, password);
+     * const srv = await service.odata.init(url, user, password);
      * const keys = {
      *   PurchaseOrder: "4100000000"
      * };
      * const res = await service.odata.get(srv, "A_PurchaseOrder", keys);
      */
-    get(srv: any, entitySet: string, keys: any, raw?: boolean): Promise<any>;
+    get(srv: any, entitySet: string, keys: any, raw?: boolean, headers?: IHeaders): Promise<any>;
     /**
      * @function getEntitySet
      * @memberOf service.odata
@@ -62,7 +78,7 @@ export declare class OData {
      * @param {String} [filterString] - The filters to be applied on get query
      * @param {String} [selectionFields] - comma separated list of fields to be selected
      * @param {Object} [queryParams] - JSON object of key value pairs of custom query parameters.
-     * @returns {Array} - Result set array
+     * @returns {Promise} A Promise that resolves to the response data.
      * @example
      * const url = "<baseUrl>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/";
      * srv = await service.odata.init(url, user, password);
@@ -80,73 +96,69 @@ export declare class OData {
      * let res = await service.odata.getEntitySet(srv, "A_PurchaseOrder", filterString, select, queryParams);
      */
     getEntitySet(srv: any, entitySet: string, filterString?: string, selectionFields?: string, queryParams?: any): Promise<any>;
-    /**
-     * @function isFeatureToggleActivated
-     * @memberOf service.odata
-     * @description checks if a feature toggle is switched on or off
-     * @param {Object} srv - Instance of the service
-     * @param {String} featureName - The name of the feature you want know the status of.
-     * @example const url = browser.params.systemUrl + "/sap/opu/odata/SAP/CA_FM_FEATURE_TOGGLE_STATUS_SRV/";
-     * const srv = await service.odata.init(url, user, password);
-     * let isFeatureActive = await service.odata.isFeatureToggleActivated(srv, "MM_PUR_PO_BATCHES_IN_MANAGE_PO");
-     */
-    isFeatureToggleActivated(srv: any, featureName: string): Promise<boolean>;
     /**
      * @function post
      * @memberOf service.odata
-     * @description makes a POST request.
+     * @description Sends a POST request to retrieve data from the specified OData entity set for the given payload.
      * @param {Object} srv - Instance of the service
      * @param {String} entitySet - The entitySet you want to POST against.
-     * @param {Object} payload - The payload for the POST-request.
-     * @param {Boolean} raw - Response includes all header contents.
+     * @param {Object} payload - The payload of the POST request.
+     * @param {Boolean} [raw=false] - Specifies whether the response should include all header contents.
+     * @param {Object} [headers] - Optional headers to be included in the request.
+     * @returns {Promise} A Promise that resolves to the response data.
      * @example
-     * let payload = {
+     * const payload = {
      *  "PurchaseOrder": "4500007108",
      *  "DraftUUID": "00000000-0000-0000-0000-000000000000",
      *  "IsActiveEntity": "true"
      * };
-     * let res = await service.odata.post(srv, "A_PurchaseOrder", payload);
+     * const res = await service.odata.post(srv, "A_PurchaseOrder", payload);
      */
-    post(srv: any, entitySet: string, payload: any, raw?: boolean): Promise<any>;
+    post(srv: any, entitySet: string, payload: any, raw?: boolean, headers?: IHeaders): Promise<any>;
     /**
      * @function merge
      * @memberOf service.odata
-     * @description makes a MERGE request.
+     * @description @description Sends a MERGE request to merge data from the specified OData entity set for the given payload.
      * @param {Object} srv - Instance of the service
      * @param {String} entitySet - The entitySet you want to MERGE in.
-     * @param {Object} payload - The payload for the MERGE-request.
+     * @param {Object} payload - The payload of the MERGE request.
+     * @param {Object} [headers] - Optional headers to be included in the request.
+     * @returns {Promise} A Promise that resolves to the response data.
      * @example
-     * let res = await service.odata.merge(srv, "A_PurchaseOrderScheduleLine", {
+     * const res = await service.odata.merge(srv, "A_PurchaseOrderScheduleLine", {
      *  "PurchasingDocument": "4500007108",
      *  "PurchasingDocumentItem": "10",
      *  "ScheduleLine": "1",
      *  "ScheduleLineDeliveryDate": new Date()
      * };
      */
-    merge(srv: any, entitySet: string, payload: any): Promise<any>;
+    merge(srv: any, entitySet: string, payload: any, headers?: IHeaders): Promise<any>;
     /**
      * @function delete
      * @memberOf service.odata
-     * @description makes a DELETE request.
-     * @param {Object} srv - Instance of the service
+     * @description Sends a DELETE request to the specified OData entity set.
+     * @param {Object} srv - Instance of the service.
      * @param {String} entitySet - The entitySet you want to DELETE.
-     * @param {Object} options - The options for the DELETE-request.
+     * @param {Object} options - The options for the DELETE request.
+     * @param {Object} [headers] - Optional headers to be included in the request.
+     * @returns {Promise} A Promise that resolves to the response data.
      * @example
-     * let options = {
+     * const options = {
      *  "PurchaseOrder": "",
      *  "DraftUUID": draftUUID,
      *  "IsActiveEntity": false
      * };
-     * await service.odata.delete(srv, "C_PurchaseOrderTP", options);
+     * const res = await service.odata.delete(srv, "C_PurchaseOrderTP", options);
      */
-    delete(srv: any, entitySet: string, options: any): Promise<any>;
+    delete(srv: any, entitySet: string, options: any, headers?: IHeaders): Promise<any>;
     /**
      * @function callFunctionImport
      * @memberOf service.odata
-     * @description makes a function import request on an OData service.
-     * @param {Object} srv - Instance of the service
-     * @param {String} functionImportName - Name of Function Import
-     * @param {Object} options - parameters for function import
+     * @description Sends a function import request to the OData service instance.
+     * @param {Object} srv - Instance of the service.
+     * @param {String} functionImportName - Name of Function Import.
+     * @param {Object} options - Parameters for function import.
+     * @returns {Promise} A Promise that resolves to the response data.
      * @example
      * const options = {
      *  CentralRequestForQuotation : "7500000026",
@@ -155,6 +167,18 @@ export declare class OData {
      * const res = await service.odata.callFunctionImport(srv, "Cancel", options);
      */
     callFunctionImport(srv: any, functionImportName: string, options: any): Promise<any>;
+    /**
+     * @function isFeatureToggleActivated
+     * @memberOf service.odata
+     * @description Checks if a feature toggle is switched on or off.
+     * @param {Object} srv - Instance of the service
+     * @param {String} featureName - The name of the feature you want know the status of.
+     * @returns {Promise} A Promise that resolves to a bool value.
+     * @example const url = browser.params.systemUrl + "/sap/opu/odata/SAP/CA_FM_FEATURE_TOGGLE_STATUS_SRV/";
+     * const srv = await service.odata.init(url, user, password);
+     * let isFeatureActive = await service.odata.isFeatureToggleActivated(srv, "MM_PUR_PO_BATCHES_IN_MANAGE_PO");
+     */
+    isFeatureToggleActivated(srv: any, featureName: string): Promise<boolean>;
     /**
      * @function getOutputManagementPdfStream
      * @memberOf service.odata
@@ -186,6 +210,8 @@ export declare class OData {
      */
     readPdfFromDirectUrl(url: string, username: string, password: string, isSaml?: boolean): Promise<any>;
     _doRequest(url: string, username: string, password: string, isSaml: boolean): Promise<any>;
+    _applyHeaders(entity: any, headers: IHeaders): any;
+    _applyQueryParameters(entity: any, params: IParams): any;
 }
 declare const _default: OData;
 export default _default;