google_apis/calendar/calendar_api_url_generator.h

// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef GOOGLE_APIS_CALENDAR_CALENDAR_API_URL_GENERATOR_H_
#define GOOGLE_APIS_CALENDAR_CALENDAR_API_URL_GENERATOR_H_

#include <optional>
#include <string>
#include <vector>

#include "base/time/time.h"
#include "google_apis/gaia/gaia_urls.h"
#include "url/gurl.h"

namespace google_apis {

namespace calendar {

// The type of Calendar event for filtering.
enum class EventType {
  kDefault,
  kFocusTime,
  kFromGmail,
  kOutOfOffice,
  kWorkingLocation,
};

// This class is used to generate URLs for communicating with calendar api
// servers for production, and a local server for testing.
class CalendarApiUrlGenerator {
 public:
  CalendarApiUrlGenerator();
  CalendarApiUrlGenerator(const CalendarApiUrlGenerator& src);
  CalendarApiUrlGenerator& operator=(const CalendarApiUrlGenerator& src);
  ~CalendarApiUrlGenerator();

  // Returns a URL to fetch a list of calendar events.
  // |calendar_id|   ID of the calendar to fetch events from. If empty,
  //                 kPrimaryCalendarId is used in its place.
  // |start_time|    Start time of the event window
  // |end_time|      End time of the aforementioned window
  // |single_events| If true, expand recurring events into instances and only
  //                 return single one-off events and instances of recurring
  //                 events, but not the underlying recurring events
  //                 themselves.
  // |max_attendees| The maximum number of attendees to include in the response.
  //                 If there are more than the specified number of attendees,
  //                 only the participant is returned. Optional.
  // |max_results|   Maximum number of events returned on one result page.
  //                 Optional.
  // |order_by|      Name of the field to order the results by. Can be
  //                 "startTime" or "updated". Optional.
  // |event_types|   Types of events to include in the results. Can
  //                 be empty or include multiple event types. When empty, the
  //                 result will include all event types. Optional.
  // |experiment|    String to differentiate the different calls in the
  //                 backend. Optional.
  GURL GetCalendarEventListUrl(const std::string& calendar_id,
                               const base::Time& start_time,
                               const base::Time& end_time,
                               bool single_events,
                               std::optional<int> max_attendees,
                               std::optional<int> max_results,
                               const std::vector<EventType>& event_types,
                               const std::string& experiment,
                               const std::string& order_by) const;

  // Returns a URL to fetch a map of calendar color id to color code.
  GURL GetCalendarColorListUrl() const;

  // Returns a URL to fetch a list of calendars.
  // max_results   Maximum number of calendars returned on one result page.
  //               Optional.
  GURL GetCalendarListUrl(std::optional<int> max_results) const;

  // The base url can be set here. It defaults to the production base url.
  void SetBaseUrlForTesting(const std::string& url) { base_url_ = GURL(url); }

 private:
  GURL base_url_{GaiaUrls::GetInstance()->google_apis_origin_url()};
};

}  // namespace calendar
}  // namespace google_apis

#endif  // GOOGLE_APIS_CALENDAR_CALENDAR_API_URL_GENERATOR_H_