Search offers - the 'Delivery' part - 20260702

deliverables/1 search offers/AfterSalesFee.yaml

@@ -0,0 +1,24 @@
+allOf:
+- $ref: .\PackageElement.yaml
+- type: object
+  required:
+    - packageElementType
+  properties:
+    packageElementType:
+      description: The type of the package element, which can be used to determine the specific schema to use for validation.
+      type: string
+      const: afterSalesFee
+    feeType:
+        type: string
+        description: The type of fee applied.
+        x-enumeration-values:
+          - TBD
+    price:
+      $ref: .\Cost.yaml
+      description: The fee associated with the after-sales service. This can include costs for cancellations, 
+       exchanges, or other post-purchase services.
+example:
+  { 
+    "packageElementType": "afterSalesFee",
+    "price": { "amount": 10.00, "currency": "EUR" }
+  }

deliverables/1 search offers/Ancillary.yaml

@@ -0,0 +1,26 @@
+allOf:
+- $ref: .\PackageElement.yaml
+- type: object
+  required:
+    - ancillaryType
+    - packageElementType
+  properties:
+    packageElementType:
+      description: The type of the package element, which can be used to determine the specific schema to use for validation.
+      type: string
+      const: ancillary
+    typeOfAncillary:
+      type: string
+      description: The type of ancillary service provided. The allowed values are defined in 'ancillary-type' lookup.
+    appliesTo:
+      type: array
+      description: A list of package elements to which this ancillary applies
+      items:
+        type: string
+        format: package-element-ref
+examples:
+- {
+    "packageElementType": "ancillary",
+    "ancillaryType": "meal",
+    "appliesTo": ["PE-123"]
+  }

deliverables/1 search offers/AssetAllocation.yaml

@@ -0,0 +1,31 @@
+allOf:
+- $ref: .\PackageElement.yaml
+- type: object
+  required:
+    - allocationType
+    - packageElementType
+  properties:
+    packageElementType:
+      description: The type of the package element, which can be used to determine the specific schema to use for validation.
+      type: string
+      const: assetAllocation
+    typeOfAsset:
+      type: string
+      description: The type of asset allocated. The allowed values are defined in 'asset-type' lookup.
+    description:
+      type: string
+      description: A description of the allocation.
+    reference:
+      type: string
+      description: An asset reference identifier for the allocation.
+      format: asset-ref
+    numberOfAssets:
+      type: integer
+      description: The number of allocated assets for the allocation
+examples:
+- {
+    "packageElementType": "assetAllocation",
+    "typeOfAsset": "normal-bike",
+    "description": "Normal bike for the trip.",
+    "numberOfAssets": 2
+  }

deliverables/1 search offers/ContinuousLeg.yaml

@@ -0,0 +1,34 @@
+allOf:
+  - $ref: .\Leg.yaml
+  - type: object
+    properties:
+      legType:
+        type: string
+        description: discriminator for the leg type
+        const: continuous
+      duration:
+        type: integer
+        description: Duration of the leg in minutes
+      startPlace:
+        type: string
+        format: place-ref
+      endPlace:
+        type: string
+        format: place-ref
+      timeWindowStart:
+        type: string
+        format: date-time
+        description: The start of the time window during which this continuous leg may be used.
+      timeWindowEnd:
+        type: string
+        format: date-time
+        description: The end of the time window during which this continuous leg may be used.
+examples:
+- {
+    "legType": "continuous",
+    "duration": 120,
+    "timeWindowStart": "2024-06-15T08:00:00Z",
+    "timeWindowEnd": "2024-06-15T10:00:00Z",
+    "startPlace": "PLACE-123",
+    "endPlace": "PLACE-456"
+  }

deliverables/1 search offers/Cost.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  amount:
+    type: number
+    description: The monetary amount of the cost.
+    format: float
+  currencyCode:
+    type: string
+    description: The currency of the cost, represented as a three-letter ISO 4217 code
+  taxes:
+    type: array
+    description: A list of taxes associated with the cost.
+    items:
+      $ref: .\Tax.yaml
+examples:
+- {
+    "amount": 100.00,
+    "currencyCode": "EUR",
+    "taxes": [
+      { "taxType": "VAT", "amount": 20.00, "currencyCode": "EUR" },
+      { "taxType": "Service Tax", "amount": 5.00, "currencyCode": "EUR" }
+    ]
+  }

deliverables/1 search offers/Delivery.yaml

@@ -0,0 +1,21 @@
+type: object
+properties:
+  requestId:
+    type: string
+    description: Identifier of the originating request
+    format: request-ref
+  problems:
+    type: array
+    description: List of problems related to the request
+    items:
+      $ref: .\Problem.yaml
+  warnings:
+    type: array
+    description: List of warnings related to the request
+    items:
+      $ref: .\Problem.yaml
+  links:
+    type: array
+    description: List of links related to the request
+    items:
+      $ref: .\Link.yaml

deliverables/1 search offers/DistributionFilter.yaml

@@ -0,0 +1,73 @@
+allOf:
+  - $ref: .\SearchOfferFilter.yaml
+  - type: object
+    required:
+      - filterType
+      - mediaType
+    properties:
+      filterType:
+        type: string
+        const: distribution
+      channel:
+        type: string
+        description: The channel of the offer.
+        x-enum-values:
+          - "web"
+          - "mobile"
+          - "kiosk"
+          - "call center"
+          - "travel agency"
+          - "other"
+      fulfillmentMethod:
+        type: string
+        description: The fulfillment method of the offer.
+        x-enum-values:
+          - "electronic"
+          - "paper"
+          - "mobile"
+          - "other"
+      typeOfPayment:
+        type: string
+        description: The type of payment of the offer.
+        x-enum-values:
+          - "prepaid"
+          - "postpaid"
+          - "other"
+      mediaType:
+        type: string
+        description: |-
+         The media type of the offer. IANA media type registry: https://www.iana.org/assignments/media-types/media-types.xhtml
+        examples: 
+          - "application/json"
+          - "application/xml"
+          - "text/html"
+          - "application/pdf"
+          - "image/jpeg"
+          - "image/svg+xml"
+      contentStandard:
+        type: string
+        description: The content standard of the offer.
+        x-enum-values:
+          - "ISO/IEC 18004" # QR Code
+          - "ISO/IEC 24778" # Aztec Code
+          - "ISO/IEC 15438" # PDF417
+          - "ISO/IEC 16022" # Data Matrix
+          - "ISO/IEC 15417" # Code 128
+          - "ISO/IEC 16388" # Code 39
+          - "ISO/IEC 15420" # EAN-13
+          - "ISO/IEC 15417" # UPC-A
+          - "ISO/IEC 15424" # MaxiCode
+          - "ISO/IEC 7816-4" # NFC, MIFARE DESFire
+          - "CEN/TS 16794" # calypso NFC card 
+          - "GATT" # Bluetooth Low Energy
+          - "AXA Bike lock" # AXA Bike lock
+          - "OTHER" # Other content standard
+examples:
+  - {
+      "filterType": "distribution",
+      "channel": "web",
+      "fulfillmentMethod": "electronic",
+      "typeOfPayment": "prepaid",
+      "mediaType": "application/json",
+      "contentStandard": "ISO/IEC 18004"
+    }

deliverables/1 search offers/EntitlementRight.yaml

@@ -0,0 +1,21 @@
+type: object
+required:
+  - issuer
+  - entitlementType
+  - code
+properties:
+  issuer:
+    type: string
+    description: The entity that issues the entitlement right. Could be a RISC code
+  entitlementType:
+    type: string
+    description: The type of entitlement right (e.g., subscription, license, access). Valid values can be obtained using the `entitlementType` endpoint
+  code:
+    type: string
+    description: A unique code representing the entitlement right.
+examples:
+- {
+    "issuer": "Company XYZ",
+    "entitlementType": "voucher",
+    "code": "VOUCHER-2024-001"
+  }

deliverables/1 search offers/FlexibilityFilter.yaml

@@ -0,0 +1,21 @@
+allOf:
+  - $ref: .\SearchOfferFilter.yaml
+  - type: object
+    required:
+      - filterType
+      - afterSalesCondition
+    properties:
+      filterType:
+        type: string
+        const: flexibility
+      afterSalesCondition:
+        type: string
+        enum:
+        - cancellable
+        - exchangeable
+        - refundable
+examples:
+- {
+    "filterType": "flexibility",
+    "afterSalesCondition": "cancellable"
+  }

deliverables/1 search offers/Fulfillment.yaml

@@ -0,0 +1,104 @@
+type: object
+required:
+  - fulfillmentId
+  - status
+  - mediaType
+  - packageElements
+  - oneOf:
+    - url
+    - binaryData   
+properties:
+  fulfillmentId:
+    type: string
+    description: Unique identifier for the fulfillment
+  status:
+    type: string
+    description: The current status of the fulfillment.
+    enum:
+    - pending
+    - in_progress
+    - completed
+    - issued
+    - revoked
+    - refunded
+  binaryData:
+    type: string
+    format: binary
+    description: The binary data associated with the fulfillment, which may include documents, tickets, or other relevant files.
+  url:
+    type: string
+    format: uri
+    description: The URL where the fulfillment can be accessed or downloaded.
+  channel:
+    type: string
+    description: The channel of the offer.
+    x-enum-values:
+      - "web"
+      - "mobile"
+      - "kiosk"
+      - "call center"
+      - "travel agency"
+      - "other"
+  fulfillmentMethod:
+    type: string
+    description: The fulfillment method of the offer.
+    x-enum-values:
+      - "electronic"
+      - "paper"
+      - "mobile"
+      - "other"
+  typeOfPayment:
+    type: string
+    description: The type of payment of the offer.
+    x-enum-values:
+      - "prepaid"
+      - "postpaid"
+      - "other"
+  mediaType:
+    type: string
+    description: |-
+      The media type of the offer.
+    externalDocs:
+      description: |-
+        For more information about media types, see the [IANA Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml) registry.
+      url: https://www.iana.org/assignments/media-types/media-types.xhtml
+    examples: 
+      - "application/json"
+      - "application/xml"
+      - "text/html"
+      - "application/pdf"
+      - "image/jpeg"
+      - "image/svg+xml"
+  contentStandard:
+    type: string
+    description: The content standard of the offer.
+    x-enum-values:
+      - "ISO/IEC 18004" # QR Code
+      - "ISO/IEC 24778" # Aztec Code
+      - "ISO/IEC 15438" # PDF417
+      - "ISO/IEC 16022" # Data Matrix
+      - "ISO/IEC 15417" # Code 128
+      - "ISO/IEC 16388" # Code 39
+      - "ISO/IEC 15420" # EAN-13
+      - "ISO/IEC 15417" # UPC-A
+      - "ISO/IEC 15424" # MaxiCode
+      - "ISO/IEC 7816-4" # NFC, MIFARE DESFire
+      - "GATT" # Bluetooth Low Energy
+      - "AXA Bike lock" # AXA Bike lock
+      - "OTHER" # Other content standard
+  packageElements:
+    type: array
+    description: A list of package elements associated with the fulfillment.
+    minItems: 1
+    items:
+      type: string
+      format: package-element-ref
+examples:
+- {
+    "fulfillmentId": "FULFILLMENT-123",
+    "status": "revoked",
+    "mediaType": "application/pdf",
+    "packageElements": ["PE-123", "PE-456"],
+    "url": "https://example.com/fulfillment/FULFILLMENT-123",
+    "contentStandard": "ISO/IEC 18004"
+  }