EventCatalog

Properties

Id* :

Unique identifier of the delivery

subscriptionId* :

Unique identifier of the subscriber

paymentMethod* :

delivery payment method

planType* :

Subscription plan type

dietType* :

Subscription plan type

cost* :

Delivery Cost

paidAmount* :

Delivery paid amount

name* :

The name of the delivery

phoneNumber* :

The phone number of the delivery

date* :

delivery date

kitchen* :

The kitchen of the delivery

currency* :

delivery payment currency

country* :

country of the delivery

time* :

delivery time (morning, evening)

status* :

delivery status (upcoming, paymentRequired,paused,cancelled,suspended)

tier* :

Subscription tier (personalized, standard)

flowchart LR l-api-service[api-service]:::producer-->DeliverySkipped[DeliverySkipped]:::event l-dashboard-api-service[dashboard-api-service]:::producer-->DeliverySkipped[DeliverySkipped]:::event classDef event stroke:#7c0070,stroke-width: 4px; classDef producer stroke:#75d7b6,stroke-width: 2px; classDef consumer stroke:#818cf8,stroke-width: 2px; DeliverySkipped[DeliverySkipped]:::event-->r-unknown[unknown]:::consumer click l-api-service href "/services/api-service" "Go to api-service" _self click l-dashboard-api-service href "/services/dashboard-api-service" "Go to dashboard-api-service" _self click r-unknown href "/services/unknown" "Go to unknown" _self click DeliverySkipped href "/events/DeliverySkipped" "Go to DeliverySkipped" _self

DeliverySkipped Schema (yml)

openapi: 3.0.0
info:
  version: "1.0.0"
  title: DeliverySkipped
paths: {}
components:
  schemas:
    DeliverySkipped:
      type: object
      required:
        - data
        # - metadata
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Metadata:
      type: object
      properties:
        version:
          type: string
        serviceFunction:
          type: string
      required:
        - version
        - serviceFunction
    Data:
      type: object
      properties:
        id:
          type: string
        subscriptionId:
          type: string
        paymentMethod:
          "$ref": "#/components/schemas/PaymentMethod"
        planType:
          "$ref": "#/components/schemas/PlanType"
        dietType:
          "$ref": "#/components/schemas/DietType"
        cost:
          type: number
        paidAmount:
          type: number
          default: 0
        name:
          type: string
        phoneNumber:
          type: string
        date:
          type: string
        tier:
          type: string
        kitchen:
          "$ref": "#/components/schemas/Kitchen"
        currency:
          "$ref": "#/components/schemas/Currency"
        country:
          "$ref": "#/components/schemas/Country"
        time:
          "$ref": "#/components/schemas/DeliveryTime"
        status:
          "$ref": "#/components/schemas/DeliveryStatus"
      required:
        - id
        - subscriptionId
        - paymentMethod
        - planType
        - dietType
        - cost
        - paidAmount
        - name
        - phoneNumber
        - date
        - kitchen
        - currency
        - country
        - time
        - status
        - tier
    PaymentMethod:
      type: string
      enum:
        - cash
        - cc
        - benefit
        - mada
        - applePay
        - knet
    Country:
      type: string
      enum:
        - AE
        - BH
        - SA
        - KW
        - OM
        - QA
        - US
    DietType:
      type: string
      enum:
        - balanced
        - vegetarian
        - low-carb
        - high-protein
        - weight-loss
    Currency:
      type: string
      enum:
        - BHD
        - SAR
        - AED
        - KWD
        - QAR
        - OMR
    PlanType:
      type: string
      enum:
        - full
        - custom
        - skipBreakfast
        - skipDinner
        - ramadan
        - businessLunch
        - futoor
        - wightLossChallenge
    Kitchen:
      type: string
      enum:
        - BH001
        - SA001
        - SA002
        - KW001
        - QA001
        - AE001
        - NA000
    DeliveryTime:
      type: string
      enum:
        - morning
        - evening
    DeliveryStatus:
      type: string
      enum:
        - upcoming
        - paymentRequired
        - paused
        - cancelled
        - suspended

DeliverySkippedv1.0.0