openapi: 3.0.3
info:
  version: 1.0.0
  title: Vality Fraudbusters Management API
  description:
    $ref: './docs/api.md'
  termsOfService: 'https://vality.dev/'
  contact:
    name: Vality Support Team
    email: support@vality.dev
    url: 'https://developer.vality.dev'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
security: [ ]
tags:
  - name: audit
    x-displayName: Audit
  - name: notification
    x-displayName: Notifications
  - name: channel
    x-displayName: Channels
  - name: group
    x-displayName: Groups
  - name: group-reference
    x-displayName: Groups reference
  - name: lists
    x-displayName: Payments lists
  - name: emulation
    x-displayName: Emulation
  - name: load-data
    x-displayName: Load data
  - name: template
    x-displayName: Templates
  - name: reference
    x-displayName: References
  - name: historical-data
    x-displayName: Historical data
  - name: notification-template
    x-displayName: Notification template
  - name: data-sets
    x-displayName: Data sets
  - name: analytics
    x-displayName: Analytics

paths:
  # Audit
  /audit/commandTypes:
    $ref: ./paths/audit/getCommandTypes.yaml
  /audit/filter:
    $ref: ./paths/audit/filterLogs.yaml
  /audit/objectTypes:
    $ref: ./paths/audit/getObjectTypes.yaml

  # Notifications
  /notifications:
    $ref: ./paths/notifications/notifications.yaml
  /notifications/{id}:
    $ref: ./paths/notifications/notification.yaml
  /notifications/validation:
    $ref: ./paths/notifications/validation.yaml
  /notifications/{id}/status:
    $ref: ./paths/notifications/notificationStatus.yaml

  # Notifications channels
  /notifications/channels:
    $ref: ./paths/notifications/channels.yaml
  /notifications/channels/channel/{name}:
    $ref: ./paths/notifications/channel.yaml
  /notifications/channels/types:
    $ref: ./paths/notifications/channelTypes.yaml

  # Notifications templates
  /notifications/templates:
    $ref: ./paths/notifications/templates.yaml

  # Load data
  /payments-load-data/fraud-payments:
    $ref: ./paths/payments/load-data/loadFraudPayments.yaml

  # Groups
  /payments-groups:
    $ref: ./paths/payments/groups/insertGroup.yaml
  /payments-groups/{groupId}:
    delete:
      $ref: ./paths/payments/groups/removeGroup.yaml
    get:
      $ref: ./paths/payments/groups/getGroup.yaml
  /payments-groups/filter:
    $ref: ./paths/payments/groups/filterGroups.yaml

  # Groups reference
  /payments-groups/{id}/references:
    $ref: ./paths/payments/groups/references/insertGroupReferences.yaml
  /payments-groups/{id}/references/remove:
    $ref: ./paths/payments/groups/references/removeGroupReference.yaml
  /payments-groups/references/filter:
    $ref: ./paths/payments/groups/references/filterGroupsReferences.yaml

  # Lists
  /payments-lists:
    $ref: ./paths/payments/lists/insertRow.yaml
  /payments-lists/csv:
    $ref: ./paths/payments/lists/insertFromCsv.yaml
  /payments-lists/{id}:
    $ref: ./paths/payments/lists/removeRow.yaml
  /payments-lists/remove/csv:
    $ref: ./paths/payments/lists/removeByCsv.yaml
  /payments-lists/availableListNames:
    $ref: ./paths/payments/lists/getAvailableListNames.yaml
  /payments-lists/currentListNames:
    $ref: ./paths/payments/lists/getCurrentListNames.yaml
  /payments-lists/filter:
    $ref: ./paths/payments/lists/filterLists.yaml
  /payments-lists/candidates:
    $ref: ./paths/payments/lists/candidates.yaml
  /payments-lists/candidates/approved:
    $ref: ./paths/payments/lists/candidates@approved.yaml
  /payments-lists/candidates-batches:
    $ref: ./paths/payments/lists/candidateBatches.yaml

  # Templates
  /payments-templates:
    $ref: ./paths/payments/templates/insertTemplate.yaml
  /payments-templates/{id}:
    $ref: ./paths/payments/templates/removeTemplate.yaml
  /payments-templates/filter:
    $ref: ./paths/payments/templates/filterTemplates.yaml
  /payments-templates/names:
    $ref: ./paths/payments/templates/getTemplateNames.yaml
  /payments-templates/validate:
    $ref: ./paths/payments/templates/validateTemplate.yaml

  # References
  /payments-references:
    $ref: ./paths/payments/references/insertReferences.yaml
  /payments-references/{id}:
    $ref: ./paths/payments/references/removeReference.yaml
  /payments-references/filter:
    $ref: ./paths/payments/references/filterReferences.yaml

  # Default references
  /payments-references/default:
    $ref: ./paths/payments/references/default/insertDefaultReference.yaml
  /payments-references/default/{id}:
    $ref: ./paths/payments/references/default/removeDefaultReference.yaml
  /payments-references/default/filter:
    $ref: ./paths/payments/references/default/filterDefaultReferences.yaml

  # Emulation
  /payments-emulations:
    $ref: ./paths/payments/emulations/getTemplatesFlow.yaml

  # Historical data
  /payments-historical-data/payments-info:
    $ref: ./paths/payments/historical-data/filterPayments.yaml
  /payments-historical-data/inspect-results:
    $ref: ./paths/payments/historical-data/filterInspectResults.yaml
  /payments-historical-data/chargebacks:
    $ref: ./paths/payments/historical-data/filterChargebacks.yaml
  /payments-historical-data/fraud-payments:
    $ref: ./paths/payments/historical-data/filterFraudPayments.yaml
  /payments-historical-data/refunds:
    $ref: ./paths/payments/historical-data/filterRefunds.yaml

  # Data sets
  /payments-data-set/data-sets:
    $ref: ./paths/payments/data-sets/insertDataSet.yaml
  /payments-data-set/data-sets/{setId}:
    delete:
      $ref: ./paths/payments/data-sets/removeDataSet.yaml
    get:
      $ref: ./paths/payments/data-sets/getDataSet.yaml
  /payments-data-set/data-sets/filter:
    $ref: ./paths/payments/data-sets/filterDataSets.yaml
  /payments-data-set/data-sets/applyRuleOnHistoricalDataSet:
    $ref: ./paths/payments/data-sets/applyRuleOnHistoricalDataSet.yaml

  # Checked data sets
  /payments-data-set/checked-data-sets/{id}:
    $ref: ./paths/payments/checked-data-sets/getCheckedDataSet.yaml

  # Analytics
  /analytics/fraud-payments/count:
    $ref: ./paths/analytics/fraud-payments/fraudPayments@count.yaml
  /analytics/fraud-payments/blocked/count:
    $ref: ./paths/analytics/fraud-payments/blockedFraudPayments@count.yaml
  /analytics/fraud-payments/blocked/sum:
    $ref: ./paths/analytics/fraud-payments/blockedFraudPayments@sum.yaml
  /analytics/fraud-payments/blocked/count/ratio:
    $ref: ./paths/analytics/fraud-payments/blockedFraudPayments@count@ratio.yaml
  /analytics/fraud-payments/scores/split-count/ratio:
    $ref: ./paths/analytics/fraud-payments/fraudPaymentsScores@split-count@ratio.yaml
  /analytics/fraud-payments/results/summary:
    $ref: ./paths/analytics/fraud-payments/fraudPaymentsResults@summary.yaml
  /analytics/currencies:
    $ref: ./paths/analytics/currencies.yaml

servers:
  - url: 'https://fb-management:8080/fb-management/v1'

components:
  securitySchemes:
    bearer:
      $ref: './components/security-schemes/Bearer.yaml'