Solvimon fileProcessingSettings API

openapi: 3.1.0
info:
  title: Configuration alertRules fileProcessingSettings API
  version: 1.0.0
servers:
- url: https://test.api.solvimon.com
  description: The TEST environment for our API
- url: https://api.solvimon.com
  description: The live environment for our API
tags:
- name: fileProcessingSettings
paths:
  /v{version}/file-processing-settings/{resourceId}:
    get:
      operationId: getFileProcessingSettingsByResourceId
      summary: Get the file processing settings by resource ID
      tags:
      - fileProcessingSettings
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileProcessingSettings'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    patch:
      operationId: patchFileProcessingSettingsByResourceId
      summary: Update file processing settings
      tags:
      - fileProcessingSettings
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileProcessingSettings'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileProcessingSettingsUpdateRequest'
  /v{version}/file-processing-settings:
    post:
      operationId: postFileProcessingSettings
      summary: Create file processing settings
      tags:
      - fileProcessingSettings
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileProcessingSettings'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileProcessingSettingsCreateRequest'
components:
  schemas:
    FileProcessingSettingsCreateRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        reference:
          type: string
        type:
          $ref: '#/components/schemas/FileProcessingSettingsCreateRequestType'
        meter_data:
          $ref: '#/components/schemas/MeterDataFileProcessingSettingsCreateRequest'
        bucket_location:
          type:
          - string
          - 'null'
        download_settings:
          $ref: '#/components/schemas/DownloadSettingsCreateRequest'
        included_customers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerReferencesCreateRequest'
        excluded_customers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerReferencesCreateRequest'
      required:
      - reference
      - type
      title: FileProcessingSettingsCreateRequest
    FileProcessingSettings:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        reference:
          type: string
        type:
          $ref: '#/components/schemas/FileProcessingSettingsType'
        meter_data:
          $ref: '#/components/schemas/MeterDataFileProcessingSettings'
        bucket_location:
          type:
          - string
          - 'null'
        download_settings:
          $ref: '#/components/schemas/DownloadSettings'
        included_customers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerReferences'
        excluded_customers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerReferences'
      title: FileProcessingSettings
    ClientCredentials:
      type: object
      properties:
        client_id:
          type: string
        client_secret:
          type: string
      title: ClientCredentials
    MeterDataFileProcessingSettingsCreateRequest:
      type: object
      properties:
        mapping_column:
          type:
          - string
          - 'null'
        mappings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MeterDataMappingSettings'
        customer_reference_mapping:
          $ref: '#/components/schemas/ColumnMapping'
      title: MeterDataFileProcessingSettingsCreateRequest
    CustomerReferences:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
        custom_field_value:
          type:
          - string
          - 'null'
      title: CustomerReferences
    MeterValueMapping:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
        column:
          $ref: '#/components/schemas/MeterValueMappingColumn'
        default_value:
          $ref: '#/components/schemas/MeterValueMappingDefaultValue'
      title: MeterValueMapping
    MeterPropertyMapping:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
        column:
          type: string
        default_value:
          $ref: '#/components/schemas/DefaultValue'
      title: MeterPropertyMapping
    MeterDataFileProcessingSettings:
      type: object
      properties:
        mapping_column:
          type:
          - string
          - 'null'
        mappings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MeterDataMappingSettings'
        customer_reference_mapping:
          $ref: '#/components/schemas/ColumnMapping'
      title: MeterDataFileProcessingSettings
    FileProcessingSettingsUpdateRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        reference:
          type: string
        type:
          $ref: '#/components/schemas/FileProcessingSettingsUpdateRequestType'
        meter_data:
          $ref: '#/components/schemas/MeterDataFileProcessingSettingsUpdateRequest'
        bucket_location:
          type:
          - string
          - 'null'
        download_settings:
          $ref: '#/components/schemas/DownloadSettingsUpdateRequest'
        included_customers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerReferencesUpdateRequest'
        excluded_customers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerReferencesUpdateRequest'
      title: FileProcessingSettingsUpdateRequest
    MeterDataFileProcessingSettingsUpdateRequest:
      type: object
      properties:
        mapping_column:
          type:
          - string
          - 'null'
        mappings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MeterDataMappingSettings'
        customer_reference_mapping:
          $ref: '#/components/schemas/ColumnMapping'
      title: MeterDataFileProcessingSettingsUpdateRequest
    ReferenceMappingInterface:
      type: object
      properties:
        column:
          type:
          - string
          - 'null'
        custom_field:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
      title: ReferenceMappingInterface
    DownloadSettingsCreateRequest:
      type: object
      properties:
        authentication:
          $ref: '#/components/schemas/AuthenticationSettings'
      title: DownloadSettingsCreateRequest
    AuthenticationSettingsApiKey:
      type: object
      properties:
        header:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      title: AuthenticationSettingsApiKey
    FileProcessingSettingsUpdateRequestType:
      type: string
      enum:
      - METER_DATA
      title: FileProcessingSettingsUpdateRequestType
    FileProcessingSettingsCreateRequestType:
      type: string
      enum:
      - METER_DATA
      title: FileProcessingSettingsCreateRequestType
    DownloadSettings:
      type: object
      properties:
        authentication:
          $ref: '#/components/schemas/AuthenticationSettings'
      title: DownloadSettings
    MeterValueMappingColumn:
      type: object
      properties:
        number:
          type:
          - string
          - 'null'
        amount:
          $ref: '#/components/schemas/MeterValueMappingColumnAmount'
      title: MeterValueMappingColumn
    MeterDataMappingSettings:
      type: object
      properties:
        column_values:
          type:
          - array
          - 'null'
          items:
            type: string
        meter_reference_mapping:
          $ref: '#/components/schemas/ReferenceMappingInterface'
        ingest_reference_mapping:
          $ref: '#/components/schemas/IngestReferenceMapping'
        meter_property_mappings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MeterPropertyMapping'
        meter_value_mappings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MeterValueMapping'
      title: MeterDataMappingSettings
    DownloadSettingsUpdateRequest:
      type: object
      properties:
        authentication:
          $ref: '#/components/schemas/AuthenticationSettings'
      title: DownloadSettingsUpdateRequest
    UsernamePassword:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
      title: UsernamePassword
    DefaultValue:
      type: object
      properties:
        absent_column:
          type:
          - string
          - 'null'
        empty_field:
          type:
          - string
          - 'null'
      title: DefaultValue
    FileProcessingSettingsType:
      type: string
      enum:
      - METER_DATA
      title: FileProcessingSettingsType
    AuthenticationSettings:
      type: object
      properties:
        api_key:
          $ref: '#/components/schemas/AuthenticationSettingsApiKey'
        client_credentials:
          $ref: '#/components/schemas/ClientCredentials'
        username_password:
          $ref: '#/components/schemas/UsernamePassword'
      title: AuthenticationSettings
    ApiErrorType:
      type: string
      enum:
      - API_ERROR
      - INVALID_REQUEST
      title: ApiErrorType
    ApiError:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ApiErrorType'
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        field:
          type:
          - string
          - 'null'
        message:
          type: string
        resource_id:
          type:
          - string
          - 'null'
        resource_type:
          oneOf:
          - $ref: '#/components/schemas/ApiErrorResourceType'
          - type: 'null'
      required:
      - type
      - code
      - message
      title: ApiError
    CustomerReferencesUpdateRequest:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
        custom_field_value:
          type:
          - string
          - 'null'
      title: CustomerReferencesUpdateRequest
    MeterValueMappingAmountDefaultValue:
      type: object
      properties:
        quantity:
          $ref: '#/components/schemas/DefaultValue'
        currency:
          $ref: '#/components/schemas/DefaultValue'
      title: MeterValueMappingAmountDefaultValue
    ColumnMapping:
      type: object
      properties:
        column:
          type:
          - string
          - 'null'
        custom_field:
          type:
          - string
          - 'null'
      title: ColumnMapping
    ApiErrorResourceType:
      type: string
      enum:
      - CUSTOMER
      - CUSTOM_FIELD
      - PLATFORM
      - PLATFORM_UPTODATE
      - METER
      - METER_VALUE
      - METER_PROPERTY
      - METER_VALUE_CALCULATION
      - INGEST_DATA
      - METER_DATA
      - CHARGE_DATA
      - PERSIST_DATA
      - ADJUSTMENT_DATA
      - PRODUCT_CATEGORY
      - PRODUCT
      - PRODUCT_ITEM
      - PRICING
      - PRICING_GROUP
      - PRICING_ITEM
      - PRICING_ITEM_CONFIG
      - PRICING_PLAN_SUBSCRIPTION
      - PRICING_PLAN_SUBSCRIPTION_GROUP
      - PRICING_PLAN_SCHEDULE
      - PRICING_PLAN
      - PRICING_PLAN_VERSION
      - QUOTE
      - QUOTE_VERSION
      - QUOTE_TEMPLATE
      - API_KEY
      - USER
      - ROLE
      - PROXY_USER
      - EXTERNAL_CREDENTIALS
      - TOKEN
      - INVOICE
      - E_INVOICE
      - PDF
      - BILLING_ENTITY
      - FEATURE
      - MEMBERSHIP
      - PAYMENT
      - PAYMENT_ACCEPTOR
      - PAYMENT_METHOD
      - PAYMENT_METHOD_OPTIONS
      - PAYMENT_SCHEDULE
      - PAYMENT_REQUEST
      - INTEGRATION
      - WEBHOOK
      - FILE
      - FILE_PROCESSING_SETTINGS
      - TEAM
      - DOWNLOAD_URL
      - CSV_REPORT
      - REPORT
      - REPORT_GENERATE_REQUEST
      - REPORT_CONFIGURATION
      - REPORT_SUBSCRIPTION
      - REPORT_DEFINITION
      - ACCOUNT_GROUP
      - ENTITY
      - EVENT_TRACE
      - EVENT_TRACE_LINK
      - PRICING_CATEGORY
      - CONTACT
      - ALERT_RULE
      - ALERT
      - AUDIT_RECORD
      - PORTAL_URL
      - AUTHENTICATION_PROVIDER
      - REPROCESS
      - APPROVAL_POLICY
      - APPROVAL_REQUEST
      - BULK_ACTION
      - COUPON
      - PROMOTION_CODE
      - WALLET
      - WALLET_TYPE
      - WALLET_GRANT
      - WORKFLOW
      - WORKFLOW_TRIGGER
      - WORKFLOW_ACTION
      - CREDIT_TYPE
      - SIGNATURE_REQUEST
      - ATTACHMENT
      - DOCUMENT
      title: ApiErrorResourceType
    MeterValueMappingDefaultValue:
      type: object
      properties:
        number:
          $ref: '#/components/schemas/DefaultValue'
        amount:
          $ref: '#/components/schemas/MeterValueMappingAmountDefaultValue'
      title: MeterValueMappingDefaultValue
    ApiErrorCode:
      type: string
      enum:
      - RESOURCE_NOT_FOUND
      - RESOURCES_NOT_FOUND
      - UNABLE_TO_PROCESS_INSTRUCTIONS
      - BAD_REQUEST
      - UNSUPPORTED_MEDIA_TYPE
      - RESOURCE_ALREADY_EXISTS
      - CUSTOM_FIELD_VALUE_ALREADY_EXISTS
      - COULD_NOT_CREATE_RESOURCE
      - COULD_NOT_UPDATE_RESOURCE
      - COULD_NOT_DELETE_RESOURCE
      - MISSING_VERSION
      - UNSUPPORTED_VERSION
      - UNAUTHORISED
      - CUSTOMER_NOT_FOUND
      - PLATFORM_NOT_FOUND
      - PRICING_PLAN_NOT_FOUND
      - PRODUCT_NOT_FOUND
      - PRODUCT_ITEM_NOT_FOUND
      - PRICING_NOT_FOUND
      - PRICING_ITEM_NOT_FOUND
      - USER_NOT_FOUND
      - METER_NOT_FOUND
      - METER_VALUE_NOT_FOUND
      - METER_PROPERTY_NOT_FOUND
      - PRICING_ITEM_SUMMARIES_NOT_FOUND
      - MISSING_ID
      - INVALID_ID
      - MISSING_REFERENCE
      - MISSING_FIELD
      - INVALID_FIELD
      - INVALID_OPERATION
      - INTERNAL_ERROR
      - USER_NOT_ALLOWED
      - IDEMPOTENCY_CHECK_FAILED
      - INVALID_REQUEST
      title: ApiErrorCode
    MeterValueMappingColumnAmount:
      type: object
      properties:
        quantity:
          type: string
        currency:
          type: string
      title: MeterValueMappingColumnAmount
    CustomerReferencesCreateRequest:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
        custom_field_value:
          type:
          - string
          - 'null'
      title: CustomerReferencesCreateRequest
    IngestReferenceMapping:
      type: object
      properties:
        column:
          type:
          - string
          - 'null'
        prefix:
          $ref: '#/components/schemas/ColumnMapping'
      title: IngestReferenceMapping
  securitySchemes:
    API-Key:
      type: apiKey
      in: header
      name: X-API-KEY
    JWT-Authentication:
      type: http
      scheme: bearer