CdsRestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  CdsRestClient.qm Copyright (C) 2023 - 2024 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 OAuth2AuthUrl= sprintf("%scommon%s", OAuth2BaseUrl, OAuth2AuthUriPathSuffix);
 
        const OAuth2TokenUrl = sprintf("%scommon%s", OAuth2BaseUrl, OAuth2TokenUriPathSuffix);
 
        const DefaultApiVersion = "9.2";
 
        const RequestUriPathPrefix = "/api/data/v";
 
        const DefaultBusinessCentralBaseUri = "https://api.businesscentral.dynamics.com/";
 
        const DefaultDynamicsPingMethod = "GET";
 
        const DefaultDynamicsPingPath = "{api_uri_path}/WhoAmI";
 
        const DefaultDynamicsPingHeaders = ...;
 
 
        const ApiProfiles = ...;
 
 
private:
        string api;
        string uri_path_pfx;
 
public:
 
 
    constructor(hash<auto> opts, *softbool do_not_connect) ;
 
 
    string getApi();
 
 
      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, *string assume_content_type, *string shdr, *code signer);
public:
 
};
 
 
class CdsRestConnection : public RestClient::RestConnection {
 
public:
        const ConnectionScheme = ...;
 
 
        const OAuth2AuthRequestOptions = ...;
 
 
        const OAuth2Options = ...;
 
 
        const OAuth2StandardToCdsOptionMap = map {$1.value: $1.key}, OAuth2Options.pairIterator();
 
        const OAuth2DifferentOptionMap = map {$1.value: $1.key}, OAuth2Options.pairIterator(), $1.key != $1.value;
 
 
    constructor(hash<auto> config, *hash<auto> attr) ;
 
 
    string getType();
 
 
 
    bool hasDataProvider();
 
 
 
    *string getAppName();
 
 
 
    DataProvider::AbstractDataProvider getDataProvider(*hash<auto> constructor_options);
 
 
 
    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);
 
 
 
    bool isAuthTokenError(int status_code, hash<auto> headers, bool body_deserialized, *string body_content_type, auto body);
 
 
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:
 
};
 
class DynamicsRestConnection : public CdsRestConnection {
 
public:
        const ConnectionScheme = ...;
 
 
 
    constructor(hash<auto> config, *hash<auto> attr) : CdsRestConnection(config + {"opts": CdsRestConnection::getOptions(config.url, config.opts
                + {"api_profile": "dynamics"})}, attr) {
    }
 
    string getType();
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};