NetSuiteRestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  NetSuiteRestClient.qm Copyright (C) 2020 - 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 NetSuiteRestClient {
 
class NetSuiteRestClient : public RestClient::RestClient {
 
public:
        const DefaultUrl = "https://{{account_id}}.suitetalk.api.netsuite.com/services/rest/record";
 
        const DefaultAuthUrl = "https://{{account_id}}.netsuite.com/app/login/oauth2/authorize.nl";
 
        const DefaultGrantType = "authorization_code";
 
        const DefaultTokenUrl = "https://{{account_id}}.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token";
 
        const DefaultLogoutUrl = "https://{{account_id}}.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/logout";
 
        const DefaultOAuth2Scopes = ("rest_webservices",);
 
        const DefaultOptions = ...;
 
 
        const DefaultNetSuitePingMethod= "GET";
 
        const DefaultNetSuitePingHeaders = ...;
 
 
protected:
        string account_id;
 
        string oauth2_logout_url;
 
public:
 
 
    constructor(hash<auto> opts, *softbool do_not_connect) ;
 
 
protected:
     checkLogin(*reference<hash<auto>> info);
public:
 
 
 
protected:
     setOAuth2LoginInfo(hash<auto> h);
public:
 
 
 
protected:
     hash<auto> oauth2Auth(hash<auto> login, *reference<hash<auto>> info, *bool refresh);
public:
 
 
 
protected:
     *hash<auto> getUpdateOptionsAfterLogin(hash<auto> h);
public:
 
 
protected:
      static hash<auto> getOptions(hash<auto> opts);
public:
 
};
 
 
class NetSuiteRestConnection : public RestClient::RestConnection {
 
public:
        const DefaultUrl = "netsuite://auto-detected";
 
        const ConnectionScheme = ...;
 
 
 
    constructor(hash<auto> config, *hash<auto> attr) ;
 
 
    string getType();
 
 
 
    *string getAppName();
 
 
 
    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
    */
    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
    */
    string getTokenUrl(*bool allow_relative);
 
 
 
    bool hasDataProvider();
 
 
 
    DataProvider::AbstractDataProvider getDataProvider(*hash<auto> constructor_options);
 
 
protected:
     setChildCapabilities();
public:
 
 
    /*  @param opt the URL option name
        @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
    */
protected:
     string getUrlOption(string opt, *bool allow_relative);
public:
 
 
 
protected:
     NetSuiteRestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
 
 
protected:
     setRealUrl(*string url);
public:
 
};
};