AuthenticationClient.h

/*
 * Copyright (C) 2019-2025 HERE Europe B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */
 
#pragma once
 
#include <chrono>
#include <functional>
#include <memory>
#include <string>
 
#include <olp/authentication/AppleSignInProperties.h>
#include <olp/authentication/AuthenticationApi.h>
#include <olp/authentication/AuthenticationCredentials.h>
#include <olp/authentication/AuthenticationSettings.h>
#include <olp/authentication/AuthorizeRequest.h>
#include <olp/authentication/SignInResult.h>
#include <olp/authentication/SignInUserResult.h>
#include <olp/authentication/SignOutResult.h>
#include <olp/authentication/SignUpResult.h>
#include <olp/authentication/Types.h>
#include <olp/core/client/ApiResponse.h>
#include <olp/core/client/CancellationToken.h>
#include <olp/core/porting/optional.h>
 
namespace olp {
 
namespace authentication {
class AuthenticationClientImpl;
 
class AUTHENTICATION_API AuthenticationClient {
 public:
  struct SignInProperties {
    porting::optional<std::string> scope{porting::none};
 
    porting::optional<std::string> device_id{porting::none};
 
    std::chrono::seconds expires_in{0};
 
    porting::optional<std::string> custom_body{olp::porting::none};
  };
 
  struct UserProperties {
    std::string email;
 
    std::string password;
 
    unsigned int expires_in{0};
  };
 
  struct FederatedProperties {
    std::string access_token;
 
    std::string country_code;
 
    std::string language;
 
    std::string email;
 
    unsigned int expires_in{0};
  };
 
  struct SignUpProperties {
    std::string email;
 
    std::string password;
 
    std::string date_of_birth;
 
    std::string first_name;
 
    std::string last_name;
 
    std::string country_code;
 
    std::string language;
 
    bool marketing_enabled{false};
 
    std::string phone_number;
 
    std::string realm;
 
    std::string invite_token;
  };
 
  struct RefreshProperties {
    std::string access_token;
 
    std::string refresh_token;
 
    unsigned int expires_in{0};
  };
 
  using SignInClientResponse = Response<SignInResult>;
 
  using SignInClientCallback = Callback<SignInResult>;
 
  using SignInUserResponse = Response<SignInUserResult>;
 
  using SignInUserCallback = Callback<SignInUserResult>;
 
  using SignUpResponse = Response<SignUpResult>;
 
  using SignUpCallback = Callback<SignUpResult>;
 
  using SignOutUserResponse = Response<SignOutResult>;
 
  using SignOutUserCallback = Callback<SignOutResult>;
 
  explicit AuthenticationClient(AuthenticationSettings settings);
  virtual ~AuthenticationClient();
 
  AuthenticationClient(const AuthenticationClient&) = delete;
 
  AuthenticationClient& operator=(const AuthenticationClient&) = delete;
 
  AuthenticationClient(AuthenticationClient&&) noexcept;
 
  AuthenticationClient& operator=(AuthenticationClient&&) noexcept;
 
  client::CancellationToken SignInClient(AuthenticationCredentials credentials,
                                         SignInProperties properties,
                                         SignInClientCallback callback);
 
  client::CancellationToken SignInHereUser(
      const AuthenticationCredentials& credentials,
      const UserProperties& properties, const SignInUserCallback& callback);
 
  client::CancellationToken SignInFederated(
      AuthenticationCredentials credentials, std::string request_body,
      SignInUserCallback callback);
 
  client::CancellationToken SignInFacebook(
      const AuthenticationCredentials& credentials,
      const FederatedProperties& properties,
      const SignInUserCallback& callback);
 
  client::CancellationToken SignInArcGis(
      const AuthenticationCredentials& credentials,
      const FederatedProperties& properties,
      const SignInUserCallback& callback);
 
  client::CancellationToken SignInApple(AppleSignInProperties properties,
                                        SignInUserCallback callback);
 
  client::CancellationToken SignInRefresh(
      const AuthenticationCredentials& credentials,
      const RefreshProperties& properties, const SignInUserCallback& callback);
 
  client::CancellationToken SignUpHereUser(
      const AuthenticationCredentials& credentials,
      const SignUpProperties& properties, const SignUpCallback& callback);
 
  client::CancellationToken AcceptTerms(
      const AuthenticationCredentials& credentials,
      const std::string& reacceptance_token,
      const SignInUserCallback& callback);
 
  client::CancellationToken SignOut(
      const AuthenticationCredentials& credentials,
      const std::string& user_access_token,
      const SignOutUserCallback& callback);
 
  client::CancellationToken IntrospectApp(std::string access_token,
                                          IntrospectAppCallback callback);
 
  client::CancellationToken Authorize(std::string access_token,
                                      AuthorizeRequest request,
                                      AuthorizeCallback callback);
 
  client::CancellationToken GetMyAccount(std::string access_token,
                                         UserAccountInfoCallback callback);
 
 private:
  std::shared_ptr<AuthenticationClientImpl> impl_;
};
 
}  // namespace authentication
}  // namespace olp