openapi: 3.2.0
info:
  title: Oracle Hospitality Profile Membership 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 ProfileMembership across 2 of this provider''s published API definitions: oracle-hospitality-property-outbound-crmoutbound.json, oracle-hospitality-property-v1-crm.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /crm/v1
tags:
- name: ProfileMembership
  description: This will allow you to create a guest profile enrollment in OPERA Cloud. Enrollment relates to a membership program, so as an example you can enrol the guest Mr Tom Smith into a Membership / loyalty program.
paths:
  /externalSystems/{extSystemCode}/chains/{chainCode}/enrollments:
    post:
      summary: Create an Enrollment
      description: Use this API when you have a guest profile and you want to enroll that guest profile into a membership program in an external system. <p><strong>OperationId:</strong>postEnrollment</p>
      operationId: postEnrollment
      parameters:
      - name: extSystemCode
        in: path
        required: true
        description: Profile will be downloaded from this External System.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: chainCode
        in: path
        required: true
        description: Chain code from which the External Profiles will be downloaded.
        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-transactionId'
      - $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/enrollment'
        '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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/enrollment'
        description: Request object to create profile enrollment.
        required: true
    servers:
    - url: /crm/v1
  /externalSystems/{extSystemCode}/profiles/{externalProfileId}/profileAwards:
    put:
      summary: Redeem an award
      description: Redeem an award that exists on a profile. <p><strong>OperationId:</strong>redeemAward</p>
      operationId: redeemAward
      parameters:
      - name: extSystemCode
        in: path
        required: true
        description: Profile will be downloaded from this External System.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: externalProfileId
        in: path
        required: true
        description: ''
        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-transactionId'
      - $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 for redeem award.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/award'
        '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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/award'
        description: Request object to redeem award.
        required: true
    servers:
    - url: /crm/v1
  /externalSystems/{extSystemCode}/profiles/{externalProfileId}/memberships:
    get:
      summary: Get membership information on a profile
      description: Use this API to retrieve membership details on a profile. <p><strong>OperationId:</strong>getMembershipDetails</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getMembershipDetails
      parameters:
      - name: extSystemCode
        in: path
        required: true
        description: Profile will be downloaded from this External System.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: externalProfileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: operaProfileId
        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: membershipType
        in: query
        required: false
        description: The type of the membership.
        schema:
          type: string
      - name: membershipId
        in: query
        required: false
        description: The card number associated with this membership.
        schema:
          type: string
      - name: hotelId
        in: query
        required: false
        description: Property from which the membership stay information was received.
        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: mode
        in: query
        required: false
        description: Whether member info search will pertain to transaction dates/ stay dates/ points credit dates.
        schema:
          type: string
          enum:
          - TransactionDate
          - StayBeginDate
          - StayEndDate
          - PointsCreditDate
          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-transactionId'
      - $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 member info.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/memberInformation'
        '204':
          description: MembershipDetails 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /airline/transactions:
    get:
      summary: Get airline transactions status
      description: Request for fetching membership transactions processed by the airline. <p><strong>OperationId:</strong>getAirlineTransactionsStatus</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getAirlineTransactionsStatus
      deprecated: true
      parameters:
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - 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: batchId
        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: batchIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: importDate
        in: query
        required: false
        description: The date when this batch was imported into OPERA
        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: Request object for fetching membership transactions processed by the airline.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/airlineTransactionsStatus'
        '204':
          description: AirlineTransactionsStatus 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /availableAwardsBasedOnType:
    get:
      summary: Get Available Awards
      description: Get available awards based on type of award selected like Rates, products or services, room type upgrades, and other gifts. <p><strong>OperationId:</strong>getAvailableAwardsBasedOnType</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getAvailableAwardsBasedOnType
      parameters:
      - name: awardBasedOn
        in: query
        required: false
        description: This award allows a guest to apply available membership points towards the balance of his or her bill.
        schema:
          type: string
          enum:
          - Rate
          - Product
          - Upgrade
          - Other
          - Ft
          - Discount
          uniqueItems: true
      - name: membershipType
        in: query
        required: false
        description: Membership type for which awards are defined.
        schema:
          type: string
      - name: rateCriteriaHotelId
        in: query
        required: false
        description: Hotel name where the award will be consumed.
        schema:
          type: string
      - name: arrivalDate
        in: query
        required: false
        description: Arrival date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: departureDate
        in: query
        required: false
        description: Departure date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: bookingDate
        in: query
        required: false
        description: Booking date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: pointsBelow
        in: query
        required: false
        description: Minimum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: pointsAbove
        in: query
        required: false
        description: Maximum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: rateCode
        in: query
        required: false
        description: Indicates rate code for the room type.
        schema:
          type: string
      - name: roomCategory
        in: query
        required: false
        description: Indicates which room category it belongs.
        schema:
          type: string
      - name: rooms
        in: query
        required: false
        description: Number of rooms that the member will be using.
        schema:
          type: string
      - name: awardType
        in: query
        required: false
        description: Indicates the award type or code.
        schema:
          type: string
      - name: productCriteriaMembershipType
        in: query
        required: false
        description: Membership type for which awards are defined.
        schema:
          type: string
      - name: productCriteriaHotelId
        in: query
        required: false
        description: Hotel name where the award will be consumed.
        schema:
          type: string
      - name: productCriteriaArrivalDate
        in: query
        required: false
        description: Arrival date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: productCriteriaDepartureDate
        in: query
        required: false
        description: Departure date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: productCriteriaBookingDate
        in: query
        required: false
        description: Booking date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: productCriteriaPointsBelow
        in: query
        required: false
        description: Minimum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: productCriteriaPointsAbove
        in: query
        required: false
        description: Maximum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: packageCode
        in: query
        required: false
        description: Package/Product code for the award to check availability.
        schema:
          type: string
      - name: upgradeCriteriaMembershipType
        in: query
        required: false
        description: Membership type for which awards are defined.
        schema:
          type: string
      - name: upgradeCriteriaHotelId
        in: query
        required: false
        description: Hotel name where the award will be consumed.
        schema:
          type: string
      - name: upgradeCriteriaArrivalDate
        in: query
        required: false
        description: Arrival date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: upgradeCriteriaDepartureDate
        in: query
        required: false
        description: Departure date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: upgradeCriteriaBookingDate
        in: query
        required: false
        description: Booking date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: upgradeCriteriaPointsBelow
        in: query
        required: false
        description: Minimum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: upgradeCriteriaPointsAbove
        in: query
        required: false
        description: Maximum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: fromRoomCategory
        in: query
        required: false
        description: Indicates availability of upgrade awards based on the room type(range of room types )
        schema:
          type: string
      - name: toRoomCategory
        in: query
        required: false
        description: Indicates availability of upgrade awards based on the room type(range of room types )
        schema:
          type: string
      - name: upgradeCriteriaRooms
        in: query
        required: false
        description: Number of rooms that the member will be using.
        schema:
          type: string
      - name: upgradeCriteriaAwardType
        in: query
        required: false
        description: Indicates the award type or code.
        schema:
          type: string
      - name: awardCode
        in: query
        required: false
        description: Unique code identifying the Award.
        schema:
          type: string
      - name: totalBillingAmount
        in: query
        required: false
        description: Total amount for the bill.
        schema:
          type: number
      - name: currencyCode
        in: query
        required: false
        description: The currency code for the member.
        schema:
          type: string
      - name: fTPaymentCriteriaPointsBelow
        in: query
        required: false
        description: Minimum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: fTPaymentCriteriaPointsAbove
        in: query
        required: false
        description: Maximum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: otherCriteriaAwardCode
        in: query
        required: false
        description: Unique code identifying the award.
        schema:
          type: string
      - name: otherCriteriaMembershipType
        in: query
        required: false
        description: Membership type for which awards are defined.
        schema:
          type: string
      - name: membershipLevel
        in: query
        required: false
        description: Level of this Membership Type.
        schema:
          type: string
      - name: shortDescription
        in: query
        required: false
        description: Name or code identifying the award.
        schema:
          type: string
      - name: valueBelow
        in: query
        required: false
        description: Amount of currency of the worth of the other award,below or actual value.
        schema:
          type: number
      - name: valueAbove
        in: query
        required: false
        description: Amount of currency of the worth of the other award,above or actual value.
        schema:
          type: number
      - name: otherCriteriaPointsBelow
        in: query
        required: false
        description: Minimum number of points the member is willing to redeem.
        schema:
          type: integer
      - name: otherCriteriaPointsAbove
        in: query
        required: false
        description: Maximum number of points the member is willing to redeem.
        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 object to fetch member available awards based on the type being passed.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/availableAwardsBasedOnType'
        '204':
          description: AvailableAwardsBasedOnType 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /awards:
    delete:
      summary: Delete Awards
      description: Operation to cancel an award already been granted to a member. <p><strong>OperationId:</strong>deleteAwards</p>
      operationId: deleteAwards
      parameters:
      - name: awardNumber
        in: query
        required: true
        description: An identifying number of the award, assigned by the system when the award was issued.
        schema:
          type: number
      - name: reservationCancellationNumber
        in: query
        required: false
        description: Identifies reservation cancellation number.
        schema:
          type: string
      - name: actualCancelPoints
        in: query
        required: false
        description: The amount of points that will be deducted for cancelling the award, from the total guest award points.
        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})*'
            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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /awardsToGrant:
    get:
      summary: Get Awards to Grant
      description: Fetch awards list to be able to grant the award to a member <p><strong>OperationId:</strong>getAwardsToGrant</p>
      operationId: getAwardsToGrant
      parameters:
      - name: awardBasedOn
        in: query
        required: false
        description: This award allows a guest to apply available membership points towards the balance of his or her bill.
        schema:
          type: string
          enum:
          - Rate
          - Product
          - Upgrade
          - Other
          - Ft
          - Discount
          uniqueItems: true
      - name: totalPointsRequired
        in: query
        required: false
        description: The number of points that must be redeemed for this award.
        schema:
          type: number
      - name: rooms
        in: query
        required: false
        description: Number of rooms that the member will be using.
        schema:
          type: string
      - name: membershipId
        in: query
        required: false
        description: Unique Membership ID to get award info.
        schema:
          type: number
      - name: membershipType
        in: query
        required: false
        description: Membership type for which awards are defined.
        schema:
          type: string
      - name: awardType
        in: query
        required: false
        description: Indicates the award type or code.
        schema:
          type: string
      - name: grantAwardInfoHotelId
        in: query
        required: false
        description: HotelCode where the award will be consumed.
        schema:
          type: string
      - name: rateCode
        in: query
        required: false
        description: Rate code associated with the award.
        schema:
          type: string
      - name: roomCategory
        in: query
        required: false
        description: Indicates which room category it belongs.
        schema:
          type: string
      - name: fromRoom
        in: query
        required: false
        description: Indicates room type code for the room prior to the upgrade.
        schema:
          type: string
      - name: toRoom
        in: query
        required: false
        description: Indicates room type code of the upgrade room.
        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 award details to grant an award.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/awardsToGrant'
        '204':
          description: AwardsToGrant 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /enrollments:
    post:
      summary: Create an Enrollment
      description: Use this API when you have a guest profile and you want to enroll that guest profile into a membership program in an external system. <p><strong>OperationId:</strong>postEnrollment</p>
      operationId: postEnrollment
      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:
        '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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/enrollment_2'
        description: Request object to create profile enrollment.
        required: true
    servers:
    - url: /crm/v1
  /hotels/{hotelId}/memberships/{membershipId}:
    get:
      summary: 'Get Membership Issued awards points '
      description: Get a memberships issued awards points per property. <p><strong>OperationId:</strong>getMembershipAwardPointsByHotel</p>
      operationId: getMembershipAwardPointsByHotel
      deprecated: true
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        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 fetching member award points by Hotel.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipAwardPointsByHotel'
        '204':
          description: MembershipAwardPointsByHotel 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /issueOtherAwards:
    post:
      summary: 'Issue an OTHER type award '
      description: This API will allow you to issue OTHER type award based on membership id or membership type and membership card number <p><strong>OperationId:</strong>issueOtherAwards</p>
      operationId: issueOtherAwards
      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:
        '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: Response object for issue awards.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/issuedAward'
        '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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/otherAwardsIssueCriteria'
        description: Request object to issue an OTHER type award to a member's profile.
        required: true
    servers:
    - url: /crm/v1
  /memberHistory:
    get:
      summary: Get primary membership history details of a guest.
      description: Use this API to retrieve primary membership history details of a profile. <p><strong>OperationId:</strong>getMembershipCardHistory</p>
      operationId: getMemberHistory
      parameters:
      - name: membershipId
        in: query
        required: false
        description: Membership Id of the member required to fetch the member history.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: actionType
        in: query
        required: false
        description: Type of action related to changes in a profile's primary membership.
        schema:
          type: string
          maxLength: 80
          minLength: 1
      - name: fromDate
        in: query
        required: false
        description: The date from which we want to see changes to membership
        schema:
          type: string
          format: date
      - name: toDate
        in: query
        required: false
        description: The date till which we want to see changes to membership
        schema:
          type: string
          format: date
      - name: user
        in: query
        required: false
        description: The user who modified profile's primary membership.
        schema:
          type: string
          maxLength: 256
          minLength: 1
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 20
          maximum: 200
      - 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: 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 list of membership history.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/memberHistoryList'
        '204':
          description: memberHistory 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /membershipClaims:
    get:
      summary: Get membership claims
      description: Retrieve available membership claims without specifying the membership ID. <p><strong>OperationId:</strong>getAllMembershipClaims</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getAllMembershipClaims
      parameters:
      - name: membershipId
        in: query
        required: false
        description: Id to get the claims.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: profileIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: profileIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: name
        in: query
        required: false
        description: Family name, last name or Company Name.
        schema:
          type: string
      - name: givenName
        in: query
        required: false
        description: Given name, first name or names.
        schema:
          type: string
      - name: membershipType
        in: query
        required: false
        description: Membership Type code.
        schema:
          type: string
      - name: claimType
        in: query
        required: false
        description: Type of user-definable claim to be searched.
        schema:
          type: string
      - name: source
        in: query
        required: false
        description: Source of the membership claim.
        schema:
          type: string
          enum:
          - Ocis
          - Opms
          - Web
          uniqueItems: true
      - name: owner
        in: query
        required: false
        description: Unique application user ID of the person responsible for handling the claim.
        schema:
          type: string
      - name: claimNumber
        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: claimNoContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: claimNoType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: hotelId
        in: query
        required: false
        description: Property where the stay took place.
        schema:
          type: string
      - name: confirmationNo
        in: query
        required: false
        description: Reservation confirmation or booking reference number.
        schema:
          type: string
      - name: submitter
        in: query
        required: false
        description: Application user ID of the user who entered the claim.
        schema:
          type: string
      - name: claimStatus
        in: query
        required: false
        description: Status of the claim.(Open, Waiting for Manager, etc.)
        schema:
          type: string
      - name: closeDateEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: closeDateStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: claimDateEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: claimDateStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: replyByEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: replyByStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: departureEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: departureStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: approvalStatus
        in: query
        required: false
        description: Claim approve or reject status.
        schema:
          type: string
          enum:
          - Approved
          - Rejected
          - Pending
          uniqueItems: true
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 20
      - 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: 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 fetching membership claims.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipClaims'
        '204':
          description: MembershipClaims 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:
      - ProfileMembership
    post:
      summary: Create membership Claim
      description: This will create membership claim details based on the claim number and instructions provided in the request. <p><strong>OperationId:</strong>postMembershipClaim</p>
      operationId: postMembershipClaim
      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:
        '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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipClaim'
        description: Request object for creating membership claim.
        required: true
    servers:
    - url: /crm/v1
  /membershipClaims/{claimId}:
    get:
      summary: 'Get membership claim '
      description: Get membership claim details based on the claim number and instructions provided in the request. <p><strong>OperationId:</strong>getMembershipClaim</p>
      operationId: getMembershipClaim
      parameters:
      - name: claimId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: id
        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: idContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: type
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: fetchInstructions
        in: query
        description: Simple type for membership claim instructions that can be used in requests for partial operations.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - ClaimDetail
            - ClaimActivityLog
          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 for fetching membership claim.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipClaim'
        '204':
          description: MembershipClaim 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:
      - ProfileMembership
    put:
      summary: Change membership Claim
      description: Change membership claim details based on the claim number and instructions provided in the request. <p><strong>OperationId:</strong>changeMembershipClaim</p>
      operationId: changeMembershipClaim
      parameters:
      - name: claimId
        in: path
        required: true
        description: ''
        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/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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipClaim'
        description: Request object for changing membership claim information.
        required: true
    servers:
    - url: /crm/v1
  /membershipPoints/calculations:
    post:
      summary: Calculate Membership Points
      description: Start Membership Points Calculation process <p><strong>OperationId:</strong>calculateMembershipPoints</p>
      operationId: calculateMembershipPoints
      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:
        '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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipPointsToCalculate'
        description: Request to run membership points calculation job.
        required: true
    servers:
    - url: /crm/v1
  /membershipPointsExceptions:
    get:
      summary: Get membership points exception details
      description: Use this API to get membership points exceptions.<p><strong>OperationId:</strong>getMembershipPointsExceptions</p><br>The maximum date Range supported between arrival and departure date is 90 days.
      operationId: getMembershipPointsExceptions
      parameters:
      - name: hotelId
        in: query
        required: false
        description: Membership transaction belongs to which Hotel.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: profileId
        in: query
        required: false
        description: Profile Id of the guest.
        schema:
          type: number
      - name: arrivalFrom
        in: query
        required: false
        description: Arrival From Date to fetch the reservations flagged for Membership Points Exception
        schema:
          type: string
          format: date
      - name: departureTo
        in: query
        required: false
        description: Departure To Date to fetch the reservation flagged for Membership Points Exception
        schema:
          type: string
          format: date
      - name: membershipType
        in: query
        required: false
        description: The type of the membership.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: membershipLevel
        in: query
        required: false
        description: The current level of the membership.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: membershipCardNo
        in: query
        required: false
        description: The card number associated with this membership.
        schema:
          type: string
          maxLength: 50
          minLength: 1
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 20
      - 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: 1
      - name: exceptionStatus
        in: query
        required: true
        description: Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,
        schema:
          type: string
          items:
            type: string
            enum:
            - AllExceptions
            - PointsAwardedOnException
            - PointsRejectedOnException
            - ExceptionNotResolved
          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 for fetching membership points exceptions.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/memberPointsExceptions'
        '204':
          description: MembershipPointsExceptions 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:
      - ProfileMembership
    put:
      summary: Update membership points exceptions
      description: Use this API to update membership points exceptions.<p><strong>OperationId:</strong>putMembershipPointsExceptions</p>
      operationId: putMembershipPointsExceptions
      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})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipPointsExceptions'
        description: Request object for updating membership points exceptions.
        required: true
    servers:
    - url: /crm/v1
  /membershipReservationActivity:
    get:
      summary: Get Membership Reservation Activity
      description: This API is useful to retrieve membership reservation activity for the day(ExpectedArrival, ExpectedDepartures, InHouse, Projected Room Revenue) <p><strong>OperationId:</strong>getMembershipReservationActivity</p>
      operationId: getMembershipReservationActivity
      parameters:
      - name: hotelIds
        in: query
        description: Unique ID of the hotels to fetch the membership reservation activity.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: propertyDate
        in: query
        required: false
        description: Business Date of the property selected.
        schema:
          type: string
          format: date
      - name: roomClasses
        in: query
        description: Room Classes required to fetch the membership reservation activity.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 100
      - name: membershipType
        in: query
        description: Membership Type required to fetch the membership reservation activity.
        required: false
        schema:
          type: string
          maxLength: 20
          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 element for membership Reservation Details.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipReservationDetails'
        '204':
          description: Statistics 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /membershipTransactions/{membershipTransactionId}:
    get:
      summary: Get a membership transaction
      description: Retrieve membership transactions. <p><strong>OperationId:</strong>getMembershipTransaction</p>
      operationId: getMembershipTransaction
      parameters:
      - name: membershipTransactionId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: id
        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: idContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: type
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        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 fetching a membership transaction.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipTransaction'
        '204':
          description: MembershipTransaction 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /membershipTransactions/{membershipTransactionId}/awardPoints:
    get:
      summary: Fetch the Award Points Accrued for the current points transaction.
      description: Retrieves the validated rule used to generate award points, the type of points, number of points, cost per point, rule code for the award points, billing group the points belong. <p><strong>OperationId:</strong>getMembershipTransactionAwardPoints</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getMembershipTransactionAwardPoints
      parameters:
      - name: membershipTransactionId
        in: path
        required: true
        description: ''
        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: 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
      - $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 membership transaction points information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/calculatedPoints'
        '204':
          description: MembershipTransactionAwardPoints 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /membershipTransactions/{membershipTransactionId}/pointRejectionReasons:
    get:
      summary: Fetch the reason points were not awarded for a given points transaction.
      description: Retrieves the rule used to generate points and the reason the points were not awarded (validation failure, for e.g.'Membership level requirements not met'). <p><strong>OperationId:</strong>getMembershipTransactionPointsRejectionReasons</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getMembershipTransactionPointsRejectionReasons
      parameters:
      - name: membershipTransactionId
        in: path
        required: true
        description: ''
        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: 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
      - $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 member transactions points rejection reasons information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/pointsRejectionReasons'
        '204':
          description: MembershipTransactionPointsRejectionReasons 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /membershipTransactions/{membershipTransactionId}/rates:
    get:
      summary: Fetch the rate details associated to current points transaction.
      description: Retrieves the dates of the stay, the rate code, the PMS rate amount, the central rate amount, the central currency and the market code associated with the stay. <p><strong>OperationId:</strong>getMembershipTransactionRates</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getMembershipTransactionRates
      parameters:
      - name: membershipTransactionId
        in: path
        required: true
        description: ''
        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: 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
      - $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 Membership Transaction Rates information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rates'
        '204':
          description: MembershipTransactionRates 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /membershipTransactions/{membershipTransactionId}/revenue:
    get:
      summary: Fetch the revenue details for the stay associated with current point transaction.
      description: Retrieves the date the revenue was recognized, the revenue type (PMS revenue buckets are seen as revenue types in ORS), PMS revenue and central <p><strong>OperationId:</strong>getMembershipTransactionRevenue</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getMembershipTransactionRevenue
      parameters:
      - name: membershipTransactionId
        in: path
        required: true
        description: ''
        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: 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
      - $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 Membership Transaction Revenue.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/revenues'
        '204':
          description: MembershipTransactionRevenue 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /membershipTransactions/{membershipTransactionId}/tierPoints:
    get:
      summary: Fetch the Tier Points Accrued for the current points transaction
      description: Retrieves the validated rule used to generate tier points, the type of points, number of points, cost per point, rule code for the award points, billing group the points belong. <p><strong>OperationId:</strong>getMembershipTransactionTierPoints</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getMembershipTransactionTierPoints
      parameters:
      - name: membershipTransactionId
        in: path
        required: true
        description: ''
        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: 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
      - $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 membership transaction points information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/calculatedPoints'
        '204':
          description: MembershipTransactionTierPoints 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/award:
    get:
      summary: Export Membership Award
      description: Export members information for Fulfillment house processing <p><strong>OperationId:</strong>exportMembershipAward</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: exportMembershipAward
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: rateInfoHotelId
        in: query
        required: false
        description: HotelCode where the award will be consumed.
        schema:
          type: string
      - name: totalAvailablePoints
        in: query
        required: false
        description: Total award points available for redemption.
        schema:
          type: number
      - name: pointsRequired
        in: query
        required: false
        description: The number of points that must be redeemed for this award.
        schema:
          type: number
      - name: cancelPenaltyPoints
        in: query
        required: false
        description: The award points that will be forfeited if the cancel penalty charge is applied.
        schema:
          type: number
      - name: cancelPenaltyDays
        in: query
        required: false
        description: Number of days before arrival when a reservation may be cancelled without an award points penalty.
        schema:
          type: number
      - name: cancelPenaltyCharge
        in: query
        required: false
        description: The cancel penalty charge.
        schema:
          type: number
      - name: cancelPenaltyType
        in: query
        required: false
        description: The penalty charge is either a percentage or a flat number of points.
        schema:
          type: string
      - name: rawIssueKey
        in: query
        required: false
        description: Issue key in format of Raw data.
        schema:
          type: string
      - name: awardNumber
        in: query
        required: false
        description: An identifying number of the award, assigned by the system when the award was issued.
        schema:
          type: number
      - name: rateCode
        in: query
        required: false
        description: Rate code associated with the award.
        schema:
          type: string
      - name: rateDescription
        in: query
        required: false
        description: Rate code description associated with the award.
        schema:
          type: string
      - name: roomLabel
        in: query
        required: false
        description: Code for the room type in which the award was issued.
        schema:
          type: string
      - name: roomDescription
        in: query
        required: false
        description: Description of the Room.
        schema:
          type: string
      - name: roomCategory
        in: query
        required: false
        description: Indicates which room category it belongs.
        schema:
          type: string
      - name: stayDate
        in: query
        required: false
        description: The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.
        schema:
          type: string
          format: date
      - name: awardType
        in: query
        required: false
        description: Unique code that identifies this award.
        schema:
          type: string
      - name: productInfoHotelId
        in: query
        required: false
        description: HotelCode where the award will be consumed.
        schema:
          type: string
      - name: productInfoTotalAvailablePoints
        in: query
        required: false
        description: Total award points available for redemption.
        schema:
          type: number
      - name: productInfoPointsRequired
        in: query
        required: false
        description: The number of points that must be redeemed for this award.
        schema:
          type: number
      - name: productInfoCancelPenaltyPoints
        in: query
        required: false
        description: The award points that will be forfeited if the cancel penalty charge is applied.
        schema:
          type: number
      - name: productInfoCancelPenaltyDays
        in: query
        required: false
        description: Number of days before arrival when a reservation may be cancelled without an award points penalty.
        schema:
          type: number
      - name: productInfoCancelPenaltyCharge
        in: query
        required: false
        description: The cancel penalty charge.
        schema:
          type: number
      - name: productInfoCancelPenaltyType
        in: query
        required: false
        description: The penalty charge is either a percentage or a flat number of points.
        schema:
          type: string
      - name: productInfoRawIssueKey
        in: query
        required: false
        description: Issue key in format of Raw data.
        schema:
          type: string
      - name: productInfoAwardNumber
        in: query
        required: false
        description: An identifying number of the award, assigned by the system when the award was issued.
        schema:
          type: number
      - name: packageCode
        in: query
        required: false
        description: Package/Product code for the award .
        schema:
          type: string
      - name: packageDescription
        in: query
        required: false
        description: Description of the product.
        schema:
          type: string
      - name: awardValidFrom
        in: query
        required: false
        description: The valid time period from when the award can be issued.
        schema:
          type: string
          format: date
      - name: awardValidTo
        in: query
        required: false
        description: The valid time to an issued award.
        schema:
          type: string
          format: date
      - name: upgradeInfoAwardType
        in: query
        required: false
        description: Unique code that identifies this award.
        schema:
          type: string
      - name: upgradeInfoHotelId
        in: query
        required: false
        description: HotelCode where the award will be consumed.
        schema:
          type: string
      - name: upgradeInfoTotalAvailablePoints
        in: query
        required: false
        description: Total award points available for redemption.
        schema:
          type: number
      - name: upgradeInfoPointsRequired
        in: query
        required: false
        description: The number of points that must be redeemed for this award.
        schema:
          type: number
      - name: upgradeInfoCancelPenaltyPoints
        in: query
        required: false
        description: The award points that will be forfeited if the cancel penalty charge is applied.
        schema:
          type: number
      - name: upgradeInfoCancelPenaltyDays
        in: query
        required: false
        description: Number of days before arrival when a reservation may be cancelled without an award points penalty.
        schema:
          type: number
      - name: upgradeInfoCancelPenaltyCharge
        in: query
        required: false
        description: The cancel penalty charge.
        schema:
          type: number
      - name: upgradeInfoCancelPenaltyType
        in: query
        required: false
        description: The penalty charge is either a percentage or a flat number of points.
        schema:
          type: string
      - name: upgradeInfoRawIssueKey
        in: query
        required: false
        description: Issue key in format of Raw data.
        schema:
          type: string
      - name: upgradeInfoAwardNumber
        in: query
        required: false
        description: An identifying number of the award, assigned by the system when the award was issued.
        schema:
          type: number
      - name: fromRoomCategory
        in: query
        required: false
        description: Indicates room type code for the room prior to the upgrade.
        schema:
          type: string
      - name: toRoomCategory
        in: query
        required: false
        description: Indicates room type code of the upgrade room.
        schema:
          type: string
      - name: fromRoomDescription
        in: query
        required: false
        description: Indicates room type Description for the room prior to the upgrade.
        schema:
          type: string
      - name: toRoomDescription
        in: query
        required: false
        description: Indicates room type Description of the upgrade room.
        schema:
          type: string
      - name: fromRoom
        in: query
        required: false
        description: Indicates room type code for the room prior to the upgrade.
        schema:
          type: string
      - name: toRoom
        in: query
        required: false
        description: Indicates room type code of the upgrade room.
        schema:
          type: string
      - name: upgradeInfoStayDate
        in: query
        required: false
        description: The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.
        schema:
          type: string
          format: date
      - name: otherInfoAwardType
        in: query
        required: false
        description: Unique code that identifies this award.
        schema:
          type: string
      - name: sellBeginDate
        in: query
        required: false
        description: Beginning date of the award.
        schema:
          type: string
          format: date
      - name: sellEndDate
        in: query
        required: false
        description: End date that the award will be available.
        schema:
          type: string
          format: date
      - name: shortDescription
        in: query
        required: false
        description: Descriptive name of the award.
        schema:
          type: string
      - name: awardValue
        in: query
        required: false
        description: The actual value of the award, in the amount of currency.
        schema:
          type: number
      - name: otherInfoTotalAvailablePoints
        in: query
        required: false
        description: Total award points available for redemption.
        schema:
          type: number
      - name: otherInfoPointsRequired
        in: query
        required: false
        description: The number of points that must be redeemed for this award.
        schema:
          type: number
      - name: longDescription
        in: query
        required: false
        description: Detail description of the award.
        schema:
          type: string
      - name: otherInfoAwardNumber
        in: query
        required: false
        description: An identifying number of the award, assigned by the system when the award was issued.
        schema:
          type: number
      - name: issueAwardsHotelId
        in: query
        required: false
        description: HotelCode where the award will be consumed.
        schema:
          type: string
      - name: externalReservationNumber
        in: query
        required: false
        description: PMS Reservation number.
        schema:
          type: string
      - name: confirmationBookingNumber
        in: query
        required: false
        description: ORS Booking number.
        schema:
          type: string
      - name: awardSource
        in: query
        required: false
        description: The source for the reservation associated with the award.
        schema:
          type: string
      - name: arrivalDate
        in: query
        required: false
        description: Arrival date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: departureDate
        in: query
        required: false
        description: Departure date of the reservation associated with the award.
        schema:
          type: string
          format: date
      - name: exportInfoAwardNumber
        in: query
        required: false
        description: Award Number to identify member's information.
        schema:
          type: number
      - name: nameType
        in: query
        required: false
        description: Person's name in an external system.
        schema:
          type: string
          enum:
          - Primary
          - Alternate
          - Incognito
          - External
          - Phonetic
          uniqueItems: true
      - name: name
        in: query
        required: false
        description: Family name, last name or Company Name.
        schema:
          type: string
      - name: fullName
        in: query
        required: false
        description: Full display Name.
        schema:
          type: string
      - name: namePrefix
        in: query
        required: false
        description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)
        schema:
          type: string
      - name: givenName
        in: query
        required: false
        description: Given name, first name or names.
        schema:
          type: string
      - name: middleName
        in: query
        required: false
        description: The middle name of the person name.
        schema:
          type: string
      - name: nameSuffix
        in: query
        required: false
        description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)
        schema:
          type: string
      - name: nameTitle
        in: query
        required: false
        description: Degree or honors (e.g., Ph.D., M.D.)
        schema:
          type: string
      - name: phoneNumber
        in: query
        required: false
        description: Phone number
        schema:
          type: string
      - name: companyName
        in: query
        required: false
        description: It returns a Company Name,If the member is associated with a company.
        schema:
          type: string
      - name: id
        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: idContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: idType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: barCode
        in: query
        required: false
        description: The postal barcode for the address.
        schema:
          type: string
      - name: createDateTime
        in: query
        required: false
        description: Time stamp of the creation.
        schema:
          type: string
          format: date-time
      - name: creatorId
        in: query
        required: false
        description: ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.
        schema:
          type: string
      - name: lastModifierId
        in: query
        required: false
        description: Identifies the last software system or person to modify a record.
        schema:
          type: string
      - name: lastModifyDateTime
        in: query
        required: false
        description: Time stamp of last modification.
        schema:
          type: string
          format: date-time
      - name: primaryInd
        in: query
        required: false
        description: When true, indicates a primary information.
        schema:
          type: boolean
      - name: purgeDate
        in: query
        required: false
        description: Date an item will be purged from a database (e.g., from a live database to an archive).
        schema:
          type: string
          format: date
      - name: type
        in: query
        required: false
        description: Defines the type of address (e.g. home, business, other).
        schema:
          type: string
      - name: typeDescription
        in: query
        required: false
        description: Describes the type code
        schema:
          type: string
      - name: updateReservations
        in: query
        required: false
        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.
        schema:
          type: boolean
      - name: addressLine
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4
      - name: cityName
        in: query
        required: false
        description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
        schema:
          type: string
      - name: postalCode
        in: query
        required: false
        description: Post Office Code number.
        schema:
          type: string
      - name: cityExtension
        in: query
        required: false
        description: Post Office City Extension Code number. City Extension mainly used for UK addresses.
        schema:
          type: string
      - name: county
        in: query
        required: false
        description: County or District Name (e.g., Fairfax). Currently this attribute is not used.
        schema:
          type: string
      - name: state
        in: query
        required: false
        description: State or Province name (e.g., Texas).
        schema:
          type: string
      - name: code
        in: query
        required: false
        description: Code for a country or a nationality.
        schema:
          type: string
      - name: language
        in: query
        required: false
        description: Language code associated with the address
        schema:
          type: string
      - name: characterUDFsAltName
        in: query
        description: Label of user defined field used by vendors or customers.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: characterUDFsName
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: characterUDFsValue
        in: query
        description: Value of user defined field.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: NumericUDFsAltName
        in: query
        description: Label of user defined field used by vendors or customers.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: NumericUDFsName
        in: query
        description: Name of user defined field.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: NumericUDFsValue
        in: query
        description: Value of user defined field.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: DateUDFsAltname
        in: query
        description: Label of user defined field used by vendors or customers.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: DateUDFsName
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: DateUDFsValue
        in: query
        description: Value of user defined field.
        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})*'
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '204':
          description: exportMembershipAward 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/awardExports:
    get:
      summary: Get Membership Award Export Information
      description: Get members information for Fulfillment house processing <p><strong>OperationId:</strong>getMembershipAwardExportInfo</p>
      operationId: getMembershipAwardExportInfo
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: awardNumber
        in: query
        required: false
        description: Award Number to identify member's information.
        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 fetch members information for Fulfillment house processing.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipAwardExportInfo'
        '204':
          description: MembershipAwardExportInfo 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/awards:
    get:
      summary: Get Membership Award list
      description: Retrieve a list of member issued awards. <p><strong>OperationId:</strong>getMembershipIssueAwardsList</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getMembershipIssueAwardsList
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: membershipType
        in: query
        required: false
        description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
        schema:
          type: string
      - name: hotelBookingNumber
        in: query
        required: false
        description: 'Confirmation Number attached '
        schema:
          type: string
      - name: hotelId
        in: query
        required: false
        description: Award Code belongs to which Hotel.
        schema:
          type: string
      - name: awardCode
        in: query
        required: false
        description: Unique code identifying the award.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: awardNumber
        in: query
        required: false
        description: Award Id for identifying the award.
        schema:
          type: number
      - name: awardBasedOn
        in: query
        required: false
        description: Award Type for identifying the award.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 20
      - 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: 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 fetching member issued award list.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipIssueAwards'
        '204':
          description: MembershipIssueAwardsList 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/claims:
    get:
      summary: Get membership claims
      description: Retrieve available membership claims by specifying the membership ID. <p><strong>OperationId:</strong>getMembershipClaims</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getMembershipClaims
      parameters:
      - name: membershipId
        in: path
        required: true
        description: Id to get the claims.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: profileIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: profileIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: name
        in: query
        required: false
        description: Family name, last name or Company Name.
        schema:
          type: string
      - name: givenName
        in: query
        required: false
        description: Given name, first name or names.
        schema:
          type: string
      - name: membershipType
        in: query
        required: false
        description: Membership Type code.
        schema:
          type: string
      - name: claimType
        in: query
        required: false
        description: Type of user-definable claim to be searched.
        schema:
          type: string
      - name: source
        in: query
        required: false
        description: Source of the membership claim.
        schema:
          type: string
          enum:
          - Ocis
          - Opms
          - Web
          uniqueItems: true
      - name: owner
        in: query
        required: false
        description: Unique application user ID of the person responsible for handling the claim.
        schema:
          type: string
      - name: claimNumber
        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: claimNoContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: claimNoType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: hotelId
        in: query
        required: false
        description: Property where the stay took place.
        schema:
          type: string
      - name: confirmationNo
        in: query
        required: false
        description: Reservation confirmation or booking reference number.
        schema:
          type: string
      - name: submitter
        in: query
        required: false
        description: Application user ID of the user who entered the claim.
        schema:
          type: string
      - name: claimStatus
        in: query
        required: false
        description: Status of the claim.(Open, Waiting for Manager, etc.)
        schema:
          type: string
      - name: closeDateEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: closeDateStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: claimDateEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: claimDateStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: replyByEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: replyByStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: departureEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: departureStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: approvalStatus
        in: query
        required: false
        description: Claim approve or reject status.
        schema:
          type: string
          enum:
          - Approved
          - Rejected
          - Pending
          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 for fetching membership claims.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipClaims'
        '204':
          description: MembershipClaims 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/pointsToExpire:
    get:
      summary: 'Get  membership points to expire '
      description: Use this API to retrieve your Points To Expire by membershipId. <p><strong>OperationId:</strong>getMemberPointsToExpire</p>
      operationId: getMemberPointsToExpire
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        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: 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
      - $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 member points to expire information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/memberPointsToExpire'
        '204':
          description: MemberPointsToExpire 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:
      - ProfileMembership
    put:
      summary: Extend Member Points set to Expire
      description: This will allow you to extend the expiration date based on the rule defined in the Grace Period in months. <p><strong>OperationId:</strong>extendMemberPointsToExpire</p>
      operationId: extendMemberPointsToExpire
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        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/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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/extendMemberPointsToExpire'
        description: Request object to extend a member points to expire.
        required: true
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/promotions:
    get:
      summary: Fetch membership promotions of a guest
      description: Use this API to retrieve your available promotions by membershipId. <p><strong>OperationId:</strong>getMembershipPromotions</p>
      operationId: getMembershipPromotions
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: includeInactive
        in: query
        required: false
        description: Search criteria for fetching inactive membership promotions. When set to true, inactive records will be included.
        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 membership promotion information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipPromotionsDetails'
        '204':
          description: MembershipPromotions 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:
      - ProfileMembership
    post:
      summary: Create membership promotion of a guest
      description: Create a new membership promotion . <p><strong>OperationId:</strong>postMembershipPromotion</p>
      operationId: postMembershipPromotion
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipPromotionDetails'
        description: Request object for creating a membership promotion.
        required: true
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/promotions/{promotionCode}:
    put:
      summary: Change membership promotion of a guest
      description: Update an existing membership promotion code in the database. <p><strong>OperationId:</strong>putMembershipPromotion</p>
      operationId: putMembershipPromotion
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: promotionCode
        in: path
        required: true
        description: An alphanumeric code for the promotion.
        schema:
          type: string
          maxLength: 20
          minLength: 0
      - $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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipPromotionDetails'
        description: The request element used to update an existing membership promotion in the database.
        required: true
    delete:
      summary: Delete membership promotion of a guest
      description: Delete a Membership promotion for a guest. This will inactivate the membership promotion.<p><strong>OperationId:</strong>deleteMembershipPromotion</p>
      operationId: deleteMembershipPromotion
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: promotionCode
        in: path
        required: true
        description: An alphanumeric code for the promotion.
        schema:
          type: string
          maxLength: 20
          minLength: 0
      - name: membershipPromotionId
        in: query
        required: false
        description: The ID of a promotion owned by a membership.
        schema:
          type: string
          maxLength: 20
          minLength: 0
      - $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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/transactions:
    get:
      summary: 'Get membership transactions '
      description: Get membership transactions summary information by specifying membership ID <p><strong>OperationId:</strong>getMembershipTransactionsSummary</p>
      operationId: getMembershipTransactionsSummary
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        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 fetching member point totals information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipTransactionsSummary'
        '204':
          description: MembershipTransactionsSummary 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:
      - ProfileMembership
    post:
      summary: Post a membership transaction
      description: Create a new membership transaction . <p><strong>OperationId:</strong>postMembershipTransaction</p>
      operationId: postMembershipTransaction
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipTransaction'
        description: Request object for creating a membership transaction.
        required: true
    servers:
    - url: /crm/v1
  /membershipsCard/{membershipCardNo}/membershipType/{membershipCardType}/pointsToExpire:
    get:
      summary: 'Get  membership points to expire '
      description: Use this API to retrieve your Points To Expire by by specifying membership card number and membership card type. This operation can return more than one membership points to expire if duplicate card numbers are allowed in the configuration. <p><strong>OperationId:</strong>getMemberPointsToExpireByCardNo</p>
      operationId: getMemberPointsToExpireByCardNo
      parameters:
      - name: membershipCardNo
        in: path
        required: true
        description: The card number associated to the membership
        schema:
          type: string
          maxLength: 50
          minLength: 1
      - name: membershipCardType
        in: path
        required: true
        description: The type of card the membership belongs to
        schema:
          type: string
          maxLength: 20
          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 fetching member points to expire information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/memberPointsToExpireCollection'
        '204':
          description: MemberPointsToExpire 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /membershipsCard/{membershipCardNo}/membershipType/{membershipCardType}/transactions:
    get:
      summary: 'Get membership transactions '
      description: Get membership transactions summary information by specifying membership card number and membership card type, this operation can return more than one membership transactions if duplicate card numbers allowed in the configuration. <p><strong>OperationId:</strong>getMembershipTransactionsSummaryByCardNo</p>
      operationId: getMembershipTransactionsSummaryByCardNo
      parameters:
      - name: membershipCardNo
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 50
          minLength: 1
      - name: membershipCardType
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 20
          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 fetching member point totals information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipTransactionsSummaryCollection'
        '204':
          description: MembershipTransactionsSummary 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /profileForEnrollment:
    get:
      summary: Get Profiles for Enrollment
      description: Get detailed information regarding match profiles <p><strong>OperationId:</strong>getEnrollmentMatchProfiles</p>
      operationId: getEnrollmentMatchProfiles
      parameters:
      - name: externalDatabaseID
        in: query
        required: false
        description: Enrollment details will be fetched from this External database.
        schema:
          type: string
      - name: matchedProfileType
        in: query
        required: false
        description: The types of Profile handled by the web service.
        schema:
          type: string
          enum:
          - Guest
          - Agent
          - Company
          - Group
          - Source
          - Employee
          - Hotel
          - Vendor
          - Contact
          - Purge
          - BusinessHeader
          - BillingAccount
          - Activity
          - Potential
          - Account
          uniqueItems: true
      - name: language
        in: query
        required: false
        description: Language code associated with an alternate name.
        schema:
          type: string
      - name: givenName
        in: query
        required: false
        description: Given name, first name or names.
        schema:
          type: string
      - name: surname
        in: query
        required: false
        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.
        schema:
          type: string
      - name: nameTitle
        in: query
        required: false
        description: Degree or honors (e.g., Ph.D., M.D.)
        schema:
          type: string
      - name: addressId
        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: addressIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: addressIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: primaryInd
        in: query
        required: false
        description: When true, indicates a primary information.
        schema:
          type: boolean
      - name: type
        in: query
        required: false
        description: Defines the type of address (e.g. home, business, other).
        schema:
          type: string
      - name: addressLine
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4
      - name: cityName
        in: query
        required: false
        description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
        schema:
          type: string
      - name: postalCode
        in: query
        required: false
        description: Post Office Code number.
        schema:
          type: string
      - name: county
        in: query
        required: false
        description: County or District Name (e.g., Fairfax). Currently this attribute is not used.
        schema:
          type: string
      - name: state
        in: query
        required: false
        description: State or Province name (e.g., Texas).
        schema:
          type: string
      - name: countryCode
        in: query
        required: false
        description: Code for a country or a nationality.
        schema:
          type: string
      - name: languageCode
        in: query
        required: false
        description: Language code associated with the address
        schema:
          type: string
      - name: businessSegment
        in: query
        description: Business/Market Segment associated to the profile.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: territory
        in: query
        required: false
        description: Territory associated to the profile.
        schema:
          type: string
      - name: traceCode
        in: query
        required: false
        description: Trace Code associated to the profile.
        schema:
          type: string
      - name: ownerCode
        in: query
        required: false
        description: Owner Code associated to the profile.
        schema:
          type: string
      - name: influenceCode
        in: query
        required: false
        description: Influence Code associated to the profile.
        schema:
          type: string
      - name: hasMore
        in: query
        required: false
        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.
        schema:
          type: boolean
      - name: totalResults
        in: query
        required: false
        description: Total number of rows queried
        schema:
          type: integer
      - name: telephoneId
        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: telephoneIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: telephoneIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: phoneNumber
        in: query
        required: false
        description: Telephone number assigned to a single location.
        schema:
          type: string
      - name: phoneTechType
        in: query
        required: false
        description: Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.
        schema:
          type: string
      - name: phoneUseType
        in: query
        required: false
        description: Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
        schema:
          type: string
      - name: phoneUseTypeDescription
        in: query
        required: false
        description: Description of the PhoneUseType code
        schema:
          type: string
      - name: telephonePrimaryInd
        in: query
        required: false
        description: When true, indicates a primary information.
        schema:
          type: boolean
      - name: emailInfoId
        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: emailInfoIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: emailInfoIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: emailAddress
        in: query
        required: false
        description: Defines the e-mail address.
        schema:
          type: string
      - name: emailPrimaryInd
        in: query
        required: false
        description: When true, indicates a primary information.
        schema:
          type: boolean
      - name: emailType
        in: query
        required: false
        description: Defines the purpose of the e-mail address (e.g. personal, business, listserve).
        schema:
          type: string
      - name: urlId
        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: urlIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: urlIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: urlPrimaryInd
        in: query
        required: false
        description: When true, indicates a primary information.
        schema:
          type: boolean
      - name: urlType
        in: query
        required: false
        description: Defines the purpose of the URL address, such as personal, business, public, etc.
        schema:
          type: string
      - name: membershipId
        in: query
        required: false
        description: Card Number of the membership.
        schema:
          type: string
      - name: nameOnCard
        in: query
        required: false
        description: Name to be displayed on the membership card.
        schema:
          type: string
      - name: membershipLevel
        in: query
        required: false
        description: Indicates the membership level.
        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: profileContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: profileType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: paymentMethodCode
        in: query
        required: false
        description: Code.
        schema:
          type: string
      - name: amount
        in: query
        required: false
        description: Amount/Fee to enroll to membership Program.
        schema:
          type: number
      - name: amountCode
        in: query
        required: false
        description: Code.
        schema:
          type: string
      - name: comments
        in: query
        required: false
        description: Payment Comments.
        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 match profiles for enrollment.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/enrollmentMatchProfiles'
        '204':
          description: EnrollmentMatchProfiles 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /profiles/{profileId}/awards/redeem:
    put:
      summary: Redeem an award
      description: Redeem an award that exists on a profile. <p><strong>OperationId:</strong>redeemAward</p>
      operationId: redeemAward
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        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 for redeem award.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/award_2'
        '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:
      - ProfileMembership
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/award_2'
        description: Request object to redeem award.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{profileId}/membershipTransactionExceptions:
    get:
      summary: Get membership transaction exception details
      description: Use this API to get membership transaction exceptions on a profile. <p><strong>OperationId:</strong>getMembershipTransactionExceptions</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getMembershipTransactionExceptions
      deprecated: true
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: Membership belongs to which Hotel.
        schema:
          type: string
      - name: end
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: start
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: id
        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: idContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: type
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: membershipType
        in: query
        required: false
        description: The type of the membership.
        schema:
          type: string
      - name: membershipLevel
        in: query
        required: false
        description: The current level of the membership.
        schema:
          type: string
      - name: membershipCardNo
        in: query
        required: false
        description: The card number associated with this membership.
        schema:
          type: string
      - name: includeEPE
        in: query
        required: false
        description: Indicates to Include External Processing Exception
        schema:
          type: boolean
      - name: exceptionType
        in: query
        required: false
        description: Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,
        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 object for fetching membership transaction exceptions.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipTransactionExceptions'
        '204':
          description: MembershipTransactionExceptions 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /profiles/{profileId}/memberships/history:
    get:
      summary: Get membership card history information on a profile
      description: Use this API to retrieve membership card history on a profile. <p><strong>OperationId:</strong>getMembershipCardHistory</p>
      operationId: getMembershipCardHistory
      parameters:
      - name: profileId
        in: path
        required: true
        description: Profile Id of the guest.
        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
          default: 20
          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: 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 list of membership card number changes.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/memberCardHistoryList'
        '204':
          description: memberCardHistory 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /profiles/{profileId}/memberships/info:
    get:
      summary: Get membership information on a profile
      description: Use this API to retrieve membership details on a profile. <p><strong>OperationId:</strong>getMembershipDetails</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getMembershipDetails
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: idContext
        in: query
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: idType
        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: membershipType
        in: query
        required: false
        description: The type of the membership.
        schema:
          type: string
      - name: membershipId
        in: query
        required: false
        description: The card number associated with this membership.
        schema:
          type: string
      - name: hotelId
        in: query
        required: false
        description: Property from which the membership stay information was received.
        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: mode
        in: query
        required: false
        description: Whether member info search will pertain to transaction dates/ stay dates/ points credit dates.
        schema:
          type: string
          enum:
          - TransactionDate
          - StayBeginDate
          - StayEndDate
          - PointsCreditDate
          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 for member info.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/memberInformation'
        '204':
          description: MembershipDetails 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
  /services/profileMembership/status:
    get:
      summary: Operation to check status of ProfileMembership service
      description: ' <p><strong>OperationId:</strong>pingMembershipService</p>'
      operationId: pingMembershipService
      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: pingMembershipService 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:
      - ProfileMembership
    servers:
    - url: /crm/v1
components:
  schemas:
    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
    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: 20
    memberAwardDetailsType:
      type: array
      description: Details related to member award per stay date.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/memberAwardDetailType'
    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
        issuedPlace:
          description: The place where Identification was issued.
          type: string
          minLength: 0
          maxLength: 80
        expirationDate:
          description: Expiration date of Identification.
          type: string
          format: date
        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
    cardReIssueType:
      type: string
      description: Request to re issue a new card.
      enum:
      - Pending
      - NotApplicable
      - Requested
    memberAwardType:
      type: object
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems.
          $ref: '#/components/schemas/profileIdList'
        membershipType:
          description: The type of the membership.
          type: string
          minLength: 0
          maxLength: 20
        membershipCardNo:
          description: The card number associated with this membership.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The current level of the membership.
          type: string
          minLength: 0
          maxLength: 20
        reservationIdList:
          description: Unique identifiers for the Reservation like Confirmation Number.
          $ref: '#/components/schemas/reservationIdList'
        adults:
          description: Number of adults associated with the reservation.
          type: integer
        reservationTimeSpan:
          description: Arrival and Departure dates of the reservation.
          $ref: '#/components/schemas/timeSpanType'
        memberPointsBefore:
          description: Member points before award transaction.
          type: integer
        memberPointsAfter:
          description: Member points after award transaction.
          type: integer
        awardPoints:
          description: Points associated with the award.
          type: integer
        cancelPointsReturn:
          description: Number of cancel points returned.
          type: integer
        actualCancelPoints:
          description: Actual number of cancel points.
          type: integer
        expiryPoints:
          description: Points that will expire.
          type: integer
        awardProcessType:
          description: Processing type of the award like Actual , Projected or Inactive.
          $ref: '#/components/schemas/memberAwardProcessType'
        memberAwardDetails:
          description: Details related to member award per stay date.
          $ref: '#/components/schemas/memberAwardDetailsType'
        hotelId:
          description: Property associated with the reservation.
          type: string
          minLength: 0
          maxLength: 20
    keywordDetailType:
      type: object
      properties:
        newKeyword:
          description: The new keyword value.
          type: string
          minLength: 0
          maxLength: 80
    tierAdministrationType:
      type: string
      description: Do not upgrade membership. The membership may be downgraded.
      enum:
      - Disabled
      - NoUpgrade
    benefitsType:
      type: array
      description: Basic information about membership benefit.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/benefitType'
    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
    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
    memberInfoDetailsType:
      type: object
      properties:
        guestTotalNights:
          description: Total nights of the guest.
          type: integer
        guestTotalStay:
          description: STotal stays of the guest.
          type: integer
        tierBaseNights:
          description: Tier Base Nights Points.
          type: integer
        tierBaseRevenue:
          description: Tier Base Revenue Points.
          type: number
        tierBaseStay:
          description: Tier Base Stay Points.
          type: integer
        tierBonusNights:
          description: Tier Bonus Nights Points.
          type: integer
        tierBonusRevenue:
          description: Tier Bonus Revenue Points.
          type: number
        tierBonusStay:
          description: Tier Bonus Stay Points.
          type: integer
        membershipTotalNights:
          description: Total Nights of the membership.
          type: integer
        membershipTotalStay:
          description: Total Stay of the membership.
          type: integer
        awardBasePoints:
          description: Total base points of the award.
          type: integer
        awardBonusPoints:
          description: Total bonus points of the award.
          type: integer
        awardMiscPoints:
          description: Total miscellaneous points of the award.
          type: integer
        totalAwardPoints:
          description: Total points of the award.
          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: 20
    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.
    profileEnrollmentType:
      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'
        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'
            allRowsFetched:
              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
            totalRows:
              description: Total number of rows queried
              type: integer
        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'
            allRowsFetched:
              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
            totalRows:
              description: Total number of rows queried
              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'
            allRowsFetched:
              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
            totalRows:
              description: Total number of rows queried
              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'
            allRowsFetched:
              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
            totalRows:
              description: Total number of rows queried
              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'
            allRowsFetched:
              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
            totalRows:
              description: Total number of rows queried
              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'
            allRowsFetched:
              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
            totalRows:
              description: Total number of rows queried
              type: integer
        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
        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 resposible 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
        profileId:
          description: Unique id of the profile.
          $ref: '#/components/schemas/uniqueID_Type'
        reservationId:
          description: Unique identifier of the reservation.
          $ref: '#/components/schemas/uniqueID_Type'
        enrollmentCode:
          description: Membership enrollment code and description.
          $ref: '#/components/schemas/codeDescriptionType'
        externalDatabaseID:
          description: Enrollment details will be fetched from this External database.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel Code, It is used to filter hotel specific children to this specific hotel code.
          type: string
          minLength: 0
          maxLength: 20
        userId:
          description: UserID/LoginID of the user who is enrolling the Guest.
          type: string
          minLength: 0
          maxLength: 200
        employeeId:
          description: EmployeeID of the user who is enrolling the Guest.
          type: string
          minLength: 0
          maxLength: 20
    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
          maxLength: 2000
        salutation:
          description: Salutation of the profile
          type: string
          maxLength: 2000
        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})*'
    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
    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'
    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
    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: 20
    personNameTypeType:
      type: string
      description: Person's name in an external system.
      enum:
      - Primary
      - Alternate
      - Incognito
      - External
      - Phonetic
    memberInfoRSType:
      type: object
      properties:
        memberInfoDetails:
          description: Points and stay details of the membership.
          $ref: '#/components/schemas/memberInfoDetailsType'
        memberInfoRangeDetails:
          description: Points and stay details for the membership range.
          $ref: '#/components/schemas/memberInfoDetailsType'
        nextTierPoints:
          description: Points required for next tier of membership.
          type: integer
        pointsAvailable:
          description: Points available for the member.
          type: integer
    reservationIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    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
    memberInformation:
      type: object
      description: Response object for member info.
      properties:
        memberInfo:
          $ref: '#/components/schemas/memberInfoRSType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    enrollment:
      type: object
      description: Response object for fetching profile enrollment from external system.
      properties:
        enrollmentInfo:
          description: Type contains profile enrollment information.
          $ref: '#/components/schemas/profileEnrollmentType'
        links:
          $ref: '#/components/schemas/links'
    award:
      type: object
      description: Request object to redeem award.
      properties:
        memberAward:
          $ref: '#/components/schemas/memberAwardType'
        links:
          $ref: '#/components/schemas/links'
    memberAwardProcessType:
      type: string
      description: Processing type of the award like Actual , Projected or Inactive.
      enum:
      - Actual
      - Projected
      - Inactive
    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
          maxLength: 2000
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
          maxLength: 2000
        programDescription:
          description: Description of the membership program.
          type: string
          maxLength: 2000
        membershipLevel:
          description: Indicates the membership level.
          type: string
          maxLength: 2000
        membershipLevelDescription:
          description: Indicates the membership level description.
          type: string
          minLength: 0
          maxLength: 200
        membershipClass:
          description: Indicates the membership class.
          type: string
          maxLength: 2000
        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, requirements 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
          maxLength: 2000
        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
          maxLength: 2000
        membershipType:
          description: Type of membership.
          type: string
          maxLength: 2000
        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
        effectiveDate:
          description: Indicates the starting date.
          type: string
          format: date
        expireDate:
          description: Indicates the ending date.
          type: string
          format: date
        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 resposible 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
    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
    timeSpanType:
      type: object
      description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, whild Duration provides a measure of time to add to the StartDate to yield end date.
      properties:
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        duration:
          type: string
    uRLInfoType:
      type: object
      description: Web site address.
      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: 20
    anonymizationStatusType:
      type: string
      description: Guest has been anonymized.
      enum:
      - Requested
      - Anonymized
    profileIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    profileStatusType:
      type: string
      enum:
      - Active
      - Inactive
    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: 20
    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
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    formattedTextTextType:
      type: object
      description: Provides text and indicates whether it is formatted or not.
      properties:
        value:
          type: string
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
    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
        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 resposible 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
    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
          maxLength: 2000
        primaryInd:
          description: When true, indicates a primary information.
          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 resposible 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
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    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: 20
    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 resposible 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
    alienInfoType:
      type: object
      description: immigration/visa information of a foreign person.
      properties:
        alienRegistrationNo:
          description: Alien Registration Number.
          type: string
          maxLength: 2000
        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
    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'
    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
    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'
            allRowsFetched:
              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
            totalRows:
              description: Total number of rows queried
              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'
        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
        birthDateMasked:
          description: Indicates the date of birth as masked.
          type: string
          maxLength: 2000
        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
    memberAwardDetailType:
      type: object
      description: Details related to member award like award type, stay date, rate code, etc.
      properties:
        awardType:
          description: The award type or code.
          type: string
          minLength: 0
          maxLength: 40
        awardBasedOn:
          description: Indicates if award is a Stay, Package Element or other.
          type: string
          minLength: 0
          maxLength: 20
        cancelPenaltyDays:
          description: Number days before arrival to apply penalty for cancellation.
          type: integer
        cancelPenaltyCharge:
          description: Number points deducted if award is cancelled.
          type: integer
        cancelPenaltyType:
          description: Type of cancel penalty like Points, etc.
          type: string
          minLength: 0
          maxLength: 20
        cancelPenaltyPoints:
          description: Number of penalty points if cancelled.
          type: integer
        stayDate:
          description: Date of stay.
          type: string
          format: date
        rateCode:
          description: Rate code associated with the reservation.
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Room type label associated with the reservation.
          type: string
          minLength: 0
          maxLength: 20
        product:
          description: Product code for which the award was issued, in case of a product award.
          type: string
          minLength: 0
          maxLength: 80
        fromRoomType:
          description: Room type label before the upgrade in case of an upgrade award.
          type: string
          minLength: 0
          maxLength: 20
        toRoomType:
          description: Room type label after the upgrade for an upgrade award.
          type: string
          minLength: 0
          maxLength: 20
        totalLocalAmount:
          description: Total Local Amount on bill in Hotel Currency.
          type: number
        redeemedLocalAmount:
          description: Redeemed Local Amount on bill in Hotel Currency.
          type: number
        totalCentralAmount:
          description: Total Central Amount on bill in External System Currency.
          type: number
        redeemedCentralAmount:
          description: Redeemed Central Amount on bill in External System Currency.
          type: number
        transactionCode:
          description: The Payment Transaction Code for which the Surcharge Applies.
          type: string
          minLength: 0
          maxLength: 20
        transactionNo:
          description: Unique Transaction Identifier.
          type: number
        exchangeRateType:
          description: Exchange Rate Type for the Currency Exchange.
          type: string
          minLength: 0
          maxLength: 20
        awardVoucherNo:
          description: Award Voucher Number.
          type: string
          minLength: 0
          maxLength: 40
        awardCancellationNo:
          description: Unique ID for the award cancellation if cancelled.
          $ref: '#/components/schemas/uniqueID_Type'
        inactive:
          description: If the award detail is inactive.
          type: boolean
        pointsRequired:
          description: Points required for the stay date.
          type: integer
    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
    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_2'
        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
    memberAwardType_2:
      type: object
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems.
          $ref: '#/components/schemas/profileIdList'
        membershipType:
          description: The type of the membership.
          type: string
          minLength: 0
          maxLength: 20
        membershipCardNo:
          description: The card number associated with this membership.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The current level of the membership.
          type: string
          minLength: 0
          maxLength: 20
        sourceCode:
          description: To specify where the business came from e.g. radio, newspaper ad, etc.
          type: string
          minLength: 0
          maxLength: 20
        reservationIdList:
          description: Unique identifiers for the Reservation like Confirmation Number.
          $ref: '#/components/schemas/reservationIdList'
        adults:
          description: Number of adults associated with the reservation.
          type: integer
        reservationTimeSpan:
          description: Arrival and Departure dates of the reservation.
          $ref: '#/components/schemas/timeSpanType_2'
        memberPointsBefore:
          description: Member points before award transaction.
          type: integer
        memberPointsAfter:
          description: Member points after award transaction.
          type: integer
        awardPoints:
          description: Points associated with the award.
          type: integer
        cancelPointsReturn:
          description: Number of cancel points returned.
          type: integer
        actualCancelPoints:
          description: Actual number of cancel points.
          type: integer
        expiryPoints:
          description: Points that will expire.
          type: integer
        awardProcessType:
          description: Processing type of the award like Actual , Projected or Inactive.
          $ref: '#/components/schemas/memberAwardProcessType'
        memberAwardDetails:
          description: Details related to member award per stay date.
          $ref: '#/components/schemas/memberAwardDetailsType'
        hotelId:
          description: Property associated with the reservation.
          type: string
          minLength: 0
          maxLength: 20
    airlineImportStatusType:
      type: string
      description: List of possible import statuses of a membership airline processing record.
      enum:
      - New
      - Uploaded
      - Error
    membershipAwardsAvailabilityType:
      type: array
      description: List of available awards information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/membershipAwardAvailabilityType'
    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
    membershipTransactionsSummaryCollection:
      type: object
      description: Response object for fetching multiple memberships transactions summaries.
      properties:
        membershipTransactionsSummaryCollection:
          type: array
          maxItems: 4000
          description: A collection of membership points exceptions.
          items:
            $ref: '#/components/schemas/membershipTransactionsSummaryType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    airlineTransactionStatusType:
      type: object
      description: Contains details of the membership transaction processing status, provided by the airline.
      properties:
        errorCode:
          description: Error Code returned by the airline
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Error Description returned by the airline
          type: string
          minLength: 0
          maxLength: 4000
    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
    rateAvailabilityType:
      type: object
      description: Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
      properties:
        awardType:
          description: Unique code that identifies this award.
          type: string
          minLength: 0
          maxLength: 40
        hotelId:
          description: HotelCode where the award will be consumed.
          type: string
          minLength: 0
          maxLength: 20
        totalAvailablePoints:
          description: Total award points available for redemption.
          type: number
        pointsRequired:
          description: The number of points that must be redeemed for this award.
          type: number
        cancelPenaltyPoints:
          description: The award points that will be forfeited if the cancel penalty charge is applied.
          type: number
        cancelPenaltyDays:
          description: Number of days before arrival when a reservation may be cancelled without an award points penalty.
          type: number
        cancelPenaltyCharge:
          description: The cancel penalty charge.
          type: number
        cancelPenaltyType:
          description: The penalty charge is either a percentage or a flat number of points.
          type: string
          minLength: 0
          maxLength: 20
        rawIssueKey:
          description: Issue key in format of Raw data.
          type: string
          minLength: 0
          maxLength: 4000
        awardNumber:
          description: An identifying number of the award, assigned by the system when the award was issued.
          type: number
        rateCode:
          description: Rate code associated with the award.
          type: string
          minLength: 0
          maxLength: 20
        rateDescription:
          description: Rate code description associated with the award.
          type: string
          minLength: 0
          maxLength: 4000
        roomLabel:
          description: Code for the room type in which the award was issued.
          type: string
          minLength: 0
          maxLength: 20
        roomDescription:
          description: Description of the Room.
          type: string
          minLength: 0
          maxLength: 4000
        roomCategory:
          description: Indicates which room category it belongs.
          type: string
          minLength: 0
          maxLength: 20
        stayDate:
          description: The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.
          type: string
          format: date
          maxLength: 8
    profileSubscriptionListType:
      type: array
      description: Details of the OPERA Profile subscription to external system
      maxItems: 4000
      items:
        $ref: '#/components/schemas/profileSubscriptionType'
    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
    airlineTransactionType:
      type: object
      description: Contains details of the membership transaction processing status, provided by the airline.
      properties:
        transactionId:
          description: Uniquely identifies this record.
          $ref: '#/components/schemas/uniqueID_Type_2'
        batchId:
          description: Identifies the batch in which this membership transaction status record was imported into OPERA
          $ref: '#/components/schemas/uniqueID_Type_2'
        membershipTransactionId:
          description: Unique ID of the membership transaction that this record corresponds to
          $ref: '#/components/schemas/membershipTransactionId'
        hotelId:
          description: Property code that this record corresponds to
          type: string
          minLength: 0
          maxLength: 20
        airlineHotelCode:
          description: Property code provided by the airline
          type: string
          minLength: 0
          maxLength: 20
        memberInfo:
          description: Information relating to the member.
          $ref: '#/components/schemas/memberInfoType'
        airlineStatus:
          description: Processing status returned by the airlines.
          $ref: '#/components/schemas/airlineTransactionStatusType'
        importInfo:
          description: Date and status of the import activity.
          $ref: '#/components/schemas/airlineTransactionImportInfoType'
        miles:
          description: Miles earned through this membership transaction
          type: number
        userDefinedFields:
          description: Collection of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
    availableAwardsBasedOnType:
      type: object
      description: Response object to fetch member available awards based on the type being passed.
      properties:
        membershipAvailableAwards:
          description: Collection of member available awards.
          $ref: '#/components/schemas/membershipAwardsAvailabilityType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    characterUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Character/String Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/characterUDFType'
    timeSpanType_2:
      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
    membershipDetailsType:
      type: object
      description: Details of membership transactions summary such as the membership details, transactions summary, points summary, etc.
      properties:
        profileId:
          description: The profile to which this membership is associated with.
          $ref: '#/components/schemas/profileId'
        name:
          description: The profile name associated with this membership.
          type: string
          minLength: 0
          maxLength: 128
        membershipId:
          description: Unique identifier of this membership.
          $ref: '#/components/schemas/uniqueID_Type_2'
        membershipCardNo:
          description: The card number associated with this membership.
          type: string
          minLength: 0
          maxLength: 50
        membershipType:
          description: The type of the membership.
          $ref: '#/components/schemas/codeDescriptionType'
        membershipLevel:
          description: The current level of the membership.
          type: string
          minLength: 0
          maxLength: 20
        joinedDate:
          description: Date when the member enrolled for the membership.
          type: string
          format: date
          maxLength: 8
        cardExpirationDate:
          description: Membership card expiration date.
          type: string
          format: date
          maxLength: 8
        referredMemNameId:
          description: Name ID of the profile referred.
          type: integer
        referredDisplayName:
          description: Display Name of the profile that is going to be referred.
          type: string
    imageStyleType:
      type: string
      description: An enumeration of image styles.
      enum:
      - Full
      - Thumbnail
      - Icon
      - Square
      - Banner
      - Button
      - Lowres
      - Highres
    addressInfoType_2:
      type: object
      description: Provides address information.
      properties:
        address:
          description: Address details for the profile.
          $ref: '#/components/schemas/addressType_2'
        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
    cardNumberTypeType:
      type: string
      description: Simple type for indicating if credit card number is tokenized.
      enum:
      - CardNumber
      - Token
    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
    rewardsInfoType:
      type: object
      description: Indicates membership base information like CurrentBalance,association and Owned card.
      properties:
        mVCIOwner:
          description: Indicates if the member is an MVCI owner.
          type: string
          minLength: 0
          maxLength: 3
        ownsVisaCard:
          description: Indicates if guest owns a visa card.
          type: boolean
        meetingPlanner:
          description: Indicates if meeting planner is requested.
          type: boolean
        association:
          description: Indicates guest association.
          type: string
          minLength: 0
          maxLength: 2000
        currentBalance:
          description: Current membership points.
          type: number
        membershipId:
          description: Indicates membership id of the guest.
          type: number
        membershipNo:
          description: Indicates membership number of the guest
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: Indicates membership level of the guest
          type: string
          minLength: 0
          maxLength: 20
        membershipDate:
          description: Indicates membership date of the guest
          type: string
          format: date
          maxLength: 8
    customerType_2:
      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_2'
        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_2'
            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_2'
        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
    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
    membershipTransactionType:
      type: object
      description: Detailed transaction information related to a membership.
      properties:
        membershipDetails:
          description: Membership details for the requested membership transaction ID.
          $ref: '#/components/schemas/membershipDetailsType'
        membershipTransactionDetails:
          description: Membership transaction details for the requested membership transaction ID.
          $ref: '#/components/schemas/membershipTransactionDetailsType'
    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
    claimActivityLogListType:
      type: array
      description: Summary of claim activity log information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/claimActivityLogType'
    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_2'
        externalResort:
          description: This provides external resort for external profiles
          type: string
          minLength: 0
          maxLength: 20
        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.). Currently this attribute is not used for PUT and POST operations.
              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.). Currently this attribute is not used for PUT and POST operations.
              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.
          type: string
          format: date-time
        lastDistributionDate:
          description: Timestamp of the most recent distribution of this profile to the external system.
          type: string
          format: date-time
        lastExternalUpdateDate:
          description: Timestamp of the most recent update of the subscription information by the external system.
          type: string
          format: date-time
        inactive:
          description: Indicates whether this subscription is active or inactive.
          type: boolean
        systemCode:
          description: Code of system where profile is subscribed to.
          type: string
          minLength: 0
          maxLength: 40
        systemType:
          description: Type of system where profile is subscribed to.
          type: string
          minLength: 0
          maxLength: 40
    profileDeliveryModuleType:
      type: string
      description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..'
      enum:
      - EfolioExport
    hotelInterfaceType:
      type: object
      properties:
        interfaceId:
          description: Unique DB internal number of a Hotel Interface record.
          $ref: '#/components/schemas/uniqueID_Type_2'
        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
    rates:
      type: object
      description: Response object for fetching Membership Transaction Rates information.
      properties:
        rate:
          description: Details of rate for the current points transaction.
          $ref: '#/components/schemas/membershipTransactionRatesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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'
    memberAwardActionType:
      type: string
      description: Specify whether award is to issue, cancel or update.
      enum:
      - Issue
      - Cancel
      - InfoUpdate
      - CxlWithoutPenalty
    membershipTransactionExceptions:
      type: object
      description: Response object for fetching membership transaction exceptions.
      properties:
        memberTransactionExceptions:
          description: A collection of membership transaction exceptions.
          $ref: '#/components/schemas/membershipTransactionExceptionsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    memberPointsExceptions:
      type: object
      description: Response object for fetching membership points exceptions.
      properties:
        memberPointsExceptions:
          type: array
          maxItems: 100
          description: A collection of membership points exceptions.
          items:
            $ref: '#/components/schemas/memberPointsExceptionType'
        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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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'
    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
    membershipHistoryType:
      type: object
      description: Contains details of the profile's primary membership history.
      properties:
        actionType:
          description: Type of action related to changes in a profile's primary membership.
          type: string
        oldValue:
          description: Old value for the membership field.
          type: string
        newValue:
          description: New value for the membership field.
          type: string
        user:
          description: User who changed the membership field.
          type: string
        date:
          description: Date when the membership field was changed.
          type: string
          format: date-time
        action:
          description: Action performed related to changes in membership level action type(REQUALIFY, RENEW, UPGRADE, DOWNGRADE).
          type: string
    surnameType:
      type: string
      description: Family name, last name.
      minLength: 0
      maxLength: 80
    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_2'
        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_2'
        department:
          description: Department to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        email:
          description: Email information of the owner.
          $ref: '#/components/schemas/emailInfoType_2'
        phone:
          description: Information on the telephone number of the owner.
          $ref: '#/components/schemas/telephoneInfoType_2'
        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
    exceptionDetailType_2:
      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_2'
        links:
          $ref: '#/components/schemas/links'
      required:
      - type
      - title
    membershipTransactionExceptionsType:
      type: array
      description: Contains Membership transaction exception information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/membershipTransactionExceptionType'
    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
    enrollmentMatchProfilesType:
      type: array
      description: Provide match profile details for enrollment.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/profileEnrollmentType_2'
    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_2'
        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
    membershipTransactionExceptionComputePointsType:
      type: object
      description: Options to compute award and tier points for membership transaction exception.
      properties:
        awardBasePoints:
          description: Indicates if membership transaction exception should be created for base award points.
          type: boolean
        awardBonusPoints:
          description: Indicates if membership transaction exception should be created for bonus award points.
          type: boolean
        tierPointsBaseStay:
          description: Indicates if membership transaction exception should be created for base tier points for the stay.
          type: boolean
        tierPointsBonusStay:
          description: Indicates if membership transaction exception should be created for tier bonus points for the stay.
          type: boolean
        tierPointsBaseNights:
          description: Indicates if membership transaction exception should be created for base tier points for the night.
          type: boolean
        tierPointsBonusNights:
          description: Indicates if membership transaction exception should be created for tier bonus points for the night.
          type: boolean
        tierPointsBaseRevenue:
          description: Indicates if membership transaction exception should be created for base tier points for the revenue.
          type: boolean
        tierPointsBonusRevenue:
          description: Indicates if membership transaction exception should be created for tier bonus points for the revenue.
          type: boolean
    uniqueIDListType:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type_2'
    commissionPaymentMethods:
      type: string
      description: Check
      enum:
      - Cent
      - Eft
      - Chk
    membershipPointsExceptions:
      type: object
      description: Response object for fetching membership points exceptions.
      properties:
        membershipPointsExceptions:
          description: A collection of membership points exceptions.
          $ref: '#/components/schemas/membershipPointsExceptionsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    operaVersionNumberType:
      type: string
      description: Current Opera Version Number
      minLength: 0
      maxLength: 40
    addressType_2:
      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). Currently this attribute is not used.
          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 resposible 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
    hotelStayType:
      type: object
      description: Type provides the hotel stay information.
      properties:
        hotelName:
          description: Hotel Name.
          type: string
          minLength: 0
          maxLength: 40
        pointsMiles:
          description: Points or Miles.
          type: string
          minLength: 0
          maxLength: 20
        pointsMilesEarned:
          description: Guest stay points or miles earned
          type: string
          minLength: 0
          maxLength: 20
        arrivalDate:
          description: Guest arrival date.
          type: string
          format: date
          maxLength: 8
    membershipPointsToCalculate:
      type: object
      description: Request to run membership points calculation job.
      properties:
        membershipPointsCalculation:
          description: Membership point calculation details needed to run job.
          $ref: '#/components/schemas/membershipPointsCalculationType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    membershipTransaction:
      type: object
      description: Response object for fetching a membership transaction.
      properties:
        membershipTransactionDetails:
          description: Membership transaction details for the requested membership transaction ID.
          $ref: '#/components/schemas/membershipTransactionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    pointsRejectionReasonType:
      type: object
      description: Information related to a Points Rejection Reason summary.
      properties:
        rule:
          description: Indicates rule description for membership rule.
          type: string
        code:
          description: Indicates rule code for membership rule.
          type: string
          minLength: 0
          maxLength: 20
        rejectionReason:
          description: Indicates the reason the points were not awarded (e.g. Membership level requirements not met).
          type: string
          minLength: 0
          maxLength: 200
    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
    errorInstance_2:
      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
    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'
    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
    dateRangeType:
      type: object
      description: Date Range with Start and End dates.
      properties:
        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
    membershipPromotionType:
      type: object
      description: Information related to a membership promotion.
      properties:
        promotionCode:
          description: The promotion code attached with the member.
          type: string
          minLength: 0
          maxLength: 20
        startDate:
          description: The start date of membership promotion.
          type: string
          format: date
          maxLength: 8
        inactive:
          description: Indicates if the membership type is inactive.
          type: boolean
        hotelId:
          description: Indicates Resort of membership promotion
          type: string
          minLength: 0
          maxLength: 20
        endDate:
          description: Indicates the end date of membership promotion.
          type: string
          format: date
        global:
          description: Specifies whether the promotion code attached is global.
          type: boolean
        membershipPromotionId:
          description: The ID of a promotion owned by a membership.
          type: number
    airlineTransactionsStatus:
      type: object
      description: Request object for fetching membership transactions processed by the airline.
      properties:
        transactions:
          description: A collection of membership transactions processed by the airline.
          $ref: '#/components/schemas/airlineTransactionsType'
        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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    hotelStaysType:
      type: array
      description: Detailed information of the hotel stay.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelStayType'
    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
    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
    membershipTransactionRatesType:
      type: object
      description: Summary of rate details of current transaction associated with the stay.
      properties:
        rate:
          description: Details of rate for the current points transaction.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/membershipTransactionRateType'
        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
    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
        customizedPrivacyCodes:
          description: Customized privacy codes
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/customizedPrivacyCodesType'
    formattedTextTextType_2:
      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: Opera version number.
          $ref: '#/components/schemas/operaVersionNumberType'
        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
    otherAwardsIssueCriteria:
      type: object
      description: Request object to issue an OTHER type award to a member's profile.
      properties:
        issueAwardsInfo:
          type: array
          description: List of OTHER type awards information.
          maxItems: 100
          items:
            $ref: '#/components/schemas/membershipOtherAwardInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    membershipTransactionRateType:
      type: object
      description: Information related to a membership transaction rate.
      properties:
        fromDate:
          description: Indicates start date of the reservation.
          type: string
          format: date
          maxLength: 8
        toDate:
          description: Indicates end date of the reservation.
          type: string
          format: date
          maxLength: 8
        rateCode:
          description: Indicates the Rate code used in the reservation.
          type: string
          minLength: 0
          maxLength: 20
        pMSRateAmount:
          description: Indicates the Rate code amount in the property currency.
          $ref: '#/components/schemas/currencyAmountType'
        centralRateAmount:
          description: Indicates the Central rate amount in central currency.
          $ref: '#/components/schemas/currencyAmountType'
        currency:
          description: Indicates the Property currency code.
          type: string
        marketCode:
          description: Indicates the Market code linked to rate code.
          type: string
          minLength: 0
          maxLength: 20
    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
    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
    guestHousekeepingServiceRequestType:
      type: string
      description: Possible values for the Guest Service Status.
      enum:
      - DoNotDisturb
      - MakeUpRoom
      - NoStatusSelected
    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 resposible 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
        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
    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'
        parentReservationId:
          description: Reservation ID of the parent reservation.
          $ref: '#/components/schemas/reservationId'
        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 resposible 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
        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
    calculatedPointType:
      type: object
      description: Information related to a Calculated Points.
      properties:
        rule:
          description: Indicates rule description for membership rule.
          type: string
        type:
          description: Indicates the type of points.
          $ref: '#/components/schemas/rulePointsTypeType'
        points:
          description: Indicates the total award/tier points generated.
          type: number
        costPerNight:
          description: Indicates the cost incurred per minght.
          $ref: '#/components/schemas/currencyAmountType'
        ruleCode:
          description: Indicates rule code for membership rule.
          type: string
          minLength: 0
          maxLength: 20
        billingGroup:
          description: Indicates the billing group the points belong to.
          type: string
          minLength: 0
          maxLength: 20
    calculatedPoints:
      type: object
      description: Response object for fetching membership transaction points information.
      properties:
        calculatedPoint:
          description: Details of Points Accrued for the current points transaction.
          $ref: '#/components/schemas/calculatedPointsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    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_2:
      type: object
      description: Detailed information of the memberships.
      properties:
        comment:
          description: Additional comments regarding to the membership.
          $ref: '#/components/schemas/paragraphType_2'
        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, requirements 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: The source from which a profile is enrolled. If not specified when adding a membership to a profile, the value defaults to the 'Default Enrollment Source' setting in the OPERA Control.
          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: Indicator that implies if membership type is a Primary Membership Type. This attribute is only applicable when fetching information using get operations and not used in post and put operations.
          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 resposible 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
        autoPopulateFromName:
          description: Automatically populate membership number based on profile name.
          type: boolean
          default: 'false'
        referredByMembershipNameId:
          description: Name id this profile was referred by.
          type: integer
        referredByDisplayName:
          description: Display name this profile was referred by.
          type: string
          minLength: 0
          maxLength: 200
    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_2'
            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
    membershipAwardListType:
      type: object
      description: Information related to Member Award Issue List.
      properties:
        membershipId:
          description: Card number of the membership.
          type: number
        membershipType:
          description: Membership type for which awards are defined.
          type: string
          minLength: 0
          maxLength: 20
        membershipLevel:
          description: Level of this Membership Type.
          type: string
          minLength: 0
          maxLength: 20
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
        joinDate:
          description: Joined date on the Card.
          type: string
          format: date
          maxLength: 8
        expireDate:
          description: Expiry date on the Card.
          type: string
          format: date
          maxLength: 8
        membershipCardNo:
          description: Indicates Membership Card Number.
          type: string
          minLength: 0
          maxLength: 50
        totalAvailablePoints:
          description: Total award points available for redemption.
          type: number
        hotelId:
          description: Property at which the award was issued.
          type: string
          minLength: 0
          maxLength: 20
        awardNumber:
          description: An identifying number of the award, assigned by the system when the award was issued.
          type: number
        awardPoints:
          description: Number of points required by the award.
          type: number
        thresholdPoints:
          description: Indicates member is below the threshold limit or not to request award.
          type: number
        awardCode:
          description: Code assigned to this membership award.
          type: string
          minLength: 0
          maxLength: 40
        cancelDays:
          description: The cancel days, set up in awards configuration that establishes the number of days before arrival when a reservation may be cancelled without an award points penalty.
          type: integer
        dateAwarded:
          description: Date when the award was issued
          type: string
          format: date
          maxLength: 8
        bookingNumber:
          description: Reservation confirmation number.
          type: string
          minLength: 0
          maxLength: 50
        hotelBookingNumber:
          description: Property Reservation number.
          type: string
          minLength: 0
          maxLength: 30
        arrivalDate:
          description: The arrival date of the stay for when the award is associated.
          type: string
          format: date
          maxLength: 8
        cancelPenaltyPoints:
          description: The award points that will be deducted (based on a cancel days restriction) if the award is cancelled. (Cancel days, set up in awards configuration, and establish the number of days before arrival when a reservation may be cancelled without an award points penalty.)
          type: integer
        awardCancellationNumber:
          description: If the award was cancelled, the system-generated award cancellation number appears here.
          type: integer
        awardCancelDate:
          description: If the reservation associated with the award was cancelled, the reservation cancellation date appears here.
          type: string
          format: date
          maxLength: 8
        actualCancelPoints:
          description: The number of points actually deducted from the member's total award points if there is a penalty points restriction associated with the award cancellation.
          type: number
        reservationCancellationNumber:
          description: If the reservation associated with the award was cancelled, the reservation cancellation number appears here.
          type: string
          minLength: 0
          maxLength: 30
        statementId:
          description: If this award was included on a statement, the statement ID appears here. The field is blank if the award has not yet been reported on a statement
          type: integer
        cancelStatementID:
          description: If this award was included on a statement, the cancel statement ID appears here. The field is blank if the award has not yet been reported on a statement
          type: integer
        memberStatementId:
          description: If this award was included on a statement, the member statement ID appears here. The field is blank if the award has not yet been reported on a statement
          type: integer
        cancelMemberStatementID:
          description: If this award was included on a statement, the cancel member statement ID appears here. The field is blank if the award has not yet been reported on a statement
          type: integer
        numberOfNights:
          description: Number of nights cancel policy is applicable.
          type: integer
        stayDate:
          description: The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award
          type: string
          format: date
          maxLength: 8
        departureDate:
          description: The date of the departure of the reservation associated with the award. There may be more than one date (multiple nights) associated with award
          type: string
          format: date
          maxLength: 8
        cancelPolicyType:
          description: Type of cancel policy.
          type: string
          minLength: 0
          maxLength: 20
        awardSource:
          description: The source for the reservation associated with the award.
          type: string
          minLength: 0
          maxLength: 40
        calculatedCancelPoints:
          description: Total calculated points to cancel an issued award.
          type: number
        awardBasedOn:
          description: Indicates if the Award is based on RATE, PRODUCT,UPGRADE,FT or OTHER.
          $ref: '#/components/schemas/membershipAwardBasedOnType'
        pmsResvNo:
          description: Indicates PMS Reservation Number.
          type: string
          minLength: 0
          maxLength: 50
        crsBookNo:
          description: Indicates CRS Booking Number.
          type: string
          minLength: 0
          maxLength: 50
        product:
          description: Indicates the Product associated with the award.
          type: string
          minLength: 0
          maxLength: 50
        ratePlanCode:
          description: Rate plan code associated with the award.
          type: string
          minLength: 0
          maxLength: 20
    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
    telephoneInfoType_2:
      type: object
      description: Information on a telephone number for the customer.
      properties:
        telephone:
          description: Phone details for the profile.
          $ref: '#/components/schemas/telephoneType_2'
        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
    membershipPointsExceptionsType:
      type: object
      description: Contains Membership points exception information.
      properties:
        membershipTransactionIds:
          description: Unique identifier associated with the membership transaction.
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/membershipTransactionId'
        acceptPoints:
          description: Indicates if the membership points exception are to be accepted or rejected.
          type: boolean
        userNotes:
          description: Notes regarding the resolution of the membership transaction exception or for any other reason.
          type: string
          minLength: 0
          maxLength: 4000
    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
    enrollmentTypeType:
      type: string
      description: The type of external system that the guest is enrolling in, such as Loyalty, Gaming or Activities.
      enum:
      - Gaming
      - Loyalty
      - Activities
    identificationInfoType_2:
      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_2'
        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
    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
    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
    pointsRejectionReasons:
      type: object
      description: Response object for fetching member transactions points rejection reasons information.
      properties:
        pointsRejectionReason:
          description: Details on rule and reason the points were not awarded for a given point transaction.
          $ref: '#/components/schemas/pointsRejectionReasonsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    claimRecordType:
      type: string
      description: Record Type associated with a claim.
      enum:
      - Stay
      - Other
      - LimitedAdjustment
    memberPointsToExpireCollectionType:
      type: object
      description: Membership points to expire with the membership details to differentiate.
      properties:
        membershipDetails:
          description: Member details for the requested membership ID.
          $ref: '#/components/schemas/membershipDetailsType'
        memberPointsToExpireListType:
          type: array
          description: List of of member points to expire.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/memberPointsToExpireListType'
    membershipTransactionsSummary:
      type: object
      description: Response object for fetching member point totals information.
      properties:
        membershipDetails:
          description: Member details for the requested membership ID.
          $ref: '#/components/schemas/membershipDetailsType'
        transactionsSummary:
          description: Member transaction Summary for the requested membership ID.
          $ref: '#/components/schemas/memberTransactionSummaryType'
        recentTransactionsSummary:
          description: Member transaction Summary(Range) for the requested membership ID.
          $ref: '#/components/schemas/memberTransactionRecentSummaryType'
        pointsSummary:
          description: Member points summary for the requested membership ID.
          $ref: '#/components/schemas/memberPointsSummaryType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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_2'
        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
    membershipAwardPointByHotelType:
      type: object
      description: Award points information group by Hotel.
      properties:
        hotelId:
          description: Award points issued at Property level.
          type: string
          minLength: 0
          maxLength: 20
        totalPoints:
          description: Sum of total positive and negative points.
          type: number
    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'
    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
          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: 80
        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: 80
    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'
    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
    rulePointsTypeType:
      type: string
      description: Possible membership points types.
      enum:
      - Base
      - Bonus
    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_2:
      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
    membershipAwardsListType:
      type: array
      description: List of Member Awards information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/membershipAwardListType'
    claimMembershipType:
      type: object
      description: Summary of claim activity log information.
      properties:
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
        membershipClass:
          description: Indicates the membership class.
          type: string
        membershipId:
          description: Card Number of the membership.
          type: string
        membershipIdNo:
          description: Membership ID Number.
          type: number
        membershipType:
          description: Membership Type code.
          type: string
          minLength: 0
          maxLength: 20
        membershipLevel:
          description: The current level of the membership.
          type: string
          minLength: 0
          maxLength: 20
        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
    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
    membershipTransactionExceptionType:
      type: object
      description: Details about a membership like ProfileID, Card Number, Type, Level, etc.
      properties:
        profileId:
          description: The profile to which this membership is associated with.
          $ref: '#/components/schemas/profileId'
        name:
          description: The profile name associated with this membership.
          type: string
          minLength: 0
          maxLength: 128
        membershipId:
          description: Unique identifier of this membership.
          $ref: '#/components/schemas/uniqueID_Type_2'
        membershipCardNo:
          description: The card number associated with this membership.
          type: string
          minLength: 0
          maxLength: 50
        membershipType:
          description: The type of the membership.
          $ref: '#/components/schemas/codeDescriptionType'
        membershipLevel:
          description: The current level of the membership.
          type: string
          minLength: 0
          maxLength: 20
        joinedDate:
          description: Date when the member enrolled for the membership.
          type: string
          format: date
          maxLength: 8
        cardExpirationDate:
          description: Membership card expiration date.
          type: string
          format: date
          maxLength: 8
        membershipTransactionId:
          description: Unique identifier associated with the membership transaction.
          $ref: '#/components/schemas/membershipTransactionId'
        hotelId:
          description: Hotel code of the membership transaction exceptions.
          type: string
          minLength: 0
          maxLength: 20
        fromToRangeDate:
          description: Arrival and Departure date of stay for which you are displaying membership transaction exceptions.
          $ref: '#/components/schemas/dateRangeType'
        reservationNumber:
          description: Any reference like reservation no etc against which the certificate was consumed.
          type: string
          minLength: 0
          maxLength: 50
        roomsBooked:
          description: If multiple room membership transaction exceptions occurred, the number of rooms booked.(MR)
          type: integer
        backToBack:
          description: Indicates if back to back membership transaction exceptions have occurred or not.
          type: string
          minLength: 0
          maxLength: 2
        averageRate:
          description: The average rate of the stay.
          type: number
        tierStays:
          description: Tier stay points associated with this membership points transaction.
          type: number
        totalAwardPoints:
          description: Award points associated with this membership points transaction.
          type: number
        totalNights:
          description: Tier night points associated with this membership points transaction.
          type: number
        totalRevenue:
          description: Tier revenue points associated with this membership points transaction.
          type: number
        pointsCalculate:
          description: Points Calculated value(Y/N) for the selected transaction.
          type: boolean
        userNotes:
          description: Notes regarding the resolution of the membership transaction exception or for any other reason.
          type: string
          minLength: 0
          maxLength: 4000
        processingMessages:
          description: The systems records and notes identifying the exception criteria.
          type: string
          minLength: 0
          maxLength: 2000
        totalPoints:
          description: The total number of award points associated with this transaction.
          type: number
        awardBasePoints:
          description: The total number of base award points for this membership points transaction.
          type: number
        awardBonusPoints:
          description: Indicates if this transaction involves bonus points, The total number of bonus points.
          type: number
        tierPoints:
          description: Details if this transaction is associated with tier points.
          $ref: '#/components/schemas/membershipTransactionTierPointsType'
        computedPoints:
          description: Information to compute award and tier points for membership transaction exception.
          $ref: '#/components/schemas/membershipTransactionExceptionComputePointsType'
        exceptionType:
          description: Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,
          type: integer
    eCertificateIssueSourceType:
      type: string
      description: Indicates that OPERA E-Certificate is issued by external system.
      enum:
      - Opera
      - Web
      - Interface
    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
    profileNameType:
      type: object
      description: This provides name information for a person.
      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.). Currently this attribute is not used for PUT and POST operations.
          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.). Currently this attribute is not used for PUT and POST operations.
          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'
    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'
        parentReservationId:
          description: Reservation ID of the parent reservation.
          $ref: '#/components/schemas/reservationId'
        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
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    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.). Currently this attribute is not used for PUT and POST operations.
          $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.). Currently this attribute is not used for PUT and POST operations.
          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
    enrollmentPaymentDetailsType:
      type: object
      description: Payment details to enrolll profile to the membership program.
      properties:
        paymentMethod:
          description: Indicate which method of payment will be used for enrollment to membership program.
          $ref: '#/components/schemas/codeDescriptionType'
        amount:
          description: Amount/Fee to enroll to membership Program.
          type: number
        amountCode:
          description: Code of Amount/Fee to enroll to membership Program.
          $ref: '#/components/schemas/codeDescriptionType'
        paymentDate:
          description: The date of Payment for enrollment to membership program.
          type: string
          format: date
          maxLength: 8
        comments:
          description: Payment Comments.
          type: string
          minLength: 0
          maxLength: 4000
    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:
        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
    reservationId:
      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
    membershipOtherAwardInfoType:
      type: object
      description: Information about the OTHER type Award and profile membership. OTHER type awards can be redeemed based on the points available with a particular member.
      properties:
        otherInfo:
          description: Information related to the Other type Award.
          $ref: '#/components/schemas/otherAwardAvailabilityType'
        membershipId:
          description: Unique Membership ID.
          type: number
        membershipNumber:
          description: The card number associated with the membership.
          type: string
          minLength: 0
          maxLength: 50
        membershipType:
          description: The type of the membership.
          type: string
          minLength: 0
          maxLength: 20
    membershipPromotionDetails:
      type: object
      description: The request element used to create a membership promotion.
      properties:
        membershipPromotion:
          description: The membership promotion information to add to the database.
          $ref: '#/components/schemas/membershipPromotionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    commissionPayoutToType:
      type: string
      enum:
      - TravelAgent
      - Source
      - TravelAgentSource
      - None
    membershipTransactionRevenuesType:
      type: object
      description: Summary of stay details for current transaction.
      properties:
        revenue:
          description: Details on stay details for current point transaction.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/membershipTransactionRevenueType'
        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
    upgradeAvailabilityType:
      type: object
      description: Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
      properties:
        awardType:
          description: Unique code that identifies this award.
          type: string
          minLength: 0
          maxLength: 40
        hotelId:
          description: HotelCode where the award will be consumed.
          type: string
          minLength: 0
          maxLength: 20
        totalAvailablePoints:
          description: Total award points available for redemption.
          type: number
        pointsRequired:
          description: The number of points that must be redeemed for this award.
          type: number
        cancelPenaltyPoints:
          description: The award points that will be forfeited if the cancel penalty charge is applied.
          type: number
        cancelPenaltyDays:
          description: Number of days before arrival when a reservation may be cancelled without an award points penalty.
          type: number
        cancelPenaltyCharge:
          description: The cancel penalty charge.
          type: number
        cancelPenaltyType:
          description: The penalty charge is either a percentage or a flat number of points.
          type: string
          minLength: 0
          maxLength: 20
        rawIssueKey:
          description: Issue key in format of Raw data.
          type: string
          minLength: 0
          maxLength: 4000
        awardNumber:
          description: An identifying number of the award, assigned by the system when the award was issued.
          type: number
        fromRoomCategory:
          description: Indicates room type code for the room prior to the upgrade.
          type: string
          minLength: 0
          maxLength: 4000
        toRoomCategory:
          description: Indicates room type code of the upgrade room.
          type: string
          minLength: 0
          maxLength: 4000
        fromRoomDescription:
          description: Indicates room type Description for the room prior to the upgrade.
          type: string
          minLength: 0
          maxLength: 4000
        toRoomDescription:
          description: Indicates room type Description of the upgrade room.
          type: string
          minLength: 0
          maxLength: 4000
        fromRoom:
          description: Indicates room type code for the room prior to the upgrade.
          type: string
          minLength: 0
          maxLength: 20
        toRoom:
          description: Indicates room type code of the upgrade room.
          type: string
          minLength: 0
          maxLength: 20
        stayDate:
          description: The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.
          type: string
          format: date
          maxLength: 8
    membershipAwardPointsType:
      type: object
      description: Details associated with award points.
      properties:
        basePoints:
          description: Total number of base award points for a membership points transaction.
          type: integer
        bonusPoints:
          description: If a membership points transaction involves bonus points, the total number of bonus points.
          type: integer
        miscPoints:
          description: If a membership points transaction involves points imported into ORS from a third-party system, the total number of points.
          type: integer
        totalPoints:
          description: The total number of award points.
          type: integer
        pointsExpiryDate:
          description: The date until points are eligible for redemption based on membership type configuration.
          type: string
          format: date
          maxLength: 8
        ruleCode:
          description: Rule Code for award points.
          type: string
          minLength: 0
          maxLength: 20
    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
    membershipAwardExportInfo:
      type: object
      description: Response object to fetch members information for Fulfillment house processing.
      properties:
        exportInfo:
          description: Collection of member information.
          $ref: '#/components/schemas/membershipAwardsExportType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    membershipTransactionRevenueType:
      type: object
      description: Information related to a membership transactions Revenue.
      properties:
        date:
          description: Indicates the Date when the revenue was recognized.
          type: string
          format: date
          maxLength: 8
        revenueType:
          description: Indicates the Revenue type associated to Revenue. This is mutually exclusive to Transaction code.
          type: string
        transactionCode:
          description: Indicates the Transaction code associated to Revenue. This is mutually exclusive to Revenue type.
          type: string
          minLength: 0
          maxLength: 20
        transactionCodeDescription:
          description: Description of Transaction code.
          type: string
          minLength: 0
          maxLength: 2000
        pMSRevenue:
          description: Indicates the Total PMS Revenue accrued.
          $ref: '#/components/schemas/currencyAmountType'
        centralRevenue:
          description: Indicates the Total central revenue Accrued.
          $ref: '#/components/schemas/currencyAmountType'
        qualified:
          description: Indicates if the stay is qualified for points calculation.
          type: boolean
    reservationFolioWindowsType:
      type: array
      description: Collection of reservation folio windows.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationFolioWindowType'
    resAccessRestrictionType:
      type: string
      description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
      enum:
      - Change
      - Cancel
      - ChangeOrCancel
    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 resposible 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
        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
    membershipClaims:
      type: object
      description: Response object for fetching membership claims.
      properties:
        membershipClaimsDetail:
          description: A collection of membership claims.
          $ref: '#/components/schemas/membershipClaimSummaryListType'
        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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    pointsRejectionReasonsType:
      type: object
      description: Summary of reason points were not awarded for a given points transaction.
      properties:
        pointsRejectionReason:
          description: Details on rule and reason the points were not awarded for a given point transaction.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/pointsRejectionReasonType'
        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
    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
    mailingPreferencesType:
      type: object
      description: Indicates guest's mailing preferences.
      properties:
        eFolio:
          description: Defines if an E-Folio is required.
          type: boolean
        mailings:
          description: Defines mailings only.
          type: boolean
    airlineTransactionImportInfoType:
      type: object
      description: Contains details of the membership transaction processing status, provided by the airline.
      properties:
        importDate:
          description: The date when this batch was imported into OPERA
          type: string
          format: date
          maxLength: 8
        status:
          description: Status identifying the outcome of import activity
          $ref: '#/components/schemas/airlineImportStatusType'
        description:
          description: Description of the error that caused the import to fail
          type: string
          minLength: 0
          maxLength: 200
    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
    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_2'
        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
    eCertificatesType:
      type: array
      description: List of e-certificates for the profile.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/eCertificateType'
    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_2'
        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'
    claimAdjustmentPointsType:
      type: object
      description: Summary of membership claim award points and tier points.
      properties:
        adjustmentCode:
          description: The selected adjustment code's Award, Stay, Nights, and Revenue thresholds will display.
          type: string
          minLength: 0
          maxLength: 20
        totalBasePointsLimits:
          description: Total base points limits for adjustment.
          type: string
        baseStayLimits:
          description: Base stay limits for adjustment.
          type: string
        baseNightsLimits:
          description: Base nights limits for adjustment.
          type: string
        baseRevenueLimits:
          description: Base revenue limits for adjustment.
          type: string
        awardBasePoints:
          description: Base award points for adjustment.
          type: integer
        awardBonusPoints:
          description: Bonus award points for adjustment.
          type: integer
        awardMiscPoints:
          description: Miscellaneous award points for adjustment.
          type: integer
        awardTotalPoints:
          description: Total award points for adjustment.
          type: integer
        tierBaseStayPoints:
          description: Tier base stay points for adjustment.
          type: integer
        tierBonusStayPoints:
          description: Tier bonus stay points for adjustment.
          type: integer
        tierTotalStayPoints:
          description: Tier total stay points for adjustment.
          type: integer
        tierBaseNightsPoints:
          description: Tier base nights points for adjustment.
          type: integer
        tierBonusNightsPoints:
          description: Tier bonus nights points for adjustment.
          type: integer
        tierTotalNightsPoints:
          description: Tier total nights points for adjustment.
          type: integer
        tierBaseRevenuePoints:
          description: Tier Base revenue points for adjustment.
          type: integer
        tierBonusRevenuePoints:
          description: Tier Bonus revenue points for adjustment.
          type: integer
        tierTotalRevenuePoints:
          description: Tier Total tier revenue points for adjustment.
          type: integer
    extendMemberPointsToExpire:
      type: object
      description: Request object to extend a member points to expire.
      properties:
        membershipId:
          description: Unique Membership ID.
          type: number
        expirationDate:
          description: Expiration date to be extended.
          type: string
          format: date
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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'
    memberTransactionRecentSummaryType:
      type: object
      description: Itemized information related to a membership transactions summary.
      properties:
        awardPoints:
          description: Summary of transactions associated with award points.
          $ref: '#/components/schemas/memberTransactionSummaryAwardPointsType'
        tierPoints:
          description: Summary of transactions associated with tier points.
          $ref: '#/components/schemas/memberTransactionSummaryTierPointsType'
        guestStays:
          description: Summary of transactions associated with guest stays.
          $ref: '#/components/schemas/memberTransactionSummaryGuestStaysType'
        years:
          description: Range in Years.
          type: integer
    resProfileTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Group
      - TravelAgent
      - Source
      - ReservationContact
      - BillingContact
      - Addressee
    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
    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'
    membershipClaimSummaryType:
      type: object
      description: Summary information of a claim.
      properties:
        claimNo:
          description: Unique ID Number assigned to the claim when the claim was created.
          $ref: '#/components/schemas/uniqueID_Type_2'
        claimDate:
          description: Date the claim was made.
          type: string
          format: date
          maxLength: 8
        callerName:
          description: Name of the person placing the claim. This name may be different from the name on the membership card.
          type: string
          minLength: 0
          maxLength: 100
        replyBy:
          description: The date, if any, by which a response to the caller was promised.
          type: string
          format: date
          maxLength: 8
        membershipType:
          description: Membership Type code.
          type: string
          minLength: 0
          maxLength: 20
        membershipId:
          description: Indicates membership card number of the guest.
          type: string
          minLength: 0
          maxLength: 50
        claimStatus:
          description: Status of the claim.(Open, Closed, Pending Review, Waiting for Manager, etc.)
          type: string
          minLength: 0
          maxLength: 20
        claimType:
          description: Type of user-definable claim such as New Card, Stay, etc.
          type: string
          minLength: 0
          maxLength: 40
        closeDate:
          description: If the status is closed, the date the claim was closed.
          type: string
          format: date
          maxLength: 8
        recordType:
          description: Record type of the claim.
          $ref: '#/components/schemas/claimRecordType'
        hotelId:
          description: Property where the stay took place.
          type: string
          minLength: 0
          maxLength: 20
        confirmationNo:
          description: List of reservation confirmation or reference numbers associated with this claim. Like PMS reservation number, Central(ORS) booking number.
          $ref: '#/components/schemas/uniqueIDListType'
        arrival:
          description: Arrival date for the stay associated with this claim.
          type: string
          format: date
          maxLength: 8
        departure:
          description: Departure date for the stay associated with this claim.
          type: string
          format: date
          maxLength: 8
        owner:
          description: User who is assigned to handle this claim.
          type: string
          minLength: 0
          maxLength: 50
        submitter:
          description: User who entered this claim.
          type: string
          minLength: 0
          maxLength: 50
        source:
          description: Source of the claim. This will be either OCIS, OPMS or WEB.
          $ref: '#/components/schemas/claimSourceType'
        origin:
          description: Origin of the membership claim. User definable values like Email, Fax, Phone Call, etc.
          type: string
          minLength: 0
          maxLength: 20
        approvalStatus:
          description: Filter claims by approved,rejected or pending status.
          $ref: '#/components/schemas/claimApprovalStatusType'
        callerInformation:
          description: More information related to call that help to resolve the claim..
          type: string
          minLength: 0
          maxLength: 2000
        profileId:
          description: Unique ID of the profile.
          $ref: '#/components/schemas/profileId'
        membershipIdNo:
          description: Membership ID Number.
          type: number
        activityLog:
          description: Contains summary information of the claim.
          $ref: '#/components/schemas/claimActivityLogListType'
    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_2'
        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 resposible 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
    enrollment_2:
      type: object
      description: Response object for fetching profile enrollment from external system.
      properties:
        enrollmentInfo:
          description: Type contains profile enrollment information.
          $ref: '#/components/schemas/profileEnrollmentType_2'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    claimActivityLogType:
      type: object
      description: Summary of claim activity log information.
      properties:
        sequence:
          description: Sequence number for claim activity.
          type: integer
        type:
          description: Claim activity type such as Reply, Call Property for Verification, Caller Called Back, and Remarks.
          type: string
          minLength: 0
          maxLength: 20
        comments:
          description: Name of the application user who created the activity record.
          type: string
          minLength: 0
          maxLength: 2000
        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 resposible 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
    membershipReservationDetailCodeType:
      type: string
      description: Supported memebership reservation detail code type.
      enum:
      - ArrivalsTotal
      - DeparturesTotal
      - InHouseTotal
      - RoomRevenue
    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_2'
        payeeName:
          description: Name of the payee.
          type: string
          minLength: 0
          maxLength: 80
        payeeAddress:
          description: Address of the payee.
          $ref: '#/components/schemas/addressInfoType_2'
        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_2'
    otherAwardAvailabilityType:
      type: object
      description: Information related to the Other type Award.
      properties:
        awardType:
          description: Unique code that identifies this award.
          type: string
          minLength: 0
          maxLength: 40
        shortDescription:
          description: Descriptive name of the award.
          type: string
          minLength: 0
          maxLength: 80
        awardValue:
          description: The actual currency value of the award.
          type: number
        pointsRequired:
          description: The number of points requried to redeem this award.
          type: number
    issueAwardInfoType:
      type: object
      description: Information about issue award.
      properties:
        pointsRequired:
          description: The number of points that must be redeemed for this award.
          type: number
        cancelPenaltyPoints:
          description: The award points that will be forfeited if the cancel penalty charge is applied.
          type: number
        cancelPenaltyDays:
          description: Number of days before arrival when a reservation may be cancelled without an award points penalty.
          type: number
        awardNumber:
          description: An identifying number of the award, assigned by the system when the award was issued.
          type: number
        packageCode:
          description: Package/Product code for the award.
          type: string
          minLength: 0
          maxLength: 20
        stayDate:
          description: The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.
          type: string
          format: date
          maxLength: 8
    awardsToGrant:
      type: object
      description: Response object to fetch award details to grant an award.
      properties:
        membershipAwardsList:
          description: Collection of member award list.
          $ref: '#/components/schemas/membershipAwardsAvailabilityType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    membershipReservationDetailUnitType:
      type: object
      description: The filetered membership reservation information.
      properties:
        value:
          description: Membership reservation detail value.
          type: number
        code:
          $ref: '#/components/schemas/membershipReservationDetailCodeType'
    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
    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
    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
    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
    memberPointsToExpireCollection:
      type: object
      description: Response object for fetching member points to expire information.
      properties:
        memberPointsToExpireCollection:
          type: array
          description: List of of member points to expire.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/memberPointsToExpireCollectionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    emailInfoType_2:
      type: object
      description: Information on an email for the customer.
      properties:
        email:
          description: eMail deatils for the profile.
          $ref: '#/components/schemas/emailType_2'
        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
    memberPointsToExpireListType:
      type: array
      description: List of of member points to expire.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/memberPointToExpireType'
    memberInfoType:
      type: object
      description: Contains details of the membership transaction processing status, provided by the airline.
      properties:
        membershipId:
          description: Membership Card Number
          type: string
          minLength: 0
          maxLength: 50
        membershipType:
          description: Membership Program Code or Membership Type
          type: string
          minLength: 0
          maxLength: 50
        lastName:
          description: Last Name of the guest that this record corresponds to
          $ref: '#/components/schemas/surnameType'
        firstName:
          description: First Name of the guest that this record corresponds to
          $ref: '#/components/schemas/givenNameType'
    facilityCodesType:
      type: array
      description: List of the facility codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/facilityCodeType'
    membershipCardHistoryType:
      type: object
      description: Contains details of the card history of a member.
      properties:
        membershipCardNo:
          description: Membership Card Number
          type: string
          minLength: 0
          maxLength: 50
        membershipType:
          description: Membership Program Code or Membership Type
          type: string
          minLength: 0
          maxLength: 50
    memberHistoryList:
      type: object
      description: Response object for member history.
      properties:
        memberHistoryList:
          type: array
          description: Contains list of history of a member.
          maxItems: 1000
          items:
            $ref: '#/components/schemas/membershipHistoryType'
        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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    claimSourceType:
      type: string
      description: Source of the membership claim.
      enum:
      - Ocis
      - Opms
      - Web
    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
    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_2:
      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:
        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
    membershipTransactionTierPointsType:
      type: object
      description: Details associated with tier points.
      properties:
        baseStay:
          description: Total number of base stay tier points for a membership points transaction.
          type: integer
        baseNights:
          description: Total number of base nights tier points for a membership points transaction.
          type: integer
        baseRevenue:
          description: Total number of base revenue tier points for a membership points transaction.
          type: integer
        bonusStay:
          description: The total number of bonus stay tier points.
          type: integer
        bonusNights:
          description: The total number of bonus nights tier points.
          type: integer
        bonusRevenue:
          description: The total number of bonus revenue tier points.
          type: integer
    membershipPointsCalculationProcessType:
      type: string
      description: Issuing awards for guests belonging to a membership type, with a specific award code that is of Other type.
      enum:
      - CalculatePoints
      - ExpirePoints
      - IssueAwards
    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'
    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
    memberAwardDetailType_2:
      type: object
      description: Details related to member award like award type, stay date, rate code, etc.
      properties:
        awardType:
          description: The award type or code.
          type: string
          minLength: 0
          maxLength: 40
        actionType:
          description: Award issue , cancel or update action.
          $ref: '#/components/schemas/memberAwardActionType'
        awardBasedOn:
          description: Indicates if award is a Stay, Package Element or other.
          type: string
          minLength: 0
          maxLength: 20
        cancelPenaltyDays:
          description: Number days before arrival to apply penalty for cancellation.
          type: integer
        cancelPenaltyCharge:
          description: Number points deducted if award is cancelled.
          type: integer
        cancelPenaltyType:
          description: Type of cancel penalty like Points, etc.
          type: string
          minLength: 0
          maxLength: 20
        cancelPenaltyPoints:
          description: Number of penalty points if cancelled.
          type: integer
        numberOfNights:
          description: Number of nights cancel policy is applicable.
          type: integer
        cancelPolicyType:
          description: Type of cancel policy.
          type: string
          minLength: 0
          maxLength: 20
        stayDate:
          description: Date of stay.
          type: string
          format: date
          maxLength: 8
        rateCode:
          description: Rate code associated with the reservation.
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Room type label associated with the reservation.
          type: string
          minLength: 0
          maxLength: 20
        product:
          description: Product code for which the award was issued, in case of a product award.
          type: string
          minLength: 0
          maxLength: 80
        fromRoomType:
          description: Room type label before the upgrade in case of an upgrade award.
          type: string
          minLength: 0
          maxLength: 20
        toRoomType:
          description: Room type label after the upgrade for an upgrade award.
          type: string
          minLength: 0
          maxLength: 20
        totalLocalAmount:
          description: Total Local Amount on bill in Hotel Currency.
          type: number
        redeemedLocalAmount:
          description: Redeemed Local Amount on bill in Hotel Currency.
          type: number
        totalCentralAmount:
          description: Total Central Amount on bill in External System Currency.
          type: number
        redeemedCentralAmount:
          description: Redeemed Central Amount on bill in External System Currency.
          type: number
        transactionCode:
          description: The Payment Transaction Code for which the Surcharge Applies.
          type: string
          minLength: 0
          maxLength: 20
        transactionNo:
          description: Unique Transaction Identifier.
          type: number
        exchangeRateType:
          description: Exchange Rate Type for the Currency Exchange.
          type: string
          minLength: 0
          maxLength: 20
        awardVoucherNo:
          description: Award Voucher Number.
          type: string
          minLength: 0
          maxLength: 40
        awardProductId:
          description: Unique ID for the award product if issued.
          $ref: '#/components/schemas/uniqueID_Type_2'
        awardCancellationNo:
          description: Unique ID for the award cancellation if cancelled.
          $ref: '#/components/schemas/uniqueID_Type_2'
        inactive:
          description: If the award detail is inactive.
          type: boolean
        pointsRequired:
          description: Points required for the stay date.
          type: integer
        actualCancelPoints:
          description: Actual number of cancel points.
          type: integer
    memberPointsExceptionType:
      type: object
      description: Details about a membership like ProfileID, Card Number, Type, Level, etc.
      properties:
        hotelId:
          description: Hotel code of the membership transaction exceptions.
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: The profile to which this membership is associated with.
          $ref: '#/components/schemas/profileId'
        name:
          description: The profile name associated with this membership.
          type: string
        fromToRangeDate:
          description: Arrival and Departure date of stay for which you are displaying membership transaction exceptions.
          $ref: '#/components/schemas/dateRangeType'
        membershipIdNo:
          description: Unique identifier of this membership.
          type: number
        membershipType:
          description: The type of the membership.
          $ref: '#/components/schemas/codeDescriptionType'
        membershipCardNo:
          description: The card number associated with this membership.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The current level of the membership.
          type: string
          minLength: 0
          maxLength: 20
        membershipTransactionId:
          description: Unique identifier associated with the membership transaction.
          $ref: '#/components/schemas/membershipTransactionId'
        roomsBooked:
          description: The number of rooms booked.(MR)
          type: integer
        backToBack:
          description: Indicates if back to back membership transaction exceptions have occurred or not.
          type: boolean
        averageRate:
          description: The average rate of the stay.
          type: number
        awardPoints:
          description: Award points associated with this membership points transaction.
          type: number
        tierNightPoints:
          description: Tier night points associated with this membership points transaction.
          type: number
        tierStayPoints:
          description: Tier stay points associated with this membership points transaction.
          type: number
        tierRevenuePoints:
          description: Tier revenue points associated with this membership points transaction.
          type: number
        pointsCalculate:
          description: Points Calculated value(Y/N) for the selected transaction.
          type: boolean
        reservationIdList:
          description: The reservation related ids.
          $ref: '#/components/schemas/reservationIdList'
        processingMessages:
          description: The systems records and notes identifying the exception criteria.
          type: string
          minLength: 0
          maxLength: 2000
        exceptionStatus:
          description: Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,
          $ref: '#/components/schemas/membershipExceptionStatusType'
    membershipPromotionsDetails:
      type: object
      description: Response object for fetching membership promotions information.
      properties:
        membershipPromotions:
          type: array
          maxItems: 4000
          description: Collection of membership promotions.
          items:
            $ref: '#/components/schemas/membershipPromotionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    membershipAwardRecipientInfoType:
      type: object
      description: Type holds details of member.
      properties:
        memberInfo:
          description: Member Name.
          $ref: '#/components/schemas/profileNameType'
        phoneNumber:
          description: Phone Number.
          $ref: '#/components/schemas/phoneNumberType'
        companyName:
          description: It returns a Company Name,If the member is associated with a company.
          type: string
          minLength: 0
          maxLength: 40
        addressInfo:
          description: Member's Mailing Address infomation.
          $ref: '#/components/schemas/addressInfoType_2'
    eCertificateIssueType:
      type: string
      description: Indicates that guest purchased OPERA E-Certificate.
      enum:
      - Assigned
      - OptedIn
      - Purchased
    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
    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
    membershipAwardExportType:
      type: object
      description: Types holds the details of Member.
      properties:
        awardNumber:
          description: Award Number to identify member's information.
          type: number
        recipientInfo:
          description: Recipient information.
          $ref: '#/components/schemas/membershipAwardRecipientInfoType'
        userDefinedFields:
          description: Collections of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
    otherAvailabilityType:
      type: object
      description: Information related to Other Award.
      properties:
        awardType:
          description: Unique code that identifies this award.
          type: string
          minLength: 0
          maxLength: 40
        sellBeginDate:
          description: Beginning date of the award.
          type: string
          format: date
          maxLength: 8
        sellEndDate:
          description: End date that the award will be available.
          type: string
          format: date
          maxLength: 8
        shortDescription:
          description: Descriptive name of the award.
          type: string
          minLength: 0
          maxLength: 80
        awardValue:
          description: The actual value of the award, in the amount of currency.
          type: number
        totalAvailablePoints:
          description: Total award points available for redemption.
          type: number
        pointsRequired:
          description: The number of points that must be redeemed for this award.
          type: number
        longDescription:
          description: Detail description of the award.
          type: string
          minLength: 0
          maxLength: 2000
        awardNumber:
          description: An identifying number of the award, assigned by the system when the award was issued.
          type: number
    membershipTransactionDetailsType:
      type: object
      description: Detailed information related to a membership transaction.
      properties:
        membershipTransactionId:
          description: Unique identifier associated with the membership transaction.
          $ref: '#/components/schemas/membershipTransactionId'
        hotelId:
          description: Property from which the membership stay information was received.
          type: string
          minLength: 0
          maxLength: 20
        transactionType:
          description: The type of membership points transaction.
          type: string
          minLength: 0
          maxLength: 20
        transactionDate:
          description: The date when the points were calculated.
          type: string
          format: date
          maxLength: 8
        reservationIdList:
          description: Unique reservation identifiers associated with this transaction like PMS Confirmation Number and CRS Booking Number.
          $ref: '#/components/schemas/reservationIdList'
        currency:
          description: The property currency at the originating PMS.
          type: string
          minLength: 0
          maxLength: 20
        reference:
          description: User-defined reference field for the Membership Transaction Adjustment.
          type: string
          minLength: 1
          maxLength: 20
        stayTimeSpan:
          description: Arrival and Departure date for the stay.
          $ref: '#/components/schemas/timeSpanType_2'
        ratePromotion:
          description: Promotion code assigned on reservation.
          type: string
          minLength: 0
          maxLength: 20
        profilePromotions:
          description: Promotion code assigned on reservation.
          $ref: '#/components/schemas/codeListType'
        pointsCreditDate:
          description: For adjustments, the date when the points are to be credited.
          type: string
          format: date
          maxLength: 8
        averageRateAmount:
          description: The average cost of the room per night.
          type: number
        adjustment:
          description: Indicates if the transaction was created as an adjustment.
          type: boolean
        pointsCalculated:
          description: Indicates if the points have been calculated on this transaction.
          type: boolean
        exceptionRejected:
          description: Indicates if the exception points were rejected.
          type: boolean
        exception:
          description: Indicates if the transaction was flagged as an exception.
          type: boolean
        roomLabel:
          description: The room type for this transaction.
          type: string
          minLength: 0
          maxLength: 50
        bookedRoomLabel:
          description: The booked room type for this transaction.
          type: string
          minLength: 0
          maxLength: 50
        notes:
          description: Notes associated with this transaction.
          type: string
          minLength: 0
          maxLength: 4000
        statementId:
          description: Statement batch ID.
          $ref: '#/components/schemas/uniqueID_Type_2'
        memberStatementId:
          description: Member statement batch ID.
          $ref: '#/components/schemas/uniqueID_Type_2'
        billingGroup:
          description: Billing group the points belong to.
          type: string
          minLength: 0
          maxLength: 20
        baseBillingGroup:
          description: Base billing group the points belong to.
          type: string
          minLength: 0
          maxLength: 20
        bonusBillingGroup:
          description: Bonus billing group the points belong to.
          type: string
          minLength: 0
          maxLength: 20
        pointsCost:
          description: The total cost associated with points earned by this transaction.
          type: integer
        processingMessages:
          description: Messages generated by the system during points calculation.
          type: string
          minLength: 0
          maxLength: 2000
        awardPoints:
          description: Details if this transaction is associated with award points.
          $ref: '#/components/schemas/membershipAwardPointsType'
        tierPoints:
          description: Details if this transaction is associated with tier points.
          $ref: '#/components/schemas/membershipTransactionTierPointsType'
        membershipCardNo:
          description: The card number associated with this membership transaction.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The membership level associated with the membership transaction.
          type: string
          minLength: 0
          maxLength: 20
        userName:
          description: User who inserted or updated the membership transaction.
          type: string
          minLength: 0
          maxLength: 256
    memberPointsToExpire:
      type: object
      description: Response object for fetching member points to expire information.
      properties:
        memberPointsToExpireList:
          description: Collection of member points to expire.
          $ref: '#/components/schemas/memberPointsToExpireListType'
        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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    membershipIssueAwards:
      type: object
      description: Response object for fetching member issued award list.
      properties:
        membershipAwardsList:
          description: Collection of member award list.
          $ref: '#/components/schemas/membershipAwardsListType'
        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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    revenues:
      type: object
      description: Response object for fetching Membership Transaction Revenue.
      properties:
        revenue:
          description: Details on stay details for current point transaction.
          $ref: '#/components/schemas/membershipTransactionRevenuesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    membershipTransactionId:
      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: 25
        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
    claimReservationInfoType:
      type: object
      description: Summary of claim activity log information.
      properties:
        hotelId:
          description: Property where the stay associated with this claim.
          type: string
          minLength: 0
          maxLength: 20
        confirmationNo:
          description: List of reservation confirmation or reference numbers associated with this claim. Like PMS reservation number, Central(ORS) booking number.
          $ref: '#/components/schemas/uniqueIDListType'
        arrival:
          description: Arrival date for the stay associated with this claim.
          type: string
          format: date
          maxLength: 8
        departure:
          description: Departure date for the stay associated with this claim.
          type: string
          format: date
          maxLength: 8
    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
    memberTransactionSummaryTierPointsType:
      type: object
      description: Items summary associated with Tier points.
      properties:
        bonusRevenue:
          description: Total number of bonus revenue tier points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        bonusStay:
          description: Total number of bonus stay tier points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        bonusNights:
          description: Total number of bonus nights tier points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        baseRevenue:
          description: Total number of base revenue tier points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        baseStay:
          description: Total number of base stay tier points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        baseNights:
          description: Total number of base nights tier points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        totalStays:
          description: Total number of stays tier points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        totalNights:
          description: Total number of nights tier points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
    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.). Currently this attribute is not used for PUT and POST operations.
      minLength: 0
      maxLength: 40
    issueAwardsInfoType:
      type: array
      description: List of awards info.
      maxItems: 100
      items:
        $ref: '#/components/schemas/issueAwardInfoType'
    personNameType_2:
      type: object
      description: This provides name information for a person.
      properties:
        namePrefix:
          description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.
          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.). Currently this attribute is not used for PUT and POST operations.
          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})*'
        name2:
          description: Maternal/paternal name of the guest, required only for the SPAIN country mode.
          type: string
          minLength: 0
          maxLength: 40
        name3:
          description: Maternal/paternal name of the guest, required only for the SPAIN country mode.
          type: string
          minLength: 0
          maxLength: 40
    issuedAward:
      type: object
      description: Response object for issue awards.
      properties:
        issueAwards:
          description: Collection of issue awards information.
          $ref: '#/components/schemas/issueAwardsInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    communicationStatusType:
      type: string
      description: Enum to denote the Status of Readiness messages sent to Guest Devices.
      enum:
      - Pending
      - Completed
      - Failed
      - Sent
      - Received
      - Cancelled
      - PendingAvailability
    resPaymentCardType:
      type: object
      description: Information on a credit card for the customer.
      properties:
        cardId:
          description: credit card id
          $ref: '#/components/schemas/uniqueID_Type_2'
        currentAuthorizedAmount:
          $ref: '#/components/schemas/currencyAmountType'
        approvalAmountNeeded:
          $ref: '#/components/schemas/currencyAmountType'
        approvalCode:
          description: Approval code sent by the credit card company on a successful authorization.
          type: string
          minLength: 0
          maxLength: 20
        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'
        citId:
          description: Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.
          type: string
          minLength: 0
          maxLength: 30
    memberTransactionSummaryAwardPointsType:
      type: object
      description: Items summary associated with award points.
      properties:
        basePoints:
          description: Total number of base award points for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        bonusPoints:
          description: If a membership points transaction involves bonus points, the total number of bonus points.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        miscPoints:
          description: If a membership points transaction involves points imported into ORS from a third-party system, the total number of points.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        totalPoints:
          description: The total number of award points.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
    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'
    membershipAwardBasedOnType:
      type: string
      description: This award allows a guest to apply available membership points towards the balance of his or her bill.
      enum:
      - Rate
      - Product
      - Upgrade
      - Other
      - Ft
      - Discount
    roomOwnershipType:
      type: object
      description: Define the search criteria for retrieving room ownership records
      properties:
        roomOwnershipId:
          description: Unique Id for Room Owner record.
          type: integer
        contractNumber:
          description: Contract number for room owner.
          type: string
        roomId:
          description: Room Id of room owner.
          type: string
        roomCategory:
          description: Room Category of the room ownership record.
          type: string
        roomType:
          description: Room Type of the room ownership record.
          type: string
        startDate:
          description: Start Date of the room ownership record.
          type: string
          format: date
          maxLength: 8
        endDate:
          description: End Date of the room ownership record.
          type: string
          format: date
          maxLength: 8
        profileId:
          description: Profile ID of the room ownership record.
          $ref: '#/components/schemas/uniqueID_Type_2'
        status:
          description: Status of the room ownership record.
          type: string
    uniqueID_Type_2:
      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
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
    telephoneType_2:
      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 resposible 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
        isValidated:
          description: Indicator to define if the Phone number is validated by the Phone Validation System.
          type: boolean
    membershipAwardPointsByHotelType:
      type: array
      description: List of available award points information by Hotel.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/membershipAwardPointByHotelType'
    memberTransactionSummaryGuestStaysType:
      type: object
      description: Items summary associated with guest stays.
      properties:
        stays:
          description: Total number of stays for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        nights:
          description: Total number of nights for the requested membership transaction ID.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
    earningPreferencesType:
      type: object
      description: Indicates guest's rewards earning preferences.
      properties:
        earningPreference:
          description: Indicates the earning preference, Points or Miles.
          type: string
          minLength: 0
          maxLength: 20
        airline:
          description: Indicates preferred airline code and name.
          type: string
          minLength: 0
          maxLength: 20
        frequentFlyerNumber:
          description: Indicates frequent flyer's number of the guest.
          type: string
          minLength: 0
          maxLength: 20
    calculatedPointsType:
      type: object
      description: Summary of Points Accrued for current transaction.
      properties:
        calculatedPoint:
          description: Details of Points Accrued for the current points transaction.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/calculatedPointType'
        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
    membershipAwardsExportType:
      type: array
      description: List of member's information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/membershipAwardExportType'
    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
        preferenceCode:
          type: string
          minLength: 0
          maxLength: 20
        excludedPreferencesCount:
          description: Specifies the count of preferences excluded for the attached reservation preference.
          type: integer
        copyToProfile:
          description: Specifies whether to copy the reservation preference to the profile or not.
          type: boolean
    airlineTransactionsType:
      type: array
      description: Contains details of the membership transaction processing status, provided by the airline.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/airlineTransactionType'
    customizedPrivacyCodesType:
      type: object
      description: Customized privacy codes and values
      properties:
        code:
          description: Configured and active profile correspondence code
          type: string
          minLength: 0
          maxLength: 20
        value:
          type: boolean
          description: Indicates code is enabled/disabled for the profile.
          default: false
    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_2'
            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_2'
            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
    membershipExceptionStatusType:
      type: string
      description: List of possible membership exception type.
      enum:
      - AllExceptions
      - PointsAwardedOnException
      - PointsRejectedOnException
      - ExceptionNotResolved
    basicEmailType:
      type: string
      description: Email address
      minLength: 0
      maxLength: 2000
    membershipClaimDetailsType:
      type: object
      description: Detailed information of a claim.
      properties:
        claimNo:
          description: Unique ID Number assigned to the claim when the claim was created.
          $ref: '#/components/schemas/uniqueID_Type_2'
        claimDate:
          description: Date the claim was made.
          type: string
          format: date
          maxLength: 8
        closeDate:
          description: If the status is closed, the date the claim was closed.
          type: string
          format: date
          maxLength: 8
        source:
          description: Source of the claim. This will be either OCIS, OPMS or WEB.
          $ref: '#/components/schemas/claimSourceType'
        callerName:
          description: Name of the person placing the claim. This name may be different from the name on the membership card.
          type: string
          minLength: 0
          maxLength: 100
        owner:
          description: User who is assigned to handle this claim.
          type: string
          minLength: 0
          maxLength: 50
        claimStatus:
          description: Status of the claim.(Open, Closed, Pending Review, Waiting for Manager, etc.)
          type: string
          minLength: 0
          maxLength: 20
        claimType:
          description: Type of user-definable claim such as New Card, Stay, etc.
          type: string
          minLength: 0
          maxLength: 20
        origin:
          description: Origin of the membership claim. User definable values like Email, Fax, Phone Call, etc.
          type: string
          minLength: 0
          maxLength: 20
        callerInformation:
          description: More information related to call that help to resolve the claim..
          type: string
          minLength: 0
          maxLength: 2000
        replyBy:
          description: The date, if any, by which a response to the caller was promised.
          type: string
          format: date
          maxLength: 8
        comments:
          description: Additional comments or steps taken to resolve the claim..
          type: string
          minLength: 0
          maxLength: 2000
        approvalStatus:
          description: Filter claims by approved or rejected status.
          $ref: '#/components/schemas/claimApprovalStatusType'
        recordType:
          description: Record type of the claim.
          $ref: '#/components/schemas/claimRecordType'
        profileId:
          description: Profile ID of the membership holder.
          $ref: '#/components/schemas/profileId'
        membership:
          description: Membership Type details.
          $ref: '#/components/schemas/claimMembershipType'
        reservation:
          description: Reservation or Stay information for the claim.
          $ref: '#/components/schemas/claimReservationInfoType'
        claimPoints:
          description: Membership claims award points and tier points.
          $ref: '#/components/schemas/claimAdjustmentPointsType'
        activityLog:
          description: Contains summary information of the claim.
          $ref: '#/components/schemas/claimActivityLogListType'
        submitter:
          description: User who entered this claim.
          type: string
          minLength: 0
          maxLength: 50
    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_2:
      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
    roomPreferencesType:
      type: object
      description: Indicates the guest's room preferences.
      properties:
        bedType:
          description: Indicates the bed type preference.
          type: string
          minLength: 0
          maxLength: 20
        smoking:
          description: Indicates the smoking preference.
          type: string
          minLength: 0
          maxLength: 20
        precedence:
          description: Indicates which room preference takes priority, bed type or smoking type.
          type: string
          minLength: 0
          maxLength: 20
        floor:
          description: Indicates the floor type preference.
          type: string
          minLength: 0
          maxLength: 20
        newspapers:
          description: Indicates the newspaper preference.
          type: string
          minLength: 0
          maxLength: 20
        snack:
          description: Indicates the snack preference.
          type: string
          minLength: 0
          maxLength: 20
        beverage:
          description: Indicates the beverage preference.
          type: string
          minLength: 0
          maxLength: 20
        pillow:
          description: Indicates the pillow type preference.
          type: string
          minLength: 0
          maxLength: 20
        roomAmenities:
          description: Indicates the room amenities requested.
          type: string
          minLength: 0
          maxLength: 80
        interests:
          description: Indicates guest preferred interests.
          type: string
          minLength: 0
          maxLength: 2000
        accessible:
          description: Indicates if the member requires accessible rooms.
          type: boolean
    relationshipProfileType:
      type: object
      properties:
        customer:
          description: Detailed information of the customer
          $ref: '#/components/schemas/customerType_2'
        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_2'
        address:
          description: Information on address details for the customer/company
          $ref: '#/components/schemas/addressInfoType_2'
        email:
          description: Information on email address for the customer/company
          $ref: '#/components/schemas/emailInfoType_2'
        uRLs:
          description: Information on web url/address for the customer/company
          $ref: '#/components/schemas/uRLInfoType_2'
        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'
    membershipReservationDetails:
      type: object
      description: Response element for membership reservation activity updated.
      properties:
        calendarDate:
          description: Date for the requested membership reservation details.
          type: string
          format: date
        membershipReservationDetailsList:
          type: array
          description: List of fetched membership reservation details.
          maxItems: 200
          items:
            $ref: '#/components/schemas/membershipReservationDetailUnitType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    membershipClaim:
      type: object
      description: Request object for creating membership claim.
      properties:
        membershipClaimDetails:
          $ref: '#/components/schemas/membershipClaimDetailsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    memberPointToExpireType:
      type: object
      description: Information related to a member point to expire.
      properties:
        pointsExpiryDate:
          description: Current expiry date for the member award points.
          type: string
          format: date
          maxLength: 8
        originalPointsExpiryDate:
          description: Original expiry date for the member award points.
          type: string
          format: date
        pointsToExpire:
          description: Displays the total number of points that will expire on the expiration date.
          type: integer
        previousPointsToExpire:
          description: Displays the number of points that are relevant for extension. Points that were already extended from the previous year are not considered for extension.
          type: integer
        extend:
          description: Indicates if the points is extendable.
          type: boolean
        awardGenerationMethod:
          description: The method of award generation.
          type: string
          minLength: 0
          maxLength: 20
    masterAccountInfoType:
      type: object
      properties:
        masterAccountId:
          description: Unique ID of the Master account.
          $ref: '#/components/schemas/uniqueID_Type_2'
        masterAccountName:
          description: Name of the Master account.
          type: string
          minLength: 0
          maxLength: 40
    profileEnrollmentType_2:
      type: object
      description: Type provides the detailed information about the profile and its children.
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems.
          $ref: '#/components/schemas/profileIdList'
        customer:
          description: Detailed customer information for this profile.
          $ref: '#/components/schemas/customerType_2'
        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_2'
            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_2'
            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_2'
            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_2'
            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_2'
            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
        roomOwnershipsList:
          description: Room Ownership records.
          type: object
          properties:
            roomOwnershipInfo:
              description: Collection of Detailed information on Room Ownership records.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/roomOwnershipType'
            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
        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 resposible 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
        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
        showInactiveRoomOwners:
          description: Flag to show inactive Room Owners.
          type: boolean
        fiscalGuestType:
          description: Fiscal Guest Type is used for Fiscal Folio funcionality
          type: string
          minLength: 0
          maxLength: 20
        previousHotelStays:
          description: List of previous hotel stays of the profile.
          $ref: '#/components/schemas/hotelStaysType'
        roomPreferences:
          description: Room preferences and request of the guest.
          $ref: '#/components/schemas/roomPreferencesType'
        earningPreferences:
          description: Rewards preferences of the guest.
          $ref: '#/components/schemas/earningPreferencesType'
        mailingPreferences:
          description: Mailing preferences of the guest.
          $ref: '#/components/schemas/mailingPreferencesType'
        rewardsInfo:
          description: Guest's rewards information.
          $ref: '#/components/schemas/rewardsInfoType'
        membershipCardRegistrationCode:
          description: Profile's membership card registration code.
          type: string
          minLength: 0
          maxLength: 40
        profileId:
          description: Unique id of the profile.
          $ref: '#/components/schemas/uniqueID_Type_2'
        reservationId:
          description: Unique identifier of the reservation.
          $ref: '#/components/schemas/reservationId'
        enrollmentPaymentDetails:
          description: Payment details to enroll profile to the membership program(e.g. Payment Method, Amount.)
          $ref: '#/components/schemas/enrollmentPaymentDetailsType'
        enrollmentCode:
          description: Membership enrollment code and description.
          $ref: '#/components/schemas/codeDescriptionType'
        employer:
          type: string
          maxLength: 36
          minLength: 0
        externalDatabaseID:
          description: Enrollment details will be fetched from this External database.
          type: string
          minLength: 0
          maxLength: 20
        enrollmentType:
          description: The type of external system that the guest is enrolling in, such as Loyalty, Gaming or Activities.
          $ref: '#/components/schemas/enrollmentTypeType'
        hotelId:
          description: Hotel Code, It is used to filter hotel specific children to this specific hotel code.
          type: string
          minLength: 0
          maxLength: 20
        userId:
          description: UserID/LoginID of the user who is enrolling the Guest.
          type: string
          minLength: 0
          maxLength: 200
        employeeId:
          description: EmployeeID of the user who is enrolling the Guest.
          type: string
          minLength: 0
          maxLength: 20
    numericUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Numeric Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/numericUDFType'
    membershipAwardPointsByHotel:
      type: object
      description: Response object for fetching member award points by Hotel.
      properties:
        membershipAwardPoints:
          description: Collection of member award points list.
          $ref: '#/components/schemas/membershipAwardPointsByHotelType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    memberPointsSummaryType:
      type: object
      description: Member Points Summary.
      properties:
        nextTierPoints:
          description: Points required for the next Level.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
        availablePoints:
          description: Total Points Available.
          $ref: '#/components/schemas/transactionSummaryAttributeType'
    memberTransactionSummaryType:
      type: object
      description: Itemized information related to a membership transactions summary.
      properties:
        awardPoints:
          description: Summary of transactions associated with award points.
          $ref: '#/components/schemas/memberTransactionSummaryAwardPointsType'
        tierPoints:
          description: Summary of transactions associated with tier points.
          $ref: '#/components/schemas/memberTransactionSummaryTierPointsType'
        guestStays:
          description: Summary of transactions associated with guest stays.
          $ref: '#/components/schemas/memberTransactionSummaryGuestStaysType'
    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
    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 resposible 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
    emailType_2:
      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
        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 resposible 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
        isValidated:
          description: Indicator to define if the Email is validated by the Email Validation System.
          type: boolean
    transactionSummaryAttributeType:
      type: object
      description: Attributes of Summary transactions.
      properties:
        customLabel:
          description: Attribute Label
          type: string
          minLength: 0
          maxLength: 100
        value:
          description: Attribute Value
          type: string
          minLength: 0
          maxLength: 80
    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
    claimApprovalStatusType:
      type: string
      description: Claim approve or reject status.
      enum:
      - Approved
      - Rejected
      - Pending
    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: 80
        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
        longAccountName:
          description: Large company name to be used in the Invoice/Credit Bill.
          type: string
          minLength: 0
          maxLength: 512
    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
    productAvailabilityType:
      type: object
      description: Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
      properties:
        awardType:
          description: Unique code that identifies this award.
          type: string
          minLength: 0
          maxLength: 40
        hotelId:
          description: HotelCode where the award will be consumed.
          type: string
          minLength: 0
          maxLength: 20
        totalAvailablePoints:
          description: Total award points available for redemption.
          type: number
        pointsRequired:
          description: The number of points that must be redeemed for this award.
          type: number
        cancelPenaltyPoints:
          description: The award points that will be forfeited if the cancel penalty charge is applied.
          type: number
        cancelPenaltyDays:
          description: Number of days before arrival when a reservation may be cancelled without an award points penalty.
          type: number
        cancelPenaltyCharge:
          description: The cancel penalty charge.
          type: number
        cancelPenaltyType:
          description: The penalty charge is either a percentage or a flat number of points.
          type: string
          minLength: 0
          maxLength: 20
        rawIssueKey:
          description: Issue key in format of Raw data.
          type: string
          minLength: 0
          maxLength: 4000
        awardNumber:
          description: An identifying number of the award, assigned by the system when the award was issued.
          type: number
        packageCode:
          description: Package/Product code for the award .
          type: string
          minLength: 0
          maxLength: 20
        packageDescription:
          description: Description of the product.
          type: string
          minLength: 0
          maxLength: 20
        awardValidFrom:
          description: The valid time period from when the award can be issued.
          type: string
          format: date
          maxLength: 8
        awardValidTo:
          description: The valid time to an issued award.
          type: string
          format: date
          maxLength: 8
    reservationAllowedActionsType:
      type: array
      description: Allowed action.
      maxItems: 11
      items:
        $ref: '#/components/schemas/reservationAllowedActionType'
    membershipPointsCalculationType:
      type: object
      description: Details needed for calculating membership points.
      properties:
        processType:
          description: Points Calculation Process Type.
          $ref: '#/components/schemas/membershipPointsCalculationProcessType'
        membershipType:
          description: Membership type for which point calculation process is to be run.
          type: string
          minLength: 0
          maxLength: 20
        awardCode:
          description: Award Code to be used to generate awards for the membership type. Available for Automatic Generation of Awards (Issue Awards) only.
          type: string
          minLength: 0
          maxLength: 40
        calculateUntilDate:
          description: The last date for which calculate or expire points. Available for Calculate Points and Expire Award Points only.
          type: string
          format: date
          maxLength: 8
    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'
    membershipClaimSummaryListType:
      type: array
      description: Contains summary information of the claim.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/membershipClaimSummaryType'
    membershipTransactionsSummaryType:
      type: object
      description: Details of membership transaction like Details, Summary, point, etc.
      properties:
        membershipDetails:
          description: Member details for the requested membership ID.
          $ref: '#/components/schemas/membershipDetailsType'
        transactionsSummary:
          description: Member transaction Summary for the requested membership ID.
          $ref: '#/components/schemas/memberTransactionSummaryType'
        recentTransactionsSummary:
          description: Member transaction Summary(Range) for the requested membership ID.
          $ref: '#/components/schemas/memberTransactionRecentSummaryType'
        pointsSummary:
          description: Member points summary for the requested membership ID.
          $ref: '#/components/schemas/memberPointsSummaryType'
    membershipAwardAvailabilityType:
      type: object
      description: Details of Member Award Type. Awards will be available for redemption of award points associated with a particular member.
      properties:
        rateInfo:
          description: Information related to Rate based Award.
          $ref: '#/components/schemas/rateAvailabilityType'
        productInfo:
          description: Information related to Product based Award.
          $ref: '#/components/schemas/productAvailabilityType'
        upgradeInfo:
          description: Information related to Upgrade based Award.
          $ref: '#/components/schemas/upgradeAvailabilityType'
        otherInfo:
          description: Information related to Other Award.
          $ref: '#/components/schemas/otherAvailabilityType'
    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
    enrollmentMatchProfiles:
      type: object
      description: Response object to fetch match profiles for enrollment.
      properties:
        enrollmentMatchProfilesDetail:
          description: Type contains detail information regarding match profiles.
          $ref: '#/components/schemas/enrollmentMatchProfilesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    award_2:
      type: object
      description: Request object to redeem award.
      properties:
        memberAward:
          $ref: '#/components/schemas/memberAwardType_2'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    memberCardHistoryList:
      type: object
      description: Response object for member card history.
      properties:
        memberCardHistoryList:
          type: array
          description: Contains list of card history of a member.
          maxItems: 500
          items:
            $ref: '#/components/schemas/membershipCardHistoryType'
        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
        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
    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
    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'
    paragraphType_2:
      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_2'
        url:
          description: A URL for this paragraph.
          type: string
    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
  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-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}$
    x-transactionId:
      name: x-transactionId
      description: Transaction Id
      in: header
      schema:
        type: string
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    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-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    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
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-outbound-crmoutbound.json
- oracle-hospitality-property-v1-crm.json