SalesforceRestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  SalesforceRestClient.qm Copyright (C) 2016 - 2022 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",
        };
 
        const DefaultSendEncoding = "gzip";
 
        const RequiredOptions = ...;
 
 
        const AsyncDataloadNs = "http://www.force.com/2009/06/asyncapi/dataload";
 
        const JobInfoAttributes = ...;
 
 
protected:
        string oauth_url_auth;
 
        string oauth_url_token;
 
        string oauth_url_revoke;
 
        Mutex m();
 
        string token;
 
        string client_id;
 
        string client_secret;
 
        string username;
 
        string password;
 
        string api;
 
        string api_used;
 
        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();
 
 
    *string getToken();
 
 
 
    checkClientOptions(hash<auto> opts);
 
 
 
      static string getBulkDate(date d);
 
      static string getGmtDate(date d);
 
protected:
      static hash getOptions(*hash<auto> opts);
public:
 
 
 
protected:
     loginIntern(*reference<hash> info);
public:
 
};
 
 
class SalesforceRestConnection : public RestClient::RestConnection {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("SalesforceRestConnection"),
            "options": RestConnection::ConnectionScheme.options + {
                "api": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Salesforce.com API to use; use `auto` (the default) to use the latest API version",
                    "default_value": SalesforceRestClient::Defaults.api,
                },
                "client_id": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Salesforce.com \"consumer key\" for the Connected App",
                },
                "client_secret": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Salesforce.com \"consumer secret\" for the Connected App",
                    "sensitive": True,
                },
                "oauth_url_auth": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the OAuth authorization URL",
                    "default_value": SalesforceRestClient::Defaults.oauth_url_auth,
                },
                "oauth_url_token": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the OAuth token URL",
                    "default_value": SalesforceRestClient::Defaults.oauth_url_auth,
                },
                "oauth_url_revoke": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the OAuth logout / revoke token URL",
                    "default_value": SalesforceRestClient::Defaults.oauth_url_auth,
                },
                "password": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the ServiceNow password (will override any password in the URL)",
                    "sensitive": True,
                },
                "username": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the ServiceNow username (will override any username in the URL)",
                    "sensitive": False,
                },
            },
            // FIXME: username and password are currently optional for backwards compatibility with URL auth options
            "required_options": "client_id,client_secret",
        };
 
 
    constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
    string getType();
 
 
 
    bool hasDataProvider();
 
 
 
    DataProvider::AbstractDataProvider getDataProvider();
 
 
protected:
     setChildCapabilities();
public:
 
 
 
protected:
     SalesforceRestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};