swagger: '2.0'
info:
  title: Event Streaming API
  description: The Event Management API provides a standardized client interface to the enterprise event management system.
  version: 4.0.0
host: serverRoot
basePath: /tmf-api/event/v4/
schemes:
  - https
consumes:
  - application/json;charset=utf-8
produces:
  - application/json;charset=utf-8
securityDefinitions:
  basicAuth:
    type: basic
  ApiKeyAuth:
    type: apiKey
    name: X-API-Key
    in: header
security:
  - ApiKeyAuth: []
  - basicAuth: []
tags:
  - name: event
  - name: topic
  - name: hub
  - name: notification listeners (client side)
  - name: events subscription
paths:
  /topic/{topicId}/event:
    get:
      operationId: listEvent
      summary: List or find Event objects
      description: This operation list or find Event entities
      tags:
        - event
      parameters:
        - name: topicId
          description: Identifier of the parent Topic entity
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/Event'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createEvent
      summary: Creates a Event
      description: This operation creates a Event entity.
      tags:
        - event
      parameters:
        - name: topicId
          description: Identifier of the parent Topic entity
          required: true
          type: string
          in: path
        - name: event
          description: The Event to be created
          required: true
          schema:
            $ref: '#/definitions/Event_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Event'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /topic/{topicId}/event/{id}:
    get:
      operationId: retrieveEvent
      summary: Retrieves a Event by ID
      description: This operation retrieves a Event entity. Attribute selection is enabled for all first level attributes.
      tags:
        - event
      parameters:
        - name: topicId
          description: Identifier of the parent Topic entity
          required: true
          type: string
          in: path
        - name: id
          description: Identifier of the Event
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Event'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /topic:
    get:
      operationId: listTopic
      summary: List or find Topic objects
      description: This operation list or find Topic entities
      tags:
        - topic
      parameters:
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/Topic'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createTopic
      summary: Creates a Topic
      description: This operation creates a Topic entity.
      tags:
        - topic
      parameters:
        - name: topic
          description: The Topic to be created
          required: true
          schema:
            $ref: '#/definitions/Topic_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Topic'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /topic/{id}:
    get:
      operationId: retrieveTopic
      summary: Retrieves a Topic by ID
      description: This operation retrieves a Topic entity. Attribute selection is enabled for all first level attributes.
      tags:
        - topic
      parameters:
        - name: id
          description: Identifier of the Topic
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Topic'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deleteTopic
      summary: Deletes a Topic
      description: This operation deletes a Topic entity.
      tags:
        - topic
      parameters:
        - name: id
          description: Identifier of the Topic
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /topic/{topicId}/hub:
    get:
      operationId: listHub
      summary: List or find Hub objects
      description: This operation list or find Hub entities
      tags:
        - hub
      parameters:
        - name: topicId
          description: Identifier of the parent Topic entity
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/Hub'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createHub
      summary: Creates a Hub
      description: This operation creates a Hub entity.
      tags:
        - hub
      parameters:
        - name: topicId
          description: Identifier of the parent Topic entity
          required: true
          type: string
          in: path
        - name: hub
          description: The Hub to be created
          required: true
          schema:
            $ref: '#/definitions/Hub_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Hub'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /topic/{topicId}/hub/{id}:
    get:
      operationId: retrieveHub
      summary: Retrieves a Hub by ID
      description: This operation retrieves a Hub entity. Attribute selection is enabled for all first level attributes.
      tags:
        - hub
      parameters:
        - name: topicId
          description: Identifier of the parent Topic entity
          required: true
          type: string
          in: path
        - name: id
          description: Identifier of the Hub
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Hub'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deleteHub
      summary: Deletes a Hub
      description: This operation deletes a Hub entity.
      tags:
        - hub
      parameters:
        - name: topicId
          description: Identifier of the parent Topic entity
          required: true
          type: string
          in: path
        - name: id
          description: Identifier of the Hub
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /hub:
    post:
      operationId: registerListener
      summary: Register a listener
      description: Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.
      tags:
        - events subscription
      parameters:
        - name: data
          schema:
            $ref: '#/definitions/EventSubscriptionInput'
          required: true
          in: body
          description: Data containing the callback endpoint to deliver the information
      responses:
        '201':
          description: Subscribed
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /hub/{id}:
    delete:
      operationId: unregisterListener
      summary: Unregister a listener
      description: Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.
      tags:
        - events subscription
      parameters:
        - name: id
          type: string
          required: true
          in: path
          description: The id of the registered listener
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method not allowed
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/topicCreateEvent:
    post:
      operationId: listenToTopicCreateEvent
      summary: Client listener for entity TopicCreateEvent
      description: Example of a client listener for receiving the notification TopicCreateEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/TopicCreateEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/topicChangeEvent:
    post:
      operationId: listenToTopicChangeEvent
      summary: Client listener for entity TopicChangeEvent
      description: Example of a client listener for receiving the notification TopicChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: sourceIdentifier
          required: false
          in: query
          description: source system details for routing purpose
          type: string
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/TopicChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/topicDeleteEvent:
    post:
      operationId: listenToTopicDeleteEvent
      summary: Client listener for entity TopicDeleteEvent
      description: Example of a client listener for receiving the notification TopicDeleteEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/TopicDeleteEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
definitions:
  Any: {}
  BillStructure:
    type: object
    description: The bill structure that associated to the customer.
    properties:
      cycleSpecification:
        description: The bill cycle that associated to the customer.
        $ref: '#/definitions/CycleSpecification'
      format:
        type: array
        description: The bill invoice format.
        items:
          $ref: '#/definitions/Format'
  CycleSpecification:
    type: object
    description: The customer bill cycle.
    properties:
      name:
        type: string
        description: Schedule Name, SV_MAPPING:Cust_Acct.InvoiceCycle_R
      preferredCurrency:
        type: string
        description: Preferred Currency, SV_MAPPING:Cust_Acct.Currency_R
        x-refdata-source: CM-Currency
      reportLevel:
        type: string
        description: Report Level, SV_MAPPING:Cust_Acct.ReportLevel_R
        x-refdata-source: RT-REPORT_LEVEL
      suppressBilling:
        type: string
        description: Suppress Billing Flag, SV_MAPPING:Cust_Acct.SuppressBilling_B, Possible value 1 and 0
      suppressCycles:
        type: string
        description: Suppress for number of Cycles, SV_MAPPING:Cust_Acct.SuppressCycles_I
      suppressUntilDate:
        type: string
        description: Bill suppress date, SV_MAPPING:Cust_Acct.SuppressDate_T
      transferredAccountNumber:
        type: string
        description: Transferred account number. SV_MAPPING:Cust_Acct.TransferAccountNumber_X
      billEndDate:
        type: string
        description: Bill End Date. Describes the Bill cycle end date
  CreditProfile:
    type: object
    description: Credit profile for the party.
    required:
      - creditProfileDate
      - validFor
    properties:
      creditProfileDate:
        type: string
        format: date-time
        description: The date the profile was established
      creditRiskRating:
        type: string
        description: Credit rating, SV_MAPPING:Cust_Acct.CreditRating_R
        x-refdata-source: RT-TREATMENT_CREDIT_CLASS
      creditLimit:
        type: string
        description: CREDIT_LIMIT, SV_MAPPING:Cust_Acct.CreditLimit_C
      creditLimitCurrency:
        type: string
        description: Credit limit Currency, SV_MAPPING:Cust_Acct.CreditLimitCurrency_R
        x-refdata-source: CM-Currency
      expectedRevenue:
        type: string
        description: Expected revenue, SV_MAPPING:Cust_Acct.ExptRevAmt_C
      expRevCurrency:
        type: string
        description: Expected revenue currency, SV_MAPPING:Cust_Acct.ExptRevCurrency_R
        x-refdata-source: CM-Currency
      creditComments:
        type: string
        description: Credit comments, SV_MAPPING:Cust_Acct.CreditComments_X
      taxClass:
        type: string
        description: Tax class, SV_MAPPING:Cust_Acct.TaxClass_R
        x-refdata-source: RT-TAX_CLASS
      creditScore:
        type: string
        description: Credit score, SV_MAPPING:Cust_Acct.CreditScore_X
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: The period for which the profile is valid
  Format:
    type: object
    description: The bill invoice format.
    properties:
      name:
        type: string
        description: Invoice formate name, SV_MAPPING:CustAcctInvoiceFormat.InvoiceFormat_R
        x-refdata-source: CM-InvoiceFormat
      presentationMedia:
        description: The bill invoice presentation media.
        $ref: '#/definitions/PresentationMedia'
      characteristic:
        type: array
        description: 'Characteristic name supported: sendInvoiceTo | contactId | itemized | addressChoice | invoiceLanguage | op | seqnr.Characteristic value supported: CustAcctInvoiceFormat.Contact_R, CustAcctInvoiceFormat.InvoiceItemised_R, CustAcctInvoiceFormat.AddressChoice_R, CustAcctInvoiceFormat.InvoiceLanguage_R, perestapi.OPERATION (op) and CustAcctInvoiceFormat.SequenceNum_I.Characteristic value type supported: string. For PATCH request, the combination of op and seqnr characteristics are mandatory values.They indicate the type of action (add/replace/remove) to perform on an identified invoice format entity, as well as all other attribute values under the format attribute object e.g.: name, presentationMedia and the list of other characteristic values.For GET request, the op characteristic will not be returned.For POST request, the op and seqnr characteristics will not be used.'
        items:
          $ref: '#/definitions/Characteristic'
        x-refdata-source: '||RT-INVXML.INVOICE_ITEMISED|RT-ADDRESS_CHOICE,RT-INVXML.EMAIL_ADDRESS_CHOICE|RT-INVXML.INVOICE_LANGUAGE|RT-perestapi.OPERATION|'
  PresentationMedia:
    type: object
    description: The bill invoice presentation media.
    properties:
      name:
        type: string
        description: Invoice Delivery, SV_MAPPING:CustAcctInvoiceFormat.InvoiceDelivery_R
        x-refdata-source: AT-invxml.InvoiceDelivery
  Characteristic:
    type: array
    description: Describes a given characteristic of an object or entity through a name/value pair.
    items:
      properties:
        id:
          type: string
          description: Unique identifier of the characteristic
        name:
          type: string
          description: Name of the characteristic
        value:
          type: string
          description: Value of the characteristic
        valueType:
          type: string
          description: Data type of the value of the characteristic
  ContactMedium:
    type: array
    description: Indicates the contact medium that could be used to contact the party.
    items:
      properties:
        mediumType:
          type: string
          description: 'Type of the contact medium i.e.: PostalAddress | SiteAddress |HomeNumber | WorkNumber | MobileNumber. SV_MAPPING: perestapi.MEDIUM_TYPE RT'
        characteristic:
          $ref: '#/definitions/MediumCharacteristic'
  CustomerOrder:
    type: object
    description: details of product order
    properties:
      account:
        type: array
        items:
          properties:
            accountNumber:
              type: string
              description: Primary account number or prepaid account number
              example: "900140314"
            accountBalance:
              type: string
              description: ACCOUNT BALANCE
              example: "0"
            accountType:
              type: string
              description: Account type
              example: "POSTPAID"
            availableCredit:
              type: string
              description: available Credit limit
              example: "5000"
            billStructure:
              description: The bill structure that associated to the account
              $ref: '#/definitions/BillStructure'
            creditLimit:
              type: string
              description: credit limit
              example: "5000"
            id:
              type: string
              description: id
              example: "140314"
            paymentPlan:
              type: object
              properties:
                autoPay:
                  type: string
                  description: if autopay enabled
                  example: "Yes"
                paymentMethod:
                  type: string
                  description: payment Method
                  example: "Auto-Debit"
      characteristic:
        $ref: '#/definitions/Characteristic'
      contactMedium:
        $ref: '#/definitions/ContactMedium'
      creditProfile:
        $ref: '#/definitions/CreditProfile'
      defaultDisplayAccount:
        type: string
        description: default display account
        example: "140314"
      engagedParty:
        $ref: '#/definitions/PartyRef'
      href:
        type: string
        description: URL
        example: "http://cptlxd106:8460/trerest_in/api/v1/billingAccount/140306"
      id:
        type: string
        description: id
        example: "140306"
      name:
        type: string
        description: name
        example: "900140306"
      paymentMethod:
        type: array
        items:
          properties:
            "@type":
              type: string
              description: type of payment method
              example: "bankAccountDebit"
            details:
              type: object
              properties:
                BIC:
                  type: string
                  description: BIC code of the bank
                  example: "ANZ"
                accountNumber:
                  type: string
                  description: Primary account number or prepaid account number
                  example: "817271293287"
                owner:
                  type: string
                  description: Owner
                paymentLimit:
                  type: string
                  description: Payment limit
                  example: "50000"
                status:
                  type: string
                  description: status
                  example: "Active"
      status:
        type: string
        description: status
        example: "Active"
      validFor:
        type: object
        properties:
          startDateTime:
            type: string
            format: date-time
            description: 'Start Date format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveStartDate_T'
          endDateTime:
            type: string
            format: date-time
            description: 'The effective end date Format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveEndDate_T'
  EntityRef:
    type: object
    description: Entity reference schema to be use for all entityRef class.
    properties:
      id:
        type: string
        description: Unique identifier of a related entity.
      href:
        type: string
        description: Reference of the related entity.
      name:
        type: string
        description: Name of the related entity.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
      - id
  Event:
    type: object
    description: event with common attributes.
    properties:
      correlationId:
        type: string
        description: The correlation id for this event.
      description:
        type: string
        description: An explnatory of the event.
      domain:
        type: string
        description: The domain of the event.
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      title:
        type: string
        description: The title of the event.
      analyticCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
      event:
        $ref: '#/definitions/Any'
        description: The event linked to the involved resource object
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
      reportingSystem:
        $ref: '#/definitions/EntityRef'
        description: Reporting System described by EntityRef
      source:
        $ref: '#/definitions/EntityRef'
        description: Source Entity described by EntityRef
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  Event_Create:
    type: object
    description: |-
      event with common attributes.
      Skipped properties: id,href
    properties:
      correlationId:
        type: string
        description: The correlation id for this event.
      description:
        type: string
        description: An explnatory of the event.
      domain:
        type: string
        description: The domain of the event.
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      title:
        type: string
        description: The title of the event.
      analyticCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
      event:
        $ref: '#/definitions/Any'
        description: The event linked to the involved resource object
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
      reportingSystem:
        $ref: '#/definitions/EntityRef'
        description: Reporting System described by EntityRef
      source:
        $ref: '#/definitions/EntityRef'
        description: Source Entity described by EntityRef
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  Hub:
    type: object
    description: A Hub is used to subscribe to an event notification
    required:
      - callback
      - id
    properties:
      id:
        type: string
        description: The unique-id for your subscription - referenced when updating or deleting a subscription
      callback:
        type: string
        description: The URI that will be POSTed to when a notification is triggered
      query:
        type: string
        description: This is a query string used to filter notifications in the context of the notifier
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  Hub_Create:
    type: object
    description: |-
      A Hub is used to subscribe to an event notification
      Skipped properties: id,href
    required:
      - callback
    properties:
      callback:
        type: string
        description: The URI that will be POSTed to when a notification is triggered
      query:
        type: string
        description: This is a query string used to filter notifications in the context of the notifier
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  IndividualIdentification:
    type: object
    description: Represents our registration of information used as proof of identity by an individual (national identity card)
    properties:
      identificationId:
        type: string
        description: 'SV_MAPPING: NationalId ->Contact.Ul_National_Id_X'
      identificationType:
        type: string
        description: 'NationalId '
  MediumCharacteristic:
    type: object
    description: Describes the contact medium characteristics that could be used to contact a party
    properties:
      street1:
        type: string
        description: 'Line 1, SV_MAPPING: Cust_Acct.PostalLine1_X | Cust_Acct.SiteLine1_X'
      street2:
        type: string
        description: 'Line 2, SV_MAPPING: Cust_Acct.PostalLine2_X | Cust_Acct.SiteLine2_X'
      suburb:
        type: string
        description: 'Suburban, SV_MAPPING: Cust_Acct.PostalSubDistrict_R | Cust_Acct.SiteSubDistrict_R'
      city:
        type: string
        description: 'City, SV_MAPPING: Cust_Acct.PostalCity_R | Cust_Acct.SiteCity_R'
      postCode:
        type: string
        description: 'Post Code, SV_MAPPING: Cust_Acct.PostalPostCode_X | Cust_Acct.SitePostCode_X'
      stateOrProvince:
        type: string
        description: 'State, SV_MAPPING: Cust_Acct.PostalDistrict_R | Cust_Acct.SiteDistrict_R'
      country:
        type: string
        description: 'Country, SV_MAPPING: Cust_Acct.PostalCountry_R | Cust_Acct.SiteCountry_R'
      addressLine1:
        type: string
        description: 'Address line 1, SV_MAPPING: Cust_Acct.PostalLine7_X | Cust_Acct.SiteLine7_X'
      geocode:
        type: string
        description: 'What3words, SV_MAPPING: Cust_Acct.PostalGeocode_X | Cust_Acct.SiteGeocode_X'
      subDoorNumber:
        type: string
        description: 'Sub Door number, SV_MAPPING: Cust_Acct.PostalSubDoorNumber_X | Cust_Acct.SiteSubDoorNumber_X'
      genericAddress:
        type: string
        description: 'Generic Address when the actual address is not known, SV_MAPPING: Cust_Acct.PostalGenericAddress_X | Cust_Acct.SiteGenericAddress_X'
      phoneNumber:
        type: string
        description: These are the phone numbers of the primary contact of customer. HomeNumber->SV_MAPPING:Contact.HomePhone_X,WorkNumber->SV_MAPPING:Contact.WorkPhone_X, MobileNumber->SV_MAPPING:Contact.MobilePhone_X
  PartyRef:
    type: array
    description: Party reference. A party represents an organization or an individual.
    items:
      properties:
        '@referredType':
          type: string
          description: 'This is type of related party which it reffers, possible values individual, organization, customer. SV_MAPPING: perestapi.REFERRED_TYPE'
          x-refdata-source: RT-perestapi.REFERRED_TYPE
        id:
          type: string
          description: Contact Id, SV_MAPPING:contact.ObjectKey (Primary) or SV_MAPPING:contact.ObjectKey (Secondary) or Customer id, SV_MAPPING:Cust_Acct.ObjectKey
        href:
          type: string
          description: Reference of the party - <http://<TREREST_HOSTNAME>:<TREREST_PORT>/<Party TreREST URL>/<contact.ObjectKey>customer - <http://<TREREST_HOSTNAME>:<TREREST_PORT>/<customer TreREST URL>/<SV_MAPPING:Cust_Acct.ObjectKey>
        name:
          type: string
          description: Contact display name, SV_MAPPING:contact.Display_Name, customer display name SV_MAPPING:Cust_Acct.CustAcctName_X or parent customer display name SV_MAPPING:Cust_Acct.ParentCustAcct_R@
        role:
          type: string
          description: 'Primary | Secondary | Parent | Child. SV_MAPPING: perestapi.RELATED_PARTY_ROLE'
          x-refdata-source: RT-perestapi.RELATED_PARTY_ROLE
        individualIdentification:
          type: array
          items:
            $ref: '#/definitions/IndividualIdentification'
        partyCharacteristic:
          type: array
          description: 'Characteristic name supported: PersonalVatNumber | CorporateVatNumber | ContactRole. Characteristic value supported: PersonalVatNumber -> SV_MAPPING:Contact.General10_X | CorporateVatNumber -> SV_MAPPING:Contact.General10_X | ContactRole -> SV_MAPPING:perestapi.imp.CONTACT_ROLE. Characteristic value type supported: string'
          items:
            $ref: '#/definitions/Characteristic'
          x-refdata-source: '||RT-perestapi.imp.CONTACT_ROLE'
        contactMedium:
          type: array
          items:
            $ref: '#/definitions/ContactMedium'
        op:
          type: string
          description: 'add | replace | remove. SV_MAPPING: perestapi.OPERATION'
          x-refdata-source: RT-perestapi.OPERATION
  ProductOrder:
    type: object
    description: details of product order
    properties:
      "@type":
        type: string
        description: Type of product
        example: "Sales Order"
      billingAccount:
        type: object
        description: Billing account details
        properties:
          href:
            type: string
            description: URL
            example: "http://cptlxd106:8460/trerest_in/api/v1/billingAccount/140306"
          id:
            type: string
            description: id
            example: "140306"
          name:
            type: string
            description: name
            example: "900140306"
      case:
        type: object
        description: case details
        properties:
          href:
            type: string
            description: URL
            example: "http://cptlxd106:8460/trerest_in/api/v1/case/14878"
          id:
            type: string
            description: id
            example: "14878"
          name:
            type: string
            description: name
            example: "C14878"
          status:
            type: string
            description: status
            example: "Open"
      href:
        type: string
        description: URL
        example: "http://cptlxd106:8460/trerest_in/api/v1/productOrder/11692"
      id:
        type: string
        description: id
        example: "11692"
      orderCharacteristic:
        type: array
        items:
          properties:
            name:
              type: string
              description: order name
              example: "OrderName"
            value:
              type: string
              description: order value
              example: "SO11692"
      orderDate:
        type: string
        description: order date
        example: "2024-05-20T09:44:13"
      productOrderItem:
        type: array
        items:
          properties:
            product:
              type: object
              properties:
                name:
                  type: string
                  description: product name
                  example: "Wholesale Base Product"
                productCharacteristic:
                  type: array
                  items:
                    properties:
                      name:
                        type: string
                        description: product name
                        example: "ContractTerm"
                      value:
                        type: string
                        description: product value
                        example: "24"
                productOffering:
                  type: object
                  properties:
                    name:
                      type: string
                      description: product offering name
                      example: "W-Bulk SMS"
                    id:
                      type: string
                      description: product offering id
                      example: "1554483"
                    href:
                      type: string
                      description: URL
                      example: "http://cptlxd106:8460/trerest_in/api/v1/productOffering/1554483"
                productRelationship:
                  type: array
                  items:
                    properties:
                      product:
                        type: object
                        properties:
                          id:
                            type: string
                            description: product relationship id
                            example: "1554529"
                          op:
                            type: string
                            description: operation
                            example: "add"
                          productOffering:
                            type: object
                            properties:
                              name:
                                type: string
                                description: product relationship name
                                example: "Wholesale Bulk SMS Usage Feature"
                              id:
                                type: string
                                description: product relationship id
                                example: "1554526"
                              href:
                                type: string
                                description: URL
                                example: "http://cptlxd106:8460/trerest_in/api/v1/productOffering/1554526"
                              objId:
                                type: string
                                description: object id
                                example: "66520"
                          productSpecification:
                            type: array
                            items:
                              properties:
                                name:
                                  type: string
                                  description: product specification name
                                  example: "Wholesale Bulk SMS Usage Feature-Wholesale Usage Feature"
                                id:
                                  type: string
                                  description: product specification id
                                  example: "1554526-1500401"
                                objId:
                                  type: string
                                  description: object id
                                  example: "66521"
                                productSpecCharacteristic:
                                  type: array
                                  items:
                                    properties:
                                      name:
                                        type: string
                                        description: name
                                        example: CapacityRequired
                                      productSpecCharacteristicValue:
                                        type: object
                                        properties:
                                          value:
                                            type: string
                                            description: value
                                            example: "Yes"
                      relationshipType:
                        type: string
                        description: relationship Type
                        example: "childOffer"
                realizingResource:
                  type: array
                  items:
                    type: string
                realizingService:
                  type: array
                  items:
                    properties:
                      "@type":
                        type: string
                        description: type
                        example: "Wholesale Service"
                      name:
                        type: string
                        description: service name
                        example: "9098121235"
                      id:
                        type: string
                        description: service id
                        example: "1500081"
                      objId:
                        type: string
                        description: object id
                        example: "66519"
                      serviceCharacteristic:
                        type: array
                        items:
                          properties:
                            name:
                              type: string
                              description: service characteristic name
                              example: "Bulk SMS Type"
                            value:
                              type: string
                              description: service characteristic value
                              example: "Standard"
      relatedParty:
        type: array
        items:
          properties:
            "@referredType":
              type: string
              description: reference type
              example: "customer"
            name:
              type: string
              description: related party name
              example: "testcus10"
            id:
              type: string
              description: related party id
              example: "142570"
            href:
              type: string
              description: URL
              example: "http://cptlxd106:8460/trerest_in/api/v1/customer/142570"
      state:
        type: string
        description: validation state
        example: "Validated"
  RelatedParty:
    type: object
    description: Related Entity reference. A related party defines party or party role linked to a specific entity.
    required:
      - '@referredType'
      - id
    properties:
      id:
        type: string
        description: Unique identifier of a related entity.
      href:
        type: string
        description: Reference of the related entity.
      name:
        type: string
        description: Name of the related entity.
      role:
        type: string
        description: Role played by the related party
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
  Topic:
    type: object
    description: Is a event channel provided by the Event Streaming API
    properties:
      id:
        type: string
        description: The identifier of the notification.
      href:
        type: string
        description: Reference of the related entity.
      contentQuery:
        type: string
        description: is the filter that will be applied on the content of the Event.
      headerQuery:
        type: string
        description: is the filter that will be applied on the Event header properties.
      name:
        type: string
        description: use to identify grouping of events, per domain, per event types, per access control-right and so on.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  Topic_Create:
    type: object
    description: |-
      Is a event channel provided by the Event Streaming API
      Skipped properties: id,href
    properties:
      contentQuery:
        type: string
        description: is the filter that will be applied on the content of the Event.
      headerQuery:
        type: string
        description: is the filter that will be applied on the Event header properties.
      name:
        type: string
        description: use to identify grouping of events, per domain, per event types, per access control-right and so on.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  EventSubscription:
    type: object
    description: Sets the communication endpoint address the service instance must use to deliver notification information
    required:
      - id
      - callback
    properties:
      statusCode:
        type: string
        description: This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
        example: '0000'
      statusMessage:
        type: string
        description: More details and corrective actions related to the error which can be shown to a client
        example: "Success"
      id:
        type: string
        description: Id of the listener
      callback:
        type: string
        description: The callback being registered.
      query:
        type: string
        description: additional data to be passed
  EventSubscriptionInput:
    type: object
    description: Sets the communication endpoint address the service instance must use to deliver notification information
    required:
      - callback
    properties:
      callback:
        type: string
        description: The callback being registered.
      query:
        type: string
        description: additional data to be passed
  TopicCreateEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      event:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/TopicCreateEventPayload'
  TopicCreateEventPayload:
    type: object
    description: The event data structure
    properties:
      topic:
        description: The involved resource data for the event
        $ref: '#/definitions/Topic'
  TopicChangeEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      event:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/TopicChangeEventPayload'
      reportingSystem:
        type: array
        items:
          properties:
            id:
              type: string
              description: id of the reporting system
            name:
              type: string
              description: name of the reporting system
      source:
        type: array
        items:
          properties:
            id:
              type: string
              description: id of the source system
            name:
              type: string
              description: name of the source system 
  TopicChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      customer:
        description: The involved customer order change details
        $ref: '#/definitions/CustomerOrder'
      productOrder:
        description: The involved product order change details
        $ref: '#/definitions/ProductOrder'
      topic:
        description: The involved resource data for the event
        $ref: '#/definitions/Topic'
  TopicDeleteEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      event:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/TopicDeleteEventPayload'
  TimePeriod:
    type: object
    description: A base / value business entity used to represent a period of time between two timepoints.
    properties:
      startDateTime:
        type: string
        format: date-time
        description: 'Start Date format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveStartDate_T'
      endDateTime:
        type: string
        format: date-time
        description: 'The effective end date Format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveEndDate_T'
  TopicDeleteEventPayload:
    type: object
    description: The event data structure
    properties:
      topic:
        description: The involved resource data for the event
        $ref: '#/definitions/Topic'
  Error:
    description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
    type: object
    required:
      - code
      - reason
    properties:
      code:
        type: string
        description: Application relevant detail, defined in the API or a common list.
      reason:
        type: string
        description: Explanation of the reason for the error which can be shown to a client user.
      message:
        type: string
        description: More details and corrective actions related to the error which can be shown to a client user.
      status:
        type: string
        description: HTTP Error code extension
      referenceError:
        type: string
        format: uri
        description: URI of documentation describing the error.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class.
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name.