openapi: 3.2.0
info:
  title: Oracle Hospitality Availability API
  version: 26.2.0.0
  contact:
    email: hospitality_apis_ww_grp@oracle.com
  license:
    name: UPL
    url: https://opensource.org/licenses/upl
  termsOfService: https://www.oracle.com/legal/terms.html
  description: 'Operations tagged Availability across 3 of this provider''s published API definitions: oracle-hospitality-property-v1-chl.json, oracle-hospitality-property-v1-par.json, oracle-hospitality-property-v1-rtp.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /chl/v1
- url: /par/v1
- url: /rtp/v1
tags:
- name: Availability
  description: The Availability APIs allow you to manage a properties room-rate availability, which is configured for a channel. This also includes operations to manage restrictions and hurdles.
paths:
  /availability/summary:
    get:
      summary: Gets the regional rate parity
      description: Operation to Fetch the Regional Rate Parity. <p><strong>OperationId:</strong>getRegionalRateParity</p>
      operationId: getRegionalRateParity
      deprecated: true
      parameters:
      - name: language
        in: query
        required: false
        description: Language identification.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: numberOfDays
        in: query
        required: false
        schema:
          type: integer
      - name: hotelIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: channelCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: ratePlanCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: channelRatePlanCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: chainCode
        in: query
        required: false
        schema:
          type: string
      - name: rateAccessCode
        in: query
        required: false
        schema:
          type: string
      - name: qualifyingProfileCategory
        in: query
        required: false
        schema:
          type: string
      - name: qualifyingProfileId
        in: query
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to fetch regional rate parity.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/regionalRateParity'
        '204':
          description: RegionalRateParity not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /chl/v1
  /hotels/{hotelId}/channels/{channelCode}/rooms/{roomTypeCode}/inventorySnapshot:
    get:
      summary: Gets hotel room's restrictions and channel availability
      description: Operation to fetch the room availability and restrictions for a given property and room type in relation to channels. <p><strong>OperationId:</strong>getChannelInventorySnapshotByRoomType</p>
      operationId: getChannelInventorySnapshotByRoomType
      deprecated: true
      parameters:
      - name: roomTypeCode
        in: path
        required: true
        description: Room Type Code.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: channelCode
        in: path
        required: true
        description: Channel Code.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: fromDate
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: friday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: monday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: saturday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: sunday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: thursday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: tuesday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: wednesday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: duration
        in: query
        required: false
        schema:
          type: string
      - name: snapshotLevel
        in: query
        required: false
        description: Indicates to evaluate statistics for house, channel, and room type level. Must include the specific booking channel in the search criteria.
        schema:
          type: string
          enum:
          - BookingChannel
          - ChannelRoomType
          uniqueItems: true
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object containing the room availability and restrictions for a hotel in relation to booking channels.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/channelInventorySnapshot'
        '204':
          description: ChannelInventorySnapshotByRoomType not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /chl/v1
  /hotels/{hotelId}/generalAvailabilitySimulator:
    get:
      summary: Gets the General Availability
      description: Use this API to fetch the General Availability Simulator. <p><strong>OperationId:</strong>getGeneralAvailabilitySimulator</p>
      operationId: getGeneralAvailabilitySimulator
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: bookingChannelCode
        in: query
        required: false
        schema:
          type: string
      - name: arrival
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: adults
        in: query
        required: false
        schema:
          type: integer
      - name: nights
        in: query
        required: false
        schema:
          type: integer
      - name: children
        in: query
        required: false
        schema:
          type: integer
      - name: noOfRooms
        in: query
        required: false
        schema:
          type: integer
      - name: channelRatePlanCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: rateAccessCode
        in: query
        required: false
        schema:
          type: string
      - name: corpIdIATA
        in: query
        required: false
        schema:
          type: string
      - name: inventoryBlockCode
        in: query
        required: false
        schema:
          type: string
      - name: promotionCode
        in: query
        required: false
        schema:
          type: string
      - name: currencyCode
        in: query
        required: false
        schema:
          type: string
      - name: language
        in: query
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to simulate general availability.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/generalAvailabilitySimulator'
        '204':
          description: GeneralAvailabilitySimulator not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /chl/v1
  /hotels/{hotelId}/inventorySnapshot:
    get:
      summary: Gets hotel's rooms and restrictions channel availability
      description: Operation to fetch the room availability and restrictions for a given property in relation to channels. <p><strong>OperationId:</strong>getChannelInventorySnapshot</p>
      operationId: getChannelInventorySnapshot
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: fromDate
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: friday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: monday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: saturday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: sunday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: thursday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: tuesday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: wednesday
        in: query
        required: false
        schema:
          type: boolean
          default: 'false'
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: duration
        in: query
        required: false
        schema:
          type: string
      - name: bookingChannelCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: channelRoomTypes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: snapshotLevel
        in: query
        required: false
        description: Indicates to evaluate statistics for house, channel, and room type level. Must include the specific booking channel in the search criteria.
        schema:
          type: string
          enum:
          - BookingChannel
          - ChannelRoomType
          uniqueItems: true
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object containing the room availability and restrictions for a hotel in relation to booking channels.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/channelInventorySnapshot'
        '204':
          description: ChannelInventorySnapshot not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /chl/v1
  /hotels/{hotelId}/rateParity:
    get:
      summary: Gets channel's rate configuration
      description: Operation to Fetch the Rate Parity. The rate parity search criteria can include room types, rate plans, promotion code, rate access code or chain codes. <p><strong>OperationId:</strong>getRateParity</p>
      operationId: getRateParity
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: comparisonType
        in: query
        required: false
        description: 'An enumerated type defining the Parity Comparison type. Values: FIRST_RATES, CHANNEL_RATES. CHANNEL_RATES requires HotelCode and BookingChannelCode as part of request.'
        schema:
          type: string
      - name: language
        in: query
        required: false
        description: Language identification.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: numberOfDays
        in: query
        required: false
        schema:
          type: integer
      - name: channelCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: ratePlanCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: channelRoomType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: channelRatePlanCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: chainCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: rateAccessCode
        in: query
        required: false
        schema:
          type: string
      - name: inventoryBlockCode
        in: query
        required: false
        schema:
          type: string
      - name: promotionCode
        in: query
        required: false
        schema:
          type: string
      - name: qualifyingProfileCategory
        in: query
        required: false
        schema:
          type: string
      - name: qualifyingProfileId
        in: query
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to fetch Rate Parity.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rateParity'
        '204':
          description: RateParity not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /chl/v1
  /availability:
    get:
      summary: Get Hotel Availability
      description: ' This API fetches hotel availablity for multiple hotels, given dates, RatePlans, Rate Category, Rate Group, Membership Rates, Number of People. <p><strong>OperationId:</strong>getHotelAvailabilityCRO</p> <p>This API allows a time span of <strong>90</strong> days.</p>'
      operationId: getHotelAvailabilityCRO
      deprecated: true
      parameters:
      - name: cro
        in: query
        description: Central reservation office Code who is requesting Rate Availability.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: hotelIds
        in: query
        description: Hotel code of the Hotel whose Rate Availability is requested.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: includeClosedRates
        in: query
        description: Used to indicate if closed rates are to be included in the Rate Plan set.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: includeDefaultRatePlanSet
        in: query
        description: Used to indicate if the configured default rate plan set will be included.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: includeNoRatePlanSet
        in: query
        description: Includes the rate codes which do not have a rate plan set associated. This parameter is applicable when the property has not configured a default rate plan set.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: initialRatePlanSet
        in: query
        description: If InitialRatePlanSet is set to true response will return most relevant Rate Plan Set(e.g. NEGOTIATED if profiles has Negotiated Rates) depending on the request. if request does not requires special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: limit
        in: query
        description: Indicates maximum number of records a Web Service should return.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: pagePointerKey
        in: query
        description: Specifies fetched record's key as pointer to fetch additional records from. If key is composite use comma separated string.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ratePlanSet
        in: query
        description: Rate Plan Set code to filter Rate Plans based on the predefined set. if not specified it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set(See InitialRatePlanSet documentation).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: redeemAwards
        in: query
        description: Used to indicate if the awards are to be redeemed.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: roomStayStartDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: roomStayEndDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: roomStayQuantity
        in: query
        required: false
        schema:
          type: integer
      - name: adults
        in: query
        required: false
        description: Defines the number of Adults.
        schema:
          type: integer
      - name: children
        in: query
        required: false
        description: Defines the number of Children.
        schema:
          type: integer
      - name: childAge
        in: query
        description: Age of a child in years.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: bucket1Count
        in: query
        required: false
        description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        schema:
          type: integer
      - name: bucket2Count
        in: query
        required: false
        description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        schema:
          type: integer
      - name: bucket3Count
        in: query
        required: false
        description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        schema:
          type: integer
      - name: bucket4Count
        in: query
        required: false
        description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        schema:
          type: integer
      - name: bucket5Count
        in: query
        required: false
        description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        schema:
          type: integer
      - name: fullStayTimeSpanStartDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: fullStayTimeSpanEndDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: prevailingRate
        in: query
        required: false
        schema:
          type: boolean
      - name: rateCategory
        in: query
        required: false
        schema:
          type: string
      - name: rateClass
        in: query
        required: false
        schema:
          type: string
      - name: rateGroup
        in: query
        required: false
        schema:
          type: string
      - name: ratePlanCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: promotionCode
        in: query
        description: Promotion code associated with the rate plan.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roomType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClass
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: bedType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: feature
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: reservationGuestId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: reservationGuestIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: reservationProfileType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Guest
            - Company
            - Group
            - TravelAgent
            - Source
            - ReservationContact
            - BillingContact
            - Addressee
          uniqueItems: true
      - name: attachedProfileId
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: hotelReservationId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: hotelReservationIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: ratePlanInfo
        in: query
        required: false
        description: If true Rate Plan Code Master information will be included in the response.
        schema:
          type: boolean
      - name: returnOnlyAvailableRateCodes
        in: query
        required: false
        description: If true Only availability check will be done and it will return available rate codes.
        schema:
          type: boolean
      - name: resGuaranteeInfo
        in: query
        required: false
        description: If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.
        schema:
          type: boolean
      - name: roomTypeInfo
        in: query
        required: false
        description: If true Room Type Master information will be included in the response.
        schema:
          type: boolean
      - name: membershipIdNumber
        in: query
        description: Membership id Number of the guest.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: membershipLevel
        in: query
        description: Membership id Number of the guest.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: membershipType
        in: query
        description: Membership id Number of the guest.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: pointsAvailable
        in: query
        description: Used to indicate Points Available for Profile Primary Membership Type.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: membershipCardNumber
        in: query
        required: false
        description: Member Card number associated with the guest membership.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: smokingPreference
        in: query
        description: Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: hotelPackage
        in: query
        description: Hotel Package Code to filter the search result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: yieldMarketCode
        in: query
        required: false
        schema:
          type: string
      - name: accessibleRoomTypesOnly
        in: query
        description: Used to fetch accessible room types only in the Rate Plan set.
        required: false
        schema:
          type: boolean
      - name: includeLocalRates
        in: query
        required: false
        description: Used to indicate if local rates are to be included in the Rate Plan set.
        schema:
          type: boolean
      - name: includeOffshoreRates
        in: query
        required: false
        description: Used to indicate if offshore rates are to be included in the Rate Plan set.
        schema:
          type: boolean
      - name: postingInterval
        in: query
        description: Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Nightly
            - Weekly
            - Monthly
          uniqueItems: true
      - name: ownerType
        in: query
        required: false
        description: Owner Room Type - can be either Owner or Referral
        schema:
          type: string
          enum:
          - Owner
          - Referral
          - Regular
          uniqueItems: true
      - name: controlSegment
        in: query
        required: false
        description: Control Segment to check for casino restrction for a patron profile.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to search hotel availability based on request segment.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/hotelAvailability'
        '204':
          description: HotelAvailabilityCRO not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /availability/searches:
    post:
      summary: Get Hotel Availability
      description: ' This API fetches hotel availablity for multiple hotels, given dates, RatePlans, Rate Category, Rate Group, Membership Rates, Number of People. <p><strong>OperationId:</strong>searchHotelAvailabilityCRO</p> <p>This API allows a time span of <strong>90</strong> days.</p>'
      operationId: searchHotelAvailabilityCRO
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to search hotel availability based on request segment.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/hotelAvailability'
        '204':
          description: HotelAvailabilityCRO not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchHotelAvailabilityCRORequest'
        description: Hotel Availability Request
    servers:
    - url: /par/v1
  /hotels:
    get:
      summary: Search hotels for the sales process
      description: This API is to search hotels for the sales process. <p><strong>OperationId:</strong>getHotels</p>
      operationId: getHotels
      parameters:
      - name: cro
        in: query
        required: false
        description: Central Reservation Office Code who is conducting the search. This will search only hotels handled by the CRO.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: quantity
        in: query
        required: false
        schema:
          type: integer
      - name: adults
        in: query
        required: false
        description: Defines the number of Adults.
        schema:
          type: integer
      - name: children
        in: query
        required: false
        description: Defines the number of Children.
        schema:
          type: integer
      - name: alternateHotels
        in: query
        required: false
        description: If true or not specified Alternate Hotels will be returned in the result. To search specific hotels send it false.
        schema:
          type: boolean
      - name: hotelId
        in: query
        description: Hotel Code to be searched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: regionCode
        in: query
        required: false
        description: Region Code where the given cities are located.
        schema:
          type: string
      - name: city
        in: query
        description: City Code to filter the search result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: hotelType
        in: query
        description: Hotel Type to filter the search result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: hotelAmenity
        in: query
        description: Hotel Amenity Code to filter the search result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: attraction
        in: query
        description: Attaction Code to filter the search result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: hotelPackage
        in: query
        description: Hotel Package Code to filter the search result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: prevailingRate
        in: query
        required: false
        schema:
          type: boolean
      - name: rateCategory
        in: query
        required: false
        schema:
          type: string
      - name: rateClass
        in: query
        required: false
        schema:
          type: string
      - name: rateGroup
        in: query
        required: false
        schema:
          type: string
      - name: ratePlanCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ratePlanId
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: promotionCode
        in: query
        description: Promotion code associated with the rate plan.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roomType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClass
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: bedType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: feature
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: reservationGuestId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: reservationGuestIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: reservationProfileType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Guest
            - Company
            - Group
            - TravelAgent
            - Source
            - ReservationContact
            - BillingContact
            - Addressee
          uniqueItems: true
      - name: id
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: currencyExchangeRates
        in: query
        required: false
        description: If true Currency Exchange Rates information will be included in the response.
        schema:
          type: boolean
      - name: ratePlanInfo
        in: query
        required: false
        description: If true Rate Plan Code Master information will be included in the response.
        schema:
          type: boolean
      - name: resGuaranteeInfo
        in: query
        required: false
        description: If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.
        schema:
          type: boolean
      - name: returnAllRates
        in: query
        required: false
        description: Indicates whether to return only 'Requested' rate codes or 'All' rate codes. The default value is true which means all available ratecodes will be returned.
        schema:
          type: boolean
      - name: roomTypeInfo
        in: query
        required: false
        description: If true Room Type Master information will be included in the response.
        schema:
          type: boolean
      - name: orderBy
        in: query
        required: false
        description: A collection of supported sorting options for search hotels results.
        schema:
          type: string
          enum:
          - MOSTAVAIL
          - LEASTAVAIL
          - MOSTPERCAVAIL
          - LISTPERCAVAIL
          - SHORTESTDISTANCE
          - DEFAULT
          - ALPHABETICAL
          - RATELOWTOHIGH
          - RATEHIGHTOLOW
          uniqueItems: true
      - name: sellMessages
        in: query
        required: false
        description: If true Sell Messages information will be included in the response.
        schema:
          type: boolean
      - name: blockId
        in: query
        required: false
        description: Block Id to query for sell messages.
        schema:
          type: number
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to search hotel availability.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/searchHotelsDetails'
        '204':
          description: Hotels not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/analyzeRateAvailability:
    get:
      summary: 'Analyze Rate Availability '
      description: This API allows to Analyze Rate Availability. Rate analysis request to include the rate code, room type and room span to analyze whether a rate is closed and the reasons. <p><strong>OperationId:</strong>analyzeRateAvailability</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: analyzeRateAvailability
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: ratePlanCode
        in: query
        required: false
        description: The Rate Code for which the Analysis is requested.
        schema:
          type: string
      - name: roomType
        in: query
        required: false
        description: The Room Type for which the Analysis is requested. Analysis is done to determine whether the Rate Code is available for this Room Type.
        schema:
          type: string
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: duration
        in: query
        required: false
        schema:
          type: string
      - name: numberOfRooms
        in: query
        required: false
        description: The number of rooms requested. The Analysis to check if this Rate Code is available for this number of rooms.
        schema:
          type: integer
      - name: adults
        in: query
        required: false
        description: Defines the number of Adults.
        schema:
          type: integer
      - name: children
        in: query
        required: false
        description: Defines the number of Children.
        schema:
          type: integer
      - name: childAge
        in: query
        description: Age of a child in years.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: bucket1Count
        in: query
        required: false
        description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        schema:
          type: integer
      - name: bucket2Count
        in: query
        required: false
        description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        schema:
          type: integer
      - name: bucket3Count
        in: query
        required: false
        description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        schema:
          type: integer
      - name: bucket4Count
        in: query
        required: false
        description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        schema:
          type: integer
      - name: bucket5Count
        in: query
        required: false
        description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        schema:
          type: integer
      - name: blockId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: blockIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: reservationId
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: reservationIdType
        in: query
        description: A reference to the type of object defined by the UniqueID element.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: controlSegment
        in: query
        required: false
        description: Control Segment to check for casino restrction for a patron profile.
        schema:
          type: string
      - name: reservationGuestId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response to the fetch Rate Availability Analysis.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rateAnalysisDetails'
        '204':
          description: analyzeRateAvailability not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/analyzeRateAvailability/searches:
    post:
      summary: 'Analyze Rate Availability '
      description: This API allows to Analyze Rate Availability. Rate analysis request to include the rate code, room type and room span to analyze whether a rate is closed and the reasons. <p><strong>OperationId:</strong>searchAnalyzeRateAvailability</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: searchAnalyzeRateAvailability
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response to the fetch Rate Availability Analysis.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rateAnalysisDetails'
        '204':
          description: analyzeRateAvailability not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchAnalyzeRateAvailabilityRequest'
        description: Analyze Rate Availability Request
    servers:
    - url: /par/v1
  /hotels/{hotelId}/availability:
    get:
      summary: Get Hotel Availability
      description: ' This API fetches hotel availability for any specific hotel, given dates, rate plans, rate category, rate group, membership rates, and number of people. It returns a list of available rate plan codes, room types, and room rates for any given search criteria. <p><strong>OperationId:</strong>getHotelAvailability</p> <p>This API allows a time span of <strong>90</strong> days.</p>'
      operationId: getHotelAvailability
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: includeLocalRates
        in: query
        required: false
        description: Used to indicate if local rates are to be included in the Rate Plan set.
        schema:
          type: boolean
      - name: includeOffshoreRates
        in: query
        required: false
        description: Used to indicate if offshore rates are to be included in the Rate Plan set.
        schema:
          type: boolean
      - name: cro
        in: query
        description: Central reservation office Code who is requesting Rate Availability.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: includeClosedRates
        in: query
        description: Used to indicate if closed rates are to be included in the Rate Plan set.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: includeDefaultRatePlanSet
        in: query
        description: Used to indicate if the configured default rate plan set will be included.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: includeNoRatePlanSet
        in: query
        description: Includes the rate codes which do not have a rate plan set associated. This parameter is applicable when the property has not configured a default rate plan set.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: initialRatePlanSet
        in: query
        description: If InitialRatePlanSet is set to true response will return most relevant Rate Plan Set(e.g. NEGOTIATED if profiles has Negotiated Rates) depending on the request. if request does not requires special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: limit
        in: query
        description: Indicates maximum number of records a Web Service should return.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: pagePointerKey
        in: query
        description: Specifies fetched record's key as pointer to fetch additional records from. If key is composite use comma separated string.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ratePlanSet
        in: query
        description: Rate Plan Set code to filter Rate Plans based on the predefined set. if not specified it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set(See InitialRatePlanSet documentation).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: redeemAwards
        in: query
        description: Used to indicate if the awards are to be redeemed.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: roomStayStartDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: roomStayEndDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: roomStayQuantity
        in: query
        required: false
        schema:
          type: integer
      - name: adults
        in: query
        required: false
        description: Defines the number of Adults.
        schema:
          type: integer
      - name: children
        in: query
        required: false
        description: Defines the number of Children.
        schema:
          type: integer
      - name: childAge
        in: query
        description: Age of a child in years.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: bucket1Count
        in: query
        required: false
        description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        schema:
          type: integer
      - name: bucket2Count
        in: query
        required: false
        description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        schema:
          type: integer
      - name: bucket3Count
        in: query
        required: false
        description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        schema:
          type: integer
      - name: bucket4Count
        in: query
        required: false
        description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        schema:
          type: integer
      - name: bucket5Count
        in: query
        required: false
        description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        schema:
          type: integer
      - name: fullStayTimeSpanStartDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: fullStayTimeSpanEndDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: prevailingRate
        in: query
        required: false
        schema:
          type: boolean
      - name: rateCategory
        in: query
        required: false
        schema:
          type: string
      - name: rateClass
        in: query
        required: false
        schema:
          type: string
      - name: rateGroup
        in: query
        required: false
        schema:
          type: string
      - name: ratePlanCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: promotionCode
        in: query
        description: Promotion code associated with the rate plan.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roomType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: feature
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: reservationGuestId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: reservationGuestIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: reservationProfileType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Guest
            - Company
            - Group
            - TravelAgent
            - Source
            - ReservationContact
            - BillingContact
            - Addressee
          uniqueItems: true
      - name: attachedProfileId
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: hotelReservationId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: hotelReservationIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: ratePlanInfo
        in: query
        required: false
        description: If true Rate Plan Code Master information will be included in the response.
        schema:
          type: boolean
      - name: returnOnlyAvailableRateCodes
        in: query
        required: false
        description: If true Only availability check will be done and it will return available rate codes.
        schema:
          type: boolean
      - name: resGuaranteeInfo
        in: query
        required: false
        description: If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.
        schema:
          type: boolean
      - name: roomTypeInfo
        in: query
        required: false
        description: If true Room Type Master information will be included in the response.
        schema:
          type: boolean
      - name: membershipIdNumber
        in: query
        description: Membership id Number of the guest.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: membershipLevel
        in: query
        description: Membership id Number of the guest.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: membershipType
        in: query
        description: Membership id Number of the guest.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: pointsAvailable
        in: query
        description: Used to indicate Points Available for Profile Primary Membership Type.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: membershipCardNumber
        in: query
        required: false
        description: Member Card number associated with the guest membership.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: smokingPreference
        in: query
        description: Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: hotelPackage
        in: query
        description: Hotel Package Code to filter the search result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: ownerType
        in: query
        required: false
        description: Owner Room Type - can be either Owner or Referral
        schema:
          type: string
          enum:
          - Owner
          - Referral
          - Regular
          uniqueItems: true
      - name: controlSegment
        in: query
        required: false
        description: Control Segment to check for casino restrction for a patron profile.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: postingInterval
        in: query
        description: Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Nightly
            - Weekly
            - Monthly
          uniqueItems: true
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to search hotel availability based on request segment.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/hotelAvailability'
        '204':
          description: HotelAvailability not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/availability/alternate:
    get:
      summary: Get Alternate Availability
      description: This API allows to  fetch alternate dates for closed rates. Criteria for to search for alternate dates, room stay information, profile block or guest information can be specified. <p><strong>OperationId:</strong>getAlternateAvailability</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getAlternateAvailability
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: ratePlanCode
        in: query
        required: false
        description: Requested Rate code
        schema:
          type: string
      - name: redemption
        in: query
        required: false
        description: Used to indicate if award redemption flag is to be set.
        schema:
          type: boolean
      - name: roomType
        in: query
        required: false
        description: Requested Room type.
        schema:
          type: string
      - name: roomNumber
        in: query
        required: false
        description: Requested Room Number.
        schema:
          type: string
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: duration
        in: query
        required: false
        schema:
          type: string
      - name: quantity
        in: query
        required: false
        schema:
          type: integer
      - name: adults
        in: query
        required: false
        description: Defines the number of Adults.
        schema:
          type: integer
      - name: children
        in: query
        required: false
        description: Defines the number of Children.
        schema:
          type: integer
      - name: childAge
        in: query
        description: Age of a child in years.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: bucket1Count
        in: query
        required: false
        description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        schema:
          type: integer
      - name: bucket2Count
        in: query
        required: false
        description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        schema:
          type: integer
      - name: bucket3Count
        in: query
        required: false
        description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        schema:
          type: integer
      - name: bucket4Count
        in: query
        required: false
        description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        schema:
          type: integer
      - name: bucket5Count
        in: query
        required: false
        description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        schema:
          type: integer
      - name: reservationGuestId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: reservationGuestIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: reservationProfileType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Guest
            - Company
            - Group
            - TravelAgent
            - Source
            - ReservationContact
            - BillingContact
            - Addressee
          uniqueItems: true
      - name: blockCode
        in: query
        required: false
        schema:
          type: string
      - name: blockName
        in: query
        required: false
        schema:
          type: string
      - name: blockId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: blockIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: membershipLevel
        in: query
        required: false
        description: Membership id Number of the guest.
        schema:
          type: string
      - name: membershipType
        in: query
        required: false
        description: Membership id Number of the guest.
        schema:
          type: string
      - name: controlSegment
        in: query
        required: false
        description: Control Segment to check for casino restrction for a patron profile.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetch alternate availability operation
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/alternateAvailability'
        '204':
          description: AlternateAvailability not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/availability/alternate/searches:
    post:
      summary: Get Alternate Availability
      description: This API allows to  fetch alternate dates for closed rates. Criteria for to search for alternate dates, room stay information, profile block or guest information can be specified. <p><strong>OperationId:</strong>searchAlternateAvailability</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: searchAlternateAvailability
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetch alternate availability operation
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/alternateAvailability'
        '204':
          description: AlternateAvailability not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchAlternateAvailabilityRequest'
        description: Alternate Availability Request
    servers:
    - url: /par/v1
  /hotels/{hotelId}/availability/searches:
    post:
      summary: Get Hotel Availability
      description: ' This API fetches hotel availability for any specific hotel, given dates, rate plans, rate category, rate group, membership rates, and number of people. It returns a list of available rate plan codes, room types, and room rates for any given search criteria. <p><strong>OperationId:</strong>searchHotelAvailability</p> <p>This API allows a time span of <strong>90</strong> days.</p>'
      operationId: searchHotelAvailability
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to search hotel availability based on request segment.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/hotelAvailability'
        '204':
          description: HotelAvailability not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchHotelAvailabilityRequest'
        description: Hotel Availability Request
    servers:
    - url: /par/v1
  /hotels/{hotelId}/availableUpsells:
    get:
      summary: Get for Available Up-sells
      description: This API allows to fetch for Available Up-sells for specific hotel and date range. <p><strong>OperationId:</strong>getAvailableUpsells</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getAvailableUpsells
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: reservationId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: profileId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: reservationStatus
        in: query
        required: false
        description: This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
        schema:
          type: string
          enum:
          - Reserved
          - Requested
          - NoShow
          - Cancelled
          - InHouse
          - CheckedOut
          - Waitlisted
          - DueIn
          - DueOut
          - Walkin
          - PendingCheckout
          uniqueItems: true
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: ratePlanCode
        in: query
        required: false
        description: Rate plan code
        schema:
          type: string
      - name: roomType
        in: query
        required: false
        description: Room type
        schema:
          type: string
      - name: adults
        in: query
        required: false
        description: Defines the number of Adults.
        schema:
          type: integer
      - name: children
        in: query
        required: false
        description: Defines the number of Children.
        schema:
          type: integer
      - name: rateAmount
        in: query
        required: false
        description: A monetary amount.
        schema:
          type: number
      - name: guaranteeCode
        in: query
        required: false
        description: Guarantee code
        schema:
          type: string
      - name: marketCode
        in: query
        required: false
        description: Market code
        schema:
          type: string
      - name: fixedRate
        in: query
        required: false
        description: Fixed Rate flag
        schema:
          type: boolean
      - name: rateDate
        in: query
        description: Reservation date
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: requiredAmount
        in: query
        description: A monetary amount.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: numberOfRooms
        in: query
        required: false
        description: Number of Rooms
        schema:
          type: integer
      - name: bucket1Count
        in: query
        required: false
        description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        schema:
          type: integer
      - name: bucket2Count
        in: query
        required: false
        description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        schema:
          type: integer
      - name: bucket3Count
        in: query
        required: false
        description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        schema:
          type: integer
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for fetching available upsells.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/availableUpsells'
        '204':
          description: AvailableUpsells not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/guarantees:
    get:
      summary: 'Get Reservation Guarantee '
      description: This API allows to Fetch Reservation Guarantee. The criteria can include the rate plan code, arrival date, guarantee code and the profile information.  <p><strong>OperationId:</strong>getReservationGuarantees</p>
      operationId: getReservationGuarantees
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: arrivalDate
        in: query
        required: true
        description: Arrival Date of the guest.
        schema:
          type: string
          format: date
      - name: ratePlanCode
        in: query
        required: false
        description: Rate Plan Code to find associated Guarantee Codes.
        schema:
          type: string
      - name: blockId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: reservationGuestId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: companyId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: travelAgentId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: sourceId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: groupId
        in: query
        required: false
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        schema:
          type: string
      - name: guaranteeCode
        in: query
        required: false
        description: Guarantee Code should be supplied only for the code verification purpose, if the supplied code is valid for the rest of the criteria it will return the response with the Guarantee Code information.
        schema:
          type: string
      - name: calculateEstimateAmount
        in: query
        required: false
        description: Determines whether estimated amount to be calculated or not
        schema:
          type: boolean
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: numberOfRooms
        in: query
        required: false
        schema:
          type: integer
      - name: numberOfAdults
        in: query
        required: false
        description: Defines the number of Adults.
        schema:
          type: integer
      - name: numberOfChildren
        in: query
        required: false
        description: Defines the number of Children.
        schema:
          type: integer
      - name: roomType
        in: query
        required: false
        description: Room Type for the reservation
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object to fetch reservation guarantees.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reservationGuaranteesPolicies'
        '204':
          description: ReservationGuarantees not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/hurdles:
    get:
      summary: Get Hurdle Rates
      description: This API allows to fetch existing Hurdle Rates. <p><strong>OperationId:</strong>getHurdleRates</p>
      operationId: getHurdleRates
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hurdleDate
        in: query
        required: false
        description: Date criteria for which the hurdle rate is scheduled.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 25
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 0
      - name: roomTypesCode
        in: query
        description: Codes to be searched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: wildCard
        in: query
        required: false
        description: Wildcard search on the code.
        schema:
          type: string
      - name: hurdleRangeStart
        in: query
        description: Hurdle date start range from which the hurdle rate is scheduled.
        required: false
        schema:
          type: string
          format: date
      - name: hurdleRangeEnd
        in: query
        description: Hurdle date end range to which the hurdle rate is scheduled.
        required: false
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching Hurdle rates.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/hurdleRates'
        '204':
          description: HurdleRates not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    post:
      summary: Create Hurdle Rates
      description: This API allows to create hurdle rates. <p><strong>OperationId:</strong>postHurdleRates</p>
      operationId: postHurdleRates
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/createHurdleRates'
        description: Request object for creating new Hurdle Rates.
        required: true
    put:
      summary: Change Hurdle Rates
      description: This API allows to update an existing Hurdle Rate. <p><strong>OperationId:</strong>putHurdleRates</p>
      operationId: putHurdleRates
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/changeHurdleRatesDetails'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/changeHurdleRates'
        description: Request object for changing existing Hurdle Rates.
        required: true
    delete:
      summary: Delete Hurdle Rates
      description: This API allows to delete hurdles rates. <p><strong>OperationId:</strong>deleteHurdleRates</p>
      operationId: deleteHurdleRates
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hurdleDate
        in: query
        description: Hurdle date for which the hurdle rate is scheduled.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: roomType
        in: query
        description: Room type for which the hurdle rate applies to.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roomCategory
        in: query
        description: Internal room category of the room type for which the hurdle rate applies to.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: yieldCategory
        in: query
        description: Yield category for which the hurdle rate applies to.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: lengthOfStay
        in: query
        description: Length of stay for which the hurdle rate applies to.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: yieldMarketCode
        in: query
        description: Yield market code for which the hurdle rate applies to.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: hurdleRangeStart
        in: query
        description: Hurdle date start range from which the hurdle rate is scheduled.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: hurdleRangeEnd
        in: query
        description: Hurdle date end range to which the hurdle rate is scheduled.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/rates:
    get:
      summary: 'Get the Rate Plan Information '
      description: This API allows to fetch Rate Plan information. <p><strong>OperationId:</strong>getAvailabilityRatePlanInfoByMultipleRatePlans</p>
      operationId: getAvailabilityRatePlanInfoByMultipleRatePlans
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: ratePlanCodeList
        in: query
        description: Rate Plan code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching rate plans.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/availabilityRatePlanInfo'
        '204':
          description: AvailabilityRatePlanInfoByMultipleRatePlans not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/rates/{ratePlanCode}:
    get:
      summary: 'Get Rate Plan Information '
      description: This API fetches the ratePlan information like description, short information, long information, Web URL for the ratePlan and Commission Code. The rate plan code list can be passed as part of the criteria in the request. <p><strong>OperationId:</strong>getAvailabilityRatePlanInfo</p>
      operationId: getAvailabilityRatePlanInfo
      parameters:
      - name: ratePlanCode
        in: path
        required: true
        description: Rate Plan Code.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: ratePlanCodeList
        in: query
        description: Rate Plan code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching rate plans.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/availabilityRatePlanInfo'
        '204':
          description: AvailabilityRatePlanInfo not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/restrictions:
    get:
      summary: 'Get the Restrictions '
      description: This API allows to fetch the Restrictions for a hotel in given date range. The search criteria can include filter codes or restriction control types, date range and the hotel information. <p><strong>OperationId:</strong>getRestrictionsByDateRange</p>
      operationId: getRestrictionsByDateRange
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: chainName
        in: query
        required: false
        description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).
        schema:
          type: string
      - name: end
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: fetchSizeByDay
        in: query
        required: false
        description: Defines the maximum amount of restrictions by day.
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: restrictionInfo
        in: query
        required: false
        schema:
          type: string
          enum:
          - Detail
          - Overview
          - Year
          uniqueItems: true
      - name: restrictionSearchCriteriaStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: bookingChannelCode
        in: query
        required: false
        description: Indicates restriction is applicable to specified Booking Channel Code in conjunction with other codes, if specified.
        schema:
          type: string
      - name: ratePlanCategory
        in: query
        required: false
        description: Indicates restriction is applicable to specified Rate Plan Category in conjunction with other codes, if specified.
        schema:
          type: string
      - name: ratePlanCode
        in: query
        required: false
        description: Indicates restriction is applicable to specified Rate Plan Code in conjunction with other codes, if specified.
        schema:
          type: string
      - name: roomClass
        in: query
        required: false
        description: Indicates restriction is applicable to specified Room Category in conjunction with other codes, if specified.
        schema:
          type: string
      - name: roomType
        in: query
        required: false
        description: Indicates restriction is applicable to specified Room Type in conjunction with other codes, if specified.
        schema:
          type: string
      - name: filterCodeCategory
        in: query
        required: false
        description: 'An enumerated type defining the Filter Code Categort or Type. Values: BookingChannelCode, RoomClass, RoomType, RatePlanCategory, RatePlanCode.'
        schema:
          type: string
          enum:
          - BookingChannelCode
          - RoomClass
          - RoomType
          - RatePlanCategory
          - RatePlanCode
          uniqueItems: true
      - name: filterCode
        in: query
        description: Defines BookingChannelCode, RoomClass, RoomType, RatePlanCategory or RatePlanCode to filter the Restriction.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: houseLevelRestriction
        in: query
        required: false
        description: Applicable when Always Display House Level Restrictions Parameter is On. If true, API returns restrictions at the House level when searching by channel, room class, room type, rate category and rate code.
        schema:
          type: boolean
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching restrictions based on date range.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/restrictionsByDateRange'
        '204':
          description: RestrictionsByDateRange not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    post:
      summary: 'Create a Restriction '
      description: This API allows you to create restrictions on various levels such as house level, rate class, rate category, rate plan, room class, room type, and booking channel code. <p><strong>OperationId:</strong>postRestriction</p>
      operationId: postRestriction
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/createRestriction'
        description: Request object for creating a new restriction.
        required: true
    put:
      summary: Clear all Restrictions
      description: This API allows Clear all Restrictions for a hotel on given date. The hotel code and the date will need to be passed as part of the request. <p><strong>OperationId:</strong>clearAllRestrictions</p>
      operationId: clearAllRestrictions
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/clearAllRestrictions'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/clearAllRestrictions'
        description: Request object for clearing all restrictions based on date.
        required: true
    servers:
    - url: /par/v1
  /hotels/{hotelId}/restrictions/{restrictionId}:
    delete:
      summary: 'Delete a Restriction '
      description: 'This API allows to Delete a given restriction. The date range is passed along with the restriction control type details which can include house, room type, room class or rate plan information. The unique criteria has been defined with one of these combinations: restrictionType, restrictionStartDate, restrictionEndDate, bookingChannelCode, ratePlanCategory, ratePlanCode, roomClass, roomType.<p><strong>OperationId:</strong>deleteRestriction</p>'
      operationId: deleteRestriction
      parameters:
      - name: restrictionId
        in: path
        required: true
        description: Indicates the Restriction Type of the restriction and mandatory to delete the restriction.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Indicates restriction is applicable to specified property and mandatory to delete the restriction.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: restrictionEndDate
        in: query
        required: false
        description: Indicates the End date of the restriction and mandatory to delete the restriction.
        schema:
          type: string
          format: date
      - name: restrictionStartDate
        in: query
        required: false
        description: Indicates the start date of the restriction and mandatory to delete the restriction.
        schema:
          type: string
          format: date
      - name: bookingChannelCode
        in: query
        required: false
        description: Indicates restriction is applicable to specified Booking Channel Code in conjunction with other codes, if specified.
        schema:
          type: string
      - name: ratePlanCategory
        in: query
        required: false
        description: Indicates restriction is applicable to specified Rate Plan Category in conjunction with other codes, if specified.
        schema:
          type: string
      - name: ratePlanCode
        in: query
        required: false
        description: Indicates restriction is applicable to specified Rate Plan Code in conjunction with other codes, if specified.
        schema:
          type: string
      - name: roomClass
        in: query
        required: false
        description: Indicates restriction is applicable to specified Room Category in conjunction with other codes, if specified.
        schema:
          type: string
      - name: roomType
        in: query
        required: false
        description: Indicates restriction is applicable to specified Room Type in conjunction with other codes, if specified.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/restrictionsHistory:
    get:
      summary: 'Get the Restriction history '
      description: This API allows to fetch the Restriction history. Specify filter codes or restriction control types. The date range can be passed as part of the request. <p><strong>OperationId:</strong>getRestrictionsHistory</p>
      operationId: getRestrictionsHistory
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: chainName
        in: query
        required: false
        description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).
        schema:
          type: string
      - name: date
        in: query
        required: false
        description: The date for which a restriction log exists.
        schema:
          type: string
          format: date
      - name: startDate
        in: query
        required: false
        description: The date for which a restriction log exists. When start date is passed, end date must be provided which will fetch all restrictions logs that has an overlap in the provided range.
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        description: The date for which a restriction log exists. When start date is passed, end date must be provided which will fetch all restrictions logs that has an overlap in the provided range.
        schema:
          type: string
          format: date
      - name: bookingChannelCode
        in: query
        required: false
        description: Indicates restriction is applicable to specified Booking Channel Code in conjunction with other codes, if specified.
        schema:
          type: string
      - name: ratePlanCategory
        in: query
        description: Indicates restriction is applicable to specified Rate Plan Category in conjunction with other codes, if specified.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 10
      - name: ratePlanCode
        in: query
        description: Indicates restriction is applicable to specified Rate Plan Code in conjunction with other codes, if specified.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 10
      - name: roomClass
        in: query
        description: Indicates restriction is applicable to specified Room Category in conjunction with other codes, if specified.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 10
      - name: roomType
        in: query
        description: Indicates restriction is applicable to specified Room Type in conjunction with other codes, if specified.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 10
      - name: restrictionType
        in: query
        description: Indicates the restriction types.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          enum:
          - Closed
          - ClosedForArrival
          - ClosedForDeparture
          - MinimumStayThrough
          - MaximumStayThrough
          - MinimumLengthOfStay
          - MaximumLengthOfStay
          - LOSNotAvailable
          - MinimumAdvanceBooking
          - MaximumAdvanceBooking
          - Open
          - OpenForArrival
          - OpenForDeparture
          - Hurdle
          - MinimumOccupancy
          - MaximumOccupancy
          - RateStrategy
          - RateDetailsNotSet
          - InventoryItemNotAvailable
          - RankRestriction
          - MaximumAuth
          - InventoryNotAvailable
          - RoomClassNotAvailable
          - RoomTypeNotAvailable
          - BlockSellLimit
          - OnRequest
          maxItems: 10
          uniqueItems: true
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 50
          maximum: 100
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 0
      - name: orderBy
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ActionType
          - StartDate
          - EndDate
          - RateCode
          - RestrictionType
          - CreationDateTime
          - RoomType
      - name: sortOrder
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Asc
          - Desc
          uniqueItems: true
      - name: userId
        in: query
        description: Indicates restriction is created by User ID in conjunction with other Users, if specified.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
          maxItems: 10
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for searching restrictions history.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/restrictionsHistory'
        '204':
          description: RestrictionsHistory not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /hotels/{hotelId}/validateGuarantees:
    put:
      summary: 'Get Reservation Guarantee '
      description: This API allows to Fetch Reservation Guarantee. The criteria can include the rate plan code, arrival date, guarantee code and the profile information.  <p><strong>OperationId:</strong>validateReservationGuarantees</p>
      operationId: validateReservationGuarantees
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response object to fetch reservation guarantees.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reservationGuaranteesPolicies'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/validateReservationGuarantees'
        description: Request object to fetch reservation guarantees.
        required: true
    servers:
    - url: /par/v1
  /hurdles:
    get:
      summary: Get multiple property Hurdle Rates
      description: This API allows to fetch multiple properties existing Hurdle Rates. <p><strong>OperationId:</strong>getHurdleRates</p>
      operationId: getMultiPropHurdleRates
      parameters:
      - name: hotelIds
        in: query
        description: Hotel code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: hurdleDate
        in: query
        required: false
        description: Date criteria for which the hurdle rate is scheduled.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 25
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 0
      - name: roomTypesCode
        in: query
        description: Codes to be searched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: wildCard
        in: query
        required: false
        description: Wildcard search on the code.
        schema:
          type: string
      - name: hurdleRangeStart
        in: query
        description: Hurdle date start range from which the hurdle rate is scheduled.
        required: false
        schema:
          type: string
          format: date
      - name: hurdleRangeEnd
        in: query
        description: Hurdle date end range to which the hurdle rate is scheduled.
        required: false
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/x-hubid'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching Hurdle rates.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/hurdleRates'
        '204':
          description: HurdleRates not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /services/availability/status:
    get:
      summary: Get the Availability Service version
      description: This API allows to retrieve the Availability Service version. <p><strong>OperationId:</strong>pingAvailabilityService</p>
      operationId: pingAvailabilityService
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for Ping operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/operaVersion'
        '204':
          description: pingAvailabilityService not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /par/v1
  /upsert/hotels/{hotelId}/hurdles:
    put:
      summary: Create/Change Hurdle Rates
      description: This API allows to create/change an existing Hurdle Rate. <p><strong>OperationId:</strong>putUpsertHurdleRates</p>
      operationId: putUpsertHurdleRates
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/changeHurdleRatesDetails'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/changeHurdleRates'
        description: Request object for changing existing Hurdle Rates.
        required: true
    servers:
    - url: /par/v1
  /hotels/{hotelId}/rates/coupons/{couponCode}:
    get:
      summary: Validate a coupon code
      description: This API allows you to validate a coupon code. <p><strong>OperationId:</strong>validateRateCoupon</p>
      operationId: validateRateCoupon
      parameters:
      - name: couponCode
        in: path
        required: true
        description: Coupon Code.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for validating a coupon.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/promotionCouponValidationDetails'
        '204':
          description: validateRateCoupon not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /rtp/v1
  /hotels/{hotelId}/rates/promotions/{promotionCode}:
    get:
      summary: Validate a promotion code
      description: This API allows you to validate a promotion code. <p><strong>OperationId:</strong>validateRatePromotion</p>
      operationId: validateRatePromotion
      parameters:
      - name: promotionCode
        in: path
        required: true
        description: Promotion Code.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for validating a coupon.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/promotionCouponValidationDetails'
        '204':
          description: validateRatePromotion not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /rtp/v1
  /hotels/{hotelId}/rates/promotionsCoupons:
    get:
      summary: Validate promotion and coupon code
      description: This API allows you to validate a promotion and coupon code. <p><strong>OperationId:</strong>validateRatePromotionCoupon</p>
      operationId: validateRatePromotionCoupon
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID that identifies a single hotel property.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: couponCode
        in: query
        required: true
        description: Coupon code to validate.
        schema:
          type: string
      - name: promotionCode
        in: query
        required: true
        description: Promotion Code to which the coupon belongs.
        schema:
          type: string
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for validating a coupon.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/promotionCouponValidationDetails'
        '204':
          description: validateRatePromotionCoupon not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Availability
    servers:
    - url: /rtp/v1
components:
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '403':
      description: Forbidden
    '413':
      description: Request Entity Too Large
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '503':
      description: Service Unavailable
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    x-hotelid:
      name: x-hotelid
      description: Mandatory parameter to identify the hotel code where the end user is logged in
      in: header
      required: true
      schema:
        type: string
    x-app-key:
      name: x-app-key
      description: Client or Partner's Application Key
      in: header
      required: true
      schema:
        type: string
        pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    x-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    externalData:
      name: externalData
      description: Pass this header as true, if payload needs DVM
      in: header
      schema:
        type: string
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    Accept-Language:
      name: Accept-Language
      description: Language code
      in: header
      schema:
        type: string
    x-request-id:
      name: x-request-id
      description: Request Id of an incoming request
      in: header
      schema:
        type: string
        pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
    x-hubid:
      name: x-hubid
      description: x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid
      in: header
      schema:
        type: string
  schemas:
    translationsTextType:
      type: array
      description: Language code for the translation.
      maxItems: 4000
      items:
        type: object
        properties:
          value:
            type: string
            description: Used for Character Strings, length 0 to 2000.
            minLength: 0
            maxLength: 2000
          language:
            description: Language identification.
            type: string
            minLength: 0
            maxLength: 20
        description: Language code for the translation.
    availableRoomType:
      type: object
      description: Room Type and Room Rate combination.
      properties:
        description:
          type: string
          minLength: 0
          maxLength: 2000
        channelRoomType:
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          type: string
          minLength: 0
          maxLength: 20
        rateChangedYN:
          type: string
          minLength: 0
          maxLength: 20
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    channelInventoryType:
      type: object
      description: Inventory statistics and restrictions. This can have no code (House level), BookingChannelCode, or ChannelRoomType to represent the different levels.
      properties:
        snapshot:
          description: Inventory statistics and restriction details.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/channelSnapshotType'
        bookingChannelCode:
          description: Booking channel code that the snapshot belongs to.
          type: string
          minLength: 0
          maxLength: 20
        channelRoomType:
          description: Booking channel room type that the snapshot belongs to.
          type: string
          minLength: 0
          maxLength: 20
    generalAvailSimulatorType:
      type: object
      description: Room Type and Room Rate combination.
      properties:
        availableRatePlans:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/availableRatePlanType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        bookingChannelCode:
          type: string
          minLength: 0
          maxLength: 20
        marketingInfo:
          type: string
          minLength: 0
          maxLength: 2000
        supportsHTMLEditor:
          type: string
          minLength: 0
          maxLength: 10
        sellOrder:
          description: Sell by room, rate or rate room.
          $ref: '#/components/schemas/sellOrderType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    hotelMappingType:
      type: object
      properties:
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        code:
          type: string
          minLength: 0
          maxLength: 20
        name:
          type: string
          minLength: 0
          maxLength: 40
        description:
          type: string
          minLength: 0
          maxLength: 2000
    instanceLink:
      type: object
      description: Metadata describing link description objects that MAY appear in the JSON instance representation.
      properties:
        href:
          description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
          type: string
        rel:
          description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
          type: string
        templated:
          description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.
          type: boolean
          default: false
        method:
          description: HTTP method for requesting the target of the link.
          type: string
          enum:
          - GET
          - POST
          - PUT
          - DELETE
          - PATCH
          - OPTIONS
          - HEAD
        targetSchema:
          description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
          type: string
        operationId:
          description: The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.
          type: string
        title:
          description: Exact copy of the "summary" field on the linked operation.
          type: string
    enhancedDescriptionType:
      type: object
      description: This type holds enhanced room/rate description.
      properties:
        shortDescription:
          $ref: '#/components/schemas/translationTextType2000'
        description:
          $ref: '#/components/schemas/translationTextType2000'
        enhancedDesc1:
          $ref: '#/components/schemas/translationTextType50'
        enhancedDesc2:
          $ref: '#/components/schemas/translationTextType50'
        enhancedDesc3:
          $ref: '#/components/schemas/translationTextType50'
        source:
          type: string
    errorInstance:
      title: Error Instance Details
      description: Complex type that contains error instance details for a REST call.
      type: object
      properties:
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).
        title:
          type: string
          description: Short, human-readable summary of the problem.  The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
        detail:
          type: string
          description: Human-readable description specific to this occurrence of the problem.
        instance:
          type: string
          description: Absolute URI that identifies the specific occurrence of the problem.  It may or may not provide additional information if dereferenced.
        o:errorCode:
          type: string
          description: Application error code, which is different from HTTP error code.
        o:errorPath:
          type: string
          description: Path to the problem at the resource or property level.
      required:
      - type
      - title
    sellOrderType:
      type: string
      description: Channel Sell By which may be RATEROOM, RATE or ROOM.
      enum:
      - RateRoom
      - Rate
      - Room
    warningType:
      type: object
      description: Used when a message has been successfully processed to report any warnings or business errors that occurred.
      properties:
        value:
          type: string
          description: Property Value
        shortText:
          description: An abbreviated version of the error in textual format.
          type: string
          maxLength: 2000
        code:
          description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.
          type: string
          minLength: 0
          maxLength: 20
        docURL:
          description: If present, this URL refers to an online description of the error that occurred.
          type: string
          maxLength: 2000
        status:
          description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
          type: string
          maxLength: 2000
        tag:
          description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
          type: string
          maxLength: 2000
        recordId:
          description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.
          type: string
          maxLength: 2000
        type:
          description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".
          type: string
          minLength: 0
          maxLength: 20
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        rph:
          description: Reference Place Holder used as an index for this warning.
          type: string
          minLength: 1
          maxLength: 8
    currencyAmountType:
      type: object
      description: A monetary value expressed with a currency code.
      properties:
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    exceptionDetailType:
      title: Error Detail
      description: Complex type that contains error details for a REST call.
      type: object
      properties:
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).
        title:
          type: string
          description: Short, human-readable summary of the problem.  The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
        detail:
          type: string
          description: Human-readable description specific to this occurrence of the problem.
        instance:
          type: string
          description: Absolute URI that identifies the specific occurrence of the problem.  It may or may not provide additional information if dereferenced.
        o:errorCode:
          type: string
          description: Application error code, which is different from HTTP error code.
        o:errorPath:
          type: string
          description: Path to the problem at the resource or property level.
        o:errorDetails:
          description: Details of the error message, consisting of a hierarchical tree structure.
          type: array
          items:
            $ref: '#/components/schemas/errorInstance'
        links:
          $ref: '#/components/schemas/links'
      required:
      - type
      - title
    regionalRateParityType:
      type: object
      description: Information on Room Rate Parity among Channels/Property
      properties:
        regionalParityGroups:
          description: Channels and Property combination.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/regionalParityGroupType'
        hotelsInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/hotelChannelInfoType'
        bookingChannelsInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/bookingChannelInfoType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    additionalDetailType:
      type: object
      properties:
        description:
          type: string
        detailType:
          type: string
          enum:
          - CancelPolicy
          - CommissionPolicy
          - GuaranteePolicy
          - DepositPolicy
          - PenaltyPolicy
          - MarketingInformation
          - Promotion
          - TaxInformation
          - Other
        otherDetailType:
          type: string
          minLength: 0
          maxLength: 80
    channelInventorySnapshotType:
      type: object
      description: The evaluated channel inventory snapshot statistics based on the search criteria given.
      properties:
        inventories:
          description: The main statistics for the channel inventory snapshot.
          $ref: '#/components/schemas/channelInventorySnapshotInventoriesType'
        masterInfo:
          description: Additional information about the records returned in the snapshot.
          $ref: '#/components/schemas/channelInventorySnapshotMasterInfoType'
    rateParity:
      type: object
      description: Response object to fetch Rate Parity.
      properties:
        rateParity:
          description: Rate parity.
          $ref: '#/components/schemas/rateParityType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    additionalAmountListType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/additionalAmountType'
    availableRatePlanType:
      type: object
      description: Room Type and Room Rate combination.
      properties:
        marketingInfo:
          type: string
          minLength: 0
          maxLength: 2000
        availableRooms:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/availableRoomType'
        ratePlanCode:
          type: string
          minLength: 0
          maxLength: 20
        ratePlanDesc:
          type: string
          minLength: 0
          maxLength: 2000
        currency:
          type: string
          minLength: 0
          maxLength: 20
        taxInfo:
          type: string
          minLength: 0
          maxLength: 2000
    translationTextType2000:
      type: object
      description: Contains Multiple translated texts and language codes.
      properties:
        defaultText:
          description: Default text with Character length from 0 to 2000.
          type: string
          minLength: 0
          maxLength: 2000
        translatedTexts:
          description: List of translated text and language codes.
          $ref: '#/components/schemas/translationsTextType'
    bookingChannelMappingType:
      type: object
      properties:
        bookingChannelCode:
          type: string
          minLength: 0
          maxLength: 20
        code:
          type: string
          minLength: 0
          maxLength: 20
        name:
          type: string
          minLength: 0
          maxLength: 40
        description:
          type: string
          minLength: 0
          maxLength: 2000
    translationTextType50:
      type: object
      description: Contains Multiple translated texts and language codes.
      properties:
        defaultText:
          description: Default text with Character length from 0 to 50.
          type: string
          minLength: 0
          maxLength: 50
        translatedTexts:
          description: List of translated text and language codes.
          $ref: '#/components/schemas/translationsTextType'
    regionalRateParity:
      type: object
      description: Response object to fetch regional rate parity.
      properties:
        regionalRateParity:
          description: Information on Room rate parity among channels or hotels
          $ref: '#/components/schemas/regionalRateParityType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    channelInventorySnapshotInventoriesType:
      type: object
      description: Collection of inventory statistics and restrictions for a hotel in relation to booking channels.
      properties:
        inventory:
          description: Details of inventory statistics and restrictions.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/channelInventoryType'
        hotelId:
          description: Hotel that the inventory belongs to.
          type: string
          minLength: 0
          maxLength: 20
    hotelChannelInfoType:
      type: object
      properties:
        bookingChannelMappings:
          description: Booking Channels mapping for the Hotel Code.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/bookingChannelMappingType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        name:
          type: string
          minLength: 0
          maxLength: 40
    channelInventorySnapshot:
      type: object
      description: Response object containing the room availability and restrictions for a hotel in relation to booking channels.
      properties:
        channelInventorySnapshot:
          description: Channel inventory snapshot containing room availability and restrictions for a hotel in relation to booking channels.
          $ref: '#/components/schemas/channelInventorySnapshotType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    channelSnapshotType:
      type: object
      description: Inventory statistic and restriction information for a given date.
      properties:
        restrictionsInfo:
          description: Restrictions information for the day.
          $ref: '#/components/schemas/restrictionsInfoType'
        inventoryRooms:
          description: Number of rooms in inventory.
          type: number
        sellLimit:
          description: Number of overbooking rooms allowed.
          type: number
        tentativeRoomsSold:
          description: Number of tentative rooms sold - does not include definite reservations.
          type: number
        roomsSold:
          description: Number of rooms sold.
          type: number
        availableRooms:
          description: Number of available rooms.
          type: number
        date:
          description: Date of the statistics and restrictions.
          type: string
          format: date
          maxLength: 8
    rateParityType:
      type: object
      description: Information on Room Rate Parity among Channels/Property
      properties:
        parityGroups:
          description: Channels and Property combination.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/parityGroupType'
        hotelsInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/hotelChannelInfoType'
        bookingChannelsInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/bookingChannelInfoType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    generalAvailabilitySimulator:
      type: object
      description: Response object to simulate general availability.
      properties:
        generalAvailability:
          description: Room Type and room rate combination.
          $ref: '#/components/schemas/generalAvailSimulatorType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    restrictionInfoStatusType:
      type: object
      description: The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.
      properties:
        code:
          description: Identifies the type of restriction. I.E. Closed, ClosedForArrival, etc.
          $ref: '#/components/schemas/restrictionStatusesType'
        unit:
          description: Defines restriction in conjunction with Restriction Code. Value must be specified for Restriction Codes MinimumStayThrough, MaximumStayThrough, MinimumLengthOfStay, MaximumLengthOfStay, MinimumAdvanceBooking, MaximumAdvanceBooking.
          type: integer
        lOS1:
          description: Indicates Length of Stay 1 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS2:
          description: Indicates Length of Stay 2 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS3:
          description: Indicates Length of Stay 3 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS4:
          description: Indicates Length of Stay 4 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS5:
          description: Indicates Length of Stay 5 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS6:
          description: Indicates Length of Stay 6 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS7:
          description: Indicates Length of Stay 7 or more is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        roomClass:
          description: Room Class of actual restriction.
          type: string
          minLength: 0
          maxLength: 20
        rateCategory:
          description: Rate Category of actual restriction.
          type: string
          minLength: 0
          maxLength: 20
        rateCode:
          description: Rate Code of actual restriction.
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Room Type of actual restriction.
          type: string
          minLength: 0
          maxLength: 20
        bookingChannelCode:
          description: Booking channel code of actual restriction.
          type: string
          minLength: 0
          maxLength: 20
    regionalParityGroupType:
      type: object
      description: Channels and Property Group wise Rates for Room Type and Rate Plan combination.
      properties:
        regionalParityRates:
          description: Minimum and Maximum Rate on specific arrival date.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/regionalParityRateType'
        hotelId:
          description: The code that identifies a Hotel.
          type: string
          minLength: 0
          maxLength: 20
        bookingChannelCode:
          description: The code that identifies a Booking Channel.
          type: string
          minLength: 0
          maxLength: 20
        bookingChannelURL:
          type: string
          minLength: 0
          maxLength: 2000
        bookingChannelIconURL:
          type: string
          minLength: 0
          maxLength: 2000
    additionalAmountType:
      type: object
      properties:
        amountType:
          type: string
          enum:
          - AdditionalAdult
          - AdditionalChild
          - AdditionalRollawayBed
          - AdditionalCrib
          - AdditionalRollawayCrib
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    regionalParityRateType:
      type: object
      description: Rate on specific arrival date.
      properties:
        minimumRate:
          type: number
        maximumRate:
          type: number
        arrivalDate:
          description: Arrival Date.
          type: string
          format: date
          maxLength: 8
        weekendDay:
          type: boolean
        currencyCode:
          type: string
          minLength: 3
          maxLength: 3
        statusCode:
          description: Status Code related to functionality.
          type: string
          minLength: 0
          maxLength: 80
        statusDescription:
          description: Description of Status Code.
          type: string
          minLength: 0
          maxLength: 2000
    parityRateType:
      type: object
      description: Minimum and Maximum Rate on specific arrival date.
      properties:
        additionalDetailList:
          $ref: '#/components/schemas/additionalDetailListType'
        roomTypeDescription:
          $ref: '#/components/schemas/enhancedDescriptionType'
        rateDescription:
          $ref: '#/components/schemas/enhancedDescriptionType'
        ratePlanDescription:
          type: string
        channelRatePlanCategory:
          type: string
          minLength: 0
          maxLength: 20
        rateFrequency:
          type: string
        availableRooms:
          type: integer
        additionalAmounts:
          $ref: '#/components/schemas/additionalAmountListType'
        rateAmounts:
          type: object
          properties:
            totalAmount:
              $ref: '#/components/schemas/currencyAmountType'
            taxAmount:
              $ref: '#/components/schemas/currencyAmountType'
            cancellationAmount:
              $ref: '#/components/schemas/currencyAmountType'
            commissionAmount:
              $ref: '#/components/schemas/currencyAmountType'
            depositAmount:
              $ref: '#/components/schemas/currencyAmountType'
        totalPricingAmounts:
          type: object
          properties:
            totalSurcharge:
              $ref: '#/components/schemas/currencyAmountType'
            totalTax:
              $ref: '#/components/schemas/currencyAmountType'
            totalRateIncl:
              $ref: '#/components/schemas/currencyAmountType'
        arrivalDate:
          description: Arrival Date.
          type: string
          format: date
          maxLength: 8
        weekendDay:
          type: boolean
        closed:
          type: boolean
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
        statusCode:
          description: Status Code related to functionality.
          type: string
          minLength: 0
          maxLength: 80
        statusDescription:
          description: Description of Status Code.
          type: string
          minLength: 0
          maxLength: 2000
        rateChangesOverDays:
          type: boolean
    restrictionStatusesType:
      type: string
      enum:
      - Closed
      - ClosedForArrival
      - ClosedForDeparture
      - MinimumStayThrough
      - MaximumStayThrough
      - MinimumLengthOfStay
      - MaximumLengthOfStay
      - LOSNotAvailable
      - MinimumAdvanceBooking
      - MaximumAdvanceBooking
      - Open
      - OpenForArrival
      - OpenForDeparture
    restrictionsInfoType:
      type: array
      description: Provides the basic Restriction type details, specifically used in snapshot operations for efficiency.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/restrictionInfoType'
    parametersType:
      type: array
      description: Collection of generic Name-Value-Pair parameters.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/parameterType'
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    parityRoomRateType:
      type: object
      description: Rate for Room Type and Rate Plan combination.
      properties:
        parityRates:
          description: Rate on specific arrival date.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/parityRateType'
        roomType:
          description: The code that identifies a Room Type.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: The code that identifies a Rate Plan Code.
          type: string
          minLength: 0
          maxLength: 20
        channelRoomType:
          description: The code that identifies a Booking Channel Room Type.
          type: string
          minLength: 0
          maxLength: 20
        channelRatePlanCode:
          description: The code that identifies a Booking Channel Rate Plan Code.
          type: string
          minLength: 0
          maxLength: 20
    parityGroupType:
      type: object
      description: Channels and Property Group wise Rates for Room Type and Rate Plan combination.
      properties:
        parityRoomRates:
          description: Room Type and Rate Plan combination.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/parityRoomRateType'
        hotelId:
          description: The code that identifies a Hotel.
          type: string
          minLength: 0
          maxLength: 20
        bookingChannelCode:
          description: The code that identifies a Booking Channel.
          type: string
          minLength: 0
          maxLength: 20
        bookingChannelURL:
          type: string
          minLength: 0
          maxLength: 2000
        bookingChannelIconURL:
          type: string
          minLength: 0
          maxLength: 2000
    parameterType:
      type: object
      description: Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.
      properties:
        parameterName:
          description: Name of the parameter.
          type: string
        parameterValue:
          description: Value of the parameter.
          type: string
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    additionalDetailListType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/additionalDetailType'
    restrictionInfoType:
      type: object
      properties:
        restrictionStatus:
          description: Indicates the type of the restriction.
          $ref: '#/components/schemas/restrictionInfoStatusType'
    bookingChannelInfoType:
      type: object
      properties:
        hotelMappings:
          description: Hotel Code mapping for the Booking Channel.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/hotelMappingType'
        configurationParameters:
          $ref: '#/components/schemas/parametersType'
        bookingChannelCode:
          type: string
          minLength: 0
          maxLength: 20
        name:
          type: string
          minLength: 0
          maxLength: 40
        bookingChannelType:
          type: string
          minLength: 0
          maxLength: 240
    channelInventorySnapshotMasterInfoType:
      type: object
      description: Details about the booking channels and room types contained in the channel inventory snapshot.
      properties:
        bookingChannel:
          description: Collection of booking channels returned in the channel inventory snapshot and the details about those channels.
          type: array
          maxItems: 4000
          items:
            type: object
            properties:
              channelRoomTypes:
                description: Details about a specific channel room type.
                type: array
                maxItems: 4000
                items:
                  type: object
                  properties:
                    channelRoomTypeCode:
                      description: The channel room type's identifying code.
                      type: string
                      minLength: 0
                      maxLength: 20
                    roomTypeCode:
                      description: The internal room type label which is mapped to the channel room type.
                      type: string
                      minLength: 0
                      maxLength: 20
                    description:
                      description: If the ENHANCED_ROOM_RATE_DESCRIPTION function is off, this element will contain the simple channel room type description.
                      type: string
                      minLength: 0
                      maxLength: 200
                    roomDescriptionLine1:
                      description: If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the first line of the enhanced channel room type description.
                      type: string
                      minLength: 0
                      maxLength: 200
                    roomDescriptionLine2:
                      description: If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the second line of the enhanced channel room type description.
                      type: string
                      minLength: 0
                      maxLength: 200
                    roomDescriptionLine3:
                      description: If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the third line of the enhanced channel room type description.
                      type: string
                      minLength: 0
                      maxLength: 200
                    sellSequence:
                      description: The order in which the channel room type is to be displayed.
                      type: integer
              code:
                description: The booking channel's identifying code.
                type: string
                minLength: 0
                maxLength: 20
              description:
                description: The name or description of the booking channel.
                type: string
                minLength: 0
                maxLength: 40
              bookingChannelType:
                description: The type of channel. I.E. GDS, ADS, ODS, WEB.
                type: string
                minLength: 0
                maxLength: 20
              channelInventoryActive:
                description: Flag to indicate if the channel and hotel combination have the Channel Inventory parameter active. This parameter allows sell limits to be set for the channel or channel room type.
                type: boolean
        hotelId:
          description: The internal hotel code that the given booking channel info is mapped under.
          type: string
          minLength: 0
          maxLength: 20
    reservationQueueInformationType:
      type: object
      description: Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
      properties:
        timeSpan:
          description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.
          type: object
          properties:
            startDate:
              type: string
              format: date
              maxLength: 8
            endDate:
              type: string
              format: date
              maxLength: 8
            duration:
              type: string
            durationInSeconds:
              description: The total duration, in seconds, the reservation is on Queue.
              type: integer
        guestTextInfo:
          description: Information for the message sent to the user
          $ref: '#/components/schemas/queueTextInfoType'
        priority:
          description: The Queue Priority given to this reservation.
          type: integer
        averageQueueTimeToCheckIn:
          description: The average time, in seconds, a reservation was on queue prior to Check-In.
          type: integer
        averageQueueTimeCurrentReservations:
          description: The average time, in seconds, of the reservations currently in queue.
          type: integer
        queueDate:
          description: The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.
          type: string
          format: date
          maxLength: 8
    cardReIssueType:
      type: string
      description: Request to re issue a new card.
      enum:
      - Pending
      - NotApplicable
      - Requested
    resAccompanyGuestInfoType:
      type: object
      properties:
        firstName:
          description: Given name, first name or names
          type: string
        lastName:
          description: Family name, last name.
          type: string
        fullName:
          description: String representation of the full name
          type: string
        registrationCardNo:
          description: Unique identifier of the police registration card number.
          type: string
          minLength: 0
          maxLength: 40
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.
          $ref: '#/components/schemas/profileIdList'
    stayInfoType:
      type: object
      description: Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.
      properties:
        arrivalDate:
          type: string
          format: date
        departureDate:
          type: string
          format: date
        originalTimeSpan:
          description: The Original Time Span covers the Room Stay dates of the original reservation.
          $ref: '#/components/schemas/timeSpanType'
        expectedTimes:
          description: The expected arrival, return and departure times of the guest.
          $ref: '#/components/schemas/resExpectedTimesType'
        adultCount:
          description: A collection of Guest Counts associated with Room Stay.
          type: integer
        childCount:
          description: A collection of Child Counts associated with Room Stay.
          type: integer
        roomClass:
          description: Room class code
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Room type code
          type: string
          minLength: 0
          maxLength: 20
        componentRoomType:
          description: True indicates room type is a component type.
          type: boolean
        numberOfRooms:
          description: Room Id
          type: integer
        roomId:
          description: Room Id
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: Rate plan code
          type: string
          minLength: 0
          maxLength: 20
        rateAmount:
          description: Rate amount
          $ref: '#/components/schemas/currencyAmountType'
        points:
          description: The Points contains the number of points used to book a particular room type.
          $ref: '#/components/schemas/pointsType'
        rateSuppressed:
          description: Whether this rate should be suppressed from view
          type: boolean
        reservationBlock:
          description: Key information about the block for this reservation.
          $ref: '#/components/schemas/reservationBlockType'
        bookingChannelCode:
          description: Booking channel code
          type: string
          minLength: 0
          maxLength: 20
        linkCode:
          description: Party code
          type: string
          maxLength: 2000
        fixedRate:
          description: True if the rate is a fixed rate, otherwise false
          type: boolean
        totalAmount:
          description: The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.
          $ref: '#/components/schemas/currencyAmountType'
        guarantee:
          description: The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.
          $ref: '#/components/schemas/resGuaranteeType'
        promotion:
          description: Promotion Codes
          $ref: '#/components/schemas/promotionType'
        marketCode:
          description: Market code
          type: string
          minLength: 0
          maxLength: 20
        marketDescription:
          description: Description of Market code
          type: string
          minLength: 0
          maxLength: 4000
        sourceCode:
          description: Source of business
          type: string
          minLength: 0
          maxLength: 20
        sourceCodeDescription:
          description: Description of the source of business.
          type: string
          minLength: 0
          maxLength: 4000
        balance:
          description: Balance amount
          $ref: '#/components/schemas/currencyAmountType'
        compBalance:
          description: Comp Balance amount
          $ref: '#/components/schemas/currencyAmountType'
        roomTypeCharged:
          description: Room type code that was charged
          type: string
          minLength: 0
          maxLength: 20
        depositPayments:
          description: A collection of deposit and/or payments for the Room Stay.
          $ref: '#/components/schemas/currencyAmountType'
        guestServiceStatus:
          description: Service Status of In House guest like DND or MUP
          $ref: '#/components/schemas/guestHousekeepingServiceRequestType'
        scheduledCheckoutTime:
          description: Indicates that this reservation is scheduled for automated check out.
          type: string
          format: date
        roomNumberLocked:
          description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.
          type: boolean
        pseudoRoom:
          description: True indicates as pseudo room type. This is usually used for a posting master reservation.
          type: boolean
        assignedByAI:
          description: Represents the room was assigned by AI Room Assignment.
          type: boolean
        upgradedByAI:
          description: Represents the room was assigned by AI Room Assignment.
          type: boolean
    configPackageUsageDetailType:
      type: object
      description: A Config Package Usage Detail type.
      properties:
        source:
          description: Indicates if the source of the product is Rate header, Rate Detail or Reservation.
          $ref: '#/components/schemas/productSourceType'
        usedInReservations:
          description: Indicates if the package is used in, reserved or prospect reservations.
          type: boolean
        usedInRates:
          description: Indicates if the package is used in any rate code.
          type: boolean
        usedInHouseReservations:
          description: Indicates if any checked in reservations are using this product.
          type: boolean
    policyBasisTypeType:
      type: string
      description: Full Amount.
      enum:
      - FlatAmount
      - Percentage
      - Nights
      - NightPercentage
      - FullAmount
    salesInfoType:
      type: object
      description: Provides sales information about the profiles of type company, travel agent, source and contact.
      properties:
        scope:
          description: Defines the scope.
          type: string
          minLength: 0
          maxLength: 2000
        scopeCity:
          description: Defines the scope city.
          type: string
          minLength: 0
          maxLength: 2000
        accountType:
          description: Defines the account type.
          type: string
          minLength: 0
          maxLength: 20
        accountSource:
          description: Defines the account source.
          type: string
          minLength: 0
          maxLength: 2000
        industryCode:
          description: Defines the industry code.
          type: string
          minLength: 0
          maxLength: 2000
        businessSegments:
          description: Defines the Business segments.
          type: string
          minLength: 0
          maxLength: 2000
        priority:
          description: Defines the priority.
          type: string
          minLength: 0
          maxLength: 4000
        roomsPotential:
          description: Defines the rooms potential.
          type: string
          minLength: 0
          maxLength: 4000
        actionCode:
          description: Defines the action code.
          type: string
          minLength: 0
          maxLength: 4000
        competitionCode:
          description: Defines the competition code.
          type: string
          minLength: 0
          maxLength: 4000
        influence:
          description: Defines the influence for the contact profile.
          type: string
          minLength: 0
          maxLength: 2000
        preferredRoom:
          description: Defines the Preferred Room for profile.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel Code used to filter the sales information.
          type: string
          minLength: 0
          maxLength: 20
    pointsType:
      type: object
      description: The Redeem Points contains the number of points required to book a room type.
      properties:
        awardsType:
          description: Awards type for the award type rate code.
          type: string
        points:
          description: No of points required to book this Room Stay.
          type: integer
    profileSubscriptionListType:
      type: array
      description: Details of the OPERA Profile subscription to external system
      maxItems: 4000
      items:
        $ref: '#/components/schemas/profileSubscriptionType'
    pkgInventoryItemType:
      type: object
      properties:
        articleNumber:
          description: Article Number of the inventory item.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the inventory item.
          type: string
          minLength: 0
          maxLength: 200
        quantity:
          description: Quantity of the inventory item allocated to the package.
          type: integer
        itemId:
          description: Identifier for the inventory item.
          type: integer
    negotiatedType:
      type: object
      description: This holds a list of NegotiatedInfoType.
      properties:
        negotiatedInfoList:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/negotiatedInfoType'
        hotelId:
          description: Hotel code for the negotiated rate.
          type: string
          minLength: 0
          maxLength: 20
        rateCode:
          description: Rate plan code for the negotiated rate.
          type: string
          minLength: 0
          maxLength: 20
    characterUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Character/String Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/characterUDFType'
    timeSpanType:
      type: object
      description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.
      properties:
        startDate:
          type: string
          format: date
          maxLength: 8
        endDate:
          type: string
          format: date
          maxLength: 8
        duration:
          type: string
    indicatorType:
      type: object
      description: Lamp indicator Type.
      properties:
        indicatorName:
          description: Name of the indicator.
          type: string
          minLength: 0
          maxLength: 80
        count:
          description: Indicates number of occurrences of the indicator.
          type: integer
    imageStyleType:
      type: string
      description: An enumeration of image styles.
      enum:
      - Full
      - Thumbnail
      - Icon
      - Square
      - Banner
      - Button
      - Lowres
      - Highres
    addressInfoType:
      type: object
      description: Provides address information.
      properties:
        address:
          description: Address details for the profile.
          $ref: '#/components/schemas/addressType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    restrictionsByDateRangeType:
      type: object
      description: Restriction by date range for the requested Hotel.
      properties:
        restrictionSets:
          description: Restriction set for a date range.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/restrictionSetType'
        chainCode:
          description: The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
          type: string
          minLength: 0
          maxLength: 20
        hotelCityCode:
          description: The IATA city code; for example DCA, ORD.
          type: string
          minLength: 0
          maxLength: 40
        hotelName:
          description: A text field used to communicate the proper name of the hotel.
          type: string
          minLength: 0
          maxLength: 80
        hotelCodeContext:
          description: A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.
          type: string
          minLength: 0
          maxLength: 40
        chainName:
          description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).
          type: string
          minLength: 0
          maxLength: 80
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    restrictionSetType:
      type: object
      description: Indicates Restriction set applicable for the date range.
      properties:
        restrictionControl:
          description: Indicates the applicability of the restriction.
          $ref: '#/components/schemas/restrictionControlType'
        restrictionStatus:
          description: Indicates the type of the restriction.
          $ref: '#/components/schemas/restrictionStatusType'
        actualTimeSpan:
          description: Actual time span of the restriction.
          $ref: '#/components/schemas/timeSpanType'
        onRequest:
          description: Indicates whether the Closed restriction is flagged as On Request.
          type: boolean
        actionType:
          description: Indicates the action performed on restriction
          type: string
          minLength: 0
          maxLength: 2000
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
        sunday:
          type: boolean
        monday:
          type: boolean
        tuesday:
          type: boolean
        wednesday:
          type: boolean
        thursday:
          type: boolean
        friday:
          type: boolean
        saturday:
          type: boolean
    cardNumberTypeType:
      type: string
      description: Simple type for indicating if credit card number is tokenized.
      enum:
      - CardNumber
      - Token
    roomTypeYieldableType:
      type: string
      description: Simple type for Yieldable or Non Yieldable
      enum:
      - Yieldable
      - NonYieldable
    eCertificateInfoType:
      type: object
      description: E-Certificates details.
      properties:
        certificateType:
          description: User defined certificate code.
          type: string
          minLength: 0
          maxLength: 20
        membershipType:
          description: Membership type to which the certificate is linked to.
          type: string
          minLength: 0
          maxLength: 20
        awardCode:
          description: Award type to which the certificate is linked to.
          type: string
          minLength: 0
          maxLength: 20
        promotionCode:
          description: Promotion code to which certificate is attached to.
          type: string
          minLength: 0
          maxLength: 20
        voucherBenefitCode:
          description: Voucher benefit code attached to the certificate.
          type: string
          minLength: 0
          maxLength: 40
        hotels:
          description: Hotel to which certificate is attached to.
          type: object
          properties:
            code:
              type: array
              maxItems: 4000
              items:
                type: string
                minLength: 0
                maxLength: 20
            scope:
              description: 'Scope of e-cert: global,single property or multi property.'
              $ref: '#/components/schemas/eCertificateScopeType'
        description:
          description: Description about the certificate.
          type: string
          minLength: 0
          maxLength: 200
        longDescription:
          description: Detail description about the certificate.
          type: string
          minLength: 0
          maxLength: 4000
        label:
          description: Label for the certificate.
          type: string
          minLength: 0
          maxLength: 40
        maxExtensionAllowed:
          description: Number of times e-certificate can be extended.
          type: integer
        usageCriteria:
          $ref: '#/components/schemas/eCertificateUsageCriteriaType'
        value:
          description: Value of the certificate for the guest.
          $ref: '#/components/schemas/currencyAmountType'
        cost:
          description: Cost of certificate.
          $ref: '#/components/schemas/currencyAmountType'
        benefitSummary:
          description: Summary of Benefits attached to this ECertificate.
          type: string
          minLength: 0
          maxLength: 4000
    customerType:
      type: object
      description: Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
      properties:
        personName:
          description: Detailed name information for the customer.
          type: array
          maxItems: 5
          items:
            $ref: '#/components/schemas/personNameType'
        anonymization:
          description: Provides information about the guest's anonymization status
          $ref: '#/components/schemas/anonymizationType'
        citizenCountry:
          description: Name of the (self-professed) country that is claimed for citizenship.
          $ref: '#/components/schemas/countryNameType'
        identifications:
          description: List of identification of the customer.
          type: object
          properties:
            identificationInfo:
              description: Collection of detailed information on the identification of the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/identificationInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        profession:
          description: Profession of a person.
          type: string
          minLength: 0
          maxLength: 80
        alienInfo:
          description: Immigration/visa information of a foreign person.
          $ref: '#/components/schemas/alienInfoType'
        birthCountry:
          description: Country of birth.
          $ref: '#/components/schemas/countryNameType'
        legalCompany:
          description: Name Of the company the individual is associated with.
          type: string
          minLength: 0
          maxLength: 80
        companyInfo:
          description: Company Information of the Profile.
          $ref: '#/components/schemas/companyInfoType'
        businessTitle:
          description: Business Title.
          type: string
          minLength: 0
          maxLength: 80
        gender:
          description: Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.
          type: string
          minLength: 0
          maxLength: 20
        birthDate:
          description: Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.
          type: string
          format: date
          maxLength: 8
        birthDateMasked:
          description: Indicates the date of birth as masked.
          type: string
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        nationality:
          description: Nationality code identification
          type: string
          minLength: 0
          maxLength: 20
        nationalityDescription:
          description: Nationality code description
          type: string
          minLength: 0
          maxLength: 80
        customerValue:
          description: The supplier's ranking of the customer (e.g., VIP, numerical ranking).
          type: string
          minLength: 0
          maxLength: 20
        creditRating:
          description: Credit Rating of the customer.
          type: string
          minLength: 0
          maxLength: 20
        vipStatus:
          description: VIP status of the customer.
          type: string
          minLength: 0
          maxLength: 20
        vipDescription:
          description: Description of the VIP status.
          type: string
          minLength: 0
          maxLength: 2000
        birthPlace:
          description: Place of birth.
          type: string
          minLength: 0
          maxLength: 80
        privateProfile:
          description: This element tells profile is property exclusive or not.
          type: boolean
        blacklist:
          description: This element tells if profile is blacklisted or not.
          type: boolean
    housekeepingRoomStatusType:
      type: string
      description: Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
      enum:
      - Clean
      - Dirty
      - Pickup
      - Inspected
      - OutOfOrder
      - OutOfService
    hotelAvailability:
      type: object
      description: Response object to search hotel availability based on request segment.
      properties:
        hotelAvailability:
          type: array
          items:
            $ref: '#/components/schemas/availResponseSegmentType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileSubscriptionType:
      type: object
      description: Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular external system
      properties:
        profileId:
          description: OPERA Profile ID that this subscription record corresponds to.
          $ref: '#/components/schemas/profileId'
        externalProfileId:
          description: Profile ID within the external system.
          $ref: '#/components/schemas/uniqueID_Type'
        profileInfo:
          description: This provides name information for a person.
          type: object
          properties:
            name:
              description: Family name, last name or Company Name.
              type: string
              minLength: 0
              maxLength: 40
            fullName:
              description: Full display Name.
              type: string
              minLength: 0
              maxLength: 200
            namePrefix:
              description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)
              type: string
              minLength: 0
              maxLength: 40
            givenName:
              description: Given name, first name or names.
              type: string
              minLength: 0
              maxLength: 40
            middleName:
              description: The middle name of the person name.
              type: string
              minLength: 0
              maxLength: 40
            nameSuffix:
              description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)
              type: string
              minLength: 0
              maxLength: 40
            nameTitle:
              description: Degree or honors (e.g., Ph.D., M.D.)
              type: string
              minLength: 0
              maxLength: 80
            nameType:
              description: Type of name of the individual, such as former, nickname, alternate or alias name.
              $ref: '#/components/schemas/personNameTypeType'
            profileType:
              description: OPERA profile type such as Individual or Company
              $ref: '#/components/schemas/profileTypeType'
        distributed:
          description: Indicates if the profile was distributed to the external system.
          type: boolean
        force:
          description: Indicates if the profile information should be overwritten by the external system.
          type: boolean
        subscriptionDate:
          description: Timestamp when the profile was subscribed to. Uses database time zone.
          type: string
          format: date-time
        lastDistributionDate:
          description: Timestamp of the most recent distribution of this profile to the external system. Uses database time zone.
          type: string
          format: date-time
        lastExternalUpdateDate:
          description: Timestamp of the most recent update of the subscription information by the external system. Uses database time zone.
          type: string
          format: date-time
        inactive:
          description: Indicates whether this subscription is active or inactive.
          type: boolean
    rateChangeTypeType:
      type: string
      description: Indicates the rate amount returned is first night or highest rate.
      enum:
      - FirstNight
      - Highest
      - Lowest
      - MostCommon
      - Average
    hotelNotesType:
      type: array
      description: List of Notes of the hotel.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/commentInfoType'
    profileDeliveryModuleType:
      type: string
      description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..'
      enum:
      - EfolioExport
    discountType:
      type: object
      description: Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.
      properties:
        discountReason:
          type: string
          minLength: 0
          maxLength: 2000
        percent:
          description: Percentage discount.
          type: number
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
        discountCode:
          description: Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).
          type: string
          minLength: 0
          maxLength: 20
    hotelInterfaceType:
      type: object
      properties:
        interfaceId:
          description: Unique DB internal number of a Hotel Interface record.
          $ref: '#/components/schemas/uniqueID_Type'
        hotelId:
          description: Hotel Code
          type: string
          minLength: 0
          maxLength: 20
        interfaceName:
          description: Name of the Hotel Interface
          type: string
          minLength: 0
          maxLength: 40
        interfaceType:
          description: Three letter code for each interface that identifies the interface.
          $ref: '#/components/schemas/hotelInterfaceTypeType'
        logo:
          description: Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.
          type: string
          minLength: 0
          maxLength: 20
        machineName:
          description: Unique machine name of the running IFC.
          type: string
          minLength: 0
          maxLength: 80
        status:
          description: The current status of the IFC.
          $ref: '#/components/schemas/hotelInterfaceStatusType'
        activeFlag:
          description: Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.
          type: boolean
    cardProcessingType:
      type: string
      enum:
      - Eft
      - Manual
    reservationHistoryFutureInfoType:
      type: object
      description: Information of History and Future Reservation details attached to Profiles.
      properties:
        historyList:
          description: Refer to History list type document.
          $ref: '#/components/schemas/historyListType'
        futureList:
          description: Refer to Future list type document.
          $ref: '#/components/schemas/futureListType'
    alternateHotelType:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/addressType'
        contactNumbers:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/telephoneType'
        minRate:
          $ref: '#/components/schemas/currencyAmountType'
        maxRate:
          $ref: '#/components/schemas/currencyAmountType'
        relativePosition:
          $ref: '#/components/schemas/relativePositionType'
        hotelAmenities:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/hotelAmenityType'
        event:
          description: True if the hotel has any scheduled events within the requested date range.
          type: boolean
        rateRoomDetails:
          description: Any additional information like membership, restriction status, room stay information of the requested hotels etc.
          $ref: '#/components/schemas/rateRoomDetailsType'
        channelSummaryInfo:
          description: Channel related information if availability request is send for a channel.
          $ref: '#/components/schemas/channelSummaryInfoType'
        sellMessages:
          description: Sell messages retrieved based on the Time Span criteria for all Rate Codes and Room Types of the requested hotel.
          $ref: '#/components/schemas/sellMessagesType'
        currencyExchangeRates:
          description: Exchange Rate information for currency codes of the requested hotel.
          $ref: '#/components/schemas/currencyExchangeRatesType'
        chainCode:
          description: The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
          type: string
          minLength: 0
          maxLength: 20
        hotelCityCode:
          description: The IATA city code; for example DCA, ORD.
          type: string
          minLength: 0
          maxLength: 40
        hotelName:
          description: A text field used to communicate the proper name of the hotel.
          type: string
          minLength: 0
          maxLength: 80
        hotelCodeContext:
          description: A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.
          type: string
          minLength: 0
          maxLength: 40
        chainName:
          description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).
          type: string
          minLength: 0
          maxLength: 80
        hotelType:
          type: string
          minLength: 0
          maxLength: 20
        negotiated:
          type: boolean
        alternate:
          type: boolean
        displayOrder:
          type: number
        inventoryRooms:
          type: integer
        availableRooms:
          type: integer
        comments:
          description: Comments of alternate Hotel.
          type: string
          minLength: 0
          maxLength: 2000
        direction:
          description: Compass direction to the attraction from the hotel (North/South, etc).
          type: string
          minLength: 0
          maxLength: 20
        reciprocalRelationship:
          description: whether the alternate relationship should be applied to the alternate hotel as well. If this flag is true, not only will the AlternateHotelCode hotel be an alternate for HotelCode hotel, but HotelCode hotel will also be an alternate for AlternateHotelCode hotel.
          type: boolean
        alternateHotelCode:
          type: string
          minLength: 0
          maxLength: 20
        newAlternateHotelCode:
          type: string
          minLength: 0
          maxLength: 20
    hotelContactRolesType:
      type: array
      description: Lists of HotelContactRoles of the hotel.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelContactRoleType'
    clearAllRestrictions:
      type: object
      description: Request object for clearing all restrictions based on date.
      properties:
        hotelId:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/stringLength20'
        date:
          description: Use date for which the restrictions is to be cleared.
          type: string
          format: date
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    restaurantCategoryType:
      type: string
      description: Simple type for Hotel Restaurant.
      enum:
      - Restaurant
      - Retail
    packageConsumptionType:
      type: object
      description: Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
      properties:
        defaultQuantity:
          description: The default quantity attached in the package.
          type: integer
        excludedQuantity:
          description: The quantity which has been excluded in the package.
          type: integer
        totalQuantity:
          description: The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType.
          type: integer
        allowanceConsumed:
          description: Indicates if Allowance(for POS packages) has been consumed/posted for today.
          type: boolean
    blockId:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    housekeepingTaskCodeType:
      type: object
      description: Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
      properties:
        description:
          description: Description of the Task Code.
          type: string
          minLength: 0
          maxLength: 80
        instructions:
          description: Instructions for this Task Code.
          type: string
          minLength: 0
          maxLength: 2000
        facilityDepartureTask:
          description: Indicates if this task code is the default departure task for Facility Tasks. This requires
          type: boolean
        linenChange:
          description: Indicates if a linen change is necessary.
          type: boolean
        hotelId:
          description: Property where this task code is configured.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: The Code for the task.
          type: string
          minLength: 0
          maxLength: 20
        sequence:
          description: Ordering sequence for display.
          type: integer
    resAccompanyGuestListType:
      type: array
      description: Collection of accompany guests
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resAccompanyGuestInfoType'
    resSharedGuestListType:
      type: array
      description: Collection of shared guest reservations.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resSharedGuestInfoType'
    shareDistributionInstructionType:
      type: string
      description: The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -> Full Rate for each Sharer. SPLIT-> Split the Rate amount between Sharer Reservations. ENTIRE -> This Sharer will get the total amount of the rate code for all the Sharer Reservations.
      enum:
      - Full
      - Entire
      - Split
      - CustomSplit
    benefitsType:
      type: array
      description: Basic information about membership benefit.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/benefitType'
    facilityTaskType:
      type: object
      description: Information regarding facility task on a reservation.
      properties:
        task:
          description: The Task Code.
          $ref: '#/components/schemas/housekeepingTaskCodeType'
        supplies:
          description: Supplies associated with the task.
          $ref: '#/components/schemas/facilityCodesType'
        date:
          description: The Date on which the task is applicable.
          type: string
          format: date
          maxLength: 8
    downgradeType:
      type: string
      description: Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
      enum:
      - Grace
      - Never
      - Period
    codeDescriptionType:
      type: object
      description: This contains a generic code and description information.
      properties:
        code:
          description: Code.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: description.
          type: string
          minLength: 0
          maxLength: 2000
    productSourceType:
      type: string
      description: Sources of Products
      enum:
      - Reservation
      - RateHeader
      - RateDetail
    resAwardsType:
      type: object
      description: Membership Awards code applied on the reservation.
      properties:
        membershipNo:
          description: Membership program under which the award is applied.
          $ref: '#/components/schemas/uniqueID_Type'
        awardVouchers:
          $ref: '#/components/schemas/awardVouchersType'
        originalRoomType:
          description: Room Type before the Upgrade Award.
          type: string
          minLength: 0
          maxLength: 20
        upgradeRoomType:
          description: Room Type after the Upgrade Award.
          type: string
          minLength: 0
          maxLength: 20
    hotelEventSpaceSummariesType:
      type: array
      description: List of summary info of hotel event space
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelEventSpaceSummaryType'
    postingRhythmType:
      type: string
      description: Simple type for posting Rhythm types.
      enum:
      - EveryNight
      - ArrivalNight
      - EveryXNightsStartingNightY
      - CertainNightsOfTheWeek
      - LastNight
      - EveryNightExceptArrivalNight
      - EveryNightExceptLast
      - EveryNightExceptFirstAndLast
      - CustomStaySchedule
      - CustomNightSchedule
      - FloatingAllowancePerStay
      - TicketPosting
    surnameType:
      type: string
      description: Family name, last name.
      minLength: 0
      maxLength: 40
    ownerType:
      type: object
      description: Generic type for information about an owner.
      properties:
        hotel:
          description: Hotel to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        userId:
          description: Unique application user ID.
          $ref: '#/components/schemas/uniqueID_Type'
        userName:
          description: Unique application user name of the owner.
          type: string
          minLength: 0
          maxLength: 40
        ownerCode:
          description: Unique Code to identify the owner.
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: Unique owner profile information.
          $ref: '#/components/schemas/profileId'
        name:
          description: Provides name information of the owner.
          $ref: '#/components/schemas/personNameType'
        department:
          description: Department to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        email:
          description: Email information of the owner.
          $ref: '#/components/schemas/emailInfoType'
        phone:
          description: Information on the telephone number of the owner.
          $ref: '#/components/schemas/telephoneInfoType'
        relationship:
          description: Relationship of the owner within the profile or block.
          $ref: '#/components/schemas/codeDescriptionType'
        primary:
          description: When true, this is a primary owner.
          type: boolean
    validateReservationGuarantees:
      type: object
      description: Request object to fetch reservation guarantees.
      properties:
        criteria:
          $ref: '#/components/schemas/resGuaranteeSearchType'
        warnings:
          $ref: '#/components/schemas/warningsType'
    alternateAvailability:
      type: object
      description: Response object for fetch alternate availability operation
      properties:
        alternates:
          description: List of Alternate dates
          $ref: '#/components/schemas/alternateAvailDatesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    searchMatchType:
      type: object
      description: Search match indicating attribute and the matching value.
      properties:
        attribute:
          description: Search match attribute.
          type: string
          minLength: 0
          maxLength: 2000
        value:
          description: Search match value.
          type: string
          minLength: 0
          maxLength: 2000
    availableUpsells:
      type: object
      description: Response for fetching available up-sells.
      properties:
        upsells:
          $ref: '#/components/schemas/upsellsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    hotelAmenityType:
      type: object
      properties:
        description:
          type: string
          minLength: 0
          maxLength: 2000
        code:
          type: string
          minLength: 0
          maxLength: 20
        type:
          type: string
          minLength: 0
          maxLength: 2000
        displayOrder:
          type: number
    relativePositionType:
      type: object
      description: Defines the position of an entity in relation to another entity (e.g. from an airport to a hotel, the relationship is dependent on use).
      properties:
        distance:
          description: Defines the distance between two points.
          type: number
        distanceType:
          description: The unit of measure in a code format.
          type: string
          minLength: 0
          maxLength: 20
        drivingTime:
          description: The driving time in a free text format.
          type: string
          minLength: 0
          maxLength: 20
    profileDeliveryMethod:
      type: object
      description: Delivery Information type to the profile.
      properties:
        deliveryId:
          description: Delivery ID. It will be empty in case of new delivery method.
          $ref: '#/components/schemas/uniqueID_Type'
        deliveryType:
          description: Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.
          type: string
          minLength: 0
          maxLength: 20
        deliveryValue:
          description: Delivery value holds the corresponding value of the delivery type..
          type: string
          minLength: 0
          maxLength: 2000
        hotelId:
          description: Property that has delivery methods configured.
          type: string
          minLength: 0
          maxLength: 20
        deliveryModule:
          description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..'
          $ref: '#/components/schemas/profileDeliveryModuleType'
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    uniqueIDListType:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    primaryCodesType:
      type: array
      description: List of codes with primary flag
      maxItems: 4000
      items:
        $ref: '#/components/schemas/primaryCodeType'
    commissionPaymentMethods:
      type: string
      description: Check
      enum:
      - Cent
      - Eft
      - Chk
    addressType:
      type: object
      description: Provides address information.
      properties:
        isValidated:
          description: Indicator to define if the Address is validated by the Address Validation System.
          type: boolean
        addressLine:
          description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.
          type: array
          maxItems: 4
          items:
            type: string
            minLength: 0
            maxLength: 80
        cityName:
          description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
          type: string
          minLength: 0
          maxLength: 40
        postalCode:
          description: Post Office Code number.
          type: string
          minLength: 0
          maxLength: 15
        cityExtension:
          description: Post Office City Extension Code number. City Extension mainly used for UK addresses.
          type: string
          minLength: 0
          maxLength: 20
        county:
          description: County or District Name (e.g., Fairfax). This is read only.
          type: string
          minLength: 0
          maxLength: 20
        state:
          description: State or Province name (e.g., Texas).
          type: string
          minLength: 0
          maxLength: 20
        country:
          description: Country name (e.g., Ireland).
          $ref: '#/components/schemas/countryNameType'
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        type:
          description: Defines the type of address (e.g. home, business, other).
          type: string
          minLength: 0
          maxLength: 20
        typeDescription:
          description: Describes the type code
          type: string
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        updateReservations:
          description: Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.
          type: boolean
        barCode:
          description: The postal barcode for the address.
          type: string
          minLength: 0
          maxLength: 100
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
    totalType:
      type: object
      description: The total amount charged for the service including additional amounts and fees.
      properties:
        taxes:
          description: A collection of taxes.
          $ref: '#/components/schemas/taxesType'
        fees:
          description: A collection of fees or service charges.
          $ref: '#/components/schemas/feesType'
        description:
          type: string
          minLength: 0
          maxLength: 2000
        amountBeforeTax:
          description: The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
          type: number
        amountAfterTax:
          description: The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
          type: number
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        code:
          description: Type of charge.
          type: string
          minLength: 0
          maxLength: 20
        rateOverride:
          description: When true indicates that the rate amount has been overridden.
          type: boolean
    taxesType:
      type: object
      description: A collection of taxes.
      properties:
        tax:
          description: An individual tax.
          type: array
          maxItems: 99
          items:
            $ref: '#/components/schemas/taxType'
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    stayFutureListType:
      type: object
      description: A collection of reservation history details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : Future reservation details'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayReservationInfoType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    countryNameType:
      type: object
      description: Code for a country or a nationality.
      properties:
        value:
          type: string
          description: Used for Character Strings, length 0 to 200.
          minLength: 0
          maxLength: 200
        code:
          description: Code for a country or a nationality.
          type: string
          minLength: 0
          maxLength: 20
    hurdleRates:
      type: object
      description: Response object for fetching Hurdle rates.
      properties:
        hurdleRates:
          description: Collection of Hurdle rates.
          $ref: '#/components/schemas/hurdleRatesType'
        totalPages:
          description: Evaluated total page count based on the requested max fetch count.
          type: integer
        offset:
          description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
          type: integer
        limit:
          description: Indicates maximum number of records a Web Service should return.
          type: integer
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    userDefinedFieldsType:
      type: object
      description: A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
      properties:
        characterUDFs:
          description: Collection of user defined fields of Character/String Type.
          $ref: '#/components/schemas/characterUDFsType'
        numericUDFs:
          description: Collection of user defined fields of Numeric Type.
          $ref: '#/components/schemas/numericUDFsType'
        dateUDFs:
          description: Collection of user defined fields of Date Type.
          $ref: '#/components/schemas/dateUDFsType'
    upsellDailyRatesType:
      type: array
      description: Reservation date and its corresponding upsell rate amount
      maxItems: 4000
      items:
        $ref: '#/components/schemas/upsellDailyRateType'
    relationshipAddressType:
      type: object
      description: Provides address information for a Relationship.
      properties:
        addressLine:
          description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.
          type: array
          maxItems: 4
          items:
            type: string
            minLength: 0
            maxLength: 80
        city:
          description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
          type: string
          minLength: 0
          maxLength: 40
        postalCode:
          description: Post Office Code number.
          type: string
          minLength: 0
          maxLength: 15
        state:
          description: State or Province name (e.g., Texas).
          type: string
          minLength: 0
          maxLength: 20
        country:
          description: Country name (e.g., Ireland).
          type: string
          minLength: 0
          maxLength: 200
    resExpectedTimesType:
      type: object
      description: Holds the Arrival and Departure Time Information
      properties:
        reservationExpectedArrivalTime:
          description: Arrival Time
          type: string
          format: date-time
        reservationExpectedDepartureTime:
          description: Departure Time
          type: string
          format: date-time
    additionalGuestAmountType:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/totalType'
        ageQualifyingCode:
          type: string
          enum:
          - ADULT
          - CHILD
          - OTHER
          - CHILDBUCKET1
          - CHILDBUCKET2
          - CHILDBUCKET3
          - CHILDBUCKET4
          - CHILDBUCKET5
    meetingRoomsType:
      type: array
      description: List of meeting rooms of the hotel.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/meetingRoomType'
    upsellType:
      type: object
      description: Holds upsell information
      properties:
        ruleId:
          description: Rule unique identifier
          $ref: '#/components/schemas/uniqueID_Type'
        ruleCode:
          description: Upsell rule code
          type: string
          minLength: 0
          maxLength: 20
        ruleDescription:
          description: Upsell rule description
          type: string
          minLength: 0
          maxLength: 2000
        percentageSavings:
          description: Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)
          type: number
          minimum: 0
          maximum: 100
        upsellType:
          description: Rate code redemption type.
          type: string
          minLength: 0
          maxLength: 1
        ratePlanCode:
          description: Rate code
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Detailed information regarding room type to upsell to
          $ref: '#/components/schemas/roomTypeInfoType'
        firstNightAmount:
          description: First night upsell amount / number of points required
          $ref: '#/components/schemas/amountPointsType'
        totalStayAmount:
          description: Total stay upsell amount / number of points required
          $ref: '#/components/schemas/amountPointsType'
        rates:
          description: List of reservation date and its corresponding upsell rate amount
          $ref: '#/components/schemas/upsellDailyRatesType'
    aRAccountStatusType:
      type: object
      description: Type for the Account Status. Status can be restricted and a message/description added to the Account.
      properties:
        restriction:
          description: The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: User defined status message on the Account.
          type: string
          minLength: 0
          maxLength: 2000
        restricted:
          description: Flag to indicate if the Account is restricted.
          type: boolean
    benefitType:
      type: object
      description: Basic information about membership benefit.
      properties:
        code:
          description: Benefit code associated with a membership.
          type: string
          minLength: 0
          maxLength: 20
        message:
          description: Processing message for membership benefit.
          type: string
          minLength: 0
          maxLength: 4000
        inactive:
          description: Indicates whether membership benefit is active or inactive.
          type: boolean
    billingPrivilegesType:
      type: object
      description: This stores the information for Bed Tax Reporting. Mainly used in Maldives.
      properties:
        postingRestriction:
          description: Flag used by interface program during check in.
          type: boolean
        preStayCharging:
          description: Indicates if the reservation has charging privileges before arrival.
          type: boolean
        postStayCharging:
          description: Indicates if the reservation has charging privileges after checkout.
          type: boolean
        folioCloseDate:
          description: Date when folio was closed. This works with PostStayCharging flag.
          type: string
          format: date
          maxLength: 8
        scheduledCheckout:
          description: Indicates if the guest is scheduled for automatic check out.
          type: boolean
        scheduledCheckoutTime:
          description: Time of automatic check out if guest is schedule for automatic check out.
          type: string
          format: date
          maxLength: 8
        directBillAuthorized:
          description: If Direct bill is authorized this will hold User ID who authorized it.
          type: boolean
        videoCheckout:
          description: Indicates if the guest can do video checkout
          type: boolean
        allowAutoCheckin:
          description: Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.
          type: boolean
        autoSettlement:
          description: Indicates if the is a candidate for auto folio settlement.
          type: boolean
        autoSettlementType:
          description: The folio settlement type for auto folio settlement.
          type: string
          minLength: 0
          maxLength: 40
        autoSettlementFreq:
          description: The interval of days between each auto folio settlement.
          type: integer
        creditLimitAutoPay:
          description: Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.
          type: boolean
    alternateAvailDatesType:
      type: array
      description: List of alternate dates.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/alternateAvailDateType'
    reservationTaxTypeInfo:
      type: object
      description: Provides information about the Tax Type.
      properties:
        hotelId:
          description: Code of the Hotel.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Code of the Tax Type.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the Tax Type.
          type: string
          minLength: 0
          maxLength: 2000
        collectingAgentTax:
          description: A boolean flag for Collecting Agent Tax
          type: boolean
        printAutoAdjust:
          description: Print auto adjust information for this tax type on the tax exempt report.
          type: boolean
        reportExemptDays:
          description: Number of days after which the guest will be tax exempt. Only used for tax exempt report.
          type: integer
        reportTaxPercentage:
          description: Tax percentage. Only used for tax exempt report.
          type: number
          minimum: 0
          maximum: 100
        minimumLengthOfStay:
          description: Minimun Length of Stay.
          type: integer
        taxExemptNo:
          description: Tax exempt number on the profile.
          type: string
          minLength: 0
          maxLength: 20
    channelAvailRSInfoType:
      type: object
      description: Channel specific information to be returned in availability response.
      properties:
        channelSummaryInfo:
          description: Channel information like channel code etc.
          $ref: '#/components/schemas/channelSummaryInfoType'
        channelMarketingInfo:
          description: Channel Marketing Text like cancel,deposit,tax,commission policy etc.
          $ref: '#/components/schemas/channelMarketingInfoType'
    privacyInfoType:
      type: object
      description: Defines Privacy related information for the profile.
      properties:
        marketResearchParticipation:
          description: Indicates if the profile participates in market research.
          type: boolean
        lastPrivacyPromptDate:
          description: Indicate the last privacy prompt date of the guest.
          type: string
          format: date
          maxLength: 8
        infoFromThirdParty:
          description: Indicates if the profile is ok getting info from third parties.
          type: boolean
        autoEnrollLoyaltyProgram:
          description: Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.
          type: boolean
        allowPhone:
          description: Indicates if the profile wishes to allow phone calls.
          type: boolean
        allowSMS:
          description: Indicates if the profile wishes to allow SMS.
          type: boolean
        allowEmail:
          description: Indicates if the profile wishes to allow Email.
          type: boolean
        optInMailingList:
          description: Indicates if the profile wishes to opt in for Mailing List.
          type: boolean
        optInMarketResearch:
          description: Indicates if the profile wishes to opt in for Market Research.
          type: boolean
        optInThirdParty:
          description: Indicates if the profile wishes to opt in for Third Party.
          type: boolean
        optInAutoEnrollmentMember:
          description: Indicates if the profile wishes to opt in for Auto Enrolment Member.
          type: boolean
        optInPhone:
          description: Indicates if the profile wishes to opt in for Phone.
          type: boolean
        optInSms:
          description: Indicates if the profile wishes to opt in for SMS.
          type: boolean
        optInEmail:
          description: Indicates if the profile wishes to opt in for Email.
          type: boolean
    mealPlanCodeType:
      type: object
      description: Meal plan codes associated with the rate codes.
      properties:
        code:
          description: Meal plan code.
          type: string
          minLength: 0
          maxLength: 40
        included:
          description: Represents if the meal plan code is included in rate code or not.
          type: boolean
        breakfastIncluded:
          description: Represents if the meal plan code is available for breakfast or not.
          type: boolean
        lunchIncluded:
          description: Represents if the meal plan code is available for lunch or not.
          type: boolean
        dinnerIncluded:
          description: Represents if the meal plan code is available for dinner or not.
          type: boolean
    formattedTextTextType:
      type: object
      description: Provides text and indicates whether it is formatted or not.
      properties:
        value:
          type: string
          description: Property Value
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
    operaVersion:
      type: object
      description: Response for Ping operation.
      properties:
        operaVersion:
          description: Current Opera Version Number
          type: string
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileCashieringType:
      type: object
      description: Contains cashiering related details for the profile
      properties:
        directBillingList:
          description: Contains the direct billing related information for the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/directBillingType'
        autoFolioSettlementType:
          description: Contains the auto folio settlement type for the profile.
          type: string
          minLength: 0
          maxLength: 40
        paymentDueDays:
          description: Ability to define on the account, the number of days after which the invoice should be paid.
          type: integer
        taxPercent1:
          description: Tax1 Percentage for Collecting Agent.
          type: integer
        taxPercent2:
          description: Tax2 Percentage for Collecting Agent.
          type: integer
        taxPercent3:
          description: Tax3 Percentage for Collecting Agent.
          type: integer
        taxPercent4:
          description: Tax4 Percentage for Collecting Agent.
          type: integer
        taxPercent5:
          description: Tax5 Percentage for Collecting Agent.
          type: integer
        arNoCentral:
          description: Account Receivables Central Number.
          type: string
          minLength: 0
          maxLength: 20
        referenceCurrency:
          description: Reference Currency.
          type: string
          minLength: 0
          maxLength: 20
        vATOffsetYN:
          description: VAT Offset Flag.
          type: string
          minLength: 0
          maxLength: 1
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
    relationshipInfoType:
      type: object
      description: Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
      properties:
        changeRelationship:
          description: Information about the changes in relationship for the profile
          $ref: '#/components/schemas/changeRelationsType'
        relationshipProfile:
          description: Refer to Relationship Profile type document.
          $ref: '#/components/schemas/relationshipProfileType'
        masterAccountInfo:
          description: Refer to Master Profile type document.
          $ref: '#/components/schemas/masterAccountInfoType'
        id:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        relation:
          description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 20
        relationDescription:
          description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetRelation:
          description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 20
        targetRelationDescription:
          description: Displays the description of the target relation(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
    authorizationRuleType:
      type: object
      description: Configured rule for computing the amount to authorize.
      properties:
        code:
          description: The authorization rule code.
          type: integer
          pattern: '[0-9]{1,9}'
        amount:
          description: The amount applicable to the authorization rule.
          $ref: '#/components/schemas/currencyAmountType'
        percent:
          description: A percentage value if the authorization rule is percentage based.
          type: number
    depositCancelRevenueType:
      type: string
      description: The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
      enum:
      - Rooms
      - Catering
      - All
    cancelPenaltyType:
      type: object
      description: The CancelPenalty class defines the cancellation policy of the hotel facility.
      properties:
        deadline:
          description: Cancellation deadline, absolute or relative.
          $ref: '#/components/schemas/policyDeadlineType'
        amountPercent:
          description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights.
          $ref: '#/components/schemas/policyAmountPercentType'
        penaltyDescription:
          description: Text description of the Penalty in a given language.
          type: string
          minLength: 0
          maxLength: 2000
        offsetUnit:
          $ref: '#/components/schemas/offsetUnitType'
        formattedRule:
          description: Formatted Text Rule of the Cancellation Penalty.
          type: string
          minLength: 0
          maxLength: 2000
        policyCode:
          description: Policy Code.
          type: string
          minLength: 0
          maxLength: 20
        manual:
          description: Flag to indicate if the cancellation policy is manual.
          type: boolean
        nonRefundable:
          description: Indicates if the amount is refundable if booking is canceled.
          type: boolean
    turndownStatusType:
      type: string
      description: Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.
      enum:
      - Required
      - NotRequired
      - Compeleted
    guaranteePoliciesType:
      type: array
      description: Guarantee Code information with cancellation penalty and deposit policy information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/guaranteePolicyType'
    guestHousekeepingServiceRequestType:
      type: string
      description: Possible values for the Guest Service Status.
      enum:
      - DoNotDisturb
      - MakeUpRoom
      - NoStatusSelected
    roomStaySearchType:
      type: object
      properties:
        timeSpan:
          $ref: '#/components/schemas/timeSpanType'
        quantity:
          type: integer
        guestCounts:
          $ref: '#/components/schemas/guestCountsType'
    webUserHistoryType:
      type: object
      description: Creation date time, Creator Id, last modification date time and last Modifier Id.
      properties:
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
        lastLogin:
          description: Last login date.
          type: string
          format: date
          maxLength: 8
        lastPasswordChange:
          description: Last Password change date.
          type: string
          format: date
          maxLength: 8
        inactiveDate:
          description: Inactive date.
          type: string
          format: date
          maxLength: 8
    hotelEventSpacesType:
      type: object
      description: The Detail and Summary info of event space about the hotel
      properties:
        eventSpaceDetails:
          description: Even Space Detail information of the hotel.
          $ref: '#/components/schemas/hotelEventSpaceDetailsType'
        eventSpaceSummaries:
          description: Event Space Summary information of the hotel.
          $ref: '#/components/schemas/hotelEventSpaceSummariesType'
        setupStyles:
          description: List of hotel setup style codes of the hotel.
          $ref: '#/components/schemas/hotelSetupStylesType'
    negotiatedInfoType:
      type: object
      description: This provides information for a profile negotiated rate.
      properties:
        corporateAgreementId:
          description: The master identifier for multiple offices/locations under the same company profile. This is optional
          type: string
          minLength: 0
          maxLength: 80
        comissionCode:
          description: Informational purposes only in numeric format.
          type: string
          minLength: 0
          maxLength: 20
        order:
          description: The sell order.
          type: integer
        inactive:
          description: Negotiated Rate is inactive or not
          type: boolean
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
    reservationInfoType:
      type: object
      description: The Reservation class contains the current reservation being created or altered.
      properties:
        reservationIdList:
          description: Unique identifiers for the reservation for both internal and external systems
          $ref: '#/components/schemas/reservationIdList'
        roomStay:
          description: Collection of room stays.
          $ref: '#/components/schemas/stayInfoType'
        reservationGuest:
          description: Collection of guests associated with the reservation.
          $ref: '#/components/schemas/resGuestInfoType'
        sharedGuests:
          description: Collection of guests who share this reservation.
          $ref: '#/components/schemas/resSharedGuestListType'
        attachedProfiles:
          description: List of attached profiles
          $ref: '#/components/schemas/resAttachedProfileListType'
        reservationPaymentMethod:
          description: Payment method used for this reservation
          $ref: '#/components/schemas/reservationPaymentMethodType'
        reservationFolioWindows:
          description: Collection of reservation folio windows.
          $ref: '#/components/schemas/reservationFolioWindowsType'
        specials:
          description: Set of reservation preferences which belongs to the Specials group.
          type: string
          minLength: 0
          maxLength: 4000
        lastPrivacyPromptDate:
          description: Last Privacy Prompt Date
          type: string
          format: date
          maxLength: 8
        displayColor:
          description: Color setting of the reservation.
          type: string
          minLength: 0
          maxLength: 20
        reservationIndicators:
          description: Indicators of additional information attached to the reservation
          $ref: '#/components/schemas/indicatorsType'
        roomStatus:
          description: Current room status
          $ref: '#/components/schemas/housekeepingRoomStatusType'
        searchMatches:
          description: Super Search matching terms.
          $ref: '#/components/schemas/searchMatchesType'
        sourceOfSale:
          description: Point of Sale of reservation. Identifies the entity/channel who made the reservation.
          $ref: '#/components/schemas/sourceOfSaleType'
        waitlist:
          description: Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.
          $ref: '#/components/schemas/waitlistResType'
        queue:
          description: Information about the time and duration this reservation was on Queue for Checkin.
          $ref: '#/components/schemas/reservationQueueInformationType'
        housekeeping:
          description: Information regarding housekeeping for this reservation.
          $ref: '#/components/schemas/resHousekeepingType'
        cashiering:
          description: Holds cashiering related information for the reservation.
          $ref: '#/components/schemas/resCashieringType'
        taxType:
          description: This stores the code for the type of tax calculation especially with tax exemption, etc.
          $ref: '#/components/schemas/taxTypeType'
        deposit:
          description: Holds reservation deposit information.
          $ref: '#/components/schemas/reservationDepositType'
        allowedActions:
          description: Collection of reservation allowed actions.
          $ref: '#/components/schemas/reservationAllowedActionsType'
        revenuesAndBalances:
          description: Revenues and Balances Amount summary for the reservation.
          $ref: '#/components/schemas/resRevenueBalanceType'
        hotelInterfaceStatusList:
          description: Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationInterfaceStatusType'
        guestPreferredCurrency:
          description: Currency code preferred by guest.
          type: string
          minLength: 0
          maxLength: 20
        turndownInfo:
          description: Currency code preferred by guest.
          $ref: '#/components/schemas/reservationTurndownInfoType'
        mobileNotifications:
          description: Denotes the status of Room Ready, Key Ready messages.
          $ref: '#/components/schemas/resMobileNotificationsType'
        reservationCommunication:
          description: Collection of reservation communication details.
          $ref: '#/components/schemas/resCommunicationType'
        advanceCheckIn:
          description: Information relating to Reservation's Advance Checked In state and Expected Time of Return
          $ref: '#/components/schemas/advanceCheckInType'
        welcomeOffer:
          description: This flag will determine wheather the reservation is eligible for Welcome Offer or not.
          type: boolean
        cancellationInfo:
          description: Information regarding why reservation has been/was cancelled.
          type: object
          properties:
            description:
              type: string
              minLength: 0
              maxLength: 2000
            code:
              type: string
              minLength: 0
              maxLength: 20
            date:
              description: Date when reservation was last cancelled.
              type: string
              format: date
              maxLength: 8
        keyCount:
          description: Number of keys created for the reservation.
          type: integer
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        hotelName:
          type: string
          minLength: 0
          maxLength: 80
        expectedServiceTime:
          type: string
          minLength: 0
          maxLength: 20
        roomStayReservation:
          description: Boolean True if this reservation is reserving rooms. False if it is only reserving services.
          type: boolean
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
        reservationStatus:
          description: Indicates the status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
        computedReservationStatus:
          description: Indicates the status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
        walkInIndicator:
          description: When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.
          type: boolean
        accessRestriction:
          description: Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.
          $ref: '#/components/schemas/resAccessRestrictionType'
        commissionPayoutTo:
          description: If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.
          $ref: '#/components/schemas/commissionPayoutToType'
        paymentMethod:
          description: Payment Method.
          type: string
          minLength: 0
          maxLength: 20
        preRegistered:
          description: Defines if the reservation is pre-registered or not.
          type: boolean
        openFolio:
          description: Returns true when reservation has an open folio.
          type: boolean
        allowMobileCheckout:
          description: Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.
          type: boolean
        allowMobileViewFolio:
          description: Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.
          type: boolean
        optedForCommunication:
          description: Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.
          type: boolean
    membershipEarningPreferenceType:
      type: string
      description: The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.
      enum:
      - Points
      - Miles
    foreignExchangeType:
      type: object
      description: Foreign Exchange info.
      properties:
        type:
          description: Exchange Type for the postings.
          type: string
          minLength: 0
          maxLength: 20
        effectiveDate:
          description: Effective Exchange date for the foreign currency posting.
          type: string
          format: date
          maxLength: 8
    reservationPackageScheduleType:
      type: object
      description: A HotelPackageSchedule type.
      properties:
        consumptionDate:
          description: The date the package was used or can be used.
          type: string
          format: date
          maxLength: 8
        unitPrice:
          description: The price per unit of the package.
          type: number
        totalQuantity:
          description: The total quantity of the package for this date, calculated based on the calculation rule as defined in the PackageHeaderType
          type: integer
        computedResvPrice:
          description: Computed Reservation Price of the package. Calculation Will Be Performed Based On Other Parameters.
          type: number
        unitAllowance:
          description: The allowance per unit of the package.
          type: number
        reservationDate:
          description: The date of the Reservation when this package is applicable. This can be different from the date the package will be consumed. Example are next day packages. Reservation date is when the package is applied to the guest and Consumption date is when the guest can consume the package.
          type: string
          format: date
          maxLength: 8
        originalUnitPrice:
          description: The original price per unit of the package if it has been changed.
          type: number
        originalUnitAllowance:
          description: The original allowance per unit of the package if it has been changed.
          type: number
    eCertificateType:
      type: object
      description: E-Certificates details.
      properties:
        certificateId:
          description: System generated unique certificate id.
          type: integer
        voucherNo:
          description: System generated unique voucher number.
          type: string
          minLength: 0
          maxLength: 40
        certificateNo:
          description: Printed certificate no. This has to be unique.
          type: string
          minLength: 0
          maxLength: 40
        eCertificateInfo:
          $ref: '#/components/schemas/eCertificateInfoType'
        expiryDate:
          description: Date of expiry.
          type: string
          format: date
          maxLength: 8
        newExpiryDate:
          description: New Date of expiry to extend e-certificate.
          type: string
          format: date
          maxLength: 8
        profileId:
          description: NameId.
          $ref: '#/components/schemas/profileId'
        consumptionDetail:
          $ref: '#/components/schemas/eCertificateConsumptionType'
        status:
          description: Status of the certificate.
          $ref: '#/components/schemas/eCertificateStatusType'
        printed:
          description: Print status of the certificate.
          type: boolean
        inactiveDate:
          description: Date the record was marked as inactive.
          type: string
          format: date
          maxLength: 8
        awardId:
          description: AwardID.
          $ref: '#/components/schemas/awardId'
        databaseId:
          description: External reference from which the record is created.
          type: string
          minLength: 0
          maxLength: 20
        source:
          description: Source of e-certificate.
          $ref: '#/components/schemas/eCertificateIssueSourceType'
        issueType:
          description: Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p).
          $ref: '#/components/schemas/eCertificateIssueType'
        issueDate:
          description: Date when certificate was issued.
          type: string
          format: date
          maxLength: 8
        awardPoints:
          description: Award points if any in case of certificate use membership award.
          type: integer
        generationDetail:
          $ref: '#/components/schemas/eCertificateGenerationType'
        originalVoucherNo:
          description: In case of in lieu of certificate this will contain the original voucher no.
          type: string
          minLength: 0
          maxLength: 40
        originalCertificateNo:
          description: In case of in lieu of certificate this will contain the original certificate no.
          type: string
          minLength: 0
          maxLength: 40
        inLieuSequence:
          description: Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.
          type: integer
        cancelRequestDate:
          description: Date on which the cancellation was requested.
          type: string
          format: date
          maxLength: 8
        extensionCount:
          description: Number of times e-certificate is already extended.
          type: integer
    resCashieringType:
      type: object
      description: Cashiering Information for the reservation.
      properties:
        revenuesAndBalances:
          description: Revenues and Balances Amount summary for the reservation.
          $ref: '#/components/schemas/resRevenueBalanceType'
        billingPrivileges:
          description: Billing privileges set on the reservation.
          $ref: '#/components/schemas/billingPrivilegesType'
        taxType:
          description: This stores the code for the type of tax calculation especially with tax exemption, etc.
          $ref: '#/components/schemas/reservationTaxTypeInfo'
        bedTaxReporting:
          description: This stores the information for Bed Tax Reporting. Mainly used in Maldives.
          $ref: '#/components/schemas/bedTaxReportingType'
        folioTexts:
          description: Additional text fields to display on the folio.
          $ref: '#/components/schemas/folioTextsType'
        periodicFolio:
          description: Information regarding periodic folios set on the reservation.
          $ref: '#/components/schemas/resPeriodicFolioType'
        compAccounting:
          description: Information regarding comp accounting on the reservation.
          $ref: '#/components/schemas/resCompAccountingType'
        reservationPreConfiguredRoutingInstruction:
          description: Information regarding the selected preconfigured routing instruction on the reservation.
          $ref: '#/components/schemas/resPreConfiguredRoutingInstrType'
        financiallyResponsible:
          description: The guest from whom payment has to be recovered (direct guest).
          type: boolean
        proratedBilling:
          description: In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.
          type: boolean
        lastRoomAndTaxPostedDate:
          description: Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.
          type: string
          format: date
          maxLength: 8
        reverseCheckInAllowed:
          description: This attribute is to verify if reverse check-in is allowed for the reservation.
          type: boolean
        reverseAdvanceCheckInAllowed:
          description: This attribute is to verify if reverse advance check-in is allowed for the reservation.
          type: boolean
        transactionsPosted:
          description: Specifies whether reservation has a financial transaction associated with it.
          type: boolean
    meetingRoomType:
      type: object
      description: Information about the meeting rooms of the hotel.
      properties:
        code:
          description: the code of the meeting room
          type: string
          minLength: 0
          maxLength: 20
        charge:
          description: The charge for the meeting room.
          type: string
          minLength: 0
          maxLength: 40
        description:
          description: A description of the meeting room.
          type: string
          minLength: 0
          maxLength: 200
    hotelSummaryInfoType:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/addressType'
        contactNumbers:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/telephoneType'
        minRate:
          $ref: '#/components/schemas/currencyAmountType'
        maxRate:
          $ref: '#/components/schemas/currencyAmountType'
        relativePosition:
          $ref: '#/components/schemas/relativePositionType'
        hotelAmenities:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/hotelAmenityType'
        event:
          description: True if the hotel has any scheduled events within the requested date range.
          type: boolean
        rateRoomDetails:
          description: Any additional information like membership, restriction status, room stay information of the requested hotels etc.
          $ref: '#/components/schemas/rateRoomDetailsType'
        channelSummaryInfo:
          description: Channel related information if availability request is send for a channel.
          $ref: '#/components/schemas/channelSummaryInfoType'
        sellMessages:
          description: Sell messages retrieved based on the Time Span criteria for all Rate Codes and Room Types of the requested hotel.
          $ref: '#/components/schemas/sellMessagesType'
        currencyExchangeRates:
          description: Exchange Rate information for currency codes of the requested hotel.
          $ref: '#/components/schemas/currencyExchangeRatesType'
        chainCode:
          description: The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
          type: string
          minLength: 0
          maxLength: 20
        hotelCityCode:
          description: The IATA city code; for example DCA, ORD.
          type: string
          minLength: 0
          maxLength: 40
        hotelName:
          description: A text field used to communicate the proper name of the hotel.
          type: string
          minLength: 0
          maxLength: 80
        hotelCodeContext:
          description: A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.
          type: string
          minLength: 0
          maxLength: 40
        chainName:
          description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).
          type: string
          minLength: 0
          maxLength: 80
        hotelType:
          type: string
          minLength: 0
          maxLength: 20
        negotiated:
          type: boolean
        alternate:
          type: boolean
        displayOrder:
          type: number
        inventoryRooms:
          description: The Maximum number of rooms in this hotel. This number includes the sell limits. Also the number of deduct rooms already sold and the number of Owner Exclusive Rooms(applicable when Ownership Records functionality is active).
          type: integer
        sellableRooms:
          description: The Maximum number of rooms that can be sold in this hotel. This number excludes the number of Owner Exclusive Rooms(applicable when Ownership Records functionality is active). It includes the sell limits and Also the number of deduct rooms already sold.
          type: integer
        ownerExclusiveRooms:
          description: The total number of Owner Exclusive rooms in this hotel. This is only applicable Ownership Records functionality is active.
          type: integer
        availableRooms:
          description: The number of rooms that are actually available in this hotel. This number includes the sell limits. It excludes the number of deduct rooms already sold and the number of Owner Exclusive rooms.
          type: integer
        physicalRooms:
          description: The total number of physical rooms in a hotel.
          type: integer
        checkInTime:
          description: The official check in time of the Hotel. Uses the hotel's time zone.
          type: string
          format: date-time
        checkOutTime:
          description: The official check out time of the Hotel. Uses the hotel's time zone.
          type: string
          format: date-time
        timeZoneRegion:
          description: Time zone region of the hotel.
          type: string
          minLength: 0
          maxLength: 80
        currencyCode:
          description: Provides the hotel's currency code.
          type: string
          minLength: 3
          maxLength: 3
        numberOfEvents:
          description: Represents the total number of events in a calendar for a hotel.
          type: integer
        websiteAddress:
          description: Website address for a resort or property
          type: string
          maxLength: 200
    reservationDepositType:
      type: object
      description: Reservation Deposit Type.
      properties:
        amountRequired:
          description: Deposit Amount Required.
          type: number
        amountPaid:
          description: Deposit Amount Paid.
          type: number
        amountOwed:
          description: Deposit Amount Owed.
          type: number
        dueDate:
          description: Deposit Due Date.
          type: string
          format: date
          maxLength: 8
        postingDate:
          description: Deposit Posting Date.
          type: string
          format: date
          maxLength: 8
        hasPaid:
          description: Resolves whether reservation has paid deposit.
          type: boolean
        hasOutstanding:
          description: Resolves whether reservation has outstanding deposit.
          type: boolean
    profileMembershipType:
      type: object
      description: Detailed information of the memberships.
      properties:
        comment:
          description: Additional comments regarding to the membership.
          $ref: '#/components/schemas/paragraphType'
        newMembershipNumber:
          description: Card Number of the membership.
          type: string
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
        programDescription:
          description: Description of the membership program.
          type: string
        membershipLevel:
          description: Indicates the membership level.
          type: string
        membershipLevelDescription:
          description: Indicates the membership level description.
          type: string
          minLength: 0
          maxLength: 200
        membershipClass:
          description: Indicates the membership class.
          type: string
        earningPreference:
          description: Earning preference to the membership.
          $ref: '#/components/schemas/membershipEarningPreferenceType'
        inactive:
          description: Indicates whether membership is active or inactive.
          type: boolean
        benefits:
          description: benefits for the membership.
          $ref: '#/components/schemas/benefitsType'
        tierAdministration:
          description: Defines the degree of participation for this membership in the tier management portion of the program.
          $ref: '#/components/schemas/tierAdministrationType'
        downgrade:
          description: Defines how downgrading will be handled for this membership.
          $ref: '#/components/schemas/downgradeType'
        reIssueNewCard:
          description: The status of issuing new membership card to the member.
          $ref: '#/components/schemas/cardReIssueType'
        excludeFromBatch:
          description: True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.
          type: boolean
        upgradeDescription:
          description: Indicates Upgrade information which includes member's next tier level, policyRequirements for the next upgrade.
          type: string
          minLength: 0
          maxLength: 32000
        downgradeDescription:
          description: Indicates information regarding the member's possible downgrades.
          type: string
          minLength: 0
          maxLength: 32000
        rating:
          description: Value Rating Type Description for this membership.
          type: string
        membershipEnrollmentCode:
          description: Indicates how the guest enrolled in the program.
          type: string
          minLength: 0
          maxLength: 20
        memberStatus:
          description: Indicates where the guest is in the membership enrollment process.
          type: string
          minLength: 0
          maxLength: 20
        currentPoints:
          description: Profile MemberShip Points.
          type: number
        pointsLabel:
          description: Label used to refer to points for this membership type
          type: string
          minLength: 0
          maxLength: 20
        enrollmentSource:
          description: Source from where the enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        enrollmentResort:
          description: Resort/CRO where enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        preferredCard:
          description: Preferred Card.
          type: boolean
        membershipId:
          description: Card Number of the membership.
          type: string
        membershipType:
          description: Type of membership.
          type: string
        primaryMembershipYn:
          description: Indicator if Membership is a Primary Membership.
          type: string
          minLength: 0
          maxLength: 1
        primaryMembership:
          description: Boolean indicator set to True implies membership is a Primary Membership.
          type: boolean
        membershipIdNo:
          description: Membership ID Number.
          type: integer
        playerRanking:
          description: Ranking assigned to the Player Profile by the Gaming system.
          type: integer
        centralSetup:
          description: Indicates how the award points for this membership type will be managed.
          type: boolean
        signupDate:
          description: Indicates when the member signed up for the loyalty program.
          type: string
          format: date
          maxLength: 8
        effectiveDate:
          description: Indicates the starting date.
          type: string
          format: date
          maxLength: 8
        expireDate:
          description: Indicates the ending date.
          type: string
          format: date
          maxLength: 8
        expireDateExclusiveIndicator:
          description: When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
    reservationPaymentMethodType:
      type: object
      properties:
        paymentCard:
          $ref: '#/components/schemas/resPaymentCardType'
        balance:
          $ref: '#/components/schemas/currencyAmountType'
        authorizationRule:
          $ref: '#/components/schemas/authorizationRuleType'
        emailFolioInfo:
          description: Information on an email for the customer.
          type: object
          properties:
            email:
              description: eMail deatils for the profile.
              $ref: '#/components/schemas/emailType'
            emailFolio:
              type: boolean
            id:
              description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
              type: string
              minLength: 0
              maxLength: 80
            type:
              description: A reference to the type of object defined by the UniqueID element.
              type: string
              minLength: 0
              maxLength: 40
        paymentMethod:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
        folioView:
          type: integer
    mealPlansType:
      type: array
      description: Meal plan codes associated with the rate codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/mealPlanCodeType'
    hotelCorporateInformationsType:
      type: object
      description: Corporate information details of the property
      properties:
        brandCode:
          type: string
          minLength: 0
          maxLength: 20
        hotelCategory:
          type: string
          minLength: 0
          maxLength: 20
        businessUnit:
          $ref: '#/components/schemas/primaryCodesType'
        departmentCode:
          $ref: '#/components/schemas/primaryCodesType'
        division:
          $ref: '#/components/schemas/primaryCodesType'
        opertingUnit:
          $ref: '#/components/schemas/primaryCodesType'
    restrictionsHistory:
      type: object
      description: Response object for searching restrictions history.
      properties:
        restrictionsHistory:
          description: Response of Restrictions History
          $ref: '#/components/schemas/fetchRestrictionsHistoryRSType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    folioTextsType:
      type: array
      description: This stores the description for the type of tax calculation especially with tax exemption, etc.
      maxItems: 2
      items:
        type: object
        properties:
          text:
            description: Additional text field to display on the folio.
            type: string
            minLength: 0
            maxLength: 50
          row:
            description: Row number of the additional text.
            type: integer
    searchHotelAvailabilityRequest:
      type: object
      properties:
        includeLocalRates:
          type: boolean
          description: Used to indicate if local rates are to be included in the Rate Plan set.
        includeOffshoreRates:
          type: boolean
          description: Used to indicate if offshore rates are to be included in the Rate Plan set.
        cro:
          type: array
          items:
            type: string
          description: Central reservation office Code who is requesting Rate Availability.
        includeClosedRates:
          type: array
          items:
            type: boolean
          description: Used to indicate if closed rates are to be included in the Rate Plan set.
        includeDefaultRatePlanSet:
          type: array
          items:
            type: boolean
          description: Used to indicate if the configured default rate plan set will be included.
        includeNoRatePlanSet:
          type: array
          items:
            type: boolean
          description: Includes the rate codes which do not have a rate plan set associated. This parameter is applicable when the property has not configured a default rate plan set.
        initialRatePlanSet:
          type: array
          items:
            type: boolean
          description: If InitialRatePlanSet is set to true response will return most relevant Rate Plan Set(e.g. NEGOTIATED if profiles has Negotiated Rates) depending on the request. if request does not requires special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set.
        limit:
          type: array
          items:
            type: integer
          description: Indicates maximum number of records a Web Service should return.
        pagePointerKey:
          type: array
          items:
            type: string
          description: Specifies fetched record's key as pointer to fetch additional records from. If key is composite use comma separated string.
        ratePlanSet:
          type: array
          items:
            type: string
          description: Rate Plan Set code to filter Rate Plans based on the predefined set. if not specified it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set(See InitialRatePlanSet documentation).
        redeemAwards:
          type: array
          items:
            type: boolean
          description: Used to indicate if the awards are to be redeemed.
        roomStayStartDate:
          type: string
          format: date
        roomStayEndDate:
          type: string
          format: date
        roomStayQuantity:
          type: integer
        adults:
          type: integer
          description: Defines the number of Adults.
        children:
          type: integer
          description: Defines the number of Children.
        childAge:
          type: array
          items:
            type: integer
          description: Age of a child in years.
        bucket1Count:
          type: integer
          description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        bucket2Count:
          type: integer
          description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        bucket3Count:
          type: integer
          description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        bucket4Count:
          type: integer
          description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        bucket5Count:
          type: integer
          description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        fullStayTimeSpanStartDate:
          type: string
          format: date
        fullStayTimeSpanEndDate:
          type: string
          format: date
        prevailingRate:
          type: boolean
        rateCategory:
          type: string
        rateClass:
          type: string
        rateGroup:
          type: string
        ratePlanCode:
          type: array
          items:
            type: string
        promotionCode:
          type: array
          items:
            type: string
          description: Promotion code associated with the rate plan.
        roomType:
          type: array
          items:
            type: string
        feature:
          type: array
          items:
            type: string
        reservationGuestId:
          type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        reservationGuestIdType:
          type: string
          description: A reference to the type of object defined by the UniqueID element.
        reservationProfileType:
          type: array
          items:
            $ref: '#/components/schemas/reservationProfileTypeEnum'
          description: Type of profile or reservation.
        attachedProfileId:
          type: array
          items:
            type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        hotelReservationId:
          type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        hotelReservationIdType:
          type: string
          description: A reference to the type of object defined by the UniqueID element.
        ratePlanInfo:
          type: boolean
          description: If true Rate Plan Code Master information will be included in the response.
        returnOnlyAvailableRateCodes:
          type: boolean
          description: If true Only availability check will be done and it will return available rate codes.
        resGuaranteeInfo:
          type: boolean
          description: If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.
        roomTypeInfo:
          type: boolean
          description: If true Room Type Master information will be included in the response.
        membershipIdNumber:
          type: array
          items:
            type: integer
          description: Membership id Number of the guest.
        membershipLevel:
          type: array
          items:
            type: string
          description: Membership id Number of the guest.
        membershipType:
          type: array
          items:
            type: string
          description: Membership id Number of the guest.
        pointsAvailable:
          type: array
          items:
            type: integer
          description: Used to indicate Points Available for Profile Primary Membership Type.
        membershipCardNumber:
          type: array
          items:
            type: string
          description: Member Card number associated with the guest membership.
        smokingPreference:
          type: array
          items:
            type: string
          description: Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation.
        hotelPackage:
          type: array
          items:
            type: string
          description: Hotel Package Code to filter the search result.
        ownerType:
          type: string
          $ref: '#/components/schemas/ownerProfileTypeEnum'
        controlSegment:
          type: array
          items:
            type: string
          description: Control Segment to check for casion restrction for a patron profile.
        postingInterval:
          type: array
          items:
            $ref: '#/components/schemas/ratePostingInterval'
          description: Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned
    upsellsType:
      type: object
      description: List of upsell information
      properties:
        upsell:
          description: Holds upsell information
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/upsellType'
        availableAmount:
          description: Amount / number of points available to guest
          $ref: '#/components/schemas/amountPointsType'
    hurdleRateType:
      type: object
      description: Unique identifier for hurdle rate.
      properties:
        hotelId:
          description: Hotel code for which the hurdle rate belongs to.
          type: string
          minLength: 0
          maxLength: 20
        hurdleDate:
          description: Hurdle date for which the hurdle rate is scheduled.
          type: string
          format: date
          maxLength: 8
        roomType:
          description: Room type for which the hurdle rate applies to.
          type: string
          minLength: 0
          maxLength: 20
        roomCategory:
          description: Internal room category of the room type for which the hurdle rate applies to.
          type: string
          minLength: 0
          maxLength: 20
        yieldCategory:
          description: Yield category for which the hurdle rate applies to.
          type: string
          minLength: 0
          maxLength: 20
        lengthOfStay:
          description: Length of stay for which the hurdle rate applies to.
          type: number
        yieldMarketCode:
          description: Yield market code for which the hurdle rate applies to.
          type: string
          minLength: 0
          maxLength: 20
        hurdle:
          description: Defines the amount to be reached before rate code or room type is made available.
          type: number
        delta:
          description: Defines the amount to be added to hurdle rate for each additional rooms sold up to the ceiling.
          type: number
        ceiling:
          description: Maximum number of rooms to sell for which the delta is applicable to be aded to hurdle rate.
          type: number
        maxSolds:
          description: Maximum number of rooms to sell.
          type: number
        roomsSold:
          description: Defines the actual number of rooms sold.
          type: number
        override:
          description: Specifies whether to override hurdle rate or not.
          type: boolean
        hurdleRangeStart:
          description: Hurdle date start range from which the hurdle rate is scheduled.
          type: string
          format: date
        hurdleRangeEnd:
          description: Hurdle date end range to which the hurdle rate is scheduled.
          type: string
          format: date
        managedBy:
          $ref: '#/components/schemas/managedByOptions'
    telephoneInfoType:
      type: object
      description: Information on a telephone number for the customer.
      properties:
        telephone:
          description: Phone details for the profile.
          $ref: '#/components/schemas/telephoneType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    currencyExchangeRateType:
      type: object
      description: Currency code configuration.
      properties:
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        description:
          description: Description of the currency code.
          type: string
          minLength: 0
          maxLength: 2000
        exchangeRate:
          description: Exchange Rate for the currency code. Exchange rate is based on the current business date of the property.
          $ref: '#/components/schemas/currencyAmountType'
    waitlistResType:
      type: object
      description: Information regarding why reservation is being /has been waitlisted.
      properties:
        reasonDescription:
          description: Waitlist Reason Description.
          type: string
          minLength: 0
          maxLength: 2000
        priorityDescription:
          description: Waitlist priority Description.
          type: string
          minLength: 0
          maxLength: 2000
        description:
          description: Description why the reservation is being /has been waitlisted.
          type: string
          minLength: 0
          maxLength: 2000
        reasonCode:
          description: Waitlist Reason Code.
          type: string
          minLength: 0
          maxLength: 20
        priorityCode:
          description: Waitlist Priority Code.
          type: string
          minLength: 0
          maxLength: 20
        telephone:
          description: Guest telephone number.
          type: string
          minLength: 0
          maxLength: 40
    identificationInfoType:
      type: object
      description: Information on the identification of the customer.
      properties:
        identification:
          description: Detailed information on the identification of the customer.
          $ref: '#/components/schemas/identificationType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    reservationProfileTypeEnum:
      type: string
      enum:
      - Guest
      - Company
      - Group
      - TravelAgent
      - Source
      - ReservationContact
      - BillingContact
      - Addressee
    status:
      type: object
      description: Response Body.
      properties:
        warnings:
          $ref: '#/components/schemas/warningsType'
        links:
          $ref: '#/components/schemas/links'
    profileRestrictions:
      type: object
      properties:
        reason:
          description: Restriction reason associated with the current profile.
          type: string
          minLength: 0
          maxLength: 20
        reasonDescription:
          description: Description of restriction reason.
          type: string
          minLength: 0
          maxLength: 2000
        restricted:
          description: True indicates there are restrictions associated with the current profile.
          type: boolean
    fetchRestrictionsHistoryRSType:
      type: object
      description: Response object to fetch restriction search filtered by search criteria.
      properties:
        restrictionsHistory:
          description: Requested restrictions history.
          $ref: '#/components/schemas/restrictionsHistoryType'
    sellMessagesType:
      type: object
      description: The SellMessagesType is the list of message and attributes returned by web service.
      properties:
        sellMessage:
          description: This is the message text.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/sellMessageType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    promotionType:
      type: object
      description: Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
      properties:
        promotionCode:
          description: Promotion code associated with the rate plan.
          type: string
          minLength: 0
          maxLength: 20
        promotionName:
          description: Promotion code Name associated with the rate plan.
          type: string
          minLength: 0
          maxLength: 20
        couponCode:
          description: Promotion Coupon Code when promotion is setup to have a valid coupon code.
          type: string
          minLength: 0
          maxLength: 40
    primaryCodeType:
      type: object
      description: Primary flag with code and description.
      properties:
        primary:
          type: boolean
        codeDescription:
          $ref: '#/components/schemas/codeDescriptionType'
    restrictionControlType:
      type: object
      description: The RestrictionControlType is used to indicate the applicability of the restriction.
      properties:
        house:
          description: Indicates the restriction is applicable at the House Level. When this is true all other attributes are ignored.
          type: boolean
        bookingChannelCode:
          description: Indicates restriction is applicable to specified Booking Channel Code in conjunction with other codes, if specified.
          type: string
          minLength: 0
          maxLength: 20
        roomClass:
          description: Indicates restriction is applicable to specified Room Category in conjunction with other codes, if specified.
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Indicates restriction is applicable to specified Room Type in conjunction with other codes, if specified.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCategory:
          description: Indicates restriction is applicable to specified Rate Plan Category in conjunction with other codes, if specified.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: Indicates restriction is applicable to specified Rate Plan Code in conjunction with other codes, if specified.
          type: string
          minLength: 0
          maxLength: 20
    channelSummaryInfoType:
      type: object
      description: Depicts channel information such as the type and code.
      properties:
        bookingChannel:
          $ref: '#/components/schemas/bookingChannelType'
        messageId:
          description: Indicates the transaction identifier.
          type: string
        summaryOnly:
          description: Used to indicate whether to return summarized or detailed rate room information.
          type: boolean
    configPackageTransactionType:
      type: object
      description: A HotelPackageTransaction type.
      properties:
        allowance:
          description: Package is marked as an allowance, in case charge is expected back to the guest account from external interface eg. POS. which need to be offset against a consumption allowance.
          type: boolean
        currency:
          description: The currency code for this package.
          type: string
          minLength: 0
          maxLength: 20
        postingType:
          description: The posting frequency for this package, e.g., daily, arrival, departure, etc.
          type: string
          minLength: 0
          maxLength: 20
        calculationRule:
          description: The price calculation rule for this package.
          type: string
          minLength: 0
          maxLength: 80
        packagePostingRules:
          description: The package posting rule details.
          $ref: '#/components/schemas/packagePostingRulesType'
    managedByOptions:
      description: Describes of the Configuration is Managed by Enterprise or Property.
      type: string
      enum:
      - EnterpriseManaged
      - PropertyManaged
      - EnterpriseEnforced
      - PropertyOverridden
    alternateAvailDateType:
      type: object
      description: Type containing information about an alternate date.
      properties:
        rateAmount:
          description: Rate amount for the requested room-rate combination if it's available in this particular date.
          $ref: '#/components/schemas/currencyAmountType'
        date:
          description: A specific date from the alternate dates.
          type: string
          format: date
          maxLength: 8
        status:
          description: Status of the availability for the date.
          $ref: '#/components/schemas/availabilityStatusType'
    relationshipInfoSummaryType:
      type: object
      description: RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
      properties:
        relationshipProfile:
          description: Refer to Relationship Profile Summary type document.
          $ref: '#/components/schemas/relationshipProfileSummaryType'
        masterAccountDetails:
          description: Refer to Master Profile type document.
          $ref: '#/components/schemas/masterAccountInfoType'
        relationshipID:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        sourceRelation:
          description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 20
        sourceRelationDescription:
          description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetRelation:
          description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 20
        targetRelationDescription:
          description: Displays the description of the target relation(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
    resPeriodicFolioType:
      type: object
      description: Information regarding periodic folios set on the reservation.
      properties:
        lastSettlementDate:
          description: Latest date when a direct bill settlement was automatically done using the "Direct Bill Batch Folios" option.
          type: string
          format: date
          maxLength: 8
        lastFolioDate:
          description: Latest date when a folio was printed using the "Periodic Batch Folios" option
          type: string
          format: date
          maxLength: 8
        frequency:
          description: Frequency in number of days when folios should be printed for this reservation.
          type: integer
    resAttachedProfileListType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resAttachedProfileType'
    eCertificateConsumptionType:
      type: object
      description: E-Certificates details.
      properties:
        hotelId:
          description: Property where certificate was consumed for.
          type: string
          minLength: 0
          maxLength: 20
        source:
          description: Source of consumption.
          $ref: '#/components/schemas/eCertificateConsumeSourceType'
        surname:
          description: Last name of the person who consumed the certificate..
          type: string
          minLength: 0
          maxLength: 40
        firstName:
          description: First name of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 40
        middleName:
          description: Middle name of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 40
        email:
          description: Email of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 2000
        date:
          description: Date the certificate was consumed.
          type: string
          format: date
          maxLength: 8
        userName:
          description: Application user who created the consumption.
          type: string
          minLength: 0
          maxLength: 2000
        userNotes:
          description: Any notes on the certificate entered at time of consumption.
          type: string
          minLength: 0
          maxLength: 4000
        referenceId:
          description: Any reference like reservation no etc against which the certificate was consumed.
          $ref: '#/components/schemas/uniqueID_Type'
        locationType:
          description: Consumption location type.
          type: string
          minLength: 0
          maxLength: 20
        authorizationCode:
          description: Authorization code for consumption.
          type: string
          minLength: 0
          maxLength: 100
        serviceDate:
          description: Date on which the service is due (arrival date in case of reservation).
          type: string
          format: date
          maxLength: 8
    resGuestExternalInfoType:
      type: object
      description: Specifies Company or Travel Agent profile using IATA or Corp. No.
      properties:
        givenName:
          description: Given name, first name or names
          $ref: '#/components/schemas/givenNameType'
        surname:
          description: Family name, last name.
          $ref: '#/components/schemas/surnameType'
    relationshipProfileSummaryType:
      type: object
      properties:
        customerName:
          description: Name of the customer
          type: string
          minLength: 0
          maxLength: 40
        companyName:
          description: Name of the company.
          type: string
          minLength: 0
          maxLength: 40
        telephoneNumber:
          description: Telephone number assigned to a single location
          type: string
          minLength: 0
          maxLength: 40
        address:
          description: Information on address details for the customer/company
          $ref: '#/components/schemas/relationshipAddressType'
        emailAddress:
          description: Defines the e-mail address.
          type: string
          minLength: 0
          maxLength: 2000
        ownerCode:
          description: Unique Code to identify the owner.
          type: string
          minLength: 0
          maxLength: 20
        profileIdList:
          description: Original profile details for which the relationships was created
          $ref: '#/components/schemas/uniqueIDListType'
        primary:
          description: Indicates if this relationship is the primary relationship.
          type: boolean
        profileStatus:
          description: Status of the profile. Active/Inactive
          $ref: '#/components/schemas/profileStatusType'
        primaryOwnerCode:
          description: When true, this is a primary owner.
          type: boolean
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
    ownerResTypeType:
      type: string
      enum:
      - Owner
      - AuthorizedUser
    givenNameType:
      type: string
      description: Given name, first name or names
      minLength: 0
      maxLength: 40
    advanceCheckInType:
      type: object
      description: Information relating to Reservation's Advance Checked In state and Expected Time of Return
      properties:
        advanceCheckedIn:
          description: Indicates if the reservation is marked as Advance Checked In
          type: boolean
        expectedReturnTime:
          description: Expected Return Time. Uses the hotel's time zone.
          type: string
          format: date-time
        eTRComments:
          description: ETR Comments
          type: string
          minLength: 0
          maxLength: 2000
    companyInfoType:
      type: object
      description: Company Information of the Profile.
      properties:
        legalCompany:
          description: Legal Company.
          type: string
          minLength: 0
          maxLength: 20
        department:
          description: Department of the Profile.
          type: string
          minLength: 0
          maxLength: 20
        position:
          description: Business Title or Position of the profile.
          type: string
          minLength: 0
          maxLength: 40
    resRevenueBalanceType:
      type: object
      description: Revenue and Balance Amount summary for the reservation.
      properties:
        totalFixedCharge:
          description: Total Fixed Charges on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        totalPayment:
          description: Total payment received for the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        roomRevenue:
          description: Room Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        foodAndBevRevenue:
          description: Food and Beverage Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        otherRevenue:
          description: Other Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        nonRevenue:
          description: Total Non Revenue posted on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        totalRevenue:
          description: Total Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        balance:
          description: Balance amount on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        compBalance:
          description: Comp Balance amount
          $ref: '#/components/schemas/currencyAmountType'
    restrictionStatusType:
      type: object
      description: The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.
      properties:
        code:
          description: Identifies the type of restriction. I.E. Closed, ClosedForArrival, etc.
          $ref: '#/components/schemas/restrictionStatusesType'
        unit:
          description: Defines restriction in conjunction with Restriction Code. Value must be specified for Restriction Codes MinimumStayThrough, MaximumStayThrough, MinimumLengthOfStay, MaximumLengthOfStay, MinimumAdvanceBooking, MaximumAdvanceBooking.
          type: integer
        lOS1:
          description: Indicates Length of Stay 1 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS2:
          description: Indicates Length of Stay 2 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS3:
          description: Indicates Length of Stay 3 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS4:
          description: Indicates Length of Stay 4 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS5:
          description: Indicates Length of Stay 5 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS6:
          description: Indicates Length of Stay 6 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS7:
          description: Indicates Length of Stay 7 or more is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
    imageSetType:
      type: object
      description: Represents on image set record.
      properties:
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        imageSet:
          description: The image set name.
          type: string
          minLength: 0
          maxLength: 800
        sequenceId:
          description: The image set sequence ID.
          type: integer
        imageStyle:
          description: The image set enumerated style.
          $ref: '#/components/schemas/imageStyleType'
        imageType:
          description: The image set type.
          type: string
          minLength: 0
          maxLength: 80
        hotelId:
          description: The image set hotel code.
          type: string
          minLength: 0
          maxLength: 20
        chainCode:
          description: The image set chain code.
          type: string
          minLength: 0
          maxLength: 20
        imageURL:
          description: The image set URL.
          type: string
          minLength: 0
          maxLength: 2000
        description:
          description: The image set description.
          type: string
          minLength: 0
          maxLength: 2000
        imageOrder:
          description: The image set order.
          type: integer
        website:
          description: The image set website.
          type: string
          minLength: 0
          maxLength: 2000
    ownerProfileTypeEnum:
      type: string
      enum:
      - Owner
      - Referral
      - Regular
    facilityCodeType:
      type: object
      description: Facility Housekeeping Code, its description and quantity.
      properties:
        description:
          description: Facility Code.
          type: string
          minLength: 0
          maxLength: 80
        quantity:
          description: Signifies the quantity.
          type: integer
        code:
          description: Facility code value.
          type: string
          minLength: 0
          maxLength: 20
    eCertificateUsageCriteriaType:
      type: object
      description: E-Certificates details.
      properties:
        reservation:
          description: Indicates if certificate is to be used against reservation or not.
          type: boolean
        web:
          description: Indicates if web certificate can be consumed in OWS.
          type: boolean
        webAllowed:
          description: Indicates if certificate consumption allowable on the web.
          type: boolean
        benefit:
          description: Indicates to attach a rate code to the e-certificate as a benefit.
          type: boolean
        hotel:
          description: Indicates if web certificate can be consumed in hotel.
          type: boolean
        verifyCertificateNo:
          description: Specify if the certificate number verification is required at time of consumption or not.
          type: boolean
        cancelAllowed:
          description: Identify if cancel is allowed or not.
          type: boolean
        generateInLieuCertificate:
          description: Identify if in lieu of certificate can be generated or not.
          type: boolean
    alienInfoType:
      type: object
      description: immigration/visa information of a foreign person.
      properties:
        alienRegistrationNo:
          description: Alien Registration Number.
          type: string
        immigrationStatus:
          description: Immigration Status on an Alien.
          type: string
          minLength: 0
          maxLength: 40
        visaValidityType:
          description: Visa Type of an Alien.
          type: string
          minLength: 0
          maxLength: 40
    currentRoomInfoType:
      type: object
      description: Room information of the reservation for the current day.
      properties:
        roomType:
          description: Current room type.
          type: string
          minLength: 0
          maxLength: 20
        roomId:
          description: Current room number.
          type: string
          minLength: 0
          maxLength: 20
        suggestedRoomNumbers:
          description: Suggested room numbers.
          $ref: '#/components/schemas/codeListType'
        roomDescription:
          description: Current room description.
          type: string
          minLength: 0
          maxLength: 2000
        roomViewCode:
          description: Represents the room view code like City view, River view, Ocean view etc.
          type: string
          minLength: 0
          maxLength: 40
        assignedByAI:
          description: Represents the room was assigned by AI Room Assignment.
          type: boolean
        upgradedByAI:
          description: Represents the room was upgraded by AI Room Assignment.
          type: boolean
    availabilityRatePlanInfo:
      type: object
      description: Response object for fetching rate plans.
      properties:
        availRatePlanInfoType:
          description: Rate plan info based on the search criteria.
          $ref: '#/components/schemas/availRatePlanInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    rateRangeType:
      type: object
      description: Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
      properties:
        base:
          description: The base amount charged for the accommodation or service.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/totalType'
        rateChange:
          description: Rate Change Indicator.
          type: boolean
    amountType:
      type: object
      description: Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.
      properties:
        base:
          description: 'The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.'
          $ref: '#/components/schemas/totalType'
        additionalGuestAmounts:
          description: Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/additionalGuestAmountType'
        discount:
          description: Discount percentage and/or Amount, code and textual reason for discount
          $ref: '#/components/schemas/discountType'
        shareRatePercentage:
          description: Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.
          type: number
          minimum: 0
          maximum: 100
        shareDistributionInstruction:
          description: Last rate share distribution instruction applied on share reservation daily rate segment.
          $ref: '#/components/schemas/shareDistributionInstructionType'
        total:
          description: The total amount charged for this rate including additional occupant amounts and fees.
          $ref: '#/components/schemas/totalType'
        requiredPoints:
          description: The Points contains the number of points required to book a particular room type.
          $ref: '#/components/schemas/pointsType'
        effectiveRate:
          description: The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time
          $ref: '#/components/schemas/totalType'
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
    bedTaxReportingType:
      type: object
      description: This stores the information for Bed Tax Reporting. Mainly used in Maldives.
      properties:
        taxRegistrationNo:
          description: Tax Registration Number for Maldives Bed Tax Reporting.
          type: number
        visaNumber:
          description: Visa number used for Maldives Bed Tax Reporting
          type: string
          minLength: 0
          maxLength: 40
        visaIssueDate:
          description: Visa Issue Date used for Maldives Bed Tax Reporting.
          type: string
          format: date
          maxLength: 8
        visaExpiryDate:
          description: Visa Expiration Date used for Maldives Bed Tax Reporting
          type: string
          format: date
          maxLength: 8
        taxableDays:
          description: Number of days for which the Maldives tax is applicable.
          type: integer
    hotelRateRangeType:
      type: object
      description: The rate rage information of the hotel.
      properties:
        timeSpan:
          description: The Start Date and End Date of the Hotel rate range.
          $ref: '#/components/schemas/timeSpanType'
        minRate:
          description: Minimum Rate offered by the hotel.
          type: number
        maxRate:
          description: Maximum Rate offered by the hotel.
          type: number
        currencyCode:
          description: The base currency code for rate range(The currency code used by the hotel which the rate range belongs to).
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    eCertificateIssueSourceType:
      type: string
      description: Indicates that OPERA E-Certificate is issued by external system.
      enum:
      - Opera
      - Web
      - Interface
    restrictionsByDateRange:
      type: object
      description: Response object for fetching restrictions based on date range.
      properties:
        restrictionsByDateRange:
          description: Response of Restrictions By Date Range
          $ref: '#/components/schemas/fetchRestrictionsByDateRangeRSType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    interfaceRightsStatusType:
      type: object
      properties:
        right:
          description: Internal code for each allowed right of a Hotel Interface record.
          type: integer
        statusCode:
          description: User defined code for an Interface Right.
          type: string
          minLength: 0
          maxLength: 5
        description:
          description: User defined description for an Interface Right.
          type: string
          minLength: 0
          maxLength: 80
        category:
          description: Category code of this interface right.
          type: string
          minLength: 0
          maxLength: 1
    stayReservationInfoType:
      type: object
      description: The Reservation class contains the current reservation being created or altered.
      properties:
        reservationIdList:
          description: Unique identifiers for the reservation for both internal and external systems
          $ref: '#/components/schemas/reservationIdList'
        roomStay:
          description: Collection of room stays.
          $ref: '#/components/schemas/stayInfoType'
        attachedProfiles:
          description: List of attached profiles
          $ref: '#/components/schemas/resAttachedProfileListType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        reservationStatus:
          description: Indicates the status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
        computedReservationStatus:
          description: Indicates the status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
    mailingActionsType:
      type: object
      description: Defines mailing action list for the profile.
      properties:
        mailingAction:
          description: Defines mailing action code and description.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/codeDescriptionType'
        active:
          description: When true indicates that profile has subscribed to the mailing list.
          type: boolean
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    searchAlternateAvailabilityRequest:
      type: object
      properties:
        ratePlanCode:
          type: string
          description: Requested Rate code
        redemption:
          type: boolean
          description: Used to indicate if award redemption flag is to be set.
        roomType:
          type: string
          description: Requested Room type.
        roomId:
          type: string
          description: Requested Room Number.
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        duration:
          type: string
        quantity:
          type: integer
        adults:
          type: integer
          description: Defines the number of Adults.
        children:
          type: integer
          description: Defines the number of Children.
        childAge:
          type: array
          items:
            type: integer
          description: Age of a child in years.
        bucket1Count:
          type: integer
          description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        bucket2Count:
          type: integer
          description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        bucket3Count:
          type: integer
          description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        bucket4Count:
          type: integer
          description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        bucket5Count:
          type: integer
          description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        reservationGuestId:
          type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        reservationGuestIdType:
          type: string
          description: A reference to the type of object defined by the UniqueID element.
        reservationProfileType:
          type: array
          items:
            $ref: '#/components/schemas/reservationProfileTypeEnum'
          description: Type of profile or reservation.
        blockCode:
          type: string
        blockName:
          type: string
        blockId:
          type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        blockIdType:
          type: string
          description: A reference to the type of object defined by the UniqueID element.
        membershipLevel:
          type: string
          description: Membership id Number of the guest.
        membershipType:
          type: string
          description: Membership id Number of the guest.
        controlSegment:
          type: string
          description: Control Segment to check for casion restrction for a patron profile.
    resGuestInfoType:
      type: object
      description: Specifies Company or Travel Agent profile using IATA or Corp. No.
      properties:
        membership:
          description: The Membership object identifying the frequent customer reward program.
          $ref: '#/components/schemas/membershipInfoType'
        namePrefix:
          description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
          $ref: '#/components/schemas/namePrefixType'
        givenName:
          description: Given name, first name or names
          $ref: '#/components/schemas/givenNameType'
        alternateGivenName:
          description: Alternate given name, first name or names
          type: string
          minLength: 0
          maxLength: 40
        middleName:
          description: The middle name of the person name
          type: string
          minLength: 0
          maxLength: 40
        surnamePrefix:
          description: e.g "van der", "von", "de"
          type: string
          minLength: 0
          maxLength: 20
        surname:
          description: Family name, last name.
          $ref: '#/components/schemas/surnameType'
        alternateSurname:
          description: Alternate family name, last name.
          type: string
          minLength: 0
          maxLength: 40
        nameSuffix:
          description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).
          type: string
          minLength: 0
          maxLength: 20
        nameTitle:
          description: Degree or honors (e.g., Ph.D., M.D.)
          type: string
          minLength: 0
          maxLength: 20
        fullName:
          description: Full display name
          type: string
        alternateFullName:
          description: Altername full display name
          type: string
        phoneNumber:
          description: Phone number
          $ref: '#/components/schemas/phoneNumberType'
        email:
          description: Email address
          $ref: '#/components/schemas/basicEmailType'
        birthDate:
          description: Date of birth
          type: string
          format: date
          maxLength: 8
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        nationality:
          description: Affiliation or ethnicity to a particular country.
          $ref: '#/components/schemas/countryNameType'
        vip:
          description: The supplier's ranking of the customer (e.g., VIP, numerical ranking).
          $ref: '#/components/schemas/vIPType'
        address:
          description: Address information that is attached to the reservation guest
          $ref: '#/components/schemas/addressSearchType'
        anonymization:
          description: Provides information about the guest's anonymization status
          $ref: '#/components/schemas/anonymizationType'
        accompanyGuests:
          description: List of guest names that are accompanying the reservation guest
          $ref: '#/components/schemas/resAccompanyGuestListType'
        externalInfo:
          description: External information about the guest associated with the reservation.
          $ref: '#/components/schemas/resGuestExternalInfoType'
        guestLastStayInfo:
          description: Contains information regarding the last stay of this guest.
          $ref: '#/components/schemas/guestLastStayInfoType'
        guestRestrictedCode:
          description: Guest profile restricted reason code
          type: string
        guestRestrictedReasonDesc:
          description: Guest profile restricted reason description
          type: string
        guestRestricted:
          description: True indicates there are restrictions associated with the current profile.
          type: boolean
        registrationCardNo:
          description: Unique identifier of the police registration card number.
          type: string
          minLength: 0
          maxLength: 40
        nameType:
          $ref: '#/components/schemas/nameTypeType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    reservationFolioWindowType:
      type: object
      description: Folio window view which holds the set of folios for a reservation.
      properties:
        payeeInfo:
          description: The window's configured payee information.
          $ref: '#/components/schemas/payeeInfoType'
        balance:
          description: Running balance of the window.
          $ref: '#/components/schemas/currencyAmountType'
        paymentMethod:
          description: Payment Method Type
          type: string
          minLength: 0
          maxLength: 20
        folioWindowNo:
          type: integer
    ratePlanCommissionType:
      type: object
      properties:
        commissionCode:
          description: commission code used by the rate plan.
          type: string
          minLength: 0
          maxLength: 20
        commissionPercentage:
          description: commission percentage used by the rate plan.
          type: number
        commissionAmount:
          description: commission amount used by the rate plan.
          type: number
    profileId:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    searchAnalyzeRateAvailabilityRequest:
      type: object
      properties:
        ratePlanCode:
          type: string
          description: The Rate Code for which the Analysis is requested.
        roomType:
          type: string
          description: The Room Type for which the Analysis is requested. Analysis is done to determine whether the Rate Code is available for this Room Type.
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        duration:
          type: string
        numberOfRooms:
          type: integer
          description: The number of rooms requested. The Analysis to check if this Rate Code is available for this number of rooms.
        adults:
          type: integer
          description: Defines the number of Adults.
        children:
          type: integer
          description: Defines the number of Children.
        childAge:
          type: array
          items:
            type: integer
          description: Age of a child in years.
        bucket1Count:
          type: integer
          description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        bucket2Count:
          type: integer
          description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        bucket3Count:
          type: integer
          description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        bucket4Count:
          type: integer
          description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        bucket5Count:
          type: integer
          description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        blockId:
          type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        blockIdType:
          type: string
          description: A reference to the type of object defined by the UniqueID element.
        reservationId:
          type: array
          items:
            type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        reservationIdType:
          type: array
          items:
            type: string
          description: A reference to the type of object defined by the UniqueID element.
        controlSegment:
          type: string
          description: Control Segment to check for casion restrction for a patron profile.
        reservationGuestId:
          type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
    profileStatusType:
      type: string
      enum:
      - Active
      - Inactive
    masterRestrictionStatusesType:
      type: string
      enum:
      - Closed
      - ClosedForArrival
      - ClosedForDeparture
      - MinimumStayThrough
      - MaximumStayThrough
      - MinimumLengthOfStay
      - MaximumLengthOfStay
      - LOSNotAvailable
      - MinimumAdvanceBooking
      - MaximumAdvanceBooking
      - Open
      - OpenForArrival
      - OpenForDeparture
      - Hurdle
      - MinimumOccupancy
      - MaximumOccupancy
      - RateStrategy
      - RateDetailsNotSet
      - InventoryItemNotAvailable
      - RankRestriction
      - MaximumAuth
      - InventoryNotAvailable
      - RoomClassNotAvailable
      - RoomTypeNotAvailable
      - BlockSellLimit
      - OnRequest
      - CasinoRestriction
    rateAnalysisCodeType:
      type: string
      enum:
      - Closed
      - ClosedForArrival
      - ClosedForDeparture
      - MinimumStayThrough
      - MaximumStayThrough
      - MinimumLengthOfStay
      - MaximumLengthOfStay
      - LOSNotAvailable
      - MinimumAdvanceBooking
      - MaximumAdvanceBooking
      - Open
      - OpenForArrival
      - OpenForDeparture
      - Hurdle
      - MinimumOccupancy
      - MaximumOccupancy
      - RateStrategy
      - RateDetailsNotSet
      - InventoryItemNotAvailable
      - RankRestriction
      - MaximumAuth
      - InventoryNotAvailable
      - RoomClassNotAvailable
      - RoomTypeNotAvailable
      - BlockSellLimit
      - CasinoRestriction
    resGuaranteeSearchType:
      type: object
      description: Contains Search criteria to get applicable Reservation Guarantee Codes.
      properties:
        hotelId:
          description: Hotel Code to request Guarantee Codes.
          type: string
          minLength: 0
          maxLength: 20
        arrivalDate:
          description: Arrival Date of the guest.
          type: string
          format: date
          maxLength: 8
        ratePlanCode:
          description: Rate Plan Code to find associated Guarantee Codes.
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          description: Block ID.
          $ref: '#/components/schemas/blockId'
        resGuestId:
          description: Reservation Guest's Unique ID.
          $ref: '#/components/schemas/uniqueID_Type'
        resAttachedProfiles:
          description: Reservation's Attached Profiles unique IDs.
          $ref: '#/components/schemas/resAttachedProfileListType'
        guaranteeCode:
          description: Guarantee Code should be supplied only for the code verification purpose, if the supplied code is valid for the rest of the criteria it will return the response with the Guarantee Code information.
          type: string
          minLength: 0
          maxLength: 20
        fetchInstruction:
          description: Fetch Instructions for guarantee code
          $ref: '#/components/schemas/resGuaranteeFetchInstructionsType'
        roomStayDetails:
          description: Reservation room stay details.
          $ref: '#/components/schemas/roomStaySearchType'
        roomType:
          description: Room Type for the reservation
          type: string
          minLength: 0
          maxLength: 2000
        reservationPackages:
          description: A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationPackageType'
        resvRateAmount:
          description: Rate amount Before Tax to calculate the total rate on event of rate change.
          $ref: '#/components/schemas/currencyAmountType'
    reservationInterfaceStatusType:
      type: object
      description: Hotel Interface Type for a reservation and status of the various services
      properties:
        roomExtension:
          description: Identifier for the room extension
          type: string
          minLength: 0
          maxLength: 20
        hotelInterface:
          description: Hotel interface information for the reservation
          $ref: '#/components/schemas/hotelInterfaceType'
        interfaceRights:
          description: Contains a list of status/rights for the various services under this interface
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/interfaceRightsStatusType'
    addressSearchType:
      type: object
      description: Address Details such as city, state, country, postal code etc.
      properties:
        cityName:
          description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
          type: string
          minLength: 0
          maxLength: 40
        postalCode:
          description: Post Office Code number.
          type: string
          minLength: 0
          maxLength: 15
        state:
          description: State or Province name (e.g., Texas).
          type: string
          minLength: 0
          maxLength: 20
        country:
          description: Country name (e.g., Ireland).
          $ref: '#/components/schemas/countryNameType'
        streetAddress:
          description: First Line of Street Address. For profile search it matches the first Address line.
          type: string
          minLength: 0
          maxLength: 80
        excludeNoCity:
          description: When true indicates that only profiles with city will be fetched.
          type: boolean
    depositPolicyType:
      type: object
      description: Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
      properties:
        amountPercent:
          description: Payment expressed as a fixed amount, or a percentage of/or room nights.
          $ref: '#/components/schemas/policyAmountPercentType'
        deadline:
          description: Payment deadline, absolute or relative.
          $ref: '#/components/schemas/policyDeadlineType'
        description:
          description: Text description of the Payment in a given language.
          type: string
          minLength: 0
          maxLength: 2000
        depositReceiptNo:
          description: Receipt number associated with the deposit policy
          type: integer
        transactionDate:
          description: Transaction Date associated with the deposit policy
          type: string
          format: date
          maxLength: 8
        depositReqReversed:
          description: Flag to indicate if deposit policy is reversed
          type: boolean
        formattedRule:
          description: Formatted Text Rule of the deposit policy.
          type: string
          minLength: 0
          maxLength: 2000
        typeOfCharges:
          description: Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both
          $ref: '#/components/schemas/depositCancelRevenueType'
        policyCode:
          description: Deposit Policy Code
          type: string
          minLength: 0
          maxLength: 20
        manual:
          description: Flag to indicate if the cancellation policy is manual.
          type: boolean
    commissionPayoutToType:
      type: string
      enum:
      - TravelAgent
      - Source
      - TravelAgentSource
      - None
    childAgesType:
      type: array
      description: Age of a child in years.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/childAgeType'
    hotelAttractionType:
      type: object
      description: Information about the attractions near the hotel.
      properties:
        name:
          description: Attraction name for the hotel.
          $ref: '#/components/schemas/translationTextType2000'
        type:
          description: The type of the attraction.
          type: string
          minLength: 0
          maxLength: 60
        class:
          description: The class of the attraction.
          type: string
          minLength: 0
          maxLength: 60
        generalDirections:
          description: Directions to the attraction from the hotel.
          type: string
          minLength: 0
          maxLength: 2000
        relativePosition:
          $ref: '#/components/schemas/relativePositionType'
        address:
          description: Address of the attraction.
          $ref: '#/components/schemas/addressType'
        website:
          description: Website for the attraction.
          $ref: '#/components/schemas/uRLType'
        priceRange:
          description: Price range for the attraction.
          type: string
          minLength: 0
          maxLength: 40
        operationHours:
          description: Price range for the attraction.
          type: string
          minLength: 0
          maxLength: 20
        displaySeq:
          description: Display sequence of the attraction.
          type: integer
        code:
          type: string
          minLength: 0
          maxLength: 20
    currencyExchangeRatesType:
      type: array
      description: Exchange Rate information for a currency code.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/currencyExchangeRateType'
    lastStayInfoType:
      type: object
      description: Contains last stay related details for the profile
      properties:
        lastVisit:
          description: Used to hold last stay information for the profile.
          type: string
          format: date
          maxLength: 8
        lastRoom:
          description: Used to hold last room information for the profile.
          type: string
        lastRate:
          description: Used to hold last rate information for the profile.
          $ref: '#/components/schemas/currencyAmountType'
        totalStay:
          description: The total number of previous stay of the profile.
          type: integer
    cardTypeType:
      type: string
      description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
      enum:
      - Ab
      - Am
      - Ax
      - Cb
      - Dc
      - Ds
      - Dt
      - Ec
      - Er
      - Jc
      - Jl
      - Mc
      - Nb
      - So
      - St
      - Sw
      - Va
      - Xy
      - Zz
      - Cp
      - Cu
    profileSharedLevelType:
      type: string
      description: Simple types for Shared level.
      enum:
      - Global
      - Property
      - Cro
    hotelRestaurantType:
      type: object
      description: Information about the Restaurants in the hotel.
      properties:
        restaurantName:
          description: The name of the Restaurant.
          type: string
          minLength: 0
          maxLength: 1000
        restaurantType:
          description: The Type of Restaurant.
          type: string
          minLength: 0
          maxLength: 1000
        hours:
          description: The Hours of Operation of the Restaurant.
          type: string
          minLength: 0
          maxLength: 1000
        priceRange:
          description: The price range of the Restaurant.
          type: string
          minLength: 0
          maxLength: 40
        comments:
          description: Comments about the Restaurant.
          type: string
          minLength: 0
          maxLength: 2000
        category:
          description: The category that the Restaurant belongs to.
          $ref: '#/components/schemas/restaurantCategoryType'
        timeSpan:
          description: The Start Date and End Date of the Restaurant.
          $ref: '#/components/schemas/timeSpanType'
        newRestaurantCode:
          description: The new Restaurant Code which is used in the change method.
          type: string
          minLength: 0
          maxLength: 20
        restaurantCode:
          type: string
          minLength: 0
          maxLength: 20
        orderBy:
          type: integer
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    reservationFolioWindowsType:
      type: array
      description: Collection of reservation folio windows.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationFolioWindowType'
    packageCodeHeaderType:
      type: object
      properties:
        primaryDetails:
          description: Package code header primary details.
          $ref: '#/components/schemas/configPackagePrimaryDetailsType'
        transactionDetails:
          description: Package code header transaction information.
          $ref: '#/components/schemas/configPackageTransactionType'
        postingAttributes:
          description: Package code posting attributes.
          $ref: '#/components/schemas/configPostingAttributesType'
        usageDetails:
          description: Package code usage information.
          $ref: '#/components/schemas/configPackageUsageDetailType'
    resAccessRestrictionType:
      type: string
      description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
      enum:
      - Change
      - Cancel
      - ChangeOrCancel
    createRestrictionType:
      type: object
      properties:
        restrictionStatus:
          description: Indicates the type of the restriction.
          $ref: '#/components/schemas/restrictionStatusType'
        ratePlanCodes:
          description: The rate code for which the restriction will be applied.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        rateClasses:
          description: The rate class for which the restriction will be applied.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        roomClasses:
          description: The room class for which the restriction will be applied.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        bookingChannels:
          description: Booking channel.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        roomTypes:
          description: The room type for which the restriction will be applied.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        ratePlanCategories:
          description: The rate category for which the restriction will be applied.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        seasonCode:
          description: The season code during which the restrictions are valid.
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          description: Unique block identifier of the block for which restriction will be applied.
          $ref: '#/components/schemas/blockId'
        bookingChannelOnRequest:
          description: Booking channel on request.
          type: string
          minLength: 0
          maxLength: 1
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
        sunday:
          type: boolean
        monday:
          type: boolean
        tuesday:
          type: boolean
        wednesday:
          type: boolean
        thursday:
          type: boolean
        friday:
          type: boolean
        saturday:
          type: boolean
        yieldStatus:
          description: Yield status condition.
          $ref: '#/components/schemas/roomTypeYieldableType'
        hotelId:
          description: The property to which the restriction is applied.
          type: string
          minLength: 0
          maxLength: 20
    commentInfoType:
      type: object
      description: Comment related to the profile/reservation.
      properties:
        comment:
          description: Comment details for the comment. It will be empty in case of delete comment.
          $ref: '#/components/schemas/commentType'
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    reservationIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    hotelContactRoleType:
      type: string
      description: The contact's role in the hotel. Possible values are Lead, General, and Contract.
      enum:
      - Lead
      - General
      - Contract
    upsellDailyRateType:
      type: object
      description: Reservation date and its corresponding upsell rate amount
      properties:
        date:
          description: Reservation date
          type: string
          format: date
          maxLength: 8
        requiredAmount:
          description: Amount / number of points required to upgrade
          $ref: '#/components/schemas/amountPointsType'
    directBillingType:
      type: object
      description: This is the preconfigured routing instruction type.
      properties:
        hotelId:
          description: Hotel Code for which the details of direct billing is provided for a profile.
          type: string
          minLength: 0
          maxLength: 20
        aRNumber:
          description: Hotel Code for which the details of direct billing is provided for a profile.
          type: string
          minLength: 0
          maxLength: 20
    eCertificateStatusType:
      type: string
      description: Indicates that OPERA E-Certificate is reserved.
      enum:
      - Cancelled
      - Consumed
      - Deleted
      - Expired
      - Issued
      - Reserved
    eCertificateScopeType:
      type: string
      description: Indicates that OPERA E-Certificate is available for a specific list of hotels.
      enum:
      - Global
      - Hotel
      - MultiHotel
    queueTextInfoType:
      type: object
      description: Information regarding the message sent to guest.
      properties:
        sentTime:
          description: Time the text was last sent to the user.
          type: string
          format: date-time
        sentBy:
          description: User name of the user who sent message.
          type: string
          minLength: 0
          maxLength: 40
    hurdleRatesEditType:
      type: array
      description: Details for hurdle rate to be modified.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hurdleRateEditType'
    gdsNegotiatedInfoType:
      type: object
      description: This provides information for a channel negotiated rate.
      properties:
        accessCode:
          description: The GDS negotiated rate code.
          type: string
          minLength: 0
          maxLength: 20
        order:
          description: The sell order.
          type: integer
        inactive:
          description: The GDS Negotiated Rate is inactive or not
          type: boolean
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
    eCertificateGenerationType:
      type: object
      description: E-Certificates details.
      properties:
        ruleId:
          description: Key to identify the generation rule id.
          $ref: '#/components/schemas/uniqueID_Type'
        generationDetail:
          description: Reason for which e-certificate was generated.
          type: string
          minLength: 0
          maxLength: 4000
        referenceValue:
          description: Type of value that is in the certificate.valid values are membership_level.
          type: string
          minLength: 0
          maxLength: 20
    amountPointsType:
      type: object
      description: Holds monetary value expressed with a currency code / number of points
      properties:
        amount:
          description: Monetary value expressed with a currency code
          $ref: '#/components/schemas/currencyAmountType'
        points:
          description: Number of points
          type: integer
    eCertificatesType:
      type: array
      description: List of e-certificates for the profile.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/eCertificateType'
    keywordType:
      type: object
      properties:
        keywordDetail:
          description: The keyword new value, in case keyword value is modified.
          $ref: '#/components/schemas/keywordDetailType'
        type:
          description: The type of keyword
          type: string
          minLength: 0
          maxLength: 20
        keyword:
          description: The keyword value.
          type: string
          minLength: 0
          maxLength: 80
    childBucketsType:
      type: object
      description: Defines children counts with Age Qualifying Group(Child Bucket) classification.
      properties:
        bucket1Count:
          description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
          type: integer
        bucket2Count:
          description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
          type: integer
        bucket3Count:
          description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
          type: integer
        bucket4Count:
          description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
          type: integer
        bucket5Count:
          description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
          type: integer
    changeHurdleRates:
      type: object
      description: Request object for changing existing Hurdle Rates.
      properties:
        hurdleRates:
          description: Details of the Hurdle Rates to be changed.
          $ref: '#/components/schemas/hurdleRatesEditType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileTaxInfoType:
      type: object
      description: Profile information related to tax.
      properties:
        tax1No:
          description: The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.
          type: string
          minLength: 0
          maxLength: 40
        tax2No:
          description: Tax 2 id of this profile.
          type: string
          minLength: 0
          maxLength: 40
        taxCategory:
          description: Tax Category to be changed.
          type: string
          minLength: 0
          maxLength: 20
        taxOffice:
          description: Tax Office to be changed.
          type: string
          minLength: 0
          maxLength: 30
        taxType:
          description: Tax type to be changed.
          type: string
          minLength: 0
          maxLength: 20
        businessId:
          description: Business ID. The maximum length of this element should not exceed 120 characters.
          type: string
          minLength: 0
          maxLength: 128
        businessRegistration:
          description: Business Registration Code. The maximum length of this element should not exceed 120 characters.
          type: string
          minLength: 0
          maxLength: 128
    aRAccountShortInfoType:
      type: object
      description: Accounts Receivabales Account details type charged for batched posting.
      properties:
        accountName:
          description: Name of the AR Account.
          type: string
          minLength: 0
          maxLength: 200
        accountId:
          description: The unique ID for the Account.
          $ref: '#/components/schemas/uniqueID_Type'
        accountNo:
          description: The Account Number for the Account.
          type: string
          minLength: 0
          maxLength: 20
        status:
          description: The status of the account.
          $ref: '#/components/schemas/aRAccountStatusType'
    roomRateType:
      type: object
      properties:
        total:
          $ref: '#/components/schemas/totalType'
        totalPoints:
          $ref: '#/components/schemas/pointsType'
        rates:
          $ref: '#/components/schemas/ratesType'
        packages:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/packageElementType'
        stayProfiles:
          description: Profile associated with the room Stay.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationProfileType'
        guestCounts:
          description: A collection of Guest Counts associated with the room rate.
          $ref: '#/components/schemas/guestCountsType'
        taxFreeGuestCounts:
          description: A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.
          $ref: '#/components/schemas/guestCountsType'
        awards:
          description: Membership Awards code applied on the reservation.
          $ref: '#/components/schemas/resAwardsType'
        foreignExchange:
          description: Exchange Type information for the postings.
          $ref: '#/components/schemas/foreignExchangeType'
        reservationBlock:
          description: Key information about the block for this reservation.
          $ref: '#/components/schemas/reservationBlockType'
        roomRateInfo:
          description: Information about the Room Rate Combination.
          type: string
          minLength: 0
          maxLength: 2000
        mealPlans:
          description: Meal plan codes for rate plan code.
          $ref: '#/components/schemas/mealPlansType'
        roomType:
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          type: string
          minLength: 0
          maxLength: 20
        guaranteedYn:
          type: string
          minLength: 0
          maxLength: 1
        promotionCode:
          type: string
          minLength: 0
          maxLength: 20
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
        availability:
          description: Used to specify an availability status for the room rate. When available value could be either not specified or "Available".
          $ref: '#/components/schemas/roomRateAvailReasonType'
        suppressRate:
          type: boolean
        marketCode:
          description: The code that relates to the market being sold to (e.g., the corporate market, packages).
          type: string
          minLength: 0
          maxLength: 20
        marketCodeDescription:
          description: Description of the market code.
          type: string
          minLength: 0
          maxLength: 4000
        sourceCode:
          description: To specify where the business came from e.g. radio, newspaper ad, etc.
          type: string
          minLength: 0
          maxLength: 20
        sourceCodeDescription:
          description: Description of the source of business.
          type: string
          minLength: 0
          maxLength: 4000
        numberOfUnits:
          description: The number of rooms.
          type: integer
        roomId:
          description: A string value representing the unique identification of a room.
          type: string
          minLength: 0
          maxLength: 20
        pseudoRoom:
          description: True indicates as pseudo room type. This is usually used for a posting master reservation.
          type: boolean
        roomTypeCharged:
          description: Room Type used for the Rate calculation.
          type: string
          minLength: 0
          maxLength: 20
        commissionCode:
          description: Commission Code applicable for commission calculation for Travel Agent/Company.
          type: string
          minLength: 0
          maxLength: 20
        commissionable:
          description: Indicates Commission is applicable for commission calculation for Travel Agent/Company.
          type: boolean
        houseUseOnly:
          description: Indicates this reservation is for House use.
          type: boolean
        complimentary:
          description: Indicates this reservation rate is complimentary.
          type: boolean
        inventoryLender:
          description: Indicates whether the room type inventory was taken from the allotment or House availability.
          type: string
        fixedRate:
          description: Fixed Rate Indicator.
          type: boolean
        barRanking:
          description: Best Available rates ranking.
          type: integer
        rateGroup:
          description: For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.
          type: string
          minLength: 0
          maxLength: 20
        discountAllowed:
          description: Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.
          type: boolean
        bogoDiscount:
          description: Indicates if the Rate Code has BOGO(Bye one Get one) indicator.
          type: boolean
        rateLevel:
          description: Rate plan type like Corporate,Regular,Military,Weekend etc.
          type: string
          minLength: 0
          maxLength: 20
        commissionPercentage:
          description: Indicates commission percentage used by the rate plan.
          type: integer
        commissionAmount:
          description: Indicates commission amount used by the rate plan.
          type: integer
        credentialsRequired:
          description: If true, indicates that credentials is required to sell the rate code.
          type: boolean
        taxIncluded:
          description: If true, indicates if tax is included in the rate code.
          type: boolean
        rateDescription:
          description: Rate code description.
          type: string
          minLength: 0
          maxLength: 4000
        offshoreRate:
          type: boolean
          description: If true, indicates that rate code is Offshore Rate.
    reservationTurndownInfoType:
      type: object
      description: Turndown information for a reservation
      properties:
        allowed:
          description: Indicates if turndown is allowed or not
          type: boolean
        status:
          description: Indicates turndown status, values could be required, not required, completed
          $ref: '#/components/schemas/turndownStatusType'
    createRestriction:
      type: object
      description: Request object for creating a new restriction.
      properties:
        restriction:
          $ref: '#/components/schemas/createRestrictionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomTypeMasterInfoType:
      type: object
      description: The RoomType element is used to contain all the room type information for a single room type.
      properties:
        roomType:
          description: Room type information
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomTypeInfoType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    resProfileTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Group
      - TravelAgent
      - Source
      - ReservationContact
      - BillingContact
      - Addressee
    availResponseMasterInfoType:
      type: object
      description: Availability master info type
      properties:
        roomTypes:
          description: Collection of room type information
          $ref: '#/components/schemas/roomTypeMasterInfoType'
        ratePlans:
          description: Collection of rate plan information
          $ref: '#/components/schemas/availRatePlanInfoType'
    codeListType:
      type: array
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    futureListType:
      type: object
      description: A collection of reservation history details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : Future reservation details'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationInfoType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    sellMessageType:
      type: object
      description: The SellMessagesType defines the standard attributes that will be retrieved with the sell message.
      properties:
        message:
          description: This is the message text.
          type: string
          minLength: 0
          maxLength: 2000
        croCode:
          description: This is the Central Reservation office code.
          type: string
          minLength: 0
          maxLength: 20
        chainCode:
          description: This is the chain code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: This is the hotel code or resort.
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: This represents the room type code.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: This represents the rate plan code of the room type.
          type: string
          minLength: 0
          maxLength: 20
        languageCode:
          description: This is the language code.
          type: string
          minLength: 0
          maxLength: 20
        stickyFlagYn:
          description: Flag which tells if this message is Sticky (Y/N).
          type: string
          minLength: 0
          maxLength: 1
        usedInModule:
          description: This represents the correct moduletype which should be used for fetching SellMessages.
          $ref: '#/components/schemas/usedInModuleType'
        beginDate:
          description: This is the Begin date for the configured SellMessage.
          type: string
          format: date
          maxLength: 8
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    hotelSetupStylesType:
      type: array
      description: List of event space setup style codes.
      maxItems: 5
      items:
        type: string
        minLength: 0
        maxLength: 20
    channelMarketingInfoType:
      type: array
      description: Marketing Text like cancel policy, deposit policy etc.
      maxItems: 4000
      items:
        type: object
        properties:
          description:
            description: Marketing Text like cancel policy, deposit policy etc.
            type: string
            minLength: 0
            maxLength: 4000
          policyType:
            description: Indicates the policy type like cancel,deposit etc.
            $ref: '#/components/schemas/marketingPolicyType'
          ratePlanCode:
            description: Indicates the rate code for which the policy is associated with.
            type: string
            minLength: 0
            maxLength: 20
    reservationStayHistoryFutureInfoType:
      type: object
      description: Information of History and Future Reservation details attached to Profiles.
      properties:
        historyList:
          description: Refer to History list type document.
          $ref: '#/components/schemas/stayHistoryListType'
        futureList:
          description: Refer to Future list type document.
          $ref: '#/components/schemas/stayFutureListType'
    packagePostingRhythmType:
      type: object
      description: Package Posting rhythm type.
      properties:
        everyXNightsStartingNightY:
          description: Post the package every X nights Staring from Night Y.
          type: object
          properties:
            startOnNightY:
              description: Starting night for consumption and posting prices.
              type: integer
            postEveryXNights:
              description: Occurance of nights when the package needs to be posted and consumed.
              type: integer
        certainNightsOfTheWeek:
          description: Post the package on certain nights of the week.
          type: object
          properties:
            sunday:
              type: boolean
            monday:
              type: boolean
            tuesday:
              type: boolean
            wednesday:
              type: boolean
            thursday:
              type: boolean
            friday:
              type: boolean
            saturday:
              type: boolean
        customStaySchedule:
          description: This user defined schedule lets you enter a posting rhythm over a 14-day period, starting with the arrival date, by assigning the day (number) within a guest stay for posting this package price.
          type: object
          properties:
            night1:
              description: Night 1 indicator.
              type: boolean
            night2:
              description: Night 2 indicator.
              type: boolean
            night3:
              description: Night 3 indicator.
              type: boolean
            night4:
              description: Night 4 indicator.
              type: boolean
            night5:
              description: Night 5 indicator.
              type: boolean
            night6:
              description: Night 6 indicator.
              type: boolean
            night7:
              description: Night 7 indicator.
              type: boolean
            night8:
              description: Night 8 indicator.
              type: boolean
            night9:
              description: Night 9 indicator.
              type: boolean
            night10:
              description: Night 10 indicator.
              type: boolean
            night11:
              description: Night 11 indicator.
              type: boolean
            night12:
              description: Night 12 indicator.
              type: boolean
            night13:
              description: Night 13 indicator.
              type: boolean
            night14:
              description: Night 14 indicator.
              type: boolean
        customNightSchedule:
          description: 'The start and end of the posting period is determined as follows: If the package is attached to a rate code: The period starts with the date when the rate code to which the package is attached becomes effective for the stay. The period ends with the date of the last night for that rate code (or the last night of the stay if the rate code remains in effect until the departure date). If the package is attached separately to the reservation: The Begin Date specified on the reservation when the package was attached is the start date for the period. The End Date specified on the reservation when the package was attached is the end date for the period. If no Begin Date and/or End Date are specified when the package is attached to the reservation, the Begin Date is assumed to be the arrival date and the End Date is assumed to be the departure date of the reservation, irrespective of when the package is attached to the reservation.'
          type: object
          properties:
            night1:
              description: Night 1 indicator.
              type: boolean
            night2:
              description: Night 2 indicator.
              type: boolean
            night3:
              description: Night 3 indicator.
              type: boolean
            night4:
              description: Night 4 indicator.
              type: boolean
            night5:
              description: Night 5 indicator.
              type: boolean
            night6:
              description: Night 6 indicator.
              type: boolean
            night7:
              description: Night 7 indicator.
              type: boolean
            night8:
              description: Night 8 indicator.
              type: boolean
            night9:
              description: Night 9 indicator.
              type: boolean
            night10:
              description: Night 10 indicator.
              type: boolean
            night11:
              description: Night 11 indicator.
              type: boolean
            night12:
              description: Night 12 indicator.
              type: boolean
            night13:
              description: Night 13 indicator.
              type: boolean
            night14:
              description: Night 14 indicator.
              type: boolean
        type:
          description: Posting Rhythm for the package.
          $ref: '#/components/schemas/postingRhythmType'
    commentType:
      type: object
      description: An indication of a new paragraph for a sub-section of a formatted text message.
      properties:
        text:
          description: Formatted text content.
          $ref: '#/components/schemas/formattedTextTextType'
        image:
          description: An image for this paragraph.
          type: string
        url:
          description: A URL for this paragraph.
          type: string
        commentTitle:
          description: Specifies Comment's Title.
          type: string
          minLength: 0
          maxLength: 4000
        notificationLocation:
          description: Notification Location associated with the Note.
          type: string
          minLength: 0
          maxLength: 20
        type:
          description: Specifies type of the comment.
          type: string
          minLength: 0
          maxLength: 20
        typeDescription:
          description: Comment type Description.
          type: string
          minLength: 0
          maxLength: 200
        internal:
          description: When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.
          type: boolean
        confidential:
          description: When true, the comment may be confidential.
          type: boolean
        overrideInternal:
          description: When true, the note internal could be modified.
          type: boolean
        protectDescription:
          description: When true, the note title will be populated from the note type description and couldn't be modified.
          type: boolean
        hotelId:
          description: If specified comment belongs to the Hotel, otherwise it is a global comment.
          type: string
          minLength: 0
          maxLength: 20
        actionType:
          description: Specifies type of action described in the comments.
          type: string
          minLength: 0
          maxLength: 20
        actionDate:
          description: Indicates at which date an action described in the comment must be taken.
          type: string
          format: date
          maxLength: 8
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
    functionArgumentType:
      type: object
      description: This type provided details of a function argument and the value it holds.
      properties:
        name:
          description: Specifies the name of the function argument.
          type: string
          minLength: 0
          maxLength: 200
        value:
          description: Specifies the value held by the function argument.
          type: string
          minLength: 0
          maxLength: 200
        position:
          description: Specifies the position of the function argument in the argument list.
          type: integer
        dataType:
          description: Specifies the datatype of the function argument.
          type: string
          minLength: 0
          maxLength: 40
        required:
          description: Argument of the function mandatory or not.
          type: boolean
        useLovYn:
          description: Specifies if the function argument is an lov or not.
          type: boolean
        lovAllowMultiSelectYn:
          description: Specifies if the function argument lov is single select or multi select lov.
          type: boolean
        lovName:
          description: Specifies the lov name of the function argument.
          type: string
          minLength: 0
          maxLength: 100
    translationTextType80:
      type: object
      description: Contains Multiple translated texts and language codes.
      properties:
        defaultText:
          description: Default text with Character length from 0 to 80.
          type: string
          minLength: 0
          maxLength: 80
        translatedTexts:
          description: List of translated text and language codes.
          $ref: '#/components/schemas/translationsTextType'
    hotelContactsType:
      type: array
      description: Lists of contacts of the hotel.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelContactType'
    availResponseSegmentType:
      type: object
      properties:
        roomStays:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomStayType'
        masterInfo:
          $ref: '#/components/schemas/availResponseMasterInfoType'
        hotelAlert:
          description: Hotel Alert Message.
          type: string
          minLength: 0
          maxLength: 2000
        restriction:
          description: Indicates the restriction types.
          $ref: '#/components/schemas/masterRestrictionStatusesType'
        rateChange:
          description: Indicates the amount returned is FIRSTNIGHT/HIGHEST/LOWEST/MOSTCOMMON/AVERAGE when there is rate change in the stay dates.
          $ref: '#/components/schemas/rateChangeTypeType'
        hotelInfo:
          description: Hotel information like hotel name,address,communication etc and also alternate hotel information if requested property is not available.
          $ref: '#/components/schemas/hotelInfoType'
        channelInformation:
          description: Channel related information if availability request is send for a channel.
          $ref: '#/components/schemas/channelAvailRSInfoType'
        ratePlanSet:
          description: Rate Plan Set whose Rate Plans are returned in the response.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel Code whose Rate Plans are returned in the response.
          type: string
          minLength: 0
          maxLength: 20
        closed:
          description: If the availability response has a house level restriction, this flag will be true.
          type: boolean
        redemption:
          description: Used to indicate if the Room Rates returned are calculated based on points.
          type: boolean
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
        pagingKey:
          description: Used to indicate the paging key(rate room) when more rate rooms available.
          type: string
    nameTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Agent
      - Contact
      - Source
      - Group
      - Employee
      - Hotel
      - Purge
    membershipInfoType:
      type: object
      description: The Membership object identifies the frequent customer reward program.
      properties:
        membershipId:
          description: Membership ID (Unique ID from the memberships table).
          type: number
        programCode:
          description: The code or name of the membership program ('Hertz', 'AAdvantage', etc.).
          type: string
          minLength: 0
          maxLength: 20
        bonusCode:
          description: The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)
          type: string
          minLength: 0
          maxLength: 20
        membershipTypeDesc:
          description: The description of the ProgramCode.(Delta Previlige for code DP)
          type: string
          minLength: 0
          maxLength: 2000
        membershipLevelDesc:
          description: The description of the Bonus Code.(Platinum for code P)
          type: string
          minLength: 0
          maxLength: 2000
        accountId:
          description: The account identification number for this particular member in this particular program.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.
          type: string
          minLength: 0
          maxLength: 20
        playerRanking:
          description: Ranking assigned to the Player Profile by the Gaming system.
          type: integer
    payeeInfoType:
      type: object
      description: Payee information.
      properties:
        payeeId:
          description: Opera name id of the payee.
          $ref: '#/components/schemas/uniqueID_Type'
        payeeName:
          description: Name of the payee.
          type: string
          minLength: 0
          maxLength: 80
        payeeAddress:
          description: Address of the payee.
          $ref: '#/components/schemas/addressInfoType'
        payeeAddressCount:
          description: Payee multiple address count.
          type: integer
        payeeReferenceCurrency:
          description: Reference currency of the payee.
          type: string
          minLength: 0
          maxLength: 20
        payeeAccountInfo:
          description: AR account short info of the payee.
          $ref: '#/components/schemas/aRAccountShortInfoType'
        payeeTaxNumber:
          description: The tax number of the payee.
          type: string
          minLength: 0
          maxLength: 40
    blockIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    stringLength20:
      type: string
      description: Used for Character Strings, length 0 to 20.
      maxLength: 20
      minLength: 0
    hotelContactType:
      type: object
      description: Contact identification details.
      properties:
        nameId:
          description: Contact or employee identifier..
          $ref: '#/components/schemas/uniqueID_Type'
        hotelId:
          description: The code of the hotel.
          type: string
          minLength: 0
          maxLength: 20
        name:
          description: Name of the hotel contact.
          type: string
          minLength: 0
          maxLength: 2000
        roles:
          description: List of HotelContactType.
          $ref: '#/components/schemas/hotelContactRolesType'
        ownerCode:
          description: The contact's code in the hotel.
          type: string
          minLength: 0
          maxLength: 20
        communicationMethod:
          description: The preferred method of communication for the contact.
          type: string
          minLength: 0
          maxLength: 20
        communicationAddress:
          description: 'Details about the preferred communication method. Example: email address, fax number, etc.'
          type: string
          minLength: 0
          maxLength: 80
        primary:
          description: Primary flag.
          type: boolean
    resMobileNotificationsType:
      type: object
      description: Contains the status of Room Ready and Key Ready messages.
      properties:
        roomReady:
          description: Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED
          $ref: '#/components/schemas/communicationStatusType'
        keyReady:
          description: Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED
          $ref: '#/components/schemas/communicationStatusType'
        checkoutMessageReceived:
          description: Indicates if the Mobile checkout message is received.
          type: boolean
        requiresAction:
          description: Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout
          type: boolean
        errorMessage:
          description: Error message when Mobile Notification has failed.
          type: string
    guaranteeRequirementsType:
      type: object
      description: Specifies various requirement for the guarantee code.
      properties:
        requirementCode:
          description: Requirement Code.
          type: string
        cancellation:
          description: When true indicates cancellation on the reservation is required for this guarantee code.
          type: boolean
        phoneNumber:
          description: When true indicates phone number on the reservation is required for this guarantee code.
          type: boolean
        address:
          description: When true indicates address on the reservation is required for this guarantee code.
          type: boolean
        creditCard:
          description: When true indicates Credit Card on the reservation is required for this guarantee code.
          type: boolean
        arrivalTime:
          description: When true indicates arrival Time on the reservation is required for this guarantee code.
          type: boolean
        deposit:
          description: When true indicates deposit is required for this guarantee code.
          type: boolean
    sourceOfSaleType:
      type: object
      description: Point of Sale of reservation. Identifies the entity/channel who made the reservation.
      properties:
        sourceType:
          description: Type of entity/channel who made the reservation..
          type: string
          minLength: 0
          maxLength: 40
        sourceCode:
          description: The entity/channel who made the reservation.
          type: string
          minLength: 0
          maxLength: 20
    alternateHotelsType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/alternateHotelType'
    historyListType:
      type: object
      description: A collection of reservation history details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : History reservation details'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationInfoType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    roomFeaturesType:
      type: array
      description: A recurring element that identifies the room features.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomFeatureType'
    usedInModuleType:
      type: string
      description: Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control.
      enum:
      - Blocks
      - Reservations
      - FunctionDiary
      - LookToBookSales
      - GroupRoomsControl
    hotelAttractionsType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelAttractionType'
    roomStayType:
      type: object
      properties:
        registrationNumber:
          description: Registration Number of the reservation for the current day.
          $ref: '#/components/schemas/uniqueID_Type'
        currentRoomInfo:
          description: Room information of the reservation for the current day.
          $ref: '#/components/schemas/currentRoomInfoType'
        roomRates:
          description: A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomRateType'
        guestCounts:
          $ref: '#/components/schemas/guestCountsType'
        arrivalDate:
          type: string
          format: date
        departureDate:
          type: string
          format: date
        expectedTimes:
          description: The Expected Arrival and Departure Times.
          $ref: '#/components/schemas/resExpectedTimesType'
        originalTimeSpan:
          description: The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.
          $ref: '#/components/schemas/timeSpanType'
        guarantee:
          description: The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.
          $ref: '#/components/schemas/resGuaranteeType'
        promotion:
          description: Promotions applied to the reservation to get the promotional rate.
          $ref: '#/components/schemas/promotionType'
        suiteWith:
          description: Connecting Rooms.
          type: string
          minLength: 0
          maxLength: 200
        total:
          description: The total amount charged for the Room Stay.
          $ref: '#/components/schemas/totalType'
        totalPoints:
          description: The total number of Points charged for the Room Stay.
          $ref: '#/components/schemas/pointsType'
        multiValueAttrs:
          description: Informative indicators indicating different values of an attribute exists over the stay.
          type: array
          maxItems: 4000
          items:
            type: string
            maxLength: 2000
        upsellInfo:
          description: Indicates Upsell Information to be applied on Reservation.
          $ref: '#/components/schemas/upsellInfoType'
        mobileNotifications:
          description: Denotes the status of Room Ready and Key Ready messages.
          $ref: '#/components/schemas/resMobileNotificationsType'
        roomNumberLocked:
          description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.
          type: boolean
        printRate:
          description: This control whether rate info will be printed in confirmation letter.
          type: boolean
        ownerReservationType:
          description: Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation.
          $ref: '#/components/schemas/ownerResTypeType'
        primaryShareType:
          description: This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed.
          $ref: '#/components/schemas/primaryShareTypeType'
        remoteCheckInAllowed:
          description: Indicates whether the reservation is pre-registered for internet check-in or not.
          type: boolean
        bookingMedium:
          description: Classifies the medium(Channel field on reservation screen) through which the reservation is made.
          type: string
          minLength: 0
          maxLength: 20
        bookingMediumDescription:
          description: Description of the booking medium.
          type: string
          minLength: 0
          maxLength: 2000
        availableUpsellOfferCount:
          description: Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request
          type: integer
    webUserAccountsType:
      type: array
      description: Web User Accounts List.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/webUserAccountType'
    guestLastStayInfoType:
      type: object
      description: Contains last stay related details of the guest.
      properties:
        lastStayDate:
          description: Guest's last stay date.
          type: string
          format: date
          maxLength: 8
        lastStayRoom:
          description: Room Number where the guest stayed.
          type: string
          minLength: 0
          maxLength: 20
        lastStayRate:
          description: The Rate amount of the guest's last stay.
          $ref: '#/components/schemas/currencyAmountType'
        totalStay:
          description: The total number of previous stay of the guest.
          type: integer
    emailInfoType:
      type: object
      description: Information on an email for the customer.
      properties:
        email:
          description: eMail deatils for the profile.
          $ref: '#/components/schemas/emailType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    ratesType:
      type: object
      description: Individual rate amount.
      properties:
        rate:
          description: The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/amountType'
        rateRange:
          description: Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/rateRangeType'
    facilityCodesType:
      type: array
      description: List of the facility codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/facilityCodeType'
    searchHotelAvailabilityCRORequest:
      type: object
      properties:
        cro:
          type: array
          items:
            type: string
          description: Central reservation office Code who is requesting Rate Availability.
        hotelIds:
          type: array
          items:
            type: string
          description: Hotel code of the Hotel whose Rate Availability is requested.
        includeClosedRates:
          type: array
          items:
            type: boolean
          description: Used to indicate if closed rates are to be included in the Rate Plan set.
        includeDefaultRatePlanSet:
          type: array
          items:
            type: boolean
          description: Used to indicate if the configured default rate plan set will be included.
        includeNoRatePlanSet:
          type: array
          items:
            type: boolean
          description: Includes the rate codes which do not have a rate plan set associated. This parameter is applicable when the property has not configured a default rate plan set.
        initialRatePlanSet:
          type: array
          items:
            type: boolean
          description: If InitialRatePlanSet is set to true response will return most relevant Rate Plan Set(e.g. NEGOTIATED if profiles has Negotiated Rates) depending on the request. if request does not requires special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set.
        limit:
          type: array
          items:
            type: integer
          description: Indicates maximum number of records a Web Service should return.
        pagePointerKey:
          type: array
          items:
            type: string
          description: Specifies fetched record's key as pointer to fetch additional records from. If key is composite use comma separated string.
        ratePlanSet:
          type: array
          items:
            type: string
          description: Rate Plan Set code to filter Rate Plans based on the predefined set. if not specified it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set(See InitialRatePlanSet documentation).
        redeemAwards:
          type: array
          items:
            type: boolean
          description: Used to indicate if the awards are to be redeemed.
        roomStayStartDate:
          type: string
          format: date
        roomStayEndDate:
          type: string
          format: date
        roomStayQuantity:
          type: integer
        adults:
          type: integer
          description: Defines the number of Adults.
        children:
          type: integer
          description: Defines the number of Children.
        childAge:
          type: array
          items:
            type: integer
          description: Age of a child in years.
        bucket1Count:
          type: integer
          description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        bucket2Count:
          type: integer
          description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        bucket3Count:
          type: integer
          description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        bucket4Count:
          type: integer
          description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        bucket5Count:
          type: integer
          description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        fullStayTimeSpanStartDate:
          type: string
          format: date
        fullStayTimeSpanEndDate:
          type: string
          format: date
        prevailingRate:
          type: boolean
        rateCategory:
          type: string
        rateClass:
          type: string
        rateGroup:
          type: string
        ratePlanCode:
          type: array
          items:
            type: string
        promotionCode:
          type: array
          items:
            type: string
          description: Promotion code associated with the rate plan.
        roomType:
          type: array
          items:
            type: string
        roomClass:
          type: array
          items:
            type: string
        bedType:
          type: array
          items:
            type: string
        feature:
          type: array
          items:
            type: string
        reservationGuestId:
          type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        reservationGuestIdType:
          type: string
          description: A reference to the type of object defined by the UniqueID element.
        reservationProfileType:
          type: array
          items:
            $ref: '#/components/schemas/reservationProfileTypeEnum'
          description: Type of profile or reservation.
        attachedProfileId:
          type: array
          items:
            type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        hotelReservationId:
          type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        hotelReservationIdType:
          type: string
          description: A reference to the type of object defined by the UniqueID element.
        ratePlanInfo:
          type: boolean
          description: If true Rate Plan Code Master information will be included in the response.
        returnOnlyAvailableRateCodes:
          type: boolean
          description: If true Only availability check will be done and it will return available rate codes.
        resGuaranteeInfo:
          type: boolean
          description: If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.
        roomTypeInfo:
          type: boolean
          description: If true Room Type Master information will be included in the response.
        membershipIdNumber:
          type: array
          items:
            type: integer
          description: Membership id Number of the guest.
        membershipLevel:
          type: array
          items:
            type: string
          description: Membership id Number of the guest.
        membershipType:
          type: array
          items:
            type: string
          description: Membership id Number of the guest.
        pointsAvailable:
          type: array
          items:
            type: integer
          description: Used to indicate Points Available for Profile Primary Membership Type.
        membershipCardNumber:
          type: array
          items:
            type: string
          description: Member Card number associated with the guest membership.
        smokingPreference:
          type: array
          items:
            type: string
          description: Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation.
        hotelPackage:
          type: array
          items:
            type: string
          description: Hotel Package Code to filter the search result.
        yieldMarketCode:
          type: string
        accessibleRoomTypesOnly:
          type: boolean
          description: Used to fetch accessible room types only in the Rate Plan set.
        includeLocalRates:
          type: boolean
          description: Used to indicate if local rates are to be included in the Rate Plan set.
        includeOffshoreRates:
          type: boolean
          description: Used to indicate if offshore rates are to be included in the Rate Plan set.
        postingInterval:
          type: array
          items:
            $ref: '#/components/schemas/ratePostingIntervalEnum'
          description: Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned
        ownerType:
          type: string
          $ref: '#/components/schemas/ownerProfileTypeEnum'
        controlSegment:
          type: array
          items:
            type: string
          description: Control Segment to check for casion restrction for a patron profile.
    personNameTypeType:
      type: string
      description: Person's name in an external system.
      enum:
      - Primary
      - Alternate
      - Incognito
      - External
      - Phonetic
    dateUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Date Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/dateUDFType'
    resCompAccountingType:
      type: object
      description: Information regarding comp accounting on the reservation.
      properties:
        compType:
          description: Code used to identify the casino comp type and ranking of a guest.
          type: string
          minLength: 0
          maxLength: 20
        authorizer:
          description: ID of the employee who will act as the host for this guest.
          type: string
          minLength: 0
          maxLength: 40
        compPostings:
          description: Indicates if the Comp Billing/posting Exist
          type: string
          minLength: 0
          maxLength: 5
    feeType:
      type: object
      description: Applicable service charges or fees.
      properties:
        description:
          type: string
          minLength: 0
          maxLength: 2000
        type:
          description: Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).
          $ref: '#/components/schemas/amountDeterminationType'
        code:
          description: Code identifying the fee (e.g.,agency fee, municipality fee).
          type: string
          minLength: 0
          maxLength: 20
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    dateUDFType:
      type: object
      description: Used to hold user defined field of Date Type.
      properties:
        name:
          description: Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: string
          format: date
          maxLength: 8
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    uRLInfoType:
      type: object
      description: Web site address.
      properties:
        url:
          description: Provides URL information.
          $ref: '#/components/schemas/uRLType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    awardId:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    resAttachedProfileType:
      type: object
      properties:
        name:
          description: Attached profile name
          type: string
        profileIdList:
          description: Collection of unique profile identifiers
          $ref: '#/components/schemas/profileIdList'
        reservationProfileType:
          $ref: '#/components/schemas/resProfileTypeType'
    paymentTypesType:
      type: array
      description: Payment card code like AX,VI etc.
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    keywordDetailType:
      type: object
      properties:
        newKeyword:
          description: The new keyword value.
          type: string
          minLength: 0
          maxLength: 80
    taxTypeType:
      type: object
      description: Provides information about the Tax Type.
      properties:
        hotelId:
          description: Code of the Hotel.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Code of the Tax Type.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the Tax Type.
          type: string
          minLength: 0
          maxLength: 2000
        collectingAgentTax:
          description: A boolean flag for Collecting Agent Tax
          type: boolean
        printAutoAdjust:
          description: Print auto adjust information for this tax type on the tax exempt report.
          type: boolean
        reportExemptDays:
          description: Number of days after which the guest will be tax exempt. Only used for tax exempt report.
          type: integer
        reportTaxPercentage:
          description: Tax percentage. Only used for tax exempt report.
          type: number
          minimum: 0
          maximum: 100
        minimumLengthOfStay:
          description: Minimun Length of Stay.
          type: integer
    feesType:
      type: object
      description: A collection of fees or service charges.
      properties:
        fee:
          description: An individual fee or service charge.
          type: array
          maxItems: 99
          items:
            $ref: '#/components/schemas/feeType'
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    fetchRestrictionsByDateRangeRSType:
      type: object
      description: Response object for searching restrictions by date range.
      properties:
        restrictionsByDateRange:
          description: Requested restrictions by date Range.
          $ref: '#/components/schemas/restrictionsByDateRangeType'
    eCertificateIssueType:
      type: string
      description: Indicates that guest purchased OPERA E-Certificate.
      enum:
      - Assigned
      - OptedIn
      - Purchased
    configPackagePrimaryDetailsType:
      type: object
      description: A Config Package Info type.
      properties:
        description:
          description: The description of the package.
          type: string
          minLength: 0
          maxLength: 2000
        shortDescription:
          description: The short description of the package.
          type: string
          minLength: 0
          maxLength: 2000
        forecastGroup:
          description: The Forecast group package belongs to.
          type: string
          minLength: 0
          maxLength: 20
        arrangementCode:
          description: Arrangement Code.
          type: string
          minLength: 0
          maxLength: 20
        beginSellDate:
          description: Indicates the begin sell date of the package.
          type: string
          format: date
          maxLength: 8
        endSellDate:
          description: Indicates the end sell date of the package.
          type: string
          format: date
          maxLength: 8
    webUserAccountType:
      type: object
      description: Web User Account of the guest.
      properties:
        securityQuestion:
          description: Security Question and its Code associated with the account to verify the user.
          $ref: '#/components/schemas/codeDescriptionType'
        securityAnswer:
          description: Answer to the Security Question.
          type: string
          minLength: 0
          maxLength: 4000
        comments:
          description: Comments.
          type: string
          minLength: 0
          maxLength: 4000
        history:
          description: Web User Account History.
          $ref: '#/components/schemas/webUserHistoryType'
        newLoginName:
          description: New Login Name of the guest.
          type: string
          minLength: 0
          maxLength: 80
        newPassword:
          description: Login Password.
          type: string
          minLength: 0
          maxLength: 2000
        autoGeneratePassword:
          description: A flag which determines if the password is auto generated.
          type: boolean
        loginName:
          description: Login Name of the guest.
          type: string
          minLength: 0
          maxLength: 80
        domainCode:
          description: Domain code.
          type: string
          minLength: 0
          maxLength: 20
        locked:
          description: Boolean flag that indicates whether the web account is locked or not.
          type: boolean
        inactive:
          description: Boolean flag that indicates whether the web account is inactive or not.
          type: boolean
    roomFeatureType:
      type: object
      description: Room Feature Information.
      properties:
        code:
          description: A code representing a room feature.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: A code representing a room feature.
          type: string
          minLength: 0
          maxLength: 2000
        orderSequence:
          description: Display Order sequence.
          type: number
        quantity:
          description: Indicates quantity.
          type: integer
    reservationPackageType:
      type: object
      description: A ReservationPackageType class.
      properties:
        packageHeaderType:
          description: Package information from configuration.
          $ref: '#/components/schemas/packageCodeHeaderType'
        scheduleList:
          description: A HotelPackageSchedule type.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationPackageScheduleType'
        newTimeSpan:
          description: The changed dates(Start and End dates) for this product.
          $ref: '#/components/schemas/timeSpanType'
        consumptionDetails:
          description: Package consumption details. Includes information for quantity , allowance etc.
          $ref: '#/components/schemas/packageConsumptionType'
        packageCode:
          description: Package code. This is the unique code used for the package and is a required element.
          type: string
          minLength: 0
          maxLength: 20
        internalID:
          description: Reservation Package Opera Internal Unique Id. This is the unique Id used for this reservation package.
          type: number
        ratePlanCode:
          description: The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record on the reservation.
          type: string
          minLength: 0
          maxLength: 20
        startDate:
          description: Required value when changing a reservation package. If the original start date was null, then null is required.
          type: string
          format: date
          maxLength: 8
        endDate:
          description: Required value when changing a reservation package. If the original end date was null, then null is required.
          type: string
          format: date
          maxLength: 8
        packageGroup:
          description: Package group code. If this package is part of a package group, the group code is indicated here. This is a required element and is part of the key to fetch the correct package record .
          type: string
          minLength: 0
          maxLength: 20
        source:
          description: Indicates if the source of the product is Rate header, Rate Detail or Reservation. For new development this field is to be used for passing the product scource
          $ref: '#/components/schemas/productSourceType'
        awardCode:
          description: This is the Award code used to redeem the package if the package is a redemption package.
          type: string
          minLength: 0
          maxLength: 20
        points:
          description: Indicates the points used to redeem the redemption package.
          type: integer
    pMS_ResStatusType:
      type: string
      description: This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
      enum:
      - Reserved
      - Requested
      - NoShow
      - Cancelled
      - InHouse
      - CheckedOut
      - Waitlisted
      - DueIn
      - DueOut
      - Walkin
      - PendingCheckout
    marketingPolicyType:
      type: string
      description: Indicates the channel policy type like deposit,cancel etc.
      enum:
      - Deposit
      - Commission
      - Cancel
      - Guarantee
      - General
      - Penalty
      - Tax
      - Promotion
    hotelEventSpaceSummaryType:
      type: object
      description: The summary info of hotel event space
      properties:
        'no':
          description: The total event space number which has the same space type, max capacity and setup style.
          type: integer
        spaceType:
          description: The type of the event space
          type: string
          minLength: 0
          maxLength: 2000
        maxCapacity:
          description: The max capacity of this event space group
          type: integer
        maxOccupancies:
          description: List of max occupancies of the event space based on the setup code.
          $ref: '#/components/schemas/eventSpaceMaxOccupanciesType'
    profileTypeType:
      type: string
      description: The types of Profile handled by the web service.
      enum:
      - Guest
      - Agent
      - Company
      - Group
      - Source
      - Employee
      - Hotel
      - Vendor
      - Contact
      - Purge
      - BusinessHeader
      - BillingAccount
      - Activity
      - Potential
      - Account
    restrictionsHistoryType:
      type: object
      description: Restriction history for the requested Hotel.
      properties:
        restrictionSets:
          description: Restriction set for a date range.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/restrictionSetHistoryType'
        chainCode:
          description: The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
          type: string
          minLength: 0
          maxLength: 20
        hotelCityCode:
          description: The IATA city code; for example DCA, ORD.
          type: string
          minLength: 0
          maxLength: 40
        hotelName:
          description: A text field used to communicate the proper name of the hotel.
          type: string
          minLength: 0
          maxLength: 80
        hotelCodeContext:
          description: A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.
          type: string
          minLength: 0
          maxLength: 40
        chainName:
          description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).
          type: string
          minLength: 0
          maxLength: 80
        totalPages:
          description: Evaluated total page count based on the requested max fetch count.
          type: integer
        offset:
          description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
          type: integer
        limit:
          description: Indicates maximum number of records a Web Service should return.
          type: integer
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    restrictionSetHistoryType:
      type: object
      properties:
        restrictionControl:
          description: Indicates the applicability of the restriction.
          $ref: '#/components/schemas/restrictionControlType'
        restrictionStatus:
          description: Indicates the type of the restriction.
          $ref: '#/components/schemas/restrictionStatusType'
        actualTimeSpan:
          description: Actual time span of the restriction.
          $ref: '#/components/schemas/timeSpanType'
        onRequest:
          description: Indicates whether the Closed restriction is flagged as On Request.
          type: boolean
        actionType:
          description: Indicates the action performed on restriction
          type: string
          minLength: 0
          maxLength: 2000
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
        sunday:
          type: boolean
        monday:
          type: boolean
        tuesday:
          type: boolean
        wednesday:
          type: boolean
        thursday:
          type: boolean
        friday:
          type: boolean
        saturday:
          type: boolean
        appliedDate:
          description: Uses the hotel's time zone.
          type: string
          format: date-time
        seasonCode:
          description: The season code during which the restrictions are valid.
          type: string
        logUserId:
          type: integer
        logUserName:
          type: string
          minLength: 0
          maxLength: 40
      description: Indicates Restriction set applicable for the date range.
    profileIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    primaryShareTypeType:
      type: string
      enum:
      - Primary
      - NonPrimary
    reservationAllowedActionType:
      type: string
      description: Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
      enum:
      - Cancel
      - Move
      - PreCharge
      - PostCharge
      - FacilitySchedule
      - Upsell
      - PreCheckIn
      - PostToNoShowCancel
      - NoShow
      - NameChange
      - Discount
      - EnrollToPrimaryMembership
      - EnrollInProgress
    availabilityStatusType:
      type: string
      description: Status when there are not enough sell control items available.
      enum:
      - Restricted
      - Available
      - InventoryNotAvailable
      - PointsNotEnough
      - InventoryitemsNotAvailable
      - RoomNotAvailable
      - CasinoRestriction
    packagePostingRulesType:
      type: object
      properties:
        transactionCode:
          description: The Transaction code used to post the package price.
          $ref: '#/components/schemas/packageTransactionCodeType'
        overageCode:
          description: The overage code to record over consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        profitCode:
          description: The transaction code to record package profit, if any, from un-consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        lossCode:
          description: The transaction code to record package Loss, if any, from un-consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        alternateCodesList:
          description: The alternate transaction code that can be consumed by the guest in place of the transaction code.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/packageTransactionCodeType'
    resSharedGuestInfoType:
      type: object
      description: Contains information regarding the share reservation.
      properties:
        profileId:
          $ref: '#/components/schemas/profileId'
        firstName:
          description: Given name, first name or names
          type: string
        lastName:
          description: Family name, last name.
          type: string
        fullName:
          description: String representation of the full name
          type: string
    numericUDFType:
      type: object
      description: Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
      properties:
        name:
          description: Name of user defined field.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: number
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    namePrefixType:
      type: string
      description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
      minLength: 0
      maxLength: 40
    personNameType:
      type: object
      description: This provides name information for a person.
      properties:
        namePrefix:
          description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)
          type: string
          minLength: 0
          maxLength: 40
        givenName:
          description: Given name, first name or names.
          type: string
          minLength: 0
          maxLength: 40
        middleName:
          description: The middle name of the person name.
          type: string
          minLength: 0
          maxLength: 40
        surname:
          description: Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.
          type: string
          minLength: 0
          maxLength: 40
        nameSuffix:
          description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)
          type: string
          minLength: 0
          maxLength: 40
        nameTitle:
          description: Degree or honors (e.g., Ph.D., M.D.)
          type: string
          minLength: 0
          maxLength: 80
        nameTitleSuffix:
          description: Title Suffix. Must be populated if ADVANCED_TITLE is on.
          type: integer
        envelopeGreeting:
          description: Envelope Greeting of the profile
          type: string
        salutation:
          description: Salutation of the profile
          type: string
        nameType:
          description: Type of name of the individual, such as former, nickname, alternate or alias name.
          $ref: '#/components/schemas/personNameTypeType'
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        externalSystem:
          description: When name type is external, indicates the external system the name belongs to.
          type: string
          minLength: 0
          maxLength: 40
    communicationStatusType:
      type: string
      description: Enum to denote the Status of Readiness messages sent to Guest Devices.
      enum:
      - Pending
      - Completed
      - Failed
      - Sent
      - Received
      - Cancelled
      - PendingAvailability
    amountDeterminationType:
      type: string
      description: Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
      enum:
      - Inclusive
      - Exclusive
    hotelInfoType:
      type: object
      description: Contains the basic configuration information about a Hotel.
      properties:
        primaryDetails:
          description: Primary Information of the hotel.
          type: object
          properties:
            legalOwner:
              description: Legal owner of the hotel.
              type: string
              minLength: 0
              maxLength: 80
        generalInformation:
          description: General Information of the hotel.
          type: object
          properties:
            hotelType:
              description: The type of the Hotel.
              type: string
              minLength: 0
              maxLength: 20
            roomCount:
              description: The total number of rooms in the Hotel.
              type: integer
            bedCount:
              description: The total number of beds in the Hotel.
              type: integer
            floorCount:
              description: The total number of floors of the Hotel.
              type: integer
            checkInTime:
              description: The official check in time of the Hotel.
              type: string
              format: date-time
            checkOutTime:
              description: The official check out time of the Hotel.
              type: string
              format: date-time
            hotelInfoWebsite:
              description: URL where property information is located.
              $ref: '#/components/schemas/uRLType'
            longitude:
              description: Longitude of the hotel.
              type: number
            latitude:
              description: Latitude of the hotel.
              type: number
            baseLanguage:
              description: The base language of the Hotel.
              $ref: '#/components/schemas/languageType'
        accommodationDetails:
          description: Accommodation Details of the hotel.
          type: object
          properties:
            singleRooms:
              description: The number of Single Rooms of the Hotel.
              type: integer
            doubleRooms:
              description: The number of Double Rooms of the Hotel.
              type: integer
            twinRooms:
              description: The number of Twin Rooms of the Hotel.
              type: integer
            familyRooms:
              description: The number of Family Rooms of the Hotel.
              type: integer
            connectingRooms:
              description: The number of Connecting Rooms of the Hotel.
              type: integer
            accessibleRooms:
              description: The number of Accessible Rooms of the Hotel.
              type: integer
            nonSmokingRooms:
              description: The number of Non-Smoking Rooms of the Hotel.
              type: integer
            maxAdultsInFamilyRoom:
              description: Maximum Adults for Family Room Type.
              type: integer
            maxChildrenInFamilyRoom:
              description: Maximum Children for Family Room Type.
              type: integer
            guestRoomFloors:
              description: The total number of the Guest Room Floors.
              type: integer
            guestRoomElevators:
              description: The number of Guest Room Elevators.
              type: integer
            suites:
              description: The number of Suites of the Hotel.
              type: integer
            executiveFloorNo:
              description: The floor number of Executive Floors of the Hotel.
              type: string
              minLength: 0
              maxLength: 1000
            roomAmenties:
              description: The information about the Room Amenities.
              type: string
              minLength: 0
              maxLength: 2000
            shopDescription:
              description: The Description of the shops in the Hotel.
              type: string
              minLength: 0
              maxLength: 2000
        propertyControls:
          description: Property controls information configuration of the hotel.
          type: object
          properties:
            sellControls:
              description: The sell controls information configuration of the hotel.
              type: object
              properties:
                startDate:
                  description: Date when the hotel become valid for use.
                  type: string
                  format: date
                  maxLength: 8
                endDate:
                  description: The end date of the hotel.
                  type: string
                  format: date
                  maxLength: 8
                hotelId:
                  description: The hotel code.
                  type: string
                  minLength: 0
                  maxLength: 80
            currencyFormatting:
              description: Currency Formatting information configuration of the hotel.
              type: object
              properties:
                currencyCode:
                  description: The base currency code for this hotel..
                  type: string
                  minLength: 0
                  maxLength: 20
                currencyFormat:
                  description: Format for the local currency.
                  type: string
                  minLength: 0
                  maxLength: 80
                currencySymbol:
                  description: Symbol to designate the default currency of the hotel.
                  type: string
                  minLength: 0
                  maxLength: 20
                decimalPositions:
                  description: Number of decimal positions used for this currency type.
                  type: integer
            cateringCurrencyFormatting:
              description: Catering Currency Formatting information configuration of the hotel.
              type: object
              properties:
                currencyCode:
                  description: The base currency code for this hotel..
                  type: string
                  minLength: 0
                  maxLength: 20
                currencyFormat:
                  description: Format for the local currency.
                  type: string
                  minLength: 0
                  maxLength: 80
            dateTimeFormatting:
              description: Date Time Formatting information configuration of the hotel
              type: object
              properties:
                longDateFormat:
                  description: Long date format of the hotel.
                  type: string
                  minLength: 0
                  maxLength: 20
                shortDateFormat:
                  description: Short date format of the hotel.
                  type: string
                  minLength: 0
                  maxLength: 20
                timeFormat:
                  description: Time format for the hotel.
                  type: string
                  minLength: 0
                  maxLength: 20
                timeZoneRegion:
                  description: Time zone region of the hotel.
                  type: string
                  minLength: 0
                  maxLength: 80
            applicationMode:
              description: Application Mode information configuration of the hotel.
              type: object
              properties:
                configurationMode:
                  description: The hotel's configuration mode if applicable.
                  type: string
                  minLength: 0
                  maxLength: 20
                countryMode:
                  description: The hotel's country code.
                  type: string
                  minLength: 0
                  maxLength: 20
                expHotelCode:
                  description: Hotel Code used for third party exports.
                  type: string
                  minLength: 0
                  maxLength: 20
                touristNumber:
                  description: The Tourist Number of the hotel.
                  type: string
                  minLength: 0
                  maxLength: 20
                mBSSupported:
                  description: Indicates if the hotel uses MBS (Marriott Business Services).
                  type: boolean
        communication:
          description: Communication information of the hotel.
          type: object
          properties:
            phoneNumber:
              description: The direct dial phone number of the hotel.
              $ref: '#/components/schemas/telephoneType'
            tollFreeNumber:
              description: Toll free phone number of the hotel.
              $ref: '#/components/schemas/telephoneType'
            faxNumber:
              description: Fax phone number of the hotel.
              $ref: '#/components/schemas/telephoneType'
            emailAddress:
              description: Email address of the hotel.
              $ref: '#/components/schemas/basicEmailType'
            webPage:
              description: The web address of the hotel.
              $ref: '#/components/schemas/uRLType'
        address:
          description: Provides address information.
          type: object
          properties:
            isValidated:
              description: Indicator to define if the Address is validated by the Address Validation System.
              type: boolean
            addressLine:
              description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.
              type: array
              maxItems: 4
              items:
                type: string
                minLength: 0
                maxLength: 80
            cityName:
              description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
              type: string
              minLength: 0
              maxLength: 40
            postalCode:
              description: Post Office Code number.
              type: string
              minLength: 0
              maxLength: 15
            cityExtension:
              description: Post Office City Extension Code number. City Extension mainly used for UK addresses.
              type: string
              minLength: 0
              maxLength: 20
            county:
              description: County or District Name (e.g., Fairfax). This is read only.
              type: string
              minLength: 0
              maxLength: 20
            state:
              description: State or Province name (e.g., Texas).
              type: string
              minLength: 0
              maxLength: 20
            country:
              description: Country name (e.g., Ireland).
              $ref: '#/components/schemas/countryNameType'
            language:
              description: Language identification.
              type: string
              pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            type:
              description: Defines the type of address (e.g. home, business, other).
              type: string
              minLength: 0
              maxLength: 20
            typeDescription:
              description: Describes the type code
              type: string
            primaryInd:
              description: When true, indicates a primary information.
              type: boolean
            updateReservations:
              description: Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.
              type: boolean
            barCode:
              description: The postal barcode for the address.
              type: string
              minLength: 0
              maxLength: 100
            createDateTime:
              description: Time stamp of the creation.
              type: string
              format: date-time
            creatorId:
              description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
              type: string
              minLength: 0
              maxLength: 200
            lastModifyDateTime:
              description: Time stamp of last modification.
              type: string
              format: date-time
            lastModifierId:
              description: Identifies the last software system or person to modify a record.
              type: string
              minLength: 0
              maxLength: 200
            purgeDate:
              description: Date an item will be purged from a database (e.g., from a live database to an archive).
              type: string
              format: date
              maxLength: 8
            regionCode:
              description: The region code of the hotel.
              type: string
              minLength: 0
              maxLength: 20
        hotelRestaurants:
          description: Names of restaurants which can be found in the Hotel.
          $ref: '#/components/schemas/hotelRestaurantsType'
        hotelRateRanges:
          description: The rate ranges which are offered by the hotels.
          $ref: '#/components/schemas/hotelRateRangesType'
        alternateHotels:
          description: Informations about alternative hotels provided by the Hotel.
          $ref: '#/components/schemas/alternateHotelsType'
        hotelContacts:
          description: The contacts information the hotels.
          $ref: '#/components/schemas/hotelContactsType'
        hotelEventSpaces:
          description: Even Space information of the hotel.
          $ref: '#/components/schemas/hotelEventSpacesType'
        hotelNotes:
          description: List of notes for the hotel.
          $ref: '#/components/schemas/hotelNotesType'
        hotelCorporateInformations:
          $ref: '#/components/schemas/hotelCorporateInformationsType'
        attractions:
          description: List of Attractions for the hotel.
          $ref: '#/components/schemas/hotelAttractionsType'
        meetingRooms:
          description: List of Meeting Rooms for the hotel.
          $ref: '#/components/schemas/meetingRoomsType'
        chainCode:
          description: The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
          type: string
          minLength: 0
          maxLength: 20
        hotelCityCode:
          description: The IATA city code; for example DCA, ORD.
          type: string
          minLength: 0
          maxLength: 40
        hotelName:
          description: A text field used to communicate the proper name of the hotel.
          type: string
          minLength: 0
          maxLength: 80
        hotelCodeContext:
          description: A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.
          type: string
          minLength: 0
          maxLength: 40
        chainName:
          description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).
          type: string
          minLength: 0
          maxLength: 80
    hotelRestaurantsType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelRestaurantType'
    rateRoomDetailsType:
      type: object
      properties:
        memberships:
          description: Detail regarding customer loyalty program.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/membershipSearchType'
        restrictionType:
          description: Indicates the restriction types if hotel is not available.
          $ref: '#/components/schemas/masterRestrictionStatusesType'
        roomStays:
          description: Room stay information.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomStayType'
    resPaymentCardType:
      type: object
      description: Information on a credit card for the customer.
      properties:
        cardId:
          description: credit card id
          $ref: '#/components/schemas/uniqueID_Type'
        currentAuthorizedAmount:
          $ref: '#/components/schemas/currencyAmountType'
        approvalAmountNeeded:
          $ref: '#/components/schemas/currencyAmountType'
        cardType:
          description: Indicates the type of credit card from a defined list
          $ref: '#/components/schemas/cardTypeType'
        userDefinedCardType:
          description: Indicates the user defined credit card type if credit card type from a defined list is not provided
          type: string
          minLength: 0
          maxLength: 2
        cardNumber:
          type: string
          minLength: 0
          maxLength: 80
        cardNumberMasked:
          type: string
          minLength: 0
          maxLength: 80
        cardNumberLast4Digits:
          type: string
          minLength: 0
          maxLength: 80
        expirationDate:
          description: Expiration date of the credit card
          type: string
          format: date
          maxLength: 8
        expirationDateMasked:
          description: Masked Expiration date of the credit card
          type: string
          minLength: 0
          maxLength: 20
        expirationDateExpired:
          type: boolean
        cardHolderName:
          type: string
          minLength: 0
          maxLength: 200
        attachCreditCardToProfile:
          description: Attach the credit card to profile.
          type: boolean
        processing:
          description: This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.
          $ref: '#/components/schemas/cardProcessingType'
        swiped:
          type: boolean
        cardPresent:
          description: Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.
          type: boolean
        cardOrToken:
          description: This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.
          $ref: '#/components/schemas/cardNumberTypeType'
    resHousekeepingType:
      type: object
      description: Holds housekeeping turndown service information for the room.
      properties:
        instructions:
          description: Turndown instructions for the room.
          type: string
        facilityTaskInfo:
          description: The facility task applicable for the current day. This will be information only and not used for any updates.
          $ref: '#/components/schemas/facilityTaskType'
        linenChange:
          description: Indicates if a linen change is necessary.
          type: boolean
        turndownRequested:
          description: Indicates whether guest wants turndown facility or not.
          type: boolean
        serviceTime:
          description: This is the Turndown room service time.
          type: string
          format: date
          maxLength: 8
        expectedServiceTime:
          description: Expected Start Time for housekeeping task(s).
          type: string
        roomStatus:
          description: Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.
          $ref: '#/components/schemas/housekeepingRoomStatusType'
    indicatorsType:
      type: array
      description: Collection of lamp indicators.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/indicatorType'
    uniqueID_Type:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    telephoneType:
      type: object
      description: Information on a telephone number for the customer.
      properties:
        phoneTechType:
          description: Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.
          type: string
          minLength: 0
          maxLength: 20
        phoneUseType:
          description: Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
          type: string
          minLength: 0
          maxLength: 20
        phoneUseTypeDescription:
          description: Description of the PhoneUseType code
          type: string
          minLength: 0
          maxLength: 2000
        phoneNumber:
          description: Telephone number assigned to a single location.
          type: string
          minLength: 0
          maxLength: 40
        extension:
          description: Extension to reach a specific party at the phone number.
          type: string
          minLength: 0
          maxLength: 20
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
    changeHurdleRatesDetails:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    resGuaranteeFetchInstructionsType:
      type: object
      description: ''
      properties:
        calculateEstimateAmount:
          description: Determines whether estimated amount to be calculated or not
          type: boolean
    hurdleRateEditType:
      type: object
      description: Unique identifier for hurdle rate.
      properties:
        hotelId:
          description: Hotel code for which the hurdle rate belongs to.
          type: string
          minLength: 0
          maxLength: 20
        hurdleDate:
          description: Hurdle date for which the hurdle rate is scheduled.
          type: string
          format: date
          maxLength: 8
        roomType:
          description: Room type for which the hurdle rate applies to.
          type: string
          minLength: 0
          maxLength: 20
        roomCategory:
          description: Internal room category of the room type for which the hurdle rate applies to.
          type: string
          minLength: 0
          maxLength: 20
        yieldCategory:
          description: Yield category for which the hurdle rate applies to.
          type: string
          minLength: 0
          maxLength: 20
        lengthOfStay:
          description: Length of stay for which the hurdle rate applies to.
          type: number
        yieldMarketCode:
          description: Yield market code for which the hurdle rate applies to.
          type: string
          minLength: 0
          maxLength: 20
        newHurdleRate:
          description: Details for hurdle rate to be modified.
          $ref: '#/components/schemas/hurdleRateType'
    preferenceType:
      type: object
      description: Guest Preference details for the profile.
      properties:
        preferenceValue:
          description: Preference value for display purposes.
          type: string
          minLength: 0
          maxLength: 200
        description:
          description: Preference Description for display purposes.
          type: string
          minLength: 0
          maxLength: 2000
        global:
          description: Whether this preference is property specific or not.
          type: boolean
        source:
          description: Source of the preference.
          type: string
          minLength: 0
          maxLength: 40
        hotels:
          description: If specified preference belongs to the Hotels listed, otherwise it is a global preference.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        preferenceId:
          type: string
          minLength: 0
          maxLength: 20
        excludedPreferencesCount:
          description: Specifies the count of preferences excluded for the attached reservation preference.
          type: integer
    tierAdministrationType:
      type: string
      description: Do not upgrade membership. The membership may be downgraded.
      enum:
      - Disabled
      - NoUpgrade
    roomRateAvailReasonType:
      type: string
      description: Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
      enum:
      - Available
      - Restricted
      - RestrictedDueToInventory
      - RestrictedDueToOccupancy
      - RestrictedDueToItemInventory
      - RestrictedDueToCasinoRestriction
    guaranteeType:
      type: object
      description: Specifies Guarantee Code attributes.
      properties:
        description:
          description: Description of the Guarantee Code.
          type: string
          minLength: 0
          maxLength: 2000
        policyRequirements:
          description: Specifies various policyRequirements for the guarantee code.
          $ref: '#/components/schemas/guaranteeRequirementsType'
        shortDescription:
          description: Brief description of the Guarantee Code.
          $ref: '#/components/schemas/translationTextType80'
        paymentTypes:
          description: Specifies various payment types for the guarantee code.
          $ref: '#/components/schemas/paymentTypesType'
        guaranteeCode:
          description: Code assigned to the Guarantee.
          type: string
          minLength: 0
          maxLength: 20
        onHold:
          description: If true indicates this Guarantee Code is used only to hold the inventory during reservation process.
          type: boolean
        reserveInventory:
          description: If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        lateArrival:
          description: Represents the late arrival time.
          type: string
    createHurdleRates:
      type: object
      description: Request object for creating new Hurdle Rates.
      properties:
        hurdleRates:
          description: Details of the Hurdle Rates to be created.
          $ref: '#/components/schemas/hurdleRatesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    reservationGuaranteesPolicies:
      type: object
      description: Response object to fetch reservation guarantees.
      properties:
        resGuarantees:
          description: A collection of Guarantee Codes information with cancellation penalty and deposit policy information.
          $ref: '#/components/schemas/guaranteePoliciesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    configPostingAttributesType:
      type: object
      description: A config Package posting attributes type.
      properties:
        addToRate:
          description: The package price is added to the room rate.
          type: boolean
        printSeparateLine:
          description: The package price is printed on separate line of the folio.
          type: boolean
        sellSeparate:
          description: Can the package be sold separate from rate plan code?
          type: boolean
        postNextDay:
          description: package charges will be posted next business day.
          type: boolean
        forecastNextDay:
          description: Package will be forecasted for consumption the next business day.
          type: boolean
        deliveryTimeRequired:
          description: Indicates whether a delivery time is required for the package.
          type: boolean
        webBookable:
          description: Can package be sold via Web channel.
          type: boolean
        formula:
          description: The custom formula used for this package, if any.
          type: string
          minLength: 0
          maxLength: 2000
        formulaFunctionName:
          description: The custom formula function name used for this package, if any.
          type: string
          minLength: 0
          maxLength: 2000
        formulaFunctionArguments:
          description: The function argument name-value combination accepted by the custom formula used for this package.
          $ref: '#/components/schemas/functionArgumentsType'
        startTime:
          description: Start time the package is valid.
          type: string
        endTime:
          description: End time the package is valid.
          type: string
        catering:
          description: Is package used for catering?
          type: boolean
        postingRhythm:
          description: The posting rhythm for this package.
          $ref: '#/components/schemas/packagePostingRhythmType'
        priceCalculationRule:
          description: The price calculation rule for this package.
          $ref: '#/components/schemas/packageCalculationRuleType'
        ticket:
          description: Indicates whether a package is configured as a ticket or not.
          type: boolean
        inventoryItems:
          description: Package Code Inventory Items type.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/pkgInventoryItemType'
        calculatedPrice:
          description: Calculated Package Price based from Number of Adults, Children and Calculation Rule.
          type: number
    resCommunicationType:
      type: object
      description: Communication details for a reservation.
      properties:
        telephones:
          description: List of Telephone Number Information
          type: object
          properties:
            telephoneInfo:
              description: Collection of Detailed information on telephone/fax for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/telephoneInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        emails:
          description: List of email address for the customer.
          type: object
          properties:
            emailInfo:
              description: Collection of Detailed information on an eMail address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/emailInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
    hurdleRatesType:
      type: array
      description: Details for hurdle rate.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hurdleRateType'
    packageTransactionCodeType:
      type: object
      properties:
        description:
          description: The description of the code.
          type: string
          minLength: 0
          maxLength: 200
        code:
          description: Posting / transaction code.
          type: string
          minLength: 0
          maxLength: 20
        type:
          description: Code is inclusive or exclusive of other charges such as taxes.
          $ref: '#/components/schemas/amountDeterminationType'
    hotelRateRangesType:
      type: array
      description: Lists of rate ranges of the hotel.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelRateRangeType'
    reservationProfileType:
      type: object
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.
          $ref: '#/components/schemas/profileIdList'
        profile:
          description: Provides detailed information regarding either a company or a customer profile.
          $ref: '#/components/schemas/profileType'
        reservationProfileType:
          $ref: '#/components/schemas/resProfileTypeType'
    basicEmailType:
      type: string
      description: Email address
      minLength: 0
      maxLength: 2000
    awardVouchersType:
      type: array
      description: This stores the Membership Awards code applied on the reservation.
      maxItems: 5
      items:
        type: object
        properties:
          awardCode:
            description: Membership Award code applied on the reservation.
            type: string
            minLength: 0
            maxLength: 20
          voucherNo:
            description: Membership Award number.
            type: string
            minLength: 0
            maxLength: 80
    membershipSearchType:
      type: object
      description: Identifies criteria for searching frequent customer reward program.
      properties:
        membershipId:
          description: Membership ID criteria.
          type: string
        membershipLevel:
          description: Membership Level criteria.
          $ref: '#/components/schemas/codeListType'
        membershipType:
          description: Membership Type criteria.
          $ref: '#/components/schemas/codeListType'
        associatedReservationsOnly:
          description: If this is true,the reservations which has membership information associated will be resulted .
          type: boolean
    hotelEventSpaceDetailType:
      type: object
      description: The detail info of hotel event space
      properties:
        code:
          description: The code of hotel event space.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Th description of the hotel event space
          type: string
          minLength: 0
          maxLength: 2000
        maxCapacity:
          description: Th max capacity of the hotel event space
          type: integer
        maxOccupancies:
          description: List of max occupancies of the event space based on the setup code.
          $ref: '#/components/schemas/eventSpaceMaxOccupanciesType'
    guaranteePolicyType:
      type: object
      description: Specifies Guarantee Code attributes.
      properties:
        guaranteeCode:
          description: Code assigned to the Guarantee.
          type: string
          minLength: 0
          maxLength: 20
        shortDescription:
          description: Brief description of the Guarantee Code.
          $ref: '#/components/schemas/translationTextType80'
        policyRequirements:
          description: Specifies various policyRequirements for the guarantee code.
          $ref: '#/components/schemas/guaranteeRequirementsType'
        description:
          description: Description of the Guarantee Code.
          type: string
          minLength: 0
          maxLength: 2000
        paymentTypes:
          description: Specifies various payment types for the guarantee code.
          $ref: '#/components/schemas/paymentTypesType'
        onHold:
          description: If true indicates this Guarantee Code is used only to hold the inventory during reservation process.
          type: boolean
        reserveInventory:
          description: If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        lateArrival:
          description: Represents the late arrival time.
          type: string
          maxLength: 2000
        cancelPenalty:
          description: The CancelPenalty class defines the cancellation policy of the hotel facility.
          type: object
          properties:
            deadline:
              description: Cancellation deadline, absolute or relative.
              $ref: '#/components/schemas/policyDeadlineType'
            amountPercent:
              description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights.
              $ref: '#/components/schemas/policyAmountPercentType'
            penaltyDescription:
              description: Text description of the Penalty in a given language.
              type: string
              minLength: 0
              maxLength: 2000
            offsetUnit:
              $ref: '#/components/schemas/offsetUnitType'
            formattedRule:
              description: Formatted Text Rule of the Cancellation Penalty.
              type: string
              minLength: 0
              maxLength: 2000
            policyCode:
              description: Policy Code.
              type: string
              minLength: 0
              maxLength: 20
            manual:
              description: Flag to indicate if the cancellation policy is manual.
              type: boolean
            nonRefundable:
              description: Indicates if the amount is refundable if booking is canceled.
              type: boolean
            effective:
              description: Indicator if Cancellation Penalty is currently applicable or not.
              type: boolean
            estimatedAmount:
              description: Message.
              type: number
        depositPolicy:
          description: A deposit policy attached with the reservation.
          type: object
          properties:
            revenueType:
              description: Type of reservation.
              $ref: '#/components/schemas/depositCancelRevenueType'
            policy:
              description: Reservation deposit policy details.
              $ref: '#/components/schemas/depositPolicyType'
            comments:
              description: Comments attached with a deposit.
              type: string
              minLength: 0
              maxLength: 2000
            amountPaid:
              description: Total amount paid against the reservation deposit.
              $ref: '#/components/schemas/currencyAmountType'
            amountDue:
              description: Total amount due against the reservation deposit.
              $ref: '#/components/schemas/currencyAmountType'
            policyId:
              description: Unique ID of the Reservation Policy.
              $ref: '#/components/schemas/uniqueID_Type'
            estimatedAmount:
              description: Message.
              type: number
        defaultGuarantee:
          description: If true indicates this can be the default guarantee type to be selected for a reservation.
          type: boolean
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileCommissionType:
      type: object
      description: This is the preconfigured routing instruction type.
      properties:
        hotelId:
          description: Hotel Code for the commission being used for a profile.
          type: string
          minLength: 0
          maxLength: 20
        commissionCode:
          description: commission Code for a profile.
          type: string
          minLength: 0
          maxLength: 20
        bankAccount:
          description: Bank account used for the commission for a profile.
          type: string
          minLength: 0
          maxLength: 20
        paymentMethod:
          description: Type of payment associated with the bank account.
          $ref: '#/components/schemas/commissionPaymentMethods'
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
    identificationType:
      type: object
      description: Identification information of the customer.
      properties:
        idType:
          description: Identification Type. Eg Passport, Driving License etc.
          type: string
          minLength: 0
          maxLength: 40
        idNumber:
          description: Identification Number.
          type: string
          minLength: 0
          maxLength: 80
        idNumberMasked:
          description: Masked Identification Number.
          type: string
          minLength: 0
          maxLength: 80
        issuedCountry:
          description: The country where Identification was issued.
          type: string
          minLength: 0
          maxLength: 20
        issuedDate:
          description: Issued date of Identification.
          type: string
          format: date
          maxLength: 8
        issuedPlace:
          description: The place where Identification was issued.
          type: string
          minLength: 0
          maxLength: 80
        expirationDate:
          description: Expiration date of Identification.
          type: string
          format: date
          maxLength: 8
        registeredProperty:
          description: Property where the identification belongs to.
          type: string
          minLength: 0
          maxLength: 20
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    relationshipProfileType:
      type: object
      properties:
        customer:
          description: Detailed information of the customer
          $ref: '#/components/schemas/customerType'
        company:
          description: Detailed information of the Company.
          $ref: '#/components/schemas/companyType'
        telephone:
          description: Information on telephone details for the customer/company
          $ref: '#/components/schemas/telephoneInfoType'
        address:
          description: Information on address details for the customer/company
          $ref: '#/components/schemas/addressInfoType'
        email:
          description: Information on email address for the customer/company
          $ref: '#/components/schemas/emailInfoType'
        uRLs:
          description: Information on web url/address for the customer/company
          $ref: '#/components/schemas/uRLInfoType'
        primaryOwner:
          description: Primary Owner of the profile
          $ref: '#/components/schemas/ownerType'
        profileIdList:
          description: Original profile details for which the relationships was created
          $ref: '#/components/schemas/uniqueIDListType'
        changeProfileIdList:
          description: Updated/changed profile details for the relationships created
          $ref: '#/components/schemas/uniqueIDListType'
        primary:
          description: Indicates if this relationship is the primary relationship.
          type: string
          minLength: 0
          maxLength: 20
        id:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        statusCode:
          description: Status of the profile. Active/Inactive
          $ref: '#/components/schemas/profileStatusType'
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
    policyAmountPercentType:
      type: object
      description: Defines the percentage basis for calculating the fee amount or the amount.
      properties:
        basisType:
          description: Provides the basis for how the amount of the guarantee is calculated.
          $ref: '#/components/schemas/policyBasisTypeType'
        nights:
          description: The number of nights of the hotel stay that are used to calculate the fee amount.
          type: integer
        percent:
          description: The percentage used to calculate the amount.
          type: number
          minimum: 0
          maximum: 100
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    masterAccountInfoType:
      type: object
      properties:
        masterAccountId:
          description: Unique ID of the Master account.
          $ref: '#/components/schemas/uniqueID_Type'
        masterAccountName:
          description: Name of the Master account.
          type: string
          minLength: 0
          maxLength: 40
    numericUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Numeric Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/numericUDFType'
    hotelEventSpaceDetailsType:
      type: array
      description: List of detail info of hotel event space
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelEventSpaceDetailType'
    bookingChannelType:
      type: object
      properties:
        channelCode:
          type: string
          minLength: 0
          maxLength: 20
        channelName:
          type: string
          minLength: 0
          maxLength: 80
        channelType:
          type: string
          minLength: 0
          maxLength: 240
    packageCalculationRuleType:
      type: string
      description: Simple type for package caluculation rules.
      enum:
      - FlatRate
      - PerPerson
      - PerAdult
      - PerChild
      - PerRoom
    offsetUnitType:
      type: string
      description: Indicates deadline offset unit type.
      enum:
      - Year
      - Month
      - Day
      - Hour
    resGuaranteeType:
      type: object
      description: Validations type record returned after Validations are done.
      properties:
        guaranteeCode:
          description: Guarantee Code.
          type: string
          minLength: 0
          maxLength: 20
        shortDescription:
          description: Guarantee Code.
          type: string
          minLength: 0
          maxLength: 80
        onHold:
          description: Guarantee Code.
          type: boolean
    phoneNumberType:
      type: string
      description: Phone number
      minLength: 0
      maxLength: 40
    hotelInterfaceStatusType:
      type: string
      description: Status of the Hotel Interface either STOPPED or RUNNING.
      enum:
      - Stopped
      - Running
      - Waiting
      - StopInitiated
      - StartInitiated
      - RebootInitiated
      - Other
    eCertificateConsumeSourceType:
      type: string
      description: Indicates that OPERA E-Certificate is consumed by hotelPMS.
      enum:
      - Central
      - Web
      - Hotel
    upsellInfoType:
      type: object
      description: Information regarding upsell for a reservation.
      properties:
        originalInfo:
          description: Original Values of the reservation prior to upgrade.
          type: object
          properties:
            rateCode:
              description: The Rate Code of the Reservation before it was upgraded
              type: string
              minLength: 0
              maxLength: 20
            totalAmount:
              description: Total Amount of the reservation before it was upgraded.
              $ref: '#/components/schemas/currencyAmountType'
            roomType:
              description: Original Reservation Room Type before being upgraded.
              $ref: '#/components/schemas/codeDescriptionType'
            nights:
              description: The number of nights of the reservation before being upgraded.
              type: integer
        upsellInfo:
          description: Information of a reservation during the process of upgrade.
          type: object
          properties:
            totalUpsellCharge:
              description: Amount that was charged for the upsell.
              $ref: '#/components/schemas/currencyAmountType'
            totalUpsellMoneyAmount:
              description: Total Amount that was charged including upsell.
              $ref: '#/components/schemas/currencyAmountType'
            firstNightUpsellAmount:
              description: First Night Total Amount including Upsell.
              $ref: '#/components/schemas/currencyAmountType'
            firstNightUpsellCharge:
              description: First Night Upsell Charges.
              $ref: '#/components/schemas/currencyAmountType'
            totalUpsellPoints:
              description: Total Upsell Points.
              type: integer
            totalActualRateAmount:
              description: Actual Total Room Rate for the Target Upsell Room Type.
              $ref: '#/components/schemas/currencyAmountType'
            roomType:
              description: Reservation Room Type for Upsell.
              $ref: '#/components/schemas/codeDescriptionType'
            roomLongDescription:
              description: Detail description of the Room Type.
              type: string
              minLength: 0
              maxLength: 2000
            ruleId:
              description: Upsell Rule Id.
              type: integer
            ruleCode:
              description: Upsell rule code
              type: string
              minLength: 0
              maxLength: 20
            ruleDescription:
              description: Upsell rule description
              type: string
              minLength: 0
              maxLength: 2000
            percentageSavings:
              description: Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)
              type: number
              minimum: 0
              maximum: 100
            upsellDate:
              description: The date on which reservation is upgraded.
              type: string
              format: date
              maxLength: 8
            upsellUser:
              description: User who upgraded the reservation.
              type: string
              minLength: 0
              maxLength: 40
    roomTypeAttributesType:
      type: object
      description: Attributes of property room type.
      properties:
        defaultOccupancy:
          description: Default occupancy of property room type.
          type: integer
        maximumOccupancy:
          description: Max occupancy of property room type.
          type: integer
        noOfPhysicalRooms:
          description: Number of physical rooms of property room type.
          type: integer
    availRatePlanInfoType:
      type: object
      description: The rate plan element is used to contain all the rate information for a single Rate Plan
      properties:
        ratePlan:
          description: Rate plan information
          type: array
          maxItems: 4000
          items:
            type: object
            properties:
              shortInfo:
                description: Brief Information of the Rate Code.
                type: string
                minLength: 0
                maxLength: 2000
              longInfo:
                description: Detail Information of the Rate Code.
                type: string
                minLength: 0
                maxLength: 2000
              webPage:
                description: URL providing more information about the Rate Code.
                type: string
                minLength: 0
                maxLength: 2000
              description:
                description: Description of the Rate Code.
                type: string
                minLength: 0
                maxLength: 2000
              ratePlanChannelInfo:
                description: To populate RatePlanLevel, RatePlanWebName, and RatePlanID according to the setup made under channel.
                $ref: '#/components/schemas/ratePlanChannelInfoType'
              currencyCode:
                description: Currency Code of the rate code.
                type: string
                minLength: 0
                maxLength: 20
              bookingChannelMappings:
                description: Booking Channel mapping for the Rate Plan Code.
                type: array
                maxItems: 4000
                items:
                  $ref: '#/components/schemas/bookingChannelMappingType'
              ratePlanLevel:
                description: All rate codes are associated with rate plan level ( or rate category )for Channels. So if rate plans are given in the request, get all rate codes associated with the rate plan level.
                type: string
                minLength: 0
                maxLength: 20
              guarantee:
                description: Guarantee details for rate plan code.
                $ref: '#/components/schemas/guaranteeType'
              cancelPenalty:
                description: Cancellation details for rate plan code.
                $ref: '#/components/schemas/cancelPenaltyType'
              mealPlans:
                description: Meal plan codes for rate plan code.
                $ref: '#/components/schemas/mealPlansType'
              ratePlanCode:
                type: string
                minLength: 0
                maxLength: 20
              hotelId:
                type: string
                minLength: 0
                maxLength: 20
              ratePlanCategory:
                type: string
                minLength: 0
                maxLength: 20
              taxInclusive:
                description: Indicates if tax is included in the rate code amount.
                type: boolean
              serviceFeeInclusive:
                description: Indicates if service fee is included in the rate code amount.
                type: boolean
              rateCommission:
                description: Commission details for Rate plan code.
                $ref: '#/components/schemas/ratePlanCommissionType'
              resGuarantees:
                description: A collection of Guarantee Codes information with cancellation penalty and deposit policy information.
                $ref: '#/components/schemas/guaranteePoliciesType'
              negotiatedBy:
                description: If Rate plane is negotiated by Guest or any attached profiles, this indicates how negotiated it. Applicable values are Guest, Company, Agent and Source.
                $ref: '#/components/schemas/profileTypeType'
              marketCode:
                description: Holds the market code.
                type: string
                minLength: 0
                maxLength: 20
              sourceCode:
                description: Holds the source code.
                type: string
                minLength: 0
                maxLength: 20
              hotelUseOnly:
                description: If true, indicates this rates is not allowed to be sold by CRO. For CRO this is information only.
                type: boolean
              discountAllowed:
                description: If true, indicates additional discount could be applied on the Rate.
                type: boolean
              credentialsRequired:
                description: If true, indicates that credentials is required to sell the rate code.
                type: boolean
              postingInterval:
                description: Specifies the frequency at which charges are posted for this rate plan.
                type: string
                minLength: 0
                maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    iATAInfoType:
      type: object
      description: IATA Information of the profile.
      properties:
        iATACompany:
          description: IATA Company Detail.
          type: string
          minLength: 0
          maxLength: 20
        iATAConsortia:
          description: IATA Consortia.
          type: string
          minLength: 0
          maxLength: 40
        iATAValidationResult:
          description: IATA Validation Result.
          type: boolean
    preferenceTypeType:
      type: object
      description: Preference details for the profile.
      properties:
        preference:
          description: Collection of Preferences for the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/preferenceType'
        preferenceType:
          description: Preference group code.
          type: string
          minLength: 0
          maxLength: 20
        preferenceTypeDescription:
          description: Preference group description.
          type: string
        sequence:
          description: Preference Sequence.
          type: string
        maxQuantity:
          description: Maximum quantity of preferences allowed per preference group.
          type: integer
        availableQuantity:
          description: Available quantity of preferences (maximum quantity - Existing preferences)per preference group.
          type: integer
        maxResortUsedQuantity:
          description: Maximum quantity of preferences used by any resort per preference group.
          type: integer
        reservationPreference:
          description: Whether this preference is reservation preference or not.
          type: boolean
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
    guestCountsType:
      type: object
      description: A collection of GuestCount by age group.
      properties:
        childAges:
          description: Defines Children's Ages. Number of children ages mentioned may mot match with children counts.
          $ref: '#/components/schemas/childAgesType'
        childBuckets:
          description: Defines children counts with Age Qualifying Group(Child Bucket#1) classification.
          $ref: '#/components/schemas/childBucketsType'
        adults:
          description: Defines the number of Adults.
          type: integer
        children:
          description: Defines the number of Children.
          type: integer
    emailType:
      type: object
      description: Information on an email for the customer.
      properties:
        emailAddress:
          description: Defines the e-mail address.
          type: string
          minLength: 0
          maxLength: 2000
        type:
          description: Defines the purpose of the e-mail address (e.g. personal, business, listserve).
          type: string
          minLength: 0
          maxLength: 20
        typeDescription:
          description: Describes the Type code
          type: string
          minLength: 0
          maxLength: 2000
        emailFormat:
          description: Supported Email format.
          type: string
          enum:
          - Html
          - Text
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
    rateAnalysisType:
      type: object
      description: Analysis type which would be returned by the Analysis procedure.
      properties:
        description:
          description: The description of the restriction which was analyzed.
          type: string
          minLength: 0
          maxLength: 2000
        date:
          description: The date of the analysis.
          type: string
          format: date
          maxLength: 8
        code:
          description: The type of restriction currently applicable to the date.
          $ref: '#/components/schemas/rateAnalysisCodeType'
    uRLType:
      type: object
      description: Web site address, in IETF(The Internet Engineering Task Force) specified format.
      properties:
        value:
          type: string
          description: Property Value
        type:
          description: Defines the purpose of the URL address, such as personal, business, public, etc.
          type: string
          minLength: 0
          maxLength: 20
        typeDescription:
          description: Describes the Type code
          type: string
          minLength: 0
          maxLength: 2000
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    companyType:
      type: object
      properties:
        companyName:
          description: Name of the company.
          type: string
          minLength: 0
          maxLength: 40
        companyName2:
          description: Second Name of the company.
          type: string
          minLength: 0
          maxLength: 40
        companyName3:
          description: Third Name of the company.
          type: string
          minLength: 0
          maxLength: 40
        alternateName:
          description: Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.
          type: string
          minLength: 0
          maxLength: 40
        alternateLanguage:
          description: Alternate Language of the company.
          type: string
          minLength: 0
          maxLength: 20
        businessLocale:
          description: A jurisdiction(Territory) in which a company is authorized to do business.
          type: string
          minLength: 0
          maxLength: 40
        iATAInfo:
          description: IATA Information of the profile.
          $ref: '#/components/schemas/iATAInfoType'
        businessTitle:
          description: Business Title.
          type: string
          minLength: 0
          maxLength: 80
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        nationality:
          description: Nationality code identification
          type: string
          minLength: 0
          maxLength: 20
        nationalityDescription:
          description: Nationality code description
          type: string
          minLength: 0
          maxLength: 80
        commissionCode:
          description: Commission code of the company.
          type: string
          minLength: 0
          maxLength: 20
        creditRating:
          description: Credit Rating of the company.
          type: string
          minLength: 0
          maxLength: 20
        corporateIdType:
          description: The type of corporate ID
          type: string
          minLength: 0
          maxLength: 20
        vipStatus:
          description: VIP status of the company.
          type: string
          minLength: 0
          maxLength: 20
        vipDescription:
          description: Description of the VIP status.
          type: string
          minLength: 0
          maxLength: 2000
        blacklist:
          description: This element tells if profile is blacklisted or not.
          type: boolean
    changeRelationsType:
      type: object
      description: Detailed information regarding the changes made to relationships for the profile.
      properties:
        id:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        relation:
          description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 20
        relationDescription:
          description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetRelation:
          description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 20
        targetRelationDescription:
          description: Displays the description of the target relation(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
    stayHistoryListType:
      type: object
      description: A collection of reservation history details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : History reservation details'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayReservationInfoType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    ratePlanChannelInfoType:
      type: object
      properties:
        ratePlanLevel:
          description: All rate codes are associated with rate plan level ( or rate category )for Channels. So if rate plans are given in the request, get all rate codes associated with the rate plan level.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanId:
          description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
          type: object
          properties:
            url:
              description: URL that identifies the location associated with the record identified by the UniqueID.
              type: string
            type:
              description: A reference to the type of object defined by the UniqueID element.
              type: string
              minLength: 0
              maxLength: 20
            instance:
              description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
              type: string
              minLength: 0
              maxLength: 80
            idContext:
              description: Used to identify the source of the identifier (e.g., IATA, ABTA).
              type: string
              minLength: 0
              maxLength: 80
            id:
              description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
              type: string
              minLength: 0
              maxLength: 80
            idExtension:
              description: Additional identifying value assigned by the creating system.
              type: integer
        ratePlanWebName:
          description: To populate the RatePlanName, setup for the channel.
          type: string
          minLength: 0
          maxLength: 80
    reservationAllowedActionsType:
      type: array
      description: Allowed action.
      maxItems: 11
      items:
        $ref: '#/components/schemas/reservationAllowedActionType'
    vIPType:
      type: object
      description: The supplier's ranking of the customer.
      properties:
        vipCode:
          description: VIP Code.
          type: string
          minLength: 0
          maxLength: 20
        vipDescription:
          description: VIP Description.
          type: string
          minLength: 0
          maxLength: 80
    searchMatchesType:
      type: array
      description: List of Generic Name-Value-Pair Parameters used for super search matches.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/searchMatchType'
    ratePostingIntervalEnum:
      type: string
      enum:
      - Nightly
      - Weekly
      - Monthly
    eventSpaceMaxOccupanciesType:
      type: array
      description: List of event space max occupancy.
      maxItems: 5
      items:
        type: integer
    languageType:
      type: string
      minLength: 0
      maxLength: 40
    taxType:
      type: object
      description: Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
      properties:
        description:
          type: string
          minLength: 0
          maxLength: 2000
        type:
          description: Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).
          $ref: '#/components/schemas/amountDeterminationType'
        code:
          description: Code identifying the fee (e.g.,agency fee, municipality fee).
          type: string
          minLength: 0
          maxLength: 20
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    rateAnalysisDetails:
      type: object
      description: Response to the fetch Rate Availability Analysis.
      properties:
        analysis:
          description: Rate availability analysis record for each date of the stay.
          type: array
          items:
            $ref: '#/components/schemas/rateAnalysisType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    resPreConfiguredRoutingInstrType:
      type: object
      description: Instruction to attach Pre-Configured Routing Instructions to a Reservation.
      properties:
        ratePlanCode:
          description: Rate Code with attached Routing Instruction.
          type: string
          minLength: 0
          maxLength: 20
        profileType:
          description: Profile Type with attached Routing Instruction.
          $ref: '#/components/schemas/resProfileTypeType'
        promotionCode:
          description: Promotion Code with attached Complimentary Routing.
          type: string
          minLength: 0
          maxLength: 20
    functionArgumentsType:
      type: array
      description: Collection of function arguments and their corresponding values.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/functionArgumentType'
    searchHotelsDetails:
      type: object
      description: Response object to search hotel availability.
      properties:
        hotels:
          type: object
          properties:
            hotel:
              type: array
              items:
                $ref: '#/components/schemas/hotelSummaryInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    reservationBlockType:
      type: object
      description: Key information about the block for a reservation.
      properties:
        blockIdList:
          description: Collection of unique block identifiers for the reservation.
          $ref: '#/components/schemas/blockIdList'
        blockName:
          description: The Name of the block that is attached to the reservation.
          type: string
          minLength: 0
          maxLength: 40
        hotelId:
          description: This is the HotelCode of the Block.
          type: string
          minLength: 0
          maxLength: 20
    anonymizationStatusType:
      type: string
      description: Guest has been anonymized.
      enum:
      - Requested
      - Anonymized
    characterUDFType:
      type: object
      description: Used to hold user defined field of Character/String Type.
      properties:
        name:
          description: Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: string
          minLength: 0
          maxLength: 2000
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    policyDeadlineType:
      type: object
      description: Cancellation deadline, absolute or relative.
      properties:
        absoluteDeadline:
          description: Defines the absolute deadline. Either this or the offset attributes may be used.
          type: string
          format: date-time
        offsetFromArrival:
          description: The number of days before arrival that allows cancellation without penalties.
          type: integer
        offsetDropTime:
          description: Time on offset day the cancellation penalties applies.
          type: string
          format: date-time
        offsetFromBookingDate:
          description: The number of days after booking deposit must be paid.
          type: integer
    packageElementType:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/currencyAmountType'
        allowance:
          $ref: '#/components/schemas/currencyAmountType'
        description:
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 2000
        startDate:
          type: string
          format: date
          maxLength: 8
        endDate:
          type: string
          format: date
          maxLength: 8
        packageCode:
          type: string
        calculationRule:
          type: string
        postingRhythm:
          type: string
        quantity:
          type: integer
        includedInRate:
          type: boolean
        addRateSeprateLine:
          type: boolean
        addRateCombinedLine:
          type: boolean
        startTime:
          type: string
        endTime:
          type: string
        sellSeparate:
          type: boolean
    childAgeType:
      type: object
      description: Defines Child's Age.
      properties:
        age:
          description: Age of a child in years.
          type: integer
    roomTypeInfoType:
      type: object
      properties:
        longDescription:
          description: Detail description of the Room Type.
          type: string
          minLength: 0
          maxLength: 2000
        webName:
          description: Name corresponding to a RoomType.
          type: string
          minLength: 0
          maxLength: 80
        webPage:
          description: URL providing more information about the Room Type.
          type: string
          minLength: 0
          maxLength: 2000
        roomFeatures:
          description: Collection of room features.
          $ref: '#/components/schemas/roomFeaturesType'
        roomTypeAttributes:
          description: Room type attributes.
          $ref: '#/components/schemas/roomTypeAttributesType'
        bookingChannelMappings:
          description: Booking Channels mapping for the Room Type.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/bookingChannelMappingType'
        bedTypeCodes:
          description: Bed type code associated with room.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        roomType:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        roomClass:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
        suite:
          description: Indicates room type is a suite.
          type: boolean
        component:
          description: Indicates room type is a Component Room.
          type: boolean
        invBlockCode:
          description: Block code.
          type: string
          minLength: 0
          maxLength: 40
        roomViewCode:
          description: Represents the room view code like City view, River view, Ocean view etc.
          type: string
          minLength: 0
          maxLength: 40
        promotionCode:
          description: Represents the promotional code.
          type: string
          minLength: 0
          maxLength: 40
        roomQualifierCode:
          description: Represents the room qualifier code like Deluxe,Economy,Suite etc.
          type: string
          minLength: 0
          maxLength: 40
        roomQualifierMatchIndicator:
          description: Represents the match indicator of room qualifier code returned in the response with the requested room qualifier code.
          type: string
          minLength: 0
          maxLength: 20
    gdsNegotiatedType:
      type: object
      description: This holds a list of GdsNegotiatedInfoType.
      properties:
        gdsNegotiatedInfoList:
          description: List of channel negotiated rates for the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/gdsNegotiatedInfoType'
        bookingChannelCode:
          description: Booking Channel Code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        channelRatePlanCode:
          description: Channel Room Type.
          type: string
          minLength: 0
          maxLength: 20
    profileAccessType:
      type: object
      properties:
        chainCode:
          description: Indicates the Chain code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        croCode:
          description: Indicates the CRO code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        hotelId:
          description: Indicates the Hotel code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        sharedLevel:
          description: 'Indicates whether the profile is shared at the following levels : global/property/CRO'
          $ref: '#/components/schemas/profileSharedLevelType'
    profileType:
      type: object
      description: Type provides the detailed information about the profile and its children.
      properties:
        customer:
          description: Detailed customer information for this profile.
          $ref: '#/components/schemas/customerType'
        company:
          description: Detailed company information for this profile.
          $ref: '#/components/schemas/companyType'
        profileImage:
          description: The profile image.
          $ref: '#/components/schemas/imageSetType'
        addresses:
          description: List of customer addresses.
          type: object
          properties:
            addressInfo:
              description: Collection of Detailed information on an address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/addressInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        businessSegments:
          description: Business/Market Segment associated to the profile.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        territory:
          description: Territory associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        traceCode:
          description: Trace Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        ownerCode:
          description: Owner Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        influenceCode:
          description: Influence Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        telephones:
          description: List of Telephone Number Information
          type: object
          properties:
            telephoneInfo:
              description: Collection of Detailed information on telephone/fax for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/telephoneInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        emails:
          description: List of email address for the customer.
          type: object
          properties:
            emailInfo:
              description: Collection of Detailed information on an eMail address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/emailInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        uRLs:
          description: List of Information on a URL for the customer.
          type: object
          properties:
            uRLInfo:
              description: Collection of Detailed information on web url/address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/uRLInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        comments:
          description: List of Notes for the customer.
          type: object
          properties:
            commentInfo:
              description: Collection of Detailed information on comments for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/commentInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        profileDeliveryMethods:
          description: List of Delivery methods configured against a Property for this Profile.
          type: object
          properties:
            profileDeliveryMethod:
              description: Collection of delivery methods for this Profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/profileDeliveryMethod'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        profileMemberships:
          description: List of loyalty program(s) the profile is subscribed to.
          type: object
          properties:
            profileMembership:
              description: Collection of Detailed information on memberships for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/profileMembershipType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        preferenceCollection:
          description: List of customer preferences.
          type: object
          properties:
            preferenceType:
              description: Collection of Detailed information on preferences of the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/preferenceTypeType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        keywords:
          description: List of customer keywords.
          type: object
          properties:
            keyword:
              description: Collection of keywords attached to the profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/keywordType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        negotiatedRates:
          description: List of profile negotiated rates.
          type: object
          properties:
            negotiatedRate:
              description: Collection of Detailed information on profile negotiated rates.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/negotiatedType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        gdsNegotiatedRates:
          description: List of channel negotiated rates that this profile has been assigned to.
          type: object
          properties:
            gdsNegotiatedRate:
              description: Collection of Detailed information on channel negotiated rates for the profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/gdsNegotiatedType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        profileIndicators:
          description: Indicators of additional information attached to the profile
          $ref: '#/components/schemas/indicatorsType'
        relationships:
          description: Contains a collection of profiles that have a relationship with this profile.
          type: object
          properties:
            relationship:
              description: A collection of the profiles that have a relationship with this profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/relationshipInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        relationshipsSummary:
          description: Contains a collection of profiles that have a relationship with this profile.
          type: object
          properties:
            relationship:
              description: A collection of the profiles summary that have a relationship with this profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/relationshipInfoSummaryType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        reservationInfoList:
          description: Collection of Detailed information on history and future reservations associated with the profile.
          $ref: '#/components/schemas/reservationHistoryFutureInfoType'
        stayReservationInfoList:
          description: Collection of Detailed information on history and future reservations associated with the profile.
          $ref: '#/components/schemas/reservationStayHistoryFutureInfoType'
        lastStayInfo:
          description: Information on last stay of the profile.
          $ref: '#/components/schemas/lastStayInfoType'
        profileAccessType:
          description: Detailed information on access type associated with the profile.
          $ref: '#/components/schemas/profileAccessType'
        profileRestrictions:
          description: Detailed information on restrictions associated with the profile.
          $ref: '#/components/schemas/profileRestrictions'
        mailingActions:
          description: Contains collection of mailing action list associated with the profile
          $ref: '#/components/schemas/mailingActionsType'
        privacyInfo:
          description: Contains privacy related information associated with the profile
          $ref: '#/components/schemas/privacyInfoType'
        cashiering:
          description: Contains cashiering related details for the profile
          $ref: '#/components/schemas/profileCashieringType'
        commissionInfoList:
          description: Contains commission related details for the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/profileCommissionType'
        userDefinedFields:
          description: Collections of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
        webUserAccounts:
          description: List of Web User Accounts of the profile.
          $ref: '#/components/schemas/webUserAccountsType'
        taxInfo:
          description: Profile information about tax.
          $ref: '#/components/schemas/profileTaxInfoType'
        salesInfo:
          description: Sales information of the profiles.
          $ref: '#/components/schemas/salesInfoType'
        eCertificates:
          description: E-Certificate assosiated with the profile.
          $ref: '#/components/schemas/eCertificatesType'
        subscriptions:
          description: List of profile subscriptions.
          $ref: '#/components/schemas/profileSubscriptionListType'
        localizationGuestType:
          description: Localization Guest Type assocaited to the profile.
          type: string
          minLength: 0
          maxLength: 20
        eligibleForFiscalFolio:
          description: Eligible for Fiscal Folio/Payload generation.
          type: string
          minLength: 0
          maxLength: 20
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
        statusCode:
          description: Status of the profile. Active/Inactive
          $ref: '#/components/schemas/profileStatusType'
        registeredProperty:
          description: Hotel which this profile is registered with. This attribute is not used for configuration.
          type: string
          minLength: 0
          maxLength: 20
        requestForHotel:
          description: Hotel which this profile is to be registered. This attribute is only used during creation of profile.
          type: string
          minLength: 0
          maxLength: 20
        protectedBy:
          description: What level this profile is protected.
          type: string
          minLength: 0
          maxLength: 40
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
        markAsRecentlyAccessed:
          description: Mark this profile as recently accessed.
          type: boolean
        markForHistory:
          description: '"true" setting marks the profile to be kept from being purged, once the profile is marked inactive.'
          type: boolean
        hasCommission:
          description: Populates true if the profile has commission configured false otherwise.
          type: boolean
        inheritedNegRates:
          description: Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.
          type: boolean
    paragraphType:
      type: object
      description: An indication of a new paragraph for a sub-section of a formatted text message.
      properties:
        text:
          description: Formatted text content.
          $ref: '#/components/schemas/formattedTextTextType'
        image:
          description: An image for this paragraph.
          type: string
        url:
          description: A URL for this paragraph.
          type: string
    anonymizationType:
      type: object
      description: Provides information about guest's anonymization status.
      properties:
        anonymizationStatus:
          description: Status of anonymization such as Requested or Anonymized.
          $ref: '#/components/schemas/anonymizationStatusType'
        anonymizationDate:
          description: Date and Time when the guest was anonymized.
          type: string
          format: date-time
    hotelInterfaceTypeType:
      type: string
      enum:
      - Bms
      - Cas
      - Ccw
      - Dls
      - Eft
      - Exp
      - Mak
      - Mbs
      - Msc
      - Pbx
      - Pos
      - Svs
      - Tik
      - Vid
      - Vms
      - Www
      - Xml
      description: XML Posting Interface
    couponInfoType:
      type: object
      description: Information about the coupon.
      properties:
        couponCode:
          description: Coupon code to validate.
          type: string
          minLength: 0
          maxLength: 40
        promotionCode:
          description: Promotion Code to which the coupon belongs.
          type: string
          minLength: 0
          maxLength: 20
        limitedUse:
          description: Indicates if promotion code is of limited use type. This is set to true if it is either set on property or template
          type: boolean
    promotionCouponValidationDetails:
      type: object
      description: Response for validating a coupon.
      properties:
        couponInfo:
          description: Coupon information.
          $ref: '#/components/schemas/couponInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html
x-refined-from:
- oracle-hospitality-property-v1-chl.json
- oracle-hospitality-property-v1-par.json
- oracle-hospitality-property-v1-rtp.json