CdsRestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  CdsRestClient.qm Copyright (C) 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum qore version
 
// require type definitions everywhere
 
// enable all warnings
 
// don't use "$" for vars, members, and methods, assume local variable scope
 
// do not ignore argument errors
 
 
}
 
namespace CdsRestClient {
 
class CdsRestClient : public RestClient::RestClient {
 
public:
        const OAuth2AuthUrl = "https://login.microsoftonline.com";
 
        const OAuth2TokenUriPathSuffix = "/oauth2/v2.0/token";
 
        const DefaultApiVersion = "9.1";
 
        const RequestUriPathPrefix = "/api/data/v";
 
private:
        // for OAuth2-based access
        string client_id;
        string client_secret;
        string api;
        string tenant;
        string scope;
        string token;
        string uri_path_pfx;
 
public:
 
 
    constructor(hash<auto> opts, *softbool do_not_connect) ;
 
 
    string getApi();
 
 
    *string getToken();
 
 
    hash<auto> doRequest(string m, string path, auto body, *reference<hash<auto>> info, softbool decode_errors = True, *hash<auto> hdr);
 
 
protected:
     loginIntern(*reference<hash<auto>> info);
public:
 
 
protected:
     hash<auto> sendAndDecodeResponse(*data body, string m, string path, hash<auto> hdr, *reference<hash<auto>> info, *softbool decode_errors);
public:
 
 
      static string getString(hash<auto> opts, string key);
 
      static error(string fmt);
 
      static hash<auto> getOptions(hash<auto> opts);
};
 
 
class CdsRestConnection : public RestClient::RestConnection {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("CdsRestConnection"),
            "options": RestConnection::ConnectionScheme.options + {
                "api": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the API version for CDS",
                    "default_value": CdsRestClient::DefaultApiVersion,
                },
                "client_id": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Microsoft Common Data Service OAuth2 client ID",
                },
                "client_secret": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Microsoft Common Data Service OAuth2 client secret",
                    "sensitive": True,
                },
                "tenant": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the tenant ID",
                },
                "scope": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the OAuth2 scope for the login; the default it to use the target URL + `/.default`",
                },
            },
            "required_options": "client_id,client_secret,tenant",
        };
 
 
    constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
    string getType();
 
 
 
    bool hasDataProvider();
 
 
 
    DataProvider::AbstractDataProvider getDataProvider();
 
 
protected:
     setChildCapabilities();
public:
 
 
 
protected:
     CdsRestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};