openapi: 3.2.0
info:
  title: IO.Common Global Settings API
  version: '1.0'
security:
- OAuth2: []
tags:
- name: Global Settings
paths:
  /v1/GlobalSettings/types:
    get:
      tags:
      - Global Settings
      summary: Get all global settings types
      operationId: GetGlobalSettingsTypesList
      parameters:
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetGlobalSettingsTypeResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Get global settings types list
  /v1/GlobalSettings:
    get:
      tags:
      - Global Settings
      summary: Get all existing global settings
      operationId: GetGlobalSettingsList
      parameters:
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSettingsResponsePagedResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Get global settings list
    post:
      tags:
      - Global Settings
      summary: Create a new global setting
      operationId: CreateGlobalSetting
      parameters:
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      requestBody:
        description: ''
        content:
          application/json-patch+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/CreateGlobalSettingRequest'
          application/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/CreateGlobalSettingRequest'
          text/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/CreateGlobalSettingRequest'
          application/*+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/CreateGlobalSettingRequest'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Create global setting
  /v1/GlobalSettings/{id}:
    get:
      tags:
      - Global Settings
      summary: Get a global setting by id
      operationId: GetAGlobalSettingByIt'sId
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGlobalSettingResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Get a global setting by it's id
    put:
      tags:
      - Global Settings
      summary: Change the value of a global setting
      operationId: ChangeGlobalSetting
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      requestBody:
        description: ''
        content:
          application/json-patch+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateGlobalSettingRequest'
          application/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateGlobalSettingRequest'
          text/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateGlobalSettingRequest'
          application/*+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateGlobalSettingRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSettingsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Change global setting
    delete:
      tags:
      - Global Settings
      summary: Delete a global setting by it's id
      operationId: DeleteGlobalSetting
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSettingsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Delete global setting
  /v1/GlobalSettings/bulk:
    put:
      tags:
      - Global Settings
      summary: Update multiple global settings with new values and types
      operationId: BulkUpdateGlobalSettings
      parameters:
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      requestBody:
        description: ''
        content:
          application/json-patch+json; x-api-version=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkUpdateGlobalSettingRequest'
          application/json; x-api-version=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkUpdateGlobalSettingRequest'
          text/json; x-api-version=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkUpdateGlobalSettingRequest'
          application/*+json; x-api-version=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkUpdateGlobalSettingRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSettingsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Bulk update global settings
  /v1/GlobalSettings/logo:
    get:
      tags:
      - Global Settings
      summary: Get tenant logo URL
      operationId: GetTenantLogo
      parameters:
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Get tenant logo
    post:
      tags:
      - Global Settings
      summary: Upload Tenant logo
      operationId: UploadTenantLogo
      parameters:
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                LogoImage:
                  type: string
                  format: binary
            encoding:
              LogoImage:
                style: form
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSettingsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Upload tenant logo
  /v1/GlobalSettings/logo/url:
    post:
      tags:
      - Global Settings
      summary: Update tenant logo URL
      operationId: UpdateTenantLogoURL
      parameters:
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      requestBody:
        description: ''
        content:
          application/json-patch+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateLogoUrlRequest'
          application/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateLogoUrlRequest'
          text/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateLogoUrlRequest'
          application/*+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateLogoUrlRequest'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
      x-operation-id-source: normalized
      x-operation-id-original: Update tenant logo URL
components:
  schemas:
    GlobalSettingsResponsePagedResult:
      type: object
      properties:
        pageSize:
          type: integer
          format: int32
          readOnly: true
        page:
          type: integer
          format: int32
          readOnly: true
        totalCount:
          type: integer
          format: int32
          readOnly: true
        filteredCount:
          type: integer
          format: int32
          readOnly: true
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GlobalSettingsResponse'
          readOnly: true
      additionalProperties: false
    ApiErrorResponse:
      type: object
      properties:
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    GlobalSettingsResponse:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        isReserved:
          type: boolean
        type:
          $ref: '#/components/schemas/GlobalSettingType'
      additionalProperties: false
    UpdateLogoUrlRequest:
      type: object
      properties:
        imageUrl:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetGlobalSettingResponse:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        isReserved:
          type: boolean
        type:
          $ref: '#/components/schemas/GlobalSettingType'
      additionalProperties: false
    BulkUpdateGlobalSettingRequest:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/GlobalSettingType'
      additionalProperties: false
    CreateGlobalSettingRequest:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/GlobalSettingType'
      additionalProperties: false
    Error:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetGlobalSettingsTypeResponse:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        value:
          $ref: '#/components/schemas/GlobalSettingType'
      additionalProperties: false
    GlobalSettingType:
      enum:
      - 0
      - 1
      - 100
      - 101
      - 102
      - 103
      - 200
      - 201
      - 203
      - 500
      - 1000
      - 2000
      - 3000
      type: integer
      format: int32
    UpdateGlobalSettingRequest:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/GlobalSettingType'
      additionalProperties: false
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://identity.scanbro.com/connect/authorize
          tokenUrl: https://identity.scanbro.com/connect/token
          scopes:
            io.common: default scope