openapi: 3.1.0
info:
  title: OpenAPI definition
  version: v0
servers:
- url: https://adminapi.incentivio.com/incentivio-admin-api
  description: Generated server url
paths:
  /toastsettings:
    put:
      tags:
      - spreedly-connector-controller
      operationId: setToastSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToastSettings'
        required: true
      responses:
        '200':
          description: OK
  /ml/portal/client/rules:
    put:
      tags:
      - ml-controller
      operationId: deleteRecommendationRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteRuleRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeleteRuleResponse'
    post:
      tags:
      - ml-controller
      operationId: createRecommendationRules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRuleRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateRuleResponse'
  /ml/portal/client/location/{clientid}:
    put:
      tags:
      - ml-controller
      operationId: updateLocations
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UpdateLocationResponse'
  /ml/portal/client/item/category/change:
    put:
      tags:
      - ml-controller
      operationId: changeItemCategory
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemCategoryChaingingRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CategoryChangedItemResponse'
  /ml/portal/client/configuration:
    put:
      tags:
      - ml-controller
      operationId: updateConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigurationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UpdatedConfigurationResponse'
  /incentivio-wallet/clients/{clientid}/walletconfig:
    get:
      tags:
      - wallet-controller
      operationId: getWalletConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WalletConfigDTO'
    put:
      tags:
      - wallet-controller
      operationId: setWalletConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutWalletConfigRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WalletConfigDTO'
    delete:
      tags:
      - wallet-controller
      operationId: deleteWalletConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-user-domain/customer-tags/{id}:
    get:
      tags:
      - customer-tag-and-rule-controller
      operationId: findCustomerTagById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TagAndRuleDTO'
    put:
      tags:
      - customer-tag-and-rule-controller
      operationId: updateCustomerTag
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerTagRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - customer-tag-and-rule-controller
      operationId: deleteCustomerTag
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/subitems:
    put:
      tags:
      - sub-item-controller
      operationId: addOrUpdatePackage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubItemRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateSubItemResponseDTO'
  /incentivio-ordering-service/packages:
    get:
      tags:
      - package-controller
      operationId: listPackagesByClientId
      parameters:
      - name: groupId
        in: query
        required: false
        schema:
          type: string
      - name: catalogId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ListPackageResponseDTO'
    put:
      tags:
      - package-controller
      operationId: addOrUpdatePackage_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackageRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreatePackageResponseDTO'
  /incentivio-ordering-service/orders/{orderid}/auditevents/{eventid}:
    put:
      tags:
      - order-controller
      operationId: updateAuditEvent
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      - name: eventid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAuditEventRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/merchants/{merchantid}:
    get:
      tags:
      - merchant-controller
      operationId: getLocationById
      parameters:
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MerchantResponseDTO'
    put:
      tags:
      - merchant-controller
      operationId: updateMerchant
      parameters:
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMerchantRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UpdateMerchantResponseDTO'
    delete:
      tags:
      - merchant-controller
      operationId: deleteMerchant
      parameters:
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/locations/{locationid}:
    get:
      tags:
      - location-controller
      operationId: getLocationById_1
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      - name: includeRelatedStores
        in: query
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationResponseDTO'
    put:
      tags:
      - location-controller
      operationId: updateLocation
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - location-controller
      operationId: deleteLocation
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
    patch:
      tags:
      - location-controller
      operationId: patchLocation
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchLocationRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/items:
    put:
      tags:
      - item-controller
      operationId: addOrUpdateItem
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateItemRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateItemResponseDTO'
    patch:
      tags:
      - item-controller
      operationId: patchItems
      parameters:
      - name: storeId
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/groups:
    get:
      tags:
      - group-controller
      operationId: listGroupsByCatalogId
      parameters:
      - name: catalogId
        in: query
        required: false
        schema:
          type: string
      - name: title
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: incentivioIds
        in: query
        required: false
        schema:
          type: string
      - name: externalIds
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Status'
      - name: type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/GroupType'
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: title
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListGroupResponseWithPagingForAdminDTO'
    put:
      tags:
      - group-controller
      operationId: addOrUpdateGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateGroupResponseDTO'
    patch:
      tags:
      - group-controller
      operationId: patchGroups
      parameters:
      - name: storeId
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/clients/{clientid}/presetorder/{orderid}:
    get:
      tags:
      - preset-order-controller
      operationId: getPresetOrderConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GetPresetOrderConfigResponseDTO'
    put:
      tags:
      - preset-order-controller
      operationId: updatePresetOrderConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePresetOrderConfigRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GetPresetOrderConfigResponseDTO'
    delete:
      tags:
      - preset-order-controller
      operationId: deletePresetOrderConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/catalogs:
    put:
      tags:
      - order-controller
      operationId: addOrUpdateCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCatalogRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateCatalogResponseDTO'
    patch:
      tags:
      - order-controller
      operationId: patchCatalogs
      parameters:
      - name: storeId
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-menu-service/bulkimageuploads/{id}:
    get:
      tags:
      - bulk-image-upload-controller
      operationId: read
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkImageUploadReadResponse'
    put:
      tags:
      - bulk-image-upload-controller
      operationId: update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImageUploadUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-giftcard-ach-service/achlocations:
    get:
      tags:
      - gift-card-ach-controller
      operationId: retrieveACHLocationsForAdmin
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ACHLocationDTO'
    put:
      tags:
      - gift-card-ach-controller
      operationId: updateLocation_1
      parameters:
      - name: merchantId
        in: header
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - gift-card-ach-controller
      operationId: retrieveLocationsByACHLocationIDs
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RetrieveAchLocationListResponse'
  /incentivio-giftcard-ach-service/achlocations/{locationId}/fundingaccount:
    put:
      tags:
      - gift-card-ach-controller
      operationId: updateFundingAccount
      parameters:
      - name: merchantId
        in: header
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFundingAccountRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-client-domain/templates/{templateId}:
    get:
      tags:
      - client-email-template-controller
      operationId: getClientTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTemplate'
    put:
      tags:
      - client-email-template-controller
      operationId: updateClientTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClientTemplateRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTemplate'
    delete:
      tags:
      - client-email-template-controller
      operationId: deleteClientTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
  /incentivio-client-domain/clients/{clientid}/updaterole:
    put:
      tags:
      - role-module-permission-controller
      operationId: updateRole
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}:
    put:
      tags:
      - client-merchant-controller
      operationId: updateMerchant_1
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMerchantRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - client-merchant-controller
      operationId: deleteMerchant_1
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores/{storeid}:
    put:
      tags:
      - store-controller
      operationId: updateStore
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Location-Id
        in: header
        required: true
        schema:
          type: string
      - name: storeid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStoreRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - store-controller
      operationId: deleteStore
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Location-Id
        in: header
        required: true
        schema:
          type: string
      - name: storeid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/app-home-config/preview:
    put:
      tags:
      - app-home-config-controller
      operationId: updatePreview
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/background/schedules/{scheduleId}:
    put:
      tags:
      - app-home-config-controller
      operationId: updateSchedule
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundScheduleRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
    delete:
      tags:
      - app-home-config-controller
      operationId: deleteSchedule
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/background/default:
    put:
      tags:
      - app-home-config-controller
      operationId: stageDefaultBackground
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultBackgroundRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
    delete:
      tags:
      - app-home-config-controller
      operationId: removeDefaultBackground
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/admins/{adminid}:
    get:
      tags:
      - client-admin-controller
      operationId: findAdminUser
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAdminUserResponseDTO'
    put:
      tags:
      - client-admin-controller
      operationId: updateAdminUser
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveAdminUserRequestDto'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - client-admin-controller
      operationId: deleteAdminUser
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/email-config:
    get:
      tags:
      - client-configuration-controller
      operationId: getEmailConfig
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailSettingBasicInfoResponseDTO'
    put:
      tags:
      - client-configuration-controller
      operationId: updateEmailConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailSettingsCreateRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailSettingBasicInfoResponseDTO'
  /incentivio-auto-tagger-service/segments/{segmentId}:
    get:
      tags:
      - segment-controller
      operationId: findSegment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SegmentResponseDTO'
    put:
      tags:
      - segment-controller
      operationId: updateSegment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SegmentRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - segment-controller
      operationId: deleteSegment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-auto-tagger-service/segments/{segmentId}/deactivate:
    put:
      tags:
      - segment-controller
      operationId: deactivateSegment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /clients/{clientid}/webappconfig:
    get:
      tags:
      - web-app-config-controller
      operationId: getWebAppConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      - name: locationid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebAppConfigDTO'
    put:
      tags:
      - web-app-config-controller
      operationId: addOrUpdateWebAppConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebAppConfigDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebAppConfigDTO'
  /payments/transactions/refund:
    post:
      tags:
      - refunds-controller
      operationId: refundTransaction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundTransactionRequest'
        required: true
      responses:
        '200':
          description: OK
  /ml/portal/client/model/train:
    post:
      tags:
      - ml-controller
      operationId: startTrainingProcess
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelTrainingRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/StartTrainingProcessResponse'
  /incentivio-user-domain/{userid}/unblock:
    post:
      tags:
      - user-controller
      operationId: unblockUserAccount
      parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountBlockRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AccountBlockResponseDTO'
  /incentivio-user-domain/{userid}/block:
    post:
      tags:
      - user-controller
      operationId: blockUserAccount
      parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountBlockRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AccountBlockResponseDTO'
  /incentivio-user-domain/users/{email}/requestpwreseturl:
    post:
      tags:
      - user-controller
      operationId: createPasswordResetToken
      parameters:
      - name: email
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-user-domain/users/unbounce/email:
    post:
      tags:
      - user-controller
      operationId: unBounceEmail
      parameters:
      - name: email
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int32
  /incentivio-user-domain/customer-tags:
    get:
      tags:
      - customer-tag-and-rule-controller
      operationId: findPaginatedTagsAndRulesByClientId
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: title
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerTagAndRulesWithPagingForAdminDTO'
    post:
      tags:
      - customer-tag-and-rule-controller
      operationId: createCustomerTag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerTagRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TagAndRuleDTO'
  /incentivio-reports/pulse/email/{reportType}/data/csv:
    post:
      tags:
      - email-pulse-controller
      operationId: getDataGridCsv
      parameters:
      - name: reportType
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailPulseDataCSVRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PulseCSVResponseDTO'
  /incentivio-reports/loyaltyreport/offers/trends/csv:
    post:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportOfferTrendsCSV
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyReportOfferTrendsCSVRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportCSVResponseDTO'
  /incentivio-reports/loyaltyreport/offers/performance/csv:
    post:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportOfferPerformanceCSV
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyReportOfferPerformanceCSVRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportCSVResponseDTO'
  /incentivio-reports/loyaltyreport/locations/trends/csv:
    post:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportLocationTrendsCSV
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyReportLocationTrendsCSVRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportCSVResponseDTO'
  /incentivio-reports/loyaltyreport/locations/performance/csv:
    post:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportLocationPerformanceCSV
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoyaltyReportLocationPerformanceCSVRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportCSVResponseDTO'
  /incentivio-reports/clients/offer-performance/export:
    post:
      tags:
      - offers-report-controller
      operationId: exportOfferPerformanceReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfferPerformanceReportExportRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OfferPerformanceReportExportResponseDTO'
  /incentivio-reports/clients/customers/download-active:
    post:
      tags:
      - customer-report-controller
      operationId: downloadActiveCustomers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerReportDownloadRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerReportDownloadResponseDTO'
  /incentivio-payments/disputes/*/upload:
    post:
      tags:
      - payments-controller
      operationId: uploadFileToStripe
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-ordering-service/searchadminorders/receivedorders/5min:
    post:
      tags:
      - order-controller
      operationId: adminOrdersForLastFiveMins
      parameters:
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/orders/{orderid}/notifications:
    get:
      tags:
      - order-controller
      operationId: getOrderNotifications
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Client-Id
        in: header
        required: false
        schema:
          type: string
      - name: Inc-Location-Id
        in: header
        required: false
        schema:
          type: string
      - name: Inc-Admin-Id
        in: header
        required: false
        schema:
          type: string
      - name: clientId
        in: header
        required: false
        deprecated: true
        schema:
          type: string
      - name: LOCATION_ID
        in: header
        required: false
        deprecated: true
        schema:
          type: string
      - name: ADMIN_ID
        in: header
        required: false
        deprecated: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderNotificationMessageResponseDTO'
    post:
      tags:
      - order-controller
      operationId: sendOrderNotification
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Client-Id
        in: header
        required: false
        schema:
          type: string
      - name: Inc-Location-Id
        in: header
        required: false
        schema:
          type: string
      - name: Inc-Admin-Id
        in: header
        required: false
        schema:
          type: string
      - name: clientId
        in: header
        required: false
        deprecated: true
        schema:
          type: string
      - name: LOCATION_ID
        in: header
        required: false
        deprecated: true
        schema:
          type: string
      - name: ADMIN_ID
        in: header
        required: false
        deprecated: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OrderNotificationRequestDTO'
          application/json:
            schema:
              $ref: '#/components/schemas/OrderNotificationRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/orders/{orderId}/cancel:
    post:
      tags:
      - order-controller
      operationId: cancelOrder
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/orders/reversepayment:
    post:
      tags:
      - refunds-controller
      operationId: refundOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundOrderRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/merchants:
    post:
      tags:
      - merchant-controller
      operationId: addMerchant
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMerchantRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateMerchantResponseDTO'
  /incentivio-ordering-service/locations:
    post:
      tags:
      - location-controller
      operationId: addLocation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLocationRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateLocationResponseDTO'
  /incentivio-ordering-service/items/list:
    post:
      tags:
      - item-controller
      operationId: listItems
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemSearchRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListItemResponseWithPagingForAdminDTO'
  /incentivio-ordering-service/items/delete:
    post:
      tags:
      - item-controller
      operationId: deleteItems
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/groups/list:
    post:
      tags:
      - group-controller
      operationId: listGroups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupSearchRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListGroupResponseWithPagingForAdminDTO'
  /incentivio-ordering-service/groups/delete:
    post:
      tags:
      - group-controller
      operationId: deleteGroups
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/daily-sales-export:
    post:
      tags:
      - order-controller
      operationId: exportDailySalesReportForAdmin
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DailySalesReportExportRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DailySalesReportExportResponseDTO'
  /incentivio-ordering-service/clients/{clientid}/presetorder:
    get:
      tags:
      - preset-order-controller
      operationId: listPresetOrderConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: code
      - name: code
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListPresetOrderResponseWithPagingForAdminDTO'
    post:
      tags:
      - preset-order-controller
      operationId: createPresetOrderConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePresetOrderConfigRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GetPresetOrderConfigResponseDTO'
  /incentivio-ordering-service/catalogs/list:
    post:
      tags:
      - order-controller
      operationId: listCatalogsByClientIdAndStoreIdsForAdmin
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogSearchRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListCatalogResponseWithPagingForAdminDTO'
  /incentivio-ordering-service/catalogs/delete:
    post:
      tags:
      - order-controller
      operationId: deleteCatalogs
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/cachecatalogs_OLD:
    post:
      tags:
      - order-controller
      operationId: addCacheCatalog_OLD
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCacheCatalogRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ListCatalogAdminDTO'
  /incentivio-ordering-service/cachecatalogs:
    post:
      tags:
      - order-controller
      operationId: cacheCatalog
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateCacheCatalogRequestDTO'
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCacheCatalogRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogCacheResponse'
  /incentivio-offers-domain/redeemofferbyid:
    post:
      tags:
      - offers-controller
      operationId: redeemById
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RedeemOfferAPIRequestDTO'
          application/json:
            schema:
              $ref: '#/components/schemas/RedeemOfferAPIRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-offers-domain/clients/{clientid}/distributesyncactivityoffers:
    post:
      tags:
      - offer-distribution-controller
      operationId: distributeSynchronousActivityOffer
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityOfferListRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ActivityOfferListDTO'
  /incentivio-menu-service/search:
    post:
      tags:
      - menu-search-pass-through-controller
      operationId: search
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchTargetingParams'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductSearchResponse'
  /incentivio-menu-service/runallimports:
    post:
      tags:
      - menu-import-controller
      operationId: runAllImports
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
  /incentivio-menu-service/locations/{locationid}/runfullimport:
    post:
      tags:
      - menu-import-controller
      operationId: runFullImport
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-menu-service/bulkimageuploads:
    get:
      tags:
      - bulk-image-upload-controller
      operationId: search_1
      parameters:
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          maximum: 100
          minimum: 10
      - name: dateCreatedGte
        in: query
        required: false
        schema:
          type: string
      - name: dateCreatedLt
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          maxLength: 255
          minLength: 0
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: type
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: uploadId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkImageUploadSearchResponse'
    post:
      tags:
      - bulk-image-upload-controller
      operationId: create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImageUploadCreateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkImageUploadCreateResponse'
  /incentivio-menu-service/bulkimageuploads/{id}/process:
    post:
      tags:
      - bulk-image-upload-controller
      operationId: process
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
      responses:
        '200':
          description: OK
  /incentivio-media/presignedurls/client:
    post:
      tags:
      - media-file-controller
      operationId: presignedUrlsClient
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PresignedUrlsClientRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresignedUrlsClientResponse'
  /incentivio-media/clients/*/media:
    post:
      tags:
      - file-controller
      operationId: uploadFile
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
  /incentivio-giftcard-service/giftcard/location-config/update:
    post:
      tags:
      - gift-card-client-onboard-controller
      operationId: updateGiftCardLocationConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardLocationConfigUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-giftcard-service/giftcard/client-config/update:
    post:
      tags:
      - gift-card-client-onboard-controller
      operationId: updateGiftCardClientConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardClientConfigUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-giftcard-service/cards/import:
    post:
      tags:
      - gift-card-controller
      operationId: importGiftCards
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ImportCardRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImportCardRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ImportCardRequest'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ImportCardResponse'
  /incentivio-giftcard-service/cards/import/{batchId}/remove:
    post:
      tags:
      - gift-card-controller
      operationId: removeGiftCards
      parameters:
      - name: batchId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RemoveCardResponse'
  /incentivio-giftcard-service/card:
    post:
      tags:
      - gift-card-controller
      operationId: createCard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCardRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateCardResponse'
  /incentivio-giftcard-service/card/reset-balance:
    post:
      tags:
      - gift-card-controller
      operationId: resetBalanceGiftCard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardTransactionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardTransactionResponse'
  /incentivio-giftcard-service/card/resendemail:
    post:
      tags:
      - gift-card-controller
      operationId: resendEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResendEmailRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResendEmailResponse'
  /incentivio-giftcard-service/card/remove-value:
    post:
      tags:
      - gift-card-controller
      operationId: removeValueFromGiftCard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardTransactionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardTransactionResponse'
  /incentivio-giftcard-service/card/deactivate:
    post:
      tags:
      - gift-card-controller
      operationId: deactivateGiftCard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardTransactionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardTransactionResponse'
  /incentivio-giftcard-service/card/admin-add-value:
    post:
      tags:
      - gift-card-controller
      operationId: addValueToGiftCard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardTransactionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardTransactionResponse'
  /incentivio-giftcard-service/card/activate:
    post:
      tags:
      - gift-card-controller
      operationId: activateGiftCard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardTransactionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardTransactionResponse'
  /incentivio-giftcard-ach-service/{locationId}/retry-verification:
    post:
      tags:
      - gift-card-ach-controller
      operationId: retryVerification
      parameters:
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetryCustomerVerificationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-giftcard-ach-service/transfers/{transferid}/cancel:
    post:
      tags:
      - fund-transfer-controller
      operationId: cancelTransfer
      parameters:
      - name: transferid
        in: path
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 36
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-giftcard-ach-service/fundtransfers/config:
    get:
      tags:
      - fund-transfer-controller
      operationId: retrieveFundTransferConfig
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FundTransferConfigResponse'
      deprecated: true
    post:
      tags:
      - fund-transfer-controller
      operationId: createOrUpdateFundTransferConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdateFundTransferConfigRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FundTransferConfigResponse'
      deprecated: true
  /incentivio-giftcard-ach-service/client-token:
    post:
      tags:
      - gift-card-ach-controller
      operationId: retrieveClientToken
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RetrieveClientTokenResponse'
  /incentivio-giftcard-ach-service/achlocations/{locationId}/status:
    post:
      tags:
      - gift-card-ach-controller
      operationId: updateLocationStatus
      parameters:
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationStatusRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-giftcard-ach-service/achlocations/{locationId}/fundingaccount/{fundingAccountId}/verifymicrodeposits:
    post:
      tags:
      - gift-card-ach-controller
      operationId: verifyMicroDeposits
      parameters:
      - name: merchantId
        in: header
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      - name: fundingAccountId
        in: path
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 36
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyMicroDepositsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-giftcard-ach-service/achlocations/copy-customer-and-account:
    post:
      tags:
      - gift-card-ach-controller
      operationId: copyCustomerAndAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyCustomerAndAccountRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /incentivio-conpay-spreedly/payment-gateway/create:
    post:
      tags:
      - spreedly-payment-gateway-controller
      operationId: createPaymentGateway
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentGatewayRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreatePaymentGatewayResponse'
  /incentivio-conpay-spreedly/environment/create:
    post:
      tags:
      - spreedly-payment-gateway-controller
      operationId: createEnvironmentRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateEnvironmentResponse'
  /incentivio-client-domain/templates:
    get:
      tags:
      - client-email-template-controller
      operationId: searchClientTemplates
      parameters:
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        required: false
        schema:
          type: string
      - name: emailTemplateType
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ClientEmailTemplateType'
      - name: reusable
        in: query
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTemplatesResponseDTO'
    post:
      tags:
      - client-email-template-controller
      operationId: createClientTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClientTemplateRequestDTO'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTemplate'
  /incentivio-client-domain/reach/display:
    post:
      tags:
      - store-controller
      operationId: readReachDisplayInfo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReachStringDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-client-domain/incadminpasswordreset:
    post:
      tags:
      - client-admin-controller
      operationId: incentivioAdminPasswordReset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlobalResetPasswordRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/merchants:
    get:
      tags:
      - client-merchant-controller
      operationId: searchMerchant
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: title
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: title
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindMerchantsResponseDTO'
    post:
      tags:
      - client-merchant-controller
      operationId: createMerchant
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMerchantRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateMerchantResponseDTO'
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores:
    get:
      tags:
      - store-controller
      operationId: searchStoreByMerchant
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: title
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: title
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindStoresResponseDTO'
    post:
      tags:
      - store-controller
      operationId: createStore
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStoreRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateStoreResponseDTO'
  /incentivio-client-domain/clients/{clientid}/createrole:
    post:
      tags:
      - role-module-permission-controller
      operationId: createRole
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRoleRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateRoleResponseDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/background/schedules:
    post:
      tags:
      - app-home-config-controller
      operationId: addSchedule
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundScheduleRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/background/default/publish:
    post:
      tags:
      - app-home-config-controller
      operationId: publishDefaultBackground
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/admins:
    get:
      tags:
      - client-admin-controller
      operationId: searchAdminUser
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: firstName
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAdminResponseDTO'
    post:
      tags:
      - client-admin-controller
      operationId: createAdminUser
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveAdminUserRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateAdminUserResponseDTO'
  /incentivio-client-domain/clients/{clientid}/admins/{adminid}/verify:
    post:
      tags:
      - client-admin-controller
      operationId: verifyAdminUserAccount
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/admins/{adminid}/updatepassword:
    post:
      tags:
      - client-admin-controller
      operationId: updatePassword
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePasswordRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/admins/{adminid}/resetpassword:
    post:
      tags:
      - client-admin-controller
      operationId: resetPassword1
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetAdminPasswordRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/admins/requestpasswordreset:
    post:
      tags:
      - client-admin-controller
      operationId: requestPasswordReset
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RequestPasswordResetRequestDTO'
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPasswordResetRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/admins/login:
    post:
      tags:
      - client-admin-controller
      operationId: adminUserLogin
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminLoginRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AdminLoginResponseDTO'
  /incentivio-client-domain/clients/email-config/verify-domain:
    post:
      tags:
      - client-configuration-controller
      operationId: verifyDomain
      parameters:
      - name: domain-id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DomainValidateResDto'
  /incentivio-client-domain/clients/email-config/client-domain:
    post:
      tags:
      - client-configuration-controller
      operationId: createEmailDomain
      parameters:
      - name: domain-name
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailSettingBasicInfoResponseDTO'
  /incentivio-auto-tagger-service/segments:
    get:
      tags:
      - segment-controller
      operationId: findAllSegments
      parameters:
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: segmentName
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          default: ASC
      - name: title
        in: query
        required: false
        schema:
          type: string
      - name: expired
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindSegmentsResponseDTO'
    post:
      tags:
      - segment-controller
      operationId: createSegment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SegmentRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateSegmentResponseDTO'
  /fail-import:
    post:
      tags:
      - menu-import-controller
      operationId: markMenuImportFailed
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkMenuImportFailedRequest'
        required: true
      responses:
        '200':
          description: OK
  /dynamicEnvs:
    get:
      tags:
      - dynamic-env-controller
      operationId: getDynamicEnvList
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DynamicEnvDTO'
    post:
      tags:
      - dynamic-env-controller
      operationId: saveDynamicEnv
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DynamicEnvDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DynamicEnvDTO'
    delete:
      tags:
      - dynamic-env-controller
      operationId: deleteDynamicEnv
      parameters:
      - name: environmentName
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /clients/{clientId}/requestmenuimport/{locationId}:
    post:
      tags:
      - menu-import-controller
      operationId: requestMenuImport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: locationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ConnectorImportedMenuResponse'
  /incentivio-user-domain/clients/{clientid}/useraccounts/{userid}:
    get:
      tags:
      - user-controller
      operationId: findUserAccount
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: userid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindUserAccountResponseDTO'
    patch:
      tags:
      - user-controller
      operationId: patchUserAccount
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: userid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserAccountPatchRequestDto'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/orders/{orderId}:
    patch:
      tags:
      - order-controller
      operationId: patchOrder
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/locations/{locationid}/orderingsettings:
    patch:
      tags:
      - location-controller
      operationId: patchLocationOrderingSettingsForAdmin
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchLocationOrderSettingsRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/item/{itemId}:
    patch:
      tags:
      - item-controller
      operationId: patchItem
      parameters:
      - name: itemId
        in: path
        required: true
        schema:
          type: string
      - name: storeId
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-giftcard-ach-service/fund-transfer-config/pool-account:
    patch:
      tags:
      - fund-transfer-config-controller
      operationId: updatePoolAccountFundTransferConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePoolAccountFundTransferConfigRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FundTransferConfigResponse'
  /incentivio-giftcard-ach-service/fund-transfer-config/locations:
    patch:
      tags:
      - fund-transfer-config-controller
      operationId: updateLocationFundTransferConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationFundTransferConfigRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FundTransferConfigResponse'
  /view/externallocation/catalogs:
    get:
      tags:
      - menu-import-controller
      operationId: viewExternalLocationCatalogs
      parameters:
      - name: clientid
        in: query
        required: true
        schema:
          type: string
      - name: incentlocationid
        in: query
        required: true
        schema:
          type: string
      - name: extlocationid
        in: query
        required: true
        schema:
          type: string
      - name: connectorgatewayname
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ConnectorViewExternalLocationCatalogsResponseDTO'
  /toastsettings/clearcache:
    get:
      tags:
      - spreedly-connector-controller
      operationId: clearToastSettingsCache
      parameters:
      - name: clientid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-wallet/scan-to-pay/sales-summary:
    get:
      tags:
      - wallet-controller
      operationId: getScanToPaySalesSummary
      parameters:
      - name: location
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ScanToPaySalesSummaryResponse'
  /incentivio-user-domain/useraccounts/{userid}/account-change-logs:
    get:
      tags:
      - user-controller
      operationId: findAllChangeLogByUseCases
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: userid
        in: path
        required: true
        schema:
          type: string
      - name: usecase
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserAccountChangeLogResponseDTO'
  /incentivio-user-domain/tags-and-rules:
    get:
      tags:
      - customer-tag-and-rule-controller
      operationId: findTagsAndRulesByClientId
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TagsAndRulesResponseDTO'
  /incentivio-user-domain/customer-tags-types:
    get:
      tags:
      - customer-tag-and-rule-controller
      operationId: findCustomerTagTypesByClientId
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomerTagDataType'
  /incentivio-user-domain/clients/{clientid}/users/filter:
    get:
      tags:
      - user-controller
      operationId: findUserAccountsByFilterMethod
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: firstName
      - name: verifiedonly
        in: query
        required: false
        schema:
          type: boolean
          default: false
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: filtermethod
        in: query
        required: false
        schema:
          type: string
      - name: firstName
        in: query
        required: false
        schema:
          type: string
      - name: lastName
        in: query
        required: false
        schema:
          type: string
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: phoneNumber
        in: query
        required: false
        schema:
          type: string
      - name: isBlocked
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindUserResponseDTO'
  /incentivio-user-domain/clients/{clientid}/users/downloadcsv:
    get:
      tags:
      - user-controller
      operationId: downloadUsersCSV
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
  /incentivio-user-domain/clients/{clientid}/clientconfig/reach:
    get:
      tags:
      - client-config-controller
      operationId: findClientConfigReachStatus
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: boolean
  /incentivio-transactions/clients/{clientid}/transactions:
    get:
      tags:
      - transaction-controller
      operationId: findTransactions
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      - name: userid
        in: query
        required: false
        schema:
          type: string
      - name: startdate
        in: query
        required: false
        schema:
          type: string
      - name: enddate
        in: query
        required: false
        schema:
          type: string
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: txDateTime
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: DESC
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindTransactionsResponseDTO'
  /incentivio-transactions/clients/{clientid}/transactions/{transactionid}:
    get:
      tags:
      - transaction-controller
      operationId: getTransaction
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: transactionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TransactionDTO'
  /incentivio-reports/pulse/email/{reportType}/opened:
    get:
      tags:
      - email-pulse-controller
      operationId: getOpened
      parameters:
      - name: reportType
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/PulseDateRange'
      - name: offerIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: campaignIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: messageIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: emailType
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PulsePieGraph'
  /incentivio-reports/pulse/email/{reportType}/data:
    get:
      tags:
      - email-pulse-controller
      operationId: getDataGrid
      parameters:
      - name: reportType
        in: path
        required: true
        schema:
          type: string
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/PulseDateRange'
      - name: offerIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: campaignIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: messageIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: emailType
        in: query
        required: false
        schema:
          type: string
      - name: pagination
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/PaginationRequest'
      - name: sorting
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/SortingRequest'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PulseDataGridWithTotalEmailDataDTO'
  /incentivio-reports/pulse/email/{reportType}/cards:
    get:
      tags:
      - email-pulse-controller
      operationId: getEmailPulseCards
      parameters:
      - name: reportType
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/PulseDateRange'
      - name: offerIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: campaignIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: messageIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: emailType
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailCardsDTO'
  /incentivio-reports/pulse/email/{reportType}/bounced:
    get:
      tags:
      - email-pulse-controller
      operationId: getBounced
      parameters:
      - name: reportType
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/PulseDateRange'
      - name: offerIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: campaignIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: messageIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: emailType
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PulsePieGraph'
  /incentivio-reports/pulse/email/overview/trends:
    get:
      tags:
      - email-pulse-controller
      operationId: getOverviewTrends
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/PulseDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PulseTimeSeries'
  /incentivio-reports/pulse/email/offers:
    get:
      tags:
      - email-pulse-controller
      operationId: getOffers
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmailPulseOfferDTO'
  /incentivio-reports/pulse/email/messages:
    get:
      tags:
      - email-pulse-controller
      operationId: getMessages
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmailPulseMessageDTO'
  /incentivio-reports/menuintelligence/locations:
    get:
      tags:
      - menu-intelligence-controller
      operationId: getMenuIntelligenceLocations
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MenuIntelligenceLocation'
  /incentivio-reports/menuintelligence/itemMetrics:
    get:
      tags:
      - menu-intelligence-controller
      operationId: getMenuIntelligenceItemMetrics
      parameters:
      - name: groups
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: groupType
        in: query
        required: false
        schema:
          type: string
      - name: location
        in: query
        required: false
        schema:
          type: string
      - name: searchInput
        in: query
        required: false
        schema:
          type: string
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: itemScore
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          default: DESC
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MenuIntelligenceItemMetricsResponseDTO'
  /incentivio-reports/menuintelligence/itemMetrics/export:
    get:
      tags:
      - menu-intelligence-controller
      operationId: getMenuIntelligenceItemMetricsCSVString
      parameters:
      - name: groups
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: groupType
        in: query
        required: false
        schema:
          type: string
      - name: location
        in: query
        required: false
        schema:
          type: string
      - name: searchInput
        in: query
        required: false
        schema:
          type: string
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: itemScore
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          default: DESC
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-reports/menuintelligence/groups:
    get:
      tags:
      - menu-intelligence-controller
      operationId: getMenuIntelligenceGroups
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MenuIntelligenceGroup'
  /incentivio-reports/loyaltyreport/offers/trends:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportOffersTrendsPage
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      - name: paginationRequest
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportPaginationRequest'
      - name: datatype
        in: query
        required: true
        schema:
          type: string
      - name: granularity
        in: query
        required: false
        schema:
          type: string
      - name: offerIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: offertype
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportOfferTrendsResponse'
  /incentivio-reports/loyaltyreport/offers/performance/summary:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportOfferPerformanceSummary
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      - name: offerIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: offertype
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportPerformanceDTO'
  /incentivio-reports/loyaltyreport/offers/performance/data:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportOfferPerformanceData
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      - name: paginationRequest
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportPaginationRequest'
      - name: sortingDto
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/SortingDto'
      - name: offerIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: offertype
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportDataGridOffersPageDTO'
  /incentivio-reports/loyaltyreport/locations/trends:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportLocationsTrendsPage
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      - name: paginationRequest
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportPaginationRequest'
      - name: datatype
        in: query
        required: true
        schema:
          type: string
      - name: granularity
        in: query
        required: false
        schema:
          type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportLocationTrendsResponse'
  /incentivio-reports/loyaltyreport/locations/performance/summary:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportLocationPerformanceSummary
      parameters:
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportPerformanceDTO'
  /incentivio-reports/loyaltyreport/locations/performance/data:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportLocationPerformancePage
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      - name: paginationRequest
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportPaginationRequest'
      - name: sortingDto
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/SortingDto'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportDataGridLocationsPageDTO'
  /incentivio-reports/loyaltyreport/franchise/summary:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportFranchiseSummary
      parameters:
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportFranchiseSummaryDTO'
  /incentivio-reports/loyaltyreport/franchise/loyaltysales:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportLoyaltySalesForFranchise
      parameters:
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportTimeSeriesDTO'
  /incentivio-reports/loyaltyreport/franchise/activemembers:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportSignUpTimeseriesForFranchise
      parameters:
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportTimeSeriesDTO'
  /incentivio-reports/loyaltyreport/brand/summary:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportSummaryForBrand
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportBrandOverallSummaryDTO'
  /incentivio-reports/loyaltyreport/brand/signup/timeseries:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportSignUpTimeseriesForBrand
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportTimeSeriesDTO'
  /incentivio-reports/loyaltyreport/brand/signup/aggregate:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportSignUpsForBrand
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
          minLength: 1
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportPieGraphDTO'
  /incentivio-reports/loyaltyreport/brand/pointssummary:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportPointsSummaryForBrand
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportBrandPointsSummaryDTO'
  /incentivio-reports/loyaltyreport/brand/orders:
    get:
      tags:
      - loyalty-report-controller
      operationId: getLoyaltyReportOrdersForBrand
      parameters:
      - name: dateRange
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/LoyaltyReportDateRange'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoyaltyReportPieGraphDTO'
  /incentivio-reports/jobs/status:
    get:
      tags:
      - job-status-controller
      operationId: getCurrentJobStatuses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusResponse'
  /incentivio-reports/guest-journey-analysis/export:
    get:
      tags:
      - guest-journey-report-controller
      operationId: exportGuestJourneyAnalysis
      parameters:
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestJourneyReportResponseDTO'
  /incentivio-reports/clients/{clientid}/survey:
    get:
      tags:
      - report-controller
      operationId: getSurveyReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: surveyId
        in: query
        required: false
        schema:
          type: string
      - name: download
        in: query
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
  /incentivio-reports/clients/{clientid}/salesbyordertype:
    get:
      tags:
      - report-controller
      operationId: getSalesByOrderTypeReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SalesByOrderTypeReportDTO'
  /incentivio-reports/clients/{clientid}/salesbylocation:
    get:
      tags:
      - report-controller
      operationId: getSalesByLocationReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SalesByLocationAndTimeReportDTO'
  /incentivio-reports/clients/{clientid}/salesbychannelovertime:
    get:
      tags:
      - report-controller
      operationId: getSalesByChannelOverTimeReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SalesByChannelOverTimeDTO'
  /incentivio-reports/clients/{clientid}/salesbychannel:
    get:
      tags:
      - report-controller
      operationId: getSalesByChannelReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SalesByChannelReportDTO'
  /incentivio-reports/clients/{clientid}/ordersbysigninstatus:
    get:
      tags:
      - report-controller
      operationId: getOrdersBySignInStatusReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrdersBySignInStatusReportDTO'
  /incentivio-reports/clients/{clientid}/ordersbyordertype:
    get:
      tags:
      - report-controller
      operationId: getOrdersByOrderTypeReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrdersByOrderTypeReportDTO'
  /incentivio-reports/clients/{clientid}/ordersbylocation:
    get:
      tags:
      - report-controller
      operationId: getOrdersByLocationReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrdersByLocationAndTimeReportDTO'
  /incentivio-reports/clients/{clientid}/ordersbychannelovertime:
    get:
      tags:
      - report-controller
      operationId: getOrdersByChannelOverTimeReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrdersByChannelOverTimeDTO'
  /incentivio-reports/clients/{clientid}/ordersbychannel:
    get:
      tags:
      - report-controller
      operationId: getOrdersByChannelReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrdersByChannelReportDTO'
  /incentivio-reports/clients/{clientid}/offerredemptionbytimeofthedaydistributed:
    get:
      tags:
      - report-controller
      operationId: getOfferRedemptionByTimeOfTheDayDistributedReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OfferRedemptionByTimeOfTheDayDistributedReportDTO'
  /incentivio-reports/clients/{clientid}/offerredemptionbytimeoftheday:
    get:
      tags:
      - report-controller
      operationId: getOfferRedemptionByTimeOfTheDayReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OfferRedemptionByTimeOfTheDayReportDTO'
  /incentivio-reports/clients/{clientid}/offerperformance:
    get:
      tags:
      - report-controller
      operationId: getOfferPerformanceReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OfferPerformanceReportDTO'
  /incentivio-reports/clients/{clientid}/mostpopularitems:
    get:
      tags:
      - report-controller
      operationId: getMostPopularItemsReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MostPopularItemsReportDTO'
  /incentivio-reports/clients/{clientid}/monthlyactiveusers:
    get:
      tags:
      - report-controller
      operationId: getMonthlyActiveUsersReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-reports/clients/{clientid}/messageviewsbytimeofthedaydistributed:
    get:
      tags:
      - report-controller
      operationId: getMessageViewsByTimeOfTheDayDistributedReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MessageViewsByTimeOfTheDayDistributedReportDTO'
  /incentivio-reports/clients/{clientid}/messageviewsbytimeoftheday:
    get:
      tags:
      - report-controller
      operationId: getMessageViewsByTimeOfTheDayReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MessageViewsByTimeOfTheDayReportDTO'
  /incentivio-reports/clients/{clientid}/messageperformance:
    get:
      tags:
      - report-controller
      operationId: getMessagePerformanceReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MessagePerformanceReportDTO'
  /incentivio-reports/clients/{clientid}/loyaltyofferredemptionbytimeofthedaydistributed:
    get:
      tags:
      - report-controller
      operationId: getLoyaltyOfferRedemptionByTimeOfTheDayDistributedReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LoyaltyOfferRedemptionByTimeOfTheDayDistributedReportDTO'
  /incentivio-reports/clients/{clientid}/loyaltyofferredemptionbytimeoftheday:
    get:
      tags:
      - report-controller
      operationId: getLoyaltyOfferRedemptionByTimeOfTheDayReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LoyaltyOfferRedemptionByTimeOfTheDayReportDTO'
  /incentivio-reports/clients/{clientid}/loyaltyofferperformance:
    get:
      tags:
      - report-controller
      operationId: getLoyaltyOfferPerformanceReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LoyaltyOfferPerformanceReportDTO'
  /incentivio-reports/clients/{clientid}/leastpopularitems:
    get:
      tags:
      - report-controller
      operationId: getLeastPopularItemsReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeastPopularItemsReportDTO'
  /incentivio-reports/clients/{clientid}/giftcardpoolsummary:
    get:
      tags:
      - gift-card-report-controller
      operationId: getGiftCardPoolSummaryReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardPoolSummaryReportDTO'
  /incentivio-reports/clients/{clientid}/giftcardpoolsummary/download-csv:
    get:
      tags:
      - gift-card-report-controller
      operationId: downloadGiftCardPoolSummaryAsCSV2
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: ispoolaccount
        in: query
        required: false
        schema:
          type: boolean
          default: true
      - name: storeid
        in: query
        required: false
        schema:
          type: string
          default: ''
      - name: storename
        in: query
        required: false
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
  /incentivio-reports/clients/{clientid}/giftcardpoolsummary/download-csv-s3url:
    get:
      tags:
      - gift-card-report-controller
      operationId: downloadGiftCardPoolSummaryAsCSVS3Url
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: ispoolaccount
        in: query
        required: false
        schema:
          type: boolean
          default: true
      - name: storeid
        in: query
        required: false
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
  /incentivio-reports/clients/{clientid}/frequentlyboughttogether:
    get:
      tags:
      - report-controller
      operationId: getFrequentlyBoughtTogetherReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FrequentlyBoughtTogetherReportDTO'
  /incentivio-reports/clients/{clientid}/dailyactiveusers:
    get:
      tags:
      - report-controller
      operationId: getDailyActiveUsersReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-reports/clients/{clientid}/customersbyorders:
    get:
      tags:
      - report-controller
      operationId: getCustomersByOrdersReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByOrdersReportDTO'
  /incentivio-reports/clients/{clientid}/customersbymostvisitsperweek:
    get:
      tags:
      - report-controller
      operationId: getCustomersByMostVisitsPerWeekReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByMostVisitsPerWeekReportDTO'
  /incentivio-reports/clients/{clientid}/customersbyloyaltybalance:
    get:
      tags:
      - report-controller
      operationId: getCustomersByLoyaltyBalanceReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByLoyaltyBalanceReportDTO'
  /incentivio-reports/clients/{clientid}/customersbyhighestaverageordersize:
    get:
      tags:
      - report-controller
      operationId: getCustomersByHighestAverageOrderSizeReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByHighestAverageOrderSizeReportDTO'
  /incentivio-reports/clients/{clientid}/customersbygender:
    get:
      tags:
      - report-controller
      operationId: getCustomersByGenderReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomersByGenderReportDTO'
  /incentivio-reports/clients/{clientid}/customersbydayssincelastpurchasepercentile:
    get:
      tags:
      - report-controller
      operationId: getCustomersByDaysSinceLastPurchasePercentileReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByDaysSinceLastPurchasePercentileReportDTO'
  /incentivio-reports/clients/{clientid}/customersbydayssincelastpurchase:
    get:
      tags:
      - report-controller
      operationId: getCustomersByDaysSinceLastPurchaseReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByDaysSinceLastPurchaseReportDTO'
  /incentivio-reports/clients/{clientid}/customersbyaverageorders:
    get:
      tags:
      - report-controller
      operationId: getCustomersByAverageOrdersReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByAverageOrdersReportDTO'
  /incentivio-reports/clients/{clientid}/customersbyaveragebasketvaluepercentile:
    get:
      tags:
      - report-controller
      operationId: getCustomersByAverageBasketValuePercentileReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByAverageBasketValuePercentileReportDTO'
  /incentivio-reports/clients/{clientid}/customersbyaveragebasketvalue:
    get:
      tags:
      - report-controller
      operationId: getCustomersByAverageBasketValueReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByAverageBasketValueReportDTO'
  /incentivio-reports/clients/{clientid}/customersbyage:
    get:
      tags:
      - report-controller
      operationId: getCustomersByAgeReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomersByAgeReportDTO'
  /incentivio-reports/clients/{clientid}/averageordersize:
    get:
      tags:
      - report-controller
      operationId: getAverageOrderSizeReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeids
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AverageOrderSizeReportDTO'
  /incentivio-reports/clients/{clientId}/total-signups:
    get:
      tags:
      - customer-report-controller
      operationId: retrieveTotalSignUps
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TotalSignUpsReportDTO'
  /incentivio-reports/clients/{clientId}/sales-by-pos-category:
    get:
      tags:
      - sales-report-controller
      operationId: retrieveSalesByPosCategoryReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SalesByPosCategoryReportDTO'
  /incentivio-reports/clients/{clientId}/sales-by-order-source:
    get:
      tags:
      - sales-report-controller
      operationId: retrieveSalesByOrderSourceReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SalesByOrderSourceReportDTO'
  /incentivio-reports/clients/{clientId}/sales-by-location:
    get:
      tags:
      - sales-report-controller
      operationId: retrieveSalesByLocationReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SalesByLocationReportDTO'
  /incentivio-reports/clients/{clientId}/recommendation-dashboard/top-items:
    get:
      tags:
      - recommendation-report-controller
      operationId: getTopRecommendedItemsReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TopRecommendedItemsDTO'
  /incentivio-reports/clients/{clientId}/recommendation-dashboard/summary:
    get:
      tags:
      - recommendation-report-controller
      operationId: getRecommendationSummary
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RecommendationSummaryDTO'
  /incentivio-reports/clients/{clientId}/recommendation-dashboard/average-basket-value:
    get:
      tags:
      - recommendation-report-controller
      operationId: getAverageBasketValueReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecommendedAverageBasketValueDTO'
  /incentivio-reports/clients/{clientId}/previous-month/sales-by-location:
    get:
      tags:
      - sales-report-controller
      operationId: retrieveSalesByLocationForPreviousMonthReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SalesByLocationForPreviousMonthReportDTO'
  /incentivio-reports/clients/{clientId}/previous-month/new-signups:
    get:
      tags:
      - customer-report-controller
      operationId: retrieveNewSignUpsForPreviousMonth
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/NewSignUpsForPreviousMonthReportDTO'
  /incentivio-reports/clients/{clientId}/offer-performance:
    get:
      tags:
      - offers-report-controller
      operationId: retrieveOfferPerformanceReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: DESC
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: totalSales
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OfferPerformanceReportDTO'
  /incentivio-reports/clients/{clientId}/new-signups:
    get:
      tags:
      - customer-report-controller
      operationId: retrieveNewSignUps
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NewSignUpsReportDTO'
  /incentivio-reports/clients/{clientId}/deliveries-by-location:
    get:
      tags:
      - deliveries-by-location-report-controller
      operationId: retrieveDeliveriesByLocationReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeliveriesByLocationReportDTO'
  /incentivio-reports/clients/{clientId}/customers/download:
    get:
      tags:
      - customer-report-controller
      operationId: customersDownload
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: clientName
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
  /incentivio-persona-processor/personadatasource/clientid/{clientid}/merchantid/{merchantid}/quantiletype/{quantiletype}:
    get:
      tags:
      - persona-controller
      operationId: personaDataSource
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: quantiletype
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/QuantileType'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GraphPoint'
  /incentivio-ordering-service/searchadminorders:
    get:
      tags:
      - order-controller
      operationId: searchOrdersForAdmin
      parameters:
      - name: firstname
        in: query
        required: false
        schema:
          type: string
      - name: lastname
        in: query
        required: false
        schema:
          type: string
      - name: phone
        in: query
        required: false
        schema:
          type: string
      - name: orderid
        in: query
        required: false
        schema:
          type: string
      - name: extorderid
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: orderStatus
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: fulfillmentStatus
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FulfillmentStatus'
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/OrderSort'
      - name: sortby
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/OrderSortBy'
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SearchOrdersResponseDTOWithPagingForAdmin'
  /incentivio-ordering-service/packages/{packageid}:
    get:
      tags:
      - package-controller
      operationId: viewPackageById
      parameters:
      - name: packageid
        in: path
        required: true
        schema:
          type: string
      - name: includeChildElements
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ViewPackageResponseDTO'
    delete:
      tags:
      - package-controller
      operationId: deletePackage
      parameters:
      - name: packageid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/orderscount:
    get:
      tags:
      - order-controller
      operationId: getOrdersCount
      parameters:
      - name: firstname
        in: query
        required: false
        schema:
          type: string
      - name: lastname
        in: query
        required: false
        schema:
          type: string
      - name: phone
        in: query
        required: false
        schema:
          type: string
      - name: orderid
        in: query
        required: false
        schema:
          type: string
      - name: extorderid
        in: query
        required: false
        schema:
          type: string
      - name: orderStatus
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: fulfillmentStatus
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FulfillmentStatus'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: integer
                format: int32
  /incentivio-ordering-service/orders/{orderid}/sendreceipt:
    get:
      tags:
      - order-controller
      operationId: sendOrderReceipt
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/locations/clients/{clientid}/merchants/{merchantid}/locations:
    get:
      tags:
      - location-controller
      operationId: findAllLocations
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindLocationResponseDTO'
  /incentivio-ordering-service/locations/clients/{clientid}/all/locations:
    get:
      tags:
      - location-controller
      operationId: findAllLocationsByClient
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindLocationResponseDTO'
  /incentivio-ordering-service/imhereorderscount:
    get:
      tags:
      - order-controller
      operationId: getImHereOrdersCount
      parameters:
      - name: firstname
        in: query
        required: false
        schema:
          type: string
      - name: lastname
        in: query
        required: false
        schema:
          type: string
      - name: phone
        in: query
        required: false
        schema:
          type: string
      - name: orderid
        in: query
        required: false
        schema:
          type: string
      - name: extorderid
        in: query
        required: false
        schema:
          type: string
      - name: orderStatus
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: fulfillmentStatus
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FulfillmentStatus'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrdersCountResponseDTO'
  /incentivio-ordering-service/dailyadminorders:
    get:
      tags:
      - order-controller
      operationId: dailyOrdersForAdmin
      parameters:
      - name: merchantId
        in: query
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      - name: filterModes
        in: query
        required: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderFilteringMode'
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: storeIds
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DailyOrdersResponseDTOWithPagingForAdmin'
  /incentivio-ordering-service/dailyadminorders/downloadcsv:
    get:
      tags:
      - order-controller
      operationId: downloadDailyOrdersForCSVExport
      parameters:
      - name: merchantId
        in: query
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      - name: filterModes
        in: query
        required: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderFilteringMode'
      - name: storeIds
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
  /incentivio-ordering-service/clients/{clientid}/poolaccount:
    get:
      tags:
      - order-controller
      operationId: getPoolAccountTimeZone
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-ordering-service/adminsubitems:
    get:
      tags:
      - sub-item-controller
      operationId: listSubItemsByClientIdAndItemIdForAdmin
      parameters:
      - name: itemid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ListSubItemResponseAdminDTO'
  /incentivio-ordering-service/adminsubitems/{subitemid}:
    get:
      tags:
      - sub-item-controller
      operationId: viewSubItemByIdForAdmin
      parameters:
      - name: subitemid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ViewSubItemResponseAdminDTO'
  /incentivio-ordering-service/adminorders/{orderid}:
    get:
      tags:
      - order-controller
      operationId: viewOrderByIdForAdmin
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ViewOrderResponseDTOForAdmin'
  /incentivio-ordering-service/adminitems:
    get:
      tags:
      - item-controller
      operationId: listItemByGroupAndTimeForAdmin
      parameters:
      - name: groupId
        in: query
        required: false
        schema:
          type: string
      - name: catalogId
        in: query
        required: false
        schema:
          type: string
      - name: title
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: incentivioIds
        in: query
        required: false
        schema:
          type: string
      - name: externalIds
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Status'
      - name: outOfStock
        in: query
        required: false
        schema:
          type: boolean
      - name: outOfStockToday
        in: query
        required: false
        schema:
          type: boolean
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: title
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListItemResponseWithPagingForAdminDTO'
  /incentivio-ordering-service/adminitems/{itemid}:
    get:
      tags:
      - item-controller
      operationId: viewItemByIdForAdmin
      parameters:
      - name: itemid
        in: path
        required: true
        schema:
          type: string
      - name: includeStores
        in: query
        required: false
        schema:
          type: boolean
      - name: includeChildElements
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ViewItemAdminDTO'
  /incentivio-ordering-service/adminitems/downloadcsv:
    get:
      tags:
      - item-controller
      operationId: downloadItemsCSV
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
  /incentivio-ordering-service/adminitems/by-displayinfo-title:
    get:
      tags:
      - item-controller
      operationId: getItemsByDisplayInfoTitleForAdmin
      parameters:
      - name: displayInfoTitle
        in: query
        required: false
        schema:
          type: string
      - name: languageCode
        in: query
        required: false
        schema:
          type: string
      - name: itemType
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindItemsDisplayInfoResponse'
  /incentivio-ordering-service/adminitem/image:
    get:
      tags:
      - recommendation-report-controller
      operationId: getItemImagesByDisplayTitles
      parameters:
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: itemDisplayTitles
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TopRecommendedItemsDTO'
  /incentivio-ordering-service/admingroups/{groupid}:
    get:
      tags:
      - group-controller
      operationId: viewGroupById
      parameters:
      - name: groupid
        in: path
        required: true
        schema:
          type: string
      - name: includeStores
        in: query
        required: false
        schema:
          type: boolean
      - name: includeChildElements
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ViewGroupAdminDTO'
  /incentivio-ordering-service/admingroups/downloadcsv:
    get:
      tags:
      - group-controller
      operationId: downloadGroupsCSV
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
  /incentivio-ordering-service/admingroups/by-displayinfo-title:
    get:
      tags:
      - group-controller
      operationId: getGroupByDisplayInfoTitleForAdmin
      parameters:
      - name: displayInfoTitle
        in: query
        required: false
        schema:
          type: string
      - name: languageCode
        in: query
        required: false
        schema:
          type: string
      - name: groupType
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindGroupsDisplayInfoResponse'
  /incentivio-ordering-service/admincatalogs:
    get:
      tags:
      - order-controller
      operationId: listCatalogsByClientIdAndStoreIdsForAdmin_1
      parameters:
      - name: title
        in: query
        required: false
        schema:
          type: string
      - name: incentivioIds
        in: query
        required: false
        schema:
          type: string
      - name: externalIds
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListCatalogResponseWithPagingForAdminDTO'
  /incentivio-ordering-service/admincatalogs/{catalogid}:
    get:
      tags:
      - order-controller
      operationId: viewCatalogByIdForAdmin
      parameters:
      - name: catalogid
        in: path
        required: true
        schema:
          type: string
      - name: includeStores
        in: query
        required: false
        schema:
          type: boolean
      - name: includeChildElements
        in: query
        required: false
        schema:
          type: string
      - name: compressed
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ViewCatalogAdminDTO'
  /incentivio-offers-domain/clients/merchants/campaigns:
    get:
      tags:
      - campaign-controller
      operationId: findCampaignsByClientAndMerchantId
      parameters:
      - name: title
        in: query
        required: false
        schema:
          type: string
      - name: isexpired
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindCampaignResponseDTO'
  /incentivio-menu-service/search/locations:
    get:
      tags:
      - menu-search-pass-through-controller
      operationId: searchLocations
      parameters:
      - name: extTargetingId
        in: query
        required: true
        schema:
          type: string
      - name: productType
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/ProductType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationDetailResponse'
  /incentivio-menu-service/merchants/{merchantid}/mostrecentimports:
    get:
      tags:
      - menu-import-controller
      operationId: retrieveMostRecentMenuImports
      parameters:
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: locationTitle
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: filterByAllowedLocations
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MenuImportHistoryWithPagingDTO'
  /incentivio-menu-service/locations/{locationid}/pastimports:
    get:
      tags:
      - menu-import-controller
      operationId: retrievePastMenuImports
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MenuImportHistoryWithPagingDTO'
  /incentivio-media/clients/{clientid}/media/{fileid}/content:
    get:
      tags:
      - file-controller
      operationId: retrieveFile
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: fileid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
                format: byte
  /incentivio-loyalty-domain/clients/{clientid}/loyaltyaccounts/{loyaltyaccountid}/accounthistory:
    get:
      tags:
      - loyalty-controller
      operationId: viewLoyalAccountHistory
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: loyaltyaccountid
        in: path
        required: true
        schema:
          type: string
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      - name: startdate
        in: query
        required: false
        schema:
          type: string
      - name: enddate
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: transactionDate
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: DESC
      - name: status
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/LoyaltyTransactionStatus'
      - name: atgOrderId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindLoyaltyHistoryResponseDTO'
  /incentivio-guest-journey-service/user/{userId}/journey:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestJourney
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ViewGuestJourneyResponse'
  /incentivio-guest-journey-service/guestsummary:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestSummary
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestSummaryResponse'
  /incentivio-guest-journey-service/guestrevenuesummary:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestRevenueSummary
      parameters:
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestRevenueSummaryResponse'
  /incentivio-guest-journey-service/guestcountsummary:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestCountSummary
      parameters:
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestCountSummaryResponse'
  /incentivio-guest-journey-service/clients/{clientid}/merchants/{merchantid}/guestrevenuesummarybystore:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestRevenueSummaryByStore
      parameters:
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      - name: guesttype
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/GuestSegmentType'
      - name: stores
        in: query
        required: false
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestRevenueSummaryByStoreResponse'
  /incentivio-guest-journey-service/clients/{clientid}/merchants/{merchantid}/guestcountsummarybystore:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestCountSummaryByStore
      parameters:
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      - name: guesttype
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/GuestSegmentType'
      - name: stores
        in: query
        required: false
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestCountSummaryByStoreResponse'
  /incentivio-giftcard-service/location/{locationid}/giftcard/location-config:
    get:
      tags:
      - gift-card-client-onboard-controller
      operationId: getGiftCardLocationConfig
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: string
  /incentivio-giftcard-service/giftcard/transaction/{giftcardtxid}/sendreceipt:
    get:
      tags:
      - gift-card-controller
      operationId: sendGiftCardReceipt
      parameters:
      - name: giftcardtxid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-giftcard-service/giftcard/providers:
    get:
      tags:
      - gift-card-client-onboard-controller
      operationId: getGiftCardProviders
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
  /incentivio-giftcard-service/giftcard/locations-config:
    get:
      tags:
      - gift-card-client-onboard-controller
      operationId: getGiftCardLocationsConfig
      parameters:
      - name: locationFilter
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: noConfiguredLocations
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          default: ASC
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GiftCardLocationConfig'
  /incentivio-giftcard-service/clients/{clientid}/giftcardclientsettings:
    get:
      tags:
      - gift-card-controller
      operationId: retrieveGiftCardProvider
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardServiceProvider'
  /incentivio-giftcard-service/clients/{clientid}/balance-report/generate:
    get:
      tags:
      - gift-card-balance-report-controller
      operationId: generateBalanceReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: liableasofdate
        in: query
        required: true
        schema:
          type: string
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardBalanceReportDTO'
  /incentivio-giftcard-service/clients/{clientid}/balance-report/export:
    get:
      tags:
      - gift-card-balance-report-controller
      operationId: exportGiftCardBalanceReport
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: liableasofdate
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardBalanceExportReportResponse'
  /incentivio-giftcard-service/client/{clientid}/giftcard/client-config:
    get:
      tags:
      - gift-card-client-onboard-controller
      operationId: getGiftCardClientConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardClientConfigResponse'
  /incentivio-giftcard-service/cards/search:
    get:
      tags:
      - gift-card-controller
      operationId: searchGiftCardForAdmin
      parameters:
      - name: adminGiftCardSearchRequestDTO
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/AdminGiftCardSearchRequestDTO'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AdminSearchForGiftCardResponseDTO'
  /incentivio-giftcard-service/cards/batch-summary:
    get:
      tags:
      - gift-card-controller
      operationId: searchGiftCardAccountBatchSummaries
      parameters:
      - name: searchRequestDTO
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/SearchGiftCardAccountBatchSummaryRequestDTO'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SearchGiftCardAccountBatchSummaryResponseDTO'
  /incentivio-giftcard-service/cards/batch-summary/{batchId}:
    get:
      tags:
      - gift-card-controller
      operationId: findGiftCardAccountBatchSummaryById
      parameters:
      - name: batchId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardAccountBatchSummaryDTO'
  /incentivio-giftcard-service/card/view:
    get:
      tags:
      - gift-card-controller
      operationId: viewGiftCardForAdmin
      parameters:
      - name: cardNumber
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AdminViewGiftCardResponseDTO'
  /incentivio-giftcard-service/card/transactions/view:
    get:
      tags:
      - gift-card-controller
      operationId: viewGiftCardTransactionsForAdmin
      parameters:
      - name: cardNumber
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AdminViewTransactionForGiftCardResponseDTO'
  /incentivio-giftcard-service/card/events/view:
    get:
      tags:
      - gift-card-controller
      operationId: viewGiftCardEventsForAdmin
      parameters:
      - name: cardNumber
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AdminViewEventsForGiftCardResponseDTO'
  /incentivio-giftcard-ach-service/iav-token/{customerId}:
    get:
      tags:
      - gift-card-ach-controller
      operationId: retrieveIAVToken
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RetrieveIAVTokenResponse'
  /incentivio-giftcard-ach-service/fund-transfer-config:
    get:
      tags:
      - fund-transfer-config-controller
      operationId: retrieveFundTransferConfig_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FundTransferConfigResponse'
  /incentivio-giftcard-ach-service/achlocations/{locationId}:
    get:
      tags:
      - gift-card-ach-controller
      operationId: retrieveLocation
      parameters:
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      - name: sync-status
        in: query
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ACHLocationDTO'
  /incentivio-giftcard-ach-service/achlocations/{locationId}/transfers:
    get:
      tags:
      - fund-transfer-controller
      operationId: retrieveTransferHistory
      parameters:
      - name: merchantId
        in: header
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      - name: pageIndex
        in: query
        required: true
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: DESC
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RetrieveFundTransferListResponse'
  /incentivio-giftcard-ach-service/achlocations/{locationId}/fundingaccount/{fundingAccountId}/balance:
    get:
      tags:
      - gift-card-ach-controller
      operationId: retrieveFundingAccountBalance
      parameters:
      - name: merchantId
        in: header
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      - name: fundingAccountId
        in: path
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 36
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-giftcard-ach-service/achlocations/{locationId}/beneficialowners:
    get:
      tags:
      - gift-card-ach-controller
      operationId: retrieveBeneficialOwners
      parameters:
      - name: merchantId
        in: header
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RetrieveBeneficalOwnersResponse'
  /incentivio-connector-sms/clients/{clientId}/order-confirmation-sms/download:
    get:
      tags:
      - sms-reports-controller
      operationId: orderConfirmationSmsReportDownload
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
  /incentivio-connector-sms/clients/{clientId}/marketing-sms/download:
    get:
      tags:
      - sms-reports-controller
      operationId: marketingSmsReportDownload
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          default: DESC
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: startDate
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
  /incentivio-connector-sms/clients/{clientId}/guest-checkout-verification/download:
    get:
      tags:
      - sms-reports-controller
      operationId: guestCheckoutVerificationSmsReportDownload
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
  /incentivio-connector-sms/clients/{clientId}/account-verification-sms/download:
    get:
      tags:
      - sms-reports-controller
      operationId: accountVerificationSmsReportDownload
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
      - name: endDate
        in: query
        required: true
        schema:
          type: string
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
  /incentivio-client-domain/verifyemail:
    get:
      tags:
      - client-admin-controller
      operationId: verifyEmailVerificationCode
      parameters:
      - name: code
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/templates/{templateid}/associations:
    get:
      tags:
      - client-email-template-controller
      operationId: getOffersOrMessagesByTemplateId
      parameters:
      - name: templateid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
  /incentivio-client-domain/templates/tags:
    get:
      tags:
      - client-email-template-controller
      operationId: getTemplateTags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TemplateTagResponseDTO'
  /incentivio-client-domain/templates/events/{event}:
    get:
      tags:
      - client-email-template-controller
      operationId: getEventBasedClientTemplate
      parameters:
      - name: event
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/EventType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTemplate'
  /incentivio-client-domain/templates/alltemplates:
    get:
      tags:
      - client-email-template-controller
      operationId: allClientTemplates
      parameters:
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTemplatesResponseDTO'
  /incentivio-client-domain/tabletappcompatibility:
    get:
      tags:
      - tablet-app-compatibility-controller
      operationId: checkTabletAppCompatibility
      parameters:
      - name: Inc-Client-Id
        in: header
        required: false
        schema:
          type: string
      - name: version
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TabletAppCompatibilityDTO'
  /incentivio-client-domain/clients/{clientid}/storetypes:
    get:
      tags:
      - store-controller
      operationId: listStoreTypeByClientId
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindStoreTypesResponseDTO'
  /incentivio-client-domain/clients/{clientid}/stores:
    get:
      tags:
      - store-controller
      operationId: searchStoreByClient
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: title
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: latitude
        in: query
        required: true
        schema:
          type: number
          format: double
      - name: longitude
        in: query
        required: true
        schema:
          type: number
          format: double
      - name: radius
        in: query
        required: true
        schema:
          type: number
          format: double
      - name: langCode
        in: query
        required: false
        schema:
          type: string
      - name: iscatering
        in: query
        required: false
        schema:
          type: boolean
      - name: ismenubrowsing
        in: query
        required: false
        schema:
          type: boolean
      - name: istest
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindStoresResponseDTO'
  /incentivio-client-domain/clients/{clientid}/stores/{identifier}:
    get:
      tags:
      - store-controller
      operationId: readStoreByClientAndIdentifier
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: identifier
        in: path
        required: true
        schema:
          type: string
      - name: idtype
        in: query
        required: false
        schema:
          type: string
          default: id
      - name: langCode
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/StoreDTO'
  /incentivio-client-domain/clients/{clientid}/secure-admins/{adminid}:
    get:
      tags:
      - client-admin-controller
      operationId: findSecureAdminUserById
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SecureAdminResponseDTO'
  /incentivio-client-domain/clients/{clientid}/secure-admins/email:
    get:
      tags:
      - client-admin-controller
      operationId: findSecureAdminUserByClientIdAndEmail
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: email
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SecureAdminResponseDTO'
  /incentivio-client-domain/clients/{clientid}/searchroles:
    get:
      tags:
      - role-module-permission-controller
      operationId: searchRoles
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: role
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: userid
        in: query
        required: false
        schema:
          type: string
      - name: role
        in: query
        required: false
        schema:
          type: string
      - name: showAll
        in: query
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SearchRolesResponseDTO'
  /incentivio-client-domain/clients/{clientid}/searchpermissions:
    get:
      tags:
      - role-module-permission-controller
      operationId: findPermissions
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SearchModulesResponseDTO'
  /incentivio-client-domain/clients/{clientid}/reach:
    get:
      tags:
      - store-controller
      operationId: readClientReachString
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores/{identifier}:
    get:
      tags:
      - store-controller
      operationId: readStoreByMerchantAndIdentifier
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: identifier
        in: path
        required: true
        schema:
          type: string
      - name: idtype
        in: query
        required: false
        schema:
          type: string
          default: id
      - name: langCode
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/StoreDTO'
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/iseditable:
    get:
      tags:
      - client-merchant-controller
      operationId: isMerchantEditable
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: boolean
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/exist:
    get:
      tags:
      - client-merchant-controller
      operationId: existsMerchant
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: boolean
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/admins/{adminid}/stores:
    get:
      tags:
      - store-controller
      operationId: searchStoreByAdmin
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: title
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: title
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindStoresResponseDTO'
  /incentivio-client-domain/clients/{clientid}/merchants-by-ids:
    get:
      tags:
      - client-merchant-controller
      operationId: listMerchantByMerchantIds
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: merchantids
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindMerchantsByIdsResponseDTO'
  /incentivio-client-domain/clients/{clientid}/findrole/{roleid}:
    get:
      tags:
      - role-module-permission-controller
      operationId: findRole
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: roleid
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RoleDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config:
    get:
      tags:
      - app-home-config-controller
      operationId: getAppHomeConfig
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/audit:
    get:
      tags:
      - app-home-config-controller
      operationId: getAuditHistory
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppHomeConfigAuditDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/admin:
    get:
      tags:
      - app-home-config-controller
      operationId: getAppHomeConfigAdmin
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/all/stores:
    get:
      tags:
      - store-controller
      operationId: listStoreByClientId
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAllStoresResponseDTO'
  /incentivio-client-domain/clients/{clientid}/admins/{adminid}/reach:
    get:
      tags:
      - client-admin-controller
      operationId: findReach
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-client-domain/clients/{clientId}/merchants/{merchantId}:
    get:
      tags:
      - client-merchant-controller
      operationId: readMerchant
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: merchantId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MerchantDTO'
  /incentivio-client-domain/clients/all/stores:
    get:
      tags:
      - store-controller
      operationId: listStore
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAllStoresResponseDTO'
  /incentivio-client-domain/admins/adminsbyids:
    get:
      tags:
      - client-admin-controller
      operationId: listAdminUserByAdminId
      parameters:
      - name: adminids
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AdminsByIdsResponseDTO'
  /incentivio-client-domain/admin/stores:
    get:
      tags:
      - store-controller
      operationId: listStoresForAdmin
      parameters:
      - name: excludenames
        in: query
        required: false
        schema:
          type: boolean
          default: false
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAdminStoresResponseDTO'
  /incentivio-client-domain/admin/stores/overall:
    get:
      tags:
      - store-controller
      operationId: listStoresForAdminOverall
      parameters:
      - name: excludenames
        in: query
        required: false
        schema:
          type: boolean
          default: false
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAdminStoresResponseDTO'
  /incentivio-auto-tagger-service/segments/{segmentid}/reactivate:
    get:
      tags:
      - segment-controller
      operationId: reactivateSegment
      parameters:
      - name: segmentid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-auto-tagger-service/customer-segments/{customerId}:
    get:
      tags:
      - customer-segment-tag-controller
      operationId: findSegmentsByCustomer
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: activeOnly
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindCustomerSegmentsResponseDTO'
  /home:
    get:
      tags:
      - home-controller
      operationId: home
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /:
    get:
      tags:
      - home-controller
      operationId: home_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: home_3
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: home_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: home_4
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: home_7
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: home_6
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: home_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /customerappcontent:
    get:
      tags:
      - app-content-controller
      operationId: retrieveCustomerAppContent
      parameters:
      - name: userid
        in: query
        required: false
        schema:
          type: string
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: languagecode
        in: query
        required: false
        schema:
          type: string
      - name: loyalty
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppContentResponseDTO'
  /clients/{clientId}/executemenuimport:
    get:
      tags:
      - menu-import-controller
      operationId: executeMenuImport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: requestId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /chmlnsignature:
    get:
      tags:
      - secure-signature-controller
      operationId: generateSignature
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SignatureResponse'
  /incentivio-ordering-service/subitems/{subitemid}:
    delete:
      tags:
      - sub-item-controller
      operationId: deleteSubItems
      parameters:
      - name: subitemid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/items/{itemid}:
    delete:
      tags:
      - item-controller
      operationId: deleteItem
      parameters:
      - name: itemid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/groups/{groupid}:
    delete:
      tags:
      - group-controller
      operationId: deleteGroup
      parameters:
      - name: groupid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/catalogs/{catalogid}:
    delete:
      tags:
      - order-controller
      operationId: deleteCatalog
      parameters:
      - name: catalogid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-offers-domain/users/{userid}/offers/{offerid}/delete:
    delete:
      tags:
      - offer-distribution-controller
      operationId: markTheDistributedOfferAsDeleted
      parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 36
      - name: offerid
        in: path
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 36
      responses:
        '200':
          description: OK
  /incentivio-media/clients/{clientid}/media:
    delete:
      tags:
      - file-controller
      operationId: deleteFile
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: objectId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-giftcard-ach-service/achlocations/{locationId}/funding-source:
    delete:
      tags:
      - gift-card-ach-controller
      operationId: removeFundingSource
      parameters:
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      - name: removeFromAllLocation
        in: query
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /incentivio-giftcard-ach-service/achlocations/{locationId}/customer:
    delete:
      tags:
      - gift-card-ach-controller
      operationId: removeCustomer
      parameters:
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      - name: removeFromAllLocation
        in: query
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /incentivio-client-domain/clients/{clientid}/deleterole/{roleid}:
    delete:
      tags:
      - role-module-permission-controller
      operationId: deleteRole
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: roleid
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/app-home-config/preview/{userId}:
    delete:
      tags:
      - app-home-config-controller
      operationId: removePreview
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/background/default/staged:
    delete:
      tags:
      - app-home-config-controller
      operationId: discardStagedDefault
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /clients/{clientid}/merchants/{merchantid}/offers/{offerid}:
    delete:
      tags:
      - offers-controller
      operationId: deleteOffer
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: offerid
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
  /ml/**:
    get:
      tags:
      - ml-controller
      operationId: routeMLRequest
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
    put:
      tags:
      - ml-controller
      operationId: routeMLRequest_2
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
    post:
      tags:
      - ml-controller
      operationId: routeMLRequest_1
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
    delete:
      tags:
      - ml-controller
      operationId: routeMLRequest_3
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
    options:
      tags:
      - ml-controller
      operationId: routeMLRequest_6
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
    head:
      tags:
      - ml-controller
      operationId: routeMLRequest_5
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
    patch:
      tags:
      - ml-controller
      operationId: routeMLRequest_4
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
  /incentivio-user-domain/**:
    get:
      tags:
      - admin-controller
      operationId: userDomain
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: userDomain_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: userDomain_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: userDomain_3
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: userDomain_6
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: userDomain_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: userDomain_4
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-surveys/**:
    get:
      tags:
      - admin-controller
      operationId: surveyDomain
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: surveyDomain_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: surveyDomain_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: surveyDomain_3
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: surveyDomain_6
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: surveyDomain_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: surveyDomain_4
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-payments/**:
    get:
      tags:
      - payments-controller
      operationId: service
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    put:
      tags:
      - payments-controller
      operationId: service_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - payments-controller
      operationId: service_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - payments-controller
      operationId: service_3
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    options:
      tags:
      - payments-controller
      operationId: service_6
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    head:
      tags:
      - payments-controller
      operationId: service_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    patch:
      tags:
      - payments-controller
      operationId: service_4
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-offers-domain/**:
    get:
      tags:
      - admin-controller
      operationId: offersDomain
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: offersDomain_2
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: offersDomain_1
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: offersDomain_3
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: offersDomain_6
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: offersDomain_5
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: offersDomain_4
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
  /incentivio-loyalty-domain/**:
    get:
      tags:
      - admin-controller
      operationId: loyaltyDomain
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: loyaltyDomain_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: loyaltyDomain_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: loyaltyDomain_3
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: loyaltyDomain_6
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: loyaltyDomain_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: loyaltyDomain_4
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-connector-sms/**:
    get:
      tags:
      - admin-controller
      operationId: smsConnector
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: smsConnector_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: smsConnector_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: smsConnector_3
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: smsConnector_6
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: smsConnector_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: smsConnector_4
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-connect-domain/**:
    get:
      tags:
      - admin-controller
      operationId: connectDomain
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: connectDomain_2
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: connectDomain_1
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: connectDomain_3
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: connectDomain_6
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: connectDomain_5
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: connectDomain_4
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
  /incentivio-client-domain/clients/*/checkinqrimage:
    get:
      tags:
      - admin-controller
      operationId: clientDomainQRCodes
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
                format: byte
    put:
      tags:
      - admin-controller
      operationId: clientDomainQRCodes_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
                format: byte
    post:
      tags:
      - admin-controller
      operationId: clientDomainQRCodes_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
                format: byte
    delete:
      tags:
      - admin-controller
      operationId: clientDomainQRCodes_3
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
                format: byte
    options:
      tags:
      - admin-controller
      operationId: clientDomainQRCodes_6
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
                format: byte
    head:
      tags:
      - admin-controller
      operationId: clientDomainQRCodes_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
                format: byte
    patch:
      tags:
      - admin-controller
      operationId: clientDomainQRCodes_4
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
                format: byte
  /incentivio-client-domain/**:
    get:
      tags:
      - admin-controller
      operationId: clientDomain
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: clientDomain_2
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: clientDomain_1
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: clientDomain_3
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: clientDomain_6
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: clientDomain_5
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: clientDomain_4
      responses:
        '200':
          description: OK
          content:
            application/json;charset=utf-8:
              schema:
                type: string
  /incentivio-analytics-service/**:
    get:
      tags:
      - admin-controller
      operationId: analyticsService
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    put:
      tags:
      - admin-controller
      operationId: analyticsService_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - admin-controller
      operationId: analyticsService_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - admin-controller
      operationId: analyticsService_3
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    options:
      tags:
      - admin-controller
      operationId: analyticsService_6
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    head:
      tags:
      - admin-controller
      operationId: analyticsService_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    patch:
      tags:
      - admin-controller
      operationId: analyticsService_4
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
components:
  schemas:
    SuffixMode:
      type: string
      enum:
      - NONE
      - FIXED
      - VARIABLE
    ToastSettings:
      type: object
      properties:
        clientId:
          type: string
        suffix:
          type: string
        suffixMode:
          $ref: '#/components/schemas/SuffixMode'
    AdminPortalMetaDataRequest:
      type: object
      properties:
        deviceDetail:
          $ref: '#/components/schemas/DeviceDetailRequest'
        userDetail:
          $ref: '#/components/schemas/UserDetailRequest'
    DeleteRuleRequest:
      type: object
      properties:
        ruleId:
          type: string
        clientId:
          type: string
        metaData:
          $ref: '#/components/schemas/AdminPortalMetaDataRequest'
    DeviceDetailRequest:
      type: object
      properties:
        deviceIpAddress:
          type: string
        deviceType:
          type: string
        browserType:
          type: string
    UserDetailRequest:
      type: object
      properties:
        userId:
          type: string
        userName:
          type: string
        email:
          type: string
    DeleteRuleResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
    LocationDetailRequest:
      type: object
      properties:
        locationId:
          type: string
        locationName:
          type: string
        metaData:
          $ref: '#/components/schemas/AdminPortalMetaDataRequest'
        locationEnabled:
          type: boolean
    UpdateLocationRequest:
      type: object
      properties:
        clientId:
          type: string
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationDetailRequest'
    UpdateLocationResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        updatedLocationsCount:
          type: integer
          format: int32
    ItemCategoryChaingingRequest:
      type: object
      properties:
        clientId:
          type: string
        itemName:
          type: string
        category:
          type: string
        subCategory:
          type: string
        previousCategory:
          type: string
        previousSubCategory:
          type: string
        metaData:
          $ref: '#/components/schemas/AdminPortalMetaDataRequest'
    CategoryChangedItemResponse:
      type: object
      properties:
        clientId:
          type: string
        itemName:
          type: string
        category:
          type: string
        subCategory:
          type: string
        previousCategory:
          type: string
        previousSubCategory:
          type: string
    UpdateConfigurationRequest:
      type: object
      properties:
        clientId:
          type: string
        mainCount:
          type: integer
          format: int32
        sideCount:
          type: integer
          format: int32
        beverageCount:
          type: integer
          format: int32
        dessertCount:
          type: integer
          format: int32
        maxRuleRecommendations:
          type: integer
          format: int32
        maxRecommendations:
          type: integer
          format: int32
        metaData:
          $ref: '#/components/schemas/AdminPortalMetaDataRequest'
    UpdatedConfigurationResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        newSideCount:
          type: integer
          format: int32
        newBeverageCount:
          type: integer
          format: int32
        newDessertCount:
          type: integer
          format: int32
        newMaxRuleRecommendations:
          type: integer
          format: int32
        newMaxRecommendations:
          type: integer
          format: int32
    PutWalletConfigRequestDTO:
      type: object
      properties:
        tokenizeGatewayName:
          type: string
        walletGatewayName:
          type: string
    WalletConfigDTO:
      type: object
      properties:
        clientId:
          type: string
        tokenizeGatewayName:
          type: string
        walletGatewayName:
          type: string
    CustomerTagRequestDTO:
      type: object
      properties:
        title:
          type: string
          minLength: 1
        key:
          type: string
          minLength: 1
        description:
          type: string
        attributeType:
          type: string
          minLength: 1
        collectionValues:
          type: array
          items:
            type: string
        source:
          type: string
      required:
      - attributeType
      - key
      - title
    CreateSubItemRequestDTO:
      type: object
      properties:
        subItemId:
          type: string
        extSubItemId:
          type: string
        merchantId:
          type: string
          minLength: 1
        clientId:
          type: string
          minLength: 1
        name:
          type: string
        price:
          type: integer
          format: int32
        uom:
          type: string
        sku:
          type: string
        upc:
          type: string
        brandId:
          type: string
        categoryId:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        externalId:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
          uniqueItems: true
        status:
          type: string
        title:
          type: string
        label:
          type: string
      required:
      - clientId
      - merchantId
    DisplayInfo:
      type: object
      properties:
        langCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: array
          items:
            type: string
        mediumImage:
          type: array
          items:
            type: string
    CreateSubItemResponseDTO:
      type: object
      properties:
        subItemId:
          type: string
        label:
          type: string
    CreatePackageRequestDTO:
      type: object
      properties:
        packageId:
          type: string
        itemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        price:
          type: integer
          format: int32
        clientId:
          type: string
          minLength: 1
        merchantId:
          type: string
          minLength: 1
        discounts:
          type: array
          items:
            $ref: '#/components/schemas/DiscountDTO'
        storeIds:
          type: array
          items:
            type: string
        startDate:
          type: string
        endDate:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        externalId:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
          uniqueItems: true
        title:
          type: string
        status:
          type: string
      required:
      - clientId
      - merchantId
    DiscountDTO:
      type: object
      properties:
        discountId:
          type: string
        extDiscountId:
          type: string
        description:
          type: string
        discountType:
          $ref: '#/components/schemas/DiscountType'
        discountValueType:
          $ref: '#/components/schemas/DiscountValueType'
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        name:
          type: string
    DiscountType:
      type: string
      enum:
      - ITEM
      - ORDER
    DiscountValueType:
      type: string
      enum:
      - AMOUNT
      - PERCENTAGE
    CreatePackageResponseDTO:
      type: object
      properties:
        packageId:
          type: string
    UpdateAuditEventRequestDTO:
      type: object
      properties:
        resolved:
          type: boolean
        comment:
          type: string
    Address:
      type: object
      properties:
        street1:
          type: string
        street2:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
        lat:
          type: number
          format: double
        lon:
          type: number
          format: double
        aptSuite:
          type: string
    ChargeDTO:
      type: object
      properties:
        chargeId:
          type: string
        extChargeId:
          type: string
        chargeDescription:
          type: string
        chargeType:
          $ref: '#/components/schemas/ChargeType'
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        taxable:
          type: boolean
        gratuity:
          type: boolean
        delivery:
          type: boolean
        orderApplied:
          type: integer
          format: int32
    ChargeType:
      type: string
      enum:
      - OPEN
      - AMOUNT
      - PERCENTAGE
    ExternalDeliveryFeeStrategy:
      type: string
      enum:
      - ADD
      - IGNORE
    ExternalDeliverySettings:
      type: object
      properties:
        deliveryStrategy:
          type: string
        externalDeliveryFeeStrategy:
          $ref: '#/components/schemas/ExternalDeliveryFeeStrategy'
        externalDeliveryChargeId:
          type: string
        pickupBusinessName:
          type: string
        pickupAddress:
          $ref: '#/components/schemas/Address'
        pickupInstructions:
          type: string
        contactPhone:
          type: string
    IDGenerationStrategy:
      type: string
      enum:
      - UUID
      - AUTO_INCREMENT
    OrderProcessingConfigDTO:
      type: object
      properties:
        orderProcessingStrategy:
          $ref: '#/components/schemas/OrderProcessingStrategy'
        paymentIDGenerationStrategy:
          $ref: '#/components/schemas/IDGenerationStrategy'
        paymentGatewayName:
          type: string
        orderGatewayName:
          type: string
        externalDeliverySettings:
          $ref: '#/components/schemas/ExternalDeliverySettings'
        roundingMode:
          $ref: '#/components/schemas/RoundingMode'
        calculationStrategy:
          $ref: '#/components/schemas/TotalCalculationStrategy'
        consolidateMultipleDiscounts:
          type: boolean
        realTimeLoyaltyProcessing:
          type: boolean
    OrderProcessingStrategy:
      type: string
      enum:
      - ONE_STEP
      - TWO_STEP
      - INCENTIVIO_ORDER
      - INC_PAYMENTS
    PaymentGatewayConfig:
      type: object
      properties:
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
    RoundingMode:
      type: string
      enum:
      - HALF_EVEN
      - HALF_UP
      - TRUNCATE
    TaxDTO:
      type: object
      properties:
        taxId:
          type: string
        extTaxId:
          type: string
        taxDescription:
          type: string
        taxType:
          $ref: '#/components/schemas/ChargeType'
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
    TotalCalculationStrategy:
      type: string
      enum:
      - TOAST
      - SILVERWARE
      - NCC
      - LIGHTSPEED
      - EXTERNAL
    UpdateMerchantRequestDTO:
      type: object
      properties:
        clientId:
          type: string
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxDTO'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDTO'
        orderProcessingConfig:
          $ref: '#/components/schemas/OrderProcessingConfigDTO'
        paymentGatewayConfig:
          $ref: '#/components/schemas/PaymentGatewayConfig'
        pickupOrderProcessingTime:
          type: integer
          format: int64
        deliveryOrderProcessingTime:
          type: integer
          format: int64
        timeZone:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
    UpdateMerchantResponseDTO:
      type: object
      properties:
        merchantId:
          type: string
        clientId:
          type: string
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxDTO'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDTO'
        orderProcessingConfig:
          $ref: '#/components/schemas/OrderProcessingConfigDTO'
        pickupOrderProcessingTime:
          type: integer
          format: int64
        deliveryOrderProcessingTime:
          type: integer
          format: int64
        timeZone:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
    ChargeDeliveryTier:
      type: object
      properties:
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        extChargeId:
          type: string
        minDistance:
          type: number
          format: float
    ChargeRule:
      type: object
      properties:
        amount:
          type: integer
          format: int32
        operator:
          $ref: '#/components/schemas/Operator'
    DayOfWeek:
      type: string
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
    DeliveryArea:
      type: object
      properties:
        deliveryAreaType:
          $ref: '#/components/schemas/DeliveryAreaType'
        deliveryAreaPolygon:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryPoint'
    DeliveryAreaType:
      type: string
      enum:
      - CIRCLE
      - POLYGON
    DeliveryPoint:
      type: object
      properties:
        latitude:
          type: number
          format: float
        longitude:
          type: number
          format: float
      required:
      - latitude
      - longitude
    DynamicDeliveryCharge:
      type: object
      properties:
        chargeId:
          type: string
        dynamicDelivery:
          type: boolean
        extChargeId:
          type: string
        chargeName:
          type: string
        chargeDescription:
          type: string
        chargeType:
          $ref: '#/components/schemas/ChargeType'
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        taxable:
          type: boolean
        gratuity:
          type: boolean
        delivery:
          type: boolean
        orderApplied:
          type: integer
          format: int32
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extTaxId:
          type: string
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/Tax'
        applicableEntity:
          $ref: '#/components/schemas/OrderEntity'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ChargeRule'
        chargeApplied:
          type: integer
          format: int32
        chargeTiers:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDeliveryTier'
    ImportTypeDTO:
      type: string
      enum:
      - SHARED_MENU_IMPORT
      - INDEPENDANT_MENU_IMPORT
    KitchenThrottleConfigDTO:
      type: object
      properties:
        countDefault:
          type: integer
          format: int32
        valueDefault:
          type: integer
          format: int32
        displayInfo:
          type: object
          additionalProperties:
            type: string
        timeslots:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/KitchenThrottleSetting'
    KitchenThrottleSetting:
      type: object
      properties:
        count:
          type: integer
          format: int32
        value:
          type: integer
          format: int32
        throttlingEnabled:
          type: boolean
    MenuImportConfig:
      type: object
      properties:
        connectorGatewayName:
          type: string
        extStoreId:
          type: string
        defaultLanguage:
          type: string
        connectorName:
          type: string
        overrideExistingImages:
          type: boolean
        importType:
          $ref: '#/components/schemas/ImportTypeDTO'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
    MenuOverride:
      type: object
      properties:
        catalogId:
          type: string
        groupId:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
          uniqueItems: true
        override:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/TimeSlot'
            uniqueItems: true
    Operator:
      type: string
      enum:
      - EQ
      - LT
      - LTEQ
      - GT
      - GTE
    OrderEntity:
      type: string
      enum:
      - ORDER
      - ITEM
    OrderOptions:
      type: object
      properties:
        optionName:
          type: string
        displayRank:
          type: integer
          format: int32
        enableInformationField:
          type: boolean
        makeInformationFieldMandatory:
          type: boolean
        enableInstructions:
          type: boolean
        enableImHere:
          type: boolean
        channelsForOrderReceivedNotification:
          type: array
          items:
            type: string
          uniqueItems: true
        channelsForOrderCompleteNotification:
          type: array
          items:
            type: string
          uniqueItems: true
        displayMessage:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptionsDisplayInfo'
    OrderOptionsDisplayInfo:
      type: object
      properties:
        langCode:
          type: string
        title:
          type: string
        informationField:
          type: string
        imHereResponseMessage:
          type: string
        errorMessageIfInformationFieldIsEmpty:
          type: string
        instructions:
          type: string
        orderConfirmationMessage:
          type: string
        orderClosedMessage:
          type: string
        smsOrderConfirmationMessage:
          type: string
        smsOrderClosedMessage:
          type: string
    OrderThrottleConfig:
      type: object
      properties:
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
          uniqueItems: true
        throttleSettings:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ThrottleSettingSlot'
            uniqueItems: true
    OrderType:
      type: string
      enum:
      - DELIVERY
      - PICKUP
    OrderValueDisplayInfoDTO:
      type: object
      properties:
        langCode:
          type: string
        shortMessage:
          type: string
        longMessage:
          type: string
    OrderValueLimits:
      type: object
      properties:
        minOrderValue:
          type: number
          format: double
        maxOrderValue:
          type: number
          format: double
        displayMessage:
          type: array
          items:
            $ref: '#/components/schemas/OrderValueDisplayInfoDTO'
    PaymentConfig:
      type: object
      properties:
        orderType:
          $ref: '#/components/schemas/OrderType'
        paymentModes:
          type: array
          items:
            $ref: '#/components/schemas/PaymentMode'
        placePOSOrdersAsOpen:
          type: boolean
        guestCheckoutSupported:
          type: boolean
    PaymentMode:
      type: string
      enum:
      - PAYMENT_MANDATORY
      - PAYMENT_OPTIONAL
      - NO_PAYMENT
    Tax:
      type: object
      properties:
        taxId:
          type: string
        extTaxId:
          type: string
        taxDescription:
          type: string
        taxType:
          $ref: '#/components/schemas/ChargeType'
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        applicableEntity:
          $ref: '#/components/schemas/OrderEntity'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ChargeRule'
    TemporaryHours:
      type: object
      properties:
        startDate:
          type: string
        endDate:
          type: string
        sameHoursPerDate:
          $ref: '#/components/schemas/WorkingHours'
        diffHoursPerDate:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/WorkingHours'
      required:
      - endDate
      - startDate
    ThrottleSetting:
      type: object
      properties:
        orderAmount:
          type: integer
          format: int32
        processingTime:
          type: integer
          format: int32
        displayMessage:
          type: object
          additionalProperties:
            type: string
    ThrottleSettingSlot:
      type: object
      properties:
        timeSlot:
          $ref: '#/components/schemas/TimeSlot'
        throttleSettings:
          type: array
          items:
            $ref: '#/components/schemas/ThrottleSetting'
          uniqueItems: true
    TimeSlot:
      type: object
      properties:
        startTime:
          type: string
        endTime:
          type: string
      required:
      - endTime
      - startTime
    UpdateLocationRequestDTO:
      type: object
      properties:
        catalogOverrides:
          type: array
          items:
            $ref: '#/components/schemas/MenuOverride'
          uniqueItems: true
        catering:
          type: boolean
        charges:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDTO'
        clientId:
          type: string
        countryCode:
          type: string
        currencyCode:
          type: string
        deliveryArea:
          $ref: '#/components/schemas/DeliveryArea'
        deliveryAsapSupported:
          type: boolean
        deliveryAvailabilityInterval:
          type: integer
          format: int32
        deliveryMaxDaysOut:
          type: integer
          format: int32
        deliveryOffDays:
          type: array
          items:
            type: string
        deliveryOrderHours:
          type: array
          items:
            $ref: '#/components/schemas/WorkingHours'
          uniqueItems: true
        deliveryOrderNoticePeriod:
          type: integer
          format: int64
        deliveryOrderOptions:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptions'
          uniqueItems: true
        deliveryOrderProcessingTime:
          type: integer
          format: int64
        deliveryOrdersAccepted:
          type: boolean
        deliveryOrderValueLimits:
          $ref: '#/components/schemas/OrderValueLimits'
        deliveryRadius:
          type: number
          format: double
        deliverySevenPlusDaysOrdering:
          type: boolean
        deliveryTemporaryHours:
          type: array
          items:
            $ref: '#/components/schemas/TemporaryHours'
        disableTipping:
          type: boolean
        dynamicDeliveryCharge:
          $ref: '#/components/schemas/DynamicDeliveryCharge'
        enableFulFillTextForToast:
          type: boolean
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        externalOrderingEnabled:
          type: boolean
        externalOrderingText:
          type: string
        extPosLocationId:
          type: string
        failureNotificationRecipientEmailList:
          type: array
          items:
            type: string
          uniqueItems: true
        fulFillTextForToast:
          type: string
        groupOverrides:
          type: array
          items:
            $ref: '#/components/schemas/MenuOverride'
          uniqueItems: true
        kitchenThrottleConfig:
          $ref: '#/components/schemas/KitchenThrottleConfigDTO'
        latitude:
          type: number
          format: double
        locationName:
          type: string
        longitude:
          type: number
          format: double
        menuImportConfig:
          $ref: '#/components/schemas/MenuImportConfig'
        merchantId:
          type: string
        orderNotificationRecipientEmailList:
          type: array
          items:
            type: string
          uniqueItems: true
        orderProcessingConfig:
          $ref: '#/components/schemas/OrderProcessingConfigDTO'
        orderThrottleConfig:
          type: array
          items:
            $ref: '#/components/schemas/OrderThrottleConfig'
          uniqueItems: true
        paymentConfigs:
          type: array
          items:
            $ref: '#/components/schemas/PaymentConfig'
        paymentGatewayConfig:
          $ref: '#/components/schemas/PaymentGatewayConfig'
        pickupAsapSupported:
          type: boolean
        pickupAvailabilityInterval:
          type: integer
          format: int32
        pickupMaxDaysOut:
          type: integer
          format: int32
        pickupOffDays:
          type: array
          items:
            type: string
        pickupOrderHours:
          type: array
          items:
            $ref: '#/components/schemas/WorkingHours'
          uniqueItems: true
        pickupOrderNoticePeriod:
          type: integer
          format: int64
        pickupOrderOptions:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptions'
          uniqueItems: true
        pickupOrderProcessingTime:
          type: integer
          format: int64
        pickupOrdersAccepted:
          type: boolean
        pickupOrderValueLimits:
          $ref: '#/components/schemas/OrderValueLimits'
        pickupSevenPlusDaysOrdering:
          type: boolean
        pickupTemporaryHours:
          type: array
          items:
            $ref: '#/components/schemas/TemporaryHours'
        primaryLocation:
          type: boolean
        primaryLocationId:
          type: string
        qalocation:
          type: boolean
        showDeliveryTimeSlots:
          type: boolean
        showPickupTimeSlots:
          type: boolean
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxDTO'
        test:
          type: boolean
        timeZone:
          type: string
    WorkingHours:
      type: object
      properties:
        dayOfWeek:
          $ref: '#/components/schemas/DayOfWeek'
        startTime:
          type: string
        endTime:
          type: string
        timeSlots:
          type: array
          items:
            $ref: '#/components/schemas/TimeSlot'
      required:
      - dayOfWeek
      - endTime
      - startTime
      - timeSlots
    CreateItemRequestDTO:
      type: object
      properties:
        clientId:
          type: string
          minLength: 1
        merchantId:
          type: string
          minLength: 1
        externalId:
          type: string
        title:
          type: string
          minLength: 1
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        itemId:
          type: string
        price:
          type: integer
          format: int32
        unformattedPrice:
          type: number
        unformattedPriceWithTax:
          type: number
        sku:
          type: string
        upc:
          type: string
        discounts:
          type: array
          items:
            $ref: '#/components/schemas/DiscountDTO'
        uom:
          type: string
        brandId:
          type: string
        categoryId:
          type: string
        optionGroups:
          type: array
          items:
            type: string
          uniqueItems: true
        optionGroupSettings:
          type: array
          items:
            $ref: '#/components/schemas/OptionGroupSettingDTO'
          uniqueItems: true
        maxItemSelections:
          type: integer
          format: int32
        maxQuantity:
          type: integer
          format: int32
        minQuantity:
          type: integer
          format: int32
        inheritParentOptions:
          type: boolean
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxInfoDTO'
        orderingChannels:
          type: array
          items:
            $ref: '#/components/schemas/OrderingChannels'
        itemType:
          $ref: '#/components/schemas/ItemType'
        invertParentTaxable:
          type: boolean
        outOfStock:
          type: boolean
        outOfStockToday:
          type: boolean
        taxable:
          type: boolean
      required:
      - clientId
      - merchantId
      - price
      - title
    ItemType:
      type: string
      enum:
      - MAIN
      - MODIFIER
    OptionGroupSettingDTO:
      type: object
      properties:
        optionGroupId:
          type: string
        displayRank:
          type: integer
          format: int32
        inheritGroupSettings:
          type: boolean
        defaultSelectedItemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        mandatoryItemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        selectionMandatory:
          type: boolean
        selectionType:
          $ref: '#/components/schemas/SelectionType'
        maxItemSelections:
          type: integer
          format: int32
        minItemSelections:
          type: integer
          format: int32
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
    OrderTypeDTO:
      type: string
      enum:
      - DELIVERY
      - PICKUP
    OrderingChannels:
      type: string
      enum:
      - MOBILE
      - FACEBOOK
      - NONE
    SelectionType:
      type: string
      enum:
      - MULTI_SELECT
      - SINGLE_SELECT
    TaxInfoDTO:
      type: object
      properties:
        id:
          type: string
        extTaxId:
          type: string
        taxDescription:
          type: string
        taxType:
          $ref: '#/components/schemas/TaxTypeDTO'
        amount:
          type: number
          format: double
        percentage:
          type: number
          format: double
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderTypeDTO'
    TaxTypeDTO:
      type: string
      enum:
      - OPEN
      - AMOUNT
      - PERCENTAGE
    CreateItemResponseDTO:
      type: object
      properties:
        itemId:
          type: string
    CreateGroupRequestDTO:
      type: object
      properties:
        clientId:
          type: string
          minLength: 1
        merchantId:
          type: string
          minLength: 1
        externalId:
          type: string
        title:
          type: string
          minLength: 1
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        groupId:
          type: string
        groupType:
          $ref: '#/components/schemas/GroupType'
        itemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        groupItemSettings:
          type: array
          items:
            $ref: '#/components/schemas/GroupItemSetting'
          uniqueItems: true
        defaultSelectedItemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        mandatoryItemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        optionGroups:
          type: array
          items:
            type: string
          uniqueItems: true
        subGroups:
          type: array
          items:
            type: string
          uniqueItems: true
        selectionMandatory:
          type: boolean
        selectionType:
          $ref: '#/components/schemas/SelectionType'
        inheritParentOptions:
          type: boolean
        maxItemSelections:
          type: integer
          format: int32
        minItemSelections:
          type: integer
          format: int32
      required:
      - clientId
      - merchantId
      - title
    GroupItemSetting:
      type: object
      properties:
        itemId:
          type: string
        itemGuid:
          type: string
        maxItemSelections:
          type: integer
          format: int32
        price:
          type: integer
          format: int32
        isDefault:
          type: boolean
        displayRank:
          type: integer
          format: int32
    GroupType:
      type: string
      enum:
      - OPTION_GROUP
      - CATALOG_GROUP
    CreateGroupResponseDTO:
      type: object
      properties:
        groupId:
          type: string
    AddOrderItemReqDTO:
      type: object
      properties:
        itemId:
          type: string
          minLength: 1
        quantity:
          type: integer
          format: int32
        note:
          type: string
        groupId:
          type: string
        discountIds:
          type: array
          items:
            type: string
        externalId:
          type: string
        itemInstructions:
          type: string
        catalogId:
          type: string
      required:
      - groupId
      - itemId
      - quantity
    Charge:
      type: object
      properties:
        chargeId:
          type: string
        chargeName:
          type: string
        chargeDescription:
          type: string
        chargeType:
          $ref: '#/components/schemas/ChargeType'
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        taxable:
          type: boolean
        gratuity:
          type: boolean
        delivery:
          type: boolean
        orderApplied:
          type: integer
          format: int32
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/Tax'
    DateSelectionMode:
      type: string
      enum:
      - FIXED
      - TODAY
      - USER_SELECT
    DeliveryInfo:
      type: object
      properties:
        deliveryAddress:
          $ref: '#/components/schemas/Address'
        deliveryInstructions:
          type: string
    ItemValidationMode:
      type: string
      enum:
      - NONE
      - BASE_ITEM
      - BASE_WITH_MODIFIERS
    OrderConfigDisplayInfo:
      type: object
      properties:
        languageCode:
          type: string
        description:
          type: string
        notEnoughPrepTimeErrorMessage:
          type: string
    OrderRestrictionType:
      type: string
      enum:
      - RESTRICTED_ORDER
      - REGULAR_ORDER
    TimeSelectionMode:
      type: string
      enum:
      - ASAP
      - FIXED
      - USER_SELECT
    UpdatePresetOrderConfigRequestDTO:
      type: object
      properties:
        code:
          type: string
        locationId:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/OrderConfigDisplayInfo'
          uniqueItems: true
        orderType:
          $ref: '#/components/schemas/OrderType'
        restrictionType:
          $ref: '#/components/schemas/OrderRestrictionType'
        dateSelectionMode:
          $ref: '#/components/schemas/DateSelectionMode'
        timeSelectionMode:
          $ref: '#/components/schemas/TimeSelectionMode'
        itemValidationMode:
          $ref: '#/components/schemas/ItemValidationMode'
        inheritChargesFromLocation:
          type: boolean
        displayPresetValueConfirmationPage:
          type: boolean
        deliveryInfo:
          $ref: '#/components/schemas/DeliveryInfo'
        requestedFulfillDate:
          type: string
          format: date
        requestedFulfillTime:
          type: string
        charges:
          type: array
          items:
            $ref: '#/components/schemas/Charge'
        items:
          type: array
          items:
            $ref: '#/components/schemas/AddOrderItemReqDTO'
        orderInstructions:
          type: string
      required:
      - code
    GetPresetOrderConfigResponseDTO:
      type: object
      properties:
        id:
          type: string
        code:
          type: string
        clientId:
          type: string
        locationId:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/OrderConfigDisplayInfo'
          uniqueItems: true
        orderType:
          $ref: '#/components/schemas/OrderType'
        restrictionType:
          $ref: '#/components/schemas/OrderRestrictionType'
        dateSelectionMode:
          $ref: '#/components/schemas/DateSelectionMode'
        timeSelectionMode:
          $ref: '#/components/schemas/TimeSelectionMode'
        itemValidationMode:
          $ref: '#/components/schemas/ItemValidationMode'
        inheritChargesFromLocation:
          type: boolean
        displayPresetValueConfirmationPage:
          type: boolean
        deliveryInfo:
          $ref: '#/components/schemas/DeliveryInfo'
        requestedFulfillDate:
          type: string
          format: date
        requestedFulfillTime:
          type: string
        charges:
          type: array
          items:
            $ref: '#/components/schemas/Charge'
        items:
          type: array
          items:
            $ref: '#/components/schemas/AddOrderItemReqDTO'
        orderInstructions:
          type: string
    CreateCatalogRequestDTO:
      type: object
      properties:
        clientId:
          type: string
          minLength: 1
        merchantId:
          type: string
          minLength: 1
        externalId:
          type: string
        title:
          type: string
          minLength: 1
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        catalogId:
          type: string
        groupIds:
          type: array
          items:
            type: string
          uniqueItems: true
      required:
      - clientId
      - merchantId
      - title
    CreateCatalogResponseDTO:
      type: object
      properties:
        catalogId:
          type: string
    BulkImageUploadStatus:
      type: string
      enum:
      - COMPLETE
      - ERROR
      - PROCESSING
      - UPLOADED
      - UPLOADING
    BulkImageUploadUpdateRequest:
      type: object
      properties:
        id:
          type: string
        processedFiles:
          type: array
          items:
            $ref: '#/components/schemas/ImageFile'
        status:
          $ref: '#/components/schemas/BulkImageUploadStatus'
        statusMessage:
          type: string
      required:
      - processedFiles
      - status
    ImageFile:
      type: object
      properties:
        filename:
          type: string
        matches:
          type: array
          items:
            $ref: '#/components/schemas/ImageFileMatch'
        status:
          $ref: '#/components/schemas/ImageFileStatus'
        statusMessage:
          type: string
        url:
          type: string
      required:
      - filename
      - status
    ImageFileMatch:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
      required:
      - id
      - title
    ImageFileStatus:
      type: string
      enum:
      - ERROR
      - PROCESSED
      - QUEUED
      - UPLOADED
    UpdateFundingAccountRequest:
      type: object
      properties:
        id:
          type: string
        externalId:
          type: string
        externalUrl:
          type: string
    ClientEmailTemplateType:
      type: string
      enum:
      - OFFER
      - LOYALTY_OFFER
      - MESSAGE
      - EVENT
    EventType:
      type: string
      enum:
      - VERIFY_EMAIL
      - USER_PASSWORD_RESET
      - TABLET_APP_MESSAGES
      - ADMIN_PASSWORD_RESET
      - POINTS_EXPIRY_NOTIFICATION
      - GIFT_CARD_FAILED
      - COMP_GIFT_CARD_FAILED
      - ORDER_FAILURE_NOTIFIER
      - GIFT_CARD_EMAIL_RECEIPT
      - GIFTCARD_PURCHASE
      - GIFTCARD_IMPORT_FAILED
      - GIFTCARD_IMPORT_SUCCESS
      - GIFTCARD_REMOVAL_FAILED
      - GIFTCARD_REMOVAL_SUCCESS
      - EMAIL_GIFTCARD_PURCHASE_RECEIPT
      - EMAIL_GIFTCARD_ADD_VALUE_RECEIPT
      - EMAIL_GIFTCARD_BALANCE_REPORT_EXPORT_SUCCESS
      - EMAIL_GIFTCARD_BALANCE_REPORT_EXPORT_FAILED
      - EMAIL_GIFTCARD_ADD_VALUE
      - EMAIL_GIFTCARD_PURCHASE_FOR_SENDER
      - GIFTCARD_REFUND_RECEIPT_NOTIFICATION
      - GIFT_ACH_TRANSFER_INIT_FAILED
      - ORDER_RECEIVED_NOTIFICATION
      - ORDER_CUSTOMER_NOTIFICATION
      - GUEST_CHECKOUT_VERIFICATION
      - PASSWORDLESS_AUTH
    UpdateClientTemplateRequestDTO:
      type: object
      properties:
        name:
          type: string
        jsonTemplate:
          type: string
        htmlTemplate:
          type: string
        fromAddress:
          type: string
        bcc:
          type: string
        subject:
          type: string
        eventType:
          $ref: '#/components/schemas/EventType'
        emailTemplateType:
          $ref: '#/components/schemas/ClientEmailTemplateType'
        reusable:
          type: boolean
    ClientTemplate:
      type: object
      properties:
        templateId:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        name:
          type: string
        jsonTemplate:
          type: string
        htmlTemplate:
          type: string
        fromAddress:
          type: string
        bcc:
          type: string
        subject:
          type: string
        eventType:
          $ref: '#/components/schemas/EventType'
        createdDate:
          type: string
          format: date-time
        emailTemplateType:
          $ref: '#/components/schemas/ClientEmailTemplateType'
        reusable:
          type: boolean
    ModuleDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        description:
          type: string
        order:
          type: integer
          format: int32
        roleModulePermissions:
          type: array
          items:
            $ref: '#/components/schemas/PermissionDTO'
        allPermissions:
          type: array
          items:
            $ref: '#/components/schemas/PermissionDTO'
        active:
          type: boolean
        deleted:
          type: boolean
    PermissionDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        permission:
          type: string
        description:
          type: string
        moduleID:
          type: integer
          format: int64
        active:
          type: boolean
        deleted:
          type: boolean
    UpdateRoleRequestDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        role:
          type: string
        description:
          type: string
        modules:
          type: array
          items:
            $ref: '#/components/schemas/ModuleDTO'
        active:
          type: boolean
        deleted:
          type: boolean
      required:
      - id
    AddressDTO:
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        postalCode:
          type: string
        region:
          type: string
        streetAddress1:
          type: string
        streetAddress2:
          type: string
    StoreDisplayInfo:
      type: object
      properties:
        languageCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
    UpdateStoreRequestDTO:
      type: object
      properties:
        title:
          type: string
        address:
          $ref: '#/components/schemas/AddressDTO'
        phoneNumber:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        regionId:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        storeType:
          type: string
        beaconId:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/StoreDisplayInfo'
          uniqueItems: true
        isCatering:
          type: boolean
        isMenuBrowsing:
          type: boolean
        viewOnlyLocationEnabled:
          type: boolean
        isTest:
          type: boolean
        regionEmpty:
          type: boolean
    PreviewRequestDTO:
      type: object
      properties:
        userId:
          type: string
        type:
          type: string
        scheduleId:
          type: string
      required:
      - type
      - userId
    AppHomeConfigDTO:
      type: object
      properties:
        clientId:
          type: string
        version:
          type: integer
          format: int32
        background:
          $ref: '#/components/schemas/HomeBackgroundDTO'
        blocks:
          type: array
          items: {}
        previewScheduleId:
          type: string
        previewType:
          type: string
        hasStagedDefault:
          type: boolean
    BackgroundPreviewDTO:
      type: object
      properties:
        type:
          type: string
        scheduleId:
          type: string
    BackgroundScheduleDTO:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        imageUrlAndroid:
          type: string
        imageUrlIos:
          type: string
        videoUrlAndroid:
          type: string
        videoUrlIos:
          type: string
        videoImageUrl:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        startTime:
          type: string
        endTime:
          type: string
        daysOfWeek:
          type: array
          items:
            type: string
        enabled:
          type: boolean
    HomeBackgroundDTO:
      type: object
      properties:
        defaultImageUrlAndroid:
          type: string
        defaultImageUrlIos:
          type: string
        defaultVideoUrlAndroid:
          type: string
        defaultVideoUrlIos:
          type: string
        defaultVideoImageUrl:
          type: string
        schedules:
          type: array
          items:
            $ref: '#/components/schemas/BackgroundScheduleDTO'
        stagedDefaultImageUrlAndroid:
          type: string
        stagedDefaultImageUrlIos:
          type: string
        stagedDefaultVideoUrlAndroid:
          type: string
        stagedDefaultVideoUrlIos:
          type: string
        stagedDefaultVideoImageUrl:
          type: string
        previewUsers:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/BackgroundPreviewDTO'
    BackgroundScheduleRequestDTO:
      type: object
      properties:
        label:
          type: string
        imageUrlAndroid:
          type: string
        imageUrlIos:
          type: string
        videoUrlAndroid:
          type: string
        videoUrlIos:
          type: string
        videoImageUrl:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        startTime:
          type: string
        endTime:
          type: string
        daysOfWeek:
          type: array
          items:
            type: string
        enabled:
          type: boolean
      required:
      - enabled
      - endDate
      - endTime
      - startDate
      - startTime
    DefaultBackgroundRequestDTO:
      type: object
      properties:
        imageUrlAndroid:
          type: string
        imageUrlIos:
          type: string
        videoUrlAndroid:
          type: string
        videoUrlIos:
          type: string
        videoImageUrl:
          type: string
    AdminAccountAuthorization:
      type: object
      properties:
        dateCreated:
          type: string
          format: date-time
        dateUpdated:
          type: string
          format: date-time
        all:
          type: boolean
        clientIdRoleIds:
          type: object
          additionalProperties:
            type: integer
            format: int64
        clients:
          type: array
          items:
            $ref: '#/components/schemas/ClientAuthorization'
          uniqueItems: true
        email:
          type: string
        locationIdClientIds:
          type: object
          additionalProperties:
            type: string
      required:
      - all
      - clientIdRoleIds
      - clients
      - dateCreated
      - dateUpdated
      - email
      - locationIdClientIds
    AdminUserType:
      type: string
      enum:
      - MARKETING
      - OPERATIONS
    ClientAuthorization:
      type: object
      properties:
        all:
          type: boolean
        id:
          type: string
        merchants:
          type: array
          items:
            $ref: '#/components/schemas/MerchantAuthorization'
          uniqueItems: true
      required:
      - all
      - id
      - merchants
    LocationAuthorization:
      type: object
      properties:
        id:
          type: string
      required:
      - id
    MerchantAuthorization:
      type: object
      properties:
        all:
          type: boolean
        id:
          type: string
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationAuthorization'
          uniqueItems: true
      required:
      - all
      - id
      - locations
    SaveAdminUserRequestDto:
      type: object
      properties:
        adminAccountAuthorization:
          $ref: '#/components/schemas/AdminAccountAuthorization'
        email:
          type: string
        firstName:
          type: string
        id:
          type: string
        lastName:
          type: string
        merchantId:
          type: string
        password:
          type: string
        reach:
          type: string
        storeIds:
          type: array
          items:
            type: string
        type:
          $ref: '#/components/schemas/AdminUserType'
        userRoleId:
          type: string
      required:
      - email
    EmailHandler:
      type: string
      enum:
      - AWS
      - SENDGRID
    EmailSettingsCreateRequestDTO:
      type: object
      properties:
        emailHandler:
          $ref: '#/components/schemas/EmailHandler'
        externalDomainId:
          type: string
        fromEmail:
          type: string
        fromEmailedName:
          type: string
        replyTo:
          type: string
        replyToName:
          type: string
      required:
      - emailHandler
    DomainAuthenticateDnsResDto:
      type: object
      properties:
        valid:
          type: string
        type:
          type: string
        host:
          type: string
        data:
          type: string
    DomainBasicInfoResponseDTO:
      type: object
      properties:
        id:
          type: string
        externalId:
          type: string
        subdomain:
          type: string
        domain:
          type: string
        username:
          type: string
        valid:
          type: boolean
        clientSpecific:
          type: boolean
        dns:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DomainAuthenticateDnsResDto'
        active:
          type: boolean
    EmailSettingBasicInfoResponseDTO:
      type: object
      properties:
        emailHandler:
          $ref: '#/components/schemas/EmailHandler'
        clientId:
          type: string
        activeDomainId:
          type: string
        activeDomainName:
          type: string
        fromEmail:
          type: string
        fromEmailedName:
          type: string
        replyTo:
          type: string
        replyToName:
          type: string
        clientSendgridApiKey:
          type: string
        subUserId:
          type: string
        subUserName:
          type: string
        domains:
          type: array
          items:
            $ref: '#/components/schemas/DomainBasicInfoResponseDTO'
    DaysOfWeekEnum:
      type: string
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
    ExpressionValueNew:
      type: object
      properties:
        attributeName:
          type: string
        attributeTitle:
          type: string
        attributeValues: {}
        dataType:
          type: string
        productList:
          type: array
          items:
            $ref: '#/components/schemas/ProductDTO'
          uniqueItems: true
        subCategory:
          $ref: '#/components/schemas/SubCategoryEnum'
        relationalOperator:
          $ref: '#/components/schemas/RelationalOperatorEnum'
        quantity:
          type: string
        noOfDays:
          type: integer
          format: int32
        noOfOrders:
          type: integer
          format: int32
        startTime:
          type: string
        endTime:
          type: string
        daysOfWeek:
          type: array
          items:
            $ref: '#/components/schemas/DaysOfWeekEnum'
    LogicTypeEnum:
      type: string
      enum:
      - AND
      - OR
      - NOT
    OperatorEnum:
      type: string
      enum:
      - EQ
      - LT
      - GT
      - LT_EQ
      - GT_EQ
      - NOT
      - WITHIN
      - NOTEXISTS
    ProductDTO:
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        externalId:
          type: string
        displayInfoTitlesList:
          type: array
          items:
            type: string
    RelationalOperatorEnum:
      type: string
      enum:
      - EQ
      - LT
      - GT
      - LT_EQ
      - GT_EQ
      - NOT
      - WITHIN
      - NOTEXISTS
    RuleDescriptor:
      type: object
      properties:
        ruleType:
          $ref: '#/components/schemas/RuleTypeEnum'
        operator:
          $ref: '#/components/schemas/OperatorEnum'
        expressionValue:
          type: string
        expressionValueNew:
          $ref: '#/components/schemas/ExpressionValueNew'
        expressionName:
          type: string
        expressoinFormat:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        logicType:
          $ref: '#/components/schemas/LogicTypeEnum'
        childNodes:
          type: array
          items:
            $ref: '#/components/schemas/RuleDescriptor'
    RuleTypeEnum:
      type: string
      enum:
      - EXPRESSION
      - LOGIC
    SegmentRequestDTO:
      type: object
      properties:
        segmentName:
          type: string
        segmentDescription:
          type: string
        segmentType:
          $ref: '#/components/schemas/SegmentTypeEnum'
        segmentTag:
          type: string
        segmentIcon:
          type: string
        visibleToCustomer:
          type: boolean
        languageCode:
          type: string
        segmentRules:
          $ref: '#/components/schemas/RuleDescriptor'
        adminId:
          type: string
        adminEmail:
          type: string
        startDate:
          type: string
          format: date-time
        createdDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        lastProcessedDate:
          type: string
          format: date-time
        timeZone:
          type: string
        expiredStatus:
          type: boolean
        deletedStatus:
          type: boolean
        segmentDistribution:
          type: string
        advancedSettings:
          type: object
          additionalProperties: {}
      required:
      - adminEmail
      - adminId
      - segmentName
      - segmentRules
      - segmentType
      - startDate
      - timeZone
    SegmentTypeEnum:
      type: string
      enum:
      - LOYALTY
      - NORMAL
    SubCategoryEnum:
      type: string
      enum:
      - LIFETIME
      - LAST_NO_OF_DAYS
      - NO_OF_ORDERS
    APNSetting:
      type: object
      properties:
        keyId:
          type: string
        teamId:
          type: string
        bundleId:
          type: string
        signingKeyFile:
          type: string
        environment:
          type: string
        androidPnApiKey:
          type: string
        firebaseProjectId:
          type: string
        firebasePrivateKeyId:
          type: string
        firebasePrivateKey:
          type: string
        firebaseClientEmail:
          type: string
        firebaseClientId:
          type: string
        firebaseClientCertUrl:
          type: string
      required:
      - androidPnApiKey
      - bundleId
      - environment
      - firebaseClientCertUrl
      - firebaseClientEmail
      - firebaseClientId
      - firebasePrivateKey
      - firebasePrivateKeyId
      - firebaseProjectId
      - keyId
      - signingKeyFile
      - teamId
    AndroidSettings:
      type: object
      properties:
        packageName:
          type: string
        fingerPrint1:
          type: string
        fingerPrint2:
          type: string
        fingerPrint3:
          type: string
        assetLinksFileUrl:
          type: string
    CheckoutTipConfigs:
      type: object
      properties:
        headerEnabled:
          type: boolean
        headerTitle:
          type: string
        subTitleEnabled:
          type: boolean
        deliverySubTitle:
          type: string
        pickupSubTitle:
          type: string
    ClientConfigShared:
      type: object
      properties:
        dateCreated:
          type: string
          format: date-time
        dateUpdated:
          type: string
          format: date-time
        apnSetting:
          $ref: '#/components/schemas/APNSetting'
        giftCard:
          $ref: '#/components/schemas/GiftCard'
        guestCheckoutVerification:
          $ref: '#/components/schemas/GuestCheckoutVerification'
        guestJourney:
          $ref: '#/components/schemas/GuestJourney'
        loyaltyNumberStrategy:
          $ref: '#/components/schemas/LoyaltyNumberStrategy'
        loyaltyProvider:
          $ref: '#/components/schemas/LoyaltyProvider'
        mobileAppVersion:
          $ref: '#/components/schemas/MobileAppVersion'
        passwordlessAuthentication:
          $ref: '#/components/schemas/PasswordlessAuthentication'
        recaptcha:
          type: boolean
        silverwareExtLoyaltyIdStrategy:
          $ref: '#/components/schemas/SilverwareExtLoyaltyIdStrategy'
        sms:
          $ref: '#/components/schemas/Sms'
        socialSignIn:
          $ref: '#/components/schemas/SocialSignIn'
        toastApplePay:
          $ref: '#/components/schemas/ToastApplePay'
        userAccountVerification:
          $ref: '#/components/schemas/UserAccountVerification'
        workspaces:
          $ref: '#/components/schemas/Workspace'
      required:
      - dateCreated
      - dateUpdated
      - giftCard
      - loyaltyProvider
      - sms
      - socialSignIn
      - userAccountVerification
      - workspaces
    Colors:
      type: object
      properties:
        primaryColor:
          type: string
        secondaryColor:
          type: string
        tertiaryColor:
          type: string
        headerBgColor:
          type: string
        bgColor:
          type: string
        tintColor:
          type: string
        shadeColor:
          type: string
        accentColor:
          type: string
        activeBreadcrumbColor:
          type: string
        inactiveBreadcrumbColor:
          type: string
        cardColor:
          type: string
        hoverColor:
          type: string
        inactiveButton:
          type: string
    CustomCatalog:
      type: object
      properties:
        isActive:
          type: boolean
        isOrderingEnabled:
          type: boolean
        customCatalogTitle:
          type: array
          items:
            type: string
        defaultLocation:
          type: string
        defaultMerchant:
          type: string
        buttonName:
          type: array
          items:
            type: string
    DateOfBirth:
      type: object
      properties:
        enabled:
          type: boolean
        required:
          type: boolean
    DefaultOrderType:
      type: object
      properties:
        active:
          type: boolean
        orderType:
          $ref: '#/components/schemas/OrderType'
    DisplayLoyaltyPointsExpiration:
      type: object
      properties:
        enabled:
          type: boolean
        noOfDays:
          type: integer
          format: int32
        displayModal:
          type: boolean
    Font:
      type: object
      properties:
        fontFamily:
          type: string
        fontSize:
          type: string
        fontColor:
          type: string
    Fonts:
      type: object
      properties:
        primaryFont:
          $ref: '#/components/schemas/Font'
        secondaryFont:
          $ref: '#/components/schemas/Font'
        tertiaryFont:
          $ref: '#/components/schemas/Font'
        quaternaryFont:
          $ref: '#/components/schemas/Font'
    GiftCard:
      type: object
      properties:
        isActive:
          type: boolean
        sendByEmailIsActive:
          type: boolean
        giftCardTitle:
          type: array
          items:
            type: string
        defaultLocation:
          type: string
        cardDetails:
          type: array
          items:
            type: string
        walletOrder:
          type: array
          items:
            type: string
        defaultMerchant:
          type: string
        minAmount:
          type: string
        maxAmount:
          type: string
        selectableAmount:
          type: array
          items:
            type: string
        giftCardHeader:
          type: array
          items:
            type: string
        hideQrCode:
          type: boolean
        purchaseNewGiftCard:
          type: boolean
        addGiftCardToWallet:
          type: boolean
        reloadGiftCard:
          type: boolean
        purchaseWithGiftCard:
          type: boolean
        giftCardLookUp:
          type: boolean
        securityCodeEnabled:
          type: boolean
        guestPurchaseEnabled:
          type: boolean
        guestAddGiftCardEnabled:
          type: boolean
    GuestCheckoutVerification:
      type: object
      properties:
        enabled:
          type: boolean
        deliveryMethod:
          $ref: '#/components/schemas/VerificationDeliveryMethod'
      required:
      - deliveryMethod
      - enabled
    GuestJourney:
      type: object
      properties:
        enabled:
          type: boolean
        enabledMenuIntelligence:
          type: boolean
      required:
      - enabled
      - enabledMenuIntelligence
    Images:
      type: object
      properties:
        logo:
          type: string
        bgImage:
          type: string
        defaultGroupImage:
          type: string
        mapPin:
          type: string
        favicon:
          type: string
    IosSettings:
      type: object
      properties:
        teamId:
          type: string
        bundleId:
          type: string
        appleAppSiteAssociationFileUrl:
          type: string
    ItemModifiers:
      type: object
      properties:
        itemModifierStyle:
          type: string
        disableAutoExpandedListStyleModifier:
          type: boolean
        autoExpandTileStyleNestedModifier:
          type: boolean
        autoExpandMoreCustomizations:
          type: boolean
    Loyalty:
      type: object
      properties:
        loyaltyType:
          type: string
        loyaltyPointNameSingular:
          type: string
        loyaltyPointNamePlural:
          type: string
        loyaltyPointsDivisor:
          type: integer
          format: int32
        loyaltyPointImgs:
          type: array
          items:
            type: string
        loyaltyLogo:
          type: string
        loyaltyHeaderRectangle1:
          type: string
        loyaltyHeaderRectangle2:
          type: string
        loyaltyText:
          type: array
          items:
            type: string
        loyaltyButtonColor:
          type: string
        loyaltyHeadingColor:
          type: string
        loyaltyTextColor:
          type: string
        loyaltyHeader:
          type: array
          items:
            type: string
        loyaltyButtons:
          $ref: '#/components/schemas/LoyaltyButtons'
        loyaltyPointTermSingular:
          type: array
          items:
            type: string
        loyaltyPointTermPlural:
          type: array
          items:
            type: string
        displayLoyaltyPointsExpiration:
          $ref: '#/components/schemas/DisplayLoyaltyPointsExpiration'
        loyaltyScreenType:
          type: string
        rewardsDescriptionURL:
          type: string
        hideLoyaltyScreenOfferDisplayTitleLabel:
          type: boolean
        displayAvailableOffersCountLoyaltyScreen:
          type: boolean
        loyaltyPointTerminology:
          type: string
        loyaltyPointsTerminology:
          type: string
        loyaltyCardDisplayTitle:
          type: string
        loyaltyWheelConfigs:
          $ref: '#/components/schemas/LoyaltyWheelConfigs'
        loyaltyPunchConfigs:
          $ref: '#/components/schemas/LoyaltyPunchConfigs'
    LoyaltyButtons:
      type: object
      properties:
        button1:
          type: array
          items:
            type: string
        button2:
          type: array
          items:
            type: string
    LoyaltyNumberStrategy:
      type: object
      properties:
        strategy:
          type: string
        accountNoPrefix:
          type: string
        accountNoPostfixStartFrom:
          type: integer
          format: int64
        accountNoPostfixDigitCount:
          type: integer
          format: int64
    LoyaltyProvider:
      type: object
      properties:
        enabled:
          type: boolean
        type:
          $ref: '#/components/schemas/LoyaltyProviderType'
    LoyaltyProviderType:
      type: string
      enum:
      - INCENTIVIO
      - SQUARE
    LoyaltyPunchConfigs:
      type: object
      properties:
        fullPunchImageUrl:
          type: string
        halfPunchImageUrl:
          type: string
        punchesToPointsRatio:
          type: integer
          format: int32
    LoyaltyWheelConfigs:
      type: object
      properties:
        hideLoyaltyScreenConfettiAnimation:
          type: boolean
        forceConfettiAnimationOnEachTier:
          type: boolean
        loyaltyMileStoneValues:
          type: array
          items:
            type: integer
            format: int32
        shouldDisplayCustomLoyaltyTierDetailButton:
          type: boolean
        customLoyaltyTierDetailButtonTitle:
          type: string
        pointUntilNextRewardDescriptionLabel:
          type: string
        pointsUntilNextRewardDescriptionLabel:
          type: string
    MagicLinkSettings:
      type: object
      properties:
        android:
          $ref: '#/components/schemas/AndroidSettings'
        ios:
          $ref: '#/components/schemas/IosSettings'
        baseUrl:
          type: string
    MenuLogos:
      type: object
      properties:
        home:
          type: array
          items:
            type: string
        loyalty:
          type: array
          items:
            type: string
        settings:
          type: array
          items:
            type: string
        pastOrders:
          type: array
          items:
            type: string
        signOut:
          type: array
          items:
            type: string
        inbox:
          type: array
          items:
            type: string
        catering:
          type: array
          items:
            type: string
        enterCode:
          type: array
          items:
            type: string
        easyOrder:
          type: array
          items:
            type: string
        giftCard:
          type: array
          items:
            type: string
        loyaltyCard:
          type: array
          items:
            type: string
        customCatalog:
          type: array
          items:
            type: string
        tings:
          $ref: '#/components/schemas/MenuLogos'
          writeOnly: true
    MobileAppVersion:
      type: object
      properties:
        requiredVersion:
          $ref: '#/components/schemas/RequiredMobileAppVersion'
        recommendedVersion:
          $ref: '#/components/schemas/RecommendedMobileAppVersion'
    OrderDetails:
      type: object
      properties:
        orderType:
          type: string
        total:
          type: string
        text:
          type: array
          items:
            type: string
    OrderHistory:
      type: object
      properties:
        hideOrderHistoryReorderButton:
          type: boolean
        hideOrderHistoryCallButton:
          type: boolean
        orderHistoryEmailButton:
          $ref: '#/components/schemas/OrderHistoryEmailButton'
        orderHistoryExternalButton:
          $ref: '#/components/schemas/OrderHistoryExternalButton'
    OrderHistoryEmailButton:
      type: object
      properties:
        displayEmailButtonOnOrderHistory:
          type: boolean
        orderHistoryContactEmail:
          type: string
        orderHistoryContactEmailSubject:
          type: string
        includeOrderNumberInSubject:
          type: boolean
        includeOrderDateInSubject:
          type: boolean
        includeLocationInSubject:
          type: boolean
        includeOrderIdInSubject:
          type: boolean
        includePaymentCardLastFourDigits:
          type: boolean
    OrderHistoryExternalButton:
      type: object
      properties:
        displayExternalContactUsButtonOnOrderHistory:
          type: boolean
        orderHistoryContactURL:
          type: string
    OrderTypeLabels:
      type: object
      properties:
        pickup:
          type: object
          additionalProperties:
            type: string
        delivery:
          type: object
          additionalProperties:
            type: string
        catering:
          type: object
          additionalProperties:
            type: string
    PageUrl:
      type: object
      properties:
        title:
          type: array
          items:
            type: string
        url:
          type: string
        image:
          type: string
    PasswordlessAuthentication:
      type: object
      properties:
        enabled:
          type: boolean
        deliveryMethod:
          type: array
          items:
            $ref: '#/components/schemas/VerificationDeliveryMethod'
        magicLinkSettings:
          $ref: '#/components/schemas/MagicLinkSettings'
      required:
      - deliveryMethod
      - enabled
    PreferenceInfo:
      type: object
      properties:
        preferenceName:
          type: object
          additionalProperties:
            type: string
        values:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        infoText:
          type: object
          additionalProperties:
            type: string
        multiSelectOption:
          type: boolean
    Recaptcha:
      type: object
      properties:
        isActive:
          type: boolean
        enableFor:
          $ref: '#/components/schemas/RecaptchaEnableFor'
    RecaptchaEnableFor:
      type: object
      properties:
        login:
          type: boolean
        createAccount:
          type: boolean
        payment:
          type: boolean
        addGiftCard:
          type: boolean
    RecommendedMobileAppVersion:
      type: object
      properties:
        androidVersion:
          type: object
          additionalProperties:
            type: boolean
        iosVersion:
          type: object
          additionalProperties:
            type: boolean
      required:
      - androidVersion
      - iosVersion
    RequiredMobileAppVersion:
      type: object
      properties:
        androidVersion:
          type: object
          additionalProperties:
            type: boolean
        iosVersion:
          type: object
          additionalProperties:
            type: boolean
      required:
      - androidVersion
      - iosVersion
    Segment:
      type: object
      properties:
        workspaceId:
          type: string
    SignUp:
      type: object
      properties:
        dateOfBirth:
          $ref: '#/components/schemas/DateOfBirth'
        enableLegacyUserAccessAccountFlow:
          type: boolean
        signUpNotification:
          $ref: '#/components/schemas/SignUpNotification'
    SignUpNotification:
      type: object
      properties:
        signUpAndLoyaltyExpiryBannerTextColor:
          type: string
        signUpAndLoyaltyExpiryBannerBackgroundColor:
          type: string
        signUpNotificationBannerMessageText:
          type: string
        shouldUsePrimaryFontOnSignUpAndLoyaltyExpiryBanner:
          type: boolean
        signUpAndLoyaltyExpiryBannerInfoIconColor:
          type: string
        signUpAndLoyaltyExpiryBannerDismissIconColor:
          type: string
    SilverwareExtLoyaltyIdStrategy:
      type: object
      properties:
        appVersion:
          type: string
        loyaltyApiMerchantId:
          type: string
        loyaltyApiMerchantCred:
          type: string
        orderSubmissionCredential:
          type: string
        clientPrefix:
          type: string
        cardTypePrefix:
          type: string
      required:
      - appVersion
      - cardTypePrefix
      - clientPrefix
      - loyaltyApiMerchantCred
      - loyaltyApiMerchantId
    Sms:
      type: object
      properties:
        enabled:
          type: boolean
          deprecated: true
        enabledAccountVerification:
          type: boolean
        enabledMarketing:
          type: boolean
        enabledOrdering:
          type: boolean
        twilioMessageServiceSid:
          type: string
        twilioPassword:
          type: string
        twilioPhoneNumber:
          type: string
        twilioUsername:
          type: string
      required:
      - enabled
      - enabledAccountVerification
      - enabledMarketing
      - enabledOrdering
    SocialSignIn:
      type: object
      properties:
        appleClientId:
          type: string
        enabled:
          type: boolean
        googleClientId:
          type: string
        googleClientSecret:
          type: string
    TipConfiguration:
      type: object
      properties:
        values:
          type: array
          items:
            type: integer
            format: int32
        defaultTip:
          type: integer
          format: int32
    TipPercentages:
      type: object
      properties:
        pickup:
          $ref: '#/components/schemas/TipConfiguration'
        delivery:
          $ref: '#/components/schemas/TipConfiguration'
    ToastApplePay:
      type: object
      properties:
        id:
          type: string
        integrationIdentifier:
          type: string
      required:
      - id
      - integrationIdentifier
    UserAccountVerification:
      type: object
      properties:
        method:
          $ref: '#/components/schemas/UserAccountVerificationMethod'
      required:
      - method
    UserAccountVerificationMethod:
      type: string
      enum:
      - EMAIL_CODE
      - EMAIL_LINK
      - SMS_CODE
      - SMS_LINK
    VerificationDeliveryMethod:
      type: string
      enum:
      - SMS
      - EMAIL
    WOv2:
      type: object
      properties:
        enabled:
          type: boolean
    WebAppConfigDTO:
      type: object
      properties:
        clientConfig:
          $ref: '#/components/schemas/ClientConfigShared'
        clientId:
          type: string
        merchantId:
          type: string
        locationId:
          type: string
        images:
          $ref: '#/components/schemas/Images'
        colors:
          $ref: '#/components/schemas/Colors'
        fonts:
          $ref: '#/components/schemas/Fonts'
        showOrderNumber:
          type: boolean
        showOrderInstructions:
          type: boolean
        showItemInstructions:
          type: boolean
        paymentGatewayName:
          type: string
        loyaltyOn:
          type: boolean
        onOffWallet:
          type: boolean
        customizationTexts:
          type: array
          items:
            type: string
        customizationChars:
          type: integer
          format: int32
        aptSuiteMand:
          type: boolean
        isTipDisplay:
          type: boolean
        languagesSupported:
          type: array
          items:
            type: string
        isGuestCheckoutEnabled:
          type: boolean
        deliveryInstructions:
          type: boolean
        customizedLoyalty:
          type: boolean
        loyaltyLabel:
          type: array
          items:
            type: string
        customizedConfirmation:
          type: boolean
        confirmDelivery:
          type: array
          items:
            type: string
        confirmDeliveryNoNum:
          type: array
          items:
            type: string
        confirmPickUp:
          type: array
          items:
            type: string
        confirmPickUpNoNum:
          type: array
          items:
            type: string
        isFutureDates:
          type: boolean
        getgAPI:
          type: string
        menuLogos:
          $ref: '#/components/schemas/MenuLogos'
        inbox:
          type: boolean
        fbAppId:
          type: string
        catering:
          type: boolean
        isLoyaltyCard:
          type: boolean
        loyaltyCardTitle:
          type: array
          items:
            type: string
        loyaltyCardCodeType:
          type: string
        isEnterCode:
          type: boolean
        loyalty:
          $ref: '#/components/schemas/Loyalty'
        clientName:
          type: string
        isEasyOrder:
          type: boolean
        easyOrderLabel:
          type: array
          items:
            type: string
        unreadMessageColor:
          type: string
        messageButtonColor:
          type: string
        messageCountColor:
          type: string
        editLoyaltyLabel:
          type: array
          items:
            type: string
        editLoyaltyOn:
          type: boolean
        hideQtyPicker:
          type: boolean
        isAVSEnabled:
          type: boolean
        showTimeBasedCatalogs:
          type: boolean
        catalogShowTime:
          type: number
          format: float
        itemInstructionsLabel:
          type: array
          items:
            type: string
        itemInstructionsWatermarkText:
          type: array
          items:
            type: string
        itemInstructionsAdditionalText1:
          type: array
          items:
            type: string
        showDineIn:
          type: boolean
        hideCateringMinMaxShortMessage:
          type: boolean
        isLoyaltyCustomer:
          type: boolean
        loyaltyCustomerTitle:
          type: array
          items:
            type: string
        orderDetails:
          $ref: '#/components/schemas/OrderDetails'
        giftCard:
          $ref: '#/components/schemas/GiftCard'
        customCatalog:
          $ref: '#/components/schemas/CustomCatalog'
        webUrls:
          $ref: '#/components/schemas/WebUrls'
        hideCustomization:
          type: boolean
        deliveryExternalLinksEnabled:
          type: boolean
        defaultSelectedDineIn:
          type: string
        showDineInConfigs:
          type: object
          additionalProperties:
            type: string
        orderHistoryTitle:
          type: object
          additionalProperties:
            type: string
        showOrderHistoryTitleInHomePage:
          type: boolean
        geoCodingTypes:
          type: object
          additionalProperties:
            type: integer
            format: int32
        geoCodingType:
          type: integer
          format: int32
        recommendationsEnabled:
          type: boolean
        uxAnalyticsEnabled:
          type: boolean
        beaconDetectionEnabled:
          type: boolean
        wov2:
          $ref: '#/components/schemas/WOv2'
        orderTypeLabels:
          $ref: '#/components/schemas/OrderTypeLabels'
        tipPercentages:
          $ref: '#/components/schemas/TipPercentages'
        signUp:
          $ref: '#/components/schemas/SignUp'
        segment:
          $ref: '#/components/schemas/Segment'
        signUpPreferenceDisabled:
          type: boolean
        signUpPreferenceInfo:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/PreferenceInfo'
        recaptcha:
          $ref: '#/components/schemas/Recaptcha'
        hideLoyaltyScanCode:
          type: boolean
        forceUserToSelectOrderType:
          type: boolean
        defaultOrderType:
          $ref: '#/components/schemas/DefaultOrderType'
        loyaltySegmentBadgesEnabled:
          type: boolean
        isClarityEnabled:
          type: boolean
        startOrderingFromNearestLocation:
          type: boolean
        hideHomeScreenOffersSlider:
          type: boolean
        displayHomeScreenOffersSliderPagingControl:
          type: boolean
        primaryAppThemeColor:
          type: string
        secondaryAppThemeColor:
          type: string
        itemModifiers:
          $ref: '#/components/schemas/ItemModifiers'
        orderHistory:
          $ref: '#/components/schemas/OrderHistory'
        checkoutTipConfigs:
          $ref: '#/components/schemas/CheckoutTipConfigs'
    WebUrls:
      type: object
      properties:
        mainUrl:
          $ref: '#/components/schemas/PageUrl'
        fb:
          $ref: '#/components/schemas/PageUrl'
        tw:
          $ref: '#/components/schemas/PageUrl'
        ig:
          $ref: '#/components/schemas/PageUrl'
    Workspace:
      type: object
      properties:
        enabled:
          type: boolean
    RefundTransactionRequest:
      type: object
      properties:
        adminUserId:
          type: string
        automaticReversal:
          type: boolean
        emailReceipt:
          type: boolean
        isPartialRefund:
          type: boolean
        refundAmount:
          type: integer
          format: int32
        refundReason:
          type: string
          minLength: 1
        requestedBy:
          type: string
        type:
          type: string
          minLength: 1
        orderId:
          type: string
        giftcardTransactionId:
          type: string
        extPaymentTransactionId:
          type: string
      required:
      - isPartialRefund
      - refundReason
      - type
    CreateRuleRequest:
      type: object
      properties:
        clientId:
          type: string
        rules:
          type: array
          items:
            $ref: '#/components/schemas/RuleRequest'
    RuleRequest:
      type: object
      properties:
        ruleId:
          type: string
        ruleType:
          type: string
        triggerMenus:
          type: array
          items:
            type: string
        triggerGroups:
          type: array
          items:
            type: string
        triggerItems:
          type: array
          items:
            type: string
        recommendationItems:
          type: array
          items:
            type: string
        metaData:
          $ref: '#/components/schemas/AdminPortalMetaDataRequest'
    CreateRuleResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        ruleCount:
          type: integer
          format: int32
    ModelTrainingRequest:
      type: object
      properties:
        clientId:
          type: string
        clientName:
          type: string
        metaData:
          $ref: '#/components/schemas/AdminPortalMetaDataRequest'
    StartTrainingProcessResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
    AccountBlockRequestDTO:
      type: object
      properties:
        reason:
          type: string
      required:
      - reason
    AccountBlockResponseDTO:
      type: object
      properties:
        userId:
          type: string
    CustomerTagDataType:
      type: string
      enum:
      - NUMBER
      - TEXT
      - DATE
      - COLLECTION
      - GEO
    Source:
      type: string
      enum:
      - SYSTEM
      - GUEST_INPUT
      - GENERATED
      - IMPORTED_MANUAL
    TagAndRuleDTO:
      type: object
      properties:
        id:
          type: string
        clientId:
          type: string
        key:
          type: string
        tagType:
          $ref: '#/components/schemas/TagType'
        category:
          type: string
        categoryDisplayTitle:
          type: string
        categoryDisplayRank:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        attributeType:
          $ref: '#/components/schemas/CustomerTagDataType'
        collectionValues:
          type: array
          items:
            type: string
        source:
          $ref: '#/components/schemas/Source'
        sourceDisplayTitle:
          type: string
        tagRank:
          type: integer
          format: int32
        visibility:
          type: array
          items:
            type: string
    TagType:
      type: string
      enum:
      - CUSTOM
      - SYSTEM
    EmailPulseDataCSVRequestDTO:
      type: object
      properties:
        clientname:
          type: string
        requestStatus:
          $ref: '#/components/schemas/RequestStatusEnum'
        startdate:
          type: string
          format: date
        enddate:
          type: string
          format: date
        storeids:
          type: array
          items:
            type: string
        columns:
          type: array
          items:
            type: string
        reportType:
          type: string
        emailType:
          type: string
        status:
          type: string
        campaignIds:
          type: array
          items:
            type: string
        offerIds:
          type: array
          items:
            type: string
        messageIds:
          type: array
          items:
            type: string
    RequestStatusEnum:
      type: string
      enum:
      - INPROGRESS
      - SUCCESS
      - FAILED
      - EMAILED
      - RETRYING
      - DOWNLOADED
      - NODATA
    PulseCSVResponseDTO:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/StatusEnum'
        responseMessage:
          type: string
        data:
          type: object
          additionalProperties: {}
    StatusEnum:
      type: string
      enum:
      - INPROGRESS
      - SUCCESS
      - FAILED
      - EMAILED
      - RETRYING
      - DOWNLOADED
      - NODATA
    LoyaltyReportOfferTrendsCSVRequestDTO:
      type: object
      properties:
        clientName:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        storeIds:
          type: array
          items:
            type: string
        offerIds:
          type: array
          items:
            type: string
        dataType:
          type: string
        granularity:
          type: string
        offerType:
          $ref: '#/components/schemas/OfferTypeEnum'
    OfferTypeEnum:
      type: string
      enum:
      - ALL
      - loyaltyPointOffer
      - nonPointOffer
    LoyaltyReportCSVResponseDTO:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/StatusEnum'
        responseMessage:
          type: string
        data:
          type: object
          additionalProperties: {}
    LoyaltyReportOfferPerformanceCSVRequestDTO:
      type: object
      properties:
        clientName:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        storeIds:
          type: array
          items:
            type: string
        offerIds:
          type: array
          items:
            type: string
        columns:
          type: array
          items:
            type: string
        offerType:
          $ref: '#/components/schemas/OfferTypeEnum'
    LoyaltyReportLocationTrendsCSVRequestDTO:
      type: object
      properties:
        clientName:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        storeIds:
          type: array
          items:
            type: string
        dataType:
          type: string
        granularity:
          type: string
    LoyaltyReportLocationPerformanceCSVRequestDTO:
      type: object
      properties:
        clientName:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        storeIds:
          type: array
          items:
            type: string
        columns:
          type: array
          items:
            type: string
    OfferPerformanceReportExportRequestDTO:
      type: object
      properties:
        clientId:
          type: string
        clientName:
          type: string
        merchantId:
          type: string
        adminId:
          type: string
        adminName:
          type: string
        emailIds:
          type: array
          items:
            type: string
        startDateStr:
          type: string
        endDateStr:
          type: string
        storeIds:
          type: array
          items:
            type: string
    OfferPerformanceReportExportResponseDTO:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/StatusEnum'
        message:
          type: string
        generatedCSV:
          type: string
    CustomerReportDownloadRequestDTO:
      type: object
      properties:
        id:
          type: string
          format: uuid
        clientId:
          type: string
        clientName:
          type: string
        status:
          $ref: '#/components/schemas/CustomerReportDownloadRequestStatus'
        createdDate:
          type: string
          format: date-time
        lastUpdated:
          type: string
          format: date-time
        emailIds:
          type: array
          items:
            type: string
    CustomerReportDownloadRequestStatus:
      type: string
      enum:
      - INPROGRESS
      - FAILED
      - DOWNLOADED
      - EMAILED
    CustomerReportDownloadResponseDTO:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/CustomerReportDownloadRequestStatus'
        responseMessage:
          type: string
        data:
          type: object
          additionalProperties: {}
    OrderNotificationRequestDTO:
      type: object
      properties:
        subject:
          type: string
        message:
          type: string
        messageType:
          type: string
        email:
          type: string
        phoneNumber:
          type: string
        updateFulfillTime:
          type: boolean
        newFulfillTime:
          type: string
          format: date-time
        timeInMinutes:
          type: integer
          format: int32
    RefundOrderRequest:
      type: object
      properties:
        adminUserId:
          type: string
        automaticReversal:
          type: boolean
        emailReceipt:
          type: boolean
        isPartialRefund:
          type: boolean
        refundAmount:
          type: integer
          format: int32
        refundReason:
          type: string
          minLength: 1
        requestedBy:
          type: string
        orderId:
          type: string
        extPaymentTransactionId:
          type: string
      required:
      - isPartialRefund
      - orderId
      - refundReason
    CreateMerchantRequestDTO:
      type: object
      properties:
        merchantId:
          type: string
        clientId:
          type: string
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxDTO'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDTO'
        orderProcessingConfig:
          $ref: '#/components/schemas/OrderProcessingConfigDTO'
        paymentGatewayConfig:
          $ref: '#/components/schemas/PaymentGatewayConfig'
        pickupOrderProcessingTime:
          type: integer
          format: int64
        deliveryOrderProcessingTime:
          type: integer
          format: int64
        timeZone:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
    CreateMerchantResponseDTO:
      type: object
      properties:
        merchantId:
          type: string
    CreateLocationRequestDTO:
      type: object
      properties:
        catalogOverrides:
          type: array
          items:
            $ref: '#/components/schemas/MenuOverride'
          uniqueItems: true
        catering:
          type: boolean
        clientId:
          type: string
        merchantId:
          type: string
        locationId:
          type: string
        paymentConfigs:
          type: array
          items:
            $ref: '#/components/schemas/PaymentConfig'
        orderProcessingConfig:
          $ref: '#/components/schemas/OrderProcessingConfigDTO'
        paymentGatewayConfig:
          $ref: '#/components/schemas/PaymentGatewayConfig'
        pickupOrderProcessingTime:
          type: integer
          format: int64
        deliveryOrderProcessingTime:
          type: integer
          format: int64
        pickupOrderNoticePeriod:
          type: integer
          format: int64
        deliveryOrderNoticePeriod:
          type: integer
          format: int64
        timeZone:
          type: string
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxDTO'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDTO'
        pickupOrdersAccepted:
          type: boolean
        deliveryOrdersAccepted:
          type: boolean
        pickupOrderHours:
          type: array
          items:
            $ref: '#/components/schemas/WorkingHours'
          uniqueItems: true
        deliveryOrderHours:
          type: array
          items:
            $ref: '#/components/schemas/WorkingHours'
          uniqueItems: true
        deliveryOffDays:
          type: array
          items:
            type: string
        pickupOffDays:
          type: array
          items:
            type: string
        deliveryRadius:
          type: number
          format: double
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        deliveryAvailabilityInterval:
          type: integer
          format: int32
        pickupAvailabilityInterval:
          type: integer
          format: int32
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        locationName:
          type: string
        showPickupTimeSlots:
          type: boolean
        showDeliveryTimeSlots:
          type: boolean
        pickupAsapSupported:
          type: boolean
        deliveryAsapSupported:
          type: boolean
        countryCode:
          type: string
        currencyCode:
          type: string
        menuImportConfig:
          $ref: '#/components/schemas/MenuImportConfig'
        orderThrottleConfig:
          type: array
          items:
            $ref: '#/components/schemas/OrderThrottleConfig'
          uniqueItems: true
        kitchenThrottleConfig:
          $ref: '#/components/schemas/KitchenThrottleConfigDTO'
        pickupOrderValueLimits:
          $ref: '#/components/schemas/OrderValueLimits'
        deliveryOrderValueLimits:
          $ref: '#/components/schemas/OrderValueLimits'
        groupOverrides:
          type: array
          items:
            $ref: '#/components/schemas/MenuOverride'
          uniqueItems: true
        orderNotificationRecipientEmailList:
          type: array
          items:
            type: string
          uniqueItems: true
        failureNotificationRecipientEmailList:
          type: array
          items:
            type: string
          uniqueItems: true
        extPosLocationId:
          type: string
        primaryLocation:
          type: boolean
        primaryLocationId:
          type: string
        qalocation:
          type: boolean
        test:
          type: boolean
        deliveryOrderOptions:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptions'
          uniqueItems: true
        enableFulFillTextForToast:
          type: boolean
        fulFillTextForToast:
          type: string
        pickupOrderOptions:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptions'
          uniqueItems: true
      required:
      - locationId
    CreateLocationResponseDTO:
      type: object
      properties:
        locationId:
          type: string
    Direction:
      type: string
      enum:
      - ASC
      - DESC
    ItemSearchRequestDTO:
      type: object
      properties:
        clientId:
          type: string
        count:
          type: integer
          format: int32
        externalIds:
          type: array
          items:
            type: string
          uniqueItems: true
        filterByAllowedLocations:
          type: boolean
        imported:
          type: boolean
        incentivioIds:
          type: array
          items:
            type: string
          uniqueItems: true
        includeStores:
          type: boolean
        originalTitle:
          type: string
        page:
          type: integer
          format: int32
        sortBy:
          type: string
        sortDirection:
          $ref: '#/components/schemas/Direction'
        status:
          $ref: '#/components/schemas/Status'
        title:
          type: string
        catalogIds:
          type: array
          items:
            type: string
          uniqueItems: true
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        groupIds:
          type: array
          items:
            type: string
          uniqueItems: true
        outOfStock:
          type: boolean
        outOfStockToday:
          type: boolean
    Status:
      type: string
      enum:
      - ACTIVE
      - INACTIVE
    Discount:
      type: object
      properties:
        discountId:
          type: string
        extDiscountId:
          type: string
        description:
          type: string
        discountType:
          $ref: '#/components/schemas/DiscountType'
        discountValueType:
          $ref: '#/components/schemas/DiscountValueType'
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        name:
          type: string
    ListItemAdminDTO:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        externalId:
          type: string
        extTargetingId:
          type: string
        title:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
        endDate:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        storeInfos:
          type: array
          items:
            $ref: '#/components/schemas/StoreInfo'
        originalTitle:
          type: string
        itemId:
          type: string
        price:
          type: integer
          format: int32
        unformattedPrice:
          type: number
        unformattedPriceWithTax:
          type: number
        discounts:
          type: array
          items:
            $ref: '#/components/schemas/Discount'
        optionGroupIds:
          type: array
          items:
            type: string
        optionGroupSettings:
          type: array
          items:
            $ref: '#/components/schemas/OptionGroupSettingDTO'
          uniqueItems: true
        uom:
          type: string
        sku:
          type: string
        upc:
          type: string
        brandId:
          type: string
        categoryId:
          type: string
        maxItemSelections:
          type: integer
          format: int32
        maxQuantity:
          type: integer
          format: int32
        minQuantity:
          type: integer
          format: int32
        inheritParentOptions:
          type: boolean
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxInfoDTO'
        invertParentTaxable:
          type: boolean
        orderingChannels:
          type: array
          items:
            $ref: '#/components/schemas/OrderingChannels'
        itemType:
          $ref: '#/components/schemas/ItemType'
        outOfStock:
          type: boolean
        outOfStockToday:
          type: boolean
        taxable:
          type: boolean
      required:
      - clientId
      - merchantId
      - title
    ListItemResponseWithPagingForAdminDTO:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ListItemAdminDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    PagingDTO:
      type: object
      properties:
        total:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int32
        currentPage:
          type: integer
          format: int32
    StoreInfo:
      type: object
      properties:
        smallImage:
          type: string
        storeId:
          type: string
        title:
          type: string
    GroupSearchRequestDTO:
      type: object
      properties:
        clientId:
          type: string
        count:
          type: integer
          format: int32
        externalIds:
          type: array
          items:
            type: string
          uniqueItems: true
        filterByAllowedLocations:
          type: boolean
        imported:
          type: boolean
        incentivioIds:
          type: array
          items:
            type: string
          uniqueItems: true
        includeStores:
          type: boolean
        originalTitle:
          type: string
        page:
          type: integer
          format: int32
        sortBy:
          type: string
        sortDirection:
          $ref: '#/components/schemas/Direction'
        status:
          $ref: '#/components/schemas/Status'
        title:
          type: string
        catalogIds:
          type: array
          items:
            type: string
          uniqueItems: true
        type:
          $ref: '#/components/schemas/GroupType'
    ListGroupAdminDTO:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        externalId:
          type: string
        extTargetingId:
          type: string
        title:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
        endDate:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        storeInfos:
          type: array
          items:
            $ref: '#/components/schemas/StoreInfo'
        originalTitle:
          type: string
        groupId:
          type: string
        groupType:
          $ref: '#/components/schemas/GroupType'
        itemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        defaultSelectedItems:
          type: array
          items:
            type: string
          uniqueItems: true
        mandatoryItems:
          type: array
          items:
            type: string
          uniqueItems: true
        optionGroupIds:
          type: array
          items:
            type: string
          uniqueItems: true
        subGroupIds:
          type: array
          items:
            type: string
          uniqueItems: true
        selectionMandatory:
          type: boolean
        selectionType:
          $ref: '#/components/schemas/SelectionType'
        inheritParentOptions:
          type: boolean
        maxItemSelections:
          type: integer
          format: int32
        minItemSelections:
          type: integer
          format: int32
        groupItemSettings:
          type: array
          items:
            $ref: '#/components/schemas/GroupItemSetting'
          uniqueItems: true
      required:
      - clientId
      - merchantId
      - title
    ListGroupResponseWithPagingForAdminDTO:
      type: object
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/ListGroupAdminDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    DailySalesReportExportRequestDTO:
      type: object
      properties:
        id:
          type: string
          format: uuid
        adminName:
          type: string
        adminId:
          type: string
        emailIds:
          type: array
          items:
            type: string
        clientId:
          type: string
        merchantId:
          type: string
        startDateStr:
          type: string
        endDateStr:
          type: string
        filterModes:
          type: array
          items:
            $ref: '#/components/schemas/OrderFilteringMode'
        storeIds:
          type: array
          items:
            type: string
    OrderFilteringMode:
      type: string
      enum:
      - ALL_ORDERS
      - CLOSED_ORDERS
      - ABANDONED_ORDERS
      - MENU_BROWSING_ORDERS
      - CANCELED_ORDERS
      - REFUNDED_ORDERS
      - TEST_ORDERS
      - PAYMENT_ERROR_ORDERS
      - NONPAYMENT_ERROR_ORDERS
    DailySalesReportExportResponseDTO:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/DailySalesReportRequestStatusEnum'
        message:
          type: string
        request:
          $ref: '#/components/schemas/DailySalesReportExportRequestDTO'
        generatedCSV:
          type: string
    DailySalesReportRequestStatusEnum:
      type: string
      enum:
      - INPROGRESS
      - EMAILED
      - DOWNLOADED
      - RETRYING
      - FAILED
    CreatePresetOrderConfigRequestDTO:
      type: object
      properties:
        code:
          type: string
          minLength: 1
        locationId:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/OrderConfigDisplayInfo'
          uniqueItems: true
        orderType:
          $ref: '#/components/schemas/OrderType'
        restrictionType:
          $ref: '#/components/schemas/OrderRestrictionType'
        dateSelectionMode:
          $ref: '#/components/schemas/DateSelectionMode'
        timeSelectionMode:
          $ref: '#/components/schemas/TimeSelectionMode'
        itemValidationMode:
          $ref: '#/components/schemas/ItemValidationMode'
        inheritChargesFromLocation:
          type: boolean
        displayPresetValueConfirmationPage:
          type: boolean
        deliveryInfo:
          $ref: '#/components/schemas/DeliveryInfo'
        requestedFulfillDate:
          type: string
          format: date
        requestedFulfillTime:
          type: string
        charges:
          type: array
          items:
            $ref: '#/components/schemas/Charge'
        items:
          type: array
          items:
            $ref: '#/components/schemas/AddOrderItemReqDTO'
        orderInstructions:
          type: string
      required:
      - code
    CatalogSearchRequestDTO:
      type: object
      properties:
        clientId:
          type: string
        count:
          type: integer
          format: int32
        externalIds:
          type: array
          items:
            type: string
          uniqueItems: true
        filterByAllowedLocations:
          type: boolean
        imported:
          type: boolean
        incentivioIds:
          type: array
          items:
            type: string
          uniqueItems: true
        includeStores:
          type: boolean
        originalTitle:
          type: string
        page:
          type: integer
          format: int32
        sortBy:
          type: string
        sortDirection:
          $ref: '#/components/schemas/Direction'
        status:
          $ref: '#/components/schemas/Status'
        title:
          type: string
        endDate:
          type: string
          format: date-time
        startDate:
          type: string
          format: date-time
        storeIds:
          type: array
          items:
            type: string
          uniqueItems: true
    ListCatalogAdminDTO:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        externalId:
          type: string
        extTargetingId:
          type: string
        title:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
        endDate:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        storeInfos:
          type: array
          items:
            $ref: '#/components/schemas/StoreInfo'
        originalTitle:
          type: string
        catalogId:
          type: string
        groupIds:
          type: array
          items:
            type: string
        groups:
          type: array
          items:
            $ref: '#/components/schemas/ViewGroupAdminDTO'
        lastPublished:
          type: string
          format: date-time
      required:
      - clientId
      - merchantId
      - title
    ListCatalogResponseWithPagingForAdminDTO:
      type: object
      properties:
        catalogs:
          type: array
          items:
            $ref: '#/components/schemas/ListCatalogAdminDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    ViewGroupAdminDTO:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        externalId:
          type: string
        extTargetingId:
          type: string
        title:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
        endDate:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        storeInfos:
          type: array
          items:
            $ref: '#/components/schemas/StoreInfo'
        originalTitle:
          type: string
        groupId:
          type: string
        groupType:
          $ref: '#/components/schemas/GroupType'
        items:
          type: array
          items:
            $ref: '#/components/schemas/ViewItemAdminDTO'
        itemIds:
          type: array
          items:
            type: string
        defaultSelectedItems:
          type: array
          items:
            type: string
        defaultSelectedItemObjects:
          type: array
          items:
            $ref: '#/components/schemas/ViewItemAdminDTO'
        mandatoryItems:
          type: array
          items:
            type: string
        mandatoryItemObjects:
          type: array
          items:
            $ref: '#/components/schemas/ViewItemAdminDTO'
        optionGroups:
          type: array
          items:
            $ref: '#/components/schemas/ViewGroupAdminDTO'
        optionGroupSetting:
          $ref: '#/components/schemas/OptionGroupSettingDTO'
        optionGroupIds:
          type: array
          items:
            type: string
        subGroups:
          type: array
          items:
            $ref: '#/components/schemas/ViewGroupAdminDTO'
        subGroupIds:
          type: array
          items:
            type: string
        selectionMandatory:
          type: boolean
        selectionType:
          $ref: '#/components/schemas/SelectionType'
        inheritParentOptions:
          type: boolean
        maxItemSelections:
          type: integer
          format: int32
        minItemSelections:
          type: integer
          format: int32
        groupItemSettings:
          type: array
          items:
            $ref: '#/components/schemas/GroupItemSetting'
          uniqueItems: true
      required:
      - clientId
      - merchantId
      - title
    ViewItemAdminDTO:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        externalId:
          type: string
        extTargetingId:
          type: string
        title:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
        endDate:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        storeInfos:
          type: array
          items:
            $ref: '#/components/schemas/StoreInfo'
        originalTitle:
          type: string
        itemId:
          type: string
        price:
          type: integer
          format: int32
        unformattedPrice:
          type: number
        unformattedPriceWithTax:
          type: number
        discounts:
          type: array
          items:
            $ref: '#/components/schemas/Discount'
        optionGroups:
          type: array
          items:
            $ref: '#/components/schemas/ViewGroupAdminDTO'
        optionGroupIds:
          type: array
          items:
            type: string
        optionGroupSettings:
          type: array
          items:
            $ref: '#/components/schemas/OptionGroupSettingDTO'
          uniqueItems: true
        uom:
          type: string
        sku:
          type: string
        upc:
          type: string
        brandId:
          type: string
        categoryId:
          type: string
        maxItemSelections:
          type: integer
          format: int32
        maxQuantity:
          type: integer
          format: int32
        minQuantity:
          type: integer
          format: int32
        inheritParentOptions:
          type: boolean
        invertParentTaxable:
          type: boolean
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxInfoDTO'
        outOfStock:
          type: boolean
        outOfStockToday:
          type: boolean
        orderingChannels:
          type: array
          items:
            $ref: '#/components/schemas/OrderingChannels'
        itemType:
          $ref: '#/components/schemas/ItemType'
        taxable:
          type: boolean
      required:
      - clientId
      - merchantId
      - title
    CreateCacheCatalogRequestDTO:
      type: object
      properties:
        clientId:
          type: string
          minLength: 1
        localDateTime:
          type: string
          format: date-time
        storeIds:
          type: array
          items:
            type: string
          minItems: 1
        userId:
          type: string
        requestId:
          type: string
      required:
      - clientId
      - storeIds
    CatalogCacheProgressStatus:
      type: string
      enum:
      - IN_PROGRESS
      - FAILED
      - COMPLETED
    CatalogCacheResponse:
      type: object
      properties:
        requestId:
          type: string
        clientId:
          type: string
        status:
          $ref: '#/components/schemas/CatalogCacheProgressStatus'
        startedTime:
          type: string
        completedTime:
          type: string
    RedeemOfferAPIRequestDTO:
      type: object
      properties:
        userId:
          type: string
        qrCodeValue:
          type: string
        transactionDate:
          type: string
          minLength: 1
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        distributedOfferId:
          type: string
      required:
      - transactionDate
    ActivityOfferListRequestDTO:
      type: object
      properties:
        userId:
          type: string
          minLength: 1
        languageCode:
          type: string
        offerIds:
          type: array
          items:
            type: string
        localDateTime:
          type: string
          minLength: 1
      required:
      - localDateTime
      - userId
    ActivityOfferDTO:
      type: object
      properties:
        distributedOfferId:
          type: string
        offerId:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        offerCode:
          type: string
        codeFormat:
          type: string
        languageCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        status:
          $ref: '#/components/schemas/RedeemStatus'
        redemptionEndDate:
          type: string
        distributedDate:
          type: string
        updatedDate:
          type: string
    ActivityOfferListDTO:
      type: object
      properties:
        offers:
          type: array
          items:
            $ref: '#/components/schemas/ActivityOfferDTO'
    RedeemStatus:
      type: string
      enum:
      - NEW
      - SAVED
      - READ
      - EXPIRED
      - DELETED
      - SYSTEM_REDEEMED
      - USER_REDEEMED
    ProductType:
      type: string
      enum:
      - ITEM
      - GROUP
      - MENU
    SearchTargetingParams:
      type: object
      properties:
        query:
          type: string
        productType:
          $ref: '#/components/schemas/ProductType'
        status:
          $ref: '#/components/schemas/Status'
        itemType:
          $ref: '#/components/schemas/ItemType'
        locationIds:
          type: array
          items:
            type: string
        limit:
          type: integer
          format: int32
        cursor:
          type: string
    ProductSearchResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/ProductSearchResult'
        nextCursor:
          type: string
        hasMoreResults:
          type: boolean
    ProductSearchResult:
      type: object
      properties:
        extTargetingId:
          type: string
        incentivioId:
          type: string
        externalId:
          type: string
        title:
          type: string
        productType:
          $ref: '#/components/schemas/ProductType'
        locationVariationCount:
          type: integer
          format: int32
        priceVariationCount:
          type: integer
          format: int32
    BulkImageUploadCreateRequest:
      type: object
      properties:
        adminId:
          type: string
        clientId:
          type: string
        processedFiles:
          type: array
          items:
            $ref: '#/components/schemas/ImageFile'
        type:
          $ref: '#/components/schemas/BulkImageUploadType'
        uploadId:
          type: string
      required:
      - processedFiles
      - type
      - uploadId
    BulkImageUploadType:
      type: string
      enum:
      - CATALOG
      - GROUP
      - ITEM
    BulkImageUploadCreateResponse:
      type: object
      properties:
        id:
          type: string
    PresignedUrlsClientRequest:
      type: object
      properties:
        keys:
          type: array
          items:
            type: string
      required:
      - keys
    PresignedUrlClient:
      type: object
      properties:
        key:
          type: string
        presignedUrl:
          type: string
    PresignedUrlsClientResponse:
      type: object
      properties:
        presignedUrls:
          type: array
          items:
            $ref: '#/components/schemas/PresignedUrlClient'
    GiftCardLocationConfigUpdateRequest:
      type: object
      properties:
        locationId:
          type: string
        locationSettings:
          type: object
          additionalProperties:
            type: string
    GiftCardClientConfigUpdateRequest:
      type: object
      properties:
        clientId:
          type: string
        giftCardProvider:
          $ref: '#/components/schemas/GiftCardServiceProvider'
        securityCodeEnabled:
          type: boolean
        poolAccountSettings:
          type: object
          additionalProperties:
            type: string
    GiftCardServiceProvider:
      type: string
      enum:
      - INCENTIVIO_GIFTCARD_SERVICE
      - WORLDPAY
      - WORLDPAY_VALUETEC
      - GIVEX
      - SQUARE
      - VALUTEC
      - E_CARD_SYSTEMS
    ImportCardRequest:
      type: object
      properties:
        sourceType:
          $ref: '#/components/schemas/SourceType'
        adminId:
          type: string
        file:
          type: string
          format: binary
        cardStatus:
          type: string
        isUpdateCards:
          type: boolean
        isCompBalance:
          type: boolean
      required:
      - cardStatus
      - file
    SourceType:
      type: string
      enum:
      - POS
      - MOBILE
      - WEB
      - ADMIN_PORTAL
    ImportCardResponse:
      type: object
      properties:
        batchId:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        description:
          type: string
        rootErrors:
          type: object
          additionalProperties:
            type: string
    RemoveCardResponse:
      type: object
      properties:
        batchId:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        description:
          type: string
        rootErrors:
          type: object
          additionalProperties:
            type: string
    CreateCardRequest:
      type: object
      properties:
        sourceType:
          $ref: '#/components/schemas/SourceType'
        clientId:
          type: string
        merchantId:
          type: string
        incentivioLocationId:
          type: string
        adminId:
          type: string
        amount:
          type: integer
          format: int32
        from:
          type: string
        recipient:
          $ref: '#/components/schemas/GiftCardRecipient'
    GiftCardRecipient:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        message:
          type: string
    CreateCardResponse:
      type: object
      properties:
        status:
          type: string
        cardIdentifier:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
    GiftCardTransactionRequest:
      type: object
      properties:
        sourceType:
          type: string
        incentivioUserId:
          type: string
        incentivioLocationId:
          type: string
        incentivioLocationName:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        cardIdentifier:
          type: string
        transactionType:
          type: string
        description:
          type: string
        amount:
          type: number
          format: double
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
    GiftCardTransactionResponse:
      type: object
      properties:
        transactionType:
          type: string
        cardIdentifier:
          type: string
        cardAccountBalance:
          type: number
          format: double
        transactionValue:
          type: number
          format: double
        cardStatus:
          type: string
        transactionStatus:
          type: string
        rootErrors:
          type: object
          additionalProperties:
            type: string
    ResendEmailRequest:
      type: object
      properties:
        cardIdentifier:
          type: string
        adminId:
          type: string
        recipientEmail:
          type: string
        fieldsAsMap:
          type: object
          additionalProperties: {}
    ResendEmailResponse:
      type: object
      properties:
        recipientEmail:
          type: string
        status:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
    RetryCustomerVerificationRequest:
      type: object
      properties:
        dateOfBirth:
          type: string
        fullSSN:
          type: string
        ein:
          type: string
    CreateOrUpdateFundTransferConfigRequest:
      type: object
      properties:
        locations:
          type: array
          items:
            $ref: '#/components/schemas/FundTransferLocationConfig'
        active:
          type: boolean
    FundTransferLocationConfig:
      type: object
      properties:
        locationId:
          type: string
        active:
          type: boolean
    FundTransferConfigResponse:
      type: object
      properties:
        clientId:
          type: string
        frequency:
          type: string
        locations:
          type: array
          items:
            $ref: '#/components/schemas/FundTransferLocationConfig'
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        active:
          type: boolean
    RetrieveClientTokenResponse:
      type: object
      properties:
        token:
          type: string
    ACHDocument:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        type:
          $ref: '#/components/schemas/TypeEnum'
        created:
          type: string
          format: date-time
        failureReason:
          type: string
        allFailureReasons:
          type: array
          items:
            type: object
            additionalProperties:
              type: string
    ACHFundingAccount:
      type: object
      properties:
        id:
          type: string
        externalId:
          type: string
        externalURL:
          type: string
        bankAccountType:
          $ref: '#/components/schemas/BankAccountTypeEnum'
        accountNickName:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        deleted:
          type: boolean
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        fingerprint:
          type: string
    ACHLocationDTO:
      type: object
      properties:
        locationId:
          type: string
        locationName:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        externalId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phone:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        ipAddress:
          type: string
        businessName:
          type: string
        businessType:
          type: string
        businessClassification:
          type: string
        fundingAccount:
          $ref: '#/components/schemas/ACHFundingAccount'
        type:
          $ref: '#/components/schemas/TypeEnum'
        status:
          $ref: '#/components/schemas/StatusEnum'
        acceptedTOSAndPP:
          type: boolean
        achLocationDocuments:
          type: array
          items:
            $ref: '#/components/schemas/ACHDocument'
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        controller:
          $ref: '#/components/schemas/BusinessController'
        copiedFromLocationId:
          type: string
        sharedCustomer:
          type: boolean
        sharedFundingSource:
          type: boolean
        fundTransferEnabled:
          type: boolean
        overallStatus:
          type: string
    BankAccountTypeEnum:
      type: string
      enum:
      - CHECKING
      - SAVINGS
    BusinessController:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        title:
          type: string
        dateOfBirth:
          type: string
        address:
          $ref: '#/components/schemas/Address'
    RetrieveAchLocationListResponse:
      type: object
      properties:
        locationList:
          type: array
          items:
            $ref: '#/components/schemas/ACHLocationDTO'
    TypeEnum:
      type: string
      enum:
      - PASSPORT
      - LICENSE
      - ID_CARD
      - OTHER
    UpdateLocationStatusRequest:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/StatusEnum'
    VerifyMicroDepositsRequest:
      type: object
      properties:
        amount1:
          type: string
        amount2:
          type: string
    CopyCustomerAndAccountRequest:
      type: object
      properties:
        fromLocationId:
          type: string
        toLocationIds:
          type: array
          items:
            type: string
          uniqueItems: true
    CreatePaymentGatewayRequest:
      type: object
      properties:
        gatewayDescription:
          type: string
        spreedlyEnvironmentKey:
          type: string
        sandbox:
          type: boolean
        type:
          type: string
    CreatePaymentGatewayResponse:
      type: object
      properties:
        gatewayToken:
          type: string
    CreateEnvironmentRequest:
      type: object
      properties:
        name:
          type: string
      required:
      - name
    CreateEnvironmentResponse:
      type: object
      properties:
        key:
          type: string
        signingSecret:
          type: string
        organizationKey:
          type: string
        callbackUrl:
          type: string
        smartRoutingEnabled:
          type: boolean
        allowDirectApiPaymentMethodCreation:
          type: boolean
        name:
          type: string
        defaultGatewayToken:
          type: string
        paymentMethodManagementEnabled:
          type: boolean
        auEnabled:
          type: boolean
        retry:
          type: boolean
        iframeEnhancedSecurityEnabled:
          type: boolean
        certificateToken:
          type: string
    CreateClientTemplateRequestDTO:
      type: object
      properties:
        name:
          type: string
        jsonTemplate:
          type: string
        htmlTemplate:
          type: string
        fromAddress:
          type: string
        bcc:
          type: string
        subject:
          type: string
        eventType:
          $ref: '#/components/schemas/EventType'
        emailTemplateType:
          $ref: '#/components/schemas/ClientEmailTemplateType'
        reusable:
          type: boolean
    ReachStringDTO:
      type: object
      properties:
        reach:
          type: string
    GlobalResetPasswordRequestDTO:
      type: object
      properties:
        email:
          type: string
        password:
          type: string
    CreateStoreRequestDTO:
      type: object
      properties:
        title:
          type: string
        regionId:
          type: string
        address:
          $ref: '#/components/schemas/AddressDTO'
        phoneNumber:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        storeType:
          type: string
        beaconId:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/StoreDisplayInfo'
          uniqueItems: true
        isCatering:
          type: boolean
        isMenuBrowsing:
          type: boolean
        viewOnlyLocationEnabled:
          type: boolean
        isTest:
          type: boolean
      required:
      - title
    CreateStoreResponseDTO:
      type: object
      properties:
        storeId:
          type: string
    CreateRoleRequestDTO:
      type: object
      properties:
        role:
          type: string
        description:
          type: string
        modules:
          type: array
          items:
            $ref: '#/components/schemas/ModuleDTO'
        active:
          type: boolean
        deleted:
          type: boolean
      required:
      - modules
      - role
    CreateRoleResponseDTO:
      type: object
      properties:
        id:
          type: string
    CreateAdminUserResponseDTO:
      type: object
      properties:
        adminId:
          type: string
        email:
          type: string
        clientID:
          type: string
        firstName:
          type: string
        lastName:
          type: string
    UpdatePasswordRequestDTO:
      type: object
      properties:
        oldPassword:
          type: string
        newPassword:
          type: string
      required:
      - newPassword
      - oldPassword
    ResetAdminPasswordRequestDTO:
      type: object
      properties:
        password:
          type: string
    RequestPasswordResetRequestDTO:
      type: object
      properties:
        email:
          type: string
    AdminLoginRequestDTO:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
        rememberme:
          type: boolean
      required:
      - password
      - username
    AdminLoginResponseDTO:
      type: object
      properties:
        accountId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        createdDate:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        role:
          $ref: '#/components/schemas/RoleDTO'
    RoleDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        role:
          type: string
        description:
          type: string
        modules:
          type: array
          items:
            $ref: '#/components/schemas/ModuleDTO'
        active:
          type: boolean
        deleted:
          type: boolean
    DomainValidateDnsResDto:
      type: object
      properties:
        valid:
          type: string
        reason:
          type: string
    DomainValidateResDto:
      type: object
      properties:
        id:
          type: string
        valid:
          type: boolean
        validation_results:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DomainValidateDnsResDto'
    CreateSegmentResponseDTO:
      type: object
      properties:
        segmentId:
          type: string
        segmentName:
          type: string
    MarkMenuImportFailedRequest:
      type: object
      properties:
        requestId:
          type: string
        user:
          type: string
      required:
      - requestId
      - user
    DynamicEnvDTO:
      type: object
      properties:
        environmentName:
          type: string
        baseUrl:
          type: string
        environmentDescription:
          type: string
    CatalogDTO:
      type: object
      properties:
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        clientId:
          type: string
          deprecated: true
        createdDate:
          type: string
          deprecated: true
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        displayRank:
          type: integer
          format: int32
        externalId:
          type: string
        extTargetingId:
          type: string
        groupExternalIds:
          type: array
          items:
            type: string
          uniqueItems: true
        id:
          type: string
        merchantId:
          type: string
          deprecated: true
        override:
          $ref: '#/components/schemas/MenuOverride'
        status:
          $ref: '#/components/schemas/Status'
        storeIds:
          type: array
          items:
            type: string
        title:
          type: string
        updatedDate:
          type: string
          deprecated: true
    ConnectorErrorStatus:
      type: string
      enum:
      - REQUEST_ID_NOT_FOUND
    ConnectorImportedMenuResponse:
      type: object
      properties:
        clientId:
          type: string
        connectorErrorStatus:
          $ref: '#/components/schemas/ConnectorErrorStatus'
        connectorMenuResponse:
          $ref: '#/components/schemas/ConnectorMenuResponse'
        connectorName:
          type: string
        externalLocationId:
          type: string
        failureDescription:
          type: string
        httpStatus:
          $ref: '#/components/schemas/HttpStatus'
        locationId:
          type: string
        menuDownloadCompletedTime:
          type: string
          format: date-time
        menuDownloadStartedTime:
          type: string
          format: date-time
        menuDownloadStatus:
          $ref: '#/components/schemas/MenuImportProgressStatus'
        merchantId:
          type: string
        requestId:
          type: string
    ConnectorMenuResponse:
      type: object
      properties:
        connectorCatalogDTOMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CatalogDTO'
        connectorGroupDTOMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/GroupDTO'
        connectorItemDTOMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ItemDTO'
    GroupDTO:
      type: object
      properties:
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        clientId:
          type: string
          deprecated: true
        createdDate:
          type: string
          deprecated: true
        defaultSelectedItemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        displayRank:
          type: integer
          format: int32
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        externalId:
          type: string
        extTargetingId:
          type: string
        groupItemSettings:
          type: array
          items:
            $ref: '#/components/schemas/GroupItemSetting'
          uniqueItems: true
        groupType:
          $ref: '#/components/schemas/GroupType'
        id:
          type: string
        includedQuantity:
          type: integer
          format: int32
        inheritParentOptions:
          type: boolean
        itemExternalIds:
          type: array
          items:
            type: string
          uniqueItems: true
        mandatoryItemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        maxItemSelections:
          type: integer
          format: int32
        merchantId:
          type: string
          deprecated: true
        minItemSelections:
          type: integer
          format: int32
        optionGroupsExternalIds:
          type: array
          items:
            type: string
          uniqueItems: true
        override:
          $ref: '#/components/schemas/MenuOverride'
        priceSubstitutionType:
          $ref: '#/components/schemas/PriceSubstitutionType'
        selectionMandatory:
          type: boolean
        selectionType:
          $ref: '#/components/schemas/SelectionType'
        status:
          $ref: '#/components/schemas/Status'
        storeIds:
          type: array
          items:
            type: string
        subGroupsExternalIds:
          type: array
          items:
            type: string
          uniqueItems: true
        title:
          type: string
        updatedDate:
          type: string
          deprecated: true
    HttpStatus:
      type: string
      enum:
      - CONTINUE
      - SWITCHING_PROTOCOLS
      - PROCESSING
      - EARLY_HINTS
      - CHECKPOINT
      - OK
      - CREATED
      - ACCEPTED
      - NON_AUTHORITATIVE_INFORMATION
      - NO_CONTENT
      - RESET_CONTENT
      - PARTIAL_CONTENT
      - MULTI_STATUS
      - ALREADY_REPORTED
      - IM_USED
      - MULTIPLE_CHOICES
      - MOVED_PERMANENTLY
      - FOUND
      - MOVED_TEMPORARILY
      - SEE_OTHER
      - NOT_MODIFIED
      - USE_PROXY
      - TEMPORARY_REDIRECT
      - PERMANENT_REDIRECT
      - BAD_REQUEST
      - UNAUTHORIZED
      - PAYMENT_REQUIRED
      - FORBIDDEN
      - NOT_FOUND
      - METHOD_NOT_ALLOWED
      - NOT_ACCEPTABLE
      - PROXY_AUTHENTICATION_REQUIRED
      - REQUEST_TIMEOUT
      - CONFLICT
      - GONE
      - LENGTH_REQUIRED
      - PRECONDITION_FAILED
      - PAYLOAD_TOO_LARGE
      - REQUEST_ENTITY_TOO_LARGE
      - URI_TOO_LONG
      - REQUEST_URI_TOO_LONG
      - UNSUPPORTED_MEDIA_TYPE
      - REQUESTED_RANGE_NOT_SATISFIABLE
      - EXPECTATION_FAILED
      - I_AM_A_TEAPOT
      - INSUFFICIENT_SPACE_ON_RESOURCE
      - METHOD_FAILURE
      - DESTINATION_LOCKED
      - UNPROCESSABLE_ENTITY
      - LOCKED
      - FAILED_DEPENDENCY
      - TOO_EARLY
      - UPGRADE_REQUIRED
      - PRECONDITION_REQUIRED
      - TOO_MANY_REQUESTS
      - REQUEST_HEADER_FIELDS_TOO_LARGE
      - UNAVAILABLE_FOR_LEGAL_REASONS
      - INTERNAL_SERVER_ERROR
      - NOT_IMPLEMENTED
      - BAD_GATEWAY
      - SERVICE_UNAVAILABLE
      - GATEWAY_TIMEOUT
      - HTTP_VERSION_NOT_SUPPORTED
      - VARIANT_ALSO_NEGOTIATES
      - INSUFFICIENT_STORAGE
      - LOOP_DETECTED
      - BANDWIDTH_LIMIT_EXCEEDED
      - NOT_EXTENDED
      - NETWORK_AUTHENTICATION_REQUIRED
    ItemDTO:
      type: object
      properties:
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        brandId:
          type: string
        calories:
          type: number
          format: double
        categoryId:
          type: string
        clientId:
          type: string
          deprecated: true
        createdDate:
          type: string
          deprecated: true
        discounts:
          type: array
          items:
            $ref: '#/components/schemas/Discount'
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        displayRank:
          type: integer
          format: int32
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        externalId:
          type: string
        extTargetingId:
          type: string
        inheritParentOptions:
          type: boolean
        isTaxable:
          type: boolean
        itemId:
          type: string
        itemType:
          $ref: '#/components/schemas/ItemType'
        maxItemSelections:
          type: integer
          format: int32
        maxQuantity:
          type: integer
          format: int32
        merchantId:
          type: string
          deprecated: true
        minQuantity:
          type: integer
          format: int32
        optionGroupExternalIds:
          type: array
          items:
            type: string
          uniqueItems: true
        optionGroupSettings:
          type: array
          items:
            $ref: '#/components/schemas/OptionGroupSetting'
          uniqueItems: true
        orderingChannels:
          type: array
          items:
            $ref: '#/components/schemas/OrderingChannels'
        outOfStock:
          type: boolean
        price:
          type: integer
          format: int32
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        sku:
          type: string
          deprecated: true
        status:
          $ref: '#/components/schemas/Status'
        storeIds:
          type: array
          items:
            type: string
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxInfo'
        title:
          type: string
        unformattedPrice:
          type: number
        unformattedPriceWithTax:
          type: number
        uom:
          type: string
          deprecated: true
        upc:
          type: string
          deprecated: true
        updatedDate:
          type: string
          deprecated: true
    MenuImportProgressStatus:
      type: string
      enum:
      - COMPLETED
      - FAILED
      - IN_PROGRESS
      - NEW
      - PUBLISHING_FAILED
    OptionGroupSetting:
      type: object
      properties:
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        defaultSelectedItemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        displayRank:
          type: integer
          format: int32
        externalOptionGroupId:
          type: string
        inheritGroupSettings:
          type: boolean
        itemIdsAreMongoMapped:
          type: boolean
        mandatoryItemIds:
          type: array
          items:
            type: string
          uniqueItems: true
        maxItemSelections:
          type: integer
          format: int32
        minItemSelections:
          type: integer
          format: int32
        optionGroupId:
          type: string
        selectionMandatory:
          type: boolean
        selectionType:
          $ref: '#/components/schemas/SelectionType'
    PriceSubstitutionType:
      type: string
      enum:
      - DIFFERENCE_ANY
      - DIFFERENCE_DECREASE
      - DIFFERENCE_INCREASE
      - EXTERNAL
      - FULL_PRICE
      - NO_CHARGE
    TaxInfo:
      type: object
      properties:
        amount:
          type: number
          format: double
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extTaxId:
          type: string
        id:
          type: string
        percentage:
          type: number
          format: double
        taxDescription:
          type: string
        taxType:
          $ref: '#/components/schemas/TaxType'
    TaxType:
      type: string
      enum:
      - AMOUNT
      - OPEN
      - PERCENTAGE
    Operation:
      type: string
      enum:
      - TEST
      - REMOVE
      - ADD
      - REPLACE
      - MOVE
      - COPY
    UserAccountPatchRequestDto:
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Operation'
        attribute:
          type: string
        value:
          type: string
    PatchRequestDTO:
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Operation'
        path:
          type: string
        value:
          type: string
    PatchLocationRequestDTO:
      type: object
      properties:
        merchantId:
          type: string
        patchData:
          type: array
          items:
            $ref: '#/components/schemas/PatchRequestDTO'
    PatchLocationOrderSettingsRequestDTO:
      type: object
      properties:
        locationOrderingSettingsType:
          type: string
        updateLocationRequestDTO:
          $ref: '#/components/schemas/UpdateLocationRequestDTO'
    BulkUpdateRequest:
      type: object
      properties:
        field:
          type: string
        ids:
          type: array
          items:
            type: string
        value: {}
      required:
      - field
      - ids
      - value
    UpdatePoolAccountFundTransferConfigRequest:
      type: object
      properties:
        active:
          type: boolean
    UpdateLocationFundTransferConfigRequest:
      type: object
      properties:
        locationId:
          type: string
        active:
          type: boolean
    ConnectorViewExternalLocationCatalogsResponseDTO:
      type: object
      properties:
        externalLocationId:
          type: string
        catalogs:
          type: array
          items:
            $ref: '#/components/schemas/ExternalLocationCatalogDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
        message:
          type: string
    ExternalLocationCatalogDTO:
      type: object
      properties:
        catalogId:
          type: string
        title:
          type: string
    ScanToPaySalesSummary:
      type: object
      properties:
        id:
          type: string
        transactionCount:
          type: integer
          format: int32
        orderTotal:
          type: integer
          format: int64
        tipTotal:
          type: integer
          format: int64
        finalTotal:
          type: integer
          format: int64
    ScanToPaySalesSummaryResponse:
      type: object
      properties:
        salesSummary:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ScanToPaySalesSummary'
    UserAccountChangeLogResponseDTO:
      type: object
      properties:
        adminUserName:
          type: string
        description:
          type: string
        actionType:
          type: string
        changedDateTime:
          type: string
          format: date-time
    TagsAndRulesResponseDTO:
      type: object
      properties:
        tagAndRuleDTOS:
          type: array
          items:
            $ref: '#/components/schemas/TagAndRuleDTO'
    CustomerTagAndRulesWithPagingForAdminDTO:
      type: object
      properties:
        tagAndRuleDTOS:
          type: array
          items:
            $ref: '#/components/schemas/TagAndRuleDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    FindUserResponseDTO:
      type: object
      properties:
        resultsPaging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserAccountDTO'
    Gender:
      type: string
      enum:
      - MALE
      - FEMALE
    ResultsPagingDTO:
      type: object
      properties:
        total:
          type: integer
          format: int64
        count:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int64
        currentPage:
          type: integer
          format: int32
    UserAccountDTO:
      type: object
      properties:
        userId:
          type: string
        clientId:
          type: string
        email:
          type: string
        gender:
          $ref: '#/components/schemas/Gender'
        dateOfBirth:
          type: string
          format: date-time
        phoneNumber:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        baseLanguagePrefrerence:
          type: string
        aliasId:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        blocked:
          type: boolean
        reopened:
          type: boolean
        linked:
          type: boolean
    FindUserAccountResponseDTO:
      type: object
      properties:
        userId:
          type: string
        mergedPrimaryUserAccountId:
          type: string
        household:
          $ref: '#/components/schemas/HouseholdDTO'
        address:
          $ref: '#/components/schemas/Address'
        clientId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phoneNumber:
          type: string
        externalId:
          type: string
        baseLanguagePrefrerence:
          type: string
        status:
          $ref: '#/components/schemas/Status'
        howAcquired:
          type: string
        gender:
          $ref: '#/components/schemas/Gender'
        dateOfBirth:
          type: string
        accountAliasId:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        emailBounced:
          type: boolean
        createdDate:
          type: string
          format: date-time
        userProfileImageUrl:
          type: string
        blocked:
          type: boolean
        reopened:
          type: boolean
        linked:
          type: boolean
    HouseholdDTO:
      type: object
      properties:
        shortDescription:
          type: string
        longDescription:
          type: string
    AppliedCharge:
      type: object
      properties:
        chargeId:
          type: string
        extChargeId:
          type: string
        chargeDescription:
          type: string
        chargeType:
          type: string
        appliedCharge:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        taxable:
          type: boolean
        gratuity:
          type: boolean
        delivery:
          type: boolean
        appliedTax:
          type: array
          items:
            $ref: '#/components/schemas/AppliedTax'
    AppliedDiscount:
      type: object
      properties:
        offerId:
          type: string
        extOfferId:
          type: string
        distributedOfferId:
          type: string
        offerCode:
          type: string
        name:
          type: string
        discountType:
          type: string
        appliedDiscount:
          type: integer
          format: int32
        additionalAttribs:
          type: object
          additionalProperties:
            type: string
    AppliedTax:
      type: object
      properties:
        taxId:
          type: string
        taxDescription:
          type: string
        taxType:
          type: string
        amount:
          type: integer
          format: int32
        percentage:
          type: number
          format: float
        appliedTax:
          type: integer
          format: int32
    Check:
      type: object
      properties:
        checkId:
          type: string
        openedDate:
          type: string
          format: date-time
        closedDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        deletedDate:
          type: string
          format: date-time
        deleted:
          type: boolean
        displayNumber:
          type: string
        orderItems:
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
        appliedCharges:
          type: array
          items:
            $ref: '#/components/schemas/AppliedCharge'
        appliedDiscounts:
          type: array
          items:
            $ref: '#/components/schemas/AppliedDiscount'
        total:
          $ref: '#/components/schemas/Total'
        paymentStatus:
          type: string
        voided:
          type: boolean
        voidInfo:
          $ref: '#/components/schemas/VoidInfo'
        customer:
          $ref: '#/components/schemas/Customer'
        loyaltyStatus:
          $ref: '#/components/schemas/LoyaltyStatus'
        loyaltyStatusModifiedTime:
          type: string
          format: date-time
        loyaltyUnSuccessfulReason:
          $ref: '#/components/schemas/LoyaltyUnSuccessfulReason'
        loyaltyUnSuccessfulAdditionalInfo:
          type: string
        customerResolved:
          type: boolean
    Customer:
      type: object
      properties:
        incentivioId:
          type: string
        extId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phoneNo:
          type: string
    FindTransactionsResponseDTO:
      type: object
      properties:
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/TransactionDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    LoyaltyStatus:
      type: string
      enum:
      - SUCCESS
      - FAILED
      - IGNORED
      - NOT_PROCESSED
    LoyaltyUnSuccessfulReason:
      type: string
      enum:
      - CHECKS_NOT_FOUND
      - CUSTOMER_NULL
      - TOTAL_NULL
      - EMAIL_AND_PHONE_NUMBER_NULL
      - USER_ACCOUNT_NOT_FOUND
      - ZERO_SUB_TOTAL
      - EXCEPTION_ON_CUSTOMER_LOOKUP
      - EXCEPTION_ON_ADDING_LOYALTY_POINTS
      - DUPLICATE_USER_FOUND_FOR_PHONE_NUMBER
      - EXT_USER_ID_NULL
      - DUPLICATE_USER_FOUND_FOR_USER_LOOKUP_MODE
      - NO_LOOKUP_DETAIL_FOUND_FOR_LOOKUP
      - EXT_USERID_IS_REQUIRED
      - EMAIL_OR_PHONE_NUMBER_IS_REQUIRED
      - CHECKNAME_EMAIL_OR_PHONE_NUMBER_IS_REQUIRED
      - VOIDED_CHECK
      - EXTUSERID_EMAIL_AND_PHONE_NUMBER_NULL
      - OPEN_CHECK
      - ZERO_SUB_TOTAL_WITHOUT_EXCLUDED_PRODUCTS
    OrderItem:
      type: object
      properties:
        orderItemId:
          type: string
        itemId:
          type: string
        extItemId:
          type: string
        itemName:
          type: string
        displayName:
          type: string
        instructions:
          type: string
        sku:
          type: string
        upc:
          type: string
        catalogId:
          type: string
        extCatalogId:
          type: string
        groupId:
          type: string
        extGroupId:
          type: string
        brandId:
          type: string
        extBrandId:
          type: string
        categoryId:
          type: string
        extCategoryId:
          type: string
        uom:
          type: string
        unitPrice:
          type: integer
          format: int32
        quantity:
          type: integer
          format: int32
        appliedDiscounts:
          type: array
          items:
            $ref: '#/components/schemas/AppliedDiscount'
        appliedTax:
          type: array
          items:
            $ref: '#/components/schemas/AppliedTax'
        preDiscountItemTotal:
          type: integer
          format: int32
        dicountTotal:
          type: integer
          format: int32
        taxTotal:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        voided:
          type: boolean
        voidInfo:
          $ref: '#/components/schemas/VoidInfo'
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        notes:
          type: string
    Payment:
      type: object
      properties:
        amount:
          type: integer
          format: int32
        gratuity:
          type: integer
          format: int32
        tenderType:
          type: string
        cardType:
          type: string
        last4:
          type: string
        paymentStatus:
          type: string
        voided:
          type: boolean
        voidInfo:
          $ref: '#/components/schemas/VoidInfo'
        refundStatus:
          type: string
        refund:
          $ref: '#/components/schemas/Refund'
    Refund:
      type: object
      properties:
        refundAmount:
          type: integer
          format: int32
        tipRefundAmount:
          type: integer
          format: int32
        refundDate:
          type: string
          format: date-time
        refundBusinessDate:
          type: string
          format: date
    Total:
      type: object
      properties:
        itemTotal:
          type: integer
          format: int32
        gratuity:
          type: integer
          format: int32
        tax:
          type: integer
          format: int32
        taxedChargeTotal:
          type: integer
          format: int32
        nonTaxedChargeTotal:
          type: integer
          format: int32
        dicountTotal:
          type: integer
          format: int32
        subTotal:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        paid:
          type: integer
          format: int32
        due:
          type: integer
          format: int32
        processingFee:
          type: integer
          format: int32
    TransactionDTO:
      type: object
      properties:
        id:
          type: string
        extTxId:
          type: string
        importBatchId:
          type: string
        displayNumber:
          type: string
        businessDate:
          type: string
        txDateTime:
          type: string
          format: date-time
        openedDate:
          type: string
          format: date-time
        closedDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        fullFilDate:
          type: string
          format: date-time
        deleted:
          type: boolean
        deletedDate:
          type: string
          format: date-time
        txZoneId:
          type: string
        importedDate:
          type: string
          format: date-time
        transactionType:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        storeId:
          type: string
        storeName:
          type: string
        extStoreId:
          type: string
        customerId:
          type: string
        extCustId:
          type: string
        loyaltyId:
          type: string
        extLoyaltyId:
          type: string
        loyaltyNumber:
          type: string
        posId:
          type: string
        laneId:
          type: string
        employeeId:
          type: string
        employeeName:
          type: string
        appliedDiscounts:
          type: array
          items:
            $ref: '#/components/schemas/AppliedDiscount'
        checks:
          type: array
          items:
            $ref: '#/components/schemas/Check'
        loyaltyPoints:
          type: number
          format: double
        total:
          $ref: '#/components/schemas/Total'
        paymentStatus:
          type: string
        voided:
          type: boolean
        voidInfo:
          $ref: '#/components/schemas/VoidInfo'
        refundStatus:
          type: string
        refund:
          $ref: '#/components/schemas/Refund'
        source:
          type: string
        extendedAttribs:
          type: object
          additionalProperties:
            type: string
        loyaltyStatus:
          $ref: '#/components/schemas/LoyaltyStatus'
        loyaltyStatusModifiedTime:
          type: string
          format: date-time
        txCreatedDate:
          type: string
          format: date-time
        txModifiedDate:
          type: string
          format: date-time
    VoidInfo:
      type: object
      properties:
        voidDate:
          type: string
          format: date-time
        voidBusinessDate:
          type: string
          format: date
        voidReason:
          type: string
    PulseDateRange:
      type: object
      properties:
        startdate:
          type: string
          format: date
        enddate:
          type: string
          format: date
        comparisonstartdate:
          type: string
          format: date
        comparisonenddate:
          type: string
          format: date
    PulsePieGraph:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PulsePieGraphEntry'
    PulsePieGraphEntry:
      type: object
      properties:
        label:
          type: string
        value:
          type: number
    PaginationRequest:
      type: object
      properties:
        page:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
    SortingRequest:
      type: object
      properties:
        sortBy:
          type: string
        sortDirection:
          type: string
    EmailDataDTO:
      type: object
      properties:
        id:
          type: string
        offerId:
          type: string
        messageId:
          type: string
        offerTitle:
          type: string
        messageTitle:
          type: string
        campaignId:
          type: string
        dateSent:
          type: string
        emailType:
          type: string
        emailTypeDisplay:
          type: string
        sent:
          type: string
        delivered:
          type: string
        deliveryRate:
          type: string
        openRate:
          type: string
        clickRate:
          type: string
        bounceRate:
          type: string
        unsubscribeRate:
          type: string
        spamReportRate:
          type: string
        emailsBounced:
          type: string
        emailsDropped:
          type: string
        emailsDeferred:
          type: string
        uniqueEmailsDeferred:
          type: string
        emailsOpened:
          type: string
        uniqueOpens:
          type: string
        clicks:
          type: string
        uniqueClicks:
          type: string
        clickThroughRate:
          type: string
        unsubscribes:
          type: string
        spamReports:
          type: string
    PulseDataGridWithTotalEmailDataDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingDTO'
        data:
          type: array
          items:
            $ref: '#/components/schemas/EmailDataDTO'
        total:
          $ref: '#/components/schemas/EmailDataDTO'
    CardTypeEnum:
      type: string
      enum:
      - number
      - percent
      - currency
    EmailCardsDTO:
      type: object
      properties:
        emailsSent:
          $ref: '#/components/schemas/PulseSummaryCard'
        emailsDelivered:
          $ref: '#/components/schemas/PulseSummaryCard'
        openRate:
          $ref: '#/components/schemas/PulseSummaryCard'
        clickRate:
          $ref: '#/components/schemas/PulseSummaryCard'
        unsubscribeRate:
          $ref: '#/components/schemas/PulseSummaryCard'
        spamReportRate:
          $ref: '#/components/schemas/PulseSummaryCard'
    PulseSummaryCard:
      type: object
      properties:
        value:
          type: number
        comparisonNumber:
          type: number
        sparkLineData:
          type: array
          items:
            type: number
        cardType:
          $ref: '#/components/schemas/CardTypeEnum'
    PulseTimeSeries:
      type: object
      properties:
        series:
          type: array
          items:
            $ref: '#/components/schemas/PulseTimeSeriesEntry'
        xlabels:
          type: array
          items:
            type: string
    PulseTimeSeriesEntry:
      type: object
      properties:
        label:
          type: string
        data:
          type: array
          items:
            type: number
    EmailPulseOfferDTO:
      type: object
      properties:
        offerId:
          type: string
        title:
          type: string
    EmailPulseMessageDTO:
      type: object
      properties:
        messageId:
          type: string
        title:
          type: string
    LocationDetail:
      type: object
      properties:
        locationId:
          type: string
        locationName:
          type: string
    MenuIntelligenceLocation:
      type: object
      properties:
        clientId:
          type: string
        jobId:
          type: integer
          format: int32
        createdDate:
          type: string
          format: date-time
        locationDetails:
          type: array
          items:
            $ref: '#/components/schemas/LocationDetail'
      required:
      - createdDate
      - locationDetails
    DoubleMetricDetail:
      type: object
      properties:
        all:
          type: number
          format: double
        good:
          type: number
          format: double
        bad:
          type: number
          format: double
    IntegerMetricDetail:
      type: object
      properties:
        all:
          type: integer
          format: int32
        good:
          type: integer
          format: int32
        bad:
          type: integer
          format: int32
    MenuIntelligenceItemGeneralMetrics:
      type: object
      properties:
        id:
          type: string
        jobId:
          type: integer
          format: int32
        itemId:
          type: string
        createdDate:
          type: string
          format: date-time
        clientId:
          type: string
        itemName:
          type: string
        itemPrice:
          type: number
          format: float
        groupNames:
          type: array
          items:
            type: string
        groupTypes:
          type: array
          items:
            type: string
        locationId:
          type: string
        totalVolumeSold:
          $ref: '#/components/schemas/IntegerMetricDetail'
        volumeSoldLastMonth:
          $ref: '#/components/schemas/IntegerMetricDetail'
        volumeSoldPerMonth:
          $ref: '#/components/schemas/DoubleMetricDetail'
        volumeSoldBreakfast:
          $ref: '#/components/schemas/IntegerMetricDetail'
        volumeSoldLunch:
          $ref: '#/components/schemas/IntegerMetricDetail'
        volumeSoldDinner:
          $ref: '#/components/schemas/IntegerMetricDetail'
        customerPercentage:
          $ref: '#/components/schemas/DoubleMetricDetail'
        avgOrdersPerMonth:
          $ref: '#/components/schemas/DoubleMetricDetail'
        revenueGenerated:
          $ref: '#/components/schemas/DoubleMetricDetail'
        indexMetricOverUnderIndexValue:
          type: number
          format: double
        indexMetricOverUnderState:
          type: string
        itemScore:
          type: number
          format: double
        itemImageUrl:
          type: string
      required:
      - clientId
      - createdDate
      - itemName
      - itemPrice
      - itemScore
    MenuIntelligenceItemMetricsResponseDTO:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/MenuIntelligenceItemGeneralMetrics'
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
    GroupDetail:
      type: object
      properties:
        groupName:
          type: string
    MenuIntelligenceGroup:
      type: object
      properties:
        clientId:
          type: string
        jobId:
          type: integer
          format: int32
        createdDate:
          type: string
          format: date-time
        groupDetails:
          type: array
          items:
            $ref: '#/components/schemas/GroupDetail'
      required:
      - createdDate
      - groupDetails
    LoyaltyReportDateRange:
      type: object
      properties:
        startdate:
          type: string
          format: date
        enddate:
          type: string
          format: date
        comparisonstartdate:
          type: string
          format: date
        comparisonenddate:
          type: string
          format: date
    LoyaltyReportPaginationRequest:
      type: object
      properties:
        page:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
    LoyaltyReportDataGridOfferTrendsPageDisplayDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        offers:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyReportDataGridTrendOfferDisplay'
        total:
          type: array
          items:
            type: string
    LoyaltyReportDataGridTrendOfferDisplay:
      type: object
      properties:
        offerId:
          type: string
        displayInfoTitle:
          type: string
        data:
          type: array
          items:
            type: string
    LoyaltyReportLineGraphEntry:
      type: object
      properties:
        label:
          type: string
        data:
          type: array
          items:
            type: number
    LoyaltyReportOfferTrendsResponse:
      type: object
      properties:
        dataGrid:
          $ref: '#/components/schemas/LoyaltyReportDataGridOfferTrendsPageDisplayDTO'
        lineChart:
          $ref: '#/components/schemas/LoyaltyReportTimeSeriesDTO'
    LoyaltyReportTimeSeriesDTO:
      type: object
      properties:
        series:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyReportLineGraphEntry'
        xlabels:
          type: array
          items:
            type: string
    LoyaltyReportPerformanceDTO:
      type: object
      properties:
        loyaltyEarnOrders:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        loyaltyBurnOrders:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        loyaltyOrdersNetSales:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        discountAmount:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        activeMembers:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
    LoyaltyReportSummaryCard:
      type: object
      properties:
        value:
          type: number
        comparisonNumber:
          type: number
        sparkLineData:
          type: array
          items:
            type: number
        cardType:
          $ref: '#/components/schemas/CardTypeEnum'
    SortingDto:
      type: object
      properties:
        sortBy:
          type: string
        sortDirection:
          type: string
    LoyaltyReportDataGridOfferPerformanceDisplay:
      type: object
      properties:
        offerId:
          type: string
        displayInfoTitle:
          type: string
        newMembers:
          type: string
        totalMembers:
          type: string
        deletedAccounts:
          type: string
        activeMembers:
          type: string
        activeMemberPercent:
          type: string
        totalOrders:
          type: string
        loyaltyEarnOrders:
          type: string
        loyaltyBurnOrders:
          type: string
        loyaltyNetZeroOrders:
          type: string
        totalLoyaltyOrders:
          type: string
        loyaltyContribution:
          type: string
        allOrdersNetSales:
          type: string
        loyaltyOrdersNetSales:
          type: string
        loyaltySales:
          type: string
        discountAmount:
          type: string
        loyaltyContributionSalesPercent:
          type: string
        loyaltyContributionOrdersPercent:
          type: string
        loyaltyAverageCheck:
          type: string
        mobileLoyaltyOrders:
          type: string
        mobileLoyaltyOrdersPercent:
          type: string
        webLoyaltyOrders:
          type: string
        webLoyaltyOrdersPercent:
          type: string
        scan2PayOrders:
          type: string
        scan2PayOrdersPercent:
          type: string
        inStoreLoyaltyOrders:
          type: string
        inStoreLoyaltyOrdersPercent:
          type: string
        otherLoyaltyOrders:
          type: string
        otherLoyaltyOrdersPercent:
          type: string
        bonusEarnEvents:
          type: string
        uniqueUserScan2Pay:
          type: string
        uniqueUserWeb:
          type: string
        uniqueUserApp:
          type: string
        uniqueUserInStore:
          type: string
        uniqueUserOther:
          type: string
        currentStatus:
          type: string
        offerType:
          type: string
        distributionMethod:
          type: string
        distributionEndDateType:
          type: string
        redemptionEndDateType:
          type: string
        redemptionEndTime:
          type: string
        redemptionDateRangeStart:
          type: string
          format: date-time
        redemptionDateRangeEnd:
          type: string
          format: date-time
        distributionDateRangeStart:
          type: string
          format: date-time
        distributionDateRangeEnd:
          type: string
          format: date-time
        redemptionDateRange:
          type: string
        distributionDateRange:
          type: string
        averageDaysToRedeem:
          type: string
        distributionsAllTime:
          type: string
        distributionsSelectedTimePeriod:
          type: string
        redemptionsCurrent:
          type: string
        redemptionsAllTimeDistributions:
          type: string
        redemptionsSelectedTimePeriodDistributions:
          type: string
        redemptionRateAllTime:
          type: string
        redemptionRateDistributedAndRedeemedInPeriod:
          type: string
        redemptionRateDistributedAllTimeRedeemedInPeriod:
          type: string
        uniqueUserDistributionsSelectedTimePeriod:
          type: string
        uniqueUserOpened:
          type: string
        totalOpened:
          type: string
        uniqueUserDeleted:
          type: string
        totalDeleted:
          type: string
        uniqueUserSaved:
          type: string
        totalSaved:
          type: string
        averageDiscount:
          type: string
    LoyaltyReportDataGridOffersPageDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        offers:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyReportDataGridOfferPerformanceDisplay'
        total:
          $ref: '#/components/schemas/LoyaltyReportDataGridOfferPerformanceDisplay'
    LoyaltyReportDataGridLocationTrendsPageDisplayDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        stores:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyReportDataGridTrendLocationDisplay'
        total:
          type: array
          items:
            type: string
    LoyaltyReportDataGridTrendLocationDisplay:
      type: object
      properties:
        storeId:
          type: string
        displayInfoTitle:
          type: string
        data:
          type: array
          items:
            type: string
    LoyaltyReportLocationTrendsResponse:
      type: object
      properties:
        dataGrid:
          $ref: '#/components/schemas/LoyaltyReportDataGridLocationTrendsPageDisplayDTO'
        lineChart:
          $ref: '#/components/schemas/LoyaltyReportTimeSeriesDTO'
    LoyaltyReportDataGridLocationPerformanceDisplay:
      type: object
      properties:
        locationId:
          type: string
        displayInfoTitle:
          type: string
        newMembers:
          type: string
        totalMembers:
          type: string
        deletedAccounts:
          type: string
        activeMembers:
          type: string
        activeMemberPercent:
          type: string
        totalOrders:
          type: string
        loyaltyEarnOrders:
          type: string
        loyaltyBurnOrders:
          type: string
        loyaltyNetZeroOrders:
          type: string
        totalLoyaltyOrders:
          type: string
        loyaltyContribution:
          type: string
        allOrdersNetSales:
          type: string
        loyaltyOrdersNetSales:
          type: string
        loyaltySales:
          type: string
        discountAmount:
          type: string
        loyaltyContributionSalesPercent:
          type: string
        loyaltyContributionOrdersPercent:
          type: string
        loyaltyAverageCheck:
          type: string
        mobileLoyaltyOrders:
          type: string
        mobileLoyaltyOrdersPercent:
          type: string
        webLoyaltyOrders:
          type: string
        webLoyaltyOrdersPercent:
          type: string
        scan2PayOrders:
          type: string
        scan2PayOrdersPercent:
          type: string
        inStoreLoyaltyOrders:
          type: string
        inStoreLoyaltyOrdersPercent:
          type: string
        otherLoyaltyOrders:
          type: string
        otherLoyaltyOrdersPercent:
          type: string
        bonusEarnEvents:
          type: string
        uniqueUserScan2Pay:
          type: string
        uniqueUserWeb:
          type: string
        uniqueUserApp:
          type: string
        uniqueUserInStore:
          type: string
        uniqueUserOther:
          type: string
    LoyaltyReportDataGridLocationsPageDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        stores:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyReportDataGridLocationPerformanceDisplay'
        total:
          $ref: '#/components/schemas/LoyaltyReportDataGridLocationPerformanceDisplay'
    LoyaltyReportFranchiseSummaryDTO:
      type: object
      properties:
        activeMembers:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        activeMembersPercent:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        systemActiveMembersPercent:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        contributionRate:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        systemContributionRate:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
    LoyaltyReportBrandOverallSummaryDTO:
      type: object
      properties:
        totalMembers:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        activeMembers:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        activeMembersPercent:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        deletedAccounts:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        loyaltySales:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        loyaltyContributionPercentOfSales:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        loyaltyContributionPercentOfOrders:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        loyaltyAverageOrder:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        membersWhoOrdered:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        activityRateMembersWhoOrdered:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
    LoyaltyReportPieGraphDTO:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyReportPieGraphEntry'
    LoyaltyReportPieGraphEntry:
      type: object
      properties:
        label:
          type: string
        value:
          type: number
    LoyaltyReportBrandPointsSummaryDTO:
      type: object
      properties:
        startingBalance:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        pointsEarned:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        pointsRedeemed:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        pointsExpired:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
        endingBalance:
          $ref: '#/components/schemas/LoyaltyReportSummaryCard'
    JobStatusDTO:
      type: object
      properties:
        jobName:
          type: string
        dataAvailableDate:
          type: string
          format: date
        updatedDate:
          type: string
          format: date-time
      required:
      - dataAvailableDate
      - jobName
      - updatedDate
    JobStatusResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JobStatusDTO'
    GuestJourneyReportResponseDTO:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/StatusEnum'
        message:
          type: string
        filePath:
          type: string
    SalesByOrderTypeDTO:
      type: object
      properties:
        orderType:
          type: string
        sales:
          type: number
    SalesByOrderTypeReportDTO:
      type: object
      properties:
        totalSales:
          type: number
        salesByOrderTypeList:
          type: array
          items:
            $ref: '#/components/schemas/SalesByOrderTypeDTO'
    SalesByHourDTO:
      type: object
      properties:
        storeHour:
          type: integer
          format: int32
        sales:
          type: number
          format: double
    SalesByLocationAndTimeReportDTO:
      type: object
      properties:
        storeName:
          type: string
        salesByHourList:
          type: array
          items:
            $ref: '#/components/schemas/SalesByHourDTO'
    SalesByChannelOverTimeDTO:
      type: object
      properties:
        channelType:
          type: string
        salesByDateList:
          type: array
          items:
            $ref: '#/components/schemas/SalesByDateDTO'
    SalesByDateDTO:
      type: object
      properties:
        storeDate:
          type: string
          format: date-time
        sales:
          type: number
          format: double
    SalesByChannelDTO:
      type: object
      properties:
        channelType:
          type: string
        sales:
          type: number
          format: double
    SalesByChannelReportDTO:
      type: object
      properties:
        totalSales:
          type: number
        salesByChannelList:
          type: array
          items:
            $ref: '#/components/schemas/SalesByChannelDTO'
    OrdersBySignInStatusDTO:
      type: object
      properties:
        signInStatus:
          type: string
        orders:
          type: number
    OrdersBySignInStatusReportDTO:
      type: object
      properties:
        totalOrders:
          type: number
        ordersBySignInStatusList:
          type: array
          items:
            $ref: '#/components/schemas/OrdersBySignInStatusDTO'
    OrdersByOrderTypeDTO:
      type: object
      properties:
        orderType:
          type: string
        orders:
          type: number
    OrdersByOrderTypeReportDTO:
      type: object
      properties:
        totalOrders:
          type: number
        ordersByOrderTypeList:
          type: array
          items:
            $ref: '#/components/schemas/OrdersByOrderTypeDTO'
    OrdersByHourDTO:
      type: object
      properties:
        storeHour:
          type: integer
          format: int32
        orders:
          type: number
    OrdersByLocationAndTimeReportDTO:
      type: object
      properties:
        storeName:
          type: string
        ordersByHourList:
          type: array
          items:
            $ref: '#/components/schemas/OrdersByHourDTO'
    OrdersByChannelOverTimeDTO:
      type: object
      properties:
        channelType:
          type: string
        ordersByDateList:
          type: array
          items:
            $ref: '#/components/schemas/OrdersByDateDTO'
    OrdersByDateDTO:
      type: object
      properties:
        storeDate:
          type: string
          format: date-time
        orders:
          type: number
          format: double
    OrdersByChannelDTO:
      type: object
      properties:
        channelType:
          type: string
        orders:
          type: number
          format: double
    OrdersByChannelReportDTO:
      type: object
      properties:
        totalOrders:
          type: number
        ordersByChannelList:
          type: array
          items:
            $ref: '#/components/schemas/OrdersByChannelDTO'
    OfferRedemptionByHourDistributedDTO:
      type: object
      properties:
        storeHour:
          type: integer
          format: int32
        offerRedemption:
          type: number
    OfferRedemptionByTimeOfTheDayDistributedReportDTO:
      type: object
      properties:
        offerName:
          type: string
        offersByHourList:
          type: array
          items:
            $ref: '#/components/schemas/OfferRedemptionByHourDistributedDTO'
    OfferRedemptionByHourDTO:
      type: object
      properties:
        storeHour:
          type: integer
          format: int32
        offerRedemption:
          type: number
    OfferRedemptionByTimeOfTheDayReportDTO:
      type: object
      properties:
        offerName:
          type: string
        offersByHourList:
          type: array
          items:
            $ref: '#/components/schemas/OfferRedemptionByHourDTO'
    OfferPerformanceDTO:
      type: object
      properties:
        attribute:
          type: string
        value:
          type: integer
          format: int32
    OfferPerformanceReportDTO:
      type: object
      properties:
        offerPerformanceList:
          type: array
          items:
            $ref: '#/components/schemas/OfferPerformanceDTO'
    MostPopularItemsReportDTO:
      type: object
      properties:
        itemName:
          type: string
        itemUrl:
          type: string
        noOfItems:
          type: integer
          format: int32
    MessageViewsByHourDistributedDTO:
      type: object
      properties:
        storeHour:
          type: integer
          format: int32
        messageViews:
          type: number
    MessageViewsByTimeOfTheDayDistributedReportDTO:
      type: object
      properties:
        messageName:
          type: string
        messagesByHourList:
          type: array
          items:
            $ref: '#/components/schemas/MessageViewsByHourDistributedDTO'
    MessageViewsByHourDTO:
      type: object
      properties:
        storeHour:
          type: integer
          format: int32
        messageViews:
          type: number
    MessageViewsByTimeOfTheDayReportDTO:
      type: object
      properties:
        messageName:
          type: string
        messagesByHourList:
          type: array
          items:
            $ref: '#/components/schemas/MessageViewsByHourDTO'
    MessagePerformanceDTO:
      type: object
      properties:
        attribute:
          type: string
        value:
          type: number
    MessagePerformanceReportDTO:
      type: object
      properties:
        messagePerformanceList:
          type: array
          items:
            $ref: '#/components/schemas/MessagePerformanceDTO'
    LoyaltyOfferRedemptionByHourDistributedDTO:
      type: object
      properties:
        storeHour:
          type: integer
          format: int32
        loyaltyOfferRedemption:
          type: number
    LoyaltyOfferRedemptionByTimeOfTheDayDistributedReportDTO:
      type: object
      properties:
        loyaltyOfferName:
          type: string
        loyaltyOffersByHourList:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyOfferRedemptionByHourDistributedDTO'
    LoyaltyOfferRedemptionByHourDTO:
      type: object
      properties:
        storeHour:
          type: integer
          format: int32
        loyaltyOfferRedemption:
          type: number
    LoyaltyOfferRedemptionByTimeOfTheDayReportDTO:
      type: object
      properties:
        loyaltyOfferName:
          type: string
        loyaltyOffersByHourList:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyOfferRedemptionByHourDTO'
    LoyaltyOfferPerformanceDTO:
      type: object
      properties:
        attribute:
          type: string
        value:
          type: integer
          format: int32
    LoyaltyOfferPerformanceReportDTO:
      type: object
      properties:
        loyaltyOfferPerformanceList:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyOfferPerformanceDTO'
    LeastPopularItemsReportDTO:
      type: object
      properties:
        itemName:
          type: string
        itemUrl:
          type: string
        noOfItems:
          type: integer
          format: int32
    AmountByBonusAccountDTO:
      type: object
      properties:
        amount:
          type: number
        noOfRecords:
          type: integer
          format: int32
    AmountByLocationDTO:
      type: object
      properties:
        locationId:
          type: string
        locationName:
          type: string
        amount:
          type: number
        noOfRecords:
          type: integer
          format: int32
    AmountByPoolAccountDTO:
      type: object
      properties:
        amount:
          type: number
        noOfRecords:
          type: integer
          format: int32
    GiftCardPoolSummaryReportDTO:
      type: object
      properties:
        amountByPoolAccount:
          $ref: '#/components/schemas/AmountByPoolAccountDTO'
        amountByBonusAccount:
          $ref: '#/components/schemas/AmountByBonusAccountDTO'
        amountByLocationList:
          type: array
          items:
            $ref: '#/components/schemas/AmountByLocationDTO'
    FrequentlyBoughtTogetherReportDTO:
      type: object
      properties:
        firstItem:
          type: string
        secondItem:
          type: string
        firstItemUrl:
          type: string
        secondItemUrl:
          type: string
        percentage:
          type: number
          format: double
    CustomersByOrdersReportDTO:
      type: object
      properties:
        orders:
          type: string
        customers:
          type: number
    CustomersByMostVisitsPerWeekReportDTO:
      type: object
      properties:
        customerName:
          type: string
        visits:
          type: number
        profileUrl:
          type: string
    CustomersByLoyaltyBalanceReportDTO:
      type: object
      properties:
        customerName:
          type: string
        loyaltyBalance:
          type: number
        profileUrl:
          type: string
    CustomersByHighestAverageOrderSizeReportDTO:
      type: object
      properties:
        customerName:
          type: string
        averageOrderSize:
          type: number
          format: double
        profileUrl:
          type: string
    CustomersByGenderDTO:
      type: object
      properties:
        gender:
          type: string
        customers:
          type: number
    CustomersByGenderReportDTO:
      type: object
      properties:
        totalCustomers:
          type: number
        customersByGenderList:
          type: array
          items:
            $ref: '#/components/schemas/CustomersByGenderDTO'
    CustomersByDaysSinceLastPurchasePercentileReportDTO:
      type: object
      properties:
        daysSinceLastPurchasePercentile:
          type: integer
          format: int32
        averageNoOfDays:
          type: number
          format: double
    CustomersByDaysSinceLastPurchaseReportDTO:
      type: object
      properties:
        daysSinceLastPurchase:
          type: string
        customers:
          type: number
    CustomersByAverageOrdersReportDTO:
      type: object
      properties:
        averageOrders:
          type: string
        customers:
          type: integer
          format: int32
    CustomersByAverageBasketValuePercentileReportDTO:
      type: object
      properties:
        averageBasketValuePercentile:
          type: integer
          format: int32
        averageBasketValue:
          type: number
          format: double
    CustomersByAverageBasketValueReportDTO:
      type: object
      properties:
        averageBasketValue:
          type: string
        customers:
          type: number
    CustomersByAgeReportDTO:
      type: object
      properties:
        attribute:
          type: string
        customers:
          type: number
    AverageOrderSizeDTO:
      type: object
      properties:
        user:
          type: string
        orders:
          type: number
    AverageOrderSizeReportDTO:
      type: object
      properties:
        averageOrderSizeList:
          type: array
          items:
            $ref: '#/components/schemas/AverageOrderSizeDTO'
    TotalSignUpsReportDTO:
      type: object
      properties:
        totalSignedUp:
          type: integer
          format: int32
    SalesByPosCategoryReportDTO:
      type: object
      properties:
        posCategory:
          type: string
        salesByDateList:
          type: array
          items:
            $ref: '#/components/schemas/SalesByDateDTO'
    SalesByOrderSourceReportDTO:
      type: object
      properties:
        orderSource:
          type: string
        salesByDateList:
          type: array
          items:
            $ref: '#/components/schemas/SalesByDateDTO'
    SalesByLocationReportDTO:
      type: object
      properties:
        locationName:
          type: string
        salesByDateList:
          type: array
          items:
            $ref: '#/components/schemas/SalesByDateDTO'
    TopRecommendedItemsDTO:
      type: object
      properties:
        itemName:
          type: string
        qty:
          type: integer
          format: int32
        orders:
          type: integer
          format: int32
        revenue:
          type: number
          format: float
        takeRate:
          type: number
          format: float
        imageUrl:
          type: string
    MonthlyTileData:
      type: object
      properties:
        total:
          type: integer
          format: int32
        comparedToPreviousMonthPercentage:
          type: number
          format: float
    RecommendationSummaryDTO:
      type: object
      properties:
        percentageOfTxWithDisplayedRecommendation:
          type: number
          format: float
        txWithPurchasedRecommendation:
          $ref: '#/components/schemas/MonthlyTileData'
        percentageOfTxWherePurchasedRecommendation:
          type: number
          format: float
        percentageOfRevenueLiftForTxWithPurchasedRecommendation:
          type: number
          format: float
        revenueAddedThroughRecommendations:
          $ref: '#/components/schemas/MonthlyTileData'
        revenueAddedAfterShowingRecommendations:
          $ref: '#/components/schemas/MonthlyTileData'
    RecommendedAverageBasketValueDTO:
      type: object
      properties:
        date:
          type: integer
          format: int64
        txWithNoRecommendationsPresented:
          type: number
          format: float
        txWithRecommendationsPurchased:
          type: number
          format: float
        txWithRecommendationsPresentedButNotPurchased:
          type: number
          format: float
    SalesByLocationForPreviousMonthReportDTO:
      type: object
      properties:
        totalSales:
          type: number
        comparedToPreviousMonthPercentage:
          type: string
    NewSignUpsForPreviousMonthReportDTO:
      type: object
      properties:
        totalSignedUp:
          type: number
        comparedToPreviousMonthPercentage:
          type: string
    NewSignUpsReportDTO:
      type: object
      properties:
        signedUpDate:
          type: string
          format: date-time
        totalSignedUp:
          type: number
    DeliveriesByDateDTO:
      type: object
      properties:
        deliveriesDate:
          type: string
          format: date-time
        totalOrders:
          type: number
        totalTaxes:
          type: number
        totalCharges:
          type: number
        totalTips:
          type: number
        totalSales:
          type: number
    DeliveriesByLocationReportDTO:
      type: object
      properties:
        locationName:
          type: string
        deliveriesByDateList:
          type: array
          items:
            $ref: '#/components/schemas/DeliveriesByDateDTO'
    QuantileType:
      type: string
      enum:
      - DAYS_SINCE_LAST_PURCHASE
      - AVERAGE_BASKET_VALUE
      - PURCHASES_PER_MONTH
    GraphPoint:
      type: object
      properties:
        x:
          type: integer
          format: int32
        y:
          type: integer
          format: int32
        value:
          type: number
          format: double
    OrderStatus:
      type: string
      enum:
      - OPEN
      - CLOSED
      - CANCELED
      - REFUNDED
      - SYNC_PENDING
    FulfillmentStatus:
      type: string
      enum:
      - NONE
      - NEW
      - CONFIRM
      - PREP
      - READY
      - DELIVERY
      - CLOSED
      - CANCELED
    OrderSort:
      type: string
      enum:
      - ASC
      - DESC
    OrderSortBy:
      type: string
      enum:
      - ORDER_FULFILL_TIME
      - UPDATED_DATE
    OrderSource:
      type: string
      enum:
      - APP
      - WEB
      - POS
      - KIOSK
      - GOOGLE_ORDERING
    OrderTotalDTO:
      type: object
      properties:
        preDiscountSubtotal:
          type: integer
          format: int32
        subtotal:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        displayTotal:
          type: string
        displaySubtotal:
          type: string
        displayPreDiscountSubtotal:
          type: string
    SearchCustomerDTO:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        phone:
          type: string
        email:
          type: string
    SearchOrdersResponseDTOForAdmin:
      type: object
      properties:
        orderId:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        locationId:
          type: string
        extOrderId:
          type: string
        orderNumber:
          type: string
        customer:
          $ref: '#/components/schemas/SearchCustomerDTO'
        createdDate:
          type: string
        updatedDate:
          type: string
        closedTime:
          type: string
        orderTotal:
          $ref: '#/components/schemas/OrderTotalDTO'
        locationName:
          type: string
        status:
          $ref: '#/components/schemas/OrderStatus'
        orderType:
          $ref: '#/components/schemas/OrderType'
        fulfillmentStatus:
          $ref: '#/components/schemas/FulfillmentStatus'
        orderFulfillTime:
          type: string
        originalFulfillTime:
          type: string
        orderSource:
          $ref: '#/components/schemas/OrderSource'
        orderNote:
          type: string
        orderOptionName:
          type: string
        hasCustomerNotifications:
          type: boolean
        imHere:
          type: boolean
        imHereUpdated:
          type: string
    SearchOrdersResponseDTOWithPagingForAdmin:
      type: object
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/SearchOrdersResponseDTOForAdmin'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    ListPackageResponseDTO:
      type: object
      properties:
        packageId:
          type: string
        title:
          type: string
        groupIds:
          type: array
          items:
            type: string
          uniqueItems: true
    ViewPackageResponseDTO:
      type: object
      properties:
        packageId:
          type: string
        groupIds:
          type: array
          items:
            type: string
          uniqueItems: true
        price:
          type: integer
          format: int32
        clientId:
          type: string
        merchantId:
          type: string
        discountDto:
          type: array
          items:
            $ref: '#/components/schemas/DiscountDTO'
        startDate:
          type: string
        endDate:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        externalId:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
          uniqueItems: true
        title:
          type: string
        status:
          type: string
        itemDTOs:
          type: array
          items:
            $ref: '#/components/schemas/ItemDTO'
        storeIds:
          type: array
          items:
            type: string
    OrderNotificationMessageResponseDTO:
      type: object
      properties:
        subject:
          type: string
        message:
          type: string
        messageType:
          type: string
        createdDate:
          type: string
          format: date-time
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
    MerchantResponseDTO:
      type: object
      properties:
        merchantId:
          type: string
        clientId:
          type: string
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxDTO'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDTO'
        orderProcessingConfig:
          $ref: '#/components/schemas/OrderProcessingConfigDTO'
        paymentGatewayConfig:
          $ref: '#/components/schemas/PaymentGatewayConfig'
        pickupOrderProcessingTime:
          type: integer
          format: int64
        deliveryOrderProcessingTime:
          type: integer
          format: int64
        timeZone:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
    LocationResponseDTO:
      type: object
      properties:
        catalogOverrides:
          type: array
          items:
            $ref: '#/components/schemas/MenuOverride'
          uniqueItems: true
        catering:
          type: boolean
        charges:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDTO'
        clientId:
          type: string
        countryCode:
          type: string
        currencyCode:
          type: string
        deliveryArea:
          $ref: '#/components/schemas/DeliveryArea'
        deliveryAsapSupported:
          type: boolean
        deliveryAvailabilityInterval:
          type: integer
          format: int32
        deliveryMaxDaysOut:
          type: integer
          format: int32
        deliveryOffDays:
          type: array
          items:
            type: string
            format: date
        deliveryOrderHours:
          type: array
          items:
            $ref: '#/components/schemas/WorkingHours'
          uniqueItems: true
        deliveryOrderNoticePeriod:
          type: integer
          format: int64
        deliveryOrderOptions:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptions'
          uniqueItems: true
        deliveryOrderProcessingTime:
          type: integer
          format: int64
        deliveryOrdersAccepted:
          type: boolean
        deliveryOrderValueLimits:
          $ref: '#/components/schemas/OrderValueLimits'
        deliveryRadius:
          type: number
          format: double
        deliverySevenPlusDaysOrdering:
          type: boolean
        deliveryTemporaryHours:
          type: array
          items:
            $ref: '#/components/schemas/TemporaryHours'
        disableTipping:
          type: boolean
        dynamicDeliveryCharge:
          $ref: '#/components/schemas/DynamicDeliveryCharge'
        enableFulFillTextForToast:
          type: boolean
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        externalOrderingEnabled:
          type: boolean
        externalOrderingText:
          type: string
        extPosLocationId:
          type: string
        failureNotificationRecipientEmailList:
          type: array
          items:
            type: string
          uniqueItems: true
        fulFillTextForToast:
          type: string
        groupOverrides:
          type: array
          items:
            $ref: '#/components/schemas/MenuOverride'
          uniqueItems: true
        kitchenThrottleConfig:
          $ref: '#/components/schemas/KitchenThrottleConfigDTO'
        latitude:
          type: number
          format: double
        locationId:
          type: string
        locationName:
          type: string
        longitude:
          type: number
          format: double
        menuImportConfig:
          $ref: '#/components/schemas/MenuImportConfig'
        merchantId:
          type: string
        orderNotificationRecipientEmailList:
          type: array
          items:
            type: string
          uniqueItems: true
        orderProcessingConfig:
          $ref: '#/components/schemas/OrderProcessingConfigDTO'
        orderThrottleConfig:
          type: array
          items:
            $ref: '#/components/schemas/OrderThrottleConfig'
          uniqueItems: true
        paymentConfigs:
          type: array
          items:
            $ref: '#/components/schemas/PaymentConfig'
        paymentGatewayConfig:
          $ref: '#/components/schemas/PaymentGatewayConfig'
        pickupAsapSupported:
          type: boolean
        pickupAvailabilityInterval:
          type: integer
          format: int32
        pickupMaxDaysOut:
          type: integer
          format: int32
        pickupOffDays:
          type: array
          items:
            type: string
            format: date
        pickupOrderHours:
          type: array
          items:
            $ref: '#/components/schemas/WorkingHours'
          uniqueItems: true
        pickupOrderNoticePeriod:
          type: integer
          format: int64
        pickupOrderOptions:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptions'
          uniqueItems: true
        pickupOrderProcessingTime:
          type: integer
          format: int64
        pickupOrdersAccepted:
          type: boolean
        pickupOrderValueLimits:
          $ref: '#/components/schemas/OrderValueLimits'
        pickupSevenPlusDaysOrdering:
          type: boolean
        pickupTemporaryHours:
          type: array
          items:
            $ref: '#/components/schemas/TemporaryHours'
        primaryLocation:
          type: boolean
        primaryLocationId:
          type: string
        qalocation:
          type: boolean
        showDeliveryTimeSlots:
          type: boolean
        showPickupTimeSlots:
          type: boolean
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/TaxDTO'
        test:
          type: boolean
        timeZone:
          type: string
        viewOnlyLocationEnabled:
          type: boolean
        primaryStore:
          $ref: '#/components/schemas/RelatedStore'
        relatedStores:
          type: array
          items:
            $ref: '#/components/schemas/RelatedStore'
        secondaryLocations:
          type: array
          items:
            $ref: '#/components/schemas/LocationResponseDTO'
    OrderingServiceAddressDTO:
      type: object
      properties:
        streetAddress1:
          type: string
        streetAddress2:
          type: string
        city:
          type: string
        postalCode:
          type: string
        region:
          type: string
        country:
          type: string
    RelatedStore:
      type: object
      properties:
        storeId:
          type: string
        title:
          type: string
        address:
          $ref: '#/components/schemas/OrderingServiceAddressDTO'
        phoneNumber:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        regionId:
          type: string
        storeCode:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        storeType:
          type: string
        beaconId:
          type: string
        beaconName:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/StoreDisplayInfo'
          uniqueItems: true
        isCatering:
          type: boolean
        isMenuBrowsing:
          type: boolean
        viewOnlyLocationEnabled:
          type: boolean
        isTest:
          type: boolean
    FindLocationResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingDTO'
        stores:
          type: array
          items:
            $ref: '#/components/schemas/LocationDTO'
          uniqueItems: true
    LocationDTO:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/OrderingServiceAddressDTO'
        beaconId:
          type: string
        beaconName:
          type: string
        catering:
          type: boolean
        clientId:
          type: string
        currencyCode:
          type: string
        deliveryAsapSupported:
          type: boolean
        deliveryAvailabilityInterval:
          type: integer
          format: int32
        deliveryMaxDaysOut:
          type: integer
          format: int32
        deliveryMaxOrderingDate:
          type: string
        deliveryNoticePeriod:
          type: integer
          format: int64
        deliveryOffDays:
          type: array
          items:
            type: string
        deliveryOrderHours:
          type: array
          items:
            $ref: '#/components/schemas/WorkingHours'
          uniqueItems: true
        deliveryOrderOptions:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptionsDTO'
          uniqueItems: true
        deliveryOrdersAccepted:
          type: boolean
        deliveryOrderValueLimits:
          $ref: '#/components/schemas/OrderValueLimits'
        deliveryProcessingTime:
          type: integer
          format: int64
        deliverySevenPlusDaysOrdering:
          type: boolean
        deliveryTemporaryHours:
          type: array
          items:
            $ref: '#/components/schemas/TemporaryHours'
        disableTipping:
          type: boolean
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/StoreDisplayInfo'
          uniqueItems: true
        enableFulFillTextForToast:
          type: boolean
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        externalOrderingEnabled:
          type: boolean
        externalOrderingText:
          type: string
        extPosLocationId:
          type: string
        fulFillTextForToast:
          type: string
        latitude:
          type: number
          format: double
        longDescription:
          type: string
        longitude:
          type: number
          format: double
        mediumImage:
          type: string
        menuImportConfig:
          $ref: '#/components/schemas/MenuImportConfig'
        merchantId:
          type: string
        orderGateway:
          type: string
        paymentGateway:
          type: string
        phoneNumber:
          type: string
        pickupAsapSupported:
          type: boolean
        pickupAvailabilityInterval:
          type: integer
          format: int32
        pickupMaxDaysOut:
          type: integer
          format: int32
        pickupMaxOrderingDate:
          type: string
        pickupNoticePeriod:
          type: integer
          format: int64
        pickupOffDays:
          type: array
          items:
            type: string
        pickupOrderHours:
          type: array
          items:
            $ref: '#/components/schemas/WorkingHours'
          uniqueItems: true
        pickupOrderOptions:
          type: array
          items:
            $ref: '#/components/schemas/OrderOptionsDTO'
          uniqueItems: true
        pickupOrdersAccepted:
          type: boolean
        pickupOrderValueLimits:
          $ref: '#/components/schemas/OrderValueLimits'
        pickupProcessingTime:
          type: integer
          format: int64
        pickupSevenPlusDaysOrdering:
          type: boolean
        pickupTemporaryHours:
          type: array
          items:
            $ref: '#/components/schemas/TemporaryHours'
        primaryLocation:
          type: boolean
        primaryLocationId:
          type: string
        qalocation:
          type: boolean
        regionId:
          type: string
        shortDescription:
          type: string
        showDeliveryTimeSlots:
          type: boolean
        showPickupTimeSlots:
          type: boolean
        smallImage:
          type: string
        storeCode:
          type: string
        storeId:
          type: string
        storeType:
          type: string
        timeZone:
          type: string
        title:
          type: string
        viewOnlyLocationEnabled:
          type: boolean
        withInDeliveryRadius:
          type: boolean
    OrderOptionsDTO:
      type: object
      properties:
        optionName:
          type: string
        displayRank:
          type: integer
          format: int32
        title:
          type: string
        informationField:
          type: string
        errorMessageIfInformationFieldIsEmpty:
          type: string
        instructions:
          type: string
    OrdersCountResponseDTO:
      type: object
      properties:
        orderCount:
          type: integer
          format: int32
        imHereNewOrderCount:
          type: integer
          format: int32
        imHerePrepOrderCount:
          type: integer
          format: int32
    DailyOrdersResponseDTOForAdmin:
      type: object
      properties:
        orderId:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        locationId:
          type: string
        extOrderId:
          type: string
        customer:
          $ref: '#/components/schemas/SearchCustomerDTO'
        createdDate:
          type: string
        localCreatedDate:
          type: string
        updatedDate:
          type: string
        orderTotal:
          $ref: '#/components/schemas/OrderTotalDTO'
        orderFulfillTime:
          type: string
          format: date-time
        closedTime:
          type: string
          format: date-time
        localClosedTime:
          type: string
        status:
          $ref: '#/components/schemas/OrderStatus'
        locationName:
          type: string
        orderGoodStanding:
          type: boolean
        orderGoodStandingStatusDescription:
          type: string
        offerRedeemStatusInGoodStanding:
          type: boolean
        offerRedeemStatusInGoodStandingDescription:
          type: string
        interventionRequired:
          type: boolean
        orderSource:
          $ref: '#/components/schemas/OrderSource'
        filterStatus:
          $ref: '#/components/schemas/OrderFilteringMode'
    DailyOrdersResponseDTOWithPagingForAdmin:
      type: object
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/DailyOrdersResponseDTOForAdmin'
        totalAmount:
          type: number
          format: double
        paging:
          $ref: '#/components/schemas/PagingDTO'
        summary:
          $ref: '#/components/schemas/DailyOrdersSummaryDTO'
    DailyOrdersSummaryDTO:
      type: object
      properties:
        noOfRecords:
          type: integer
          format: int32
        totalOfOrderTotal:
          type: number
          format: double
        totalOfOrderSubtotal:
          type: number
          format: double
    ListPresetOrderResponseWithPagingForAdminDTO:
      type: object
      properties:
        presetOrderConfigResponseDTOs:
          type: array
          items:
            $ref: '#/components/schemas/GetPresetOrderConfigResponseDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    ListSubItemResponseAdminDTO:
      type: object
      properties:
        subItemId:
          type: string
        extSubItemId:
          type: string
        merchantId:
          type: string
        clientId:
          type: string
        name:
          type: string
        price:
          type: integer
          format: int32
        uom:
          type: string
        sku:
          type: string
        upc:
          type: string
        brandId:
          type: string
        categoryId:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        externalId:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
          uniqueItems: true
        status:
          type: string
        title:
          type: string
        label:
          type: string
        createdDate:
          type: string
        updatedDate:
          type: string
    ViewSubItemResponseAdminDTO:
      type: object
      properties:
        subItemId:
          type: string
        extSubItemId:
          type: string
        merchantId:
          type: string
        clientId:
          type: string
        name:
          type: string
        price:
          type: integer
          format: int32
        uom:
          type: string
        sku:
          type: string
        upc:
          type: string
        brandId:
          type: string
        categoryId:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        externalId:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
          uniqueItems: true
        status:
          type: string
        title:
          type: string
        label:
          type: string
        createdDate:
          type: string
        updatedDate:
          type: string
    AuditEventDTO:
      type: object
      properties:
        id:
          type: string
        eventName:
          type: string
        traceId:
          type: string
        transactionId:
          type: string
        eventTime:
          type: string
        description:
          type: string
        interventionRequired:
          type: boolean
        resolved:
          type: boolean
        resolutionTime:
          type: string
        resolutionComment:
          type: string
        requestedBy:
          $ref: '#/components/schemas/FindAdminUserResponseDTO'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        externalStatuses:
          type: object
          additionalProperties:
            type: string
        additionalDetails:
          type: string
    ChargeSummary:
      type: object
      properties:
        taxableCharges:
          type: integer
          format: int32
        nonTaxableCharges:
          type: integer
          format: int32
        charges:
          type: array
          items:
            $ref: '#/components/schemas/OrderCharge'
        totalCharges:
          type: integer
          format: int32
        totalChargesWithTax:
          type: integer
          format: int32
        totalTaxes:
          type: integer
          format: int32
    FindAdminUserResponseDTO:
      type: object
      properties:
        adminAccountAuthorization:
          $ref: '#/components/schemas/AdminAccountAuthorization'
        adminId:
          type: string
        email:
          type: string
        clientID:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        merchantId:
          type: string
        role:
          $ref: '#/components/schemas/RoleDTO'
        status:
          type: string
        deleted:
          type: boolean
        storeIds:
          type: array
          items:
            type: string
        reach:
          type: string
        hasEntireClientReach:
          type: boolean
    ItemsCountDTO:
      type: object
      properties:
        totalItemsCount:
          type: integer
          format: int32
        itemsCount:
          type: object
          additionalProperties:
            type: integer
            format: int32
    OrderCharge:
      type: object
      properties:
        chargeId:
          type: string
        chargeName:
          type: string
        chargeDescription:
          type: string
        taxable:
          type: boolean
        gratuity:
          type: boolean
        delivery:
          type: boolean
        chargeApplied:
          type: integer
          format: int32
        chargeAppliedWithTax:
          type: number
          format: float
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/Tax'
    OrderDiscount:
      type: object
      properties:
        discountId:
          type: string
        extDiscountId:
          type: string
        distributedOfferId:
          type: string
        description:
          type: string
        discountType:
          $ref: '#/components/schemas/DiscountType'
        pointsCost:
          type: integer
          format: int32
        discountAmount:
          type: integer
          format: int32
        discountPercentage:
          type: number
          format: float
        appliedDiscount:
          type: integer
          format: int32
        displayAppliedDiscount:
          type: string
    OrderRefund:
      type: object
      properties:
        refundAmount:
          type: integer
          format: int32
        refundReason:
          type: string
        refundDate:
          type: string
        requestedBy:
          type: string
        userInfo:
          $ref: '#/components/schemas/FindAdminUserResponseDTO'
    OrderTax:
      type: object
      properties:
        taxId:
          type: string
        taxDescription:
          type: string
        taxAmountApplied:
          type: integer
          format: int32
    OrderTotal:
      type: object
      properties:
        preDiscountSubtotal:
          type: integer
          format: int32
        taxSummary:
          $ref: '#/components/schemas/TaxSummary'
        chargeSummary:
          $ref: '#/components/schemas/ChargeSummary'
        refundSummary:
          $ref: '#/components/schemas/RefundSummary'
        subtotal:
          type: integer
          format: int32
        gratuity:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
        displayTotal:
          type: string
        displaySubtotal:
          type: string
        displayPreDiscountSubtotal:
          type: string
        displayTotalDiscountApplied:
          type: string
        displayGratuity:
          type: string
        totalTaxApplied:
          type: integer
          format: int32
    RefundSummary:
      type: object
      properties:
        totalRefundAmount:
          type: integer
          format: int32
        refunds:
          type: array
          items:
            $ref: '#/components/schemas/OrderRefund'
    TaxSummary:
      type: object
      properties:
        totalTaxes:
          type: integer
          format: int32
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/OrderTax'
    ViewOrderResponseDTOForAdmin:
      type: object
      properties:
        orderId:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        locationId:
          type: string
        extOrderId:
          type: string
        orderName:
          type: string
        orderNumber:
          type: string
        orderType:
          $ref: '#/components/schemas/OrderType'
        customer:
          $ref: '#/components/schemas/Customer'
        guestCount:
          type: integer
          format: int32
        tableId:
          type: string
        tableNumber:
          type: string
        delivery:
          $ref: '#/components/schemas/DeliveryInfo'
        openedTime:
          type: string
        closedTime:
          type: string
        status:
          $ref: '#/components/schemas/OrderStatus'
        orderNote:
          type: string
        orderFulfillTime:
          type: string
          format: date-time
        revenueCenter:
          type: string
        createdDate:
          type: string
        updatedDate:
          type: string
        orderItems:
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
          uniqueItems: true
        orderDiscounts:
          type: array
          items:
            $ref: '#/components/schemas/OrderDiscount'
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
        checks:
          type: array
          items:
            $ref: '#/components/schemas/Check'
        orderTotal:
          $ref: '#/components/schemas/OrderTotal'
        itemsCountDetails:
          $ref: '#/components/schemas/ItemsCountDTO'
        fulfillmentStatus:
          $ref: '#/components/schemas/FulfillmentStatus'
        orderSource:
          $ref: '#/components/schemas/OrderSource'
        auditEvents:
          type: array
          items:
            $ref: '#/components/schemas/AuditEventDTO'
        orderOptionName:
          type: string
        trackingUrl:
          type: string
    FindItemsDisplayInfoResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ItemDisplayInfoDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    ItemDisplayInfoDTO:
      type: object
      properties:
        id:
          type: string
        idType:
          type: string
        displayInfoTitles:
          type: array
          items:
            type: string
        itemType:
          type: string
        itemsByDisplayInfoTitle:
          type: array
          items:
            $ref: '#/components/schemas/ItemDTO'
    FindGroupsDisplayInfoResponse:
      type: object
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupDisplayInfoDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    GroupDisplayInfoDTO:
      type: object
      properties:
        id:
          type: string
        idType:
          type: string
        displayInfoTitles:
          type: array
          items:
            type: string
        groupType:
          type: string
        groupsByDisplayInfoTitle:
          type: array
          items:
            $ref: '#/components/schemas/GroupDTO'
    CatalogIntegrationType:
      type: string
      enum:
      - INTEGRATED
      - STANDALONE
    ViewCatalogAdminDTO:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        externalId:
          type: string
        extTargetingId:
          type: string
        title:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        startDate:
          type: string
        endDate:
          type: string
        displayRank:
          type: integer
          format: int32
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/DisplayInfo'
        status:
          type: string
        applicableOrderTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrderType'
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        privateAttributes:
          type: object
          additionalProperties:
            type: string
        storeIds:
          type: array
          items:
            type: string
        storeInfos:
          type: array
          items:
            $ref: '#/components/schemas/StoreInfo'
        originalTitle:
          type: string
        catalogId:
          type: string
        catalogIntegrationType:
          $ref: '#/components/schemas/CatalogIntegrationType'
        compressedCatalogJson:
          type: string
        groupIds:
          type: array
          items:
            type: string
        groups:
          type: array
          items:
            $ref: '#/components/schemas/ViewGroupAdminDTO'
        lastPublished:
          type: string
          format: date-time
        stores:
          type: array
          items:
            $ref: '#/components/schemas/StoreInfo'
      required:
      - clientId
      - merchantId
      - title
    CampaignDTO:
      type: object
      properties:
        campaignId:
          type: string
        programId:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        merchantId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
    FindCampaignResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        campaigns:
          type: array
          items:
            $ref: '#/components/schemas/CampaignDTO'
    LocationDetailResponse:
      type: object
      properties:
        extTargetingId:
          type: string
        productType:
          $ref: '#/components/schemas/ProductType'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/TargetingLocationVariant'
    TargetingLocationVariant:
      type: object
      properties:
        productTitle:
          type: string
        incentivioId:
          type: string
        externalId:
          type: string
        locationId:
          type: string
        locationName:
          type: string
        price:
          type: string
        status:
          type: string
        itemType:
          type: string
        productId:
          type: string
    LocationMenuImportSummaryDTO:
      type: object
      properties:
        clientId:
          type: string
        failureDescription:
          type: string
        locationExternalId:
          type: string
        locationId:
          type: string
        locationTitle:
          type: string
        menuDownloadStartedTime:
          type: string
        menuImportCompletedTime:
          type: string
        menuImportStatus:
          $ref: '#/components/schemas/MenuImportProgressStatus'
        merchantId:
          type: string
        requestId:
          type: string
        userId:
          type: string
    MenuImportHistoryWithPagingDTO:
      type: object
      properties:
        locationMenuImportSummaryDTOList:
          type: array
          items:
            $ref: '#/components/schemas/LocationMenuImportSummaryDTO'
        paging:
          $ref: '#/components/schemas/PagingDto'
    PagingDto:
      type: object
      properties:
        count:
          type: integer
          format: int32
        currentPage:
          type: integer
          format: int32
        total:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
    BulkImageUpload:
      type: object
      properties:
        dateCreated:
          type: string
        dateUpdated:
          type: string
        id:
          type: string
        adminId:
          type: string
        clientId:
          type: string
        processedFiles:
          type: array
          items:
            $ref: '#/components/schemas/ImageFile'
        status:
          $ref: '#/components/schemas/BulkImageUploadStatus'
        statusMessage:
          type: string
        type:
          $ref: '#/components/schemas/BulkImageUploadType'
        uploadId:
          type: string
      required:
      - adminId
      - clientId
      - dateCreated
      - dateUpdated
      - status
      - type
      - uploadId
    BulkImageUploadSearchResponse:
      type: object
      properties:
        bulkImageUploads:
          type: array
          items:
            $ref: '#/components/schemas/BulkImageUpload'
        paging:
          $ref: '#/components/schemas/PagingDto'
    BulkImageUploadReadResponse:
      type: object
      properties:
        bulkImageUpload:
          $ref: '#/components/schemas/BulkImageUpload'
    LoyaltyTransactionStatus:
      type: string
      enum:
      - PENDING
      - CONFIRMED
      - EXPIRED
    FindLoyaltyHistoryResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        loyaltyHistories:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyTransactionDTO'
    LoyaltyTransactionDTO:
      type: object
      properties:
        loyaltyTransactionStatus:
          $ref: '#/components/schemas/LoyaltyTransactionStatus'
        description:
          type: string
        originalPoints:
          type: integer
          format: int32
        currentPoints:
          type: integer
          format: int32
        transactionDate:
          type: string
        offerId:
          type: string
        offerTitle:
          type: string
        loyaltyAccountId:
          type: string
        loyaltyTransactionId:
          type: string
        externalTransactionId:
          type: string
        status:
          $ref: '#/components/schemas/LoyaltyTransactionStatus'
        confirmationDate:
          type: string
    GuestJourneyStatus:
      type: object
      properties:
        jobId:
          type: integer
          format: int32
        status:
          type: string
        modifiedDate:
          type: string
    ViewGuestJourneyResponse:
      type: object
      properties:
        journey:
          type: array
          items:
            $ref: '#/components/schemas/GuestJourneyStatus'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    GuestSegmentInfo:
      type: object
      properties:
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        guestCount:
          type: integer
          format: int64
        annualSpend:
          type: number
          format: double
        annualSpendPerUser:
          type: number
          format: double
        annualSpendPerUserTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        averageCheckSize:
          type: number
          format: double
        averageCheckSizeTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        revenuePercentage:
          type: number
          format: double
        revenuePercentageTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        guestPercentage:
          type: number
          format: double
        guestPercentageTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        visitsPerMonth:
          type: number
          format: double
        visitsPerMonthTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        recoveryInfo:
          $ref: '#/components/schemas/GuestSegmentRecoveryInfo'
        offerInfo:
          $ref: '#/components/schemas/GuestSegmentOfferInfo'
        updatedDate:
          type: string
          format: date-time
    GuestSegmentOfferInfo:
      type: object
      properties:
        offerTypeCount:
          type: integer
          format: int32
        distributionCount:
          type: integer
          format: int32
        redemptionPercentage:
          type: number
          format: double
    GuestSegmentRecoveryInfo:
      type: object
      properties:
        recoveredCount:
          type: integer
          format: int64
        recoveredAnnualSpend:
          type: number
          format: double
    GuestSegmentTrend:
      type: string
      enum:
      - UPTREND
      - DOWNTREND
      - STAGNANT
    GuestSegmentType:
      type: string
      enum:
      - STRANGER
      - ROOKIE
      - REGULAR
      - LOYALIST
      - CHAMPION
      - WHALE
      - SLIDER
      - CHURNED
    GuestSummaryResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/GuestSegmentInfo'
    GuestRevenueSummary:
      type: object
      properties:
        clientId:
          type: string
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        revenuePercentage:
          type: number
          format: double
        date:
          type: string
    GuestRevenueSummaryResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/GuestRevenueSummary'
    GuestCountSummary:
      type: object
      properties:
        clientId:
          type: string
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        date:
          type: string
        guestCount:
          type: integer
          format: int64
    GuestCountSummaryResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/GuestCountSummary'
    GuestRevenueSummaryByStore:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        storeId:
          type: string
        storeName:
          type: string
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        date:
          type: string
        revenuePercentage:
          type: number
          format: double
    GuestRevenueSummaryByStoreResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/GuestRevenueSummaryByStore'
    GuestCountSummaryByStore:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        storeId:
          type: string
        storeName:
          type: string
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        date:
          type: string
        guestCount:
          type: integer
          format: int64
    GuestCountSummaryByStoreResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/GuestCountSummaryByStore'
    GiftCardLocationConfig:
      type: object
      properties:
        locationId:
          type: string
        locationName:
          type: string
        locationConfig:
          type: object
          additionalProperties:
            type: string
    GiftCardBalanceRecord:
      type: object
      properties:
        cardIdentifier:
          type: string
        cardStatus:
          type: string
        totalBalance:
          type: string
        liableBalance:
          type: string
        compBalance:
          type: string
        createdDate:
          type: string
          format: date-time
        activatedDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        createdDateString:
          type: string
        activatedDateString:
          type: string
        updatedDateString:
          type: string
        initialPurchaseAmount:
          type: string
        initialPurchaseLocation:
          type: string
    GiftCardBalanceReportDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingDTO'
        results:
          type: array
          items:
            $ref: '#/components/schemas/GiftCardBalanceRecord'
        releaseDate:
          type: string
    GiftCardBalanceExportReportResponse:
      type: object
      properties:
        requestId:
          type: string
        status:
          $ref: '#/components/schemas/StatusEnum'
        message:
          type: string
    GiftCardClientConfigResponse:
      type: object
      properties:
        giftCardProvider:
          $ref: '#/components/schemas/GiftCardServiceProvider'
        securityCodeEnabled:
          type: boolean
        poolAccountSettings:
          type: object
          additionalProperties:
            type: string
    AdminGiftCardSearchRequestDTO:
      type: object
      properties:
        adminId:
          type: string
        cardNumber:
          type: string
        email:
          type: string
        senderEmail:
          type: string
        recipientEmail:
          type: string
        status:
          type: string
        startActivateDate:
          type: string
        endActivateDate:
          type: string
        sortBy:
          type: string
        sortDirection:
          type: string
        count:
          type: integer
          format: int32
        page:
          type: integer
          format: int32
    AdminSearchForGiftCardResponseDTO:
      type: object
      properties:
        giftCards:
          type: array
          items:
            $ref: '#/components/schemas/GiftCardAccountViewDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    GiftCardAccountViewDTO:
      type: object
      properties:
        cardIdentifier:
          type: string
        cardAccountBalance:
          type: number
          format: double
        cardStatus:
          type: string
        activatedDate:
          type: string
        ownerEmail:
          type: string
        sender:
          $ref: '#/components/schemas/GiftCardSender'
        recipient:
          $ref: '#/components/schemas/GiftCardRecipient'
        token:
          type: string
    GiftCardSender:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phone:
          type: string
        customerId:
          type: string
        adminId:
          type: string
    SearchGiftCardAccountBatchSummaryRequestDTO:
      type: object
      properties:
        adminId:
          type: string
        userId:
          type: string
        type:
          $ref: '#/components/schemas/TypeEnum'
        status:
          $ref: '#/components/schemas/StatusEnum'
        createdDateFrom:
          type: string
        createdDateTo:
          type: string
        count:
          type: integer
          format: int32
        page:
          type: integer
          format: int32
        sortBy:
          type: string
        sortDirection:
          $ref: '#/components/schemas/SortDirectionEnum'
    SortDirectionEnum:
      type: string
      enum:
      - ASC
      - DESC
    GiftCardAccountBatchSummaryDTO:
      type: object
      properties:
        id:
          type: string
        sourceType:
          $ref: '#/components/schemas/SourceTypeEnum'
        clientId:
          type: string
        userId:
          type: string
        processedCardCount:
          type: integer
          format: int32
        processedCardList:
          type: array
          items:
            type: string
        successCardCount:
          type: integer
          format: int32
        successCardList:
          type: array
          items:
            type: string
        failedCardCount:
          type: integer
          format: int32
        failedCardList:
          type: array
          items:
            type: string
        type:
          $ref: '#/components/schemas/TypeEnum'
        status:
          $ref: '#/components/schemas/StatusEnum'
        reportLink:
          type: string
        parentBatchId:
          type: string
        traceId:
          type: string
        closed:
          type: boolean
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        userName:
          type: string
        parentBatch:
          $ref: '#/components/schemas/GiftCardAccountBatchSummaryDTO'
        childBatchIds:
          type: array
          items:
            type: string
        childBatches:
          type: array
          items:
            $ref: '#/components/schemas/GiftCardAccountBatchSummaryDTO'
    SearchGiftCardAccountBatchSummaryResponseDTO:
      type: object
      properties:
        batchSummaries:
          type: array
          items:
            $ref: '#/components/schemas/GiftCardAccountBatchSummaryDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    SourceTypeEnum:
      type: string
      enum:
      - POS
      - MOBILE
      - WEB
      - ADMIN_PORTAL
      - EMAIL_EVENT
    AdminViewGiftCardResponseDTO:
      type: object
      properties:
        cardIdentifier:
          type: string
        cardAccountBalance:
          type: number
          format: double
        cardStatus:
          type: string
        activatedDate:
          type: string
        customerList:
          type: array
          items:
            $ref: '#/components/schemas/CustomerViewDTO'
        from:
          type: string
        recipient:
          $ref: '#/components/schemas/GiftCardRecipient'
        sender:
          $ref: '#/components/schemas/GiftCardSender'
        token:
          type: string
        provider:
          type: string
        securityCode:
          type: string
    CustomerViewDTO:
      type: object
      properties:
        userId:
          type: string
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        externalId:
          type: string
        accountAliasId:
          type: string
    AdminViewTransactionForGiftCardResponseDTO:
      type: object
      properties:
        giftCardTransactionList:
          type: array
          items:
            $ref: '#/components/schemas/GiftCardTransactionViewDTO'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    GiftCardTransactionViewDTO:
      type: object
      properties:
        amount:
          type: string
        transactionType:
          type: string
        sourceType:
          type: string
        transactionDate:
          type: string
        locationId:
          type: string
        locationName:
          type: string
        adminId:
          type: string
        adminName:
          type: string
        transactionInstant:
          type: string
          format: date-time
        status:
          type: string
    AdminViewEventsForGiftCardResponseDTO:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/GiftCardEvent'
        paging:
          $ref: '#/components/schemas/PagingDTO'
        status:
          type: string
    GiftCardEvent:
      type: object
      properties:
        id:
          type: string
        cardIdentifier:
          type: string
        eventName:
          type: string
        traceId:
          type: string
        transactionId:
          type: string
        eventTime:
          type: string
          format: date-time
        description:
          type: string
        interventionRequired:
          type: boolean
        resolved:
          type: boolean
        resolutionTime:
          type: string
          format: date-time
        resolutionComment:
          type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
        externalStatuses:
          type: object
          additionalProperties:
            type: string
        additionalDetails:
          type: string
    RetrieveIAVTokenResponse:
      type: object
      properties:
        token:
          type: string
    AuditEvent:
      type: object
      properties:
        id:
          type: string
        eventName:
          $ref: '#/components/schemas/EventNameEnum'
        topic:
          type: string
        traceId:
          type: string
        transferId:
          type: string
        eventTime:
          type: string
          format: date-time
        interventionRequired:
          type: boolean
        resolved:
          type: boolean
        resolutionTime:
          type: string
          format: date-time
        resolutionComment:
          type: string
        additionalDetails:
          type: string
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        path:
          type: string
    EventNameEnum:
      type: string
      enum:
      - CREATED
      - SUBMITTED_TO_DWOLLA
      - SUBMITTION_TO_DWOLLA_FAILED
      - WEBHOOK_UPDATE
      - WEBHOOK_UPDATE_FAILED
      - CANCELLATION_STARTED
      - CANCELLED
      - CANCELLATION_FAILED
      - RETRY_TRANSFER_CREATED
    FormattedDwollaException:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    FundTransfer:
      type: object
      properties:
        id:
          type: string
        externalId:
          type: string
        parentTransferId:
          type: string
        parentTransferExternalId:
          type: string
        fundingTransferId:
          type: string
        fundedTransferId:
          type: string
        summaryId:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        locationId:
          type: string
        sourceLocationId:
          type: string
        sourceLocationExternalId:
          type: string
        sourceLocationName:
          type: string
        destinationLocationId:
          type: string
        destinationLocationExternalId:
          type: string
        destinationLocationName:
          type: string
        sourceFundingAccountId:
          type: string
        sourceFundingAccountExternalId:
          type: string
        sourceFundingAccountName:
          type: string
        destinationFundingAccountId:
          type: string
        destinationFundingAccountExternalId:
          type: string
        destinationFundingAccountName:
          type: string
        amount:
          type: number
        amountFormatted:
          type: string
        fullAmount:
          type: number
        currencyCode:
          type: string
        debitAccount:
          type: string
        resolutionTime:
          type: string
          format: date-time
        resolutionComment:
          type: string
        partialTransfer:
          type: boolean
        status:
          $ref: '#/components/schemas/StatusEnum'
        links:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
        failureReason:
          $ref: '#/components/schemas/FundTransferFailureReason'
        failureException:
          $ref: '#/components/schemas/FormattedDwollaException'
        auditEvents:
          type: array
          items:
            $ref: '#/components/schemas/AuditEvent'
        transferStartDate:
          type: string
          format: date-time
        transferEndDate:
          type: string
          format: date-time
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
    FundTransferFailureReason:
      type: object
      properties:
        code:
          type: string
        description:
          type: string
        explanation:
          type: string
    RetrieveFundTransferListResponse:
      type: object
      properties:
        transferList:
          type: array
          items:
            $ref: '#/components/schemas/FundTransfer'
        pageIndex:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        totalRecordCount:
          type: integer
          format: int64
    ACHBeneficialOwner:
      type: object
      properties:
        externalId:
          type: string
        locationId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        address:
          $ref: '#/components/schemas/Address'
        createdDate:
          type: string
          format: date-time
        verificationStatus:
          $ref: '#/components/schemas/VerificationStatusEnum'
        documents:
          type: array
          items:
            $ref: '#/components/schemas/ACHDocument'
    RetrieveBeneficalOwnersResponse:
      type: object
      properties:
        beneficialOwners:
          type: array
          items:
            $ref: '#/components/schemas/ACHBeneficialOwner'
    VerificationStatusEnum:
      type: string
      enum:
      - UNVERIFIED
      - DOCUMENT
      - VERIFIED
      - INCOMPLETE
    ClientTemplatesResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingDto'
        templates:
          type: array
          items:
            $ref: '#/components/schemas/ClientTemplate'
    TemplateTagResponseDTO:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientEmailTemplateType'
        eventType:
          $ref: '#/components/schemas/EventType'
        tag:
          type: string
        required:
          type: boolean
        specialLink:
          type: boolean
    TabletAppCompatibility:
      type: string
      enum:
      - COMPATIBLE
      - UPGRADE_RECOMMENDED
      - UPGRADE_REQUIRED
      - NOT_COMPATIBLE
    TabletAppCompatibilityDTO:
      type: object
      properties:
        compatibility:
          $ref: '#/components/schemas/TabletAppCompatibility'
    FindStoreTypesResponseDTO:
      type: object
      properties:
        storeTypes:
          type: array
          items:
            $ref: '#/components/schemas/StoreTypeDTO'
    StoreTypeDTO:
      type: object
      properties:
        storeTypeId:
          type: string
        type:
          type: string
        description:
          type: string
    FindStoresResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingDto'
        stores:
          type: array
          items:
            $ref: '#/components/schemas/StoreDTO'
    StoreDTO:
      type: object
      properties:
        storeId:
          type: string
        title:
          type: string
        address:
          $ref: '#/components/schemas/AddressDTO'
        phoneNumber:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        regionId:
          type: string
        storeCode:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        storeType:
          type: string
        beaconId:
          type: string
        beaconName:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/StoreDisplayInfo'
          uniqueItems: true
        isCatering:
          type: boolean
        isMenuBrowsing:
          type: boolean
        viewOnlyLocationEnabled:
          type: boolean
        isTest:
          type: boolean
    SecureAdminResponseDTO:
      type: object
      properties:
        adminAccountAuthorization:
          $ref: '#/components/schemas/AdminAccountAuthorization'
        adminId:
          type: string
        clientId:
          type: string
        email:
          type: string
        password:
          type: string
        reach:
          type: string
        status:
          $ref: '#/components/schemas/Status'
        storeIds:
          type: array
          items:
            type: string
        deleted:
          type: boolean
    SearchRolesResponseDTO:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/RoleDTO'
        paging:
          $ref: '#/components/schemas/PagingDto'
    SearchModulesResponseDTO:
      type: object
      properties:
        modules:
          type: array
          items:
            $ref: '#/components/schemas/ModuleDTO'
    FindMerchantsResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingDto'
        merchants:
          type: array
          items:
            $ref: '#/components/schemas/MerchantDTO'
    MerchantDTO:
      type: object
      properties:
        merchantId:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        title:
          type: string
        address:
          $ref: '#/components/schemas/AddressDTO'
        clientId:
          type: string
        messageFromEmail:
          type: string
        timezone:
          type: string
    FindMerchantsByIdsResponseDTO:
      type: object
      properties:
        merchantsMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/MerchantDTO'
    AppHomeConfigAuditDTO:
      type: object
      properties:
        id:
          type: string
        adminId:
          type: string
        action:
          type: string
        detail:
          type: string
        timestamp:
          type: string
          format: date-time
    FindAllStoresResponseDTO:
      type: object
      properties:
        stores:
          type: array
          items:
            $ref: '#/components/schemas/StoreDTO'
    AdminDTO:
      type: object
      properties:
        adminId:
          type: string
        clientID:
          type: string
        deleted:
          type: boolean
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        merchantId:
          type: string
        reach:
          type: string
        role:
          $ref: '#/components/schemas/RoleDTO'
        status:
          type: string
        storeIds:
          type: array
          items:
            type: string
    FindAdminResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingDto'
        admins:
          type: array
          items:
            $ref: '#/components/schemas/AdminDTO'
    AdminsByIdsResponseDTO:
      type: object
      properties:
        adminsMap:
          type: object
          additionalProperties:
            type: string
    AdminStoreDTO:
      type: object
      properties:
        storeId:
          type: string
        merchantId:
          type: string
        title:
          type: string
    FindAdminStoresResponseDTO:
      type: object
      properties:
        stores:
          type: array
          items:
            $ref: '#/components/schemas/AdminStoreDTO'
    FindSegmentsResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        segments:
          type: array
          items:
            $ref: '#/components/schemas/SegmentResponseDTO'
    SegmentResponseDTO:
      type: object
      properties:
        segmentId:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        merchantName:
          type: string
        segmentName:
          type: string
        segmentDescription:
          type: string
        segmentTag:
          type: string
        segmentType:
          $ref: '#/components/schemas/SegmentTypeEnum'
        segmentIcon:
          type: string
        visibleToCustomer:
          type: boolean
        segmentRules:
          $ref: '#/components/schemas/RuleDescriptor'
        adminId:
          type: string
        adminEmail:
          type: string
        startDate:
          type: string
          format: date-time
        createdDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        lastProcessedDate:
          type: string
          format: date-time
        expiredStatus:
          type: boolean
        displaySegmentStatus:
          type: string
        deletedStatus:
          type: boolean
        segmentDistribution:
          type: string
        customerCount:
          type: integer
          format: int32
        calculationInProgressStatus:
          type: boolean
    FindCustomerSegmentsResponseDTO:
      type: object
      properties:
        clientId:
          type: string
        customerId:
          type: string
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
        segments:
          type: array
          items:
            $ref: '#/components/schemas/SegmentLightResponseDTO'
    SegmentLightResponseDTO:
      type: object
      properties:
        segmentId:
          type: string
        segmentName:
          type: string
        segmentDescription:
          type: string
        segmentIcon:
          type: string
        segmentRules:
          $ref: '#/components/schemas/RuleDescriptor'
        deletedStatus:
          type: boolean
    AppContentResponseDTO:
      type: object
      properties:
        offerList:
          $ref: '#/components/schemas/AppOfferListDTO'
        messageList:
          $ref: '#/components/schemas/AppMessageListDTO'
    AppMessageDTO:
      type: object
      properties:
        distributedMessageId:
          type: string
        merchantId:
          type: string
        messageId:
          type: string
        languageCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        status:
          $ref: '#/components/schemas/MessageStatus'
        distributedDate:
          type: string
        updatedDate:
          type: string
        messageType:
          type: string
        surveyId:
          type: string
    AppMessageListDTO:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/AppMessageDTO'
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
    AppOfferDTO:
      type: object
      properties:
        distributedOfferId:
          type: string
        offerId:
          type: string
        clientId:
          type: string
        merchantId:
          type: string
        offerCode:
          type: string
        codeFormat:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        status:
          $ref: '#/components/schemas/OfferStatus'
        redemptionEndDate:
          type: string
        distributedDate:
          type: string
        updatedDate:
          type: string
        redeemType:
          type: string
        purchaseTypes:
          type: array
          items:
            type: string
          uniqueItems: true
        isLoyaltyOffer:
          type: boolean
        universalOffer:
          type: boolean
        alwaysAvailable:
          type: boolean
        enableGuestCheckout:
          type: boolean
    AppOfferListDTO:
      type: object
      properties:
        offers:
          type: array
          items:
            $ref: '#/components/schemas/AppOfferDTO'
        paging:
          $ref: '#/components/schemas/ResultsPagingDTO'
    MessageStatus:
      type: string
      enum:
      - NEW
      - READ
      - EXPIRED
      - DELETED
    OfferStatus:
      type: string
      enum:
      - NEW
      - SAVED
      - READ
      - EXPIRED
      - DELETED
      - SYSTEM_REDEEMED
      - USER_REDEEMED
    SignatureResponse:
      type: object
      properties:
        uidHash:
          type: string