1.1.0 • Published 4 months ago
@microfox/google-calendar v1.1.0
Google Calendar
A TypeScript SDK for managing Google Calendar resources, including calendars, events, access control, and settings.
Installation
npm install @microfox/google-calendar
Environment Variables
To use this package, you need to set the following environment variables:
GOOGLE_CLIENT_ID
: The client ID obtained from the Google API Console for your OAuth2 application. (Required)GOOGLE_CLIENT_SECRET
: The client secret obtained from the Google API Console for your OAuth2 application. (Required)MICROFOX_GOOGLE_CALENDAR_ACCESS_TOKEN
: The access token for Google Calendar API. This token grants access to the user's Google Calendar data. (Required)MICROFOX_GOOGLE_CALENDAR_REFRESH_TOKEN
: The refresh token for Google Calendar API. This token is used to obtain a new access token when the current one expires. (Required)MICROFOX_GOOGLE_CALENDAR_SCOPES
: A space-separated list of scopes required for Google Calendar API access. Defaults to a predefined set of calendar scopes if not provided. Example: 'https://www.googleapis.com/auth/calendar.readonly https://www.googleapis.com/auth/calendar.events' (Optional)
API Reference
For detailed documentation on the constructor and all available functions, please refer to the following files:
- createGoogleCalendarSDK (Constructor): Initializes the client.
- clearCalendar
- deleteAclRule
- deleteCalendar
- deleteCalendarFromList
- deleteEvent
- getAclRule
- getCalendar
- getCalendarFromList
- getColors
- getEvent
- getSetting
- importEvent
- insertAclRule
- insertCalendarToList
- insertEvent
- listAclRules
- listCalendarList
- listEventInstances
- listEvents
- listSettings
- moveEvent
- queryFreebusy
- quickAddEvent
- stopChannel
- updateAclRule
- updateCalendar
- updateCalendarInList
- updateEvent
- watchAcl
- watchCalendarList
- watchEvents
- watchSettings