openapi: 3.2.0
info:
  title: Opoint Customers API
  version: 1.0.0
  description: 'Operations tagged customers across 2 of this provider''s published API definitions: opoint-openapi-original.yml, opoint-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.opoint.com
tags:
- name: Customers
paths:
  /customers/:
    get:
      operationId: customers_list
      tags:
      - Customers
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomerDetail'
              examples:
                CustomerDetailWithNavisionId:
                  value:
                  - id: 1
                    name: Test customer
                    partner: 1
                    is_active: true
                    is_educational: false
                    max_num_users: 100
                    num_users: 34
                    navision_id: NO123456
                  summary: customer_detail_with_navision_id
          description: ''
      summary: Customers list
      x-summary-source: derived
    post:
      operationId: customers_create
      tags:
      - Customers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerDetail'
            examples:
              CustomerDetail:
                value:
                  id: 1
                  name: Test customer
                  partner: 1
                  is_active: true
                  is_educational: false
                  max_num_users: 100
                  num_users: 34
                summary: customer_detail
              CustomerDetailWithNavisionId:
                value:
                  id: 1
                  name: Test customer
                  partner: 1
                  is_active: true
                  is_educational: false
                  max_num_users: 100
                  num_users: 34
                  navision_id: NO123456
                summary: customer_detail_with_navision_id
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomerDetail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomerDetail'
        required: true
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDetail'
              examples:
                CustomerDetailWithNavisionId:
                  value:
                    id: 1
                    name: Test customer
                    partner: 1
                    is_active: true
                    is_educational: false
                    max_num_users: 100
                    num_users: 34
                    navision_id: NO123456
                  summary: customer_detail_with_navision_id
          description: ''
      summary: Customers create
      x-summary-source: derived
    servers:
    - url: https://api.opoint.com
  /customers/{id_customer}/:
    get:
      operationId: customers_retrieve
      parameters:
      - in: path
        name: id_customer
        schema:
          type: integer
        description: A unique integer value identifying this opoint customer.
        required: true
      tags:
      - Customers
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDetail'
              examples:
                CustomerDetailWithNavisionId:
                  value:
                    id: 1
                    name: Test customer
                    partner: 1
                    is_active: true
                    is_educational: false
                    max_num_users: 100
                    num_users: 34
                    navision_id: NO123456
                  summary: customer_detail_with_navision_id
          description: ''
      summary: Customers retrieve
      x-summary-source: derived
    put:
      operationId: customers_update
      parameters:
      - in: path
        name: id_customer
        schema:
          type: integer
        description: A unique integer value identifying this opoint customer.
        required: true
      tags:
      - Customers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerDetail'
            examples:
              CustomerDetail:
                value:
                  id: 1
                  name: Test customer
                  partner: 1
                  is_active: true
                  is_educational: false
                  max_num_users: 100
                  num_users: 34
                summary: customer_detail
              CustomerDetailWithNavisionId:
                value:
                  id: 1
                  name: Test customer
                  partner: 1
                  is_active: true
                  is_educational: false
                  max_num_users: 100
                  num_users: 34
                  navision_id: NO123456
                summary: customer_detail_with_navision_id
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomerDetail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomerDetail'
        required: true
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDetail'
              examples:
                CustomerDetailWithNavisionId:
                  value:
                    id: 1
                    name: Test customer
                    partner: 1
                    is_active: true
                    is_educational: false
                    max_num_users: 100
                    num_users: 34
                    navision_id: NO123456
                  summary: customer_detail_with_navision_id
          description: ''
      summary: Customers update
      x-summary-source: derived
    patch:
      operationId: customers_partial_update
      parameters:
      - in: path
        name: id_customer
        schema:
          type: integer
        description: A unique integer value identifying this opoint customer.
        required: true
      tags:
      - Customers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCustomerDetail'
            examples:
              CustomerDetail:
                value:
                  id: 1
                  name: Test customer
                  partner: 1
                  is_active: true
                  is_educational: false
                  max_num_users: 100
                  num_users: 34
                summary: customer_detail
              CustomerDetailWithNavisionId:
                value:
                  id: 1
                  name: Test customer
                  partner: 1
                  is_active: true
                  is_educational: false
                  max_num_users: 100
                  num_users: 34
                  navision_id: NO123456
                summary: customer_detail_with_navision_id
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCustomerDetail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCustomerDetail'
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDetail'
              examples:
                CustomerDetailWithNavisionId:
                  value:
                    id: 1
                    name: Test customer
                    partner: 1
                    is_active: true
                    is_educational: false
                    max_num_users: 100
                    num_users: 34
                    navision_id: NO123456
                  summary: customer_detail_with_navision_id
          description: ''
      summary: Customers partial update
      x-summary-source: derived
    servers:
    - url: https://api.opoint.com
  /customers/{id_customer}/usage/:
    get:
      operationId: customers_usage_retrieve_detail
      parameters:
      - in: query
        name: anomalies
        schema:
          type: string
        description: 'Comma-separated metrics to annotate with anomaly scores: requests, articles, tokens'
      - in: query
        name: delivery
        schema:
          type: string
          enum:
          - safefeed
          - search
          - storedsearch
        required: true
      - in: query
        name: from
        schema:
          type: string
        description: Start date (YYYY-MM-DD, inclusive), default 14 days ago
      - in: path
        name: id_customer
        schema:
          type: integer
        description: A unique integer value identifying this opoint customer.
        required: true
      - in: query
        name: to
        schema:
          type: string
        description: End date (YYYY-MM-DD, exclusive), default tomorrow
      tags:
      - Customers
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerUsageResponse'
          description: ''
      summary: Customers usage retrieve detail
      x-summary-source: derived
    servers:
    - url: https://api.opoint.com
  /customers/search/:
    get:
      operationId: customers_search_list
      description: 'Searches for customer.


        Performs a case-insensitive search against customers names.'
      parameters:
      - in: query
        name: page_size
        schema:
          type: integer
          maximum: 500
          minimum: 1
        description: Maximum number of results to return
      - in: query
        name: q
        schema:
          type: string
        description: Search term
        required: true
      tags:
      - Customers
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Customer'
              examples:
                Customer:
                  value:
                  - id: 1
                    name: Test customer
                    partner: 1
                  summary: customer
          description: ''
      summary: Customers search list
      x-summary-source: derived
    servers:
    - url: https://api.opoint.com
  /customers/self/usage/:
    get:
      operationId: customers_self_usage_retrieve
      parameters:
      - in: query
        name: delivery
        schema:
          type: string
          enum:
          - safefeed
          - search
          - storedsearch
        description: 'Default: search'
      - in: query
        name: from
        schema:
          type: string
        description: Start date (YYYY-MM-DD, inclusive), default 14 days ago
      - in: query
        name: only_totals
        schema:
          type: boolean
        description: If true, omit per-entity breakdown and return totals only
      - in: query
        name: to
        schema:
          type: string
        description: End date (YYYY-MM-DD, exclusive), default tomorrow
      tags:
      - Customers
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerUsageResponse'
          description: ''
      summary: Customers self usage retrieve
      x-summary-source: derived
    servers:
    - url: https://api.opoint.com
  /customers/usage/:
    get:
      operationId: customers_usage_retrieve
      parameters:
      - in: query
        name: anomalies
        schema:
          type: string
        description: 'Comma-separated metrics to annotate with anomaly scores: requests, articles, tokens'
      - in: query
        name: delivery
        schema:
          type: string
          enum:
          - safefeed
          - search
          - storedsearch
        required: true
      - in: query
        name: from
        schema:
          type: string
        description: Start date (YYYY-MM-DD, inclusive), default 14 days ago
      - in: query
        name: to
        schema:
          type: string
        description: End date (YYYY-MM-DD, exclusive), default tomorrow
      tags:
      - Customers
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerUsageListResponse'
          description: ''
      summary: Customers usage retrieve
      x-summary-source: derived
    servers:
    - url: https://api.opoint.com
components:
  schemas:
    CustomerUsageListEntry:
      type: object
      properties:
        id_customer:
          type: integer
        name:
          type: string
        totals:
          $ref: '#/components/schemas/UsageDataPoint'
        deliveries:
          type: array
          items:
            $ref: '#/components/schemas/UsageDelivery'
      required:
      - deliveries
      - id_customer
      - name
      - totals
    Customer:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          description: Customers name
          maxLength: 255
        partner:
          type: integer
          minimum: 0
      required:
      - id
      - name
      - partner
    CustomerUsageListResponse:
      type: object
      properties:
        delivery:
          type: string
        customers:
          type: array
          items:
            $ref: '#/components/schemas/CustomerUsageListEntry'
      required:
      - customers
      - delivery
    UsageDataPoint:
      type: object
      properties:
        from_ts:
          type: integer
          description: Unix timestamp (UTC) of interval start (inclusive)
        to_ts:
          type: integer
          description: Unix timestamp (UTC) of interval end (exclusive)
        requests:
          type: integer
        articles:
          type: integer
        tokens:
          type: integer
        ratio:
          type: number
          format: double
          description: Articles per request
        gaps:
          type: integer
          description: 'Safefeed only: missing articles in expected sequence'
        overlaps:
          type: integer
          description: 'Safefeed only: duplicate articles delivered'
        anomaly_scores:
          type: object
          additionalProperties:
            type: number
            format: double
          description: Per-metric anomaly scores; only present when the anomalies param is used
      required:
      - articles
      - from_ts
      - ratio
      - requests
      - to_ts
      - tokens
    CustomerUsageResponse:
      type: object
      properties:
        delivery:
          type: string
        totals:
          $ref: '#/components/schemas/UsageDataPoint'
        deliveries:
          type: array
          items:
            $ref: '#/components/schemas/UsageDelivery'
      required:
      - delivery
      - totals
    UsageDelivery:
      type: object
      properties:
        type:
          type: string
        id:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/UsageDataPoint'
      required:
      - data
      - id
      - type
    CustomerDetail:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          description: Customers name
          maxLength: 255
        partner:
          type: integer
          minimum: 0
        is_active:
          type: boolean
          description: Customers active status. When the customer is inactive, users can no longer login. Currently not enforced
        is_educational:
          type: boolean
          description: Whether customer is an educational institution
        is_opoint:
          type: boolean
          default: false
          description: Specifies if the user is owned by opoint or not
        max_num_users:
          type:
          - integer
          - 'null'
          minimum: 1
        navision_id:
          type: string
          description: Customers navision id
        salesforce_id:
          type: string
          description: Customers salesforce id
        num_users:
          type: integer
          readOnly: true
          description: Number of users the customer has signed up
      required:
      - id
      - max_num_users
      - name
      - num_users
      - partner
    PatchedCustomerDetail:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          description: Customers name
          maxLength: 255
        partner:
          type: integer
          minimum: 0
        is_active:
          type: boolean
          description: Customers active status. When the customer is inactive, users can no longer login. Currently not enforced
        is_educational:
          type: boolean
          description: Whether customer is an educational institution
        is_opoint:
          type: boolean
          default: false
          description: Specifies if the user is owned by opoint or not
        max_num_users:
          type:
          - integer
          - 'null'
          minimum: 1
        navision_id:
          type: string
          description: Customers navision id
        salesforce_id:
          type: string
          description: Customers salesforce id
        num_users:
          type: integer
          readOnly: true
          description: Number of users the customer has signed up
  securitySchemes:
    JWT:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "JWT"
    cookieAuth:
      type: apiKey
      in: cookie
      name: PHPSESSID
    ephmeralId:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Ephemeral"
    staticToken:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
x-refined-from:
- opoint-openapi-original.yml
- opoint-openapi.yml