# -*- coding: utf-8 -*-
openapi: 3.0.1
info:
  title: Integration Platform Reseller API
  description: |
    Welcome to the Integration Platform Reseller API reference documentation. For general information, please read <a href="/docs/index.html" target="_blank">Integration Platform Developer Guide</a>.

  version: "9"
  # Don't forget to change the following files:
  # admin.yaml
  # plugboard.yaml
  # ApiInfo
servers:
  - url: /reseller
security:
  - basicAuth: []
    resellerName: []
paths:
  /:
    get:
      tags:
      - API Root
      summary: API Information.
      description: Returns information about the API.
      parameters:
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: The API info structure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResellerApiInfo'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/:
    get:
      tags:
      - Tenant
      summary: List all tenants for this reseller.
      parameters:
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: The tenants
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tenant'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    post:
      tags:
      - Tenant
      summary: Create a new tenant.
      parameters:
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantCreate'
        required: true
      responses:
        200:
          description: The tenant
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
      x-codegen-request-body-name: body
  /tenant/{codeName}:
    get:
      tags:
      - Tenant
      summary: Get a specific tenant for this reseller.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: The tenant
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    put:
      tags:
      - Tenant
      summary: Edit tenant.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantUpdate'
        required: true
      responses:
        200:
          description: |
            The tenant. If the field options is updated it automatically appends
            to the exinsting list of options.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
      x-codegen-request-body-name: body
    delete:
      tags:
      - Tenant
      summary: Deletes this tenant.
      parameters:
      - $ref: '#/components/parameters/codeName'
      responses:
        204:
          description: Item deleted, no response data sent.
          content: {}
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        404:
          description: |
            The object referenced by the url (id, etc) doesn't exist.
          content:
            application/json:
              schema:
                $ref: 'plugboard.yaml#/components/schemas/NotFoundError'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'

  /tenant/{codeName}/login/:
    post:
      tags:
      - Tenant
      summary: Create a login url to login the reseller as a tenant user
      description: |
        Creates a temporary url that will automatically login as the
        the reseller user. The optional parameter path in the body allows
        to specify the path that will be loaded after the login.

        **This endpoint is experimental and might be subject to change**
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserLoginUrl'
        required: false
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserLoginUrl'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'

  /tenant/{codeName}/login/{login}:
    post:
      tags:
      - Tenant
      summary: Create a login url for a specific tenant user
      description: |
        Creates a temporary url that will automatically login as the
        specified user (not as the current reseller user).
        The optional parameter path in the body allows to specify
        the path that will be loaded after the login.

        **This endpoint is experimental and might be subject to change**
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: '#/components/parameters/login'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserLoginUrl'
        required: false
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserLoginUrl'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'

  /tenant/{codeName}/options:
    get:
      tags:
      - Tenant
      summary: List all options enabled for tenant.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: |
            The tenant. All available tenantOptions are found in:
            https://api.next.plugboard.io/reseller/.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    put:
      tags:
      - Tenant
      summary: Overwrite options for tenant.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        200:
          description: |
            The options. Replaces the existing options with the updated options.
            All available tenantOptions are found in:
            https://api.next.plugboard.io/reseller/.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
      x-codegen-request-body-name: body
    post:
      tags:
      - Tenant
      summary: Add new options for tenant.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        200:
          description: |
            The options. Appends the option to the existing list of options.
            All available tenantOptions are found in:
            https://api.next.plugboard.io/reseller/.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
      x-codegen-request-body-name: body
    delete:
      tags:
      - Tenant
      summary: Delete specified options from tenant.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        200:
          description: The options
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
      x-codegen-request-body-name: body
  /tenant/{codeName}/user:
    get:
      tags:
      - Tenant
      summary: List all users for this tenant.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: List of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    post:
      tags:
      - Tenant
      summary: Create a new user.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
        required: true
      responses:
        200:
          description: The options
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
      x-codegen-request-body-name: body
  /tenant/{codeName}/user/{login}:
    get:
      tags:
      - Tenant
      summary: Retrieve a user
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: '#/components/parameters/login'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    delete:
      tags:
      - Tenant
      summary: Retrieve a user
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: '#/components/parameters/login'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        204:
          description: Item deleted, no response data sent.
          content: {}
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        404:
          description: |
            The object referenced by the url (id, etc) doesn't exist.
          content:
            application/json:
              schema:
                $ref: 'plugboard.yaml#/components/schemas/NotFoundError'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'

  /tenant/{codeName}/connection:
    get:
      tags:
      - Tenant
      summary: Get all connections this tenant has.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: 'plugboard.yaml#/components/schemas/Connection'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    post:
      tags:
      - Tenant
      summary: Create a connection for this tenant
      description: |
        **This endpoint is experimental and might be subject to change**
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: 'plugboard.yaml#/components/schemas/Connection'
                - required:
                  - configuration
                  properties:
                    configuration:
                      type: string
                      description: |
                        Configuration is unique per connection. Contact us
                        for more details.
        required: true
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                allOf:
                - $ref: 'plugboard.yaml#/components/schemas/Connection'
                - properties:
                    type:
                      description: |
                        Only types that matches the tenants options
                        will be allowed.
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/{codeName}/connection/{id}:
    get:
      tags:
      - Tenant
      summary: Get specific connection this tenant has.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/id'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: 'plugboard.yaml#/components/schemas/Connection'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    put:
      tags:
      - Tenant
      summary: Update a specific connection for this tenant
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/id'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: 'plugboard.yaml#/components/schemas/Connection'
                - properties:
                    configuration:
                      type: string
                      description: |
                        Configuration is unique per connection. Contact us
                        for more details.
        required: true
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                allOf:
                - $ref: 'plugboard.yaml#/components/schemas/Connection'
                - properties:
                    type:
                      readOnly: true
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'

  /tenant/{codeName}/connection/{localId}/plug:
    get:
      tags:
      - Tenant
      summary: Get plugs for the selected connection
      description: |
        **This endpoint is experimental and might be subject to change**
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/localId'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: 'plugboard.yaml#/components/schemas/ConnectionPlug'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    put:
      tags:
      - Tenant
      summary: Update multiple connection plugs
      description: |
        **This endpoint is experimental and might be subject to change**
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/localId'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              $ref: 'plugboard.yaml#/components/schemas/ConnectionPlugs'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: 'plugboard.yaml#/components/schemas/ConnectionPlug'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/{codeName}/connection/{localId}/plug/{code}:
    get:
      tags:
      - Tenant
      summary: Get a specific plug for the selected connection
      description: |
        **This endpoint is experimental and might be subject to change**
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/localId'
      - $ref: 'plugboard.yaml#/components/parameters/plugCode'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: 'plugboard.yaml#/components/schemas/ConnectionPlug'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
    put:
      tags:
      - Tenant
      summary: Update a specific plug for the selected connection
      description: |
        **This endpoint is experimental and might be subject to change**
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/localId'
      - $ref: 'plugboard.yaml#/components/parameters/plugCode'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: 'plugboard.yaml#/components/schemas/ConnectionPlug'
                - properties:
                    code:
                      readOnly: true
                    direction:
                      readOnly: true
                    recordType:
                      readOnly: true
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: 'plugboard.yaml#/components/schemas/ConnectionPlug'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'

  /tenant/{codeName}/order/:
    get:
      tags:
      - Tenant
      summary: Lists all orders.
      description: |
        Same format as base api order object.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/modifiedAtOrAfter'
      - $ref: 'plugboard.yaml#/components/parameters/remoteOrderNo'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: 'plugboard.yaml#/components/schemas/Order'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/{codeName}/order/{localId}:
    get:
      tags:
      - Tenant
      summary: Get specific order created by the tenant
      description: |
        Same format as base api order object.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/localId'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: 'plugboard.yaml#/components/schemas/Order'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/{codeName}/log/event/:
    get:
      tags:
      - Tenant
      summary: List all log events after certain time.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      - $ref: 'plugboard.yaml#/components/parameters/eventAtOrAfter'
      - $ref: 'plugboard.yaml#/components/parameters/severity'
      - $ref: 'plugboard.yaml#/components/parameters/fetchRelIdMsgs'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: 'plugboard.yaml#/components/schemas/LogItem'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/{codeName}/log/event/{id}:
    get:
      tags:
      - Tenant
      summary: Get a specific event
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/id'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      - $ref: 'plugboard.yaml#/components/parameters/eventAtOrAfter'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: 'plugboard.yaml#/components/schemas/LogItem'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/{codeName}/log/transferreport/:
    get:
      tags:
      - Tenant
      summary: List all transfer reports after a certain time.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      - $ref: 'plugboard.yaml#/components/parameters/eventAtOrAfter'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransferReport'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/{codeName}/log/transferreport/{id}:
    get:
      tags:
      - Tenant
      summary: List a transfer report.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: 'plugboard.yaml#/components/parameters/id'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferReportEntry'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /tenant/{codeName}/log/transferreport/by-request-id/{requestId}:
    get:
      tags:
      - Tenant
      summary: List all transfer reports related to a requestId.
      parameters:
      - $ref: '#/components/parameters/codeName'
      - $ref: '#/components/parameters/requestId'
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransferReport'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /stats/recordcounts/alltenants:
    get:
      tags:
      - Statistics
      summary: Retrieves per hour record counts for all tenants.
      parameters:
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      - $ref: 'plugboard.yaml#/components/parameters/fromHour'
      - $ref: 'plugboard.yaml#/components/parameters/toHour'
      - $ref: '#/components/parameters/tenantCodeName'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                    - properties:
                        tenant:
                          type: string
                    - $ref: 'plugboard.yaml#/components/schemas/RecordCounts'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
  /stats/transferstats/alltenants:
    get:
      tags:
      - Statistics
      summary: Retrieves transfer statistics for all tenants.
      parameters:
      - $ref: 'plugboard.yaml#/components/parameters/compactJson'
      - $ref: 'plugboard.yaml#/components/parameters/fromHour'
      - $ref: 'plugboard.yaml#/components/parameters/toHour'
      - $ref: '#/components/parameters/tenantCodeName'
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TenantTransferStatsSummary'
        400:
          $ref: 'plugboard.yaml#/components/responses/badRequestResp'
        401:
          $ref: 'plugboard.yaml#/components/responses/unAuthResp'
        403:
          $ref: 'plugboard.yaml#/components/responses/forbiddenResp'
        500:
          $ref: 'plugboard.yaml#/components/responses/internalServerError'
components:
  schemas:
    AttributeAttach:
      required:
      - values
      type: object
      properties:
        localId:
          $ref: 'plugboard.yaml#/components/schemas/localId'
        remoteId:
          type: string
          description: |
            A string that identifies this object for the current
            connection. This string is provided by the external system.
        isDeleted:
          type: boolean
          readOnly: true
        values:
          type: array
          items:
            type: object
            description: Values according to the attribute type.
            example: '...'
    UserLoginUrl:
      type: object
      properties:
        path:
          type: string
        loginUrl:
          type: string
          readOnly: true
        expires:
          format: dateTime
          readOnly: true
          example: 2015-01-02T03:04:05Z
    ResellerApiInfo:
      required:
      - allowableTenantOptions
      - permissions
      type: object
      properties:
        version:
          type: integer
          readOnly: true
          example: 1
        serverTime:
          type: string
          description: The server time in UTC.
          format: dateTime
          readOnly: true
          example: 2015-01-02T03:04:05Z
        permissions:
          type: array
          example:
          - api
          - product.export
          items:
            type: string
        allowableTenantOptions:
          type: array
          example:
          - api
          - api.sharespine.economic
          - attribute
          items:
            type: string
    TenantShort:
      type: object
      properties:
        codeName:
          type: string
          readOnly: true
        resellerCodeName:
          type: string
          readOnly: true
        customerReference:
          type: string
        active:
          type: boolean
        fullName:
          type: string
        email:
          type: string
    Tenant:
      type: object
      properties:
        codeName:
          type: string
          readOnly: true
        resellerCodeName:
          type: string
          readOnly: true
        customerReference:
          type: string
        active:
          type: boolean
        fullName:
          type: string
        email:
          type: string
        defaultLanguage:
          maxLength: 3
          minLength: 2
          type: string
          description: |
            The server WILL ALWAYS send language codes in ISO-639-2 format.

            The client MAY send either ISO-639-1 or ISO-639-2 language codes.
          format: language3
          example: swe
        languages:
          type: array
          items:
            maxLength: 3
            minLength: 2
            type: string
            description: |
              The server WILL ALWAYS send language codes in ISO-639-2 format.

              The client MAY send either ISO-639-1 or ISO-639-2 language codes.
            format: language3
            example: swe
        comments:
          type: string
        options:
          type: array
          items:
            type: string
    TenantUpdate:
      type: object
      properties:
        customerReference:
          type: string
        active:
          type: boolean
        fullName:
          type: string
        email:
          type: string
        defaultLanguage:
          maxLength: 3
          minLength: 2
          type: string
          description: |
            The server WILL ALWAYS send language codes in ISO-639-2 format.

            The client MAY send either ISO-639-1 or ISO-639-2 language codes.
          format: language3
          example: swe
        languages:
          type: array
          items:
            maxLength: 3
            minLength: 2
            type: string
            description: |
              The server WILL ALWAYS send language codes in ISO-639-2 format.

              The client MAY send either ISO-639-1 or ISO-639-2 language codes.
            format: language3
            example: swe
        options:
          type: array
          items:
            type: string
    TenantCreate:
      type: object
      properties:
        codeName:
          type: string
          description: If not provided, system will generate a code name for you.
        customerReference:
          type: string
        active:
          type: boolean
        fullName:
          type: string
        email:
          type: string
        defaultLanguage:
          maxLength: 3
          minLength: 2
          type: string
          description: |
            The server WILL ALWAYS send language codes in ISO-639-2 format.

            The client MAY send either ISO-639-1 or ISO-639-2 language codes.
          format: language3
          example: swe
        languages:
          type: array
          items:
            maxLength: 3
            minLength: 2
            type: string
            description: |
              The server WILL ALWAYS send language codes in ISO-639-2 format.

              The client MAY send either ISO-639-1 or ISO-639-2 language codes.
            format: language3
            example: swe
        options:
          type: array
          items:
            type: string
    UserCreate:
      type: object
      properties:
        login:
          type: string
        fullName:
          type: string
        email:
          type: string
        permissions:
          type: array
          items:
            type: string
        defaultLanguage:
          maxLength: 3
          minLength: 2
          type: string
          description: |
            The server WILL ALWAYS send language codes in ISO-639-2 format.

            The client MAY send either ISO-639-1 or ISO-639-2 language codes.
          format: language3
          example: swe
    User:
      type: object
      properties:
        login:
          type: string
        fullName:
          type: string
        email:
          type: string
        permissions:
          type: array
          items:
            type: string
        defaultLanguage:
          maxLength: 3
          minLength: 2
          type: string
          description: |
            The server WILL ALWAYS send language codes in ISO-639-2 format.

            The client MAY send either ISO-639-1 or ISO-639-2 language codes.
          format: language3
          example: swe
        tenantCodeName:
          type: string
        created:
          type: string
          description: |
            Date/time according to RFC 3339 format.

            The server will always send the datetime using the UTC time zone.
          format: dateTime
          readOnly: true
          example: 2015-01-02T03:04:05Z
        lastModified:
          type: string
          description: |
            Date/time according to RFC 3339 format.

            The server will always send the datetime using the UTC time zone.
          format: dateTime
          readOnly: true
          example: 2015-01-02T03:04:05Z
    OrderTotals:
      type: object
      properties:
        tenant:
          $ref: '#/components/schemas/TenantShort'
        totals:
          type: object
          properties:
            count:
              type: integer
    ProductTotals:
      type: object
      properties:
        tenant:
          $ref: '#/components/schemas/TenantShort'
        totals:
          type: object
          properties:
            count:
              type: integer
    TransferReport:
      type: object
      properties:
        tenant:
          $ref: '#/components/schemas/TenantShort'
        transferReport:
          type: object
          properties:
            connectionId:
              maxLength: 32
              minLength: 32
              type: string
              description: |
                A unique id.
                Case sensitive.
              readOnly: true
              example: 3fb2568eb7e165e34dd311af5550002b
            user:
              type: string
            when:
              type: string
              description: |
                Date/time according to RFC 3339 format.

                The server will always send the datetime using the UTC time zone.
              format: dateTime
              example: 2015-01-02T03:04:05Z
            reportId:
              maxLength: 32
              minLength: 32
              type: string
              description: |
                A unique id.
                Case sensitive.
              readOnly: true
              example: 3fb2568eb7e165e34dd311af5550002b
            relatedRequestId:
              maxLength: 32
              minLength: 32
              type: string
              description: |
                A unique id for the request that triggered the transaction
                that resulted in this report.
              readOnly: true
              example: 3fb2568eb7e165e34dd311af5550002b
            entries:
              type: array
              items:
                $ref: '#/components/schemas/TransferReportEntry'
    TransferReportEntry:
      type: object
      properties:
        type:
          type: string
        direction:
          type: string
        numTransferred:
          type: integer
        numCreated:
          type: integer
        numUpdated:
          type: integer
        numUnchanged:
          type: integer
        numFailed:
          type: integer
        numIgnored:
          type: integer
        generalError:
          type: string
        ignoreReasons:
          type: array
          items:
            $ref: '#/components/schemas/TransferReportMessage'
        perItemErrors:
          type: array
          items:
            $ref: '#/components/schemas/TransferReportMessage'
    TransferReportMessage:
      type: object
      properties:
        localId:
          maxLength: 32
          minLength: 32
          type: string
          description: |
            A unique id.
            Case sensitive.
          readOnly: true
          example: 3fb2568eb7e165e34dd311af5550002b
        displayId:
          type: string
        message:
          type: string
    TenantTransferStatsSummary:
      type: object
      properties:
        meta:
          type: object
          properties:
            hour:
              type: string
              description: |
                Date/time according to RFC 3339 format.

                The server will always send the datetime using the UTC time zone.
              format: dateTime
              example: 2015-01-02T03:04:05Z
            tenant:
              type: string
            recordType:
              type: string
            direction:
              type: string
        numberOfTransfers:
          type: integer
        numConsidered:
          type: integer
          description: The total number of records considered during this hour.
        numFailed:
          type: integer
          description: The total number of records that failed transfer.
        numIgnored:
          type: integer
          description: The total number of ignored records.
        numCreated:
          type: integer
        numUpdated:
          type: integer
        numUnchanged:
          type: integer
          description: Number of records transfered where no change occurred.
        numOther:
          type: integer
          description: |
            Number of records transferred where creation/update state could
            not be determined.
  parameters:
    codeName:
      name: codeName
      in: path
      description: |
        The the tenant value used to log in.
      required: true
      schema:
        type: string
    tenantCodeName:
      name: tenant
      in: query
      description: |
        The the tenant value used to log in.
      schema:
        type: string
    login:
      name: login
      in: path
      required: true
      schema:
        type: string
    requestId:
      name: requestId
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      description: HTTP Basic Auth parameters.
      scheme: basic
    resellerName:
      type: apiKey
      description: Reseller code name for your account.
      name: X-Reseller
      in: header