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 OAuth2BaseUrl = "https://login.microsoftonline.com/";
 
        const OAuth2AuthUriPathSuffix = "/oauth2/v2.0/authorize";
 
        const OAuth2TokenUriPathSuffix = "/oauth2/v2.0/token";
 
        const DefaultApiVersion = "9.2";
 
        const RequestUriPathPrefix = "/api/data/v";
 
        const DefaultBusinessCentralBaseUri = "https://api.businesscentral.dynamics.com/";
 
        const DefaultDynamicsPingMethod = "GET";
 
        const DefaultDynamicsPingPath = "{api_uri_path}/systemusers?$top=1&$select=identityid";
 
        const DefaultDynamicsPingHeaders = {
            "Accept": MimeTypeJson,
        };
 
        const ApiProfiles = {
            "none": {},
            "dynamics": {
                "oauth2_scopes": (
                    "offline_access",
                    "{url}.default",
                ),
                "ping_method": DefaultDynamicsPingMethod,
                "ping_path": DefaultDynamicsPingPath,
                "ping_headers": DefaultDynamicsPingHeaders,
            },
            "dynamics-business-central": {
                "url": DefaultBusinessCentralBaseUri,
                "oauth2_scopes": (
                    "offline_access",
                    "{url}.default",
                ),
            },
        };
 
private:
        string api;
        string tenant;
        string uri_path_pfx;
 
public:
 
 
    constructor(hash<auto> opts, *softbool do_not_connect) ;
 
 
    string getApi();
 
 
      static string getString(hash<auto> opts, string key);
 
      static raiseError(string fmt);
 
      static hash<auto> getOptions(hash<auto> opts);
 
protected:
     hash<auto> sendAndDecodeResponse(*data body, string m, string path, hash<auto> hdr, *reference<hash<auto>> info, *softbool decode_errors);
public:
 
};
 
 
class CdsRestConnection : public RestClient::RestConnection {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("CdsRestConnection"),
            "options": RestConnection::ConnectionScheme.options - (keys OAuth2DifferentOptionMap) + {
                "api": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the API version for CDS",
                    "default_value": CdsRestClient::DefaultApiVersion,
                },
                "api_profile": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the API profile according to the CDS API in use; this option will set the REST "
                        "options if they are not already set (`oauth2_scopes`, `ping_body`, `ping_headers`, and "
                        "`ping_method`); valid "
                        "values:\n"
                        "- `none`: no options configured (default)\n"
                        "- `dynamics`: set options for the Dynamics 365 API",
                    "default_value": "none",
                    "allowed_values": (
                        <AllowedValueInfo>{
                            "desc": "No options are set",
                            "value": "none",
                        },
                        <AllowedValueInfo>{
                            "desc": "Set REST client options for the Dynamics 365 API",
                            "value": "dynamics",
                        },
                        /*
                        <AllowedValueInfo>{
                            "desc": "Set REST client options for the Dynamics 365 API",
                            "value": "dynamics-business-central",
                        },
                        */
                    ),
                },
                "client_id": RestConnection::ConnectionScheme.options.oauth2_client_id + <ConnectionOptionInfo>{
                    "desc": "the Microsoft Common Data Service OAuth2 client ID",
                },
                "client_secret": RestConnection::ConnectionScheme.options.oauth2_client_secret + <ConnectionOptionInfo>{
                    "desc": "the Microsoft Common Data Service OAuth2 client secret",
                    "sensitive": True,
                },
                "data": RestConnection::ConnectionScheme.options."data" + <ConnectionOptionInfo>{
                    "default_value": "json",
                },
                "oauth2_auth_url": RestConnection::ConnectionScheme.options.oauth2_auth_url + <ConnectionOptionInfo>{
                    "default_value": "auto",
                },
                "oauth2_grant_type": RestConnection::ConnectionScheme.options.oauth2_grant_type + <ConnectionOptionInfo>{
                    "default_value": "authorization_code",
                },
                "oauth2_token_url": RestConnection::ConnectionScheme.options.oauth2_token_url + <ConnectionOptionInfo>{
                    "default_value": "auto",
                },
                "tenant": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the tenant ID",
                },
            },
            "required_options": "client_id,client_secret,tenant",
        };
 
        const OAuth2AuthRequestOptions = ...;
 
 
        const OAuth2Options = {
            "oauth2_auto_refresh": "oauth2_auto_refresh",
            "oauth2_auth_args": "oauth2_auth_args",
            "oauth2_auth_url": "oauth2_auth_url",
            "client_id": "oauth2_client_id",
            "client_secret": "oauth2_client_secret",
            "oauth2_redirect_url": "oauth2_redirect_url",
            "oauth2_refresh_token": "oauth2_refresh_token",
            "oauth2_scopes": "oauth2_scopes",
            "oauth2_token_url": "oauth2_token_url",
            "password": "password",
            "username": "username",
        };
 
        const OAuth2StandardToCdsOptionMap = map {$1.value: $1.key}, OAuth2Options.pairIterator();
 
        const OAuth2DifferentOptionMap = map {$1.value: $1.key}, OAuth2Options.pairIterator(), $1.key != $1.value;
 
 
    constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
    string getType();
 
 
 
    bool hasDataProvider();
 
 
 
    DataProvider::AbstractDataProvider getDataProvider();
 
 
 
    string getAuthorizationCodeRequest(hash<AuthCodeInfo> info = <AuthCodeInfo>{});
 
 
 
    string getOAuth2OptionName(string opt);
 
 
 
    hash<auto> getOAuth2Options();
 
 
    /*  @param allow_relative if @ref True then a relative URL (path only) can be returned; the default (@ref False)
        is to return a full URL
 
        @since %CdsRestClient 2.0
    */
    string getAuthUrl(*bool allow_relative);
 
 
    /*  @param allow_relative if @ref True then a relative URL (path only) can be returned; the default (@ref False)
        is to return a full URL
 
        @since %CdsRestClient 2.0
    */
    string getTokenUrl(*bool allow_relative);
 
 
protected:
     checkAuthCodeFeature();
public:
 
 
protected:
     setChildCapabilities();
public:
 
 
 
protected:
     CdsRestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
 
protected:
      static hash<auto> getOptions(string url, hash<auto> orig_opts);
public:
 
};
};