ZeyosRestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  ZeyosRestClient.qm Copyright (C) 2017 - 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.
*/
 
 
 
 
 
}
 
namespace ZeyosRestClient {
 
class ZeyosRestClient : public RestClient::RestClient {
 
public:
        const RequiredOptions = ...;
 
 
        const AuthPath = "/auth/v1/login";
 
private:
        string username;
        string password;
        string identifier;
        string appsecret;
        string instance;
 
        // the token acquired in the login call
        string token;
 
public:
 
 
    constructor(hash<auto> options, *softbool do_not_connect) ;
 
 
    hash<auto> doRequest(string m, string path, auto body, *reference<hash> info, softbool decode_errors = True, *hash<auto> hdr);
 
 
    hash<auto> doValidatedRequest(string m, string path, auto body, *reference<hash<auto>> info, softbool decode_errors = True, *hash<auto> hdr);
 
 
      static hash<auto> getOptions(hash<auto> options);
 
protected:
     getToken(*reference<hash> info);
public:
 
};
 
 
class ZeyosRestConnection : public RestClient::RestConnection {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("ZeyosRestConnection"),
            "options": RestConnection::ConnectionScheme.options + {
                "appsecret": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Zeyos application secret",
                    "sensitive": True,
                },
                "identifier": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Zeyos identifier;if none is provided, a random identifier string is used",
                },
                "instance": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the Zeyos instance name (first segment of URI path)",
                },
            },
            "required_options": foldl $1 + "," + $2, ZeyosRestClient::RequiredOptions,
        };
 
 
    constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
    string getType();
 
 
    hash<auto> getConstructorOptions(hash<auto> options);
 
 
 
protected:
     ZeyosRestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};