openapi: 3.2.0
info:
  title: Oracle Hospitality Profile 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 Profile 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: Profile
  description: The Profile APIs allow you to view, create, update, and delete profiles in OPERA Cloud. Each time a new profile in created in OPERA Cloud, a profileID is assigned.  Use this profileID to retrieve and update details relating to that profile.   The resource 'Companies' includes group, source, company and travel agent profile types.   The resource 'Guests' includes individual and contact profile types.
paths:
  /externalSystems/{extSystemCode}/memberships/{membershipType}/membershipIDs:
    post:
      summary: Generate membership number
      description: This API will generate a new membership number. <p><strong>OperationId:</strong>postMembershipNumber</p>
      operationId: postMembershipNumber
      parameters:
      - name: extSystemCode
        in: path
        required: true
        description: Profile will be downloaded from this External System.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: membershipType
        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:
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipNumber'
        description: Request object for generating membership number.
        required: true
    servers:
    - url: /crm/v1
  /address:
    get:
      summary: Get city states
      description: This API will get city and states. <p><strong>OperationId:</strong>getAddress</p>
      operationId: getAddress
      parameters:
      - name: excludeNoCity
        in: query
        required: false
        description: When true indicates that only profiles with city will be fetched.
        schema:
          type: boolean
      - 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: 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: streetAddress
        in: query
        required: false
        description: First Line of Street Address. For profile search it matches the first Address line.
        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 City and State based on search criteria. This object contains address information,Success,Warnings and Errors related to this operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/cityState'
        '204':
          description: Address 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:
      - Profile
    servers:
    - url: /crm/v1
  /certificates:
    delete:
      summary: Delete certificate
      description: This API will allow you to delete a certificate. <p><strong>OperationId:</strong>deleteCertificate</p>
      operationId: deleteCertificate
      deprecated: true
      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: 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:
      - Profile
    servers:
    - url: /crm/v1
  /companies:
    post:
      summary: This API facilitates creation of a company/agent/group/source profile in OPERA.
      description: When a profile doesn't already exist for a guest, use this to create a new profile.  The response will provide the newly created profile's OPERA ID. There are many fields in postProfile defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use postProfile. <p><strong>OperationId:</strong>postCompanyProfile</p>
      operationId: postCompanyProfile
      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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/company'
        description: Request object for creation of company profile. This object contains profile details with unique identifiers of a profile. The standard optional Opera Context element is also included.
        required: true
    servers:
    - url: /crm/v1
  /companies/{corporateID}:
    get:
      summary: Get company profile by corporate ID
      description: Use this to retrieve a specific Company, Travel Agent, Group or Source profile. You must know the corporate ID of the profile for the request API. <p><strong>OperationId:</strong>getCompanyProfile</p>
      operationId: getCompanyProfile
      parameters:
      - name: corporateID
        in: path
        required: true
        description: Unique OPERA Corporate ID used to find company/agent/group/source profile in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: fetchInstructions
        in: query
        description: Room Ownership information associated with the profile.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Address
            - Communication
            - Comment
            - Membership
            - Preference
            - Keyword
            - Correspondence
            - Profile
            - Indicators
            - SalesInfo
            - Relationship
            - Subscriptions
          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 unique company profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/company'
        '204':
          description: CompanyProfile 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:
      - Profile
    servers:
    - url: /crm/v1
  /duplicateExternalSubscriptions:
    get:
      summary: 'Get profiles with duplicate external subscriptions '
      description: Fetch profile subscriptions where the same OPERA Cloud profile is linked to multiple external profiles, within the same external system. <p><strong>OperationId:</strong>getDuplicateExternalSubscriptions</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getDuplicateExternalSubscriptions
      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: databaseId
        in: query
        required: false
        description: Code identifying the external database record which is linked to external systems.
        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
      - $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 subscriptions where the same OPERA profile is linked to multiple external profiles within the same external system.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/duplicateExternalSubscriptions'
        '204':
          description: DuplicateExternalSubscriptions 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:
      - Profile
    servers:
    - url: /crm/v1
  /duplicateOPERASubscriptions:
    get:
      summary: Get profiles with duplicate OPERA Cloud subscriptions
      description: Fetch subscriptions where an external profile within a particular external system is linked to multiple OPERA Cloud profiles. <p><strong>OperationId:</strong>getDuplicateOPERASubscriptions</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getDuplicateOPERASubscriptions
      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: databaseId
        in: query
        required: false
        description: Code identifying the external database record which is linked to external systems.
        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
      - $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 subscriptions where an external profile within a particular external system is linked to multiple OPERA profiles.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/duplicateOPERASubscriptions'
        '204':
          description: DuplicateOPERASubscriptions 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:
      - Profile
    servers:
    - url: /crm/v1
  /ecertificates:
    get:
      summary: Get e-certificate
      description: This API allows you to retrieve eCertificates which exist on a profile in OPERA Cloud. <p><strong>OperationId:</strong>getECertificates</p>
      operationId: getECertificates
      parameters:
      - 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: hotelId
        in: query
        required: false
        description: Property for which preferences are to be fetched.
        schema:
          type: string
      - name: code
        in: query
        required: false
        description: Ecertificates search criteria
        schema:
          type: string
      - name: groupCode
        in: query
        required: false
        description: Ecertificates search criteria
        schema:
          type: string
      - name: status
        in: query
        description: Indicates that OPERA E-Certificate is reserved.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Cancelled
            - Consumed
            - Deleted
            - Expired
            - Issued
            - Reserved
          uniqueItems: true
      - name: includeInactive
        in: query
        required: false
        description: Include or not include inactive E-certificate.
        schema:
          type: boolean
      - name: voucherNo
        in: query
        required: false
        description: System generated unique voucher number.
        schema:
          type: string
      - name: excludeVoucherNumbers
        in: query
        description: List of System generated unique voucher numbers to be excluded.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: availableECertificates
        in: query
        required: false
        description: Search criteria to limit Ecertificates that are available for reservation consumption.
        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 fetch ECertificates. This object contains collection of ECertificates,Success,Warnings and Errors related to this operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/eCertificates'
        '204':
          description: ECertificates 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:
      - Profile
    post:
      summary: Create e-certificate
      description: This API allows you to create a new eCertificates onto a profile in OPERA Cloud. <p><strong>OperationId:</strong>postECertificate</p>
      operationId: postECertificate
      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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/eCertificateGeneration'
        description: Request object to issue E-Certificate.
        required: true
    servers:
    - url: /crm/v1
  /ecertificates/{certificateId}:
    delete:
      summary: Delete e-certificate
      description: This API allows you to delete an eCertificates which exist on a profile in OPERA Cloud. <p><strong>OperationId:</strong>deleteECertificate</p>
      operationId: deleteECertificate
      parameters:
      - name: certificateId
        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: 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:
      - Profile
    put:
      summary: Consume an E-Certificate
      description: Use this API to consume (use) an E-Certificate.  <p><strong>OperationId:</strong>consumeECertificate</p>
      operationId: consumeECertificate
      parameters:
      - name: certificateId
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/eCertificateToConsume'
        description: Request object to Consume an E-Certificate.
        required: true
    servers:
    - url: /crm/v1
  /ecertificates/{certificateId}/action/validate:
    put:
      summary: Verify E-Certificate Number
      description: Use this API to verify an ng E-Certificate Number. <p><strong>OperationId:</strong>verifyECertificate</p>
      operationId: verifyECertificate
      parameters:
      - name: certificateId
        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 to Verify E-Certificate and will return the profile information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/verifiedECertificate'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/eCertificateToVerify'
        description: Request object to Verify an E-Certificate Number.
        required: true
    servers:
    - url: /crm/v1
  /ecertificates/{certificateId}/extensions:
    post:
      summary: Extend E-Certificate Expiry date
      description: Use this API to extend the date of an existing E-Certificate. <p><strong>OperationId:</strong>extendECertificate</p>
      operationId: extendECertificate
      parameters:
      - name: certificateId
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/eCertificateToExtend'
        description: Request object to Consume an E-Certificate.
        required: true
    servers:
    - url: /crm/v1
  /externalSystems/{extSystemCode}/profiles/{profileExternalId}:
    get:
      summary: Get profile by external ID
      description: When a reservation is booked via an external system, you would use this API to retrieve a reservation using the external ID in the request <p><strong>OperationId:</strong>getProfileByExtId</p>
      operationId: getProfileByExtId
      parameters:
      - name: profileExternalId
        in: path
        required: true
        description: External System's ID used to get the profile.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: extSystemCode
        in: path
        required: true
        description: Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: Hotel Code used to filter hotel specific information regarding the profile.
        schema:
          type: string
      - name: logViewProfile
        in: query
        required: false
        description: This element tells when the view profile should be logged.
        schema:
          type: boolean
      - name: showInactiveRoomOwners
        in: query
        required: false
        description: Flag to show inactive Room Owners.
        schema:
          type: boolean
      - name: fetchInstructions
        in: query
        description: Room Ownership information associated with the profile.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Address
            - Communication
            - Comment
            - Membership
            - Preference
            - Keyword
            - Correspondence
            - Profile
            - Indicators
            - SalesInfo
            - Relationship
            - Subscriptions
            - DeliveryMethods
            - GdsNegotiatedRate
            - NegotiatedRate
            - HistoryReservation
            - FutureReservation
            - WebUserAccount
          uniqueItems: true
      - name: instructionParameterType
        in: query
        description: Simple type enumerating the different parameters accepted by a profile Instructions. Parameter names have the name of the instruction expecting it, and the parameter name itself.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - NegotiatedRateShowInactive
            - NegotiatedRateResort
            - NegotiatedRateMaxFetchCount
            - NegotiatedRateCode
            - GdsNegotiatedRateShowInactive
            - PreferencesShowInactive
            - ResortForRoutingInstructions
            - RelationshipPrimaryProfile
            - AddressPrimaryOnly
            - CommunicationPrimaryOnly
            - DeliveryMethodsHotelCode
          uniqueItems: true
      - name: value
        in: query
        description: Value of Profile Instruction Parameter
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: allowedAction
        in: query
        description: Flag indicating whether Profile is Enrolled to Primary Membership Program.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - NameChange
            - TaxIDChange
            - EnrollToPrimaryMembership
          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 profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profile'
        '204':
          description: ProfileByExtId 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:
      - Profile
    put:
      summary: Update by external ID
      description: Use this API to update guests details on profile.  You will need to know the External Profile ID and external system code to use this API. <p><strong>OperationId:</strong>putProfileByExtId</p>
      operationId: putProfileByExtId
      parameters:
      - name: profileExternalId
        in: path
        required: true
        description: External System's ID used to get the profile.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: extSystemCode
        in: path
        required: true
        description: Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system.
        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 change/modification of profile details. This object contains the profile details with unique identifiers for each profile. Also Success,Warnings and Errors related to this operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profile'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profile'
              - example:
                  profileIdList:
                  - type: Profile
                    idContext: OPERA
                    id: '3149001'
                  profileDetails:
                    customer:
                      personName:
                      - givenName: William
                        middleName: D
                        surname: Smith
                        nameSuffix: '10'
                        nameTitle: Mr.....
                        envelopeGreeting: Hello Mr. Smith
                        salutation: Mr. Smith
                        nameType: PRIMARY
                        language: E
                      citizenCountry:
                        value: United States of America
                        code: USA
                      identifications:
                        identificationInfo:
                        - identification:
                            idType: PASSPORT
                            idNumber: C03005988
                            idNumberMasked: C030059XX
                            issuedCountry: USA
                            issuedDate: '2009-11-30'
                            issuedPlace: New York
                            expirationDate: '2019-11-29'
                            registeredProperty: HOTEL1
                            primaryInd: true
                      language: E
                      nationality: US
                      nationalityDescription: USA
                      vipStatus: '006'
                      vipDescription: 'VVIP: VV important person'
                      privateProfile: false
                    company:
                      companyName: Oracle America Inc
                      companyName2: Oracle Group Companies
                      businessTitle: Developer
                      currencyCode: USD
                      currencySymbol: $
                      decimalPlaces: -100000000
                      language: E
                      nationality: USA
                      nationalityDescription: United States
                      commissionCode: ''
                      creditRating: ''
                      corporateIdType: ''
                      vipStatus: '006'
                      vipDescription: Important
                      blacklist: false
                    addresses:
                      addressInfo:
                      - address:
                          addressLine:
                          - 500 Oracle Parkway
                          cityName: Redwood Shores
                          postalCode: '94065'
                          cityExtension: a
                          state: CA
                          country:
                            value: USA
                            code: US
                          language: E
                          type: Office
                          typeDescription: This is office address.
                          primaryInd: false
                          barCode: ''
                          createDateTime: '2019-09-18T21:09:36.498Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-18T21:09:36.498Z'
                          lastModifierId: '12883'
                    territory: North America
                    telephones:
                      telephoneInfo:
                      - telephone:
                          phoneTechType: PHONE
                          phoneUseTypeDescription: office
                          phoneNumber: +1 415 555 0100
                          extension: x25
                          primaryInd: false
                          orderSequence: -100000000
                          createDateTime: '2019-09-18T21:09:36.499Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-18T21:09:36.499Z'
                          lastModifierId: '12883'
                    emails:
                      emailInfo:
                      - email:
                          emailAddress: eg@example.com
                          type: EMAIL
                          typeDescription: Email Address
                          emailFormat: EMAIL
                          primaryInd: false
                          orderSequence: -100000000
                          createDateTime: '2019-09-17T18:18:32.415Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-17T18:18:32.416Z'
                          lastModifierId: '12883'
                    comments:
                      commentInfo:
                      - comment:
                          text:
                            value: Please add comments here.
                            language: E
                          commentTitle: Discount
                          type: GEN
                          typeDescription: Comments for discount.
                          internal: false
                          confidential: false
                          overrideInternal: false
                    profileAccessType:
                      croCode: HOTEL1
                      sharedLevel: CRO
                    profileRestrictions:
                      restricted: false
                    statusCode: ACTIVE
                    registeredProperty: HOTEL1
                    createDateTime: '2019-09-17 08:10:28.0'
                    creatorId: '12883'
                    lastModifyDateTime: '2019-09-17 08:23:05.0'
                    lastModifierId: '12883'
                    markForHistory: false
                  links:
                  - href: http://hotelCompany.example.com/operarest/opera/crm/v2/guests
                    rel: guestProfile
                    templated: false
                    method: POST
                    operationId: postGuestProfile
        description: Request object for change/modification of profile details. This object contains modified profile details with unique identifiers for each profile. The standard optional Opera Context element is also included.
        required: true
    servers:
    - url: /crm/v1
  /guests:
    post:
      summary: Create a guest, contact or employee profile in OPERA
      description: When a profile doesn't already exist for a guest, use this to create a new profile.  The response will provide the newly created profile's OPERA ID. There are many fields in postProfile defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use postProfile. <p><strong>OperationId:</strong>postGuestProfile</p>
      operationId: postGuestProfile
      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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/guest'
        description: Request object for creation of guest profile. This object contains profile details with unique identifiers of a profile. The standard optional Opera Context element is also included.
        required: true
    servers:
    - url: /crm/v1
  /guests/{guestId}:
    get:
      summary: Get guest profile by guest ID
      description: Use this API to retrieve all data stored for a guest Profile, such as their address, phone number, preferences. You must already know the guests Profile ID. If you don't know the profile ID, first use the API getGuests to find the profile ID. <p><strong>OperationId:</strong>getGuestProfile</p>
      operationId: getGuestProfile
      parameters:
      - name: guestId
        in: path
        required: true
        description: Unique OPERA internal ID used to find guest/contact/employee profile in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: Hotel Code used to filter hotel specific information regarding the profile.
        schema:
          type: string
      - name: fetchInstructions
        in: query
        description: Room Ownership information associated with the profile.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Address
            - Communication
            - Comment
            - Membership
            - Preference
            - Keyword
            - Correspondence
            - Profile
            - Indicators
            - SalesInfo
            - Relationship
            - WebUserAccount
          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 unique guest profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/guest'
        '204':
          description: GuestProfile 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:
      - Profile
    servers:
    - url: /crm/v1
  /hotels/{hotelId}/profiles/{profileId}/commissionAccount:
    put:
      summary: Copy profile commission account
      description: You can use this API to copy the commission account on a profile <p><strong>OperationId:</strong>copyProfileCommissionAccount</p>
      operationId: copyProfileCommissionAccount
      parameters:
      - name: profileId
        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})*'
            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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileCommissionAccountCopy'
        description: Request object for copying transaction groups configuration.
        required: true
    servers:
    - url: /crm/v1
  /hotels/{hotelId}/profiles/{profileId}/flexFieldCode/{flexFieldCode}:
    delete:
      summary: Operation to delete a flex field.
      description: Operation to delete a flex field Value. <p><strong>OperationId:</strong>deleteFlexFieldValue</p>
      operationId: deleteProfileFlexFieldValue
      parameters:
      - name: flexFieldCode
        in: path
        required: true
        description: Flex field code
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel in OPERA
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA.
        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: 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:
      - Profile
    servers:
    - url: /crm/v1
  /hotels/{hotelId}/profiles/{profileId}/flexFieldValues:
    get:
      summary: Operation to fetch flex field values.
      description: API to fetch flex field values. <p><strong>OperationId:</strong>getFlexFieldValue</p>
      operationId: getProfileFlexFieldValue
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel in OPERA
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: flexFieldId
        in: query
        description: Flex field ID
        required: false
        schema:
          type: number
      - name: flexFieldCode
        in: query
        description: Flex field code
        required: false
        schema:
          type: string
      - name: flexFieldValue
        in: query
        description: Flex field Value
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return. Default is 50
        schema:
          type: integer
          default: 50
          maximum: 100
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 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 flex field Values.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/flexFieldsResponse'
        '204':
          description: Flex field details 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:
      - Profile
    post:
      summary: Operation to create a flex field with value for a module.
      description: Operation to create a flex field Value. <p><strong>OperationId:</strong>postFlexFieldValue</p>
      operationId: postProfileFlexFieldValue
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel in OPERA
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA.
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/flexFieldValues'
        description: Request object to create a new flex field
        required: true
    put:
      summary: Operation to update flex field value.
      description: Operation to update flex field value. <p><strong>OperationId:</strong>putFlexFieldValue</p>
      operationId: putProfileFlexFieldValue
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel in OPERA
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA.
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/flexFieldValues'
        description: Request object for updating the configuration of flex fields.
        required: true
    servers:
    - url: /crm/v1
  /hotels/{hotelId}/profiles/{profileId}/reprocess:
    put:
      summary: Re-Process a single Stage Record
      description: Use this API to Re-Process a single Stage Record.<br><p><strong>OperationId:</strong>reProcessStageRecord</p>
      operationId: reProcessStageRecord
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Resort for the stage record to reprocess or rematch
        schema:
          type: string
      - name: profileId
        in: path
        required: true
        description: Resort Name Id for the stage record to reprocess or rematch
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response object for the the reprocessed staged profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reProcessStageRecord'
        '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:
      - Profile
    servers:
    - url: /crm/v1
  /membershipTierProjections:
    get:
      summary: Get Membership Tier Projection
      description: Retrieve a list of membership Tier Projection such as upgrades and downgrades. <p><strong>OperationId:</strong>getMembershipTierProjections</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getMembershipTierProjections
      parameters:
      - name: membershipId
        in: query
        required: false
        description: Membership Card Number.
        schema:
          type: string
      - name: membershipType
        in: query
        required: false
        description: Type of the Membership.
        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: type
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: projectionDate
        in: query
        required: false
        description: Date for which Tier projections is fetched.
        schema:
          type: string
          format: date
      - name: projectionType
        in: query
        required: false
        description: Upgrade And Downgrade
        schema:
          type: string
          enum:
          - Upgrade
          - Downgrade
          - UpgradeAndDowngrade
          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 Tier Process Text.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/membershipTierProjections'
        '204':
          description: MembershipTierProjections 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:
      - Profile
    servers:
    - url: /crm/v1
  /memberships/{membershipId}/fullfillmentExportLogs:
    get:
      summary: Get Fulfillment Export Logs
      description: Use this API to Get Fulfillment Export Logs. <p><strong>OperationId:</strong>getFulfillmentExportLogs</p>
      operationId: getFulfillmentExportLogs
      deprecated: true
      parameters:
      - name: membershipId
        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: idType
        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: 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
      - $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 which has list of membership fulfillment export logs and membership extract information(Exclude Extract -Y/N).
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/fulfillmentExportedLogs'
        '204':
          description: FulfillmentExportLogs 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:
      - Profile
    servers:
    - url: /crm/v1
  /memberships/{membershipType}/membershipNumbers:
    post:
      summary: Generate membership number
      description: This API will generate a new membership number. <p><strong>OperationId:</strong>postMembershipNumber</p>
      operationId: postMembershipNumber
      parameters:
      - name: membershipType
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membershipNumber'
        description: Request object for generating membership number.
        required: true
    servers:
    - url: /crm/v1
  /processStagedProfile:
    put:
      summary: Process a staged profile
      description: Use this API to process one profile that has been staged. <p><strong>OperationId:</strong>processStagedProfile</p>
      operationId: processStagedProfile
      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 object for the staged profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/processedStagedProfile'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/stagedProfileCriteria'
        description: Request object for processing the staged profile.
        required: true
    servers:
    - url: /crm/v1
  /profileMatch:
    get:
      summary: Fetch the profile Id if a unique guest profile Exists
      description: Use this operation to fetch guest profile (profile Id). This operation can be integrated with createReservation API, to prevent creation of duplicate profiles.<p><strong>OperationId:</strong>getProfileMatch</p>
      operationId: getProfileMatch
      deprecated: true
      parameters:
      - name: lastName
        in: query
        required: true
        description: Last Name for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: firstName
        in: query
        required: false
        description: First Name for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: membershipType
        in: query
        required: false
        description: Membership Type for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: membershipCardNumber
        in: query
        required: false
        description: Membership Card Number for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 50
          minLength: 1
      - name: identificationType
        in: query
        required: false
        description: Identification Type for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: identificationNumber
        in: query
        required: false
        description: Identification Number for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 80
          minLength: 1
      - name: email
        in: query
        required: false
        description: Email for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: subscriptionType
        in: query
        required: false
        description: Subscription Type for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: subscriptionId
        in: query
        required: false
        description: Subscription Id for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 80
          minLength: 1
      - name: clientId
        in: query
        required: false
        description: Client Id for the profile that needs to be matched.
        schema:
          type: string
          maxLength: 80
          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 profile match.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileMatch'
        '204':
          description: No unique match found for the search criteria.
        '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:
      - Profile
    servers:
    - url: /crm/v1
  /profileMatch/searches:
    post:
      summary: Fetch the profile Id if a unique guest profile Exists
      description: Use this operation to fetch guest profile (profile Id). This operation can be integrated with createReservation API, to prevent creation of duplicate profiles.<p><strong>OperationId:</strong>searchProfileMatch</p>
      operationId: searchProfileMatch
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching profile match.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileMatch'
        '204':
          description: No unique match found for the search criteria.
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchProfileMatchRequest'
        description: Search profile match request
    servers:
    - url: /crm/v1
  /profileTransactions/{profileId}:
    get:
      summary: 'Get Profile Transactions '
      description: Retrieve the Transactions associated to a profile related to Stay Records or Membership Adjustments.<p><strong>OperationId:</strong>getProfileTransactions</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getProfileTransactions
      parameters:
      - name: profileId
        in: path
        description: Profile Id for which we want to fetch transactions
        required: true
        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: transactionDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: hotelId
        in: query
        required: false
        description: Stay Record or Membership transaction belongs to which Hotel.
        schema:
          type: string
      - name: confirmationNumber
        in: query
        required: false
        description: Confirmation Number of the stay Record or Membership Transaction.
        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
          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
      - name: reference
        in: query
        required: false
        description: User-defined reference field for the Membership Transaction Adjustment.
        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 of the WS operation FetchProfileTransactions.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileTransactions'
        '204':
          description: ProfileTransactions 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles:
    get:
      summary: Search for profile(s)
      description: Use this API when you want to search for a profile. The response will include a list of profiles that exist in OPERA, based on your search criteria.  For example, you want to see if  a profile for Mr David Smith exists - you can search by various criteria, such as first, last name, email.  The response will include a list of any profiles that exist for Mr Davis Smith.  If a profile matches the criteria, and you want to get more details of that profile, proceed to use getProfile with the profileID in the request. In the response TotalResults=1000 means, it returns maximum 1000 matching records even matching records can be equal to or greater than 1000. To get more accurate results, provide more search criteria. <p><strong>OperationId:</strong>getProfiles</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getProfiles
      deprecated: true
      parameters:
      - name: excludeInactive
        in: query
        required: false
        description: Indicates whether to exclude Inactive Profiles, when true indicates that only profiles with active status will be displayed.
        schema:
          type: boolean
      - name: hotelId
        in: query
        required: false
        description: Hotel Code, It is used to filter hotel specific children to this specific hotel code.
        schema:
          type: string
      - name: includeHasHierarchyOnly
        in: query
        required: false
        description: Include profiles that have one or more relationships in the search.
        schema:
          type: boolean
      - name: includePrimaryOwnersOnly
        in: query
        required: false
        description: Include primary owners in the search.
        schema:
          type: boolean
      - name: includePurgeProfiles
        in: query
        required: false
        description: Include purged profiles in the search.
        schema:
          type: boolean
      - 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: searchType
        in: query
        required: false
        description: When search type is PatronTrackingSystemMemberProfiles, the FetchProfiles will return the Membership Number of the searched Membership Type regardless of primary flag or sequence of the profile memberships.
        schema:
          type: string
          enum:
          - PurgeableProfiles
          - Any
          - PatronTrackingSystemMemberProfiles
          uniqueItems: true
      - name: summaryInfo
        in: query
        required: false
        description: When true response will return summary information otherwise detailed information.
        schema:
          type: boolean
      - name: searchString
        in: query
        required: false
        description: Search string to be used for super search.
        schema:
          type: string
      - name: includeAnonymized
        in: query
        required: false
        description: Indicates whether to include Anonymized Profiles.
        schema:
          type: boolean
      - name: profileType
        in: query
        description: The types of Profile handled by the web service.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Guest
            - Agent
            - Company
            - Group
            - Source
            - Employee
            - Hotel
            - Vendor
            - Contact
            - Purge
            - BusinessHeader
            - BillingAccount
            - Activity
            - Potential
            - Account
          uniqueItems: true
      - name: profileIds
        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: externalReferenceIds
        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: externalSystemCodes
        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: corporateIds
        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: profileName
        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: incognitoName
        in: query
        required: false
        description: Family name, last name or Company Name.
        schema:
          type: string
      - name: incognitoGivenName
        in: query
        required: false
        description: Given name, first name or names.
        schema:
          type: string
      - name: city
        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: 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: streetAddress
        in: query
        required: false
        description: First Line of Street Address. For profile search it matches the first Address line.
        schema:
          type: string
      - name: keyword
        in: query
        required: false
        description: Keyword associated to the profile.
        schema:
          type: string
      - name: communication
        in: query
        required: false
        description: Any communication method associated to the profile such as phone, fax, email address.
        schema:
          type: string
      - name: membership
        in: query
        required: false
        description: Membership number associated to the profile.
        schema:
          type: string
      - name: membershipType
        in: query
        required: false
        description: Member Type of searching profile.
        schema:
          type: string
      - name: ownerCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: membershipLevel
        in: query
        required: false
        description: Membership level associated to the profile.
        schema:
          type: string
      - name: aRNumber
        in: query
        required: false
        description: Account Receivable associated to the profile.
        schema:
          type: string
      - name: taxID
        in: query
        required: false
        description: Tax ID associated to the profile
        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: accountsReceivables
        in: query
        required: false
        description: When true indicates that only profiles with AR account fetched.
        schema:
          type: boolean
      - name: corporateProfiles
        in: query
        required: false
        description: When true indicates that only profiles with client id are searched for.
        schema:
          type: boolean
      - name: excludeIncompleteProfiles
        in: query
        required: false
        description: When true indicates that only profiles with an Address Line 1 and Country or at least one Communications Type will be displayed.
        schema:
          type: boolean
      - name: negotiatedRates
        in: query
        required: false
        description: When true indicates that this option has to be included in advanced search.
        schema:
          type: boolean
      - name: relatedProfileExcludeInactive
        in: query
        required: false
        description: Indicates whether to exclude Inactive Profiles, when true indicates that only profiles with active status will be displayed.
        schema:
          type: boolean
      - name: realtedProfileIncludeHasHierarchyOnly
        in: query
        required: false
        description: Include profiles that have one or more relationships in the search.
        schema:
          type: boolean
      - name: relatedProfileNegotiatedRates
        in: query
        required: false
        description: When true indicates that this option has to be included in advanced search.
        schema:
          type: boolean
      - name: relatedProfileType
        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: relatedProfileName
        in: query
        required: false
        description: Family name, last name or Company Name.
        schema:
          type: string
      - name: protectedProfiles
        in: query
        required: false
        description: Indicates whether to exclude Protected Profiles.
        schema:
          type: boolean
      - name: excludedProfilesId
        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: idExtension
        in: query
        description: Additional identifying value assigned by the creating system. This query parameter is deprecated.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: excludedProfilesIdContext
        in: query
        description: Used to identify the source of the identifier (e.g., IATA, ABTA). This query parameter is deprecated.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: excludedProfilesIdType
        in: query
        description: A reference to the type of object defined by the UniqueID element. This query parameter is deprecated.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: identificationNo
        in: query
        required: false
        description: Any identification number associated with the profile such as Passport Number, StateID.
        schema:
          type: string
      - name: fetchInstructions
        in: query
        description: Room Ownership information associated with the profile.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Address
            - Communication
            - NegotiatedRate
            - GdsNegotiatedRate
            - Comment
            - Membership
            - Preference
            - Keyword
            - HistoryReservation
            - FutureReservation
            - Relationship
            - Correspondence
            - Routing
            - Indicators
            - Profile
            - WebUserAccount
            - SalesInfo
            - ECertificate
            - Subscriptions
            - PrimaryAccountInfo
            - DeliveryMethods
            - RoomOwnership
          uniqueItems: true
      - name: allowedAction
        in: query
        description: Flag indicating whether Profile is Enrolled to Primary Membership Program.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - NameChange
            - TaxIDChange
            - EnrollToPrimaryMembership
          uniqueItems: true
      - name: vipCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: prioritieCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: birthDate
        in: query
        required: false
        description: Date of birth
        schema:
          type: string
          format: date
      - name: phone
        in: query
        required: false
        description: The phone number associated to the profile.
        schema:
          type: string
      - name: email
        in: query
        required: false
        description: The email address associated to the profile.
        schema:
          type: string
      - name: lastStayBefore
        in: query
        required: false
        description: Date to filter profiles with stays before.
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching profiles. This object contains profile primary details,profile summary details,master info list containing code and description used as lookup for description.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileSummaries'
        '204':
          description: Profiles 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:
      - Profile
    post:
      summary: Create a profile
      description: When a profile doesn't already exist for a guest, use this to create a new profile. The response will provide the newly created profile's OPERA ID. There are many fields in postProfile defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use postProfile. <p><strong>OperationId:</strong>postProfile</p>
      operationId: postProfile
      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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profile'
              - example:
                  profileIdList:
                  - type: Profile
                    idContext: OPERA
                    id: '3149001'
                  profileDetails:
                    customer:
                      personName:
                      - givenName: William
                        middleName: D
                        surname: Smith
                        nameSuffix: '10'
                        nameTitle: Mr.....
                        envelopeGreeting: Hello Mr. Smith
                        salutation: Mr. Smith
                        nameType: PRIMARY
                        language: E
                      citizenCountry:
                        value: United States of America
                        code: USA
                      identifications:
                        identificationInfo:
                        - identification:
                            idType: PASSPORT
                            idNumber: C03005988
                            idNumberMasked: C030059XX
                            issuedCountry: USA
                            issuedDate: '2009-11-30'
                            issuedPlace: New York
                            expirationDate: '2019-11-29'
                            registeredProperty: HOTEL1
                            primaryInd: true
                      language: E
                      nationality: US
                      nationalityDescription: USA
                      vipStatus: '006'
                      vipDescription: 'VVIP: Important person (Corporate office only)'
                      privateProfile: false
                    company:
                      companyName: Oracle America Inc
                      companyName2: Oracle Group Companies
                      businessTitle: Developer
                      currencyCode: USD
                      currencySymbol: $
                      decimalPlaces: -100000000
                      language: E
                      nationality: USA
                      nationalityDescription: United States
                      commissionCode: ''
                      creditRating: ''
                      corporateIdType: ''
                      vipStatus: '006'
                      vipDescription: Important
                      blacklist: false
                    addresses:
                      addressInfo:
                      - address:
                          addressLine:
                          - 500 Oracle Parkway
                          cityName: Redwood Shores
                          postalCode: '94065'
                          cityExtension: a
                          state: CA
                          country:
                            value: USA
                            code: US
                          language: E
                          type: Office
                          typeDescription: Office address use
                          primaryInd: false
                          barCode: ''
                          createDateTime: '2019-09-18T21:09:36.498Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-18T21:09:36.498Z'
                          lastModifierId: '12000'
                    territory: North America
                    telephones:
                      telephoneInfo:
                      - telephone:
                          phoneTechType: PHONE
                          phoneUseTypeDescription: office
                          phoneNumber: +1 415 555 0100
                          extension: x25
                          primaryInd: false
                          orderSequence: -100000000
                          createDateTime: '2019-09-18T21:09:36.499Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-18T21:09:36.499Z'
                          lastModifierId: '12883'
                    emails:
                      emailInfo:
                      - email:
                          emailAddress: eg@example.com
                          type: EMAIL
                          typeDescription: Email Address
                          emailFormat: EMAIL
                          primaryInd: false
                          orderSequence: -100000000
                          createDateTime: '2019-09-17T18:18:32.415Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-17T18:18:32.416Z'
                          lastModifierId: '12883'
                    comments:
                      commentInfo:
                      - comment:
                          text:
                            value: Please provide discount.
                            language: E
                          commentTitle: Discount
                          type: GEN
                          typeDescription: Comments for discount.
                          internal: false
                          confidential: false
                          overrideInternal: false
                    profileAccessType:
                      croCode: HOTEL1
                      sharedLevel: CRO
                    profileRestrictions:
                      restricted: false
                    statusCode: ACTIVE
                    registeredProperty: HOTEL1
                    createDateTime: '2019-09-17 08:10:28.0'
                    creatorId: '12883'
                    lastModifyDateTime: '2019-09-17 08:23:05.0'
                    lastModifierId: '12883'
                    markForHistory: false
                  links:
                  - href: http://hotelCompany.example.com/operarest/opera/crm/v2/guests
                    rel: guestProfile
                    templated: false
                    method: POST
                    operationId: postGuestProfile
        description: Request object for creation of profiles. This object contains profile details with unique identifiers for each profile. The standard optional Opera Context element is also included.
        required: true
    servers:
    - url: /crm/v1
  /profiles/action/validate:
    get:
      summary: Validate and check profiles
      description: This API validates/checks allowed actions, the existence of attached records and/or indicators of a profile. <p><strong>OperationId:</strong>checkProfileType</p>
      operationId: checkProfileType
      parameters:
      - 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: checkProfileInstruction
        in: query
        required: false
        description: Simple type that corresponds to check profile instructions.
        schema:
          type: string
          enum:
          - HasWebAccounts
          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 for checking allowed actions, existence of attached records, or indicators of a profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/checkedProfiles'
        '204':
          description: checkProfileType 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/activityLog:
    get:
      summary: Fetch profile activity log
      description: Use this API to fetch the activity log for a specific profile.  This will allow you to see the changes that have occurred on this profile. <p><strong>OperationId:</strong>getProfileActivityLog</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getProfileActivityLog
      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: activityParamsHotelId
        in: query
        required: false
        description: Hotel code.
        schema:
          type: string
      - name: module
        in: query
        required: false
        description: Activity module.
        schema:
          type: string
          enum:
          - Reservation
          - Contract
          - Allotment
          - Outlookview
          - Profile
          - Accountreceivables
          - GdsConvRateCodes
          - RateCode
          - Billing
          - Activity
          uniqueItems: true
      - name: parameterName
        in: query
        description: Name of the parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: parameterValue
        in: query
        description: Value of the parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: activityGroup
        in: query
        required: false
        schema:
          type: string
      - name: activityType
        in: query
        required: false
        schema:
          type: string
      - name: fromDate
        in: query
        required: false
        description: Search from date for the user activity log.
        schema:
          type: string
          format: date
      - name: toDate
        in: query
        required: false
        description: Search to date for the user activity log.
        schema:
          type: string
          format: date
      - name: searchText
        in: query
        required: false
        description: Search text for the user activity log.
        schema:
          type: string
      - name: userByIDs
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            maxItems: 4000
      - name: userForIDs
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching profile activity log. This object contains collection of user activity log for the profile,Success,Warnings and Errors related to this operation
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileActivityLog'
        '204':
          description: ProfileActivityLog 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/profileMatches:
    get:
      summary: Get potential profile matches
      description: This API will provide a list of potential profiles matching the given criteria. <p><strong>OperationId:</strong>getProfileMatches</p>
      operationId: getProfileMatches
      deprecated: true
      parameters:
      - name: lastName
        in: query
        required: false
        description: Last name of the user
        schema:
          type: string
      - name: firstName
        in: query
        required: false
        description: First name of the user
        schema:
          type: string
      - name: AddressLine1
        in: query
        required: false
        description: First Line of Street Address. For profile search it matches the first Address line.
        schema:
          type: string
      - name: AddressLine2
        in: query
        required: false
        description: Second Line of Street Address. For profile search it matches the first Address line.
        schema:
          type: string
      - name: city
        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: state
        in: query
        required: false
        description: State or Province name (e.g., Texas).
        schema:
          type: string
      - name: postalCode
        in: query
        required: false
        description: Post Office Code number.
        schema:
          type: string
      - name: country
        in: query
        required: false
        description: Country Address
        schema:
          type: string
      - name: email
        in: query
        required: false
        description: Email linked to the user.
        schema:
          type: string
      - name: phone
        in: query
        required: false
        description: Telephone linked to the user.
        schema:
          type: string
      - name: matchPercentage
        in: query
        required: false
        description: match percentage criteria will exceed.
        schema:
          type: number
      - name: legalCompany
        in: query
        required: false
        description: Name Of the company the individual is associated with.
        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 with the details of the profiles match.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileMatchType'
        '204':
          description: No profile Match 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/profileMatches/searches:
    post:
      summary: Get potential profile matches
      description: This API will provide a list of potential profiles matching the given criteria. <p><strong>OperationId:</strong>searchProfileMatches</p>
      operationId: searchProfileMatches
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object with the details of the profiles match.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileMatchType'
        '204':
          description: No profile Match 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchProfileMatchesRequest'
        description: Search profile matches request
    servers:
    - url: /crm/v1
  /profiles/searches:
    post:
      summary: Search for profile(s)
      description: Use this API when you want to search for a profile. The response will include a list of profiles that exist in OPERA, based on your search criteria.  For example, you want to see if  a profile for Mr David Smith exists - you can search by various criteria, such as first, last name, email.  The response will include a list of any profiles that exist for Mr Davis Smith.  If a profile matches the criteria, and you want to get more details of that profile, proceed to use getProfile with the profileID in the request. In the response TotalResults=1000 means, it returns maximum 1000 matching records even matching records can be equal to or greater than 1000. To get more accurate results, provide more search criteria. <p><strong>OperationId:</strong>searchProfiles</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: searchProfiles
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching profiles. This object contains profile primary details,profile summary details,master info list containing code and description used as lookup for description.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileSummaries'
        '204':
          description: Profiles 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchProfilesRequest'
        description: Search profiles request
    servers:
    - url: /crm/v1
  /profiles/stageProfileMatches:
    get:
      summary: Get potential stage profile matches
      description: This API provides a list of potential profiles matching the given stage profile. <p><strong>OperationId:</strong>getStagedProfileMatches</p>
      operationId: getStagedProfileMatches
      parameters:
      - name: hotelId
        in: query
        required: false
        description: The resort to which the profile belongs
        schema:
          type: string
      - name: resortNameId
        in: query
        required: false
        description: Profile's external ID
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      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 with the details of the profiles match.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/stageProfileMatchesType'
        '204':
          description: No profile Match 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}:
    get:
      summary: Get profile by ID
      description: You would use this to retrieve any type of profile, whether it is a company, travel agent, individual, source or group <p><strong>OperationId:</strong>getProfile</p>
      operationId: getProfile
      parameters:
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: Hotel Code used to filter hotel specific information regarding the profile.
        schema:
          type: string
      - name: logViewProfile
        in: query
        required: false
        description: This element tells when the view profile should be logged.
        schema:
          type: boolean
      - name: systemCode
        in: query
        required: false
        description: This element will be used to store external database.
        schema:
          type: string
      - name: showInactiveRoomOwners
        in: query
        required: false
        description: Flag to show inactive Room Owners.
        schema:
          type: boolean
      - name: markAsRecentlyAccessed
        in: query
        required: false
        description: Providing this flag marks the profile as recently accessed.
        schema:
          type: boolean
      - name: fetchInstructions
        in: query
        description: Room Ownership information associated with the profile.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Address
            - Communication
            - Comment
            - Membership
            - Preference
            - Keyword
            - Correspondence
            - Profile
            - Indicators
            - SalesInfo
            - Relationship
            - Subscriptions
            - DeliveryMethods
            - GdsNegotiatedRate
            - NegotiatedRate
            - HistoryReservation
            - FutureReservation
            - WebUserAccount
            - ProfileAccount
          uniqueItems: true
      - name: instructionParameterType
        in: query
        description: Simple type enumerating the different parameters accepted by a profile Instructions. Parameter names have the name of the instruction expecting it, and the parameter name itself.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - NegotiatedRateShowInactive
            - NegotiatedRateResort
            - NegotiatedRateMaxFetchCount
            - NegotiatedRateCode
            - GdsNegotiatedRateShowInactive
            - PreferencesShowInactive
            - ResortForRoutingInstructions
            - RelationshipPrimaryProfile
            - AddressPrimaryOnly
            - CommunicationPrimaryOnly
            - DeliveryMethodsHotelCode
          uniqueItems: true
      - name: value
        in: query
        description: Value of Profile Instruction Parameter
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: allowedAction
        in: query
        description: Flag indicating whether Profile is Enrolled to Primary Membership Program.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - NameChange
            - TaxIDChange
            - EnrollToPrimaryMembership
          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 profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profile'
        '204':
          description: Profile 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:
      - Profile
    put:
      summary: Update a profile by ID
      description: Use this to update a guests details on their profile.  You will need to know the OPERA Profile ID to use this API, and you will also need to know the List of Values for profile fields, such as AddressType, PhoneType, Title.  <p><strong>OperationId:</strong>putProfile</p>
      operationId: putProfile
      parameters:
      - name: profileId
        in: path
        required: true
        description: OPERA internal profile ID which is used to uniquely identify the profile in OPERA. This ID is a primary identification of a profile in OPERA.
        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 change/modification of profile details. This object contains the profile details with unique identifiers for each profile. Also Success,Warnings and Errors related to this operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profile'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profile'
              - example:
                  profileIdList:
                  - type: Profile
                    idContext: OPERA
                    id: '3149001'
                  profileDetails:
                    customer:
                      personName:
                      - givenName: William
                        middleName: D
                        surname: Smith
                        nameSuffix: '10'
                        nameTitle: Mr.....
                        envelopeGreeting: Hello Mr. Smith
                        salutation: Mr. Smith
                        nameType: PRIMARY
                        language: E
                      citizenCountry:
                        value: United States of America
                        code: USA
                      identifications:
                        identificationInfo:
                        - identification:
                            idType: PASSPORT
                            idNumber: C03005988
                            idNumberMasked: C030059XX
                            issuedCountry: USA
                            issuedDate: '2009-11-30'
                            issuedPlace: New York
                            expirationDate: '2019-11-29'
                            registeredProperty: HOTEL1
                            primaryInd: true
                      language: E
                      nationality: US
                      nationalityDescription: USA
                      vipStatus: '006'
                      vipDescription: 'VVIP: VV important person'
                      privateProfile: false
                    company:
                      companyName: Oracle America Inc
                      companyName2: Oracle Group Companies
                      businessTitle: Developer
                      currencyCode: USD
                      currencySymbol: $
                      decimalPlaces: -100000000
                      language: E
                      nationality: USA
                      nationalityDescription: United States
                      commissionCode: ''
                      creditRating: ''
                      corporateIdType: ''
                      vipStatus: '006'
                      vipDescription: Important
                      blacklist: false
                      longaccountname: Nieskoczono Spka. Rozwj Neurologiczny dla Interfejsu Mzg-Komputer Spka z ograniczon odpowiedzialnoci. Romanowski, Kiljaczyk i Wsplnicy Rozwj oprogramowania operacyjnego Spka z ograniczon odpowiedzialnoci. Spka komandytowa.
                    addresses:
                      addressInfo:
                      - address:
                          addressLine:
                          - 500 Oracle Parkway
                          cityName: Redwood Shores
                          postalCode: '94065'
                          cityExtension: a
                          state: CA
                          country:
                            value: USA
                            code: US
                          language: E
                          type: Office
                          typeDescription: This is office address.
                          primaryInd: false
                          barCode: ''
                          createDateTime: '2019-09-18T21:09:36.498Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-18T21:09:36.498Z'
                          lastModifierId: '12883'
                    territory: North America
                    telephones:
                      telephoneInfo:
                      - telephone:
                          phoneTechType: PHONE
                          phoneUseTypeDescription: office
                          phoneNumber: +1 415 555 0100
                          extension: x25
                          primaryInd: false
                          orderSequence: -100000000
                          createDateTime: '2019-09-18T21:09:36.499Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-18T21:09:36.499Z'
                          lastModifierId: '12883'
                    emails:
                      emailInfo:
                      - email:
                          emailAddress: eg@example.com
                          type: EMAIL
                          typeDescription: Email Address
                          emailFormat: EMAIL
                          primaryInd: false
                          orderSequence: -100000000
                          createDateTime: '2019-09-17T18:18:32.415Z'
                          creatorId: '12883'
                          lastModifyDateTime: '2019-09-17T18:18:32.416Z'
                          lastModifierId: '12883'
                    comments:
                      commentInfo:
                      - comment:
                          text:
                            value: Please add comments here.
                            language: E
                          commentTitle: Discount
                          type: GEN
                          typeDescription: Comments for discount.
                          internal: false
                          confidential: false
                          overrideInternal: false
                    profileAccessType:
                      croCode: HOTEL1
                      sharedLevel: CRO
                    profileRestrictions:
                      restricted: false
                    statusCode: ACTIVE
                    registeredProperty: HOTEL1
                    createDateTime: '2019-09-17 08:10:28.0'
                    creatorId: '12883'
                    lastModifyDateTime: '2019-09-17 08:23:05.0'
                    lastModifierId: '12883'
                    markForHistory: false
                  links:
                  - href: http://hotelCompany.example.com/operarest/opera/crm/v2/guests
                    rel: guestProfile
                    templated: false
                    method: POST
                    operationId: postGuestProfile
        description: Request object for change/modification of profile details. This object contains modified profile details with unique identifiers for each profile. The standard optional Opera Context element is also included.
        required: true
    delete:
      summary: Forget or delete a profile by ID
      description: Use this to anonymize a guest or contact profile in OPERA. <p><strong>OperationId:</strong>deleteProfile</p>
      operationId: deleteProfile
      parameters:
      - name: profileId
        in: path
        required: true
        description: OPERA internal profile ID which is used to uniquely identify the profile in OPERA. This ID is a primary identification of a profile in OPERA.
        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: 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/accounts:
    get:
      summary: Get profile accounts
      description: You can find the accounts that are listed on a profile with this API. <p><strong>OperationId:</strong>getProfileAccounts</p>
      operationId: getProfileAccounts
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: type
        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: hotelIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response of profile accounts.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileAccounts'
        '204':
          description: ProfileAccounts 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/attachments:
    get:
      summary: Get profile attachments
      description: This API will provide the attachments on a profile in OPERA Cloud. <p><strong>OperationId:</strong>getProfileAttachments</p>
      operationId: getProfileAttachments
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: attachedFileName
        in: query
        required: false
        description: File name used to filter final list of attachments. For example, Document.txt.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: description
        in: query
        required: false
        description: Description used to filter final list of attachments. For example, Offical guest ID. (This parameter does not require wildcard characters like * or % ).
        schema:
          type: string
          maxLength: 100
          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 with the details of the attachments of a profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileAttachments'
        '204':
          description: ProfileAttachments 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/attachments/{attachmentId}:
    delete:
      summary: Delete profile attachment
      description: This API will delete an attachment on a profile in OPERA Cloud. <p><strong>OperationId:</strong>deleteProfileAttachment</p>
      operationId: deleteProfileAttachment
      parameters:
      - name: attachmentId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: idExtension
        in: query
        description: Additional identifying value assigned by the creating system.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - 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: type
        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
          default:
          - Profile
      - name: uniqueIdIdExtension
        in: query
        description: Additional identifying value assigned by the creating system.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: uniqueIdIdContext
        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: uniqueIdType
        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
          default:
          - Attachment
      - $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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/awardsAndCertificates:
    get:
      summary: Get Profile awards and certificates
      description: Get Profile awards and certificates that exist on a profile. <p><strong>OperationId:</strong>getAwards</p>
      operationId: getAwards
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: hotelId
        in: query
        required: false
        description: Hotel Code for which the routing instructions are provided for a profile.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response of fetch awards request.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/awardDetails'
        '204':
          description: Awards 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/cashieringDetails:
    get:
      summary: Get cashiering details for a profile
      description: Retrieve any profile Financial details that exists on a profile (typically Company or Travel Agent profiles).  This includes Routing Instructions on the profile. <p><strong>OperationId:</strong>getCashieringDetails</p>
      operationId: getCashieringDetails
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: fetchPaymentMethod
        in: query
        required: false
        description: Boolean flag that indicates whether the payment method has to be fetched or not.
        schema:
          type: boolean
      - name: fetchRoutingInstruction
        in: query
        required: false
        description: Boolean flag that indicates whether the routing instruction has to be fetched or not.
        schema:
          type: boolean
      - 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: hotelIds
        in: query
        description: List of Hotel Codes.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object containing profile routing instructions.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileCashieringDetailsInfo'
        '204':
          description: CashieringDetails 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:
      - Profile
    put:
      summary: Change cashiering details for a profile
      description: Update a profiles Financial details, such as billing, routing instructions. <p><strong>OperationId:</strong>changeProfileCashieringDetails</p>
      operationId: changeProfileCashieringDetails
      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 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileCashieringDetails'
        description: Request object for changing the profile cashiering details.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{profileId}/commissionAccount:
    get:
      summary: Get commission account on a profile
      description: Retrieve Commission Account details from a specified profile. <p><strong>OperationId:</strong>getProfileCommissionAccount</p>
      operationId: getProfileCommissionAccount
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching profile commission detail.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileCommissionAccountInfo'
        '204':
          description: ProfileCommissionAccount 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:
      - Profile
    delete:
      summary: Delete a commission account from a profile
      description: Delete a Commission Account from a specified profile. <p><strong>OperationId:</strong>deleteProfileCommissionAccount</p>
      operationId: deleteProfileCommissionAccount
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: validatePending
        in: query
        required: false
        description: Used in CRUD operations. When set to true, proceed validating pending commissions
        schema:
          type: boolean
      - name: hotelId
        in: query
        required: false
        description: Hotel code from which the profile bank account and code belongs to
        schema:
          type: string
      - name: profileIdExtension
        in: query
        required: false
        description: Additional identifying value assigned by the creating system.
        schema:
          type: integer
      - 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: bankAccountId
        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: bankAccountIdExtension
        in: query
        required: false
        description: Additional identifying value assigned by the creating system.
        schema:
          type: integer
      - name: bankAccountIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: bankAccountIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: commissionCode
        in: query
        required: false
        description: Code.
        schema:
          type: string
      - name: description
        in: query
        required: false
        description: description.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Profile
    post:
      summary: Add a commission account on a profile
      description: Add a commission account on a profile.  You can only add commission accounts onto a Travel Agent or Source Profile type in OPERA Cloud. <p><strong>OperationId:</strong>postProfileCommissionAccount</p>
      operationId: postProfileCommissionAccount
      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:
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileCommissionAccount'
        description: Request object for creating profile commission detail.
        required: true
    put:
      summary: Set profile commission account
      description: Apply a commission account to an existing profile. You can add commission accounts to Travel Agent profile types. <p><strong>OperationId:</strong>setProfileCommissionAccount</p>
      operationId: setProfileCommissionAccount
      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 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileCommissionAccount'
        description: Request object for updating profile commission detail.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{profileId}/emails:
    post:
      summary: Create an Email.
      description: Use this API to create a new Email in OPERA.  You would need to know the Profile Id such as Contact or Account. <p><strong>OperationId:</strong>storeEmail</p>
      operationId: storeEmail
      parameters:
      - name: profileId
        in: path
        required: true
        description: Profile ID linked to an Email.
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/emailMessageType'
              - example:
                  blockId: '13701'
                  fromAddress: eg@example.com
                  toAddress:
                  - Example1@email.com
                  subject: First Email Subject
                  emailBody: base 64 encoded email body should be placed here
                  messageId: '12345'
                  emailReceiveDate: '2020-07-15T17:16:47.617Z'
                  hasAttachment: true
        description: Request object for storing an email.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{profileId}/flexFieldValues:
    get:
      summary: Operation to fetch flex field values.
      description: API to fetch flex field values. <p><strong>OperationId:</strong>getAllFlexFieldValues</p>
      operationId: getAllProfileFlexFieldValues
      parameters:
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelIds
        in: query
        description: Hotel code
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 50
      - name: flexFieldId
        in: query
        description: Flex field ID
        required: false
        schema:
          type: number
      - name: flexFieldCode
        in: query
        description: Flex field code
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 50
      - name: flexFieldValue
        in: query
        description: Flex field Value
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return. Default is 50
        schema:
          type: integer
          default: 50
          maximum: 100
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 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 flex field Values.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/flexFieldsResponse'
        '204':
          description: Flex field details 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/hotels/{hotelId}/forecasts:
    get:
      summary: Fetch Account Forecasts by hotel
      description: You can use this API to retrieve account forecasts for a hotel <p><strong>OperationId:</strong>getAccountForecasts</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getAccountForecasts
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal account profile ID
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: fromPeriodCode
        in: query
        required: false
        description: Specifies the From Fiscal or Calendar Period Code
        schema:
          type: string
      - 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 forecasts of an account profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/accountForecasts'
        '204':
          description: AccountForecasts 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:
      - Profile
    post:
      summary: Create account forecast in a hotel
      description: Use postAccountForecast to create a new account forecast for a hotel.  <p><strong>OperationId:</strong>postAccountForecast</p>
      operationId: postAccountForecast
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal account profile ID
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/forecastsInformation'
        description: Request object for creating forecast(s) of an account profile.
        required: true
    delete:
      summary: Delete multiple account forecasts
      description: Use this API to delete multiple account forecasts. <p><strong>OperationId:</strong>deleteMultipleAccountForecasts</p>
      operationId: deleteMultipleAccountForecasts
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique OPERA internal account profile ID
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: periodCodes
        in: query
        description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/hotels/{hotelId}/forecasts/periodCodes/{periodCode}:
    put:
      summary: Update account forecast in a hotel by period code
      description: Use this to update an existing account Forecast for a hotel.  You must know the period code for this API. <p><strong>OperationId:</strong>putAccountForecast</p>
      operationId: putAccountForecast
      parameters:
      - name: periodCode
        in: path
        required: true
        description: Period Code
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique Account Profile ID.
        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/changeAccountForecastsRS'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/forecastsInformation'
        description: Request object for changing forecast(s) of an account profile.
        required: true
    delete:
      summary: Delete account forecast in a hotel by period code
      description: Use this to delete an existing account Forecast for a hotel.  You must know the period code for this API. <p><strong>OperationId:</strong>deleteAccountForecast</p>
      operationId: deleteAccountForecast
      parameters:
      - name: periodCode
        in: path
        required: true
        description: Period Code.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: Unique Account Profile ID.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: periodCodes
        in: query
        description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/hotels/{hotelId}/preferenceType/{preferenceType}/preferences/{preferenceCode}:
    delete:
      summary: Delete a preference from a profile
      description: This will allow you to delete a preference code from a profile.  For example the guest no longer has a preference for High Floor Room, so you would go ahead and delete this preference from their profile. <p><strong>OperationId:</strong>deletePreference</p>
      operationId: deletePreference
      parameters:
      - name: preferenceCode
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: preferenceType
        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
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: registeredProperty
        in: query
        required: false
        description: Profiles Registered Property
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/hotels/{hotelId}/stagedProfile:
    delete:
      summary: Delete a staged profile
      description: This API can be used to delete a staged profile. <p><strong>OperationId:</strong>deleteStagedProfile</p>
      operationId: deleteStagedProfile
      parameters:
      - name: profileId
        in: path
        required: true
        description: Profile id of staged profile.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Hotel id of staged profile.
        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})*'
            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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/links:
    get:
      summary: Get linked profiles
      description: Retrieves profiles that are linked to an existing profile in OPERA Cloud, and maximum 1000 matching records can be fetched even if the matching records equal to or greater than 1000.<p><strong>OperationId:</strong>getLinkedProfiles</p>
      operationId: getLinkedProfiles
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: profileTypes
        in: query
        description: The types of Profile handled by the web service.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Guest
            - Agent
            - Company
            - Group
            - Source
            - Employee
            - Hotel
            - Vendor
            - Contact
            - Purge
            - BusinessHeader
            - BillingAccount
            - Activity
            - Potential
            - Account
          uniqueItems: true
      - name: accountsReceivables
        in: query
        required: false
        description: When true indicates that only profiles with AR account fetched.
        schema:
          type: boolean
      - name: corporateProfiles
        in: query
        required: false
        description: When true indicates that only profiles with client id are searched for.
        schema:
          type: boolean
      - name: excludeInactive
        in: query
        required: false
        description: Indicates whether to exclude Inactive Profiles, when true indicates that only profiles with active status will be displayed.
        schema:
          type: boolean
      - name: excludeIncompleteProfiles
        in: query
        required: false
        description: When true indicates that only profiles with an Address Line 1 and Country or at least one Communications Type will be displayed.
        schema:
          type: boolean
      - name: includeHasHierarchyOnly
        in: query
        required: false
        description: Include profiles that have one or more relationships in the search.
        schema:
          type: boolean
      - name: negotiatedRates
        in: query
        required: false
        description: When true indicates that this option has to be included in advanced search.
        schema:
          type: boolean
      - name: linkedProfileAdditionalCriteriaProfileType
        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: linkedProfileid
        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: linkedProfileIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: linkedProfileIdType
        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: excludeNoCity
        in: query
        required: false
        description: When true indicates that only profiles with city will be fetched.
        schema:
          type: boolean
      - 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: 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: streetAddress
        in: query
        required: false
        description: First Line of Street Address. For profile search it matches the first Address line.
        schema:
          type: string
      - name: ownerCode
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: aRNumber
        in: query
        required: false
        description: Account Receivable associated to the profile.
        schema:
          type: string
      - name: prioritiesCode
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response of fetch set of linked Profiles to the requested Profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/linkedProfiles'
        '204':
          description: LinkedProfiles 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/matches:
    get:
      summary: Get profile matches
      description: Retrieve profiles that match another profile. <p><strong>OperationId:</strong>getMatchProfiles</p>
      operationId: getMatchProfiles
      parameters:
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: Hotel Code for the profile.
        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
      - $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 the match profiles.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/matchedProfiles'
        '204':
          description: MatchProfiles 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/membershipType/{membershipType}/membershipId/{membershipId}:
    put:
      summary: Change membership information on a profile
      description: Use this API to update membership details on a profile. <p><strong>OperationId:</strong>changeMembership</p>
      operationId: changeMembership
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: membershipType
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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 change/update membership. This object contains collection of memberships,Success,Warnings and Errors related to this operation
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/changedMembership'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membership'
        description: Request object for change/update membership. This object contains unique identifiers for each profile and list of membership details to be updated/changed. The standard optional Opera Context element is also included.
        required: true
    delete:
      summary: Delete membership information from a profile
      description: Use this API to delete membership details on a profile. <p><strong>OperationId:</strong>deleteMembership</p>
      operationId: deleteMembership
      parameters:
      - name: membershipId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: membershipType
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/memberships:
    post:
      summary: Create membership on a profile
      description: A guest might be a member of your hotel loyalty program and/or a member of multiple airline frequent flier programs. Use this API to add membership details onto a guests profile. <p><strong>OperationId:</strong>postMembership</p>
      operationId: postMembership
      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:
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/membership'
        description: Request object for create membership. This object contains unique identifiers for each profile and list of membership details to be created. The standard optional Opera Context element is also included.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{profileId}/owners:
    get:
      summary: Get profile owners
      description: Retrieve the Owners listed on a profile. <p><strong>OperationId:</strong>getProfileOwners</p>
      operationId: getProfileOwners
      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: type
        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
      - $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 the owners of a profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileOwnersDetail'
        '204':
          description: ProfileOwners 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:
      - Profile
    put:
      summary: Change profile owners
      description: Update an Owner on a profile  <p><strong>OperationId:</strong>changeProfileOwners</p>
      operationId: changeProfileOwners
      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 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileOwners'
              - example:
                  criteria:
                    profileIdList:
                      id: 1017420
                      type: Profile
                    owners:
                    - ownerCode: MLW
                      profileId:
                        idContext: OPERA
                        id: 1017420
                        type: Profile
                      hotel:
                        code: HOTEL1
                      primary: false
        description: Request object to change profile owners.
        required: true
    post:
      summary: Assign profile owners
      description: Assign an Owner to a profile. <p><strong>OperationId:</strong>postProfileOwners</p>
      operationId: postProfileOwners
      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:
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileOwners'
        description: Request object to assign profile owners.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{profileId}/preferenceType/{preferenceType}/preferences/{preferenceCode}:
    delete:
      summary: Delete a global preference from a profile
      description: This will allow you to delete a global preference code from a profile.  For example the guest no longer has a preference for High Floor Room, so you would go ahead and delete this preference from their profile. <p><strong>OperationId:</strong>deleteGlobalPreference</p>
      operationId: deleteGlobalPreference
      parameters:
      - name: preferenceCode
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: preferenceType
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: profileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: registeredProperty
        in: query
        required: false
        description: Profiles Registered Property
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/preferences:
    get:
      summary: Get preferences on a profile
      description: Use this API to retrieve all preferences that a profile has stored on it.  Preferences are configured codes by a property, examples are usually High Floor, Non smoking room, Room with a View, soft pillow etc.  <p><strong>OperationId:</strong>getPreferenceForProfile</p>
      operationId: getPreferenceForProfile
      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: type
        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: hotelId
        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: codes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetch preference. This object contains collection of preferences,Success,Warnings and Errors related to this operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/preference'
        '204':
          description: PreferenceForProfile 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:
      - Profile
    put:
      summary: Distribute preferences on a profile
      description: With this API you can distribute preferences on a profile. <p><strong>OperationId:</strong>distributePreference</p>
      operationId: distributePreference
      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 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/preference'
        description: Request object for distribute Preference. This object contains unique identifiers for each profile and list of preferences to be associated with the profile. The standard optional Opera Context element is also included.
        required: true
    post:
      summary: Add preferences to a profile
      description: You can add new preferences to a profile to personalize or enhance your guest services.  You will need to know the profile ID, and the properties pre-configured preference codes. <p><strong>OperationId:</strong>postPreference</p>
      operationId: postPreference
      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:
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/preference'
        description: Request object for Create Preference. This object contains unique identifiers for each profile and list of preferences to be associated with the profile. The standard optional Opera Context element is also included.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{profileId}/relationships:
    get:
      summary: FetchProfileRelationships method provides the ability to retrieve a profile relationships for a profile based on the unique internal profile ID specified.
      description: ' <p><strong>OperationId:</strong>getProfileRelationships</p>'
      operationId: getProfileRelationships
      parameters:
      - name: profileId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: relationshipPrimaryProfile
        in: query
        required: false
        description: Type of Profile to be fetched from OPERA.
        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 profile relationships.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileRelationships'
        '204':
          description: ProfileRelationships 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{profileId}/reservations/action/validate:
    put:
      summary: Check future past bookings
      description: Validate if a profile has future and past bookings on a specific profile. <p><strong>OperationId:</strong>validateReservationsForProfile</p>
      operationId: validateReservationsForProfile
      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: This is the Response Message to information regarding existence of profile in future and/or past business blocks and/or reservations.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/futurePastBookings'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/futurePastBookingsCriteria'
        description: Request for information regarding existence of profile in future and/or past business blocks and/or reservations.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{profileId}/stayHistory:
    get:
      summary: FetchStayHistory method provides stay history and future reservations of a profile based on the unique internal ID specified.
      description: ' <p><strong>OperationId:</strong>getStayHistory</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>'
      operationId: getStayHistory
      parameters:
      - name: profileId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: Hotel Code used to filter hotel specific information regarding the profile.
        schema:
          type: string
      - name: includePurgeProfiles
        in: query
        required: false
        description: Providing this flag includes purged profiles in the result.
        schema:
          type: boolean
      - name: markAsRecentlyAccessed
        in: query
        required: false
        description: Providing this flag marks the profile as recently accessed.
        schema:
          type: boolean
      - name: limit
        in: query
        description: Indicates maximum number of records a Web Service should return.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: fetchInstructions
        in: query
        description: Simple type for instructions that can be used in requests for partial operations to fetch past and future reservation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - HistoryReservation
            - FutureReservation
          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 showing stay history and future reservations of specific profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileStayHistory'
        '204':
          description: StayHistory 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{sourceProfileId}/relationships/{targetProfileId}:
    post:
      summary: CreateProfileRelationship method provides the ability to create profile relationship based on the request criteria of SourceProfileID,TargetProfileID and SourceRelationType specified.
      description: ' <p><strong>OperationId:</strong>postProfileRelationship</p>'
      operationId: postProfileRelationship
      parameters:
      - name: targetProfileId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: sourceProfileId
        in: path
        required: true
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileRelationship'
              - example:
                  relationship:
                    primary: 'true'
                    statusCode: Active
                    targetProfileType: Guest
                    sourceRelation: FAMILY MEMBER
                    sourceRelationDescription: FAMILY MEMBER
                    targetRelation: FAMILY HEAD
                    targetRelationDescription: FAMILY HEAD
                    profileType: Guest
        description: Request object for creating profile relationship.
        required: true
    put:
      summary: ChangeProfileRelationship method provides the ability to update(delete and add) profile relationship based on the request criteria of SourceProfileID , TargetProfileID, To Be ChangedProfileID and SourceProfileRelationType specified.
      description: ' <p><strong>OperationId:</strong>putProfileRelationship</p>'
      operationId: putProfileRelationship
      parameters:
      - name: targetProfileId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: sourceProfileId
        in: path
        required: true
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileRelationshipToBeChanged'
              - example:
                  relationship:
                    changeRelationship:
                      changeProfileID:
                        id: '3261507'
                        type: Guest
                      sourceRelation: FRIEND1
                      sourceRelationDescription: Friends
                      targetRelation: FRIEND2
                      targetRelationDescription: Friends 2
                    primary: true
                    statusCode: Active
                    targetProfileType: Guest
                    sourceRelation: EMPLOYEE
                    sourceRelationDescription: EMPLOYEE
                    targetRelation: EMPLOYER
                    targetRelationDescription: EMPLOYER
                    relationshipID: '28026'
                    profileType: Guest
        description: Request object for changing profile relationship.
        required: true
    delete:
      summary: DeleteProfileRelationship method provides the ability to delete profile relationship based on the request criteria of SourceProfileID,TargetProfileID and SourceRelationType specified.
      description: ' <p><strong>OperationId:</strong>removeProfileRelationship</p>'
      operationId: removeProfileRelationship
      parameters:
      - name: targetProfileId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: sourceProfileId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: sourceRelation
        in: query
        required: true
        description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).
        schema:
          type: string
      - name: targetRelation
        in: query
        required: true
        description: Indicates the type of relationship the related profile(Target Profile) has with the current profile(Source Profile).
        schema:
          type: string
      - name: primary
        in: query
        required: false
        description: Indicates if this relationship is the primary relationship.
        schema:
          type: boolean
      - name: sourceRelationDescription
        in: query
        required: false
        description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).This needs to be passed if the attribute primary is sent as true.
        schema:
          type: string
      - name: targetRelationDescription
        in: query
        required: false
        description: Displays the description of relationship the related profile(Target Profile) has with the current profile(Source Profile).
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{survivorProfileId}/merges:
    post:
      summary: Merge two profiles by ID
      description: When you need to merge 2 guest profiles into 1 profile, use this API. <p><strong>OperationId:</strong>mergeProfiles</p>
      operationId: mergeProfiles
      parameters:
      - name: survivorProfileId
        in: path
        required: true
        description: Original Profile ID to which profiles will be merged in OPERA.
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileToBeMerged'
              - example:
                  victimProfileId:
                    id: '1087330'
        description: Request object for merging profiles.
        required: true
    servers:
    - url: /crm/v1
  /profiles/{survivorProfileId}/merges/snapshot:
    get:
      summary: Get merge profiles snapshot
      description: This API will provide you with a snapshot of the to be merged profile. In the request you will pass the survivor profile, along with the profile ID of the profile which it to be merged into the survivor profile.  The response will provide you with the combined profile data of both profiles which are being merged. <p><strong>OperationId:</strong>getMergeProfilesSnapshot</p>
      operationId: getMergeProfilesSnapshot
      parameters:
      - name: survivorProfileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: originalId
        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: originalIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: originalIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: toBeMergedId
        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: toBeMergedIdContext
        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: toBeMergedIdType
        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: centralOriginalId
        in: query
        required: false
        description: A unique identifying value for a central system. The ID attribute may be used to reference a primary-key value within a central database..
        schema:
          type: string
      - name: centralOriginalIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: centralOriginalIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: centralToBeMergedId
        in: query
        description: A unique identifying value for a central system. The ID attribute may be used to reference a primary-key value within a central database.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: centralToBeMergedIdContext
        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: centralToBeMergedIdType
        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
      - $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 snapshot of merge profiles result.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/mergedProfilesSnapshotDetails'
        '204':
          description: MergeProfilesSnapshot 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:
      - Profile
    servers:
    - url: /crm/v1
  /profiles/{survivorProfileId}/stageProfiles/snapshot:
    get:
      summary: Get merge stage profile snapshot
      description: This API will provide you with a snapshot of the to be merged profile in staging. <p><strong>OperationId:</strong>getMergeStageProfileSnapshot</p>
      operationId: getMergeStageProfileSnapshot
      parameters:
      - name: survivorProfileId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: Hotel Code for the profile.
        schema:
          type: string
      - name: resortProfileId
        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: resortProfileIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: resortProfileIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        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
      - $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 merge profile based on stage and opera profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/mergedStageProfileSnapshot'
        '204':
          description: MergeStageProfileSnapshot 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:
      - Profile
    servers:
    - url: /crm/v1
  /profilesByIds:
    get:
      summary: Search for profile(s)
      description: Use this API when you want to search for a profile. The response will include a list of profiles that exist in OPERA, based on your search criteria.  For example, you want to see if  a profile for Mr David Smith exists - you can search by various criteria, such as first, last name, email.  The response will include a list of any profiles that exist for Mr Davis Smith.  If a profile matches the criteria, and you want to get more details of that profile, proceed to use getProfile with the profileID in the request. <p><strong>OperationId:</strong>getProfilesByIds</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getProfilesByIds
      parameters:
      - name: profileIds
        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: corporateIds
        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: externalReferenceIds
        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: externalSystemCodes
        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: limit
        in: query
        description: Indicates maximum number of records a Web Service should return.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: fetchInstructions
        in: query
        description: Room Ownership information associated with the profile.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Address
            - Communication
            - NegotiatedRate
            - GdsNegotiatedRate
            - Comment
            - Membership
            - Preference
            - Keyword
            - HistoryReservation
            - FutureReservation
            - Relationship
            - Correspondence
            - Routing
            - Indicators
            - Profile
            - WebUserAccount
            - SalesInfo
            - ECertificate
            - Subscriptions
            - PrimaryAccountInfo
            - DeliveryMethods
            - RoomOwnership
          uniqueItems: true
      - name: instructionParameterType
        in: query
        description: Simple type enumerating the different parameters accepted by a profile Instructions. Parameter names have the name of the instruction expecting it, and the parameter name itself.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - NegotiatedRateShowInactive
            - NegotiatedRateResort
            - NegotiatedRateMaxFetchCount
            - NegotiatedRateCode
            - GdsNegotiatedRateShowInactive
            - PreferencesShowInactive
            - ResortForRoutingInstructions
            - RelationshipPrimaryProfile
            - AddressPrimaryOnly
            - CommunicationPrimaryOnly
            - DeliveryMethodsHotelCode
          uniqueItems: true
      - name: instructionParameterValue
        in: query
        description: Value of Profile Instruction Parameter
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: hotelId
        in: query
        required: false
        description: Hotel Code, It is used to filter hotel specific.
        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 multiple detailed profiles by unique identifiers..
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileDetails'
        '204':
          description: ProfilesByIds 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:
      - Profile
    servers:
    - url: /crm/v1
  /profilesMatchList:
    put:
      summary: Updates a list of matchIds to skip or don't skip profile match.
      description: Use this API to update a list of records of profiles match to skip or don't skip profile match
      operationId: putProfilesMatchList
      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: 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/matchListType'
        description: Parameter that contains a list of matchIds that will be updated to skip or don't skip profile match.
        required: true
    servers:
    - url: /crm/v1
  /profilesMatchList/profileType/{profileType}:
    get:
      summary: Get profiles match list.
      description: This API provides list of matching profiles based on the profile match configuration. These profiles are matched based on address, Postal codes, Last Name etc.<p><strong>OperationId:getProfilesMatchList</strong></p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getProfilesMatchList
      parameters:
      - name: profileType
        in: path
        required: true
        description: Profile type of the matched profiles.
        schema:
          type: string
          maxLength: 20
          minLength: 0
      - name: registeredProperty
        in: query
        required: false
        description: Property this profile is registered with.
        schema:
          type: string
          maxLength: 20
          minLength: 0
      - name: computedDate
        in: query
        required: false
        description: Specific Date when the weighing points were computed for the profiles.
        schema:
          type: string
          format: date
      - name: status
        in: query
        required: false
        description: 'Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.'
        schema:
          type: string
          items:
            type: string
            enum:
            - MPC
            - DNM
            - CNM
          uniqueItems: true
      - name: clientID
        in: query
        required: false
        description: Corporate id of the profile.
        schema:
          type: string
          maxLength: 20
          minLength: 0
      - 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
          maxLength: 40
          minLength: 0
      - name: givenName
        in: query
        required: false
        description: Given name, first name or names.
        schema:
          type: string
          maxLength: 40
          minLength: 0
      - name: doNotMerge
        in: query
        required: false
        description: If this value is true, then the response will return profiles that have been selected as Do Not Merge.
        schema:
          type: boolean
      - name: aboveUpperThreshold
        in: query
        required: false
        description: If this value is true, then the response will return profiles with weighing points that are higher than the upper threshold.
        schema:
          type: boolean
      - name: belowUpperThreshold
        in: query
        required: false
        description: If this value is true, then the response will return profiles with weighing points that are below the upper threshold.
        schema:
          type: boolean
      - 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 the profiles match.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profilesMatch'
        '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:
      - Profile
    servers:
    - url: /crm/v1
  /reProcessStageRecords:
    put:
      summary: Re-Process all Stage Records
      description: Use this API to Re-Process all Stage Records.<br><p><strong>OperationId:</strong>reProcessStageRecords</p>
      operationId: reProcessStageRecords
      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 object for the staged profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reProcessStageRecords'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/reProcessStageRecordsCriteria'
        description: Request object for reprocessing Stage records.
        required: true
    servers:
    - url: /crm/v1
  /reProcessStageRecords/logs:
    get:
      summary: Get reProcess stage records logs.
      description: Use this API to fetch logs for reProcess and rematch operations. The log can be filtered by date, users, and job ID.<p><strong>OperationId:</strong>getReProcessStageRecordsLogs</p>
      operationId: getReProcessStageRecordsLogs
      parameters:
      - name: fromDate
        in: query
        required: false
        description: Fetch logs from this date (inclusive).
        schema:
          type: string
          format: date
      - name: users
        in: query
        required: false
        description: User(s) who initiated the process. Can be comma separated or supplied as multiple params.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            maxItems: 40
      - name: jobId
        in: query
        required: false
        description: Job ID to fetch logs for a specific process/job.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api 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 fetch reProcess stage records logs. This object contains a collection of logs for each job/process request, including job id, log type, log content, record counts, date/time, and user.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reProcessStageRecordsLogInfo'
        '204':
          description: Logs 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:
      - Profile
    servers:
    - url: /crm/v1
  /recentlyAccessedProfiles:
    get:
      summary: Fetch recently accessed profiles
      description: Use this API to fetch the profiles that have recently been accessed by an application user. <p><strong>OperationId:</strong>getRecentlyAccessedProfiles</p>
      operationId: getRecentlyAccessedProfiles
      parameters:
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: accessDate
        in: query
        required: false
        description: Indicates which date reservations to be returned
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response with the fetched recently accessed profiles.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/recentlyAccessedProfiles'
        '204':
          description: RecentlyAccessedProfiles 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:
      - Profile
    servers:
    - url: /crm/v1
  /service/profileService/cache:
    delete:
      summary: Operation to delete cache for Profile service
      description: ' <p><strong>OperationId:</strong>clearProfileServiceCache</p>'
      operationId: clearProfileServiceCache
      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: 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:
      - Profile
    servers:
    - url: /crm/v1
  /services/profile/status:
    get:
      summary: Operation to check the status of profile service
      description: ' <p><strong>OperationId:</strong>pingProfileService</p>'
      operationId: pingProfileService
      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: pingProfileService 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:
      - Profile
    servers:
    - url: /crm/v1
  /stagedProfile/{id}:
    get:
      summary: Get a staged profile
      description: The system suspends / stages a profile with a point value between the upper and lower thresholds. When a profile is staged, you must review the suspended profile and determine if it should be merged with an internal profile or added as a new profile.  This API will get a specific profile that has been staged. <p><strong>OperationId:</strong>getStagedProfile</p>
      operationId: getStagedProfile
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: The hotel code that the stage profile belongs to.
        schema:
          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: type
        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: fetchInstructions
        in: query
        description: If selected, only invalid details of the staged profile will be retrieved.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Profile
            - Address
            - Communication
            - NegotiatedRate
            - Membership
            - Preference
            - Keyword
            - Routing
            - UserDefinedField
            - Identifier
            - InvalidDetail
            - Commission
          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 the staged profile.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/stagedProfileDetails'
        '204':
          description: StagedProfile 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:
      - Profile
    put:
      summary: Change a staged profile
      description: This API can be used to update the staged Profile. <p><strong>OperationId:</strong>changeStagedProfile</p>
      operationId: changeStagedProfile
      parameters:
      - name: id
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/stagedProfile'
        description: Request object for changing the staged profile.
        required: true
    servers:
    - url: /crm/v1
  /stagedProfiles:
    get:
      summary: Get staged profiles
      description: The system suspends / stages a profile with a point value between the upper and lower thresholds. When a profile is staged, you must review the suspended profile and determine if it should be merged with an internal profile or added as a new profile. <p><strong>OperationId:</strong>getStagedProfiles</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getStagedProfiles
      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: hotelIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: stagedReasons
        in: query
        description: 'This can be used to fetch staged profiles based on the reason why it got staged Ex : NameChange'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - InvalidEnrollmentCode
            - EmptyEnrollmentCode
            - NameChange
            - InvalidExpirationDate
            - EmptyExpirationDate
            - EmptyMembershipLevel
            - InvalidMembershipLevel
            - DuplicateMembership
          uniqueItems: true
      - name: id
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: 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: type
        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: 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: region
        in: query
        required: false
        description: The profile region for which the staged profiles shall be fetched.
        schema:
          type: string
      - name: countryCode
        in: query
        required: false
        description: Code for a country or a nationality.
        schema:
          type: string
      - name: profileType
        in: query
        required: false
        description: Profile type to be included in the search.
        schema:
          type: string
      - name: importDate
        in: query
        required: false
        description: 'The date on which the staged profiles have been received. This parameter is deprecated. '
        schema:
          type: string
          format: date
      - name: stageStatus
        in: query
        required: false
        description: The status of the staged profiles.
        schema:
          type: string
      - name: applyTo
        in: query
        required: false
        description: Membership filter of staged profiles.
        schema:
          type: string
          enum:
          - StagedProfiles
          - MatchingProfiles
          - StagedAndMatchingProfiles
          uniqueItems: true
      - name: membershipCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: insertDateFrom
        in: query
        required: false
        description: Accepts a date value and retrieves all the suspended profiles inserted on or after the provided date.
        schema:
          type: string
          format: date
      - name: insertDateTo
        in: query
        required: false
        description: Accepts a date value and retrieves all the suspended profiles inserted up to and including the specified date.
        schema:
          type: string
          format: date
      - name: membershipNumber
        in: query
        required: false
        description: ' Accepts a membership number and retrieves the suspended profile(s) associated with the provided code.'
        schema:
          type: string
          maxLength: 40
      - name: clientID
        in: query
        required: false
        description: Accepts a client ID number and retrieves the suspended profile(s) associated with the provided code.
        schema:
          type: string
      - name: errorDescription
        in: query
        required: false
        description: The error description for the staged profile.
        schema:
          type: string
          maxLength: 200
      - $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 the staged profiles.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/stagedProfiles'
        '204':
          description: StagedProfiles 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:
      - Profile
    servers:
    - url: /crm/v1
  /stagedProfiles/searches:
    post:
      summary: Get staged profiles
      description: The system suspends / stages a profile with a point value between the upper and lower thresholds. When a profile is staged, you must review the suspended profile and determine if it should be merged with an internal profile or added as a new profile. <p><strong>OperationId:</strong>searchStagedProfiles</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: searchStagedProfiles
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for the staged profiles.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/stagedProfiles'
        '204':
          description: StagedProfiles 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchStagedProfilesRequest'
        description: Search staged profiles request
    servers:
    - url: /crm/v1
  /stayMembership:
    post:
      summary: This API facilitates attaching or replacing a membership to a given stayRecord.
      description: A user can add a new membership or substitute an existing membership for a stay record by providing the relevant membership information in the request.<p><strong>OperationId:</strong>addReplaceStayMembership</p>
      operationId: addReplaceStayMembership
      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/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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/stayMembershipDetails'
        description: Request object for Membership details to attach or replace.
        required: true
    servers:
    - url: /crm/v1
  /stayRecord:
    post:
      summary: This API facilitates uploading stage records to LCS.
      description: A user can upload stay record to OPERA by specifying stay record column details in the request.<p><strong>OperationId:</strong>postStayRecord</p>
      operationId: postStayRecord
      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/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 stay record.
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/links'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/stayRecordDetails'
        description: Request object for uploading stage records to LCS.
        required: true
    servers:
    - url: /crm/v1
  /stayRecord/{stayRecordId}:
    get:
      summary: Get Stay Record Detail.
      description: This API is used to retrieve details of a given stay record (including UDFs, Daily Rates and Revenue). <p><strong>OperationId:</strong>getStayRecordDetail</p>
      operationId: getStayRecordDetail
      parameters:
      - name: stayRecordId
        in: path
        required: true
        description: A unique identifying value of the stay record, assigned by the creating system.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: fetchInstructions
        in: query
        description: Fetch instructions that can be used to fetch required stay record details.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - UDF
            - Revenue
            - Rates
          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 stay record detail.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/stayRecordDetail'
        '204':
          description: Stay Record detail 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:
      - Profile
    servers:
    - url: /crm/v1
  /stayRecords/{stayRecordId}:
    put:
      summary: Ability to edit Orphan Stay Records
      description: This API allows user to edit Orphan Stay Record fields. <p><strong>OperationId:</strong>putOrphanStayRecords</p>
      operationId: putOrphanStayRecords
      parameters:
      - name: stayRecordId
        in: path
        required: true
        description: Unique OPERA internal Orphan Stay Record Id which is used to find the Orphan Stay Record.
        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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/orphanStayRecord'
        description: Request object for updating Orphan Stay Record fields.
        required: true
    servers:
    - url: /crm/v1
  /suspendedAddresses:
    get:
      summary: Fetch Suspended Profile Addresses
      description: Fetch Suspended Profile Addresses <p><strong>OperationId:</strong>getSuspendedAddresses</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getSuspendedAddresses
      deprecated: true
      parameters:
      - name: name
        in: query
        required: false
        description: Last Name of the Profile against which the Suspended Addresses are fetched.
        schema:
          type: string
      - name: hotelId
        in: query
        required: false
        description: Hotel Code, It is used to filter hotel specific children to this specific hotel code.
        schema:
          type: string
      - name: firstName
        in: query
        required: false
        description: First Name of the Profile against which the Suspended Addresses are fetched.
        schema:
          type: string
      - name: profileType
        in: query
        required: false
        description: ProfileT ype of the Profile against which the Suspended Addresses are fetched..
        schema:
          type: string
      - name: matchCode
        in: query
        required: false
        description: Match Code of the Address Validation Performed from the batch processing
        schema:
          type: string
      - name: countryCode
        in: query
        required: false
        description: Code for a country or a nationality.
        schema:
          type: string
      - name: validateDate
        in: query
        required: false
        description: Validate Date.
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response list of suspended addresses based on supplied criteria
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedAddresses'
        '204':
          description: SuspendedAddresses 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:
      - Profile
    servers:
    - url: /crm/v1
  /suspendedProfiles/errorsSummary:
    get:
      summary: Get suspended profiles errors summary details
      description: Retrieve the suspended profiles errors summary details <p><strong>OperationId:</strong>getSuspendedProfilesErrorsSummary</p>
      operationId: getSuspendedProfilesErrorsSummary
      parameters:
      - name: insertDate
        in: query
        required: false
        description: Fetch the statistics from this date.
        schema:
          type: string
          format: date
      - name: hotelIds
        in: query
        description: Hotel codes of the profile's origin.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api should return.
        schema:
          type: integer
          default: 25
          minimum: 1
      - 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
          minimum: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetch suspended profiles errors summary. This object contains collection of profiles errors and the number of profiles that were encountered with these errors.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesErrorsSummaryInfo'
        '204':
          description: SuspendedProfilesErrorsSummary 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:
      - Profile
    servers:
    - url: /crm/v1
  /suspendedProfiles/errorsSummary/profileType:
    get:
      summary: Get suspended profiles match errors summary information grouped by profile type.
      description: Use this api to get the profiles match errors summary grouped by profile type <p><strong>OperationId:</strong>getSuspendedProfilesErrorsSummaryByProfileType</p>
      operationId: getSuspendedProfilesErrorsSummaryByProfileType
      parameters:
      - name: insertDate
        in: query
        required: false
        description: Fetch the statistics from this date.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api 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 fetch suspended profiles errors summary grouped by profile types. This object contains collection of profile types and count of how many errors encountered in each.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesErrorsSummaryByProfileTypeInfo'
        '204':
          description: SuspendedProfilesErrorsSummaryByProfileType 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:
      - Profile
    servers:
    - url: /crm/v1
  /suspendedProfiles/errorsSummary/property:
    get:
      summary: Get suspended profiles match errors summary information grouped by property.
      description: Use this api to get the profiles match errors summary to see the count of errors appears in each property. <p><strong>OperationId:</strong>getSuspendedProfilesErrorsStatByProperty</p>
      operationId: getSuspendedProfilesErrorsStatByProperty
      parameters:
      - name: insertDate
        in: query
        required: false
        description: Fetch the statistics from this date.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api 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 fetch suspended profiles errors summary for a specific error and see the number of times it appears in each property. This object contains collection of hotel and count of how many hotels encountered this error.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesErrorsSummaryByPropertyInfo'
        '204':
          description: SuspendedProfilesErrorsSummaryByProperty 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:
      - Profile
    post:
      summary: Get suspended profiles match errors summary information grouped by property.
      description: Use this api to get the profiles match errors summary for a specific error and see the number of times it appears in each property. <p><strong>OperationId:</strong>getSuspendedProfilesErrorsSummaryByProperty</p>
      operationId: getSuspendedProfilesErrorsSummaryByProperty
      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})*'
          description: Response object for fetch suspended profiles errors summary for a specific error and see the number of times it appears in each property. This object contains collection of hotel and count of how many hotels encountered this error.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesErrorsSummaryByPropertyInfo'
        '204':
          description: SuspendedProfilesErrorsSummaryByProperty 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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/errorDescType'
        description: Request object for filtering by error description of the suspended profiles.
        required: true
    servers:
    - url: /crm/v1
  /suspendedProfiles/matchStats:
    get:
      summary: Get suspended profile match statistics information.
      description: Retrieve the suspended profile match statistics information. <p><strong>OperationId:</strong>getSuspendedProfilesMatchStats</p>
      operationId: getSuspendedProfilesMatchStats
      parameters:
      - name: hotelId
        in: query
        required: false
        description: Hotel code of the profile's origin.
        schema:
          type: string
      - name: profileType
        in: query
        description: Profile type of the profile matched.
        required: false
        schema:
          type: string
          enum:
          - Guest
          - Agent
          - Company
          - Group
          - Source
          uniqueItems: true
      - name: insertDateFrom
        in: query
        required: false
        description: Fetch the statistics from this date.
        schema:
          type: string
          format: date
      - name: insertDateTo
        in: query
        required: false
        description: Fetch the statistics up to this date.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api should return.
        schema:
          type: integer
          default: 25
          minimum: 1
      - 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
          minimum: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetch suspended profile match statistics.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesMatchStats'
        '204':
          description: /suspendedProfiles/matchStats 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:
      - Profile
    servers:
    - url: /crm/v1
  /suspendedProfiles/matchStats/matchCriteria:
    get:
      summary: Get suspended profiles match statistics information grouped by match criteria.
      description: Use this api to get the profile match statistics grouped by match criteria. <p><strong>OperationId:</strong>getSuspendedProfilesMatchStatsByMatchCriteria</p>
      operationId: getSuspendedProfilesMatchStatsByMatchCriteria
      parameters:
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api 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 fetch suspended profiles match statistics grouped by match criteria.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesMatchStatsByMatchCriteria'
        '204':
          description: SuspendedProfilesMatchStatsByMatchCriteria 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:
      - Profile
    servers:
    - url: /crm/v1
  /suspendedProfiles/matchStats/profileType:
    get:
      summary: Get suspended profiles match statistics information grouped by profile type.
      description: Use this api to get the profiles match statistics grouped by profile type. <p><strong>OperationId:</strong>getSuspendedProfilesMatchStatsByProfileType</p>
      operationId: getSuspendedProfilesMatchStatsByProfileType
      parameters:
      - name: insertDate
        in: query
        required: false
        description: Fetch the statistics from this date.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api 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 fetch suspended profiles match statistics grouped by profile type.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesMatchStatsByProfileType'
        '204':
          description: SuspendedProfilesMatchStatsByProfileType 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:
      - Profile
    servers:
    - url: /crm/v1
  /suspendedProfiles/matchStats/property:
    get:
      summary: Get suspended profiles match statistics information grouped by property.
      description: Use this api to get the profiles match statistics grouped by property. <p><strong>OperationId:</strong>getSuspendedProfilesMatchStatsByProperty</p>
      operationId: getSuspendedProfilesMatchStatsByProperty
      parameters:
      - name: insertDate
        in: query
        required: false
        description: Fetch the statistics from this date.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api 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 fetch suspended profiles match statistics grouped by property.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesMatchStatsByProperty'
        '204':
          description: SuspendedProfilesMatchStatsByProperty 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:
      - Profile
    servers:
    - url: /crm/v1
  /suspendedProfiles/matchStats/propertyAndProfileType:
    get:
      summary: Get suspended profiles match statistics information grouped by property and profile type.
      description: Use this api to get the profiles match statistics grouped by property and profile type. <p><strong>OperationId:</strong>getSuspendedProfilesMatchStatsByPropertyAndProfileType</p>
      operationId: getSuspendedProfilesMatchStatsByPropertyAndProfileType
      parameters:
      - name: insertDate
        in: query
        required: false
        description: Fetch the statistics from this date.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api 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 fetch suspended profiles match statistics grouped by profile type.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesMatchStatsByPropertyAndProfileType'
        '204':
          description: SuspendedProfilesMatchStatsByPropertyAndProfileType 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:
      - Profile
    servers:
    - url: /crm/v1
  /suspendedProfiles/matchStats/threshold:
    get:
      summary: Get suspended profiles match statistics summary information filtering by threshold type.
      description: Use this api to get the profiles match statistics filtered by region, name type and threshold type. <p><strong>OperationId:</strong>getSuspendedProfilesMatchStatsByThreshold</p>
      operationId: getSuspendedProfilesMatchStatsByThreshold
      parameters:
      - name: regionCode
        in: query
        description: Profile region.
        required: true
        schema:
          type: string
      - name: hotelId
        in: query
        description: Hotel id of the profile's origin.
        required: false
        schema:
          type: string
      - name: threshold
        in: query
        required: true
        description: Returns the matches that are either upper, lower or between the threshold.
        schema:
          type: string
          enum:
          - Upper
          - Lower
          - Between
          uniqueItems: true
      - name: profileType
        in: query
        description: Name type of the profile matched.
        required: true
        schema:
          type: string
          enum:
          - Guest
          - Agent
          - Company
          - Group
          - Source
          uniqueItems: true
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records this api should return.
        schema:
          type: integer
          default: 25
          minimum: 1
      - 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
          minimum: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetch suspended profiles match statistics summary information filtering by threshold type.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suspendedProfilesMatchStatsByThreshold'
        '204':
          description: SuspendedProfilesMatchStatsByThreshold 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:
      - Profile
    servers:
    - url: /crm/v1
  /synchronizeProfileSubscriptions:
    put:
      summary: Synchronize profile subscriptions
      description: Synchronize profile subscriptions <p><strong>OperationId:</strong>synchronizeProfileSubscriptions</p>
      operationId: synchronizeProfileSubscriptions
      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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/profileSubscriptionsToSynchronize'
        description: Request object for re-subscribing profile subscriptions.
        required: true
    servers:
    - url: /crm/v1
  /validateForgetProfiles:
    put:
      summary: Validate forget profiles
      description: Validate forget profiles. <p><strong>OperationId:</strong>validateForgetProfiles</p>
      operationId: validateForgetProfiles
      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 object for validating profiles for forgetting.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/validatedForgetProfiles'
        '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:
      - Profile
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/forgetProfilesCriteria'
        description: Operation to validate profiles for forgetting.
        required: true
    servers:
    - url: /crm/v1
components:
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '403':
      description: Forbidden
    '413':
      description: Request Entity Too Large
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '503':
      description: Service Unavailable
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    x-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
  schemas:
    generateMembershipNumberCriteriaType:
      type: object
      description: Auto generate membership number criteria.
      properties:
        membershipType:
          description: Indicates the Membership Type where membership number to be generated will be based on.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: External Hotel Id to generate membership number.
          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
    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.
    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'
    status:
      type: object
      description: Response Body.
      properties:
        warnings:
          $ref: '#/components/schemas/warningsType'
        links:
          $ref: '#/components/schemas/links'
    membershipNumber:
      type: object
      description: Request object for generating membership number.
      properties:
        generateMembershipNumberCriteria:
          description: Generate Membership Number criteria.
          $ref: '#/components/schemas/generateMembershipNumberCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    reservationQueueInformationType:
      type: object
      description: Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
      properties:
        timeSpan:
          description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.
          type: object
          properties:
            startDate:
              type: string
              format: date
              maxLength: 8
            endDate:
              type: string
              format: date
              maxLength: 8
            duration:
              type: string
            durationInSeconds:
              description: The total duration, in seconds, the reservation is on Queue.
              type: integer
        guestTextInfo:
          description: Information for the message sent to the user
          $ref: '#/components/schemas/queueTextInfoType'
        priority:
          description: The Queue Priority given to this reservation.
          type: integer
        averageQueueTimeToCheckIn:
          description: The average time, in seconds, a reservation was on queue prior to Check-In.
          type: integer
        averageQueueTimeCurrentReservations:
          description: The average time, in seconds, of the reservations currently in queue.
          type: integer
        queueDate:
          description: The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.
          type: string
          format: date
          maxLength: 8
    cardReIssueType:
      type: string
      description: Request to re issue a new card.
      enum:
      - Pending
      - NotApplicable
      - Requested
    stayInfoType:
      type: object
      description: Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.
      properties:
        arrivalDate:
          type: string
          format: date
        departureDate:
          type: string
          format: date
        originalTimeSpan:
          description: The Original Time Span covers the Room Stay dates of the original reservation.
          $ref: '#/components/schemas/timeSpanType'
        expectedTimes:
          description: The expected arrival, return and departure times of the guest.
          $ref: '#/components/schemas/resExpectedTimesType'
        adultCount:
          description: A collection of Guest Counts associated with Room Stay.
          type: integer
        childCount:
          description: A collection of Child Counts associated with Room Stay.
          type: integer
        roomClass:
          description: Room class code
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Room type code
          type: string
          minLength: 0
          maxLength: 20
        componentRoomType:
          description: True indicates room type is a component type.
          type: boolean
        numberOfRooms:
          description: Room Id
          type: integer
        roomId:
          description: Room Id
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: Rate plan code
          type: string
          minLength: 0
          maxLength: 20
        rateAmount:
          description: Rate amount
          $ref: '#/components/schemas/currencyAmountType'
        points:
          description: The Points contains the number of points used to book a particular room type.
          $ref: '#/components/schemas/pointsType'
        rateSuppressed:
          description: Whether this rate should be suppressed from view
          type: boolean
        reservationBlock:
          description: Key information about the block for this reservation.
          $ref: '#/components/schemas/reservationBlockType'
        bookingChannelCode:
          description: Booking channel code
          type: string
          minLength: 0
          maxLength: 20
        linkCode:
          description: Party code
          type: string
          maxLength: 2000
        fixedRate:
          description: True if the rate is a fixed rate, otherwise false
          type: boolean
        totalAmount:
          description: The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.
          $ref: '#/components/schemas/currencyAmountType'
        guarantee:
          description: The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.
          $ref: '#/components/schemas/resGuaranteeType'
        promotion:
          description: Promotion Codes
          $ref: '#/components/schemas/promotionType'
        marketCode:
          description: Market code
          type: string
          minLength: 0
          maxLength: 20
        marketDescription:
          description: Description of Market code
          type: string
          minLength: 0
          maxLength: 4000
        sourceCode:
          description: Source of business
          type: string
          minLength: 0
          maxLength: 20
        sourceCodeDescription:
          description: Description of the source of business.
          type: string
          minLength: 0
          maxLength: 4000
        balance:
          description: Balance amount
          $ref: '#/components/schemas/currencyAmountType'
        compBalance:
          description: Comp Balance amount
          $ref: '#/components/schemas/currencyAmountType'
        roomTypeCharged:
          description: Room type code that was charged
          type: string
          minLength: 0
          maxLength: 20
        depositPayments:
          description: A collection of deposit and/or payments for the Room Stay.
          $ref: '#/components/schemas/currencyAmountType'
        guestServiceStatus:
          description: Service Status of In House guest like DND or MUP
          $ref: '#/components/schemas/guestHousekeepingServiceRequestType'
        scheduledCheckoutTime:
          description: Indicates that this reservation is scheduled for automated check out.
          type: string
          format: date
        roomNumberLocked:
          description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.
          type: boolean
        pseudoRoom:
          description: True indicates as pseudo room type. This is usually used for a posting master reservation.
          type: boolean
        assignedByAI:
          description: Represents the room was assigned by AI Room Assignment.
          type: boolean
        upgradedByAI:
          description: Represents the room was assigned by AI Room Assignment.
          type: boolean
    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'
    matchStatusType:
      type: string
      enum:
      - MatchFoundMerge
      - MatchFoundCreate
      - TentativeMatchFound
      - MatchNotFound
      description: No Match found based on the Threshold.
    duplicateExternalSubscriptionsListType:
      type: array
      description: Details of the OPERA Profile subscription to external system
      maxItems: 4000
      items:
        $ref: '#/components/schemas/duplicateExternalSubscriptionsType'
    suspendedProfilesMatchStatsByMatchCriteriaType:
      type: object
      description: Suspended profiles match statistics grouped by match criteria.
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        matchStatsInfo:
          type: array
          description: Collection of suspended profiles match statistics grouped by match criteria.
          items:
            $ref: '#/components/schemas/suspendedProfilesMatchStatByMatchCriteriaType'
            maxItems: 100
    emailMessageType:
      type: object
      description: Request object for storing an email.
      properties:
        blockId:
          description: ID of the Block that is associated with the email.
          $ref: '#/components/schemas/stringLength80'
        fromAddress:
          description: The address that originated the email.
          $ref: '#/components/schemas/basicEmailType'
        toAddress:
          description: A collection of email addresses for recipients who were sent the email message
          $ref: '#/components/schemas/basicEmailListType'
        subject:
          description: The subject line of the email.
          $ref: '#/components/schemas/stringLength200'
        emailBody:
          description: Email in base64 binary format.
          type: string
          format: byte
        messageId:
          description: Global ID of the email message from the external system.
          $ref: '#/components/schemas/stringLength100'
        emailReceiveDate:
          description: The date the email was received.
          type: string
          format: date-time
        hasAttachment:
          description: Indicates whether the email was sent with an attachment (true) or not (false).
          type: boolean
        warnings:
          $ref: '#/components/schemas/warningsType'
    stagedProfilePhoneType:
      type: object
      properties:
        telephone:
          description: Phone details for the profile.
          $ref: '#/components/schemas/telephoneType'
        errorDescription:
          description: The error in telephone information in a staged profile with an invalid status.
          type: string
          minLength: 0
          maxLength: 2000
        inactiveDate:
          description: Inactivation date of the record.
          type: string
          format: date
          maxLength: 8
        defaultConfirmation:
          description: Indicates whether the phone is the default confirmation method.
          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
      description: Information on a telephone number for the customer.
    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
    recentlyAccessedProfileType:
      type: object
      description: A recently used profile details.
      properties:
        profileIdList:
          description: List of unique ids, consisting of the profile name id.
          $ref: '#/components/schemas/profileIdList'
        guestFirstName:
          description: First Name of a Profile.
          $ref: '#/components/schemas/givenNameType'
        guestLastName:
          description: Last Name of a profile.
          $ref: '#/components/schemas/surnameType'
        accessDate:
          description: The date the record was accessed.
          type: string
          format: date
          maxLength: 8
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
    successType:
      type: object
      description: Returning an empty element of this type indicates the successful processing of an message. This is used in conjunction with the Warning Type to report any warnings or business errors.
      properties: {}
    folioStatusType:
      type: string
      description: 'The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.'
      enum:
      - Deposit
      - Void
      - Ok
      - Zero
      - Compress
      - Converted
      - Internal
    stageProfileMatchType:
      type: object
      description: Details about the matched profiles.
      properties:
        profileId:
          description: Unique identifier of the matching profile.
          $ref: '#/components/schemas/uniqueID_Type'
        matchPercentage:
          description: Percentage match between the stage profile and the given profile.
          type: number
        matchDescription:
          description: Reason for the profile match.
          type: string
          minLength: 0
          maxLength: 200
    colorType:
      type: string
      description: Color configuration type. This color configuration provides a visual category of entities.
      enum:
      - Red
      - DarkRed
      - Green
      - DarkGreen
      - LightGreen
      - Orange
      - White
      - Yellow
      - DarkYellow
      - Purple
      - Brown
      - Gray
      - Aqua
      - Chocolate
      - Blue
      - LightBlue
      - DarkBlue
      - Cyan
      - DarkCyan
      - Magenta
      - DarkMagenta
      - Black
    profileCashieringDetails:
      type: object
      description: Request object for changing the profile cashiering details.
      properties:
        profileIdList:
          description: Unique identifier for the profile for both internal and external systems.
          $ref: '#/components/schemas/profileIdList'
        profileCashieringDetailList:
          description: Cashiering details for the profile.
          type: array
          items:
            $ref: '#/components/schemas/profileCashieringDetailType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    stagedReasonsEnum:
      type: string
      enum:
      - InvalidEnrollmentCode
      - EmptyEnrollmentCode
      - NameChange
      - InvalidExpirationDate
      - EmptyExpirationDate
      - EmptyMembershipLevel
      - InvalidMembershipLevel
      - DuplicateMembership
    stagedProfileCharacterUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Character/String Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/stagedProfileCharacterUDFType'
    profileCommissionAccountCriteriaType:
      type: object
      description: Contains base info to determine profile commission bank account and code.
      properties:
        hotelId:
          description: Hotel code from which the profile bank account and code belongs to
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: Unique profile identifier.
          $ref: '#/components/schemas/profileId'
        bankAccountId:
          description: Bank account ID.
          $ref: '#/components/schemas/uniqueID_Type'
        commissionCode:
          description: Profile commission code
          $ref: '#/components/schemas/codeDescriptionType'
        validatePending:
          description: Used in CRUD operations. When set to true, proceed validating pending commissions
          type: boolean
    stagedProfileCommentInfosType:
      type: array
      description: List of Notes for the customer.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/stagedProfileCommentInfoType'
    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
    reProcessStageRecordsType:
      type: object
      description: Provides information about the search criteria for the staged records to reprocess.
      properties:
        property:
          description: Property in Search Criteria
          type: string
        name:
          description: Name in Search Criteria
          type: string
        region:
          description: Region in Search Criteria
          type: string
        nameCode:
          description: Name Code in Search Criteria
          type: string
        country:
          description: Country in Search Criteria
          type: string
        stageStatus:
          description: Stage Status in Search Criteria
          type: string
        membershipType:
          description: Membership Types to filter in the search criteria.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        nameType:
          description: Name Type in Search Criteria
          type: string
        importDate:
          description: Import Date in Search Criteria
          type: string
          format: date
          maxLength: 8
        firstName:
          description: First Name in Search Criteria
          type: string
        errorSummary:
          description: List of error summaries, comma separated values
          type: array
          items:
            type: string
        applyToType:
          description: Records with memberships.
          $ref: '#/components/schemas/applyToType'
    characterUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Character/String Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/characterUDFType'
    timeSpanType:
      type: object
      description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.
      properties:
        startDate:
          type: string
          format: date
          maxLength: 8
        endDate:
          type: string
          format: date
          maxLength: 8
        duration:
          type: string
    profile:
      type: object
      description: Object for creation of profiles. This object contains profile details with unique identifiers for each profile.
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as ID.
          $ref: '#/components/schemas/profileIdList'
        externalReferences:
          description: External Reference information for Profile.
          $ref: '#/components/schemas/externalReferencesType'
        profileDetails:
          description: Provides detailed information regarding either a company or a customer profile.
          $ref: '#/components/schemas/profileType'
        profileAllowedActions:
          description: Provides the actions needed to apply on the profile
          $ref: '#/components/schemas/profileAllowedActionsType'
        copyInstructions:
          description: Indicates which details of the master profile should be copied to subsidiary profiles, when a master-sub relationship is created for profile types Company, TravelAgent and Source
          $ref: '#/components/schemas/copyInstructionsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    suspendedProfilesMatchStatsByPropertyAndProfileTypeType:
      type: object
      description: Suspended profiles match statistics grouped by property and profile type.
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        matchStatsInfo:
          type: array
          description: Collection of suspended profiles match statistics grouped by property and profile type.
          items:
            $ref: '#/components/schemas/suspendedProfilesMatchStatByPropertyAndProfileTypeCombined'
            maxItems: 100
    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
    stagedProfileChangeInstructionsType:
      type: object
      description: Information about instructions to change the staged profile.
      properties:
        fullyOverlay:
          description: If true then delete and recreat the staged profile details.
          type: boolean
    fixedChargesType:
      type: array
      description: Holds fixed charge detail.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/fixedChargeType'
    stagedProfileSummariesType:
      type: object
      description: A collection of staged profiles.
      properties:
        profileInfo:
          description: Basic information about staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileSummaryType'
        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
    imageStyleType:
      type: string
      description: An enumeration of image styles.
      enum:
      - Full
      - Thumbnail
      - Icon
      - Square
      - Banner
      - Button
      - Lowres
      - Highres
    addressInfoType:
      type: object
      description: Provides address information.
      properties:
        address:
          description: Address details for the profile.
          $ref: '#/components/schemas/addressType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    profileCommissionAccountCopy:
      type: object
      description: Request object for copying transaction groups configuration.
      properties:
        profileCommissionAccountsInfo:
          description: List of resorts with profile commission account information to be copied.
          $ref: '#/components/schemas/copyProfileCommissionInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    verifiedECertificate:
      type: object
      description: Response object to Verify E-Certificate and will return the profile information.
      properties:
        profileName:
          description: Basic profile information related to the ecertificate.
          $ref: '#/components/schemas/profileNameType'
        profileId:
          description: Profile NameId.
          $ref: '#/components/schemas/profileId'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    changeRelationsInfoType:
      type: object
      description: Detailed information regarding to be changed relationships for the profile.
      properties:
        changeProfileID:
          description: Unique id of the profile to be changed to.
          $ref: '#/components/schemas/uniqueID_Type'
        primary:
          description: Indicates if this relationship is the primary relationship.
          type: boolean
        sourceProfileType:
          description: Used to specify a source profile type.
          $ref: '#/components/schemas/profileTypeType'
        sourceRelation:
          description: Indicates the type of to be changed 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 to be changed relationship the current profile(Source Profile) has with the related profile(Target Profile).This needs to be passed if the attribute primary is sent as true.
          type: string
          minLength: 0
          maxLength: 200
        targetRelation:
          description: Indicates the type of to be changed 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 to be changed relationship the related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetProfileType:
          description: Used to specify a target profile type.
          $ref: '#/components/schemas/profileTypeType'
    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
    customerType:
      type: object
      description: Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
      properties:
        personName:
          description: Detailed name information for the customer.
          type: array
          maxItems: 5
          items:
            $ref: '#/components/schemas/personNameType'
        anonymization:
          description: Provides information about the guest's anonymization status
          $ref: '#/components/schemas/anonymizationType'
        citizenCountry:
          description: Name of the (self-professed) country that is claimed for citizenship.
          $ref: '#/components/schemas/countryNameType'
        identifications:
          description: List of identification of the customer.
          type: object
          properties:
            identificationInfo:
              description: Collection of detailed information on the identification of the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/identificationInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        profession:
          description: Profession of a person.
          type: string
          minLength: 0
          maxLength: 80
        alienInfo:
          description: Immigration/visa information of a foreign person.
          $ref: '#/components/schemas/alienInfoType'
        birthCountry:
          description: Country of birth.
          $ref: '#/components/schemas/countryNameType'
        legalCompany:
          description: Name Of the company the individual is associated with.
          type: string
          minLength: 0
          maxLength: 80
        companyInfo:
          description: Company Information of the Profile.
          $ref: '#/components/schemas/companyInfoType'
        businessTitle:
          description: Business Title.
          type: string
          minLength: 0
          maxLength: 80
        gender:
          description: Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.
          type: string
          minLength: 0
          maxLength: 20
        birthDate:
          description: Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.
          type: string
          format: date
          maxLength: 8
        birthDateMasked:
          description: Indicates the date of birth as masked.
          type: string
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        nationality:
          description: Nationality code identification
          type: string
          minLength: 0
          maxLength: 20
        nationalityDescription:
          description: Nationality code description
          type: string
          minLength: 0
          maxLength: 80
        customerValue:
          description: The supplier's ranking of the customer (e.g., VIP, numerical ranking).
          type: string
          minLength: 0
          maxLength: 20
        creditRating:
          description: Credit Rating of the customer.
          type: string
          minLength: 0
          maxLength: 20
        vipStatus:
          description: VIP status of the customer.
          type: string
          minLength: 0
          maxLength: 20
        vipDescription:
          description: Description of the VIP status.
          type: string
          minLength: 0
          maxLength: 2000
        birthPlace:
          description: Place of birth.
          type: string
          minLength: 0
          maxLength: 80
        privateProfile:
          description: This element tells profile is property exclusive or not.
          type: boolean
        blacklist:
          description: This element tells if profile is blacklisted or not.
          type: boolean
    suspendedProfilesErrorsSummaryInfo:
      type: object
      description: Response object for fetch suspended profiles errors summary. This object contains collection of profiles errors and the number of profiles that were encountered with these errors.
      properties:
        suspendedProfilesErrorsSummary:
          description: Indicates response of the suspended profiles errors summary.
          $ref: '#/components/schemas/suspendedProfilesErrorsSummaryType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    suspendedProfilesErrorsSummaryByProfileType:
      type: object
      description: Suspended profiles errors summary by profile type.
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        errorSummaryInfo:
          type: array
          description: Collection of suspended profiles errors summary by property.
          items:
            $ref: '#/components/schemas/suspendedProfilesErrorSummaryByProfileType'
            maxItems: 100
    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
    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'
        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
    company:
      type: object
      description: Request object for creation of company/agent/group/source profile. This object contains profile details with unique identifiers of a profile. The standard optional Opera Context element is also included.
      properties:
        companyIdList:
          description: Unique identifiers of 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'
        externalReferences:
          description: External Reference information for Profile.
          $ref: '#/components/schemas/externalReferencesType'
        companyDetails:
          description: Provides detailed information of a company profile.
          $ref: '#/components/schemas/companyProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stagedProfileNumericUDFType:
      type: object
      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
        errorDescription:
          description: The error in a user defined field in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        tableName:
          description: PMS table name.
          type: string
          minLength: 0
          maxLength: 40
        valid:
          description: Indicates whether the UDF information is valid.
          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
      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.
    stagedReasonsType:
      type: object
      description: This is used to fetch staged profiles based on the reason why it got staged.
      properties:
        stagedProfileReasonsType:
          description: This is used to fetch staged profiles based on the reason why it got staged.
          $ref: '#/components/schemas/stagedReasonType'
    hasFuturePastBookingsExclusionsType:
      type: object
      description: Search type for excluding list of business blocks and/or reservations.
      properties:
        reservationIdList:
          description: List of unique identifier of reservation.
          $ref: '#/components/schemas/uniqueIDListType'
        blockIdList:
          description: List of Unique identifier of business block.
          $ref: '#/components/schemas/uniqueIDListType'
    forgetProfileFailureReasonListType:
      type: array
      description: Reason describing why the profile is not eligible to be forgotten.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/forgetProfileFailureReasonType'
    stagedAddressCleansStatus:
      type: string
      description: Simple type for status of staged address cleansing.
      enum:
      - NotCleansed
      - Cleansed
      - Failure
    fulfillmentExportInfoType:
      type: object
      description: This type holds the export log information for the membership fulfillment record.
      properties:
        extractLogId:
          description: Unique Id that references an object uniquely in the fulfillment export logs table.
          $ref: '#/components/schemas/uniqueID_Type'
        membershipId:
          description: Id Number of the membership.
          $ref: '#/components/schemas/uniqueID_Type'
        membershipCard:
          description: The card number for the guest membership.
          type: string
          minLength: 0
          maxLength: 50
        extractCode:
          description: ExtractCode of the membership fulfillment export logs.
          type: string
          minLength: 0
          maxLength: 20
        extractDate:
          description: ExtractDate of the membership fulfillment export logs.
          type: string
          format: date
          maxLength: 8
        deliveryStatus:
          description: The Delivery Status for export logs will default to "Unknown."(Unknown/Delivered/NotDelivered).
          $ref: '#/components/schemas/exportLogsDeliveryStatusType'
        extractId:
          description: ExtractId of Membership Extracts.
          $ref: '#/components/schemas/uniqueID_Type'
        extractBatchId:
          description: Export run will populate the Extract Batch Id in export logs.
          $ref: '#/components/schemas/uniqueID_Type'
        excludeExtract:
          description: To exclude the extract record from membership exports. Once the membership export has run, this check box will be grayed out and the extract batch Id will be populated in the Extract Batch Id read-only field.
          type: boolean
    profileDeliveryModuleType:
      type: string
      description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..'
      enum:
      - EfolioExport
    reProcessStageRecord:
      type: object
      properties:
        processResult:
          $ref: '#/components/schemas/reProcessStageRecordResultType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    aRAccountType:
      type: object
      description: Accounts Receivabales Account details type.
      properties:
        hotelId:
          description: Property where the AR Account exists.
          type: string
          minLength: 0
          maxLength: 20
        accountName:
          description: Name of the AR Account.
          type: string
          minLength: 0
          maxLength: 200
        accountId:
          description: The unique ID for the Account.
          $ref: '#/components/schemas/uniqueID_Type'
        accountNo:
          description: The Account Number for the Account.
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: Internal Profile ID for the AR Account.
          $ref: '#/components/schemas/profileId'
        balance:
          description: Open Balance of the Account for this property.
          $ref: '#/components/schemas/currencyAmountType'
        creditLimit:
          description: The maximum credit allowed for the Account.
          $ref: '#/components/schemas/currencyAmountType'
        contactName:
          description: The person to contact for this Account.
          type: string
          minLength: 0
          maxLength: 200
        paymentDueDays:
          description: Number of days on which person can make payment.
          type: string
          minLength: 0
          maxLength: 20
        monthEndCalcYN:
          description: Month End Calculation.
          type: boolean
        address:
          description: Address information for the address which is attached to this AR Account.
          $ref: '#/components/schemas/addressInfoType'
        email:
          description: Email information for the Account. This is the Email that is attached to this AR Account.
          $ref: '#/components/schemas/emailInfoType'
        telephones:
          description: The Telephone and Fax details attached to the Account.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/telephoneInfoType'
        lastReminderInfo:
          description: Report History Type used as based type for Remiders and Statements History types.
          type: object
          properties:
            reportName:
              description: Report Name.
              type: string
              minLength: 0
              maxLength: 2000
            reportFileName:
              description: Report file name when exists to allow report re-printing.
              type: string
              minLength: 0
              maxLength: 2000
            dateSent:
              description: The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.
              type: string
              format: date
              maxLength: 8
            age:
              description: The minimum age(days) of the invoices to be included in the Reminder
              type: integer
            historyExists:
              description: Indicates that reminders history exists.
              type: boolean
        lastStatementInfo:
          description: Report History Type used as based type for Remiders and Statements History types.
          type: object
          properties:
            reportName:
              description: Report Name.
              type: string
              minLength: 0
              maxLength: 2000
            reportFileName:
              description: Report file name when exists to allow report re-printing.
              type: string
              minLength: 0
              maxLength: 2000
            dateSent:
              description: The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.
              type: string
              format: date
              maxLength: 8
            statementNo:
              description: When using Statement Numbering, a unique number is associated to the Statement.
              type: integer
            historyExists:
              description: Indicates that statement history exists.
              type: boolean
        notes:
          description: The Note details attached to the Account.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/commentInfoType'
        traces:
          description: The Trace details attached to the Account.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/traceType'
        fixedCharges:
          description: Fixed charges attached to this AR Account.
          $ref: '#/components/schemas/fixedChargesType'
        accountIndicators:
          description: Indicators of additional information attached to the Account.
          $ref: '#/components/schemas/indicatorsType'
        agingInfo:
          description: The Aging balance information for this account, by Aging Buckets.
          $ref: '#/components/schemas/aRAgingInfoType'
        yearViewInfo:
          description: The Year View balance information for this account.
          $ref: '#/components/schemas/aRYearViewInfoType'
        invoices:
          description: List of all Invoices.
          $ref: '#/components/schemas/aRInvoicesType'
        payments:
          description: List of all Payments made.
          $ref: '#/components/schemas/aRPaymentsType'
        summary:
          description: The Summary Information of the Invoices for the Account.
          $ref: '#/components/schemas/aRBalanceType'
        status:
          description: The status of the account.
          $ref: '#/components/schemas/aRAccountStatusType'
        batchStatement:
          description: Include In Batch Statement
          type: boolean
        printFoliosWithStatement:
          description: Indicates if associated folios should be printed by default with the statement.
          type: boolean
        emailStatementsReminders:
          description: Indicates if the Account has opted to send the statements and reminders to the Account email address by default.
          type: boolean
        searchMatches:
          description: Super Search matching terms.
          $ref: '#/components/schemas/searchMatchesType'
        primary:
          description: Indicates if this Account is the Primary Account for this Guest/Company.
          type: boolean
        type:
          description: The type of Account.
          type: string
          minLength: 0
          maxLength: 20
        accountTypeDescription:
          description: The description of the Account Type.
          type: string
          minLength: 0
          maxLength: 2000
        permanent:
          description: Indicates if this is a Permanent Account. Permanent Accounts cannot be deleted.
          type: boolean
    duplicateOPERASubscriptionsType:
      type: object
      description: Contains subscription details about an external profile within a particular external system that is linked to multiple OPERA profiles.
      properties:
        externalProfileId:
          description: Profile ID within the external system
          $ref: '#/components/schemas/uniqueID_Type'
        profileSubscriptions:
          description: List of profile subscriptions to external system that are linked to the same OPERA Profile
          $ref: '#/components/schemas/profileSubscriptionListType'
    suspendedProfileType:
      type: string
      description: The types of suspended profiles
      enum:
      - Guest
      - Agent
      - Company
      - Group
      - Source
    hotelInterfaceType:
      type: object
      properties:
        interfaceId:
          description: Unique DB internal number of a Hotel Interface record.
          $ref: '#/components/schemas/uniqueID_Type'
        hotelId:
          description: Hotel Code
          type: string
          minLength: 0
          maxLength: 20
        interfaceName:
          description: Name of the Hotel Interface
          type: string
          minLength: 0
          maxLength: 40
        interfaceType:
          description: Three letter code for each interface that identifies the interface.
          $ref: '#/components/schemas/hotelInterfaceTypeType'
        logo:
          description: Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.
          type: string
          minLength: 0
          maxLength: 20
        machineName:
          description: Unique machine name of the running IFC.
          type: string
          minLength: 0
          maxLength: 80
        status:
          description: The current status of the IFC.
          $ref: '#/components/schemas/hotelInterfaceStatusType'
        activeFlag:
          description: Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.
          type: boolean
    stagedProfiles:
      type: object
      description: Response object for the staged profiles.
      properties:
        stagedProfiles:
          description: A collection of staged profiles.
          $ref: '#/components/schemas/stagedProfileSummariesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    cardProcessingType:
      type: string
      enum:
      - Eft
      - Manual
    eCertificateGenerationDetailsType:
      type: object
      description: E-Certificates issue API call details.
      properties:
        profileId:
          description: NameId.
          $ref: '#/components/schemas/profileId'
        certificateType:
          description: User defined certificate code.
          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'
        hotels:
          description: Hotel to which certificate is attached to.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
    suspendedProfilesMatchStatsByMatchCriteria:
      type: object
      description: Response object for fetch suspended profiles match statistics grouped by match criteria.
      properties:
        suspendedProfilesMatchStatsByMatchCriteria:
          description: Provides the information for suspended profiles match statistics grouped by match criteria.
          $ref: '#/components/schemas/suspendedProfilesMatchStatsByMatchCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    aRPaymentsType:
      type: array
      description: A collection of AR Payments.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/aRPaymentType'
    suspendedProfilesMatchStatsByThresholdType:
      type: object
      description: Suspended profiles match statistics grouped by threshold
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        matchStatsInfo:
          type: array
          description: Collection of suspended profiles match statistics grouped by threshold type
          items:
            $ref: '#/components/schemas/suspendedProfilesMatchStatByThresholdType'
            maxItems: 100
    suspendedAddresses:
      type: object
      description: Response object for fetching unique company profile.
      properties:
        suspendedAddressesInfo:
          description: Suspended Addresses List
          $ref: '#/components/schemas/suspendedAddressesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    aRYearViewInfoType:
      type: object
      description: Information regarding Year View balances for an account.
      properties:
        totalOutstanding:
          description: The total debit and credit balance of the account.
          $ref: '#/components/schemas/aRBalanceType'
        yearView:
          description: The debit and credit balance per account.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/aRYearViewType'
    changeRelationshipCriteriaType:
      type: object
      description: Information about the changes in relationship for the profile
      properties:
        changeRelationship:
          description: Information about the changes in relationship for the profile
          $ref: '#/components/schemas/changeRelationsInfoType'
        relationshipID:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        sourceRelation:
          description: Indicates the type of existing 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 existing relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetRelation:
          description: Indicates the type of existing 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 existing relationship the related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 200
    errorType:
      type: object
      description: Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.
      properties:
        value:
          type: string
          description: Property Value
        shortText:
          description: An abbreviated version of the error in textual format.
          type: string
        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
        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
        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
        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
        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})*'
        nodeList:
          description: An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional contraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.
          type: string
    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'
    benefitsType:
      type: array
      description: Basic information about membership benefit.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/benefitType'
    facilityTaskType:
      type: object
      description: Information regarding facility task on a reservation.
      properties:
        task:
          description: The Task Code.
          $ref: '#/components/schemas/housekeepingTaskCodeType'
        supplies:
          description: Supplies associated with the task.
          $ref: '#/components/schemas/facilityCodesType'
        date:
          description: The Date on which the task is applicable.
          type: string
          format: date
          maxLength: 8
    setProfileOwnersCriteriaType:
      type: object
      description: Criteria to update the profile owners.
      properties:
        profileIdList:
          description: Id of the profile of which its owners will be updated.
          $ref: '#/components/schemas/profileIdList'
        owners:
          description: Collection of owners that will be updated.
          $ref: '#/components/schemas/ownersType'
    downgradeType:
      type: string
      description: Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
      enum:
      - Grace
      - Never
      - Period
    codeDescriptionType:
      type: object
      description: This contains a generic code and description information.
      properties:
        code:
          description: Code.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: description.
          type: string
          minLength: 0
          maxLength: 2000
    profileOwners:
      type: object
      description: Request object to change profile owners.
      properties:
        criteria:
          description: Criteria to change the owners of a profile.
          $ref: '#/components/schemas/setProfileOwnersCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    surnameType:
      type: string
      description: Family name, last name.
      minLength: 0
      maxLength: 80
    sourceCodeInfoType:
      type: object
      properties:
        sourceCode:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        sourceGroup:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
    stagedProfileId:
      type: object
      description: Unique identifier for a staged profile.
      properties:
        hotelId:
          description: Hotel code for the staged profile to be reprocessed.
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: External profile ID to be reprocessed.
          $ref: '#/components/schemas/profileId'
    eCertificateToConsume:
      type: object
      description: Request object to Consume an E-Certificate.
      properties:
        consumeECertificates:
          description: Details to consume an E-Certificate.
          $ref: '#/components/schemas/eCertificatesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    ownerType:
      type: object
      description: Generic type for information about an owner.
      properties:
        hotel:
          description: Hotel to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        userId:
          description: Unique application user ID.
          $ref: '#/components/schemas/uniqueID_Type'
        userName:
          description: Unique application user name of the owner.
          type: string
          minLength: 0
          maxLength: 40
        ownerCode:
          description: Unique Code to identify the owner.
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: Unique owner profile information.
          $ref: '#/components/schemas/profileId'
        name:
          description: Provides name information of the owner.
          $ref: '#/components/schemas/personNameType'
        department:
          description: Department to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        email:
          description: Email information of the owner.
          $ref: '#/components/schemas/emailInfoType'
        phone:
          description: Information on the telephone number of the owner.
          $ref: '#/components/schemas/telephoneInfoType'
        relationship:
          description: Relationship of the owner within the profile or block.
          $ref: '#/components/schemas/codeDescriptionType'
        primary:
          description: When true, this is a primary owner.
          type: boolean
    checkedProfiles:
      type: object
      description: Response for checking allowed actions, existence of attached records, or indicators of a profile.
      properties:
        checkProfilesDetail:
          description: Collection of profiles and the status of its allowed actions, attached records, and indicators.
          $ref: '#/components/schemas/checkProfilesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    aRYearViewType:
      type: object
      description: Year information for an Year View.
      properties:
        dateRange:
          description: The period start and end date.
          $ref: '#/components/schemas/dateRangeType'
        balanceInfo:
          description: The balance amounts for this date range. Contains the Debit Balance, Credit Balance and the Total Balance.
          $ref: '#/components/schemas/aRBalanceType'
        runningTotal:
          description: The running total balance for the date range.
          $ref: '#/components/schemas/currencyAmountType'
    matchedProfiles:
      type: object
      description: Response object for the match profiles.
      properties:
        matchProfiles:
          description: A collection of match profiles.
          $ref: '#/components/schemas/matchProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stayRevenuesType:
      type: object
      properties:
        revenueAmount:
          description: Specifies the amount of revenue.
          type: number
        revenueBucketCode:
          description: Specifies the bucket code to which the revenue belongs.
          type: string
        transactionDate:
          description: Date on which the transaction was done.
          type: string
          format: date
      required:
      - revenueBucketCode
      - transactionDate
    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
    flexFieldsResponse:
      type: object
      description: Response object for flex fields.
      properties:
        flexFieldValues:
          description: List of flex fields.
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/flexFieldValueType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
        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
    checkProfileType:
      type: object
      description: Profile and the status of its allowed actions, attached records, and indicators.
      properties:
        profileId:
          description: Unique identifier of the profile.
          $ref: '#/components/schemas/profileId'
        results:
          description: Collection of status of allowed actions, attached records, and indicators of the profile.
          $ref: '#/components/schemas/checkProfileResultsType'
    profileDeliveryMethod:
      type: object
      description: Delivery Information type to the profile.
      properties:
        deliveryId:
          description: Delivery ID. It will be empty in case of new delivery method.
          $ref: '#/components/schemas/uniqueID_Type'
        deliveryType:
          description: Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.
          type: string
          minLength: 0
          maxLength: 20
        deliveryValue:
          description: Delivery value holds the corresponding value of the delivery type..
          type: string
          minLength: 0
          maxLength: 2000
        hotelId:
          description: Property that has delivery methods configured.
          type: string
          minLength: 0
          maxLength: 20
        deliveryModule:
          description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..'
          $ref: '#/components/schemas/profileDeliveryModuleType'
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    uniqueIDListType:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    traceType:
      type: object
      properties:
        timeInfo:
          description: Date of the trace.
          $ref: '#/components/schemas/traceTimeInfoType'
        reservationId:
          description: Reservation ID of the reservation for which the traces are to be retrieved.
          $ref: '#/components/schemas/reservationId'
        departmentId:
          description: Indicates the Department code.
          type: string
          minLength: 0
          maxLength: 20
        traceText:
          description: The information this trace contains.
          type: string
        resolveInfo:
          description: Information regarding the status of the trace
          $ref: '#/components/schemas/traceResolveType'
        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
        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
    commissionPaymentMethods:
      type: string
      description: Check
      enum:
      - Cent
      - Eft
      - Chk
    operaVersionNumberType:
      type: string
      description: Current Opera Version Number
      minLength: 0
      maxLength: 40
    stringLength80:
      type: string
      description: Used for Character Strings, length 0 to 80.
      maxLength: 80
      minLength: 0
    errorsType:
      type: array
      description: An error that occurred during the processing of a message.
      maxItems: 99
      items:
        $ref: '#/components/schemas/errorType'
    stagedProfileCompanyType:
      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
        errors:
          description: The error in stage profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileErrorType'
    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). 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
    guest:
      type: object
      description: Request object for creation of guest/contact/employee profile. This object contains profile details with unique identifiers of a profile. The standard optional Opera Context element is also included.
      properties:
        guestIdList:
          description: Unique identifiers of Profile for both internal and external systems.
          $ref: '#/components/schemas/profileIdList'
        externalReferences:
          description: External Reference information for Profile.
          $ref: '#/components/schemas/externalReferencesType'
        guestDetails:
          description: Provides detailed information of a customer profile.
          $ref: '#/components/schemas/guestProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    orphanStayRecord:
      type: object
      description: The request element used to update orphan stay record elements.
      properties:
        orphanStayRecord:
          description: This object stores the elements which user wants to update.
          $ref: '#/components/schemas/orphanStayRecordType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileSubscriptionsToSynchronize:
      type: object
      description: Request object for re-subscribing profile subscriptions.
      properties:
        criteria:
          description: Criteria to re-subscribe profile subscriptions.
          $ref: '#/components/schemas/synchronizeProfileSubscriptionsCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stagedProfileDateUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Date Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/stagedProfileDateUDFType'
    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
    suspendedProfilesErrorSummaryByPropertyType:
      type: object
      description: Type which represents a suspended profiles error by property information.
      properties:
        hotelId:
          description: Property where the error was found.
          type: string
          minLength: 0
          maxLength: 20
        errorCount:
          description: Count of how many suspended profiles encountered this error.
          type: integer
    countryNameType:
      type: object
      description: Code for a country or a nationality.
      properties:
        value:
          type: string
          description: Used for Character Strings, length 0 to 200.
          minLength: 0
          maxLength: 200
        code:
          description: Code for a country or a nationality.
          type: string
          minLength: 0
          maxLength: 20
    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'
    stagedReasonType:
      type: string
      description: Reasons why the profile got staged. InvalidExpirationDate indicates the membership expiration date is not matching with OPERA system. InvalidEnrollmentCode indicates the membership enrollment code is not matching with opera. NameChange indicates last name or first name is not matching with OPERA
      enum:
      - InvalidEnrollmentCode
      - EmptyEnrollmentCode
      - NameChange
      - InvalidExpirationDate
      - EmptyExpirationDate
      - EmptyMembershipLevel
      - InvalidMembershipLevel
      - DuplicateMembership
    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
    stagedProfileKeywordType:
      type: object
      properties:
        keywordDetail:
          description: The keyword new value, in case keyword value is modified.
          $ref: '#/components/schemas/keywordDetailType'
        errorDescription:
          description: The error in keyword information in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        keywordType:
          description: The type of keyword
          type: string
          minLength: 0
          maxLength: 20
        keyword:
          description: The keyword value.
          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
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    accountForecastsType:
      type: array
      description: Detail Information about Account Forecast.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/accountForecastType'
    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
    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
    profileDetails:
      type: object
      description: Response object for fetching multiple detailed profiles by unique identifiers..
      properties:
        profiles:
          description: Type contains Profile's primary details and it's children details.
          $ref: '#/components/schemas/profilesType'
        masterInfoList:
          description: Refer to Generic common types document.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/masterInfoType'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileMatchType:
      type: object
      properties:
        profileMatchType:
          description: Result of fetching profile matches.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/profileMatchTypeType'
    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
    forgetProfileResultType:
      type: object
      description: Results of Anonymization processing/validation.
      properties:
        profileId:
          description: Unique Identifier for OPERA Profile.
          $ref: '#/components/schemas/profileId'
        canBeForgotten:
          description: Indicates if the profile is eligible to be anonymized.
          type: boolean
        status:
          description: Anonymization Status of the Guest Profile.
          $ref: '#/components/schemas/anonymizationStatusType'
        failureReasons:
          description: Collection of reasons describing why the profile is not eligible to be anonymized.
          $ref: '#/components/schemas/forgetProfileFailureReasonListType'
    stayRecord:
      type: object
      properties:
        hotelId:
          description: Specifies the property name
          type: string
        stayDailyRates:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayDailyRatesType'
        stayMemberships:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayMembershipsType'
        stayProfiles:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayProfilesType'
        stayRecordsList:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayRecordsType'
        stayRevenuesDetails:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayRevenuesDetailsType'
    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
    suspendedProfilesErrorsSummaryByProfileTypeInfo:
      type: object
      description: Response object for fetch suspended profiles errors summary by profile type. This object contains a collection of profile types and the count of errors found in each type.
      properties:
        suspendedProfilesErrorsSummary:
          description: Indicates response of the suspended profiles errors summary by profileType.
          $ref: '#/components/schemas/suspendedProfilesErrorsSummaryByProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    stagedProfileTrxInfoType:
      type: object
      properties:
        description:
          description: Transaction codes info.
          type: string
          minLength: 0
          maxLength: 2000
        transactionGroup:
          description: Category of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        transactionSubGroup:
          description: Sub category of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        universalProductCode:
          description: Unique Universal product code of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        routingInstructionsId:
          description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.
          type: number
        articles:
          description: The List of Articles defined for this transaction code, when using the Articles functionality.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/articleInfoType'
        trxServiceType:
          description: Contains service type for transaction code.
          type: string
          minLength: 0
          maxLength: 20
        transactionCode:
          description: Unique identifier for the Transaction code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel context of the Transaction code.
          type: string
          minLength: 0
          maxLength: 20
        printTrxReceipt:
          description: Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.
          type: boolean
        errorDescription:
          description: The error in transaction code information in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        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
      description: Transaction codes info.
    allowedActionEnum:
      type: string
      enum:
      - NameChange
      - TaxIDChange
      - EnrollToPrimaryMembership
    awardDetails:
      type: object
      description: Response of fetch awards request.
      properties:
        profileAwards:
          description: Profile awards and certificates.
          $ref: '#/components/schemas/awardsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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'
    guestProfileTypeType:
      type: string
      description: The types of Profile handled by the web service.
      enum:
      - Guest
      - Employee
      - Contact
    suspendedProfilesMatchStats:
      type: object
      description: Response object for fetch suspended profiles match statistics.
      properties:
        suspendedProfilesMatch:
          description: Provides the information for suspended profiles match statistics.
          $ref: '#/components/schemas/suspendedProfilesMatchStatsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    formattedTextTextType:
      type: object
      description: Provides text and indicates whether it is formatted or not.
      properties:
        value:
          type: string
          description: Property Value
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
    aRAgingInfoType:
      type: object
      description: Information regarding the aging balances for an account.
      properties:
        totalOutstanding:
          description: The total debit and credit balance of the account.
          $ref: '#/components/schemas/aRBalanceType'
        aging:
          description: The debit and credit balance per Aging bucket.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/aRAgingType'
    relationshipCriteriaType:
      type: object
      description: Contains Criteria Information for a profile relationship.
      properties:
        primary:
          description: Indicates if this relationship is the primary relationship.
          type: boolean
        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).This needs to be passed if the attribute primary is sent as true.
          type: string
          minLength: 0
          maxLength: 200
        sourceProfileType:
          description: Used to specify a source profile type.
          $ref: '#/components/schemas/profileTypeType'
        targetRelation:
          description: Indicates 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 relationship the related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetProfileType:
          description: Used to specify a target profile type.
          $ref: '#/components/schemas/profileTypeType'
    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
    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
    profileToBeMerged:
      type: object
      description: Profile Resource will be merged.
      properties:
        victimProfileId:
          description: Provides detailed information regarding either a company or a customer profile.
          $ref: '#/components/schemas/uniqueIDListType'
        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'
        profileDetails:
          description: Provides detailed information regarding either a company or a customer profile.
          $ref: '#/components/schemas/profileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    guestHousekeepingServiceRequestType:
      type: string
      description: Possible values for the Guest Service Status.
      enum:
      - DoNotDisturb
      - MakeUpRoom
      - NoStatusSelected
    ownersType:
      type: array
      description: Generic type for a list of owners.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/ownerType'
    stagedProfileMembershipType:
      type: object
      properties:
        comment:
          description: Additional comments regarding to the membership.
          $ref: '#/components/schemas/paragraphType'
        newMembershipNumber:
          description: Card Number of the membership.
          type: string
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
        programDescription:
          description: Description of the membership program.
          type: string
        membershipLevel:
          description: Indicates the membership level.
          type: string
        membershipLevelDescription:
          description: Indicates the membership level description.
          type: string
          minLength: 0
          maxLength: 200
        membershipClass:
          description: Indicates the membership class.
          type: string
        earningPreference:
          description: Earning preference to the membership.
          $ref: '#/components/schemas/membershipEarningPreferenceType'
        inactive:
          description: Indicates whether membership is active or inactive.
          type: boolean
        benefits:
          description: benefits for the membership.
          $ref: '#/components/schemas/benefitsType'
        tierAdministration:
          description: Defines the degree of participation for this membership in the tier management portion of the program.
          $ref: '#/components/schemas/tierAdministrationType'
        downgrade:
          description: Defines how downgrading will be handled for this membership.
          $ref: '#/components/schemas/downgradeType'
        reIssueNewCard:
          description: The status of issuing new membership card to the member.
          $ref: '#/components/schemas/cardReIssueType'
        excludeFromBatch:
          description: True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.
          type: boolean
        upgradeDescription:
          description: Indicates Upgrade information which includes member's next tier level, 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: Source from where the enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        enrollmentResort:
          description: Resort/CRO where enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        preferredCard:
          description: Preferred Card.
          type: boolean
        membershipId:
          description: Card Number of the membership.
          type: string
        membershipType:
          description: Type of membership.
          type: string
        primaryMembershipYn:
          description: Indicator if Membership is a Primary Membership.
          type: string
          minLength: 0
          maxLength: 1
        primaryMembership:
          description: 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
        errorDescription:
          description: The error in membership information in a staged profile with an invalid status.
          type: string
          minLength: 0
          maxLength: 2000
        registrationResort:
          description: Registration resort.
          type: string
          minLength: 0
          maxLength: 20
        enrollmentCode:
          description: Enrollment code.
          type: string
          minLength: 0
          maxLength: 20
        membershipStatus:
          description: Membership status.
          type: string
          minLength: 0
          maxLength: 20
        inactiveDate:
          description: Inactivation date of the record.
          type: string
          format: date
          maxLength: 8
        deviceCode:
          description: Device encoded string.
          type: string
          minLength: 0
          maxLength: 200
        deviceDisabledDate:
          description: Device disabled date.
          type: string
          format: date
          maxLength: 8
        updateExistingMembership:
          description: Indicates if existing information for primary membership should be overwritten.
          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
      description: Detailed information of the memberships.
    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
    suspendedProfilesMatchStatsByProfileType:
      type: object
      description: Response object for fetch suspended profiles match statistics grouped by profile type.
      properties:
        suspendedProfilesMatchStatsByProfileType:
          description: Provides the information for suspended profiles match statistics grouped by profile type.
          $ref: '#/components/schemas/suspendedProfilesMatchStatsByProfileTypeType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileTransactions:
      type: object
      description: Response of the WS operation FetchProfileTransactions.
      properties:
        profileTransactions:
          description: Transactions related to the Profile.
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/profileTransactionsType'
        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'
    fulfillmentExportedLogs:
      type: object
      description: Optional elements whether to update exclude extract or delivery status in membership fulfillment
      properties:
        fulfillmentExportLogs:
          description: This type holds list of export logs information for the membership fulfillment .
          $ref: '#/components/schemas/fulfillmentExportLogsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileCashieringDetailsInfo:
      type: object
      description: Response object containing profile routing instructions.
      properties:
        profileCashieringDetailList:
          description: Cashiering details for the profile.
          type: array
          items:
            $ref: '#/components/schemas/profileCashieringDetailType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    mergedProfilesSnapshotDetails:
      type: object
      description: Response object for fetching snapshot of merge profiles result.
      properties:
        mergedProfileSnapshot:
          $ref: '#/components/schemas/mergedProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    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
    stagedProfileBillingInstructionType:
      type: object
      properties:
        desc:
          description: Billing Instruction code description.
          type: string
          minLength: 0
          maxLength: 2000
        routingInstructionsId:
          description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.
          type: number
        billingCode:
          description: Unique identifier for the Billing Instruction.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel context of the Billing Instruction.
          type: string
          minLength: 0
          maxLength: 20
        errorDescription:
          description: The error in billing instruction information in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        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
      description: Configured Billing Instruction which represents a set of Transaction Codes.
    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
    stagedProfileErrorType:
      type: object
      description: Criteria to fetch the staged profile.
      properties:
        field:
          description: The field that has error.
          $ref: '#/components/schemas/stagedProfileErrorField'
        errorDescription:
          description: The error description for the staged profile.
          type: string
          minLength: 0
          maxLength: 2000
    reservationDepositType:
      type: object
      description: Reservation Deposit Type.
      properties:
        amountRequired:
          description: Deposit Amount Required.
          type: number
        amountPaid:
          description: Deposit Amount Paid.
          type: number
        amountOwed:
          description: Deposit Amount Owed.
          type: number
        dueDate:
          description: Deposit Due Date.
          type: string
          format: date
          maxLength: 8
        postingDate:
          description: Deposit Posting Date.
          type: string
          format: date
          maxLength: 8
        hasPaid:
          description: Resolves whether reservation has paid deposit.
          type: boolean
        hasOutstanding:
          description: Resolves whether reservation has outstanding deposit.
          type: boolean
    profileMembershipType:
      type: object
      description: Detailed information of the memberships.
      properties:
        comment:
          description: Additional comments regarding to the membership.
          $ref: '#/components/schemas/paragraphType'
        newMembershipNumber:
          description: Card Number of the membership.
          type: string
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
        programDescription:
          description: Description of the membership program.
          type: string
        membershipLevel:
          description: Indicates the membership level.
          type: string
        membershipLevelDescription:
          description: Indicates the membership level description.
          type: string
          minLength: 0
          maxLength: 200
        membershipClass:
          description: Indicates the membership class.
          type: string
        earningPreference:
          description: Earning preference to the membership.
          $ref: '#/components/schemas/membershipEarningPreferenceType'
        inactive:
          description: Indicates whether membership is active or inactive.
          type: boolean
        benefits:
          description: benefits for the membership.
          $ref: '#/components/schemas/benefitsType'
        tierAdministration:
          description: Defines the degree of participation for this membership in the tier management portion of the program.
          $ref: '#/components/schemas/tierAdministrationType'
        downgrade:
          description: Defines how downgrading will be handled for this membership.
          $ref: '#/components/schemas/downgradeType'
        reIssueNewCard:
          description: The status of issuing new membership card to the member.
          $ref: '#/components/schemas/cardReIssueType'
        excludeFromBatch:
          description: True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.
          type: boolean
        upgradeDescription:
          description: Indicates Upgrade information which includes member's next tier level, 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'
            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
    profilesMatch:
      type: object
      description: Response object for fetching the profiles match.
      properties:
        profilesMatchList:
          type: array
          description: List of profiles matches. The values are ordered by default using main profile first name.
          maxItems: 200
          items:
            $ref: '#/components/schemas/profilesMatchType'
        offset:
          description: Indicates the index of the next applicable set(page).
          type: integer
        limit:
          description: Indicates number of records the API can return as per the API request limit sent. A maximum of 200 records can be only returned at a time.
          type: integer
        count:
          description: Indicates number of records the API has returned actually as per the API request criteria.
          type: integer
        hasMore:
          description: Indicates whether there are more records available to be returned as per the API request criteria or not.
          type: boolean
        totalResults:
          description: Indicates total number of records available that can be returned as per the API request criteria.
          type: integer
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stayProfilesType:
      type: object
      properties:
        primary:
          description: Checks if the profile is primary.
          type: boolean
        nameId:
          description: Specifies the unique id that is assigned to a profile.
          type: number
        pmsNameId:
          description: Specifies the pms id that is assigned to a profile.
          type: string
        profileRole:
          description: Describes the role associated with the profile.
          type: string
      required:
      - profileRole
    searchStagedProfilesRequest:
      type: object
      properties:
        limit:
          type: integer
          description: Indicates maximum number of records a Web Service should return.
        offset:
          type: integer
          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.
          default: 0
        hotelIds:
          type: array
          items:
            type: string
            maxItems: 4000
        stagedReasons:
          type: array
          description: 'This can be used to fetch staged profiles based on the reason why it got staged Ex : NameChange'
          items:
            $ref: '#/components/schemas/stagedReasonsEnum'
        id:
          type: array
          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.
          items:
            type: string
        idContext:
          type: array
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          items:
            type: string
        type:
          type: array
          description: A reference to the type of object defined by the UniqueID element.
          items:
            type: string
        name:
          type: string
          description: Family name, last name or Company Name.
        givenName:
          type: string
          description: Given name, first name or names.
        region:
          type: string
          description: The profile region for which the staged profiles shall be fetched.
        countryCode:
          type: string
          description: Code for a country or a nationality.
        profileType:
          type: string
          description: Profile type to be included in the search.
        importDate:
          type: string
          format: date
          description: The date on which the staged profiles have been received. This parameter is deprecated.
        stageStatus:
          type: string
          description: The status of the staged profiles.
        applyTo:
          $ref: '#/components/schemas/applyToEnum'
          description: Membership filter of staged profiles.
        membershipCodes:
          type: array
          items:
            type: string
            maxItems: 4000
        insertDateFrom:
          type: string
          format: date
          description: Accepts a date value and retrieves all the suspended profiles inserted on or after the provided date.
        insertDateTo:
          type: string
          format: date
          description: Accepts a date value and retrieves all the suspended profiles inserted up to and including the specified date.
        membershipNumber:
          type: string
          description: Accepts a membership number and retrieves the suspended profile(s) associated with the provided code.
          maxLength: 40
        clientID:
          type: string
          description: Accepts a client ID number and retrieves the suspended profile(s) associated with the provided code.
        errorDescription:
          type: string
          description: The error description for the staged profile.
          maxLength: 200
    changedMembership:
      type: object
      description: Response object for change/update membership. This object contains collection of memberships,Success,Warnings and Errors related to this operation
      properties:
        profileMemberships:
          description: Detailed information of membership related to the profile
          type: array
          items:
            $ref: '#/components/schemas/profileMembershipType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    searchProfileMatchesRequest:
      type: object
      properties:
        lastName:
          type: string
          description: Last name of the user
        firstName:
          type: string
          description: First name of the user
        AddressLine1:
          type: string
          description: First Line of Street Address. For profile search it matches the first Address line.
        AddressLine2:
          type: string
          description: Second Line of Street Address. For profile search it matches the first Address line.
        city:
          type: string
          description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
        state:
          type: string
          description: State or Province name (e.g., Texas).
        postalCode:
          type: string
          description: Post Office Code number.
        country:
          type: string
          description: Country Address
        email:
          type: string
          description: Email linked to the user.
        phone:
          type: string
          description: Telephone linked to the user.
        matchPercentage:
          type: number
          description: match percentage criteria will exceed.
        legalCompany:
          type: string
          description: Name Of the company the individual is associated with.
    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
    suspendedProfilesMatchStatsByProfileTypeType:
      type: object
      description: Ssuspended profiles match statistics grouped by profile type.
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        matchStatsInfo:
          type: array
          description: Collection of suspended profiles match statistics grouped by profile type.
          items:
            $ref: '#/components/schemas/suspendedProfilesMatchStatByProfileType'
            maxItems: 100
    stagedProfileRoutingInstructionType:
      type: object
      properties:
        transactionInfo:
          description: Transaction code information in a staged profile with an invalid status
          $ref: '#/components/schemas/stagedProfileTrxInfoType'
        billingInstruction:
          description: Configured Billing Instruction in a staged profile with an invalid status
          $ref: '#/components/schemas/stagedProfileBillingInstructionType'
    profileTransactionsType:
      type: object
      description: Transaction related to the Profile.
      properties:
        transactionDate:
          description: Stay Record or Membership Transaction Date.
          type: string
          format: date
        transactionType:
          description: Stay Record or Membership Transaction Type.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Resort of the transaction.
          type: string
          minLength: 0
          maxLength: 20
        reservationIdList:
          description: The PMS confirmation number of the transaction.
          $ref: '#/components/schemas/reservationIdList'
        pointsCalculated:
          description: Flag to indicate if points are calculated.
          type: boolean
        reference:
          description: User-defined reference field for the Membership Transaction Adjustment.
          type: string
          minLength: 1
          maxLength: 20
        stayTimeSpan:
          description: Begin and end dates of the reservation.
          $ref: '#/components/schemas/timeSpanType'
        membershipType:
          description: The type of membership.
          type: string
          minLength: 0
          maxLength: 20
        cardNumber:
          description: The membership card number.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The level of the membership.
          type: string
          minLength: 0
          maxLength: 20
        awardPoints:
          description: Award points for the transactions.
          type: integer
        tierNightPoints:
          description: Tier Night points for the transactions.
          type: integer
        tierStayPoints:
          description: Tier Stay points for the transactions.
          type: integer
        tierRevenuePoints:
          description: Tier Revenue points for the transactions.
          type: integer
        pointsCreditDate:
          description: Date when points were created.
          type: string
          format: date
        stayRecordId:
          description: Stay Record Id of the transaction.
          type: string
        membershipTransactionId:
          description: Unique ID of the membership transaction that this record corresponds to
          $ref: '#/components/schemas/membershipTransactionId'
        membershipId:
          description: Unique identifier of this membership.
          $ref: '#/components/schemas/uniqueID_Type'
        profileIdList:
          description: Collection of unique profile identifiers
          $ref: '#/components/schemas/profileIdList'
    suspendedAddressesType:
      type: object
      description: List of suspended addresses returned, based on the entered seach criteria.
      properties:
        suspendedAddressesInfo:
          description: A collection of suspended Addresses.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/suspendedAddressesInfoType'
        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
        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
        totalPages:
          description: Evaluated total page count based on the requested max fetch count.
          type: integer
    suspendedProfilesErrorsSummaryByPropertyType:
      type: object
      description: Suspended profiles errors summary by property.
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        errorSummaryInfo:
          type: array
          description: Collection of suspended profiles errors summary by property.
          items:
            $ref: '#/components/schemas/suspendedProfilesErrorSummaryByPropertyType'
            maxItems: 100
    telephoneInfoType:
      type: object
      description: Information on a telephone number for the customer.
      properties:
        telephone:
          description: Phone details for the profile.
          $ref: '#/components/schemas/telephoneType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    profileSummaries:
      type: object
      description: Response object for fetching profiles. This object contains profile primary details,profile summary details,master info list containing code and description used as lookup for description.
      properties:
        profileSummaries:
          description: Type contains Profile's summary information.
          $ref: '#/components/schemas/profileSummariesType'
        masterInfoList:
          description: Refer to Generic common types document.
          type: array
          items:
            $ref: '#/components/schemas/masterInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    dateTimeStampGroupType:
      type: object
      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
    hasFuturePastBookingsSearchType:
      type: object
      description: Search type for verifying whether there are future and/or past business blocks and/or reservations exist for a Profile.
      properties:
        profileIdList:
          description: Unique identifier of the profile to be searched.
          $ref: '#/components/schemas/profileIdList'
        searchFor:
          description: Search for active or past.
          type: string
          enum:
          - Active
          - Past
        searchIn:
          description: Search in business blocks or reservations.
          type: string
          enum:
          - Block
          - Reservation
        rateCode:
          description: Unique identifier of the rate code of business block or reservation.
          type: string
          minLength: 0
          maxLength: 20
        exclusions:
          description: Search to exclude list of reservations and/or business blocks.
          $ref: '#/components/schemas/hasFuturePastBookingsExclusionsType'
    stagedProfileSourceType:
      type: string
      enum:
      - Screen
      - Interface
    futurePastBookings:
      type: object
      description: This is the Response Message to information regarding existence of profile in future and/or past business blocks and/or reservations.
      properties:
        response:
          description: response - whether there are future and/or past business blocks or reservations for the profile.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    relatedProfileTypeEnum:
      type: string
      enum:
      - Guest
      - Agent
      - Company
      - Group
      - Source
      - Employee
      - Hotel
      - Vendor
      - Contact
      - Purge
      - BusinessHeader
      - BillingAccount
      - Activity
      - Potential
      - Account
    stagedProfileSummaryType:
      type: object
      description: Basic information about staged profile.
      properties:
        hotelId:
          description: Hotel code associated with the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        profileIdList:
          description: List of unique identifier of staged profile.
          $ref: '#/components/schemas/uniqueIDListType'
        profileName:
          description: Name information for the staged profile.
          $ref: '#/components/schemas/profileNameType'
        internalProfileName:
          description: Indicates name information present in OPERA for a staged profile.
          $ref: '#/components/schemas/profileNameType'
        primaryMembershipCardNo:
          description: Indicates the primary membership card number of a staged profile
          type: string
          minLength: 0
          maxLength: 40
        membershipEnrollmentCode:
          description: Membership enrollment code of a staged profile.
          type: string
          maxLength: 40
        membershipExpirationDate:
          description: Indicates the expiry date of a staged membership profile.
          type: string
          format: date
        membershipLevel:
          description: Indicates the membership level of a staged membership profile.
          type: string
          minLength: 0
          maxLength: 20
        stagedProfileReasons:
          description: Describes the reasons why a profile got staged.
          type: array
          maxItems: 8
          items:
            $ref: '#/components/schemas/stagedReasonsType'
        importDate:
          description: The date on which the staged profile has been received.
          type: string
          format: date
          maxLength: 8
        profileType:
          description: Type of the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        region:
          description: The region of the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        country:
          description: The country of residence where the property is located that has received the staged profile.
          $ref: '#/components/schemas/countryNameType'
        stageStatus:
          description: The status of the staged profiles.
          $ref: '#/components/schemas/stagedProfileStatus'
    activityLogListType:
      type: object
      properties:
        activityLog:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/activityLogType'
        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
    awardType:
      type: object
      description: Detailed information of the awards.
      properties:
        awardCode:
          description: Award category.
          type: string
          minLength: 0
          maxLength: 20
        awardType:
          description: Can be P (Paper) or E (E-Certificate).
          $ref: '#/components/schemas/awardKindType'
        description:
          description: Description of the award/certificate.
          type: string
        certificateNo:
          description: Certificate No.
          type: string
          minLength: 0
          maxLength: 20
        masterCertificiateNo:
          description: Master Certificate No.
          type: string
          minLength: 0
          maxLength: 20
        membershipNo:
          description: Membership No.
          type: string
        hotelId:
          description: Hotel Code for which the routing instructions are provided for a profile.
          type: string
          minLength: 0
          maxLength: 20
        hotelCategory:
          description: Indicates the lowest hotel category for which the certificate is valid.
          type: string
          minLength: 0
          maxLength: 20
        externalHotelCode:
          description: Hotel Code of the CRS application that this certificate belongs to.
          type: string
          minLength: 0
          maxLength: 20
        externalConfirmationNo:
          description: Confirmation Number given by a CRS application for this reservation.
          type: string
          minLength: 0
          maxLength: 20
        categoryValid:
          description: Indicates whether the category of certificate is valid or not for this resort.
          type: boolean
        reservationCertificateType:
          description: '[R]=Reward, [I]=Incentive.'
          $ref: '#/components/schemas/reservationCertificateType'
        rewardCertificateType:
          description: '[RE]=Regular Certificate, [SA]=Stay Anytime Certificate, [PS]=Point Saver Certificate.'
          $ref: '#/components/schemas/rewardCertificateType'
        status:
          description: Status of the award aka available.
          $ref: '#/components/schemas/awardStatusType'
        expirationDate:
          description: Expiration Date.
          type: string
          format: date
          maxLength: 8
        gift:
          description: Signifies whether award is gift or not.
          type: boolean
        upgrade:
          description: Signifies whether upgrade award or not.
          type: boolean
        package:
          description: Signifies whether upgrade is package or not.
          type: boolean
        instantlyRedeemable:
          description: Indicates if the award is an Instant Redemption award.
          type: boolean
        paidUpgrade:
          description: Indicates if this certificate was ordered using the "Paid Upgrade" option in the E-Certs screen.
          type: boolean
        detailedCertificate:
          description: Indicates if this certificate is detailed or not.
          type: boolean
        nights:
          description: Award Nights.
          type: integer
        sourceType:
          description: 'MRW : From MRW MAN:Entered manually.'
          type: string
        points:
          description: No. of points used to order this award.
          type: number
        fBAInfo:
          description: FBA related fields.
          $ref: '#/components/schemas/fBAInfoType'
        reservationId:
          description: Reservation IDs will be empty if award is not attached.
          $ref: '#/components/schemas/reservationId'
        profileId:
          description: Unique profile identifier requested to be fetched.
          $ref: '#/components/schemas/profileId'
        quantity:
          description: Quantity of such awards needed to be ordered.
          type: integer
        displaySequence:
          description: Indicates the order in which the certificates received from MRW.
          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
    identificationInfoType:
      type: object
      description: Information on the identification of the customer.
      properties:
        identification:
          description: Detailed information on the identification of the customer.
          $ref: '#/components/schemas/identificationType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    masterInfoCodeDetailType:
      type: string
      enum:
      - LongDescription
      - ShortDescription
    profileSummaryType:
      type: object
      description: Type provides the basic information about the profile.
      properties:
        formerName:
          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'
            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})*'
            customerValue:
              description: The supplier's ranking of the customer (e.g., VIP, numerical ranking).
              type: string
              minLength: 0
              maxLength: 20
        altName:
          description: Profile Name information for this profile.
          $ref: '#/components/schemas/profileNameType'
        anonymization:
          description: Provides information about the guest's anonymization status
          $ref: '#/components/schemas/anonymizationType'
        addressInfo:
          description: Detailed information on an address for the customer.
          $ref: '#/components/schemas/addressInfoType'
        telephoneInfo:
          description: Detailed information on telephone/ fax for the customer.
          $ref: '#/components/schemas/telephoneInfoType'
        emailInfo:
          description: Detailed information on an eMail address for the customer.
          $ref: '#/components/schemas/emailInfoType'
        profileMembership:
          description: Information on membership for the customer.
          $ref: '#/components/schemas/profileMembershipType'
        uRLInfo:
          description: Detailed information on web url/address for the customer.
          $ref: '#/components/schemas/uRLInfoType'
        citizenCountry:
          description: Name of the (self-professed) country that is claimed for citizenship.
          $ref: '#/components/schemas/countryNameType'
        profileIndicators:
          description: Indicators of additional information attached to the profile
          $ref: '#/components/schemas/indicatorsType'
        searchMatches:
          description: Super Search matching terms.
          $ref: '#/components/schemas/searchMatchesType'
        profileAccessType:
          description: Detailed information on access type associated with the profile.Information on whether the profile is created in CRO/Hotel/Chain.
          $ref: '#/components/schemas/profileAccessType'
        profileRestrictions:
          description: Detailed information on restrictions associated with the profile.
          $ref: '#/components/schemas/profileRestrictions'
        vipStatus:
          description: VIP status of the customer.
          $ref: '#/components/schemas/vIPStatusType'
        owners:
          description: Owner of the customer.
          $ref: '#/components/schemas/ownersType'
        primaryCompany:
          description: Primary Company of the profile.
          type: string
        aRAccount:
          description: AR Account information.
          $ref: '#/components/schemas/directBillingType'
        commission:
          description: Commission Code and description of the requested HotelCode.
          $ref: '#/components/schemas/codeDescriptionType'
        taxInfo:
          description: Profile information about tax.
          $ref: '#/components/schemas/profileTaxInfoType'
        cashiering:
          description: Contains cashiering related details for the profile
          $ref: '#/components/schemas/profileCashieringType'
        lastStayInfo:
          description: Information on last stay of the profile.
          $ref: '#/components/schemas/lastStayInfoType'
        allowedActions:
          description: Collection of allowed actions for profile search.
          $ref: '#/components/schemas/profileAllowedActionsType'
        primaryAccountInfo:
          description: Contains primary account information (Profile Id, Profile Type and Profile Name) for the contacts.
          $ref: '#/components/schemas/primaryProfileInfoType'
        salesInfo:
          description: Sales information of the profile.
          $ref: '#/components/schemas/salesInfoType'
        additionalInfo:
          description: Additional Information about the profile.
          $ref: '#/components/schemas/profileAdditionalInfoType'
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
        subscription:
          description: This element tells If there is an active subscription for this external profile .
          type: boolean
        statusCode:
          description: Status of the profile. Active/Inactive
          $ref: '#/components/schemas/profileStatusType'
        protected:
          description: What level this profile is protected.
          type: string
          minLength: 0
          maxLength: 40
        privateProfile:
          description: This element tells profile is property exclusive or not.
          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
        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
        registeredProperty:
          description: Property this profile is registered with.
          type: string
          minLength: 0
          maxLength: 20
        profileSourceCode:
          description: Original Source Code for profile. It is used as reference to identify the source of Profile.
          type: string
          minLength: 0
          maxLength: 2000
    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
    overrideForecastTypeType:
      type: string
      description: Defines values for OverrideForecastType.
      enum:
      - Default
      - Override
      - DoNotOverride
    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
    suspendedProfilesErrorSummaryByProfileType:
      type: object
      description: Type which represents a suspended profiles error by profile type.
      properties:
        profileType:
          description: Type of the suspended profile.
          $ref: '#/components/schemas/suspendedProfileType'
        errorCount:
          description: Count of how many suspended profiles encountered this error.
          type: integer
    matchCriteriaListType:
      type: object
      description: Type which represents suspended profiles match statistics grouped by profile type with detailed view
      properties:
        matchCriteria:
          description: Criteria used to for matching two profiles.
          type: string
          minLength: 0
          maxLength: 80
        count:
          description: Number of records with this property.
          type: integer
    suspendedProfilesMatchStatType:
      type: object
      description: Type which represents suspended profiles match statistics information.
      properties:
        matchCriteria:
          description: Criteria used to for matching two profiles.
          type: string
          minLength: 0
          maxLength: 80
        importDate:
          description: Indicates the date when this suspended profile match was inserted into the table
          type: string
          format: date
        points:
          description: Indicates the number of points that this match generated.
          type: number
        orderSequence:
          description: Display order sequence.
          type: number
        processTime:
          description: Process time during match.
          type: number
        hotelId:
          description: Hotel code of the profile's origin.
          type: string
          minLength: 0
          maxLength: 20
        profileType:
          description: Type of the suspended profile.
          $ref: '#/components/schemas/suspendedProfileType'
    eCertificateToExtend:
      type: object
      description: Request object to Consume an E-Certificate.
      properties:
        certificateId:
          description: System generated unique certificate id.
          type: integer
        expiryDate:
          description: Indicates E-Certificate extended expiry date.
          type: string
          format: date
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stagedProfileCharacterUDFType:
      type: object
      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
        errorDescription:
          description: The error in a user defined field in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        tableName:
          description: PMS table name.
          type: string
          minLength: 0
          maxLength: 40
        valid:
          description: Indicates whether the UDF information is valid.
          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
      description: Used to hold user defined field of Character/String Type.
    fixedChargeScheduleType:
      type: object
      description: Holds schedule of fixed charge.
      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
        frequency:
          description: Frequency of a fixed charge.
          $ref: '#/components/schemas/fixedChargeFrequencyType'
        dayToExecute:
          description: Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.
          type: string
          minLength: 0
          maxLength: 3
        dateToExecute:
          description: Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.
          type: string
          format: date
          maxLength: 8
    profileMatch:
      type: object
      description: Response object for fetching profile Match.
      properties:
        profileId:
          description: The profile Id for which the details matched.
          $ref: '#/components/schemas/profileId'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    suspendedProfilesMatchStatsByThreshold:
      type: object
      description: Response object for fetch suspended profiles match statistics filtered by threshold type.
      properties:
        suspendedProfilesMatchStatsByThreshold:
          description: Provides the information for suspended profile match statistics filtered by threshold type.
          $ref: '#/components/schemas/suspendedProfilesMatchStatsByThresholdType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stayRecordDetails:
      type: object
      description: Complex type that contains stay record details
      properties:
        stayRecord:
          description: Contains stay record details
          $ref: '#/components/schemas/stayRecord'
    stayRecordDetail:
      type: object
      description: Stay Record details for a single stay record including Revenues, Daily Rates and UDFs.
      properties:
        stayDetail:
          description: Stay Details of the stay record.
          $ref: '#/components/schemas/stayDetailType'
        revenue:
          description: Revenue Details for the stay record.
          type: array
          maxItems: 200
          items:
            $ref: '#/components/schemas/membershipTransactionRevenueType'
        rate:
          description: Rate Details for the stay record.
          type: array
          maxItems: 200
          items:
            $ref: '#/components/schemas/membershipTransactionRateType'
        userDefinedFields:
          description: Collections of user defined fields (UDFs) for the stay record.
          $ref: '#/components/schemas/userDefinedFieldsType'
        warnings:
          $ref: '#/components/schemas/warningsType'
    trxInfoType:
      type: object
      description: Transaction codes info.
      properties:
        description:
          description: Transaction codes info.
          type: string
          minLength: 0
          maxLength: 2000
        transactionGroup:
          description: Category of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        transactionSubGroup:
          description: Sub category of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        universalProductCode:
          description: Unique Universal product code of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        routingInstructionsId:
          description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.
          type: number
        articles:
          description: The List of Articles defined for this transaction code, when using the Articles functionality.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/articleInfoType'
        trxServiceType:
          description: Contains service type for transaction code.
          type: string
          minLength: 0
          maxLength: 20
        transactionCode:
          description: Unique identifier for the Transaction code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel context of the Transaction code.
          type: string
          minLength: 0
          maxLength: 20
        printTrxReceipt:
          description: Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.
          type: boolean
    suspendedProfilesErrorsSummaryType:
      type: object
      description: Profiles errors summary type.
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        errorsSummaryInfo:
          type: array
          description: Collection of profiles errors summary.
          items:
            $ref: '#/components/schemas/suspendedProfilesErrorSummaryType'
            maxItems: 100
    flexFieldValues:
      type: object
      description: Request object for flex fields values.
      properties:
        flexFieldInfo:
          description: Provides information about flex fields
          $ref: '#/components/schemas/flexFieldValueType'
        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
    profileTypesListType:
      type: object
      description: Type which represents suspended profiles match statistics grouped by profile type with detailed view
      properties:
        profileType:
          description: Type of the suspended profile.
          $ref: '#/components/schemas/suspendedProfileType'
        matchCriteriasListInfo:
          type: array
          description: Collection of suspended profiles match statistics grouped by match criteria with count
          items:
            $ref: '#/components/schemas/matchCriteriaListType'
            maxItems: 100
        count:
          description: Number of records with this property.
          type: integer
    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'
    stagedProfileErrorField:
      type: string
      description: Simple type for stage profile error filed to specify which filed in the stage profile has error.
      enum:
      - PrimaryLanguage
      - AlternateLanguag
      - Gender
      - ProfileType
      - Nationality
      - Prefix
      - VIPStatus
    eCertificateConsumptionType:
      type: object
      description: E-Certificates details.
      properties:
        hotelId:
          description: Property where certificate was consumed for.
          type: string
          minLength: 0
          maxLength: 20
        source:
          description: Source of consumption.
          $ref: '#/components/schemas/eCertificateConsumeSourceType'
        surname:
          description: Last name of the person who consumed the certificate..
          type: string
          minLength: 0
          maxLength: 40
        firstName:
          description: First name of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 40
        middleName:
          description: Middle name of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 40
        email:
          description: Email of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 2000
        date:
          description: Date the certificate was consumed.
          type: string
          format: date
          maxLength: 8
        userName:
          description: Application user who created the consumption.
          type: string
          minLength: 0
          maxLength: 2000
        userNotes:
          description: Any notes on the certificate entered at time of consumption.
          type: string
          minLength: 0
          maxLength: 4000
        referenceId:
          description: Any reference like reservation no etc against which the certificate was consumed.
          $ref: '#/components/schemas/uniqueID_Type'
        locationType:
          description: Consumption location type.
          type: string
          minLength: 0
          maxLength: 20
        authorizationCode:
          description: Authorization code for consumption.
          type: string
          minLength: 0
          maxLength: 100
        serviceDate:
          description: Date on which the service is due (arrival date in case of reservation).
          type: string
          format: date
          maxLength: 8
    suspendedProfilesMatchStatByThresholdType:
      type: object
      description: Type which represents suspended profiles match statistics information.
      properties:
        matchCriteria:
          description: Criteria used for matching two profiles.
          type: string
          minLength: 0
          maxLength: 80
        hotelId:
          description: Hotel code of the profile's origin.
          type: string
          minLength: 0
          maxLength: 20
        count:
          description: Number of records with this match criteria and property.
          type: integer
    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'
    suspendedProfilesMatchStatByProperty:
      type: object
      description: Type which represents suspended profiles match statistics grouped by profile type.
      properties:
        matchCriteria:
          description: Criteria used to for matching two profiles.
          type: string
          minLength: 0
          maxLength: 80
        hotelId:
          description: Property where the match was found.
          type: string
          minLength: 0
          maxLength: 20
        count:
          description: Number of records with this match criteria and property.
          type: integer
    forgetProfilesCriteria:
      type: object
      description: Operation to validate profiles for forgetting.
      properties:
        validateForgetProfilesCriteria:
          description: Criteria to identify the profiles to be validated for forgetting.
          $ref: '#/components/schemas/forgetProfilesCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    awardsType:
      type: array
      description: List of awards.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/awardType'
    givenNameType:
      type: string
      description: Given name, first name or names
      minLength: 0
      maxLength: 40
    aRAgingType:
      type: object
      description: Aging information for an Aging Bucket.
      properties:
        agingBucketRange:
          description: 'The bucket description in terms of days. Example : 0-31 days'
          type: string
          minLength: 0
          maxLength: 20
        agingDate:
          description: The start date and end date for this Aging bucket.
          $ref: '#/components/schemas/dateRangeType'
        balanceInfo:
          description: The balance amounts for this bucket. Contains the Debit Balance, Credit Balance and the Total Balance.
          $ref: '#/components/schemas/aRBalanceType'
        agingStartDay:
          description: 'The start number of days for this Aging bucket. Example: For the range 31-60 days, this would be 31.'
          type: integer
        agingEndDay:
          description: 'The end number of days for this Aging bucket. Example: For the range 31-60 days, this would be 60.'
          type: integer
        sequence:
          description: The sequence for display.
          type: integer
    suspendedProfilesMatchStatsByPropertyType:
      type: object
      description: Suspended profile match statistics grouped by property.
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        matchStatsInfo:
          type: array
          description: Collection of suspended profile match statistics grouped by property.
          items:
            $ref: '#/components/schemas/suspendedProfilesMatchStatByProperty'
            maxItems: 100
    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
    fulfillmentExportLogsType:
      type: array
      description: This type holds the export log information for the membership fulfillment record.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/fulfillmentExportInfoType'
    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
    membership:
      type: object
      description: Request object for create membership. This object contains unique identifiers for each profile and list of membership details to be created. The standard optional Opera Context element is also included.
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.
          $ref: '#/components/schemas/profileIdList'
        profileMemberships:
          description: Detailed information of membership related to the profile
          type: array
          items:
            $ref: '#/components/schemas/profileMembershipType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    searchTypeEnum:
      type: string
      enum:
      - PurgeableProfiles
      - Any
      - PatronTrackingSystemMemberProfiles
    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'
    forgetProfilesCriteriaType:
      type: object
      description: Criteria to identify the profiles to be forgotten.
      properties:
        profiles:
          description: Collection of Unique Identifiers of profiles to be forgotten.
          $ref: '#/components/schemas/profiles'
        centralProfiles:
          description: Collection of Unique Identifiers of profiles to be forgotten.
          $ref: '#/components/schemas/profiles'
    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
    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
    membershipTierProjections:
      type: object
      description: Response object for fetching Membership Tier Process Text.
      properties:
        membershipTierProjection:
          description: Membership tier upgrade/downgrade projection.
          $ref: '#/components/schemas/membershipTierProjectionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stageProfileMatchesType:
      type: object
      properties:
        stageprofileMatches:
          description: Results of matching profiles for the stage profile.
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/stageProfileMatchType'
    reProcessStageRecordResultType:
      type: object
      description: Information about the staged profile after processing.
      properties:
        hotelId:
          description: Hotel Code for the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        resortNameId:
          description: The resulting resort name id after processing the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        stageStatus:
          description: The resulting profile status after processing the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        result:
          description: Processing/Rematching result for the staged profile.
          type: string
          minLength: 0
          maxLength: 4000
        errorDescription:
          description: Error message describing the cause of failure in processing the given staged profile.
          type: string
          minLength: 0
          maxLength: 4000
    profilesMatchType:
      type: object
      description: Type that contains the information of a profile match such as main profile, profile to merge, match id, status of the match, date when the points where computed for last time, etc.
      properties:
        matchId:
          description: Unique identifier for this particular profile match record.
          type: string
          minLength: 0
          maxLength: 80
        mainProfile:
          description: Information of main profile.
          $ref: '#/components/schemas/shortInfoProfileType'
        profileToMerge:
          description: Information of profile that will be merged to the main profile.
          $ref: '#/components/schemas/shortInfoProfileType'
        rule:
          description: Match criteria rule code that was used to create that match.
          type: string
          minLength: 0
          maxLength: 400
        matchCriteria:
          description: Description of the match point for the profile merge.
          type: string
          minLength: 0
          maxLength: 4000
        points:
          description: Total number of weighing match points that was found between main profile and profile to merge.
          type: number
          minimum: 0
        status:
          description: 'Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.'
          $ref: '#/components/schemas/profileMatchStatusType'
        computedOn:
          description: Date when the weighing points were computed for the profiles
          type: string
          format: date
          minLength: 0
          maxLength: 20
        doNotMerge:
          description: If this value is true, then this record is set as do not merge, if false, it is set as merge.
          type: boolean
        processingMessage:
          description: Description of the processing message while merging profiles.
          type: string
          minLength: 0
          maxLength: 4000
    accountForecasts:
      type: object
      description: Response object for showing forecast information of account profile.
      properties:
        accountForecastDetails:
          description: Type contains forecast information of the account profile.
          $ref: '#/components/schemas/accountForecastsType'
        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'
    rESTPaginationGroup:
      type: object
      description: Provides Pagination Information for the REST API.
      properties:
        offset:
          description: Indicates the index of the next applicable set(page).
          type: integer
        limit:
          description: Indicates number of records the API can return as per the API request limit sent. A maximum of 200 records can be only returned at a time.
          type: integer
        count:
          description: Indicates number of records the API has returned actually as per the API request criteria.
          type: integer
        hasMore:
          description: Indicates whether there are more records available to be returned as per the API request criteria or not.
          type: boolean
        totalResults:
          description: Indicates total number of records available that can be returned as per the API request criteria.
          type: integer
    profileAllowedActionsType:
      type: array
      description: Allowed actions for profile operations.
      maxItems: 2
      items:
        $ref: '#/components/schemas/profileAllowedActionType'
    alienInfoType:
      type: object
      description: immigration/visa information of a foreign person.
      properties:
        alienRegistrationNo:
          description: Alien Registration Number.
          type: string
        immigrationStatus:
          description: Immigration Status on an Alien.
          type: string
          minLength: 0
          maxLength: 40
        visaValidityType:
          description: Visa Type of an Alien.
          type: string
          minLength: 0
          maxLength: 40
    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
    companyProfileTypeType:
      type: string
      description: The types of Profile handled by the web service.
      enum:
      - Agent
      - Company
      - Group
      - Source
    suspendedProfilesMatchStatsByPropertyAndProfileType:
      type: object
      description: Response object for fetch suspended profiles match statistics grouped by property and profile type.
      properties:
        suspendedProfilesMatchStatsByPropertyAndProfileType:
          description: Provides the information for suspended profiles match statistics grouped by property and profile type.
          $ref: '#/components/schemas/suspendedProfilesMatchStatsByPropertyAndProfileTypeType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stagedProfileCommissionType:
      type: object
      properties:
        commissionCode:
          description: Commission code for the profile.
          type: string
          minLength: 0
          maxLength: 20
        errorDescription:
          description: The error in commission information in a staged profile with an invalid status.
          type: string
          minLength: 0
          maxLength: 2000
        inactiveDate:
          description: Inactivation date of the record.
          type: string
          format: date
          maxLength: 8
        currencyCode:
          description: Currency code for the commission.
          type: string
          minLength: 0
          maxLength: 20
        commissionResort:
          description: Resort corresponding to the commission.
          type: string
          minLength: 0
          maxLength: 20
        valid:
          description: Indicates whether the commission information is valid.
          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
      description: Information on commission for the customer.
    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
    eCertificateIssueSourceType:
      type: string
      description: Indicates that OPERA E-Certificate is issued by external system.
      enum:
      - Opera
      - Web
      - Interface
    profileAccounts:
      type: object
      description: Response of profile accounts.
      properties:
        accounts:
          description: Collection of profile accounts.
          $ref: '#/components/schemas/aRAccountsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stagedProfileDetails:
      type: object
      description: Response object for the staged profile.
      properties:
        stagedProfile:
          description: Response object for the staged profile.
          $ref: '#/components/schemas/stagedProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stagedProfileURLType:
      type: object
      properties:
        url:
          description: Web URL details for the Profile.
          $ref: '#/components/schemas/uRLType'
        errorDescription:
          description: The error in URL in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        inactiveDate:
          description: Inactivation date of the record.
          type: string
          format: date
          maxLength: 8
        defaultConfirmation:
          description: Indicates whether the phone is the default confirmation method.
          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
      description: Web site address.
    mergedProfileType:
      type: object
      description: Provides information for merged profile.
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.
          $ref: '#/components/schemas/profileIdList'
        profile:
          description: Provides detailed information regarding either a company or a customer profile.
          $ref: '#/components/schemas/profileType'
    profilesType:
      type: object
      description: A collection of Profile objects or Unique IDs of Profiles.
      properties:
        profileInfo:
          description: A collection of Profiles or Unique IDs of Profiles.
          type: array
          maxItems: 4000
          items:
            type: object
            properties:
              profileIdList:
                description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.
                $ref: '#/components/schemas/profileIdList'
              profile:
                description: Provides detailed information regarding either a company or a customer profile.
                $ref: '#/components/schemas/profileType'
              chainCode:
                description: Chain code associated with the profile.
                type: string
                minLength: 0
                maxLength: 20
              allowedActions:
                description: Collection of allowed actions for profile search.
                $ref: '#/components/schemas/profileAllowedActionsType'
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    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
    guestProfileType:
      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'
        profileImage:
          description: The profile image.
          $ref: '#/components/schemas/imageSetType'
        addresses:
          description: List of customer addresses.
          type: object
          properties:
            addressInfo:
              description: Collection of Detailed information on an address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/addressInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        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'
            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'
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        uRLs:
          description: List of Information on a URL for the customer.
          type: object
          properties:
            uRLInfo:
              description: Collection of Detailed information on web url/address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/uRLInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        comments:
          description: List of Notes for the customer.
          type: object
          properties:
            commentInfo:
              description: Collection of Detailed information on comments for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/commentInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        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'
            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'
            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
        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 associated with the profile.
          $ref: '#/components/schemas/eCertificatesType'
        subscriptions:
          description: List of profile subscriptions.
          $ref: '#/components/schemas/profileSubscriptionListType'
        localizationGuestType:
          description: Localization Guest Type associated to the profile.
          type: string
          minLength: 0
          maxLength: 20
        eligibleForFiscalFolio:
          description: Eligible for Fiscal Folio/Payload generation.
          type: string
          minLength: 0
          maxLength: 20
        profileType:
          description: Type of profile such as Guest, Employee or Contact.
          $ref: '#/components/schemas/guestProfileTypeType'
        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
    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'
    traceTimeInfoType:
      type: object
      properties:
        dateTimeSpan:
          description: Time span for the trace.
          $ref: '#/components/schemas/dateTimeSpanType'
        traceOn:
          description: Date of the trace.
          type: string
          format: date-time
        traceTime:
          description: Time of the trace
          type: string
          minLength: 0
          maxLength: 20
        enteredBy:
          description: User that entered this trace.
          type: string
    primaryProfileInfoType:
      type: object
      description: Contains basic information of profile.
      properties:
        profileId:
          description: Unique Identifier for OPERA Profile.
          $ref: '#/components/schemas/uniqueID_Type'
        profileType:
          description: Type of account such as Agent, Company, and Source.
          $ref: '#/components/schemas/profileTypeType'
        profileName:
          description: Name of the account.
          type: string
          minLength: 0
          maxLength: 40
    duplicateExternalSubscriptionsType:
      type: object
      description: Contains subscription details about an OPERA Profile that is linked to multiple external profiles within the same external system.
      properties:
        profileId:
          description: OPERA Profile ID
          $ref: '#/components/schemas/profileId'
        databaseId:
          description: Code identifying the external database record which is linked to external systems.
          type: string
          minLength: 0
          maxLength: 20
        profileSubscriptions:
          description: List of subscriptions where this OPERA profile is linked to multiple external profiles within the same external system
          $ref: '#/components/schemas/profileSubscriptionListType'
    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'
    profiles:
      type: array
      description: Unique identifier for a profile.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/profileId'
    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
    duplicateOPERASubscriptionsListType:
      type: array
      description: Details of the OPERA Profile subscription to external system
      maxItems: 4000
      items:
        $ref: '#/components/schemas/duplicateOPERASubscriptionsType'
    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
    copyProfileCommissionInfoType:
      type: object
      description: Contains base info to determine profile commission bank account and code.
      properties:
        hotelId:
          description: Hotel code from which the profile bank account and code belongs to
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: Unique profile identifier.
          $ref: '#/components/schemas/profileId'
        bankAccountId:
          description: Bank account ID.
          $ref: '#/components/schemas/uniqueID_Type'
        commissionCode:
          description: Profile commission code
          $ref: '#/components/schemas/codeDescriptionType'
        validatePending:
          description: Used in CRUD operations. When set to true, proceed validating pending commissions
          type: boolean
        targetHotelCodes:
          description: Property to which configuration code type to be copied to.
          $ref: '#/components/schemas/codeListType'
    suspendedProfilesMatchStatsType:
      type: object
      description: Suspended profiles match statistics
      allOf:
      - $ref: '#/components/schemas/rESTPaginationGroup'
      properties:
        matchStatsInfo:
          type: array
          description: Collection of suspended profiles match statistics.
          items:
            $ref: '#/components/schemas/suspendedProfilesMatchStatType'
            maxItems: 100
    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
    recentlyAccessedProfiles:
      type: object
      description: Response with the fetched recently accessed profiles.
      properties:
        profiles:
          description: List of recently accessed profiles.
          type: array
          items:
            $ref: '#/components/schemas/recentlyAccessedProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    profileCommissionAccountInfoListType:
      type: array
      description: Profile commission info which contains bank account and commission code details.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/profileCommissionAccountInfoType'
    profileStatusType:
      type: string
      enum:
      - Active
      - Inactive
    errorDescType:
      type: object
      description: Object for specific error description.
      properties:
        errorDesc:
          description: Specific error description.
          type: string
          maxLength: 2000
        limit:
          description: Indicates maximum number of records this api should return.
          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
    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'
    billingInstructionsType:
      type: array
      description: Set of Billing Instruction codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/billingInstructionType'
    stagedProfilePreferenceType:
      type: object
      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
        errorDescription:
          description: The error in Preference information in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        inactiveDate:
          description: Inactivation date of the record.
          type: string
          format: date
          maxLength: 8
        resortPrefernce:
          description: Prefernce resort.
          type: string
          minLength: 0
          maxLength: 20
        valid:
          description: Indicated whether the preference information is valid.
          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
      description: Guest Preference details for the profile.
    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
    duplicateOPERASubscriptions:
      type: object
      description: Response object for fetching subscriptions where an external profile within a particular external system is linked to multiple OPERA profiles.
      properties:
        duplicateOPERASubscriptionsList:
          description: A collection of subscriptions where an external profile within a particular external system is linked to multiple OPERA profiles.
          $ref: '#/components/schemas/duplicateOPERASubscriptionsListType'
        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'
    reProcessStageRecordLogEntry:
      type: object
      description: A log entry for a reprocess/rematch job.
      properties:
        jobId:
          type: string
          description: ID of the reprocess/rematch job.
        recordsProcessed:
          type: integer
          description: Number of records processed in this job.
        successful:
          type: integer
          description: Number of records successfully processed.
        created:
          type: integer
          description: Number of records successfully created.
        merged:
          type: integer
          description: Number of records successfully merged.
        failed:
          type: integer
          description: Number of records failed to process.
        dateTime:
          type: string
          format: date-time
          description: Date and time when log entry was created/completed.
        user:
          type: string
          description: User who initiated/executed this job.
        state:
          type: string
          description: State information of the job.
    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
    eCertificates:
      type: object
      description: Response object for fetch ECertificates. This object contains collection of ECertificates,Success,Warnings and Errors related to this operation.
      properties:
        eCertificatesDetail:
          description: E-Certificate assosiated with the profile.
          $ref: '#/components/schemas/eCertificatesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    rewardCertificateType:
      type: string
      description: Point Saver reward.
      enum:
      - Regular
      - StayAnytime
      - PointSaver
    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
    generateMembershipNumberCriteriaType_2:
      type: object
      description: Auto generate membership number criteria.
      properties:
        membershipType:
          description: Indicates the Membership Type where membership number to be generated will be based on.
          type: string
          minLength: 0
          maxLength: 20
    profileCommissionAccount:
      type: object
      description: Request object for creating profile commission detail.
      properties:
        criteria:
          $ref: '#/components/schemas/profileCommissionAccountCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileSharedLevelType:
      type: string
      description: Simple types for Shared level.
      enum:
      - Global
      - Property
      - Cro
    reservationFolioWindowsType:
      type: array
      description: Collection of reservation folio windows.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationFolioWindowType'
    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
    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
    reservationIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    suspendedProfilesMatchStatByMatchCriteriaType:
      type: object
      description: Type which represents suspended profiles match statistics grouped by match criteria.
      properties:
        matchCriteria:
          description: Criteria used to for matching two profiles.
          type: string
          minLength: 0
          maxLength: 80
        count:
          description: Number of records with this match criteria.
          type: integer
    suspendedProfilesMatchStatByPropertyAndProfileTypeCombined:
      type: object
      description: Type which represents suspended profiles match statistics grouped by property with detailed view
      properties:
        hotelId:
          description: Property where the match was found.
          type: string
          minLength: 0
          maxLength: 20
        profileTypesListInfo:
          type: array
          description: Collection of suspended profiles match statistics grouped by profile type with detailed view
          items:
            $ref: '#/components/schemas/profileTypesListType'
            maxItems: 100
        count:
          description: Number of records with this property.
          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
    profileStayDetailsType:
      type: object
      description: Type provides the stay history and future reservations of specific profile.
      properties:
        reservationInfoList:
          description: Collection of Detailed information on history and future reservations associated with the profile.
          $ref: '#/components/schemas/reservationStayHistoryFutureInfoType'
    eCertificateStatusType:
      type: string
      description: Indicates that OPERA E-Certificate is reserved.
      enum:
      - Cancelled
      - Consumed
      - Deleted
      - Expired
      - Issued
      - Reserved
    stayRevenuesDetailsType:
      type: object
      properties:
        folioView:
          description: ''
          type: string
        revenueAmount:
          description: Specifies the amount of revenue.
          type: number
        stayRevenues:
          type: array
          items:
            $ref: '#/components/schemas/stayRevenuesType'
    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
    billingInstructionType:
      type: object
      description: Configured Billing Instruction which represents a set of Transaction Codes.
      properties:
        desc:
          description: Billing Instruction code description.
          type: string
          minLength: 0
          maxLength: 2000
        routingInstructionsId:
          description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.
          type: number
        billingCode:
          description: Unique identifier for the Billing Instruction.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel context of the Billing Instruction.
          type: string
          minLength: 0
          maxLength: 20
    eCertificateGenerationType:
      type: object
      description: E-Certificates details.
      properties:
        ruleId:
          description: Key to identify the generation rule id.
          $ref: '#/components/schemas/uniqueID_Type'
        generationDetail:
          description: Reason for which e-certificate was generated.
          type: string
          minLength: 0
          maxLength: 4000
        referenceValue:
          description: Type of value that is in the certificate.valid values are membership_level.
          type: string
          minLength: 0
          maxLength: 20
    eCertificatesType:
      type: array
      description: List of e-certificates for the profile.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/eCertificateType'
    keywordType:
      type: object
      properties:
        keywordDetail:
          description: The keyword new value, in case keyword value is modified.
          $ref: '#/components/schemas/keywordDetailType'
        type:
          description: The type of keyword
          type: string
          minLength: 0
          maxLength: 20
        keyword:
          description: The keyword value.
          type: string
          minLength: 0
          maxLength: 80
    processedStagedProfile:
      type: object
      properties:
        processResult:
          $ref: '#/components/schemas/processStagedProfileResultType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileTaxInfoType:
      type: object
      description: Profile information related to tax.
      properties:
        tax1No:
          description: The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.
          type: string
          minLength: 0
          maxLength: 40
        tax2No:
          description: Tax 2 id of this profile.
          type: string
          minLength: 0
          maxLength: 40
        taxCategory:
          description: Tax Category to be changed.
          type: string
          minLength: 0
          maxLength: 20
        taxOffice:
          description: Tax Office to be changed.
          type: string
          minLength: 0
          maxLength: 30
        taxType:
          description: Tax type to be changed.
          type: string
          minLength: 0
          maxLength: 20
        businessId:
          description: Business ID. The maximum length of this element should not exceed 120 characters.
          type: string
          minLength: 0
          maxLength: 128
        businessRegistration:
          description: Business Registration Code. The maximum length of this element should not exceed 120 characters.
          type: string
          minLength: 0
          maxLength: 128
    aRAccountShortInfoType:
      type: object
      description: Accounts Receivabales Account details type charged for batched posting.
      properties:
        accountName:
          description: Name of the AR Account.
          type: string
          minLength: 0
          maxLength: 200
        accountId:
          description: The unique ID for the Account.
          $ref: '#/components/schemas/uniqueID_Type'
        accountNo:
          description: The Account Number for the Account.
          type: string
          minLength: 0
          maxLength: 20
        status:
          description: The status of the account.
          $ref: '#/components/schemas/aRAccountStatusType'
    profileRelationship:
      type: object
      description: Request object for creating profile relationship.
      properties:
        relationship:
          description: Refer to Relationship Profile request criteria.
          $ref: '#/components/schemas/relationshipCriteriaType'
        copyInstructions:
          description: Indicates which details of the master profile should be copied to subsidiary profiles, when a master-sub relationship is created for profile types Company, TravelAgent and Source
          $ref: '#/components/schemas/copyInstructionsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    processStagedProfileType:
      type: object
      description: Information required to process a atged profile.
      properties:
        stagedProfileId:
          description: Unique Identifier for Staged Profile.
          $ref: '#/components/schemas/stagedProfileId'
        processType:
          description: Type of processing.
          $ref: '#/components/schemas/stagedProfileProcessType'
        sourceType:
          description: Type of source.
          $ref: '#/components/schemas/stagedProfileSourceType'
    profileRoutingInstructionsType:
      type: object
      description: The type contains routing instructions for the profile.
      properties:
        transactionCodes:
          description: Set of preconfigured transaction codes.
          $ref: '#/components/schemas/trxCodesInfoType'
        billingInstructions:
          description: Set of preconfigured Billing Instruction results.
          $ref: '#/components/schemas/billingInstructionsType'
        autoPopulateRouting:
          description: A flag which determines whether the instructions has to be automatically populated for this profile or not.
          type: boolean
    stringLength100:
      type: string
      description: Used for Character Strings, length 0 to 100.
      maxLength: 100
      minLength: 0
    vIPStatusType:
      type: object
      description: VIP status of the customer.
      properties:
        value:
          type: string
          description: Used for Character Strings, length 0 to 2000.
          minLength: 0
          maxLength: 2000
        code:
          description: VIP status of the customer.
          type: string
          minLength: 0
          maxLength: 20
    cashierInfoType:
      type: object
      description: Cashier information. Contains Id and Name details of the cashier.
      properties:
        cashierId:
          description: Cashier Id of the Cashier.
          type: number
        cashierName:
          description: Cashier Name.
          type: string
          minLength: 0
          maxLength: 2000
    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'
    stayMembershipDetails:
      type: object
      description: Complex type that contains stay membership details and instructions to attach or replace.
      properties:
        newMembershipCardNo:
          description: Specifies the Card Number of new membership being attached.
          type: string
        newMembershipType:
          description: Specifies the type of new membership being attached.
          type: string
        oldMembershipCardNo:
          description: Specifies the Card Number of old membership that should be replaced.
          type: string
        oldMembershipType:
          description: Specifies the type of old membership that should be replaced.
          type: string
        stayRecordId:
          description: Stay Record ID
          type: number
        attachMode:
          $ref: '#/components/schemas/stayMembershipAttachMode'
      required:
      - attachMode
    resProfileTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Group
      - TravelAgent
      - Source
      - ReservationContact
      - BillingContact
      - Addressee
    forecastsInformation:
      type: object
      properties:
        forecastsInformation:
          description: Account Forecast details to be created.
          $ref: '#/components/schemas/accountForecastsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    codeListType:
      type: array
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    profileAllowedActionType:
      type: string
      description: Flag indicating whether Profile is Enrolled to Primary Membership Program.
      enum:
      - NameChange
      - AltNameChange
      - TaxIDChange
      - EnrollToPrimaryMembership
    profileCommissionAccountInfoType:
      type: object
      description: Profile commission info which contains bank account and commission code details
      properties:
        profileId:
          description: Unique profile identifier.
          $ref: '#/components/schemas/profileId'
        bankAccount:
          description: Bank account details
          $ref: '#/components/schemas/bankAccountType'
        commissionCode:
          description: Commission code details
          $ref: '#/components/schemas/codeDescriptionType'
    profileOwnersDetail:
      type: object
      description: Response object to fetch the owners of a profile.
      properties:
        profileOwnersList:
          description: Collection of the profile owners belonging to the profile requested.
          $ref: '#/components/schemas/ownersType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    membershipTierProjectionType:
      type: object
      description: Membership Upgrade/Downgrade Projection.
      properties:
        upgrade:
          description: Upgrade information which includes member's next tier level requirements for next upgrade.
          type: string
          minLength: 0
          maxLength: 32000
        downgrade:
          description: Information regarding member's possible downgrades.
          type: string
          minLength: 0
          maxLength: 32000
    profileCommissionAccountInfo:
      type: object
      description: Response object for fetching profile commission detail.
      properties:
        profileCommissionAccountInfoList:
          $ref: '#/components/schemas/profileCommissionAccountInfoListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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'
    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'
        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
    stagedProfileUserDefinedFieldsType:
      type: object
      description: Used to hold user defined fields(UDFs) for staged profile.
      properties:
        characterUDFs:
          description: Collection of user defined fields of Character/String Type.
          $ref: '#/components/schemas/stagedProfileCharacterUDFsType'
        numericUDFs:
          description: Collection of user defined fields of Numeric Type.
          $ref: '#/components/schemas/stagedProfileNumericUDFsType'
        dateUDFs:
          description: Collection of user defined fields of Date Type.
          $ref: '#/components/schemas/stagedProfileDateUDFsType'
    forgetProfileFailureReasonType:
      type: object
      description: Provides information about the reason why the profile is not eligible to be forgotten.
      properties:
        reasonCode:
          description: Code representing the reason why the profile is not eligible to be forgotten.
          type: string
          minLength: 0
          maxLength: 20
        reasonDescription:
          description: Reason describing why the profile is not eligible to be forgotten.
          type: string
          minLength: 0
          maxLength: 2000
        expectedResolutionDate:
          description: Expected resolution date for this reason.
          type: string
          format: date
          maxLength: 8
    aRBalanceType:
      type: object
      description: Balance information for AR.
      properties:
        debit:
          description: Debit Balance amount. The amount owed by the Account.
          $ref: '#/components/schemas/currencyAmountType'
        credit:
          description: The credit Balance amount. Any payment that is Unallocated i.e not applied against an invoice, is included in this.
          $ref: '#/components/schemas/currencyAmountType'
        total:
          description: The total balance i.e Debit minus Credit amounts.
          $ref: '#/components/schemas/currencyAmountType'
    profileInfoType:
      type: object
      description: Provides information about attached profiles to the block.
      properties:
        profileId:
          description: Opera ID for the profile attached to the block.
          $ref: '#/components/schemas/uniqueID_Type'
        name:
          description: Name for the profile attached to the block.
          type: string
          minLength: 0
          maxLength: 200
        city:
          description: City for the profile attached to the block.
          type: string
          minLength: 0
          maxLength: 80
        phone:
          description: Phone for the profile attached to the block.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: Defines the type of Linked profiles for a block.
          type: string
          minLength: 0
          maxLength: 20
    articlePostItType:
      type: object
      description: Post it information of an article.
      properties:
        availableForPostIt:
          description: Indicates whether the article is available for post it.
          type: boolean
        color:
          description: Color indicator which is only configurable if article is available for post it.
          $ref: '#/components/schemas/colorType'
    stagedProfileEmailType:
      type: object
      properties:
        email:
          description: Email details for the profile.
          $ref: '#/components/schemas/emailType'
        errorDescription:
          description: The error in email information in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        inactiveDate:
          description: Inactivation date of the record.
          type: string
          format: date
          maxLength: 8
        defaultConfirmation:
          description: Indicates whether the email is the default confirmation method.
          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
      description: Information on an email for the customer.
    nameTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Agent
      - Contact
      - Source
      - Group
      - Employee
      - Hotel
      - Purge
    membershipInfoType:
      type: object
      description: The Membership object identifies the frequent customer reward program.
      properties:
        membershipId:
          description: Membership ID (Unique ID from the memberships table).
          type: number
        programCode:
          description: The code or name of the membership program ('Hertz', 'AAdvantage', etc.).
          type: string
          minLength: 0
          maxLength: 20
        bonusCode:
          description: The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)
          type: string
          minLength: 0
          maxLength: 20
        membershipTypeDesc:
          description: The description of the ProgramCode.(Delta Previlige for code DP)
          type: string
          minLength: 0
          maxLength: 2000
        membershipLevelDesc:
          description: The description of the Bonus Code.(Platinum for code P)
          type: string
          minLength: 0
          maxLength: 2000
        accountId:
          description: The account identification number for this particular member in this particular program.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.
          type: string
          minLength: 0
          maxLength: 20
        playerRanking:
          description: Ranking assigned to the Player Profile by the Gaming system.
          type: integer
    payeeInfoType:
      type: object
      description: Payee information.
      properties:
        payeeId:
          description: Opera name id of the payee.
          $ref: '#/components/schemas/uniqueID_Type'
        payeeName:
          description: Name of the payee.
          type: string
          minLength: 0
          maxLength: 80
        payeeAddress:
          description: Address of the payee.
          $ref: '#/components/schemas/addressInfoType'
        payeeAddressCount:
          description: Payee multiple address count.
          type: integer
        payeeReferenceCurrency:
          description: Reference currency of the payee.
          type: string
          minLength: 0
          maxLength: 20
        payeeAccountInfo:
          description: AR account short info of the payee.
          $ref: '#/components/schemas/aRAccountShortInfoType'
        payeeTaxNumber:
          description: The tax number of the payee.
          type: string
          minLength: 0
          maxLength: 40
    blockIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    relationshipsSummary:
      type: object
      description: Contains details relationships related to a profile.
      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
    searchProfileMatchRequest:
      type: object
      properties:
        lastName:
          type: string
          minLength: 1
          maxLength: 40
          description: Last Name for the profile that needs to be matched.
        firstName:
          type: string
          minLength: 1
          maxLength: 40
          description: First Name for the profile that needs to be matched.
        membershipType:
          type: string
          minLength: 1
          maxLength: 20
          description: Membership Type for the profile that needs to be matched.
        membershipCardNumber:
          type: string
          minLength: 1
          maxLength: 50
          description: Membership Card Number for the profile that needs to be matched.
        identificationType:
          type: string
          minLength: 1
          maxLength: 40
          description: Identification Type for the profile that needs to be matched.
        identificationNumber:
          type: string
          minLength: 1
          maxLength: 80
          description: Identification Number for the profile that needs to be matched.
        email:
          type: string
          minLength: 1
          maxLength: 2000
          description: Email for the profile that needs to be matched.
        subscriptionType:
          type: string
          minLength: 1
          maxLength: 20
          description: Subscription Type for the profile that needs to be matched.
        subscriptionId:
          type: string
          minLength: 1
          maxLength: 80
          description: Subscription Id for the profile that needs to be matched.
        clientId:
          type: string
          minLength: 1
          maxLength: 80
          description: Client Id for the profile that needs to be matched.
    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
    roomClassCodeInfoType:
      type: object
      description: Code of the room class type.
      properties:
        roomClassCode:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
    preference:
      type: object
      description: Response object for fetch preference. This object contains collection of preferences,Success,Warnings and Errors related to this operation.
      properties:
        preferenceCollections:
          description: Detailed information of preferences related to the profile
          type: array
          items:
            $ref: '#/components/schemas/preferenceTypeType'
        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'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    attachmentType:
      type: object
      description: Attached files.
      properties:
        fileName:
          description: Name of the file.
          type: string
          minLength: 0
          maxLength: 2000
        fileSize:
          description: Size of the file.
          type: integer
        description:
          description: Description for the file.
          type: string
          minLength: 0
          maxLength: 4000
        global:
          description: Flag to say if attachment is available across properties.
          type: boolean
        hotelId:
          description: Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        history:
          description: History data associated with Attachment.
          $ref: '#/components/schemas/dateTimeStampGroupType'
        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
    matchProfileType:
      type: object
      description: Provides information for match profile.
      properties:
        hotelId:
          description: Hotel Code for the profile.
          type: string
          minLength: 0
          maxLength: 20
        profileIdList:
          description: Unique identifiers of the Profile for both internal and external systems.
          $ref: '#/components/schemas/profileIdList'
        statusCode:
          description: Status of the match profile.
          $ref: '#/components/schemas/matchStatusType'
    webUserAccountsType:
      type: array
      description: Web User Accounts List.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/webUserAccountType'
    linkedProfiles:
      type: object
      description: Response of fetch set of linked Profiles to the requested Profile.
      properties:
        profileSummaries:
          description: Linked profile's summary information.
          $ref: '#/components/schemas/profileSummariesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    changeAccountForecastsRS:
      type: object
      description: Response Body.
      properties:
        success:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/successType'
        warnings:
          $ref: '#/components/schemas/warningsType'
        errors:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/errorsType'
        echoToken:
          description: A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
          type: string
          minLength: 0
          maxLength: 128
        timeStamp:
          description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
          type: string
          format: date-time
        version:
          description: For all Opera versioned messages, the version of the message is indicated by a Opera Version value.
          type: string
          minLength: 0
          maxLength: 40
        correlationId:
          description: Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
          type: string
          minLength: 0
          maxLength: 80
        retryAllowed:
          description: Indicates if the operation supports the ability to retry the request.
          type: boolean
        enforceAllowed:
          description: Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.
          type: boolean
        useLocalAllowed:
          description: This attribute carries the user selected confirmation value on confirmation popup.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
    stagedProfileNumericUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Numeric Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/stagedProfileNumericUDFType'
    profileCashieringDetailType:
      type: object
      description: The type contains routing instructions for the profile.
      properties:
        paymentMethod:
          description: Payment Method Details.
          $ref: '#/components/schemas/codeDescriptionType'
        eCommerceId:
          description: E-Commerce ID of the Profile
          $ref: '#/components/schemas/uniqueID_Type'
        routingInstructions:
          description: Set of preconfigured transaction codes.
          $ref: '#/components/schemas/profileRoutingInstructionsType'
        taxType:
          description: Tax type code.
          type: string
          minLength: 0
          maxLength: 20
        fiscalGuestType:
          description: Guest type code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel Code for which the routing instructions are provided for a profile.
          type: string
          minLength: 0
          maxLength: 20
        offshoreEligible:
          description: Indicates whether the profile is eligible to use offshore rates or not.
          type: boolean
        parentAccountNameId:
          description: Name ID of the parent account for a profile.
          type: number
    aRAccountsType:
      type: array
      description: Information regarding the AR Account.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/aRAccountType'
    emailInfoType:
      type: object
      description: Information on an email for the customer.
      properties:
        email:
          description: eMail deatils for the profile.
          $ref: '#/components/schemas/emailType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    stayRecordsType:
      type: object
      properties:
        UDFC01:
          description: Describes the user defined field 01
          type: string
        UDFC02:
          description: Describes the user defined field 02
          type: string
        UDFC03:
          description: Describes the user defined field 03
          type: string
        UDFC04:
          description: Describes the user defined field 04
          type: string
        UDFC05:
          description: Describes the user defined field 05
          type: string
        UDFC06:
          description: Describes the user defined field 06
          type: string
        UDFC07:
          description: Describes the user defined field 07
          type: string
        UDFC08:
          description: Describes the user defined field 08
          type: string
        UDFC09:
          description: Describes the user defined field 09
          type: string
        UDFC10:
          description: Describes the user defined field 10
          type: string
        UDFD01:
          description: Describes the user defined field 01
          type: string
          format: date
        UDFD02:
          description: Describes the user defined field 02
          type: string
          format: date
        UDFD03:
          description: Describes the user defined field 03
          type: string
          format: date
        UDFD04:
          description: Describes the user defined field 04
          type: string
          format: date
        UDFD05:
          description: Describes the user defined field 05
          type: string
          format: date
        UDFN01:
          description: Describes the user defined field 10
          type: number
        UDFN02:
          description: Describes the user defined field 10
          type: number
        UDFN03:
          description: Describes the user defined field 10
          type: number
        UDFN04:
          description: Describes the user defined field 10
          type: number
        UDFN05:
          description: Describes the user defined field 10
          type: number
        adults:
          description: Describes the number of adults
          type: number
        arrivalDate:
          description: Specifies the date of arrival
          type: string
          format: date
        baseRateAmount:
          description: Specifies the base rate amount
          type: number
        baseRateCode:
          description: Specifies the base rate code
          type: string
        baseRateCurrencyCode:
          description: Specifies the currency code of the base rate
          type: string
        blockCode:
          description: Specifies the block code
          type: string
        bookedRoomType:
          description: Specifies the type of room booked.
          type: string
        bookingDate:
          description: Specifies the date of booking.
          type: string
          format: date
        cancellationDate:
          description: Specifies the date of cancellation
          type: string
          format: date
        channel:
          description: Specifies the channel
          type: string
        children:
          description: specifies the number of children
          type: number
        companyId:
          description: Specifies the id assigned to the company
          type: string
        confirmationLegNumber:
          description: Specifies the confirmation leg number
          type: number
        confirmationNumber:
          description: Specifies the confirmation number
          type: string
        currencyCode:
          description: Specifies the currency code
          type: string
        departureDate:
          description: Specifies the date of departure
          type: string
          format: date
        exchangeRate:
          description: Specifies the exchange rate
          type: number
        externalReservationId:
          description: Describes the id assigned to an external reservation
          type: string
        groupId:
          description: Specifies the id assigned to a group
          type: string
        guestNameId:
          description: Specifies the id assigned to a guest name
          type: string
        complimentary:
          description: Describes if complimentary or not
          type: boolean
        primaryShare:
          description: Describes if it is a primary share
          type: boolean
        miscellaneousId:
          description: Specifies the miscellaneous id
          type: string
        paymentMethod:
          description: Specifies the payment method used
          type: string
        posCode:
          description: Specifies the postal code
          type: string
        promotionCode:
          description: Specifies the promotion code
          type: string
        reservationStatus:
          description: Describes the reservation status ie CANCELLED, CHECKED OUT, ARRIVAL etc
          type: string
        reservationExpectedArrivalTime:
          description: Specifies the expected arrival time of the reservation
          type: string
          format: date
        reservationExpectedDepartureTime:
          description: Specifies the expected departure time of the reservation
          type: string
          format: date
        reservationInsertSource:
          description: Specifies the insert source for the reservation
          type: string
        reservationInsertSourceType:
          description: Specifies the insert source type for the reservation
          type: string
        roomId:
          description: Describes the room id of the room owner.
          type: string
        roomRevenue:
          description: Specifies the revenue for the room.
          type: number
        roomType:
          description: Describes the type of the room.
          type: string
        shareId:
          description: Specifies the share id.
          type: string
        sourceCode:
          description: Specifies the source code.
          type: string
        sourceId:
          description: Specifies the source id.
          type: string
        stageStatus:
          description: Specifies the stage status.
          type: string
        stageSuspenseReason:
          description: Specifies the stage suspense reason.
          type: string
        totalRevenue:
          description: Specifies the total revenue.
          type: number
        travelAgentId:
          description: Specifies the travel agent id
          type: string
    facilityCodesType:
      type: array
      description: List of the facility codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/facilityCodeType'
    matchType:
      type: object
      description: Type that contains matchId and if this particular matchId is set to skip profile match or not.
      properties:
        matchId:
          description: Identifier of the match record.
          type: string
          minLength: 0
          maxLength: 80
        skipProfileMatch:
          description: If true, it sets the record to skip profile match for this particular matchId. if false, it sets the record to not skip profile match.
          type: boolean
    personNameTypeType:
      type: string
      description: Person's name in an external system.
      enum:
      - Primary
      - Alternate
      - Incognito
      - External
      - Phonetic
    forgetProfileResultListType:
      type: array
      description: Result of processing/validation for forgetting a profile.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/forgetProfileResultType'
    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
    suspendedAddressesInfoType:
      type: object
      properties:
        addressId:
          description: Corporate id of the profile.
          type: integer
        name:
          description: Last Name of the Profile against which the Suspended Addresses are fetched.
          type: string
          minLength: 0
          maxLength: 80
        profileId:
          description: Opera ID for the profile attached to the address.
          $ref: '#/components/schemas/uniqueID_Type'
        firstName:
          description: First Name of the Profile against which the Suspended Addresses are fetched.
          type: string
          minLength: 0
          maxLength: 80
        profileType:
          description: Profile Type of the Profile against which the Suspended Addresses are fetched..
          type: string
          minLength: 0
          maxLength: 20
        clientID:
          description: Corporate id of the profile.
          $ref: '#/components/schemas/uniqueID_Type'
        matchCode:
          description: Match Code of the Address Validation Performed from the batch processing
          type: string
          minLength: 0
          maxLength: 20
        validateDate:
          description: Validate Date.
          type: string
          format: date
          maxLength: 8
        country:
          description: The country of residence where the property is located e.
          $ref: '#/components/schemas/countryNameType'
        hotelId:
          description: Resort of the Profile
          type: string
          minLength: 0
          maxLength: 20
    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
    stagedProfileProcessType:
      type: string
      description: Process Type enumerator.
      enum:
      - New
      - Match
      - Reprocess
      - ForceMerge
      - ForceAdd
    profileSummaryInfoType:
      type: object
      description: Summary information about a profile and the associated Unique IDs.
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code.
          $ref: '#/components/schemas/profileIdList'
        profile:
          description: Provides summary information regarding profile.
          $ref: '#/components/schemas/profileSummaryType'
    processStagedProfileResultType:
      type: object
      description: Information about the staged profile after processing.
      properties:
        hotelId:
          description: Hotel Code for the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: The resulting profile ID after processing the staged profile.
          $ref: '#/components/schemas/profileId'
        stageStatus:
          description: The resulting profile status after processing the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        result:
          description: Processing/Rematching result for the staged profile.
          type: string
          minLength: 0
          maxLength: 4000
    uRLInfoType:
      type: object
      description: Web site address.
      properties:
        url:
          description: Provides URL information.
          $ref: '#/components/schemas/uRLType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    profileRelationshipToBeChanged:
      type: object
      description: Request object for changing profile relationship.
      properties:
        relationship:
          description: Refer to Relationship Profile request criteria.
          $ref: '#/components/schemas/changeRelationshipCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    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'
    reProcessStageRecordsCriteria:
      type: object
      description: Object for Reprocessing Stage Records.
      properties:
        reProcessStageRecords:
          description: Reprocess Stage Records for all records.
          $ref: '#/components/schemas/reProcessStageRecordsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    cityState:
      type: object
      description: Response object for fetching City and State based on search criteria. This object contains address information,Success,Warnings and Errors related to this operation.
      properties:
        addressType:
          description: Contains address information.
          $ref: '#/components/schemas/addressType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stagedProfileCriteria:
      type: object
      properties:
        stagedProfile:
          $ref: '#/components/schemas/processStagedProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    keywordDetailType:
      type: object
      properties:
        newKeyword:
          description: The new keyword value.
          type: string
          minLength: 0
          maxLength: 80
    taxTypeType:
      type: object
      description: Provides information about the Tax Type.
      properties:
        hotelId:
          description: Code of the Hotel.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Code of the Tax Type.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the Tax Type.
          type: string
          minLength: 0
          maxLength: 2000
        collectingAgentTax:
          description: A boolean flag for Collecting Agent Tax
          type: boolean
        printAutoAdjust:
          description: Print auto adjust information for this tax type on the tax exempt report.
          type: boolean
        reportExemptDays:
          description: Number of days after which the guest will be tax exempt. Only used for tax exempt report.
          type: integer
        reportTaxPercentage:
          description: Tax percentage. Only used for tax exempt report.
          type: number
          minimum: 0
          maximum: 100
        minimumLengthOfStay:
          description: Minimun Length of Stay.
          type: integer
    stagedProfileCustomerType:
      type: object
      properties:
        personName:
          description: Detailed name information for the customer.
          type: array
          maxItems: 5
          items:
            $ref: '#/components/schemas/personNameType'
        anonymization:
          description: Provides information about the guest's anonymization status
          $ref: '#/components/schemas/anonymizationType'
        citizenCountry:
          description: Name of the (self-professed) country that is claimed for citizenship.
          $ref: '#/components/schemas/countryNameType'
        identifications:
          description: List of identification of the customer.
          type: object
          properties:
            identificationInfo:
              description: Collection of detailed information on the identification of the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/identificationInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        profession:
          description: Profession of a person.
          type: string
          minLength: 0
          maxLength: 80
        alienInfo:
          description: Immigration/visa information of a foreign person.
          $ref: '#/components/schemas/alienInfoType'
        birthCountry:
          description: Country of birth.
          $ref: '#/components/schemas/countryNameType'
        legalCompany:
          description: Name Of the company the individual is associated with.
          type: string
          minLength: 0
          maxLength: 80
        companyInfo:
          description: Company Information of the Profile.
          $ref: '#/components/schemas/companyInfoType'
        businessTitle:
          description: Business Title.
          type: string
          minLength: 0
          maxLength: 80
        gender:
          description: Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.
          type: string
          minLength: 0
          maxLength: 20
        birthDate:
          description: Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.
          type: string
          format: date
          maxLength: 8
        birthDateMasked:
          description: Indicates the date of birth as masked.
          type: string
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        nationality:
          description: Nationality code identification
          type: string
          minLength: 0
          maxLength: 20
        nationalityDescription:
          description: Nationality code description
          type: string
          minLength: 0
          maxLength: 80
        customerValue:
          description: The supplier's ranking of the customer (e.g., VIP, numerical ranking).
          type: string
          minLength: 0
          maxLength: 20
        creditRating:
          description: Credit Rating of the customer.
          type: string
          minLength: 0
          maxLength: 20
        vipStatus:
          description: VIP status of the customer.
          type: string
          minLength: 0
          maxLength: 20
        vipDescription:
          description: Description of the VIP status.
          type: string
          minLength: 0
          maxLength: 2000
        birthPlace:
          description: Place of birth.
          type: string
          minLength: 0
          maxLength: 80
        privateProfile:
          description: This element tells profile is property exclusive or not.
          type: boolean
        blacklist:
          description: This element tells if profile is blacklisted or not.
          type: boolean
        errors:
          description: The error in stage profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileErrorType'
        alternateLanguage:
          description: ALternate language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
      description: Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
    stayDailyRatesType:
      type: object
      properties:
        transactionDate:
          description: Date on which the transaction was done.
          type: string
          format: date
        bookedRoomType:
          description: Specifies the type of room booked.
          type: string
        currencyCode:
          description: Specifies the code assigned to the currency.
          type: string
        pseudoRoom:
          description: Specifies if the room is a pseudo room.
          type: boolean
        marketCode:
          description: Specifies the market code.
          type: string
        rateCode:
          description: Specifies the rate code.
          type: string
        rateAmount:
          description: Specifies the amount added to a particular rate code.
          type: number
        roomId:
          description: Describes the room id of the room owner.
          type: string
        roomType:
          description: Describes the type of the room.
          type: string
      required:
      - transactionDate
      - rateCode
    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
    externalReferencesType:
      type: array
      description: This type contains unique information of external reference.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/externalReferenceType'
    fixedChargeDetailType:
      type: object
      description: Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
      properties:
        transaction:
          description: Transaction code and description of a fixed charge.
          $ref: '#/components/schemas/codeDescriptionType'
        quantity:
          description: Quantity of the product.
          type: integer
        chargeAmount:
          description: Price of the product.
          $ref: '#/components/schemas/currencyAmountType'
        percent:
          description: Percentage of the rate amount.
          type: number
          minimum: 0
          maximum: 100
        supplement:
          description: Additional information regarding the fixed charge.
          type: string
          minLength: 0
          maxLength: 2000
        article:
          description: Holds related article code and description.
          $ref: '#/components/schemas/codeDescriptionType'
        roomNights:
          description: Holds number of comp or cash room night to allocate.
          type: integer
    aRInvoiceType:
      type: object
      description: Details of an AR Invoice.
      properties:
        hotelId:
          description: Property where the invoice exists.
          type: string
          minLength: 0
          maxLength: 20
        reservationId:
          description: Reservation ID of the invoice.
          $ref: '#/components/schemas/reservationId'
        guestProfileId:
          description: Guest Profile ID of the invoice.
          $ref: '#/components/schemas/uniqueID_Type'
        age:
          description: The Aging age of the invoice
          type: integer
        guestName:
          description: Name of the Guest who consumed these transactions.
          type: string
          minLength: 0
          maxLength: 200
        originalAmount:
          description: Original Amount of the Invoice
          $ref: '#/components/schemas/currencyAmountType'
        amount:
          description: Current Amount of the Invoice.
          $ref: '#/components/schemas/currencyAmountType'
        payments:
          description: Total Payments made to this Invoice.
          $ref: '#/components/schemas/currencyAmountType'
        balance:
          description: Amount still open which has not been paid
          $ref: '#/components/schemas/currencyAmountType'
        reference:
          description: User-defined posting reference.
          type: string
          minLength: 0
          maxLength: 2000
        remark:
          description: User-defined posting remark.
          type: string
          minLength: 0
          maxLength: 2000
        adjusted:
          type: boolean
        parentInvoiceNo:
          type: number
        compressed:
          type: boolean
        compressedDate:
          type: string
          format: date
          maxLength: 8
        transferredOut:
          type: boolean
        transferredIn:
          type: boolean
        market:
          description: Invoice market code.
          $ref: '#/components/schemas/marketCodeInfoType'
        roomClass:
          description: Invoice room class code.
          $ref: '#/components/schemas/roomClassCodeInfoType'
        source:
          description: Invoice source code.
          $ref: '#/components/schemas/sourceCodeInfoType'
        reservationInfo:
          description: Reservation guest details.
          $ref: '#/components/schemas/reservationInfoType'
        cashierInfo:
          description: Cashier information. Contains Id and Name details of the cashier.
          $ref: '#/components/schemas/cashierInfoType'
        transactionInfo:
          description: Transaction information .
          $ref: '#/components/schemas/trxInfoType'
        paymentCard:
          description: Payment card details.
          $ref: '#/components/schemas/resPaymentCardType'
        addresseeInfo:
          description: Addressee Information for the folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio of the Invoice.
          $ref: '#/components/schemas/profileInfoType'
        allowPartialTransferYn:
          description: Flag to check Partail Transfer Allowed.
          type: boolean
        printed:
          description: Flag to check Invoice Statement is Printed.
          type: boolean
        printedDate:
          description: Invoice Statement Printed Date.
          type: string
          format: date
          maxLength: 8
        storedFolioId:
          description: ID of the Stored Folio.
          $ref: '#/components/schemas/uniqueID_Type'
        storedFolioName:
          description: Name of the Stored Folio.
          type: string
          minLength: 0
          maxLength: 2000
        storedDebitFolioId:
          description: ID of the Stored Debit Folio.
          $ref: '#/components/schemas/uniqueID_Type'
        storedDebitFolioName:
          description: Name of the Stored Debit Folio.
          type: string
          minLength: 0
          maxLength: 2000
        folioTexts:
          description: Additional text fields to display on the folio.
          $ref: '#/components/schemas/folioTextsType'
        transactionNo:
          description: Unique Transaction Identifier of the Invoice.
          type: number
        transactionDate:
          description: Transaction Date of the invoice.
          type: string
          format: date
          maxLength: 8
        status:
          description: Status of the invoice.
          type: string
          minLength: 0
          maxLength: 20
        transactionCode:
          description: Transaction code of the invoice.
          type: string
          minLength: 0
          maxLength: 20
        folioNo:
          description: Folio Number.
          type: number
        invoiceNo:
          description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios
          type: number
        fiscalBillNo:
          description: The Fiscal Bill number of this posting
          type: string
          minLength: 0
          maxLength: 2000
        folioTypeName:
          description: The name of the Folio Type used for the Folio Number sequence.
          type: string
          minLength: 0
          maxLength: 100
        internalFolioWindowID:
          description: Internal window ID which is unique to the reservation. This ID can only be used for reference.
          type: string
          minLength: 0
          maxLength: 20
        folioDate:
          description: Date of Folio Generation.
          type: string
          format: date
          maxLength: 8
        folioStatus:
          $ref: '#/components/schemas/folioStatusType'
        folioNoWithPrefix:
          description: The folio number with prefix value.
          type: string
          minLength: 0
          maxLength: 200
        folioSeqNo:
          description: Unique sequence number. Used to identify the current folio tax record.
          type: number
        invoiceType:
          description: Invoice code of the invoice.
          $ref: '#/components/schemas/aRInvoiceCategory'
        statementNo:
          description: Statementno of the invoice.
          type: integer
        revenueDate:
          description: Revenue date ID of the invoice.
          type: string
          format: date
          maxLength: 8
        closeDate:
          description: Close date of the invoice.
          type: string
          format: date
          maxLength: 8
        postingDate:
          description: Posting date of the invoice.
          type: string
          format: date
          maxLength: 8
        transferDate:
          description: Transfer date of the invoice.
          type: string
          format: date
          maxLength: 8
        canBeModified:
          description: Flag to indicate if postings or adjustments can be made to the invoice.
          type: boolean
    suspendedProfilesErrorsSummaryByPropertyInfo:
      type: object
      description: Response object for fetch suspended profiles errors summary by property. This object contains a collection of suspended profiles match errors and  the count of how many properties encountered this error.
      properties:
        suspendedProfilesErrorsSummary:
          description: Indicates response of the suspended profiles errors summary by property.
          $ref: '#/components/schemas/suspendedProfilesErrorsSummaryByPropertyType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    mergedStageProfileSnapshot:
      type: object
      description: Response object to fetch merge profile based on stage and opera profile.
      properties:
        mergeStageProfile:
          $ref: '#/components/schemas/stagedProfileType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileRelationships:
      type: object
      properties:
        relationships:
          description: Contains a collection of profiles that have a relationship with this profile.
          $ref: '#/components/schemas/relationshipsSummary'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    databaseIDListType:
      type: array
      description: Code identifying the external database record which is linked to external systems.
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    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
    stagedProfileType:
      type: object
      description: Detailed information about the staged profile.
      properties:
        profileIdList:
          description: List of unique identifier of staged profile.
          $ref: '#/components/schemas/uniqueIDListType'
        customer:
          description: Detailed customer information for this profile.
          $ref: '#/components/schemas/stagedProfileCustomerType'
        company:
          description: Detailed company information for this profile.
          $ref: '#/components/schemas/stagedProfileCompanyType'
        addresses:
          description: Collection of detailed information about address for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileAddressType'
        telephones:
          description: Collection of detailed information about telephone/fax for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfilePhoneType'
        emails:
          description: Collection of detailed information about email for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileEmailType'
        uRLs:
          description: Collection of detailed information about web url/address for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileURLType'
        commissions:
          description: Collection of detailed information about commissions for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileCommissionType'
        memberships:
          description: Collection of detailed information about memberships for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileMembershipType'
        preferences:
          description: Collection of detailed information about preferences for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfilePreferenceType'
        keywords:
          description: Collection of detailed information about keyword for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileKeywordType'
        negotiatedRates:
          description: Collection of detailed information about negotiated rates for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileNegotiatedRateType'
        identifications:
          description: Collection of detailed information about identification for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileIdentificationsType'
        routingInstructions:
          description: Collection of routing instructions for the staged profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stagedProfileRoutingInstructionType'
        userDefinedFields:
          description: List of user defined fields for the staged profile.
          $ref: '#/components/schemas/stagedProfileUserDefinedFieldsType'
        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'
        comments:
          description: List of Notes for the customer.
          $ref: '#/components/schemas/stagedProfileCommentInfosType'
        hotelId:
          description: Hotel code that the staged profile belongs to.
          type: string
          minLength: 0
          maxLength: 20
        importDate:
          description: The date on which the staged profile has been received.
          type: string
          format: date
          maxLength: 8
        profileType:
          description: Type of the staged profile.
          type: string
          minLength: 0
          maxLength: 20
        stageStatus:
          description: The status of the staged profile.
          type: string
          minLength: 0
          maxLength: 20
    aRInvoiceCategory:
      type: string
      enum:
      - Normal
      - Credit
      - OldBalance
      - PasserBy
    profileAdditionalInfoType:
      type: object
      properties:
        primaryOwnerCode:
          description: Primary Owner of the profile
          type: string
          minLength: 0
          maxLength: 20
        territory:
          description: Territory associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        masterAccount:
          description: Indicates if the profile is a Master Account for one or more Subsidiary Accounts.
          type: boolean
        subsidiaryAccount:
          description: Indicates if the profile is a Subsidiary Account of a Master/Parent Account.
          type: boolean
        businessPosition:
          description: Business Title or Position of the profile.
          type: string
          minLength: 0
          maxLength: 40
    applyToEnum:
      type: string
      enum:
      - StagedProfiles
      - MatchingProfiles
      - StagedAndMatchingProfiles
    exportLogsDeliveryStatusType:
      type: string
      description: Delivery Status for export logs - Not Delivered.
      enum:
      - Unknown
      - Delivered
      - Notdelivered
    matchListType:
      type: object
      description: Type that contains the list of theh matchIds that will be updated to skip or don't skip profile match.
      properties:
        matchList:
          type: array
          description: List of matchIds that will be updated to skip or don't skip profile match.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/matchType'
    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
    fetchInstructionsEnum:
      type: string
      enum:
      - Address
      - Communication
      - NegotiatedRate
      - GdsNegotiatedRate
      - Comment
      - Membership
      - Preference
      - Keyword
      - HistoryReservation
      - FutureReservation
      - Relationship
      - Correspondence
      - Routing
      - Indicators
      - Profile
      - WebUserAccount
      - SalesInfo
      - ECertificate
      - Subscriptions
      - PrimaryAccountInfo
      - DeliveryMethods
      - RoomOwnership
    profileMatchStatusType:
      type: string
      description: 'Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.'
      enum:
      - MPC
      - DNM
      - CNM
    profileIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    stagedProfile:
      type: object
      description: Request object for changing the staged profile.
      properties:
        stagedProfile:
          $ref: '#/components/schemas/stagedProfileType'
        changeInstructions:
          $ref: '#/components/schemas/stagedProfileChangeInstructionsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    fBAInfoType:
      type: object
      description: FBA ( Flexible Benefits Awards ) related fields.
      properties:
        status:
          description: Possible FBA statuses.
          $ref: '#/components/schemas/fBAStatusType'
        monetaryValue:
          description: Award's FBA monetary values.
          type: number
        amount:
          description: Award's FBA amount.
          type: number
        postedAmount:
          description: Award's FBA posted amount.
          type: number
        reimbursedAmount:
          description: Award's FBA reimbursed amount.
          type: number
        postingDateTime:
          description: Date and time of the FBA posting.
          type: string
          format: date
          maxLength: 8
        postingBusinessDate:
          description: Business date of the FBA posting.
          type: string
          format: date
          maxLength: 8
        settlementDateTime:
          description: Date and time of the FBA settlement.
          type: string
          format: date
          maxLength: 8
        settlementBusinessDate:
          description: Business date of the FBA settlement.
          type: string
          format: date
          maxLength: 8
        reimbursementDateTime:
          description: Date and time of the FBA reimbursement.
          type: string
          format: date
          maxLength: 8
        reimbursementBusinessDate:
          description: Business date of the FBA reimbursement.
          type: string
          format: date
          maxLength: 8
        fbaBillGenDate:
          description: Business date of the FBA bill generation.
          type: string
          format: date
          maxLength: 8
        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
        flexibleBenefitAward:
          description: Indicates if this certificate is a Flexible Benefit Award certificate.
          type: boolean
        posted:
          description: Indicates whether FBA has been posted.
          type: boolean
        settled:
          description: Indicates whether FBA has been settled.
          type: boolean
        reimbursed:
          description: Indicates whether FBA has been reimbursed.
          type: boolean
        resettleAllowed:
          description: Marks if the certificate is eligible for resettlement
          type: boolean
        reimburseAllowed:
          description: Marks if the certificate is eligible for reimbursement.
          type: boolean
        orphanCertificate:
          description: Indicates whether the certificate is Orphan or not.
          type: boolean
    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
    stagedProfileDateUDFType:
      type: object
      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
        errorDescription:
          description: The error in a user defined field in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        tableName:
          description: PMS table name.
          type: string
          minLength: 0
          maxLength: 40
        valid:
          description: Indicates whether the UDF information is valid.
          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
      description: Used to hold user defined field of Date Type.
    profileAttachments:
      type: object
      description: Response object with the details of the attachments of a profile.
      properties:
        profileAttachments:
          description: List of Attachments associated with the requesting Profile.
          $ref: '#/components/schemas/attachmentsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileStayHistory:
      type: object
      description: Response object for showing stay history and future reservations of specific profile.
      properties:
        profileStayDetails:
          description: Type contains stay history and future reservations of the specific profile.
          $ref: '#/components/schemas/profileStayDetailsType'
        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
    awardStatusType:
      type: string
      description: Indicates that certificate is in use.
      enum:
      - Available
      - NotAvailable
      - InUse
    companyProfileType:
      type: object
      description: Type provides the detailed information about the profile and its children.
      properties:
        company:
          description: Detailed company information for this profile.
          $ref: '#/components/schemas/companyType'
        profileImage:
          description: The profile image.
          $ref: '#/components/schemas/imageSetType'
        addresses:
          description: List of customer addresses.
          type: object
          properties:
            addressInfo:
              description: Collection of Detailed information on an address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/addressInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        businessSegments:
          description: Business/Market Segment associated to the profile.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        territory:
          description: Territory associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        traceCode:
          description: Trace Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        ownerCode:
          description: Owner Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        influenceCode:
          description: Influence Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        telephones:
          description: List of Telephone Number Information
          type: object
          properties:
            telephoneInfo:
              description: Collection of Detailed information on telephone/fax for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/telephoneInfoType'
            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'
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        uRLs:
          description: List of Information on a URL for the customer.
          type: object
          properties:
            uRLInfo:
              description: Collection of Detailed information on web url/address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/uRLInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        comments:
          description: List of Notes for the customer.
          type: object
          properties:
            commentInfo:
              description: Collection of Detailed information on comments for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/commentInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        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'
            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'
            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
        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 associated with the profile.
          $ref: '#/components/schemas/eCertificatesType'
        subscriptions:
          description: List of profile subscriptions.
          $ref: '#/components/schemas/profileSubscriptionListType'
        localizationGuestType:
          description: Localization Guest Type associated to the profile.
          type: string
          minLength: 0
          maxLength: 20
        eligibleForFiscalFolio:
          description: Eligible for Fiscal Folio/Payload generation.
          type: string
          minLength: 0
          maxLength: 20
        profileType:
          description: Type of profile such as Agent, Company, Group and Source.
          $ref: '#/components/schemas/companyProfileTypeType'
        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
    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
    eCertificateGeneration:
      type: object
      description: Request object to issue E-Certificate.
      properties:
        eCertificateGenerationDetails:
          description: Details to issue E-Certificate.
          $ref: '#/components/schemas/eCertificateGenerationDetailsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stayMembershipAttachMode:
      description: Flag that indicates if membership should be attached or existing membership should be replaced.
      type: string
      enum:
      - ADD
      - REPLACE
    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
    checkProfileResultType:
      type: object
      description: Status of allowed actions, attached records, and indicators of the profile.
      properties:
        checkProfileInstruction:
          description: Indicates status of allowed actions, total number of attached records, or number of occurrences of indicator of a profile.
          $ref: '#/components/schemas/checkProfileInstructionType'
        exists:
          description: Indicates status of allowed actions, total number of attached records, or number of occurrences of indicator of a profile.
          type: boolean
    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
    duplicateExternalSubscriptions:
      type: object
      description: Response object for fetching subscriptions where the same OPERA profile is linked to multiple external profiles within the same external system.
      properties:
        duplicateExternalSubscriptionsList:
          description: A collection of subscriptions where the same OPERA profile is linked to multiple external profiles within the same external system.
          $ref: '#/components/schemas/duplicateExternalSubscriptionsListType'
        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'
    personNameType:
      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
    fBAStatusType:
      type: string
      description: Flexible benefit award has been reimbursed.
      enum:
      - Ordered
      - Attached
      - Posted
      - Settled
      - Reimbursed
    reProcessStageRecords:
      type: object
      description: Request object for processing the staged records.
      properties:
        jobId:
          description: The IDs of the jobs created for Reprocessing Stage records.
          type: array
          items:
            type: string
        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
    applyToType:
      type: string
      description: Membership filter of staged profiles.
      enum:
      - StagedProfiles
      - MatchingProfiles
      - StagedAndMatchingProfiles
    resPaymentCardType:
      type: object
      description: Information on a credit card for the customer.
      properties:
        cardId:
          description: credit card id
          $ref: '#/components/schemas/uniqueID_Type'
        currentAuthorizedAmount:
          $ref: '#/components/schemas/currencyAmountType'
        approvalAmountNeeded:
          $ref: '#/components/schemas/currencyAmountType'
        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
    suspendedProfilesMatchStatsByProperty:
      type: object
      description: Response object for fetch suspended profiles match statistics grouped by property.
      properties:
        suspendedProfilesMatchStatsByProperty:
          description: Provides the information for suspended profiles match statistics grouped by property.
          $ref: '#/components/schemas/suspendedProfilesMatchStatsByPropertyType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    bankAccountType:
      type: object
      description: Bank account information like Account ID, Bank Name, Currency, etc.
      properties:
        hotelId:
          description: Property of the bank account.
          type: string
          minLength: 0
          maxLength: 20
        bankAccountId:
          description: Bank account ID.
          $ref: '#/components/schemas/uniqueID_Type'
        bankAccountNo:
          description: Account number at the bank.
          type: string
          minLength: 0
          maxLength: 80
        bankCode:
          description: Unique code of the bank account.
          type: string
          minLength: 0
          maxLength: 20
        branchCode:
          description: Code for the branch of the bank.
          type: string
          minLength: 0
          maxLength: 20
        bankName:
          description: Name of the bank account.
          type: string
          minLength: 0
          maxLength: 2000
        paymentMethod:
          description: Type of payment associated with the bank account.
          $ref: '#/components/schemas/commissionPaymentMethodType'
        checkFormat:
          description: Type of format for Payment Method.
          type: string
          minLength: 0
          maxLength: 80
        currency:
          description: Currency associated with the bank account.
          $ref: '#/components/schemas/codeDescriptionType'
        currentCheckNo:
          description: Current check no of the bank account.
          type: number
        hotelName:
          description: Property name of the bank account.
          type: string
          minLength: 0
          maxLength: 80
        default:
          description: Whether this bank account is to be the default in case no bank account is associated with the travel agent or source.
          type: boolean
        linkedToProfile:
          description: Whether this bank account is associated with the travel agent or source.
          type: boolean
    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'
    suspendedProfilesErrorSummaryType:
      type: object
      description: Type which represents suspended profile errors information.
      properties:
        errorDescription:
          description: Represents error description of the suspended profile.
          type: string
          minLength: 0
          maxLength: 2000
        errorCount:
          description: Number of profiles that were encountered with this error.
          type: integer
    indicatorsType:
      type: array
      description: Collection of lamp indicators.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/indicatorType'
    addtionalCodeInfoType:
      type: array
      description: Holds name of additional code information
      maxItems: 4000
      items:
        type: object
        properties:
          name:
            description: Holds name of additional code information
            $ref: '#/components/schemas/masterInfoCodeDetailType'
          value:
            description: Holds value of additional code information
            type: string
            minLength: 0
            maxLength: 2000
    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'
        status:
          description: Status of the room ownership record.
          type: string
    uniqueID_Type:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
    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
        isValidated:
          description: Indicator to define if the Phone number is validated by the Phone Validation System.
          type: boolean
    stagedProfileStatus:
      type: string
      description: Simple type for status of the staged profiles.
      enum:
      - Valid
      - Invalid
      - MatchFound
      - New
    profileTypeEnum:
      type: string
      enum:
      - Guest
      - Agent
      - Company
      - Group
      - Source
      - Employee
      - Hotel
      - Vendor
      - Contact
      - Purge
      - BusinessHeader
      - BillingAccount
      - Activity
      - Potential
      - Account
    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
    tierAdministrationType:
      type: string
      description: Do not upgrade membership. The membership may be downgraded.
      enum:
      - Disabled
      - NoUpgrade
    copyInstructionType:
      type: string
      description: Copy Instruction for a profile
      enum:
      - Keyword
    profileActivityLog:
      type: object
      description: Response object for fetching profile activity log. This object contains collection of user activity log for the profile,Success,Warnings and Errors related to this operation
      properties:
        activityLog:
          description: Collection of user activity log for the profile.
          $ref: '#/components/schemas/activityLogListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    basicEmailListType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/basicEmailType'
    checkProfilesType:
      type: array
      description: Collection of profiles and the status of its allowed actions, attached records, and indicators.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/checkProfileType'
    stagedProfileNegotiatedRateType:
      type: object
      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
        errorDescription:
          description: The error in negotiated rate information in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        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
      description: This holds a list of NegotiatedInfoType.
    stayMembershipsType:
      type: object
      properties:
        membershipNumber:
          description: A unique value given to a membership.
          type: string
        membershipType:
          description: Specifies the type of membership.
          type: string
    traceResolveType:
      type: object
      properties:
        resolvedOn:
          description: Date the trace was resolved
          type: string
          format: date
          maxLength: 8
        resolvedBy:
          description: User that resolved the trace
          type: string
    checkProfileResultsType:
      type: array
      description: Collection of status of allowed actions, attached records, and indicators of the profile.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/checkProfileResultType'
    resCommunicationType:
      type: object
      description: Communication details for a reservation.
      properties:
        telephones:
          description: List of Telephone Number Information
          type: object
          properties:
            telephoneInfo:
              description: Collection of Detailed information on telephone/fax for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/telephoneInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        emails:
          description: List of email address for the customer.
          type: object
          properties:
            emailInfo:
              description: Collection of Detailed information on an eMail address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/emailInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
    masterInfoType:
      type: object
      properties:
        codeInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/codeInfoType'
        codeType:
          $ref: '#/components/schemas/masterType'
    stagedProfileIdentificationsType:
      type: object
      properties:
        identification:
          description: Detailed information on the identification of the customer.
          $ref: '#/components/schemas/identificationType'
        errorDescription:
          description: The error in negotiated rate information in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        documentResort:
          description: Hotel code to which the document belongs.
          type: string
          minLength: 0
          maxLength: 20
        inactiveDate:
          description: The date when the record was inactivated.
          type: string
          format: date
          maxLength: 8
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
      description: Information on the identification of the customer.
    dateTimeSpanType:
      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:
        startDateTime:
          type: string
          format: date-time
        endDateTime:
          type: string
          format: date-time
    stagedProfileAddressType:
      type: object
      properties:
        address:
          description: Address details for the profile.
          $ref: '#/components/schemas/addressType'
        errorDescription:
          description: The error in address information in a staged profile with an invalid status
          type: string
          minLength: 0
          maxLength: 2000
        inactiveDate:
          description: Inactivation date of the record.
          type: string
          format: date
          maxLength: 8
        postalCodeExtension:
          description: Postal code extension.
          type: string
          minLength: 0
          maxLength: 15
        barCode:
          description: The postal barcode for the address.
          type: string
          minLength: 0
          maxLength: 100
        cleansStatus:
          description: Status of Address Cleansing.
          $ref: '#/components/schemas/stagedAddressCleansStatus'
        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
      description: Provides address information.
    basicEmailType:
      type: string
      description: Email address
      minLength: 0
      maxLength: 2000
    aRInvoicesType:
      type: array
      description: A collection of AR Invoices.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/aRInvoiceType'
    profileCommissionType:
      type: object
      description: This is the preconfigured routing instruction type.
      properties:
        hotelId:
          description: Hotel Code for the commission being used for a profile.
          type: string
          minLength: 0
          maxLength: 20
        commissionCode:
          description: commission Code for a profile.
          type: string
          minLength: 0
          maxLength: 20
        bankAccount:
          description: Bank account used for the commission for a profile.
          type: string
          minLength: 0
          maxLength: 20
        paymentMethod:
          description: Type of payment associated with the bank account.
          $ref: '#/components/schemas/commissionPaymentMethods'
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
    identificationType:
      type: object
      description: Identification information of the customer.
      properties:
        idType:
          description: Identification Type. Eg Passport, Driving License etc.
          type: string
          minLength: 0
          maxLength: 40
        idNumber:
          description: Identification Number.
          type: string
          minLength: 0
          maxLength: 80
        idNumberMasked:
          description: Masked Identification Number.
          type: string
          minLength: 0
          maxLength: 80
        issuedCountry:
          description: The country where Identification was issued.
          type: string
          minLength: 0
          maxLength: 20
        issuedDate:
          description: Issued date of Identification.
          type: string
          format: date
          maxLength: 8
        issuedPlace:
          description: The place where Identification was issued.
          type: string
          minLength: 0
          maxLength: 80
        expirationDate:
          description: Expiration date of Identification.
          type: string
          format: date
          maxLength: 8
        registeredProperty:
          description: Property where the identification belongs to.
          type: string
          minLength: 0
          maxLength: 20
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    articleInfoType:
      type: object
      description: Information regarding an article.
      properties:
        description:
          description: Description of the article.
          type: string
          minLength: 0
          maxLength: 2000
        transactionCode:
          description: Transaction code to which the article belongs.
          type: string
          minLength: 0
          maxLength: 20
        price:
          description: Default price of the article.
          $ref: '#/components/schemas/currencyAmountType'
        postIt:
          description: Post it information of the article.
          $ref: '#/components/schemas/articlePostItType'
        universalProductCode:
          description: Unique Universal product code of the article.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel code to which the article belongs.
          type: string
          minLength: 0
          maxLength: 20
        articleCode:
          description: Unique code of the article.
          type: string
          minLength: 0
          maxLength: 20
        inactive:
          description: Indicates whether the article is inactive or not.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    profileMatchTypeType:
      type: object
      description: Provides information about the profiles matched.
      properties:
        personName:
          description: Provides name information of the owner.
          $ref: '#/components/schemas/personNameType'
        address:
          description: Address details for the profile.
          $ref: '#/components/schemas/addressType'
        profileIdList:
          description: List of unique identifier of matching profile.
          $ref: '#/components/schemas/uniqueIDListType'
        email:
          description: Email of the profile.
          type: string
          minLength: 0
          maxLength: 2000
        telephone:
          description: Guest telephone number.
          type: string
          minLength: 0
          maxLength: 40
        legalCompany:
          description: Name Of the company the individual is associated with.
          type: string
          minLength: 0
          maxLength: 80
        matchPercentage:
          description: Percentage profile is matched with given profile.
          type: number
        membershipCardNo:
          description: Indicates Membership Card Number.
          type: string
          minLength: 0
          maxLength: 50
    relationshipProfileType:
      type: object
      properties:
        customer:
          description: Detailed information of the customer
          $ref: '#/components/schemas/customerType'
        company:
          description: Detailed information of the Company.
          $ref: '#/components/schemas/companyType'
        telephone:
          description: Information on telephone details for the customer/company
          $ref: '#/components/schemas/telephoneInfoType'
        address:
          description: Information on address details for the customer/company
          $ref: '#/components/schemas/addressInfoType'
        email:
          description: Information on email address for the customer/company
          $ref: '#/components/schemas/emailInfoType'
        uRLs:
          description: Information on web url/address for the customer/company
          $ref: '#/components/schemas/uRLInfoType'
        primaryOwner:
          description: Primary Owner of the profile
          $ref: '#/components/schemas/ownerType'
        profileIdList:
          description: Original profile details for which the relationships was created
          $ref: '#/components/schemas/uniqueIDListType'
        changeProfileIdList:
          description: Updated/changed profile details for the relationships created
          $ref: '#/components/schemas/uniqueIDListType'
        primary:
          description: Indicates if this relationship is the primary relationship.
          type: string
          minLength: 0
          maxLength: 20
        id:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        statusCode:
          description: Status of the profile. Active/Inactive
          $ref: '#/components/schemas/profileStatusType'
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
    stagedProfileCommentInfoType:
      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
        lineNo:
          description: The line number of the comment.
          type: integer
        inActiveDate:
          description: Indicates comment inactive date.
          type: string
          format: date
          maxLength: 8
        errorDescription:
          description: The error in a user defined field in a staged profile with an invalid status.
          type: string
          minLength: 0
          maxLength: 2000
        valid:
          description: Indicates whether the comment information is valid.
          type: boolean
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
        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
    futurePastBookingsCriteria:
      type: object
      description: Request for information regarding existence of profile in future and/or past business blocks and/or reservations.
      properties:
        criteria:
          description: Criteria to determine if search should be restricted to future and/or past business blocks and/or reservations, restricted to rate code, or restricted to exclude a given list of reservations and/or blocks.
          $ref: '#/components/schemas/hasFuturePastBookingsSearchType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    shortInfoProfileType:
      type: object
      description: This type contains short information of a profile.
      properties:
        nameId:
          description: Unique id for the profile.
          type: string
          minLength: 0
          maxLength: 80
        displayName:
          description: Name that will be displayed for the profile, it is the combination of last name and first name of a profile.
          type: string
          minLength: 0
          maxLength: 160
        clientId:
          description: Corporate id of the profile.
          type: string
          minLength: 0
          maxLength: 20
    masterAccountInfoType:
      type: object
      properties:
        masterAccountId:
          description: Unique ID of the Master account.
          $ref: '#/components/schemas/uniqueID_Type'
        masterAccountName:
          description: Name of the Master account.
          type: string
          minLength: 0
          maxLength: 40
    numericUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Numeric Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/numericUDFType'
    profileSummariesType:
      type: object
      description: A complex type containing the collection of Profile objects or Unique IDs of Profiles.
      properties:
        profileInfo:
          description: A collection of Profiles or Unique IDs of Profiles.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/profileSummaryInfoType'
        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
    activityLogType:
      type: object
      properties:
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        module:
          type: string
        logDate:
          type: string
          format: date-time
        refActionId:
          type: number
        logUserId:
          type: integer
        logUserName:
          type: string
        machineStation:
          type: string
        croCode:
          type: string
          minLength: 0
          maxLength: 20
        actionType:
          type: string
          minLength: 0
          maxLength: 100
        actionDescription:
          type: string
          minLength: 0
          maxLength: 2000
        iPAddress:
          description: The IP Address of the machine that performed the activity
          type: string
          minLength: 0
          maxLength: 2000
        deviceCode:
          description: The selected device code
          type: string
          minLength: 0
          maxLength: 2000
    masterType:
      type: string
      enum:
      - Country
      - State
      - AddressType
      - PhoneType
      - RateCategory
      - CalculationRule
      - PostingRythym
      - BillingInstruction
      - TransactionCode
      - DisplaySet
      - MailingActions
      - DistanceType
      - District
      - Territory
      - FiscalRegion
      - InventoryItem
      - Package
      - RoomFeaturePreference
      - SpecialPreference
      - Promotion
      - Department
      - ReservationPreference
      - FacilityTask
      - RoomType
      - RateCode
      - OutOfOrderReason
      - Block
    resGuaranteeType:
      type: object
      description: Validations type record returned after Validations are done.
      properties:
        guaranteeCode:
          description: Guarantee Code.
          type: string
          minLength: 0
          maxLength: 20
        shortDescription:
          description: Guarantee Code.
          type: string
          minLength: 0
          maxLength: 80
        onHold:
          description: Guarantee Code.
          type: boolean
    phoneNumberType:
      type: string
      description: Phone number
      minLength: 0
      maxLength: 40
    synchronizeProfileSubscriptionsCriteriaType:
      type: object
      description: Criteria for searching profile subscriptions.
      properties:
        profileId:
          description: Unique ID of the profile.
          $ref: '#/components/schemas/profileId'
        databaseIds:
          description: List of codes identifying the external database record which is linked to external systems.
          $ref: '#/components/schemas/databaseIDListType'
    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
    accountForecastType:
      type: object
      description: Detail Information about Account Forecast.
      properties:
        hotelId:
          description: Hotel Code
          type: string
          minLength: 0
          maxLength: 20
        accountId:
          description: Unique Account ID
          $ref: '#/components/schemas/uniqueID_Type'
        periodCode:
          description: Specifies the Fiscal or Calendar Period Code for the forecast
          type: string
          minLength: 0
          maxLength: 20
        periodDescription:
          description: Specifies the Fiscal or Calendar Period Description for the forecast.
          type: string
          minLength: 0
          maxLength: 100
        periodStartDate:
          description: Specifies the Period Start Date
          type: string
          format: date
          maxLength: 8
        periodEndDate:
          description: Specifies the Period End Date
          type: string
          format: date
          maxLength: 8
        roomNights:
          description: Room Nights for the forecast
          type: integer
        averageRate:
          description: Average Rate for the forecast
          $ref: '#/components/schemas/currencyAmountType'
        roomRevenue:
          description: Room Revenue for the forecast
          $ref: '#/components/schemas/currencyAmountType'
        foodAndBeverageRevenue:
          description: Food and Beverage revenue for the forecast
          $ref: '#/components/schemas/currencyAmountType'
        otherRevenue:
          description: Other revenue (For example, function space rental, equipment rental, etc.) of forecast.
          $ref: '#/components/schemas/currencyAmountType'
        totalRevenue:
          description: Total revenue for the forecast
          $ref: '#/components/schemas/currencyAmountType'
        overrideForecast:
          description: This element is used for overriding any existing forecasts for a profile, Please select Default, if you want to be notified of a warning message. No Forecast is overridden or created. Please select Override, if existing forecasts are to be overridden and new forecasts are to be created. Please select DoNotOverride, if existing forecasts are not to be overridden and new forecasts are to be created.
          $ref: '#/components/schemas/overrideForecastTypeType'
    reProcessStageRecordsLogInfo:
      type: object
      description: Response object for fetch reProcessStageRecords logs.
      properties:
        logs:
          type: array
          description: List of reprocess/rematch job logs.
          items:
            $ref: '#/components/schemas/reProcessStageRecordLogEntry'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
        totalPages:
          description: Evaluated total page count based on the requested max fetch count
          type: integer
        offset:
          description: Page offset index
          type: integer
        limit:
          description: Maximum number of records returned
          type: integer
        count:
          description: Number of records in current response
          type: integer
        totalResults:
          description: Total number of records matching criteria
          type: integer
        hasMore:
          description: Whether more results are available to fetch
          type: boolean
    stringLength40:
      type: string
      description: Used for Character Strings, length 0 to 40.
      maxLength: 40
      minLength: 0
    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
    reservationCertificateType:
      type: string
      description: Certificate is incentive.
      enum:
      - Reward
      - Incentive
    awardKindType:
      type: string
      description: Indicates that this is electronic certificate.
      enum:
      - Paper
      - ECertificate
    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
    attachmentsType:
      type: array
      description: Attachment List.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/attachmentType'
    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
        isValidated:
          description: Indicator to define if the Email is validated by the Email Validation System.
          type: boolean
    validatedForgetProfiles:
      type: object
      description: Response object for validating profiles for forgetting.
      properties:
        validateForgetProfilesResults:
          description: Results of validation.
          $ref: '#/components/schemas/forgetProfileResultListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    fixedChargeType:
      type: object
      description: Holds fixed charge information.
      properties:
        schedule:
          description: Holds schedule of fixed charge.
          $ref: '#/components/schemas/fixedChargeScheduleType'
        charge:
          description: Holds specific details of fixed charge.
          $ref: '#/components/schemas/fixedChargeDetailType'
        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
    eCertificateToVerify:
      type: object
      description: Request object to Verify an E-Certificate Number.
      properties:
        certificateId:
          description: System generated unique certificate id.
          type: integer
        certificateNo:
          description: Unique Certificate Number.
          $ref: '#/components/schemas/stringLength40'
        allowReservation:
          description: Indicates if certificate is to be used against reservation or not.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    codeInfoType:
      type: object
      description: ''
      properties:
        description:
          type: string
          minLength: 0
          maxLength: 80
        addtionalCodeInfo:
          $ref: '#/components/schemas/addtionalCodeInfoType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        code:
          type: string
          minLength: 0
          maxLength: 20
    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
    trxCodesInfoType:
      type: array
      description: List of Transaction codes info.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/trxInfoType'
    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
    reservationAllowedActionsType:
      type: array
      description: Allowed action.
      maxItems: 11
      items:
        $ref: '#/components/schemas/reservationAllowedActionType'
    searchMatchesType:
      type: array
      description: List of Generic Name-Value-Pair Parameters used for super search matches.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/searchMatchType'
    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
    stringLength200:
      type: string
      description: Used for Character Strings, length 0 to 200.
      maxLength: 200
      minLength: 0
    marketCodeInfoType:
      type: object
      properties:
        marketCode:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        marketGroup:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
    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
    copyInstructionsType:
      type: object
      description: Copy Instructions for a profile
      properties:
        instructions:
          type: array
          description: List of the profile details to be copied
          items:
            $ref: '#/components/schemas/copyInstructionType'
    stayDetailType:
      type: object
      description: The Reservation class contains the current reservation being created or altered.
      properties:
        reservationIdList:
          description: Unique identifiers for the reservation for both internal and external systems
          $ref: '#/components/schemas/reservationIdList'
        roomStay:
          description: Collection of room stays.
          $ref: '#/components/schemas/stayInfoType'
        reservationGuest:
          description: Collection of guests associated with the reservation.
          $ref: '#/components/schemas/resGuestInfoType'
        sharedGuests:
          description: Collection of guests who share this reservation.
          $ref: '#/components/schemas/resSharedGuestListType'
        attachedProfiles:
          description: List of attached profiles
          $ref: '#/components/schemas/resAttachedProfileListType'
        reservationPaymentMethod:
          description: Payment method used for this reservation
          $ref: '#/components/schemas/reservationPaymentMethodType'
        reservationFolioWindows:
          description: Collection of reservation folio windows.
          $ref: '#/components/schemas/reservationFolioWindowsType'
        specials:
          description: Set of reservation preferences which belongs to the Specials group.
          type: string
          minLength: 0
          maxLength: 4000
        lastPrivacyPromptDate:
          description: Last Privacy Prompt Date
          type: string
          format: date
          maxLength: 8
        displayColor:
          description: Color setting of the reservation.
          type: string
          minLength: 0
          maxLength: 20
        reservationIndicators:
          description: Indicators of additional information attached to the reservation
          $ref: '#/components/schemas/indicatorsType'
        roomStatus:
          description: Current room status
          $ref: '#/components/schemas/housekeepingRoomStatusType'
        searchMatches:
          description: Super Search matching terms.
          $ref: '#/components/schemas/searchMatchesType'
        sourceOfSale:
          description: Point of Sale of reservation. Identifies the entity/channel who made the reservation.
          $ref: '#/components/schemas/sourceOfSaleType'
        waitlist:
          description: Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.
          $ref: '#/components/schemas/waitlistResType'
        queue:
          description: Information about the time and duration this reservation was on Queue for Checkin.
          $ref: '#/components/schemas/reservationQueueInformationType'
        housekeeping:
          description: Information regarding housekeeping for this reservation.
          $ref: '#/components/schemas/resHousekeepingType'
        cashiering:
          description: Holds cashiering related information for the reservation.
          $ref: '#/components/schemas/resCashieringType'
        taxType:
          description: This stores the code for the type of tax calculation especially with tax exemption, etc.
          $ref: '#/components/schemas/taxTypeType'
        deposit:
          description: Holds reservation deposit information.
          $ref: '#/components/schemas/reservationDepositType'
        allowedActions:
          description: Collection of reservation allowed actions.
          $ref: '#/components/schemas/reservationAllowedActionsType'
        revenuesAndBalances:
          description: Revenues and Balances Amount summary for the reservation.
          $ref: '#/components/schemas/resRevenueBalanceType'
        hotelInterfaceStatusList:
          description: Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationInterfaceStatusType'
        guestPreferredCurrency:
          description: Currency code preferred by guest.
          type: string
          minLength: 0
          maxLength: 20
        turndownInfo:
          description: Currency code preferred by guest.
          $ref: '#/components/schemas/reservationTurndownInfoType'
        mobileNotifications:
          description: Denotes the status of Room Ready, Key Ready messages.
          $ref: '#/components/schemas/resMobileNotificationsType'
        reservationCommunication:
          description: Collection of reservation communication details.
          $ref: '#/components/schemas/resCommunicationType'
        advanceCheckIn:
          description: Information relating to Reservation's Advance Checked In state and Expected Time of Return
          $ref: '#/components/schemas/advanceCheckInType'
        welcomeOffer:
          description: This flag will determine wheather the reservation is eligible for Welcome Offer or not.
          type: boolean
        cancellationInfo:
          description: Information regarding why reservation has been/was cancelled.
          type: object
          properties:
            description:
              type: string
              minLength: 0
              maxLength: 2000
            code:
              type: string
              minLength: 0
              maxLength: 20
            date:
              description: Date when reservation was last cancelled.
              type: string
              format: date
              maxLength: 8
        keyCount:
          description: Number of keys created for the reservation.
          type: integer
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        hotelName:
          type: string
          minLength: 0
          maxLength: 80
        expectedServiceTime:
          type: string
          minLength: 0
          maxLength: 20
        roomStayReservation:
          description: Boolean True if this reservation is reserving rooms. False if it is only reserving services.
          type: boolean
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee 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
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
        reservationStatus:
          description: Indicates the status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
        computedReservationStatus:
          description: Indicates the status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
        walkInIndicator:
          description: When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.
          type: boolean
        accessRestriction:
          description: Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.
          $ref: '#/components/schemas/resAccessRestrictionType'
        commissionPayoutTo:
          description: If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.
          $ref: '#/components/schemas/commissionPayoutToType'
        paymentMethod:
          description: Payment Method.
          type: string
          minLength: 0
          maxLength: 20
        preRegistered:
          description: Defines if the reservation is pre-registered or not.
          type: boolean
        openFolio:
          description: Returns true when reservation has an open folio.
          type: boolean
        allowMobileCheckout:
          description: Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.
          type: boolean
        allowMobileViewFolio:
          description: Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.
          type: boolean
        optedForCommunication:
          description: Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.
          type: boolean
        complimentaray:
          description: Indicates the profile stay record is complimentaray.
          type: boolean
        reservationSourceCode:
          description: Indicates the profile stay record reservation source code.
          type: string
          minLength: 0
          maxLength: 20
        reservationSourceType:
          description: Indicates the profile stay record reservation source Type.
          type: string
          minLength: 0
          maxLength: 50
        shareNumber:
          description: Indicates the share Number for Stay if reservation was a share.
          type: string
          minLength: 0
          maxLength: 20
        bookingDate:
          description: Booking date of the stay record.
          type: string
          format: date
          maxLength: 8
        bookedArrivalDate:
          description: Booked arrival date of the stay record.
          type: string
          format: date
          maxLength: 8
        bookedDepartureDate:
          description: Booked departure date of the stay record.
          type: string
          format: date
          maxLength: 8
        cancellationDate:
          description: Cancellation date of the stay record.
          type: string
          format: date
          maxLength: 8
        cancelledRoomNights:
          description: Number of cancelled room nights.
          type: integer
        noShowRoomNights:
          description: Number of no show room nights.
          type: integer
        travelAgentReferenceId:
          description: Travel Agent reference number for stay record.
          type: string
          minLength: 0
          maxLength: 60
        allotmentCode:
          description: Allotment Code for stay record.
          type: string
          minLength: 0
          maxLength: 20
        primarySharer:
          description: Indicates whether the guest was the primary sharer or not.
          type: boolean
        exchangeRate:
          description: Exchange Rate.
          type: number
        promotionCode:
          description: Promotion code associated with the stay.
          type: string
          minLength: 0
          maxLength: 20
        bookedRoomType:
          description: Indicate the category of room originally booked.
          type: string
          minLength: 0
          maxLength: 20
        channelCode:
          description: Indicate channel for stay.
          type: string
          minLength: 0
          maxLength: 20
        stayRecordId:
          description: Stay Record identifier.
          $ref: '#/components/schemas/uniqueID_Type'
        userDefinedFields:
          description: Collection of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
    aRPaymentType:
      type: object
      description: Details of an AR Payment.
      properties:
        age:
          description: The Aging age of the payment.
          type: integer
        amount:
          description: Amount of the Payment.
          $ref: '#/components/schemas/currencyAmountType'
        amountUsed:
          description: Total amount applied against an invoice.
          $ref: '#/components/schemas/currencyAmountType'
        balance:
          description: Amount still open which has not been applied against any invoice.
          $ref: '#/components/schemas/currencyAmountType'
        reference:
          description: User-defined posting reference.
          type: string
          minLength: 0
          maxLength: 2000
        remark:
          description: User-defined posting remark.
          type: string
          minLength: 0
          maxLength: 2000
        cashierInfo:
          description: Cashier information. Contains Id and Name details of the cashier.
          $ref: '#/components/schemas/cashierInfoType'
        paymentCard:
          description: Payment card details.
          $ref: '#/components/schemas/resPaymentCardType'
        transferredOut:
          type: boolean
        transferredIn:
          type: boolean
        hotelId:
          description: Property code.
          type: string
          minLength: 0
          maxLength: 20
        transactionNo:
          description: Unique Transaction Identifier of the Payment.
          type: number
        transactionDate:
          description: Date of the Payment.
          type: string
          format: date
          maxLength: 8
        transactionCode:
          description: Transaction code of the Payment.
          type: string
          minLength: 0
          maxLength: 20
        postingDate:
          description: Posting date of the invoice.
          type: string
          format: date
          maxLength: 8
        revenueDate:
          description: Revenue date ID of the invoice.
          type: string
          format: date
          maxLength: 8
        transferDate:
          description: Transfer of the invoice.
          type: string
          format: date
          maxLength: 8
        sequenceNo:
          description: When this PostingType is used to return the postings generated by a batch request, the sequence number is used to relate to the Request's sequence number.
          type: integer
    suspendedProfilesMatchStatByProfileType:
      type: object
      description: Type which represents suspended profiles match statistics grouped by profile type.
      properties:
        matchCriteria:
          description: Criteria used to for matching two profiles.
          type: string
          minLength: 0
          maxLength: 80
        profileType:
          description: Type of the suspended profile.
          $ref: '#/components/schemas/suspendedProfileType'
        count:
          description: Number of records with this match criteria and property.
          type: integer
    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
    fixedChargeFrequencyType:
      type: string
      description: Yearly.
      enum:
      - O
      - D
      - W
      - M
      - Q
      - Y
    checkProfileInstructionType:
      type: string
      description: Simple type that corresponds to check profile instructions.
      enum:
      - HasWebAccounts
    orphanStayRecordType:
      type: object
      description: This object stores the elements which user wants to update.
      properties:
        bookedRoomLabel:
          type: string
          minLength: 0
          maxLength: 50
          description: Indicates the booked room type for the Stay Record.
        crsBookNo:
          type: string
          minLength: 0
          maxLength: 50
          description: Indicates the Central Reservation System (CRS) Booking Number
        guestNameId:
          type: number
          description: Indicates the internal Profile ID for the guest.
        numberOfNights:
          type: number
          description: Indicates the Number of nights for the given stay
        pmsCompanyId:
          type: string
          minLength: 0
          maxLength: 20
          description: Indicates the internal Company Profile Id linked to the reservation (stay).
        pmsNameId:
          type: string
          minLength: 0
          maxLength: 20
          description: Indicates the internal Profile Id.
        pmsResvNo:
          type: string
          minLength: 0
          maxLength: 50
          description: Indicates the Property (PMS) Reservation Number.
        pmsResvNameId:
          type: string
          minLength: 0
          maxLength: 50
          description: Indicates the internal Property (PMS) Reservation Id.
        pmsTravelId:
          type: string
          minLength: 0
          maxLength: 240
          description: Indicates the internal Travel Agent Profile Id linked to the reservation (stay).
        pmsWholesalerId:
          type: string
          minLength: 0
          maxLength: 20
          description: Indicates the internal Wholesaler Profile Id linked to the reservation (stay).
        roomLabel:
          type: string
          minLength: 0
          maxLength: 50
          description: Indicates the room type for the Stay Record.
        udfc10:
          type: string
          minLength: 0
          maxLength: 200
          description: Indicates the character UDF 10 for the Stay Record.
    anonymizationStatusType:
      type: string
      description: Guest has been anonymized.
      enum:
      - Requested
      - Anonymized
    characterUDFType:
      type: object
      description: Used to hold user defined field of Character/String Type.
      properties:
        name:
          description: Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: string
          minLength: 0
          maxLength: 2000
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    commissionPaymentMethodType:
      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
        format:
          description: Payment format if the payment method is EFT.
          type: string
          minLength: 0
          maxLength: 3
    flexFieldValueType:
      type: object
      description: Provides the details of a flex field values
      properties:
        code:
          description: Flex field code
          type: string
          minLength: 0
          maxLength: 20
        flexFieldValue:
          description: 'value of the Dynamic Field '
          type: string
          minLength: 0
          maxLength: 200
        hotelId:
          description: Hotel Code
          type: string
          minLength: 1
          maxLength: 20
    searchProfilesRequest:
      type: object
      properties:
        excludeInactive:
          type: boolean
          description: Indicates whether to exclude Inactive Profiles, when true indicates that only profiles with active status will be displayed.
        hotelId:
          type: string
          description: Hotel Code, It is used to filter hotel specific children to this specific hotel code.
        includeHasHierarchyOnly:
          type: boolean
          description: Include profiles that have one or more relationships in the search.
        includePrimaryOwnersOnly:
          type: boolean
          description: Include primary owners in the search.
        includePurgeProfiles:
          type: boolean
          description: Include purged profiles in the search.
        limit:
          type: integer
          description: Indicates maximum number of records a Web Service should return.
        offset:
          type: integer
          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.
          default: 0
        searchType:
          $ref: '#/components/schemas/searchTypeEnum'
          description: When search type is PatronTrackingSystemMemberProfiles, the FetchProfiles will return the Membership Number of the searched Membership Type regardless of primary flag or sequence of the profile memberships.
        summaryInfo:
          type: boolean
          description: When true response will return summary information otherwise detailed information.
        searchString:
          type: string
          description: Search string to be used for super search.
        includeAnonymized:
          type: boolean
          description: Indicates whether to include Anonymized Profiles.
        profileType:
          type: array
          items:
            $ref: '#/components/schemas/profileTypeEnum'
          description: The types of Profile handled by the web service.
        profileIds:
          type: array
          items:
            type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        externalReferenceIds:
          type: array
          items:
            type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        externalSystemCodes:
          type: array
          items:
            type: string
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        corporateIds:
          type: array
          items:
            type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        profileName:
          type: string
          description: Family name, last name or Company Name.
        givenName:
          type: string
          description: Given name, first name or names.
        incognitoName:
          type: string
          description: Family name, last name or Company Name.
        incognitoGivenName:
          type: string
          description: Given name, first name or names.
        city:
          type: string
          description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
        postalCode:
          type: string
          description: Post Office Code number.
        state:
          type: string
          description: State or Province name (e.g., Texas).
        countryCode:
          type: string
          description: Code for a country or a nationality.
        streetAddress:
          type: string
          description: First Line of Street Address. For profile search it matches the first Address line.
        keyword:
          type: string
          description: Keyword associated to the profile.
        communication:
          type: string
          description: Any communication method associated to the profile such as phone, fax, email address.
        membership:
          type: string
          description: Membership number associated to the profile.
        membershipType:
          type: string
          description: Member Type of searching profile.
        ownerCodes:
          type: array
          items:
            type: string
            maxItems: 4000
        membershipLevel:
          type: string
          description: Membership level associated to the profile.
        aRNumber:
          type: string
          description: Account Receivable associated to the profile.
        taxId:
          type: string
          description: Tax ID associated to the profile
        businessSegment:
          type: array
          items:
            type: string
            maxItems: 4000
          description: Business/Market Segment associated to the profile.
        accountsReceivables:
          type: boolean
          description: When true indicates that only profiles with AR account fetched.
        corporateProfiles:
          type: boolean
          description: When true indicates that only profiles with client id are searched for.
        excludeIncompleteProfiles:
          type: boolean
          description: When true indicates that only profiles with an Address Line 1 and Country or at least one Communications Type will be displayed.
        negotiatedRates:
          type: boolean
          description: When true indicates that this option has to be included in advanced search.
        relatedProfileExcludeInactive:
          type: boolean
          description: Indicates whether to exclude Inactive Profiles, when true indicates that only profiles with active status will be displayed.
        realtedProfileIncludeHasHierarchyOnly:
          type: boolean
          description: Include profiles that have one or more relationships in the search.
        relatedProfileNegotiatedRates:
          type: boolean
          description: When true indicates that this option has to be included in advanced search.
        relatedProfileType:
          $ref: '#/components/schemas/relatedProfileTypeEnum'
          description: The types of Profile handled by the web service.
        relatedProfileName:
          type: string
          description: Family name, last name or Company Name.
        protectedProfiles:
          type: boolean
          description: Indicates whether to exclude Protected Profiles.
        excludedProfilesId:
          type: array
          items:
            type: string
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        idExtension:
          type: array
          items:
            type: integer
          description: Additional identifying value assigned by the creating system. This query parameter is deprecated.
        excludedProfilesIdContext:
          type: array
          items:
            type: string
          description: Used to identify the source of the identifier (e.g., IATA, ABTA). This query parameter is deprecated.
        excludedProfilesIdType:
          type: array
          items:
            type: string
          description: A reference to the type of object defined by the UniqueID element. This query parameter is deprecated.
        identificationNo:
          type: string
          description: Any identification number associated with the profile such as Passport Number, StateID.
        fetchInstructions:
          type: array
          items:
            $ref: '#/components/schemas/fetchInstructionsEnum'
          description: Room Ownership information associated with the profile.
        allowedAction:
          type: array
          items:
            $ref: '#/components/schemas/allowedActionEnum'
          description: Flag indicating whether Profile is Enrolled to Primary Membership Program.
        vipCodes:
          type: array
          items:
            type: string
            maxItems: 4000
        prioritieCodes:
          type: array
          items:
            type: string
            maxItems: 4000
        birthDate:
          type: string
          format: date
          description: Date of birth
        phone:
          type: string
          description: The phone number associated to the profile.
        email:
          type: string
          description: The email address associated to the profile.
        lastStayBefore:
          type: string
          format: date
          description: Date to filter profiles with stays before.
    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
    externalReferenceType:
      type: object
      description: This type contains unique information of external reference.
      properties:
        id:
          description: Unique ID of external reference.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: ID context for external reference.
          type: string
          minLength: 0
          maxLength: 80
    profileAccessType:
      type: object
      properties:
        chainCode:
          description: Indicates the Chain code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        croCode:
          description: Indicates the CRO code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        hotelId:
          description: Indicates the Hotel code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        sharedLevel:
          description: 'Indicates whether the profile is shared at the following levels : global/property/CRO'
          $ref: '#/components/schemas/profileSharedLevelType'
    profileType:
      type: object
      description: Type provides the detailed information about the profile and its children.
      properties:
        customer:
          description: Detailed customer information for this profile.
          $ref: '#/components/schemas/customerType'
        company:
          description: Detailed company information for this profile.
          $ref: '#/components/schemas/companyType'
        profileImage:
          description: The profile image.
          $ref: '#/components/schemas/imageSetType'
        addresses:
          description: List of customer addresses.
          type: object
          properties:
            addressInfo:
              description: Collection of Detailed information on an address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/addressInfoType'
            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'
            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'
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        uRLs:
          description: List of Information on a URL for the customer.
          type: object
          properties:
            uRLInfo:
              description: Collection of Detailed information on web url/address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/uRLInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        comments:
          description: List of Notes for the customer.
          type: object
          properties:
            commentInfo:
              description: Collection of Detailed information on comments for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/commentInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        profileDeliveryMethods:
          description: List of Delivery methods configured against a Property for this Profile.
          type: object
          properties:
            profileDeliveryMethod:
              description: Collection of delivery methods for this Profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/profileDeliveryMethod'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        profileMemberships:
          description: List of loyalty program(s) the profile is subscribed to.
          type: object
          properties:
            profileMembership:
              description: Collection of Detailed information on memberships for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/profileMembershipType'
            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'
            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
        profileAccounts:
          description: Response of profile accounts.
          $ref: '#/components/schemas/aRAccountsType'
        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
        flexFieldExternalProfileId:
          description: Unique Identifier of the Profile on the External System that would be fetched against flexFieldExternalProfileId. (For internal use only).
          type: string
          minLength: 0
          maxLength: 80
        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'
        inactiveReason:
          description: Inactive reason associated with the current profile.
          type: string
          minLength: 0
          maxLength: 20
        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
        internalFolio:
          description: Flag considered during folio settlement, to select the corresponding Folio Type when the value is true. Only used in Poland country mode.
          type: boolean
    paragraphType:
      type: object
      description: An indication of a new paragraph for a sub-section of a formatted text message.
      properties:
        text:
          description: Formatted text content.
          $ref: '#/components/schemas/formattedTextTextType'
        url:
          description: A URL for this paragraph.
          type: string
    anonymizationType:
      type: object
      description: Provides information about guest's anonymization status.
      properties:
        anonymizationStatus:
          description: Status of anonymization such as Requested or Anonymized.
          $ref: '#/components/schemas/anonymizationStatusType'
        anonymizationDate:
          description: Date and Time when the guest was anonymized.
          type: string
          format: date-time
    hotelInterfaceTypeType:
      type: string
      enum:
      - Bms
      - Cas
      - Ccw
      - Dls
      - Eft
      - Exp
      - Mak
      - Mbs
      - Msc
      - Pbx
      - Pos
      - Svs
      - Tik
      - Vid
      - Vms
      - Www
      - Xml
      description: XML Posting Interface
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