ServiceNowRestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  ServiceNowRestClient.qm Copyright (C) 2020 - 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 ServiceNowRestClient {
 
class ServiceNowRestClient : public RestClient::RestClient {
 
public:
        const OAuth2DefaultGrantType = "authorization_code";
 
        const OAuth2AuthUriPathSuffix = "/oauth_auth.do";
 
        const OAuth2TokenUriPathSuffix = "/oauth_token.do";
 
        const DefaultApiVersion = "now";
 
        const RequestUriPathPrefix = "/api/";
 
private:
        *string api;
        string uri_path_pfx;
 
public:
 
 
    constructor(hash<auto> opts, *softbool do_not_connect) ;
 
 
 
    string getApi();
 
 
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 raiseError(string fmt);
 
      static hash<auto> getOptions(hash<auto> opts);
};
 
 
class ServiceNowRestConnection : public RestClient::RestConnection {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("ServiceNowRestConnection"),
            "options": RestConnection::ConnectionScheme.options - (keys OAuth2DifferentOptionMap) + {
                "api": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the API version for ServiceNow; if not set the latest version is used",
                    "default_value": ServiceNowRestClient::DefaultApiVersion,
                },
                "client_id": RestConnection::ConnectionScheme.options.oauth2_client_id + <ConnectionOptionInfo>{
                    "desc": "the ServiceNow OAuth2 client ID",
                },
                "client_secret": RestConnection::ConnectionScheme.options.oauth2_client_secret + <ConnectionOptionInfo>{
                    "desc": "the ServiceNow OAuth2 client secret",
                    "sensitive": True,
                },
                "oauth2_auth_url": RestConnection::ConnectionScheme.options.oauth2_auth_url + <ConnectionOptionInfo>{
                    "default_value": ServiceNowRestClient::OAuth2AuthUriPathSuffix,
                },
                "oauth2_grant_type": RestConnection::ConnectionScheme.options.oauth2_grant_type + <ConnectionOptionInfo>{
                    "default_value": ServiceNowRestClient::OAuth2DefaultGrantType,
                },
                "oauth2_token_url": RestConnection::ConnectionScheme.options.oauth2_token_url + <ConnectionOptionInfo>{
                    "default_value": ServiceNowRestClient::OAuth2TokenUriPathSuffix,
                },
                "password": RestConnection::ConnectionScheme.options.password + <ConnectionOptionInfo>{
                    "desc": "the ServiceNow password",
                    "sensitive": True,
                },
                "ping_headers": RestConnection::ConnectionScheme.options."ping_headers" + <ConnectionOptionInfo>{
                    "default_value": DefaultServiceNowPingHeaders,
                },
                "ping_method": RestConnection::ConnectionScheme.options."ping_method" + <ConnectionOptionInfo>{
                    "default_value": DefaultServiceNowPingMethod,
                },
                "ping_path": RestConnection::ConnectionScheme.options."ping_path" + <ConnectionOptionInfo>{
                    "default_value": DefaultServiceNowPingPath,
                },
                "username": RestConnection::ConnectionScheme.options.username + <ConnectionOptionInfo>{
                    "desc": "the ServiceNow username",
                },
            },
            "required_options": "username,password|token|client_id,client_secret",
        };
 
        const DefaultServiceNowPingMethod= "GET";
 
        const DefaultServiceNowPingPath = ...;
 
 
        const DefaultServiceNowPingHeaders = {
            "Accept": MimeTypeJson,
        };
 
        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 OAuth2StandardToServiceNowOptionMap = 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 getOAuth2OptionName(string opt);
 
 
 
    hash<auto> getOAuth2Options();
 
 
 
    Qore::AbstractPollOperation startPollConnect();
 
 
protected:
     checkAuthCodeFeature();
public:
 
 
protected:
     setChildCapabilities();
public:
 
 
 
protected:
     ServiceNowRestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};