Yoxel Calendars API

openapi: 3.2.0
info:
  contact:
    email: support@aurinko.io
  description: '## Introduction

    The Aurinko API is a unified API platform allowing developers to quickly build integrations with

    many mailbox providers and services like Google, Office 365, Outlook.com, MS Exchange, IMAP.

    The unified API abstracts away differences between many email, calendar, contact, task APIs

    to make it easy to connect and sync the mailbox data.


    The Aurinko API''s focus is convenient and reliable data synchronization for all supported

    data categories (email, calendar, contacts, tasks) so the API provides methods to receive changes/deltas

    and be notified of the changes (through webhooks) in a unified manner. The API''s sync/deltas model

    should allow developers to build reliable event based solutions easily.


    The Aurinko API is built on HTTP. Our API is RESTful. It has predictable resource URLs.

    It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body.


    ## API Authentication

    When you sign up for an account, you are given a Client Id and Secret

    for every application that you create. You use those to go through OAuth flows that allow you

    to start syncing remote account data through Aurinko. An account OAuth flow can be started with

    just the Client Id and the Client Secret will be required to obtain an account access token in the

    "authorization code" flow ("implicit grant" flow does is secured by the "trusted domains" setting).


    Aurinko offers two forms of authentication:


    - `Basic ` - used for authentication flows and administrative requests made from the server side.

    - `Bearer ` - used for working with an account data.

    - `Api Key in Cookie` - for in-browser apps that use Aurinko as their backend API with user sessions.

    - `Api Key in Header (X-Aurinko-Session)` - for server side apps that need user sessions


    Never share your client secret or access token. Keep them guarded and secure.


    ## Getting Started Guide

    If you have a use case you would like to implement, please consult us for feedback on the best API operations for the task.


    Click here to visit our API Guides.'
  termsOfService: https://www.aurinko.io/terms-of-service/
  title: Aurinko.io Calendars API
  version: 1.0.0
servers:
- url: https://api.aurinko.io
  description: Production server
security:
- AccountToken: []
- AppAuth: []
  AccountIdHeader: []
- UserSessionHeader: []
  AccountIdHeader: []
- UserSessionCookie: []
  ClientIdHeader: []
  AccountIdHeader: []
- AuthTypeHeader: []
  ExchangeIdToken: []
  ClientIdHeader: []
  AccountIdHeader: []
tags:
- name: Calendars
  description: Each account connected to Aurino can have zero or more calendars, and each calendar has a collection of individual events.
paths:
  /v1/calendars:
    post:
      operationId: createCalendar
      tags:
      - Calendars
      summary: Create new calendar
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarCreate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Calendar'
      x-codeSamples:
      - lang: cURL
        source: "curl -H 'Authorization: Bearer <access token>' \\\n    -X POST https://api.aurinko.io/v1/calendars \\\n    -d '{ \"name\": \"New calendar\" }'"
    get:
      operationId: calendars
      tags:
      - Calendars
      summary: Request list of calendars
      parameters:
      - schema:
          type:
          - string
          - 'null'
        in: query
        name: pageToken
        description: A token received as nextPageToken from a previous page request (for the first page it must be empty)
        required: false
      - schema:
          default: false
          type:
          - boolean
          - 'null'
        in: query
        name: withShared
        description: Shows shared calendars if any available
        required: false
      - schema:
          type:
          - calendarmode.calendarmode
          - 'null'
          $ref: '#/components/schemas/CalendarMode'
        in: query
        name: mode
        description: Calendar type to request (make sense only for Office365)
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarsPage'
      x-codeSamples:
      - lang: cURL
        source: "curl -H 'Authorization: Bearer <access token>' \\\n    -X GET https://api.aurinko.io/v1/calendars"
  /v1/calendars/{id}:
    patch:
      operationId: updateCalendar
      tags:
      - Calendars
      summary: Update a calendar
      parameters:
      - schema:
          type: string
        in: path
        name: id
        description: Calendar id
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarUpdate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Calendar'
      x-codeSamples:
      - lang: cURL
        source: "curl -H 'Authorization: Bearer <access token>' \\\n    -X PATCH https://api.aurinko.io/v1/calendars/{calendarId} \\\n    -d '{ \"name\": \"Updated calendar\" }'"
    get:
      operationId: calendarById
      tags:
      - Calendars
      summary: Get a calendar
      parameters:
      - schema:
          type: string
        in: path
        name: id
        description: Calendar id
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Calendar'
      x-codeSamples:
      - lang: cURL
        source: "curl -H 'Authorization: Bearer <access token>' \\\n    -X GET https://api.aurinko.io/v1/calendars/primary"
components:
  schemas:
    Calendar:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        color:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        accessRole:
          type: string
          readOnly: true
          enum:
          - owner
          - writer
          - reader
        primary:
          type: boolean
          readOnly: true
    CalendarUpdate:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
    CalendarCreate:
      type: object
      properties:
        name:
          type: string
        color:
          type: string
        description:
          type: string
    CalendarsPage:
      type: object
      properties:
        nextPageToken:
          type: string
        length:
          type: integer
        records:
          type: array
          items:
            $ref: '#/components/schemas/Calendar'
    CalendarMode:
      type: string
      enum:
      - user
      - group
  securitySchemes:
    AppAuth:
      type: http
      scheme: basic
      description: App-level basic authentication using Client ID and Client Secret that can be obtained at Aurinko Dashboard page.
    AccountToken:
      type: http
      scheme: bearer
      description: Account-level authentication with account token obtained using `/auth/authorize` endpoint.
    UserSessionCookie:
      type: apiKey
      in: cookie
      name: AUR{APPID}
      description: Cookie-based user-level authentication
    UserSessionHeader:
      type: apiKey
      in: header
      name: X-Aurinko-Session
      description: Token-based user-level authentication
    ClientIdHeader:
      type: apiKey
      in: header
      name: X-Aurinko-Client-Id
      description: Client ID that can be obtained at Aurinko Dashboard page
    AccountIdHeader:
      type: apiKey
      in: header
      name: X-Aurinko-Account-Id
      description: User account id
    AuthTypeHeader:
      type: apiKey
      in: header
      name: X-Aurinko-Auth-Type
      description: 'Authentication type. Possible values: default, exchangeIdToken'
    ExchangeIdToken:
      type: http
      scheme: bearer
      bearerFormat: 'Exchange Identity Token (only with `X-Aurinko-Auth-Type: exchangeIdToken` header.)'
      description: 'Authentication using Exchange Identity Token. To use this method `X-Aurinko-Auth-Type: exchangeIdToken` header should be used.'
x-tagGroups:
- name: OAuth Flow
  tags:
  - Auth
  - Account
  - User
- name: Account management
  tags:
  - Accounts
  - Services
  - Managed accounts
- name: Email
  tags:
  - Messages
  - EmailSync
  - Drafts
  - EmailFolders
  - EmailTracking
  - FollowUpRobot
- name: Calendars
  tags:
  - Calendars
  - Events
  - CalSync
  - FreeBusySchedule
- name: Scheduling
  tags:
  - Booking
  - GroupBooking
  - Availability
- name: Contacts
  tags:
  - Contacts
  - ContSync
- name: Tasks
  tags:
  - TaskLists
  - Tasks
  - TaskSync
- name: Webhooks
  tags:
  - Webhooks
- name: Other
  tags:
  - Errors