openapi.yaml

openapi: 3.0.3
info:
  title: OfficeRnD
  description: Unofficial OfficeRnD specification.
  contact:
    email: technology-team@techspace.co
  license:
    name: MIT
    url: https://github.com/techspaceco/officernd-api/LICENSE
  version: 1.0.0
externalDocs:
  description: The OfficeRnD public API is designed to let 3rd party applications communicate with the core OfficeRnD platform.
  url: https://developer.officernd.com
servers:
- url: 'https://app.officernd.com/api/v1/organizations/{organization}'
  variables:
    organization:
      description: The organization slug.
      default: example
tags:
- name: Offices
  description: Office objects represent the separate physical locations in the organization. They are used to separate resources and members in a single organization.
security: 
  - oauth2: 
    - 'officernd.api.read'
paths:

  /offices:
    get:
      summary: List
      operationId: ListOffices
      description: Retrieve all locations in the space.
      tags:
      - offices
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: name
        in: query
        required: false
        description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match.
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Office'

  /offices/{officeId}:
    get:
      summary: Get
      operationId: GetOffice
      description: Retrieve an individual location.
      tags:
      - offices
      parameters:
      - name: officeId
        in: path
        required: true
        description: Primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Office'

  /floors:
    get:
      summary: List
      operationId: ListFloors
      description: Represents floor data. Floors are used to classify different resources from the same location. It may contain floorplan data as well.
      tags:
      - offices
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: name
        in: query
        required: false
        description: The exact name of the item you are looking for.
        schema:
          type: string
      - name: office
        in: query
        required: false
        description: Filter by office id.
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Floor'

  /floors/{floorId}:
    get:
      summary: Get
      operationId: GetFloor
      description: Retrieve an individual floor.
      tags:
      - floors
      parameters:
      - name: floorId
        in: path
        required: true
        description: Primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Floor'

  /members:
    get:
      summary: List
      operationId: ListMembers
      description: Represents floor data. Floors are used to classify different resources from the same location. It may contain floorplan data as well.
      tags:
      - offices
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: modifiedAt.$gt
        in: query
        required: false
        description: All items created or last modified after the pointed date
        schema:
          type: string
          format: date-time
      - name: modifiedAt.$lt
        in: query
        required: false
        description: All items created or last modified before the pointed date
        schema:
          type: string
          format: date-time
      - name: createdAt.$gt
        in: query
        required: false
        description: All items created after the pointed date
        schema:
          type: string
          format: date-time
      - name: createdAt.$lt
        in: query
        required: false
        description: All items created before the pointed date
        schema:
          type: string
          format: date-time
      - name: office
        in: query
        required: false
        description: Filter by office id.
        schema:
          type: string
      - name: team
        in: query
        required: false
        description: Filter by team id.
        schema:
          type: string
      - name: name
        in: query
        required: false
        description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match https://developer.officernd.com/#Wildcard-matches.
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Member'
    post:
      summary: Create
      operationId: CreateMembers
      description: Add new members.
      tags:
      - members
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Member'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Member'
    delete:
      summary: Delete
      operationId: DeleteMembers
      description: You can delete members by passing array of IDs to be deleted as request body.
      tags:
      - members
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: OK

  /members/{memberId}:
    get:
      summary: Get
      operationId: GetMember
      description: Retrieve an individual member.
      tags:
      - members
      parameters:
      - name: memberId
        in: path
        required: true
        description: Primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
    put:
      summary: Update
      operationId: UpdateMember
      description: Retrieve an individual member.
      tags:
      - members
      parameters:
      - name: memberId
        in: path
        required: true
        description: Primary key.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Member'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'

  /teams:
    get:
      summary: List
      operationId: ListTeams
      description: Team objects allow you to keep your companies' data in single place, track memberships, invoices, charges, fees, and etc.
      tags:
      - offices
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: modifiedAt.$gt
        in: query
        required: false
        description: All items created or last modified after the pointed date
        schema:
          type: string
          format: date-time
      - name: modifiedAt.$lt
        in: query
        required: false
        description: All items created or last modified before the pointed date
        schema:
          type: string
          format: date-time
      - name: createdAt.$gt
        in: query
        required: false
        description: All items created after the pointed date
        schema:
          type: string
          format: date-time
      - name: createdAt.$lt
        in: query
        required: false
        description: All items created before the pointed date
        schema:
          type: string
          format: date-time
      - name: office
        in: query
        required: false
        description: Filter by office id.
        schema:
          type: string
      - name: name
        in: query
        required: false
        description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match https://developer.officernd.com/#Wildcard-matches.
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Team'
    post:
      summary: Create
      operationId: CreateTeams
      description: Add new teams.
      tags:
      - teams
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Team'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Team'
    delete:
      summary: Delete
      operationId: DeleteTeams
      description: You can delete teams by passing array of IDs to be deleted as request body.
      tags:
      - teams
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: OK

  /teams/{teamId}:
    get:
      summary: Get
      operationId: GetTeam
      description: Retrieve an individual team.
      tags:
      - teams
      parameters:
      - name: teamId
        in: path
        required: true
        description: Primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
    put:
      summary: Update
      operationId: UpdateTeam
      description: Retrieve an individual team.
      tags:
      - teams
      parameters:
      - name: teamId
        in: path
        required: true
        description: Primary key.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Team'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'

  /memberships:
    get:
      summary: List
      operationId: ListMemberships
      description: Represents floor data. Floors are used to classify different resources from the same location. It may contain floorplan data as well.
      tags:
      - offices
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: $populate
        in: query
        required: false
        description: Comma-separated list of all properties to be populated. Only id references can be populated. Refer to Populating queries section for more information.
        schema:
          type: string
      - name: team
        in: query
        required: false
        description: Filter by team id.
        schema:
          type: string
      - name: member
        in: query
        required: false
        description: Filter by member id
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Membership'
    post:
      summary: Create
      operationId: CreateMemberships
      description: Add new memberships.
      tags:
      - memberships
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Membership'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Membership'
    delete:
      summary: Delete
      operationId: DeleteMemberships
      description: You can delete memberships by passing array of IDs to be deleted as request body.
      tags:
      - memberships
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: OK

  /memberships/{membershipId}:
    get:
      summary: Get
      operationId: GetMembership
      description: Retrieve an individual membership.
      tags:
      - memberships
      parameters:
      - name: membershipId
        in: path
        required: true
        description: Primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Membership'
    put:
      summary: Update
      operationId: UpdateMembership
      description: Retrieve an individual membership.
      tags:
      - memberships
      parameters:
      - name: membershipId
        in: path
        required: true
        description: Primary key.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Membership'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Membership'

  /checkins:
    get:
      summary: List
      operationId: ListCheckins
      description: Represents floor data. Floors are used to classify different resources from the same location. It may contain floorplan data as well.
      tags:
      - offices
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: modifiedAt.$gt
        in: query
        required: false
        description: All items created or last modified after the pointed date
        schema:
          type: string
          format: date-time
      - name: modifiedAt.$lt
        in: query
        required: false
        description: All items created or last modified before the pointed date
        schema:
          type: string
          format: date-time
      - name: createdAt.$gt
        in: query
        required: false
        description: All items created after the pointed date
        schema:
          type: string
          format: date-time
      - name: createdAt.$lt
        in: query
        required: false
        description: All items created before the pointed date
        schema:
          type: string
          format: date-time
      - name: office
        in: query
        required: false
        description: Filter by office id.
        schema:
          type: string
      - name: team
        in: query
        required: false
        description: Filter by team id.
        schema:
          type: string
      - name: name
        in: query
        required: false
        description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match https://developer.officernd.com/#Wildcard-matches.
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Checkin'

  /checkins/{memberId}:
    post:
      summary: Create
      operationId: CreateCheckins
      description: |
        Check in member with id = {memberId}.
        By default, the request checks in the member with start date now, no end date and the office where the member is registered.
        You can optionally provide start, end and office in the request body. Member checkins with start date before the current date and no end date are not allowed.
      tags:
      - checkins
      parameters:
      - name: memberId
        in: path
        required: true
        description: Member primary key.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Checkin'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Checkin'

  /checkins/checkout/{memberId}:
    post:
      summary: Create
      operationId: CreateCheckinCheckout
      description: |
        Check out member with id = {memberId}.
        The request will update current checkins end date with now if the checkins don't have an end date.
      tags:
      - checkins
      parameters:
      - name: memberId
        in: path
        required: true
        description: Member primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Checkin'

  /bookings:
    get:
      summary: List
      operationId: ListBookings
      description: Retrieve all bookings.
      tags:
      - offices
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: office
        in: query
        required: false
        description: Filter by office id.
        schema:
          type: string
      - name: member
        in: query
        required: false
        description: Filter by member id.
        schema:
          type: string
      - name: team
        in: query
        required: false
        description: Filter by team id.
        schema:
          type: string
      - name: seriesStart.$gte
        in: query
        required: false
        description: "Filter by start date of the booking series. (UNDOCUMENTED: We think ISO 8601 Date or DateTime)"
        schema:
          type: string
      - name: seriesEnd.$lte
        in: query
        required: false
        description: "Filter by end date of the booking series. (UNDOCUMENTED: We think ISO 8601 Date or DateTime)"
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Booking'
    post:
      summary: Create
      operationId: CreateBookings
      description: Add one or many bookings.
      tags:
      - bookings
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Booking'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Booking'

  /bookings/checkout:
    post:
      summary: Create
      operationId: CreateBookingsCheckout
      description: |
        Create bookings without specifying resources, but search parameters instead.
      tags:
      - checkins
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                required:
                  - start
                  - end
                  - count
                properties:
                  start:
                    type: string
                    format: date-time
                    description: Start datetime of the booking request.
                  end:
                    type: string
                    format: date-time
                    description: End datetime of the booking request.
                  team:
                    type: string
                    description: Reference to the company (required if no member).
                  member:
                    type: string
                    description: Reference to the member (required if no team).
                  extras:
                    type: object
                    description: Dictionary with keys the IDs of the extras to add to the booking and values - the quantity of the extra.
                  source:
                    type: string
                    description: The origin/source of the bookings.
                  summary:
                    type: string
                    description: Booking title/summary.
                  description:
                    type: string
                    description: Long description of the booking.
                  tentative:
                    type: boolean
                    description: True if the booking is not confirmed. Tentative bookings are not charged.
                  free:
                    type: boolean
                    description: True if the booking is marked as free. If a booking is marked as free, no fees will be added for it.
                  size:
                    type: number
                    description: The resource size to be used.
                  count:
                    type: number
                    description: The count of bookings of this type to be made.
                  rate:
                    type: string
                    description: The resource rate to be used to lookup available resources.
                  resourceType:
                    type: string
                    description: The resource type to be used to lookup available resources.       
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Booking'

  /bookings/{bookingId}:
    get:
      summary: Get
      operationId: GetBooking
      description: Retrieve a booking.
      tags:
      - offices
      parameters:
      - name: bookingId
        in: path
        required: true
        description: Booking primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Booking'
    put:
      summary: Update
      operationId: UpdateBooking
      description: Update a single booking.
      tags:
      - bookings
      parameters:
      - name: bookingId
        in: path
        required: true
        description: Booking primary key.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Booking'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Booking'
    delete:
      summary: Delete
      operationId: DeleteBooking
      description: Deleting the booking will remove the associated fees and will return the used credits the the company/member account.
      tags:
      - bookings
      parameters:
      - name: bookingId
        in: path
        required: true
        description: Booking primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK

  /bookings/{bookingId}/cancel:
    post:
      summary: Cancel
      operationId: CancelBooking
      description: |
        Cancel a booking that was already confirmed. Booking cancellation may trigger a notification or generate a cancellation fee based on the cancellation policy.
        If you want to suppress those, you should use the silent and skipCancellationPolicy query string parameters.
      tags:
      - bookings
      parameters:
      - name: bookingId
        in: path
        required: true
        description: Booking primary key.
        schema:
          type: string
      - name: silent
        in: query
        required: false
        description: Whether to send notifications to the member. If true, a notification will be sent. If false or not passed at all, the notification will be sent as normal.
        schema:
          type: boolean
      - name: skipCancellationPolicy
        in: query
        required: false
        description: Whether to calculate a cancellation fee. If true, the cancellation fee will be skipped. If false or not passed at all, a cancellation fee will be generated based on the cancellation policy for the resource.
        schema:
          type: boolean
      responses:
        '200':
          description: OK

  # TODO: /bookings/summary
  # TODO: /bookings/checkout-summary

  /bookings/occurrences:
    get:
      summary: List
      operationId: ListBookingOccurrences
      description: Get a list of all occurrences for a specified period.
      tags:
      - offices
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: office
        in: query
        required: false
        description: Filter by office id.
        schema:
          type: string
      - name: member
        in: query
        required: false
        description: Filter by member id.
        schema:
          type: string
      - name: team
        in: query
        required: false
        description: Filter by team id.
        schema:
          type: string
      - name: resourceId
        in: query
        required: false
        description: Filter by resource id.
        schema:
          type: string
      - name: start
        in: query
        required: true
        description: Start ISO 8601 Date or DateTime of the interval to get occurrences for (inclusive).
        schema:
          type: string
      - name: end
        in: query
        required: true
        description: End ISO 8601 Date or DateTime of the interval to get occurrences for (inclusive).
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Booking'
  # TODO: /fees
  # TODO: /fees/{feeId}

  /plans:
    get:
      summary: List
      operationId: ListPlans
      description: Retrieve all plans.
      tags:
      - rates
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Plan'
  /plans/{planId}:
    get:
      summary: Get
      operationId: GetPlan
      description: Retrieve a plan by ID.
      tags:
      - resources
      parameters:
      - name: planId
        in: path
        required: true
        description: Plan primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'

  /rates:
    get:
      summary: List
      operationId: ListRates
      description: |
        The rate objects (or resource rates) describe available resource rates in the system. Rates are very similar to the plans.
      tags:
      - rates
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Rate'
  /rates/{rateId}:
    get:
      summary: Get
      operationId: GetRate
      description: Retrieve a rate by ID.
      tags:
      - resources
      parameters:
      - name: rateId
        in: path
        required: true
        description: Rate primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rate'


  # TODO: /{rateId}

  /resources:
    get:
      summary: List
      operationId: ListResources
      description: |
        Resource objects describe all type of bookable (short term bookings or long term assignments) resources in the system.

        Resource types can be extended and modified, but the default ones are:

        meeting rooms - meeting_room
        private offices - team_room
        private office desk - desk_tr
        dedicated desks - desk
        hot desks - hotdesk
        You can retrieve individual resources as well as a list of all your resources or all of a specific type.
      tags:
      - resources
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: office
        in: query
        required: false
        description: Filter by office id.
        schema:
          type: string
      - name: name
        in: query
        required: false
        description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match.
        schema:
          type: string
      - name: type
        in: query
        required: false
        description: One of the possible resource types.
        schema:
          type: string
      # TODO: availableFrom, availableTo.
      # Unknown format. The documentation just says "date" which could be anything.
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Resource'

  /resources/{resourceId}:
    get:
      summary: Get
      operationId: GetResource
      description: Retrieve a resource by ID.
      tags:
      - resources
      parameters:
      - name: resourceId
        in: path
        required: true
        description: Resource primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'

  /resource-types:
    get:
      summary: List
      operationId: ListResourceTypes
      description: |
        Resource types can be extended and modified, but the default ones are:

        meeting rooms - meeting_room
        private offices - team_room
        private office desk - desk_tr
        dedicated desks - desk
        hot desks - hotdesk
        Target types (Floorplan object type):

        desk
        zone
        Booking modes:

        time
        date
        Check-in modes:

        half_day
        day
        You can retrieve a list of all your resource types.
      tags:
      - resource-types
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: type
        in: query
        required: false
        description: One of the possible resource types.
        schema:
          type: string
      - name: target
        in: query
        required: false
        description: One of the possible resource target types.
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResourceType'
 
  /contracts:
    get:
      summary: List
      operationId: ListContracts
      description: Retrieve all contracts.
      tags:
      - contracts
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: office
        in: query
        required: false
        description: Filter by office id.
        schema:
          type: string
      - name: team
        in: query
        required: false
        description: Filter by team id.
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Contract'
    post:
      summary: Create
      operationId: CreateContract
      description: Create a single contract.
      tags:
      - contracts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Contract'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Contract'

  /contracts/{contractId}:
    get:
      summary: Get
      operationId: GetContract
      description: Retrieve a contract by ID.
      tags:
      - contracts
      parameters:
      - name: contractId
        in: path
        required: true
        description: Contract primary key.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contract'

    # TODO: /contracts/{contractId}/sign
    # TODO: /contracts/{contractId}/terminate
    # TODO: /credit-accounts
    # TODO: /leads
    # TODO: /posts
    # TODO: /posts/{eventId}
    # TODO: /events
    # TODO: /events/{eventId}
    # TODO: /visits
    # TODO: /visits/{visitId}

  /visits:
    get:
      summary: List
      operationId: ListVisits
      description: Retrieve all visits.
      tags:
      - visits
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/NextParam'
      - $ref: '#/components/parameters/PrevParam'
      - name: start.$gt
        in: query
        description: All items starting after the pointed date.
        required: false
        schema:
          type: string
          format: date
      - name: start.$lt
        in: query
        description: All items starting before the pointed date.
        required: false
        schema:
          type: string
          format: date
      - name: end.$gt
        in: query
        description: All items ending after the pointed date.
        required: false
        schema:
          type: string
          format: date
      - name: end.$lt
        in: query
        description: All items ending before the pointed date.
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: OK
          headers:
            rnd-cursor-next:
              $ref: '#/components/headers/rnd-cursor-next'
            rnd-cursor-prev:
              $ref: '#/components/headers/rnd-cursor-prev'
            rnd-range-start:
              $ref: '#/components/headers/rnd-range-start'
            rnd-range-end:
              $ref: '#/components/headers/rnd-range-end'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Visit'

    # TODO: /visitors
    # TODO: /payments
    # TODO: /payments/{paymentId}
    # TODO: /payments/{paymentId}/documents
    # TODO: /payments/{paymentId}/charges
    # TODO: /payments/{paymentId}/charges/{chargeId}
    # TODO: /charges
    # TODO: /network/auth
    # TODO: /network/checkin
    # TODO: /network/checkout
    # TODO: /reports/occupancy
    # TODO: /reports/occupancy/by-customer
    # TODO: /reports/occupancy/assignable-stats

  /auth/member:
    post:
      summary: Auth Member
      operationId: AuthMember
      description: |
        Authenticate member by given email. Returns the access token to login (impersonate) as a member.
        The authentication token returned by this endpoint can be used to generate quick login links to the members portal. You just need to add access_token=<token> to the URL.
      tags:
      - auth
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                  description: The email of the member.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - token
                properties:
                  token:
                    type: string
                    description: The access token to be used for authentication.    


    # TODO: /auth/signin
    # TODO: /signup
    # TODO: /checkout
    # TODO: /checkout/summary
    # TODO: /subscribe
    # TODO: /user/visits
    # TODO: /user/visits/{visitId}
    # TODO: /user/visitors/suggest
    # TODO: /user/visitors/create
    # TODO: /user/visitors/{visitorId}
    # TODO: /user/member
    # TODO: /user/member/suggest
    # TODO: /user/checkins
    # TODO: /user/checkins/visitor/{visitorId}

components:
  parameters:
    LimitParam:
      name: $limit
      in: query
      description: Limits the number of results returned. Default is 100, and maximum is 100.
      schema:
        type: integer
        default: 100
        maximum: 100
    NextParam:
      name: $next
      in: query
      description: Pointer to the start of the current page for pagination.
      schema:
        type: string
    PrevParam:
      name: $prev
      in: query
      description: Pointer to the previous page for pagination.
      schema:
        type: string

  headers:
    rnd-cursor-next:
      required: true
      description: Cursor pointer to the next page.
      schema:
        type: string
    rnd-cursor-prev:
      required: true
      description: Cursor pointer to the previous page.
      schema:
        type: string
    rnd-range-start:
      required: true
      description: Numeric index of the first returned item.
      schema:
        type: integer
    rnd-range-end:
      required: true
      description: Numeric index of the last returned item.
      schema:
        type: integer
    
  securitySchemes:
    oauth2:
      type: oauth2
      description: https://developer.officernd.com/#authentication
      flows:
        clientCredentials:
          tokenUrl: https://identity.officernd.com/oauth/token
          scopes:
            'officernd.api.read': Provides read (GET) access to the OfficeRnD app endpoints for a particular organisation.
            'officernd.api.write': Provides write (PUT, POST, DELETE) access to the OfficeRnD app endpoints for a particular organisation.
  schemas:
    Office:
      type: object
      required:
        - name
      properties:
        _id:
          type: string
        name:
          type: string
          description: The name of the plan in hand. It appears everywhere in the system.
        country:
          type: string
          description: The country part of the location address.
        state:
          type: string
          description: The state part of the location address.
        city:
          type: string
          description: The city part of the location address.
        address:
          type: string
          description: The address part of the location address.
        zip:
          type: string
          description: The zip code part of the location address.
        timezone:
          type: string
          description: The timezone the location is at.
        image:
          type: string
          description: The URL pointing to an image assigned to this location.
        isOpen:
          type: boolean
          description: If true, the location is operational; if false or omitted the location is not working - either not open yet, or suspended for some other reason.
        public:
          type: boolean
          description: If true, the location is shown in the members portal; if false or omitted the location is not displayed in the members portal.
        # Properties, slug and code are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'
        slug:
          type: string
          description: Unique URL slug.
        code:
          type: string
          description: Unique code.

    Floor:
      type: object
      required:
        - name
        - office
      properties:
        _id:
          type: string
        name:
          type: string
          description: The name of the floorplan - usually the floor number.
        slug:
          type: string
          description: (UNDOCUMENTED) The unique URL slug for the floor.
        floor:
          type: string
          description: Optional floor number.
        isOpen:
          type: boolean
          description: If true, the location is operational; if false or omitted, the location is not working - either not open yet, or suspended for some other reason.
        office:
          type: string
          description: A reference to the location the floor is part of
        area:
          type: number
          description: The floor area of this part of the building.
        targetRevenue:
          type: number
          description: The target revenue for the specified floor
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'
        createdAt:
          type: string
          format: date-time
          description: The date when the floor was created.
        createdBy:
          type: string
          description: The user that created the floor.
        modifiedAt:
          type: string
          format: date-time
          description: The date when the floor was last modified. Before the first modification, this field equals to the createdAt field.

    Member:
      type: object
      required:
        - name
        - email
      properties:
        _id:
          type: string
        name:
          type: string
          description: The full name of the member
        email:
          type: string
          description: The email address of the member
        phone:
          type: string
          description: The primary phone number of the member
        twitterHandle:
          type: string
          description: The twitter handle of the member
        team:
          type: string
          description: Reference to the team the member belongs to
        contactPerson:
          type: boolean
          description: True if the member is a contact person in his company
        billingPerson:
          type: boolean
          description: True if the member is the billing person of his company and receives all the invoices
        office:
          type: string
          description: Reference to the location the member belongs to. It will default to the only location if left empty
        paymentDetails:
          type: array
          description: Array containing all the names of the payment details added to the member account
        createdAt:
          type: string
          format: date-time
          description: The date when the member has been created at.
        createdBy:
          type: string
          description: The user that created the member.
        modifiedAt:
          type: string
          format: date-time
          description: The date when the member has been modified for the last time. Before the first modification, this field equals to the createdAt field.
        modifiedBy:
          type: string
          description: The user that did the last modification to the member. Before the first modification, this field equals to the createdBy field.
        status:
          type: string
          enum:
            - active
            - contact
            - former
          description: The member status. It could be active, contact or former
        calculatedStatus:
          type: string
          description: The actual member status calculated by the platform. Please, refer to this article for more information https://help.officernd.com/hc/en-us/articles/360002210114-Member-Statuses-and-Labels
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'

    Team:
      type: object
      required:
        - name
      properties:
        _id:
          type: string
        name:
          type: string
          description: The full name of the team
        url:
          type: string
          description: (UNDOCUMENTED) The URL of the team
        email:
          type: string
          description: The email address of the team
        twitterHandle:
          type: string
          description: The twitter handle of the team
        office:
          type: string
          description: Reference to the location the team belongs to. It will default to the only location if left empty
        paymentDetails:
          type: array
          description: Array containing all the names of the payment details added to the team account
        createdAt:
          type: string
          format: date-time
          description: The date when the team has been created at.
        createdBy:
          type: string
          description: The user that created the team.
        modifiedAt:
          type: string
          format: date-time
          description: The date when the team has been modified for the last time. Before the first modification, this field equals to the createdAt field.
        modifiedBy:
          type: string
          description: The user that did the last modification to the team. Before the first modification, this field equals to the createdBy field.
        # Properties, image, billing and address details are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'
        image:
          type: string
          description: (UNDOCUMENTED) Image brand image URL.
        calculatedStatus:
          type: string
          description: (UNDOCUMENTED) Status calculated based on current contracts and memberships.
        details:
          $ref: '#/components/schemas/TeamDetails'
        address:
          $ref: '#/components/schemas/TeamAddress'
        startDate:
          type: string
          format: date-time
          description: (UNDOCUMENTED) First ever move in date. Required for a valid Team record in the UI but not the API.

    TeamDetails:
      type: object
      description: (UNDOCUMENTED) Billing details. If not provided address details will be used.
      properties:
        currency:
          type: string
        currencyConversionRate:
          type: number
        paymentMethod:
          type: string
          enum:
            -
            - Cash
            - Bank Transfer
            - POS
            - Cheque
        date:
          type: number
          description: Day of the month to bill.
        membershipsPONumber:
          type: string
        name:
          type: string
        vatId:
          type: string
        regId:
          type: string
          description: Business registration number.
        differentAddress:
          type: boolean
          description: Different billing address from registered address.
        address:
          type: string
          description: Billing Address - street address.
        city:
          type: string
          description: Billing Address - city.
        state:
          type: string
          description: Billing Address - state.
        zip:
          type: string
          description: Billing Address - zip.
        country:
          type: string
          description: Billing Address - country.

    TeamAddress:
      type: object
      description: (UNDOCUMENTED) Registered address.
      properties:
        address:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
        country:
          type: string

    Membership:
      type: object
      required:
        - name
        - price
        - office
        - plan
        - startDate
      properties:
        _id:
          type: string
        name:
          type: string
          description: The display name of the membership. Used to generate invoice line items as well
        price:
          type: number
          description: The monthly price of the membership
        team:
          type: string
          description: Reference to the company (required if no member)
        member:
          type: string
          description: Reference to the company (required if no team)
        office:
          type: string
          description: A reference to the location the fee is issued for
        plan:
          type: string
          description: A reference to the price plan assigned to the membership. It is used to determine the sales account when generating an invoice
        isPersonal:
          type: boolean
          description: If true, the membership is billed to the assigned member and not to the company
        startDate:
          type: string
          format: date-time
          description: The membership starting date
        endDate:
          type: string
          format: date-time
          description: The last date of membership. If not set the membership is open-ended
        discount:
          type: string
          description: A reference to a discount definition
        discountAmount:
          type: number
          description: Manually granted discount for the specific membership
        calculatedDiscountAmount:
          type: number
          description: The actual discount amount coming from a discount defintion or from a manually granted discount
        discountedPrice:
          type: number
          description: The final membership unit price after granting the discount
        locked:
          type: boolean
          description: If true, prevents editing the membership
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'

    Rate:
      type: object
      required:
        - name
        - extras
        - amenities
        - price
        - locations
        - intervalLength
        - rates
      properties:
        _id:
          type: string
        account:
          type: string
          description: (UNDOCUMENTED) Revenue account ID.
        name:
          type: string
          description: The name of the plan in hand. It appears everywhere in the system.
        code:
          type: string
          description: (UNDOCUMENTED Billing code for the rate.
        description:
          type: string
          description: Plain text description of the rate.
        extras:
          type: array
          description: An array of _ids of the various extras associated with the rate. Each extra is the _id of a one-off billing plan.
          items:
            type: string
        price:
          type: number
          description: The default hourly/daily price of the rate. If the rate consists of multiple rates, each one will have its own price.
        locations:
          type: array
          description: List of all locations where the rate is present. If empty, all locations are assumed.
          items:
            type: string
        intervalLength:
          # NOTE: Incorrectly marked as an object in the documentation.
          type: string
          description: The interval of the rate - can be either day or hour.
        rates:
          type: array
          description: Contains all rates and their respective intervals. If there's a resource rate, that has both daily rates and hourly rates, they'll present as a separate object with a different intervalQuantity and boolean properties for whether it's a weekend rate or a half-day rate
          items:
            # Undocumented. No idea what this structure is called internally. A RateRate? :P
            type: object
            required:
              - intervalQuantity
              - price
            properties:
              _id:
                type: string
              intervalQuantity:
                type: number
                description: (UNDOCUMENTED) The number of days/hours the rate is valid for
              interval:
                type: string
                description: (UNDOCUMENTED) We've seen 'hour', 'day', 'week', 'month' in the wild. It may be the same as `/components/schemas/Rate.intervalLength`.
              isHalfDayRate:
                type: boolean
                description: (UNDOCUMENTED) If true, the rate is valid only for half a day.
              isOffRate:
                type: boolean
                description: (UNDOCUMENTED) If true, the rate is valid only for out of office hours and weekends.
              isWeekendRate:
                type: boolean
                description: (UNDOCUMENTED) If true, the rate is valid only for weekends.
              price:
                type: number
                description: (UNDOCUMENTED) The price of the rate
        bookingPolicy:
          type: string
          description: The _id of the associated booking policy. It can be expanded into an object using $populate in order to get information on the policy itself (minDuration,maxDuration etc).
        bookingCancellationPolicy:
          type: string
          description: The _id of the associated cancellation policy. It can be expanded into an object using $populate in order to get information on the policy itself (activeMemberConditions,nonActiveMemberConditions etc).
        createdAt:
          type: string
          format: date-time
          description: The date when the rate has been created.
        createdBy:
          type: string
          description: The user that created the rate.
        modifiedAt:
          type: string
          format: date-time
          description: The user that did the last modification to the rate. If no update is made this field will match the createdBy field.
        modifiedBy:
          type: string
          description: The user that did the last modification to the rate. Before the first modification, this field equals to the createdBy field.

    Checkin:
      type: object
      required:
        - member
        - start
        - office
      properties:
        _id:
          type: string
        member:
          type: string
          description: A reference to the member that is checked in.
        team:
          type: string
          description: A reference to the team of the member that is checked in.
        start:
          type: string
          format: date-time
          description: The start date of the checkin.
        end:
          type: string
          format: date-time
          description: The end date of the checkin.
        office:
          type: string
          description: A reference to the office where the member is checked in.

    Booking:
      type: object
      required:
        - start
        - end
        - resourceId
      properties:
        _id:
          type: string
        start:
          type: object
          required:
            - dateTime
          properties:
            dateTime:
              type: string
              format: date-time
              description: Start datetime of the booking in ISO date time format
        end:
          type: object
          required:
            - dateTime
          properties:
            dateTime:
              type: string
              format: date-time
              description: End datetime of the booking in ISO date time format
        timezone:
          type: string
          description: The booking resource timezone
        source:
          type: string
          description: The origin/source of the booking
        summary:
          type: string
          description: Booking title/summary
        resourceId:
          type: string
          description: Reference to the booked resource
        plan:
          type: string
          description: Reference to the resource rate used for the booking
        team:
          type: string
          description: Reference to the company (required if no member)
        member:
          type: string
          description: Reference to the member (required if no team)
        description:
          type: string
          description: Long description of the booking
        tentative:
          type: boolean
          description: True if the booking is not confirmed. Tentative booking are not charged.
        free:
          type: boolean
          description: True if the booking is marked as free. If create a booking marked as free, no fees will be added for it.
        fees:
          type: array
          description: Array of items describing how the booking will be charged for. Described below as BookingFee.
          items:
            $ref: '#/components/schemas/BookingFee'
        extras:
          type: object
          description: Dictionary with keys the IDs of the extras to add to the booking and values - the quantity of the extra
        canceled:
          type: boolean
          description: Whether the booking got canceled or not. It also can be passed when calling the /summary endpoint.
        createdAt:
          type: string
          format: date-time
          description: (UNDOCUMENTED) The time when the booking was created.
        modifiedAt:
          type: string
          format: date-time
          description: (UNDOCUMENTED) The time when the booking was last modified.
        reference:
          type: string
          description: (UNDOCUMENTED) Reference code.
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'


    BookingFee:
      type: object
      properties:
        _id:
          type: string
        date:
          type: string
          format: date-time
          description: The date of the occurrence the fee has been generated for
        fee:
          $ref: '#/components/schemas/Fee'
          description: The actual charge generated for this occurrence.
        credits:
          type: array
          description: The credits used for the booking
        extraFees:
          type: array
          items:
            $ref: '#/components/schemas/Fee'
          description: Array of fees generated for the extras.

    Fee:
      type: object
      properties:
        _id:
          type: string
        name:
          type: string
          description: The name of the charge. It will appear in the invoice line item.
        price:
          type: number
          description: The unit price of the item described by the fee.
        quantity:
          type: number
          description: The quantity described by the one-off charge. If omitted, 1 is assumed.
        date:
          type: string
          format: date-time
          description: The date when the service has been sold. This date is used to determine in which invoice the fee should be included.
        team:
          type: string
          description: Reference to the company (required if no member)
        member:
          type: string
          description: Reference to the company (required if no team)
        office:
          type: string
          description: A reference to the location the fee is issued for
        plan:
          type: string
          description: A reference to the price plan assigned to the fee. It is used to determine the sales account when generating an invoice
        refundable:
          type: boolean
          description: If true, the one-off charge is counted as deposit and can be refunded later on.
        billInAdvance:
          type: boolean
          description: If true, the one-off charge is billed in advance (respecting its date). By default one-off charges are billed in arears.
        isPersonal:
          type: boolean
          description: If true, the one-off charge is billed to the assigned member and not to the company.
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'

    Plan:
      type: object
      required:
        - name
        - price
        - locations
        - type
        - intervalLength
        - credits
        - useValueCredits
        - deposit
        - depositPercent
        - depositPercentEnabled
        - public
        - forTeamMembers
        - forMembers
        - forNonMembers
        - prorate
        - allowCancellation
        - passes
      properties:
        _id:
          type: string
        name:
          type: string
          description: The name of the plan in hand. It appears everywhere in the system.
        description:
          type: string
          description: Text describing the plan. It will appear when users need to choose among different plans.
        price:
          type: number
          description: The default unit price for the plan, depending if it is recurring plan or a one-off plan.
        locations:
          type: array
          items:
            type: string
          description: List of all locations where the plan is present. If empty, all locations are assumed.
        type:
          type: string
          enum:
            - office
            - desk
            - hotdesk
            - service
          description: The type of the plan. It could be office, desk, hotdesk or service.
        intervalLength:
          type: string
          enum:
            - month
            - once
          description: The plan interval. It could be month or once.
        code:
          type: string
          description: External identified for the plan. Usually used for accounting purposes.
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'
        createdAt:
          type: string
          format: date-time
          description: The date when the plan has been created.
        createdBy:
          type: string
          description: The user that created the plan.
        modifiedAt:
          type: string
          format: date-time
          description: The user that did the last modification to the plan. If no update is made this field will match the createdBy field.
        modifiedBy:
          type: string
          description: The user that did the last modification to the plan. Before the first modification, this field equals to the createdBy field.
        # The following fields are not documented in the official public API but required for a lot (most) useful integrations.
        credits:
          description: (UNDOCUMENTED) Allowance.
          type: array
          items:
            type: object
            required:
              - type
              - rates
              - resourceTypes
              - oneOffPlans
              - goods
              - validFor
              - count
            properties:
              type:
                type: string
              rates:
                type: array
              resourceTypes:
                type: array
                description: (UNDOCUMENTED) Array of resource type IDs.
                items:
                  type: string
              oneOffPlans:
                type: array
              goods:
                type: array
              validFor:
                # TODO: Should this be an enum. We've seen 'resourceTypes' and 'all'.
                type: string
                description: (UNDOCUMENTED) "resourceTypes", "all".
              count:
                type: number
        useValueCredits:
          type: boolean
          description: (UNDOCUMENTED)
        deposit:
          type: number
          description: (UNDOCUMENTED) Fixed price deposit.
        depositPercent:
          type: number
          description: (UNDOCUMENTED) Percentage.
        depositPercentEnabled:
          type: boolean
          description: (UNDOCUMENTED) In practice this doesn't mean depositPercent actually has a valid value > 0.
        public:
          type: boolean
          description: (UNDOCUMENTED)
        forTeamMembers:
          type: boolean
          description: (UNDOCUMENTED)
        forMembers:
          type: boolean
          description: (UNDOCUMENTED)
        forNonMembers:
          type: boolean
          description: (UNDOCUMENTED)
        prorate:
          type: boolean
          description: (UNDOCUMENTED)
        allowCancellation:
          type: boolean
          description: (UNDOCUMENTED)
        passes:
          type: number
          description: (UNDOCUMENTED)

    Resource:
      type: object
      required:
        - name
        - office
        - type
        - target
        - targetPlan
        - availability
        - createdAt
        - createdBy
      properties:
        _id:
          type: string
        name:
          type: string
          description: The name of the resource in hand.
        rate:
          type: string
          description: The resource rate used for pricing bookings for this particular resource.
        office:
          type: string
          description: The location the resource is assigned to
        room:
          type: string
          description: The floorplan the resource is assigned to
        type:
          type: string
          description: The type of the resource.
        target:
          type: string
          description: |
            (NOTE) The type is documented as 'read-only' but it's a string (at the time of writing).
            
            The _id of the floor plan object to which the resource is associated.
            This shouldn't be edited apart from adjusting your floor plan through the admin UI.
        targetPlan:
          type: string
          description: |
            (NOTE) The type is documented as 'read-only' but it's a string (at the time of writing).
            
            The _id of the plan associated with the resource, if it's an assignable resource.
            This determines the plan that will be used when assigning a membership for the resource.
        availability:
          type: array
          description: |
            Contains a single object with two parameters - startDate and endDate. The two dates determine the availability of the resourcee.
            The "endDate" parameter can be set to null if the resource is available indefinitely.
          items:
            type: object
            properties:
              startDate:
                type: string
                format: date-time
              endDate:
                type: string
                format: date-time
        parents:
          type: array
          items:
            type: string
          description: Array of resource ids which are parents of the current resource. Parents are only present for resource types with hierarchicalResourcesEnabled option set to true.
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'
        image:
          type: string
          description: (UNDOCUMENTED) Image (useful for meeting rooms).
        number:
          type: number
          description: (UNDOCUMENTED) Capacity if the resource is a physical space. 1 car, 5 people etc...
        size:
          type: number
          description: (UNDOCUMENTED)
        timezone:
          type: string
          description: (UNDOCUMENTED) TZ database name timezone for the resource. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
        access:
          type: object
          description: (UNDOCUMENTED) Booking access controls.
          properties:
            full:
              type: boolean
              description: Member portal level access.
            public:
              type: boolean
              description: Self checkout by (new) non-members via a public calendar.
            teams:
              description: Restricted to a list of team IDs.
              type: array
              items:
                type: string
            plans:
              description: Restricted to a list of plan IDs.
              type: array
              items:
                type: string
        price:
          type: number
          description: (UNDOCUMENTED) Overrides the target plan or rate price. We think the priority is probably Price > Rate > Target Plan Price?
        deposit:
          type: number
          description: (UNDOCUMENTED) 
        area:
          type: number
          description: (UNDOCUMENTED)
        createdAt:
          type: string
          format: date-time
          description: The date when the resource has been created at.
        createdBy:
          type: string
          description: The user that created the resource.

    ResourceType:
      type: object
      required:
        - title
        - type
        - target
      properties:
        _id:
          type: string
        title:
          type: string
          description: The name of the resource type
        type:
          type: string
          description: A unique key that links the resource type to a zone type.
        target:
          type: string
          description: The floorplan object type of the resource.
        bookingMode:
          type: string
          enum:
            - time
            - date
          description: Booking mode of the resource type. One of types listed above.
        checkinMode:
          type: string
          enum:
            - half_day
            - day
          description: The check-in mode of the resource type (applicable to hotdesk type only). One of types listed above.
        icon:
          type: string
          description: An icon to represent the resource type on the portal.
        color:
          type: string
          description: A color that color codes the resource type on the floorplan.
        canBook:
          type: boolean
          description: If true, the resource type is available for booking on a calendar.
        canAssign:
          type: boolean
          description: If true, memberships is assignable to the resource type.
        primary:
          type: boolean
          description: If true, the resource occupancy can be tracked in the Occupancy section of the Dashboard.
        hierarchicalResourcesEnabled:
          type: boolean
          description: If true, the resource type allows parent/child relationship (applicable to meeting_room type only).

    # The contract structure is undocumented, we've gone by the example response for now.
    Contract:
      type: object
      # TODO: Required fields are unknown.
      properties:
        _id:
          type: string
        approveDate:
          type: string
          format: date-time
        approvedBy:
          type: object
          required:
            - userId
          properties:
            userId:
              type: string
            role:
              type: string
            displayName:
              type: string
        resourcesTotal:
          type: number
        servicesTotal:
          type: number
        baseTotal:
          type: number
        total:
          type: number
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        office:
          type: string
          description: The office primary key.
        number:
          type: string
        team:
          type: string
          description: The team primary key.
        documentType:
          type: string
        organization:
          type: string
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        plans:
          type: array
          items:
            $ref: '#/components/schemas/Plan'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ContractResource'
        notice:
          type: object
          description: (UNDOCUMENTED)
          properties:
            months:
              type: number
        type:
          type: string
          description: (UNDOCUMENTED)
        status:
          type: string
          description: (UNDOCUMENTED)
        stage:
          type: string
          description: (UNDOCUMENTED)
          enum:
            - served_notice
            - expired
            - active
            - terminated
            - not_renewed
            - up_for_renewal
        terminated:
          type: object
          description: (UNDOCUMENTED)
          required:
            - date
            - reasonKey
          properties:
            comments:
              type: string
            date:
              type: string
              format: date-time
            reasonKey:
              type: string
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'

    # The resource endpoints don't follow the documented API and return IDs for rate, office and room while contracts endpoints
    # do follow the documentation and return nested objects. Until this is fixed Resource and ContractResource are two seaparate types.
    ContractResource:
      type: object
      required:
        - name
        - office
        - room
        - type
        - target
        - targetPlan
        - availability
        - createdAt
        - createdBy
      properties:
        _id:
          type: string
        name:
          type: string
          description: The name of the resource in hand.
        rate:
          $ref: '#/components/schemas/Rate'
        office:
          $ref: '#/components/schemas/Office'
        room:
          $ref: '#/components/schemas/Floor'
        type:
          type: string
          description: The type of the resource.
        target:
          type: string
          description: |
            (NOTE) The type is documented as 'read-only' but it's a string (at the time of writing).
            
            The _id of the floor plan object to which the resource is associated.
            This shouldn't be edited apart from adjusting your floor plan through the admin UI.
        targetPlan:
          type: string
          description: |
            (NOTE) The type is documented as 'read-only' but it's a string (at the time of writing).
            
            The _id of the plan associated with the resource, if it's an assignable resource.
            This determines the plan that will be used when assigning a membership for the resource.
        availability:
          type: array
          description: |
            Contains a single object with two parameters - startDate and endDate. The two dates determine the availability of the resourcee.
            The "endDate" parameter can be set to null if the resource is available indefinitely.
          items:
            type: object
            properties:
              startDate:
                type: string
                format: date-time
              endDate:
                type: string
                format: date-time
        parents:
          type: array
          items:
            type: string
          description: Array of resource ids which are parents of the current resource. Parents are only present for resource types with hierarchicalResourcesEnabled option set to true.
        # Properties are currently not documented in the official public API but required for a lot of useful integrations.
        properties:
          $ref: '#/components/schemas/Properties'
        image:
          type: string
          description: (UNDOCUMENTED) Image (useful for meeting rooms).
        number:
          type: number
          description: (UNDOCUMENTED) Capacity if the resource is a physical space. 1 car, 5 people etc...
        size:
          type: number
          description: (UNDOCUMENTED)
        timezone:
          type: string
          description: (UNDOCUMENTED) TZ database name timezone for the resource. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
        access:
          type: object
          description: (UNDOCUMENTED) Booking access controls.
          properties:
            full:
              type: boolean
              description: Member portal level access.
            public:
              type: boolean
              description: Self checkout by (new) non-members via a public calendar.
            teams:
              description: Restricted to a list of team IDs.
              type: array
              items:
                type: string
            plans:
              description: Restricted to a list of plan IDs.
              type: array
              items:
                type: string
        price:
          type: number
          description: (UNDOCUMENTED) Overrides the target plan or rate price. We think the priority is probably Price > Rate > Target Plan Price?
        listPrice:
          type: number
          description: (UNDOCUMENTED)
        deposit:
          type: number
          description: (UNDOCUMENTED) 
        area:
          type: number
          description: (UNDOCUMENTED)
        createdAt:
          type: string
          format: date-time
          description: The date when the resource has been created at.
        createdBy:
          type: string
          description: The user that created the resource.
        steps:
          type: array
          description: (UNDOCUMENTED)
          items:
            type: object
            required:
              - startDate
              - endDate
              - price
              - calculatedDiscountAmount
              - discountedPrice
            properties:
              startDate: 
                type: string
                format: date-time
              endDate:
                type: string
                format: date-time
              price:
                type: number
              calculatedDiscountAmount:
                type: number
              discountedPrice:  
                type: number

# TODO: The Credit structure is undocumented.

# TODO: The Lead structure is undocumented.

    Post:
      type: object
      required:
        - type
        - description
        - locations
      properties:
        _id:
          type: string
        type:
          type: string
          description: The type of the post - currently the only supported type is info.
        description:
          type: string
          description: The content of the post.
        locations:
          type: array
          items:
            type: string
          description: List of locations for which this post is relevant. If you want to be for all locations - just pass an empty array []
        url:
          type: string
          description: The URL for the image included in the post headline.
        team:
          type: string
          description: A reference to the company that creates the post.
        member:
          type: string
          description: A reference to the member that creates the post.

    Event:
      type: object
      properties:
        _id:
          type: string
        start:
          type: string
          format: date-time
          description: The start date and time of the event. Must be a ISO-formatted in UTC.
        end:
          type: string
          format: date-time
          description: The end date and time of the event. Must be a ISO-formatted in UTC.
        office:
          type: string
          description: A reference to the location the invoiced is issued by.
        team:
          type: string
          description: A reference to the company that organizes the event.
        member:
          type: string
          description: A reference to the member that organizes the event.
        title:
          type: string
          description: A brief title of the event.
        description:
          type: string
          description: A detailed description of the event.
        where:
          type: string
          description: Additional information for the location of the event.
        timezone:
          type: string
          description: TZ database name timezone of the event. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
        image:
          type: string
          description: A url to an image for the event.
        limit:
          type: number
          description: The number of participants that this event will host.

    Visit:
      type: object
      required:
        - _id
        - office
        - visitor
        - team
        - member
        - end
        - start
      properties:
        _id:
          type: string
          description: The unique identifier for the visit
        office:
          type: string
          description: The location where the visit took place
        visitor:
          type: string
          description: The visitor that visited the location
        team:
          type: string
          description: The team with which the visit is associated
        member:
          type: string
          description: The member with which the visit is associated
        end:
          type: string
          format: date-time
          description: The end date and time of the visit
        start:
          type: string
          format: date-time
          description: The start date and time of the visit

    Visitor:
      type: object
      required:
        - name
        - member
        - type
      properties:
        _id:
          type: string
        name:
          type: string
          description: The full name of the visitor
        email:
          type: string
          description: The email address of the visitor
        member:
          type: string
          description: Reference to the member that the visitor is visiting
        type:
          type: string
          enum:
            - reception
            - preregistration
          description: Visitor type.
        description:
          type: string
          description: Description of the visitor
        phone:
          type: string
          description: The phone number of the visitor

    Charge:
      type: object
      required:
        - amount
        - date
        - status
        - reference
      properties:
        _id:
          type: string
        amount:
          type: number
          description: The amount of the transaction.
        date:
          type: string
          format: date-time
          description: The exact date of the transaction.
        status:
          type: string
          enum:
            - success
            - pending
            - fail
          description: The status of the transaction. One of the following success, pending, fail.
        reference:
          type: string
          description: Human readable description of the transaction.
        source:
          type: string
          description: The system the charge originated at. OfficeR&D by default
        account:
          type: string
          description: The name of the account where money are depositet at.
        integration:
          type: object
          description: Present if charge is collected via payment gateway. Its property providerChargeId is set to the gateway charge ID
        createdAt:
          type: string
          format: date-time
          description: The date when the charge has been created at.
        createdBy:
          type: string
          description: The user that created the charge.
        modifiedAt:
          type: string
          format: date-time
          description: The date when the charge has been modified for the last time. Before the first modification, this field equals to the createdAt field.
        modifiedBy:
          type: string
          description: The user that did the last modification to the charge. Before the first modification, this field equals to the createdBy field.
        payment:
          type: string
          description: The invoice or credit note the charge is associated with.
        office:
          type: string
          description: The location of the invoice or credit note the charge is assigned to.

    # TODO: The Network structure is undocumented.
    # TODO: All reporting structures and endpoints.
    # TODO: The Authentication structure is undocumented.
    # TODO: The Signup structure is undocumented.
    # TODO: Checkout structures and endpoints.
    # TODO: The Subscribe structure is undocumented.
    # TODO: User structures and endpoints.
    # TODO: Signup structures and endpoints.
    # TODO: Hosted payment gateway structures and endpoints.

    WebhookEvent:
      type: object
      required:
        - object
      properties:
        event:
          type: string
          description: unique identifier of the event instance
        eventType:
          type: string
          description: The event type that occurred in OfficeRnD
        data:
          type: object
          description: event payload describing the event
          properties:
            object:
              type: object
              description: resource that has been added/changed/removed
            previousAttributes:
              type: object
              description: field is only present for updated events. The object describing all changed attributes and their previous values
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
          description: The time of the event occurrence.

    Properties:
      type: object
      description: (UNDOCUMENTED) custom properties associated with a record. The CRUD API to create custom properties is also undocumented.