SalesforceRestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  SalesforceRestClient.qm Copyright (C) 2016 - 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 SalesforceRestClient {
const BulkJobQuery = "query";
 
const BulkJobInsert = "insert";
 
const BulkJobUpdate = "update";
 
const BulkJobUpsert = "upsert";
 
const BulkJobDelete = "delete";
 
 
const BulkJobOperations = {
    BulkJobQuery: True,
    BulkJobInsert: True,
    BulkJobUpdate: True,
    BulkJobUpsert: True,
    BulkJobDelete: True,
};
 
const BulkJobCsv = "CSV";
 
const BulkJobJson = "JSON";
 
const BulkJobXml = "XML";
 
const BulkJobZipCsv = "ZIP_CSV";
 
const BulkJobZipJson = "ZIP_JSON";
 
const BulkJobZipXml = "ZIP_XML";
 
 
const BulkJobContentTypes = {
    BulkJobCsv: MimeTypeCsv,
    BulkJobJson: MimeTypeJson,
    BulkJobXml: MimeTypeXmlApp,
    BulkJobZipCsv: "zip/csv",
    BulkJobZipJson: "zip/json",
    BulkJobZipXml: "zip/xml",
};
 
 
class SalesforceRestClient : public RestClient::RestClient {
 
public:
        const Defaults = {
            "oauth_url_auth": "https://login.salesforce.com/services/oauth2/authorize",
            "oauth_url_token": "https://login.salesforce.com/services/oauth2/token",
            "oauth_url_revoke": "https://login.salesforce.com/services/oauth2/revoke",
            "api": "auto",
            "oauth2_grant_type": "password",
        };
 
        const DefaultSendEncoding = "gzip";
 
        const RequiredOptions = ...;
 
 
        const AsyncDataloadNs = "http://www.force.com/2009/06/asyncapi/dataload";
 
        const JobInfoAttributes = {
            "^attributes^": {
                "xmlns": AsyncDataloadNs,
            },
        };
 
protected:
        string oauth_url_auth;
 
        string oauth_url_token;
 
        string oauth_url_revoke;
 
        Mutex m();
 
        string client_id;
 
        string client_secret;
 
        string api;
 
        string api_used;
 
        string instance_url;
 
        hash<string, hash<auto>> api_hash;
 
public:
 
 
    constructor(*hash<auto> opts, *softbool do_not_connect) ;
 
 
 
    hash<auto> patch(string path, auto body, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> doRequest(string m, string path, auto body, *reference<hash<auto>> info, softbool decode_errors = True, *hash<auto> hdr);
 
 
 
    hash<auto> doBulkRequest(string m, string path, auto body, *reference<hash<auto>> info, softbool decode_errors = True, *hash<auto> hdr);
 
 
 
    hash<auto> bulkGet(string path, auto body, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> bulkPost(string path, auto body, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> bulkJobCreate(string operation, string object, string job_content_type, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> bulkJobAddBatch(string jobid, data batch_data, string job_content_type, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    hash<auto> bulkJobClose(string jobid, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
    login(*reference<hash<auto>> info);
 
 
 
    logout(*reference<hash<auto>> info);
 
 
    *string getApi();
 
 
    *hash<string, hash<auto>> getApis();
 
 
 
    checkClientOptions(hash<auto> opts);
 
 
    processApis(*list<auto> apis);
 
 
    setVerifyApi();
 
 
 
      static string getBulkDate(date d);
 
      static string getGmtDate(date d);
 
 
protected:
     setApi();
public:
 
 
 
protected:
     setOAuth2LoginInfo(hash<auto> h);
public:
 
 
protected:
      static hash getOptions(*hash<auto> opts);
public:
 
 
protected:
     checkLogin(*reference<hash<auto>> info);
public:
 
 
protected:
     hash<auto> loginIntern(*reference<hash> info);
public:
 
 
 
protected:
     *hash<auto> getUpdateOptionsAfterLogin(hash<auto> h);
public:
 
 
 
protected:
     *hash<auto> getOAuth2AuthHeaders();
public:
 
};
 
 
class SalesforceRestConnection : public RestClient::RestConnection {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("SalesforceRestConnection"),
            "options": RestConnection::ConnectionScheme.options - (keys OAuth2DifferentOptionMap) + {
                "api": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Salesforce API to use; use `auto` (the default) to use the latest API version",
                    "default_value": SalesforceRestClient::Defaults.api,
                },
                "client_id": RestConnection::ConnectionScheme.options.oauth2_client_id + <ConnectionOptionInfo>{
                    "desc": "The OAuth2 client_id and also the Salesforce \"consumer key\" for the Connected App",
                },
                "client_secret": RestConnection::ConnectionScheme.options.oauth2_client_secret + <ConnectionOptionInfo>{
                    "desc": "The OAuth2 client_secret and also the Salesforce \"consumer secret\" for the Connected "
                        "App",
                    "sensitive": True,
                },
                "data": RestConnection::ConnectionScheme.options."data" + <ConnectionOptionInfo>{
                    "default_value": "json",
                },
                "instance_url": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Salesforce.com instance URL returned in the OAuth2 login process",
                },
                "oauth_url_auth": RestConnection::ConnectionScheme.options.oauth2_auth_url + <ConnectionOptionInfo>{
                    "default_value": SalesforceRestClient::Defaults.oauth_url_auth,
                },
                "oauth_url_token": RestConnection::ConnectionScheme.options.oauth2_token_url + <ConnectionOptionInfo>{
                    "default_value": SalesforceRestClient::Defaults.oauth_url_token,
                },
                "oauth_url_revoke": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the OAuth logout / revoke token URL",
                    "default_value": SalesforceRestClient::Defaults.oauth_url_revoke,
                },
                "oauth2_grant_type": RestConnection::ConnectionScheme.options.oauth2_grant_type
                    + <ConnectionOptionInfo>{
                    "default_value": SalesforceRestClient::Defaults.oauth2_grant_type,
                },
                "oauth2_scopes": RestConnection::ConnectionScheme.options.oauth2_scopes
                    + <ConnectionOptionInfo>{
                    "default_value": SalesforceRestClient::Defaults.oauth2_scopes,
                },
                "password": RestConnection::ConnectionScheme.options."password" + <ConnectionOptionInfo>{
                    "desc": "the Salesforce.com password (will override any password in the URL)",
                    "sensitive": True,
                },
                "ping_method": RestConnection::ConnectionScheme.options."ping_method" + <ConnectionOptionInfo>{
                    "default_value": "GET",
                },
                "ping_path": RestConnection::ConnectionScheme.options."ping_path" + <ConnectionOptionInfo>{
                    "default_value": "/services/data",
                },
                "username": RestConnection::ConnectionScheme.options."username" + <ConnectionOptionInfo>{
                    "desc": "the Salesforce.com username (will override any username in the URL)",
                },
            },
            // FIXME: username and password are currently optional for backwards compatibility with URL auth options
            "required_options": "client_id,client_secret",
        };
 
        const OAuth2AuthRequestOptions = ...;
 
 
        const OAuth2Options = {
            "oauth2_auto_refresh": "oauth2_auto_refresh",
            "oauth2_auth_args": "oauth2_auth_args",
            "oauth_url_auth": "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",
            "oauth_url_token": "oauth2_token_url",
            "password": "password",
            "username": "username",
        };
 
        const OAuth2StandardToSalesforceOptionMap = 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();
 
 
protected:
     *hash<auto> processOAuth2TokenResponseImpl(hash<auto> resp);
public:
 
 
protected:
     checkAuthCodeFeature();
public:
 
 
protected:
     setChildCapabilities();
public:
 
 
 
protected:
     SalesforceRestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
 
 
    Qore::AbstractPollOperation startPollConnect();
 
};
 
 
class SalesforceRestPingPollOperation : public RestClient::RestPingPollOperation {
 
public:
protected:
        const SPS_GET_APIS = "get-apis";
 
public:
 
    constructor(RestClient rc, hash<auto> real_opts) : RestPingPollOperation(rc, real_opts + {
                "url": real_opts.instance_url ?? real_opts.url,
            }) {
    }
 
protected:
     checkOtherStates();
public:
 
 
protected:
     gotOAuth2LoginInfo(hash<auto> h);
public:
 
 
protected:
     doStartGetApis();
public:
 
};
};