openapi: 3.0.1
info:
  title: Uberall API
  description: Enhance your application with Uberall's comprehensive API documentation
  contact:
    name: Support
    url: https://uberall.com
    email: api@uberall.com
  license:
    name: Licensed under Uberall
    url: https://uberall.com/en-us/uberall-terms-and-conditions
  version: '20250204'
  x-logo:
    url: https://uberall.com/images/uberall-logo-white.svg
servers:
  - url: https://uberall.com/api
tags:
  - name: Users
    description: Set up - Users
    x-group: Set up
  - name: Auto Response
    description: Products - Auto Response
    x-group: Products
  - name: Batch Operation
    description: Locations Hub - Locations - Batch Operations (excel)
    x-group: Locations Hub
  - name: Brand Data Points
    description: Products - Brand Data Points
    x-group: Products
  - name: Business Connections
    description: Set up - Business Connections
    x-group: Set up
  - name: Businesses
    description: Set up - Businesses
    x-group: Set up
  - name: Categories
    description: Locations Hub - Categories
    x-group: Locations Hub
  - name: Collection Management
    description: Locations Hub - Collections - Collection Management
    x-group: Locations Hub
  - name: Content List
    description: Locations Hub - Collections - Content List
    x-group: Locations Hub
  - name: Locations Data
    description: Locations Hub - Locations Data
    x-group: Locations Hub
  - name: Custom Items
    description: Locations Hub - Collections - Custom Items
    x-group: Locations Hub
  - name: Dashboard
    description: Products - Analytics - Dashboard
    x-group: Products
  - name: Dashboard Exports
    description: Products - Analytics - Dashboard Exports
    x-group: Products
  - name: Data Points
    description: Products - Data Points
    x-group: Products
  - name: Data Point Filters
    description: Products - Data Points - Data Point Filters
    x-group: Products
  - name: Configuration
    description: Set up - Configuration
    x-group: Set up
  - name: Sales Partners
    description: Set up - Tenancy - Sales Partners
    x-group: Set up
  - name: Events
    description: Locations Hub - Collections - Events
    x-group: Locations Hub
  - name: Listings
    description: Locations Hub - Locations - Listings
    x-group: Locations Hub
  - name: Labels
    description: Locations Hub - Labels
    x-group: Locations Hub
  - name: Location Groups
    description: Locations Hub - Location Groups
    x-group: Locations Hub
  - name: Menu Items
    description: Locations Hub - Locations - Menu Items
    x-group: Locations Hub
  - name: Monitoring
    description: Set up - API Status
    x-group: Set up
  - name: Persons
    description: Locations Hub - Locations - Persons
    x-group: Locations Hub
  - name: Locations Photos
    description: Locations Hub - Locations Photos
    x-group: Locations Hub
  - name: Products
    description: Locations Hub - Locations - Product
    x-group: Locations Hub
  - name: Product Plans
    description: Set up - Tenancy - Product Plans
    x-group: Set up
  - name: Templates
    description: Products - Response Library - Templates
    x-group: Products
  - name: Service Items
    description: Locations Hub - Locations - Service Items
    x-group: Locations Hub
  - name: Social Posting
    description: Products - Social Posting
    x-group: Products
  - name: Social Posting Templates
    description: Products - Social Posting - Social Posting Templates
    x-group: Products
  - name: Digital Asset Management
    description: Products - Digital Asset Management
    x-group: Products
  - name: Status Check
    description: Products - Status Check
    x-group: Products
  - name: Store Finder
    description: Products - Store Finder
    x-group: Products
  - name: Suggestions
    description: Locations Hub - Locations - Suggestions
    x-group: Locations Hub
  - name: Webhooks
    description: Set up - Tenancy - Sales Partners - Webhooks
    x-group: Set up
paths:
  /users/login:
    post:
      tags:
        - Users
      summary: Provide an access_token for the user
      description: >-
        Provides an access_token for the email or the userId provided in the
        LoginCommand.</br>

        The accepted couples are:

        </br>[email, password]</br>

        [email, private_key]</br>

        [userId, private_key]
      operationId: post_users_login
      requestBody:
        description: A LoginCommand object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginCommand'
        required: true
      responses:
        '200':
          description: User successfully authenticated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LoginResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
  /auto-response/rules/check-conflict:
    post:
      tags:
        - Auto Response
      summary: Check for Auto Response Rule conflicts
      description: >-
        Check if there are any other Auto Response Rules that have status
        ACTIVE, apply to at least one of the businesses or locations in this
        request, and share at least one of the triggers in this request. When
        editing an existing Auto Response Rule, its id should be passed in
        ignoreRule so that it is not returned as a false positive.
      operationId: post_auto_response_rules_check_conflict
      requestBody:
        description: A CheckConflictRequest object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckConflictRequest'
        required: true
      responses:
        '200':
          description: Checking for conflicts completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingRulesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /auto-response/rules:
    get:
      tags:
        - Auto Response
      summary: List Auto Response Rules with filters
      description: List Auto Response Rules with filters
      operationId: get_auto_response_rules
      parameters:
        - name: businesses
          in: query
          description: >-
            Only return Auto Response Rules identified by the business ids
            listed in businesses
          schema:
            type: array
            items:
              type: string
        - name: locations
          in: query
          description: >-
            Only return Auto Response Rules identified by the location ids
            listed in locations
          schema:
            type: array
            items:
              type: string
        - name: excludedLocations
          in: query
          description: List of location ids that should be excluded from the result
          schema:
            type: array
            items:
              type: string
        - name: page
          in: query
          description: Used for pagination
          schema:
            type: integer
            format: int64
            default: 0
        - name: size
          in: query
          description: Used for pagination
          schema:
            type: integer
            format: int64
            default: 10
        - name: sort
          in: query
          description: Field to sort the results in, use created_by, date_created or id
          schema:
            type: string
        - name: direction
          in: query
          description: >-
            Direction to sort the results in, use asc for ascending sort or desc
            for descending sort
          schema:
            type: string
      responses:
        '200':
          description: Auto Response Rules retrieved.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RulesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Auto Response
      summary: Create an Auto Response Rule
      description: Create an Auto Response Rule
      operationId: post_auto_response_rules
      requestBody:
        description: Auto Response Rule to be created
        content:
          '*/*':
            schema:
              type: object
              properties:
                businesses:
                  type: array
                  items:
                    type: integer
                    format: int64
                locations:
                  type: array
                  items:
                    type: integer
                    format: int64
                excludedLocations:
                  type: array
                  items:
                    type: integer
                    format: int64
                name:
                  type: string
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - INACTIVE
                    - DELETED
                triggers:
                  type: array
                  items:
                    type: string
                responses:
                  type: array
                  items:
                    $ref: '#/components/schemas/ResponseValue'
                ruleResponses:
                  type: array
                  items:
                    $ref: '#/components/schemas/ResponseValue'
        required: true
      responses:
        '200':
          description: Auto Response Rule created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RuleResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /auto-response/rules/{id}:
    get:
      tags:
        - Auto Response
      summary: Get an Auto Response Rule
      description: Get an Auto Response Rule
      operationId: get_auto_response_rules_id
      parameters:
        - name: id
          in: path
          description: id of Auto Response Rule
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Auto Response Rule retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RuleResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Auto Response
      summary: Delete an Auto Response Rule
      description: >-
        Delete an Auto Response Rule. Only rules that can be edited by the
        current user can be deleted
      operationId: delete_auto_response_rules_id
      parameters:
        - name: id
          in: path
          description: id of Auto Response Rule
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Auto Response Rule deleted.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Auto Response
      summary: Edit an Auto Response Rule
      description: >-
        Edit an Auto Response Rule. The current user can edit this rule when
        they have access to all businesses and locations that identify this
        rule.
      operationId: patch_auto_response_rules_id
      parameters:
        - name: id
          in: path
          description: id of Auto Response Rule
          required: true
          schema:
            type: string
      requestBody:
        description: Auto Response Rule to be edited
        content:
          '*/*':
            schema:
              type: object
              properties:
                businesses:
                  type: array
                  items:
                    type: integer
                    format: int64
                locations:
                  type: array
                  items:
                    type: integer
                    format: int64
                excludedLocations:
                  type: array
                  items:
                    type: integer
                    format: int64
                name:
                  type: string
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - INACTIVE
                    - DELETED
                triggers:
                  type: array
                  items:
                    type: string
                responses:
                  type: array
                  items:
                    $ref: '#/components/schemas/ResponseValue'
                ruleResponses:
                  type: array
                  items:
                    $ref: '#/components/schemas/ResponseValue'
        required: true
      responses:
        '200':
          description: Auto Response Rule updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /batch:
    get:
      tags:
        - Batch Operation
      summary: Get all Location Imports
      description: Returns a list of all existing location imports for the current user
      operationId: get_batch
      parameters:
        - name: max
          in: query
          description: Used for pagination. Maximum number of results per page
          schema:
            type: integer
            format: int64
            default: 10
        - name: offset
          in: query
          description: Offset used for pagination
          schema:
            type: integer
            format: int64
            default: 0
        - name: sort
          in: query
          description: Order results by the specified field. Default is location id.
          schema:
            type: string
        - name: order
          in: query
          description: Use asc for ascending sort or desc for descending sort
          schema:
            type: string
            default: asc
      responses:
        '200':
          description: Successfully retrieved location imports
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationImportListWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /batch/{id}/error-report:
    get:
      tags:
        - Batch Operation
      summary: Get Excel document with Location errors
      description: >-
        After a file import, a results report is created with all location
        failures. This endpoints allows downloading only the locations with
        errors.
      operationId: get_batch_id_error_report
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the location import
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved error report file
          content:
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /brand-data-points/{id}/like:
    post:
      tags:
        - Brand Data Points
      summary: Like a Brand Data Point
      description: Like a brand data point
      operationId: post_brand_data_points_id_like
      parameters:
        - name: id
          in: path
          description: The ID of the Brand Data Point
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully liked Brand Data Point
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandDataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Brand Data Points
      summary: Unlike a Brand Data Point
      description: Unlike a brand data point
      operationId: delete_brand_data_points_id_like
      parameters:
        - name: id
          in: path
          description: The ID of the Brand Data Point
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully unliked Brand Data Point
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandDataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
  /business-connections/{directoryType}/connect/{businessId}:
    post:
      tags:
        - Business Connections
      summary: Connect a business
      description: >-
        Creates a business connection between the business and the external
        entity on directory (e.g. brand page for FB)
      operationId: post_business_connections_directoryType_connect_businessId
      parameters:
        - name: directoryType
          in: path
          description: Type of the directory
          required: true
          schema:
            type: string
        - name: businessId
          in: path
          description: Id of the Business
          required: true
          schema:
            type: string
      requestBody:
        description: Business connection parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Connect'
      responses:
        '200':
          description: Business successfully connected
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /business-connections/{directoryType}/sales-partner/{salesPartnerId}/count:
    get:
      tags:
        - Business Connections
      summary: Count of connections
      description: Get number of all business connections created under given salesPartner
      operationId: >-
        get_business_connections_directoryType_sales_partner_salesPartnerId_count
      parameters:
        - name: directoryType
          in: path
          description: Type of the directory
          required: true
          schema:
            type: string
        - name: salesPartnerId
          in: path
          description: Id of the SalesPartner
          required: true
          schema:
            type: string
        - name: status
          in: query
          description: Filter by status
          schema:
            type: string
        - name: name
          in: query
          description: Filters results by performing search with given value
          schema:
            type: string
      responses:
        '200':
          description: Business connections count successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /business-connections/{directoryType}/disconnect/{businessId}:
    put:
      tags:
        - Business Connections
      summary: Disconnect a business
      description: Deletes or disconnects the current business connection
      operationId: put_business_connections_directoryType_disconnect_businessId
      parameters:
        - name: directoryType
          in: path
          description: Type of the directory
          required: true
          schema:
            type: string
        - name: businessId
          in: path
          description: Id of the Business
          required: true
          schema:
            type: string
      requestBody:
        description: Business connection parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Disconnect'
      responses:
        '200':
          description: Business successfully disconnected
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /business-connections/{directoryType}/sales-partner/{salesPartnerId}/pages:
    get:
      tags:
        - Business Connections
      summary: List of external entities
      description: >-
        Get list of all the external entities on directories that correspond to
        all connected accounts on given salesPartner (e.g. brand pages list for
        FB of all the accounts that have been authenticated under sp)
      operationId: >-
        get_business_connections_directoryType_sales_partner_salesPartnerId_pages
      parameters:
        - name: directoryType
          in: path
          description: Type of the directory
          required: true
          schema:
            type: string
        - name: salesPartnerId
          in: path
          description: Id of the SalesPartner
          required: true
          schema:
            type: string
        - name: max
          in: query
          description: Maximum number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: External entities successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessDirectoryPageResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /business-connections/{directoryType}/sales-partner/{salesPartnerId}/users:
    get:
      tags:
        - Business Connections
      summary: List of all directory user accounts connected to sales partner
      description: >-
        Get list of all the directory user accounts that correspond to all
        connected accounts
                                on given salesPartner (e.g. list of all the accounts that have been authenticated under sp)
      operationId: >-
        get_business_connections_directoryType_sales_partner_salesPartnerId_users
      parameters:
        - name: directoryType
          in: path
          description: Type of the directory
          required: true
          schema:
            type: string
        - name: salesPartnerId
          in: path
          description: Id of the SalesPartner
          required: true
          schema:
            type: string
        - name: max
          in: query
          description: Maximum number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: External entities successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessDirectoryAccountResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /business-connections/{directoryType}/sales-partner/{salesPartnerId}/list:
    get:
      tags:
        - Business Connections
      summary: List of business connections
      description: >-
        Get detailed list of business connections created under given
        salesPartner
      operationId: get_business_connections_directoryType_sales_partner_salesPartnerId_list
      parameters:
        - name: directoryType
          in: path
          description: Type of the directory
          required: true
          schema:
            type: string
        - name: salesPartnerId
          in: path
          description: Id of the SalesPartner
          required: true
          schema:
            type: string
        - name: status
          in: query
          description: Filter by status
          required: true
          schema:
            type: string
        - name: name
          in: query
          description: Filters results by performing search with given value
          schema:
            type: string
        - name: max
          in: query
          description: Maximum number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Business connections successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /businesses:
    get:
      tags:
        - Businesses
      summary: Get a List of Businesses
      description: Get a list of businesses managed by the current user.
      operationId: get_businesses
      parameters:
        - name: query
          in: query
          description: >-
            Value used to filter the results by the fields provided in the
            "queryFields" query parameter.
                                    By default, the value will be searched for in the following fields: "name", "streetAndNo", "zip", "city", "country", "identifier".
          schema:
            type: string
        - name: queryFields
          in: query
          description: >-
            The fields that will be searched to contain the value provided in
            the "query" query parameter.
                                    The default query fields are "name", "streetAndNo", "zip", "city", "country", "identifier
          schema:
            type: array
            items:
              type: string
        - name: identifier
          in: query
          description: >-
            Only return one business based on your internal identification
            system
          schema:
            type: string
        - name: businessIds
          in: query
          description: Only return businesses identified by ids listed in businessIds
          schema:
            type: string
        - name: status
          in: query
          description: Filter by business status. One of ACTIVE, INACTIVE
          schema:
            type: string
        - name: minLocations
          in: query
          description: Only return businesses with at least minLocations locations
          schema:
            type: string
        - name: maxLocations
          in: query
          description: Only returns businesses with at most maxLocations locations
          schema:
            type: string
        - name: productPlan
          in: query
          description: Query accounts by product plan name.
          schema:
            type: string
        - name: productPlanId
          in: query
          description: Query accounts by product plan Id.
          schema:
            type: string
        - name: sort
          in: query
          description: >-
            The business property to sort by (ascending). One of name,
            streetAndNo, city, zip, phone
          schema:
            type: string
        - name: max
          in: query
          description: 'Used for pagination. Maximum number of results per page. Default: 10'
          schema:
            type: string
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: string
        - name: fieldMask
          in: query
          description: >-
            Possible fieldMask options ('id', 'identifier', 'name', 'type',
            'streetAndNo', 'addressLine2',
                                        'province', 'zip', 'city','phone', 'country', 'status', 'canSync', 'dateCreated', 'defaultPrice','defaultOriginalPrice', 'defaultPriceSetup',
                                        'productPlan', 'nextProductPlan', 'numOfLocations') 
          schema:
            type: string
          example: fieldMask=type&fieldMask=city
      responses:
        '200':
          description: Successfully retrieved Businesses
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessPageResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Businesses
      summary: Create a Business
      description: >-
        Create a Business belonging to the SalesPartner of the current User.
        User needs UserRole ADMIN or ACCOUNT_MANAGER.
      operationId: post_businesses
      requestBody:
        description: A Business object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Business'
        required: true
      responses:
        '201':
          description: Business successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /businesses/{id}:
    get:
      tags:
        - Businesses
      summary: Get a Business
      description: >-
        Get information about the business with the given id. Current user needs
        UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER.
      operationId: get_businesses_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the business
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved Business
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Businesses
      summary: Delete a Business
      description: >-
        Delete the business with the given id. Current user needs UserRole
        ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER. Locations within the
        businesses need to be deleted separately.
      operationId: delete_businesses_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the business
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted Business
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Businesses
      summary: Update a Business
      description: >-
        Edit information of the business with the given id. Current user needs
        UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER.
      operationId: patch_businesses_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the business
          required: true
          schema:
            type: string
      requestBody:
        description: A Business object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Business'
        required: true
      responses:
        '200':
          description: Successfully edited Business
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /businesses/{id}/migrate:
    post:
      tags:
        - Businesses
      summary: Migrate the Business to a new SalesPartner
      description: >-
        Migration is only possible from parent sales partner to child sales
        partner or between children sales partners.
      operationId: post_businesses_id_migrate
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the business
          required: true
          schema:
            type: string
        - name: targetSalesPartnerId
          in: query
          description: ID of the sales partner where the business should be migrated
          required: true
          schema:
            type: string
        - name: targetWhiteLabelIdentifier
          in: query
          description: >-
            If the target sales partner has more then one whitelabel, please
            specify which one has to be chosen
          schema:
            type: string
      responses:
        '200':
          description: Successfully migrated Business
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /businesses/product-plans:
    get:
      tags:
        - Businesses
      summary: Get the product plans for businesses
      description: Get the product plans assigned to a business
      operationId: get_businesses_product_plans
      parameters:
        - name: query
          in: query
          description: Restricts the response to the Product Plans that contain this name
          schema:
            type: string
        - name: max
          in: query
          description: Maximum number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Postcodes successfully retrieved
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /businesses/statistics:
    get:
      tags:
        - Businesses
      summary: Get Businesses' Statistics
      description: >-
        Get statistics about the businesses the current user is managing: total
        and breakdown by status
      operationId: get_businesses_statistics
      responses:
        '200':
          description: Successfully retrieved Business Statistics
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessStatisticsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /businesses/{businessId}/locations/sync:
    post:
      tags:
        - Businesses
      summary: Sync All Business' Locations
      description: >-
        Start a sync on all directories for all locations in the business with
        the given id. Current user needs UserRole ADMIN, ACCOUNT_MANAGER or
        BUSINESS_MANAGER.
      operationId: post_businesses_businessId_locations_sync
      parameters:
        - name: businessId
          in: path
          description: The uberall unique id of the business
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Sync successfully started
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /categories/{id}/attribute-recommendations:
    get:
      tags:
        - Categories
      summary: Get the recommended attributes for a Category
      description: >-
        Get all Recommended attributes for the Category, Country excluding
        (already applied attributes on location/payment related attributes)

        Notes:

        - Sent to Google and Apple maps

        - Only the non payment related attributes available and not applied to
        the location for the primary category of the location can be selected
        and setup
      operationId: get_categories_id_attribute_recommendations
      parameters:
        - name: id
          in: path
          description: The Category id
          required: true
          schema:
            type: string
        - name: keywords
          in: query
          description: Keywords to look for which are associated with attributes
          schema:
            type: array
            items:
              type: string
        - name: locationId
          in: query
          description: >-
            Location id to exclude already applied attributes on the provided
            location
          schema:
            type: string
        - name: country
          in: query
          description: The country to retrieve the attribute recommendations for
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved recommended attributes
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AttributeRecommendationsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /categories/{id}/attributes:
    get:
      tags:
        - Categories
      summary: Get Attributes for a specific Category
      description: >-
        Get all Attributes for the Category, Country and Language

        <br>

        <p>Notes: 

        <br>- Sent to Google and Apple maps

        <br>- Only the attributes available for the primary category of the
        location can be selected and setup</p>
      operationId: get_categories_id_attributes
      parameters:
        - name: id
          in: path
          description: The Category id
          required: true
          schema:
            type: string
        - name: language
          in: query
          description: >-
            The language to show the attributes in, this affects only the name
            of the results
          schema:
            type: string
        - name: country
          in: query
          description: The country to retrieve the attributes for
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved attributes
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AttributesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /categories/{id}/available-photo-types:
    get:
      tags:
        - Categories
      summary: Get available Photo types for a specific Category
      description: >-
        Google limits photo types for each business category. GET a list of
        available photo types for a category.
      operationId: get_categories_id_available_photo_types
      parameters:
        - name: id
          in: path
          description: Photo types for the location id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved photo types
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AvailablePhotoTypesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      deprecated: true
      security:
        - accessToken: []
        - privateKey: []
  /categories:
    get:
      tags:
        - Categories
      summary: Get All or Several Categories
      description: >-
        Get a list of all available location categories, or specific location
        categories based on the following parameters
      operationId: get_categories
      parameters:
        - name: categories
          in: query
          description: The uberall unique id of the category you want to get
          schema:
            type: integer
            format: int64
        - name: q
          in: query
          description: Filter categories by a search query
          schema:
            type: string
          example: Auto
        - name: roots
          in: query
          description: >-
            Set to 'true' to show root categories as well (i.e., show all
            categories)
          schema:
            type: boolean
        - name: language
          in: query
          description: Show categories in the specified language. One of de, en, es, fr
          required: true
          schema:
            type: string
        - name: max
          in: query
          description: 'Used for pagination. Maximum number of results per page. Default: 10'
          schema:
            type: integer
            format: int64
          example: 10
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
          example: 0
      responses:
        '200':
          description: Successfully retrieved categories
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /categories/{id}/google-services:
    get:
      tags:
        - Categories
      summary: Get available Google Structured Services for a specific Category
      description: >-
        GET the list of Google's structured services for a location's business
        category. Google does not have structured services for all business
        categories.
      operationId: get_categories_id_google_services
      parameters:
        - name: id
          in: path
          description: Category ID for retrieving services
          required: true
          schema:
            type: string
        - name: language
          in: query
          description: The language the structured services should be returned in.
          schema:
            type: string
        - name: country
          in: query
          description: >-
            Available structured services vary by country, so a country is
            needed to provide the available structured services from Google.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved Google Services
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GoogleServicesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /categories/{id}/more-hours-types:
    get:
      tags:
        - Categories
      summary: Get the supported More Hours types for a specific Category
      description: >-
        Get all supported More Hours types for a specific Category. Optionally
        specify language, otherwise default sales partner language is returned
      operationId: get_categories_id_more_hours_types
      parameters:
        - name: id
          in: path
          description: The Category id
          required: true
          schema:
            type: string
        - name: language
          in: query
          description: The language to show the values in
          schema:
            type: string
          example: en or de
      responses:
        '200':
          description: Successfully retrieved more hours types
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MoreHoursWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /collections:
    get:
      tags:
        - Collection Management
      summary: Get all collections
      description: Get all the collections managed by the current API user.
      operationId: get_collections
      responses:
        '200':
          description: Collections found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContentListsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Collection Management
      summary: Create a collection
      description: >-
        Create a new collection managed by the current API user. If the user
        specifies a set of locations for the collections, users managing the
        whole set of locations can also manage the collection.
      operationId: post_collections
      requestBody:
        description: ContentCollection object to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContentCollection'
      responses:
        '200':
          description: Collection created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentCollection'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /collections/{id}:
    get:
      tags:
        - Collection Management
      summary: Get a Collection
      description: Retrieve a specific Collection by id
      operationId: get_collections_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the Collection to retrieve
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Collection found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentCollection'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Collection Management
      summary: Delete a Collection
      description: Delete a specific Collection by id
      operationId: delete_collections_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the Collection to delete
          required: true
          schema:
            type: string
      requestBody:
        description: ContentCollection object to delete
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContentCollection'
      responses:
        '200':
          description: Collection deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Collection Management
      summary: Update a Collection
      description: Update a specific Collection by id
      operationId: patch_collections_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the Collection to update
          required: true
          schema:
            type: string
      requestBody:
        description: ContentCollection object to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContentCollection'
      responses:
        '200':
          description: Collection updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentCollection'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /content-lists:
    get:
      tags:
        - Content List
      summary: Get All Content Lists
      description: Get all content lists managed by the current API user
      operationId: get_content_lists
      responses:
        '200':
          description: Content lists successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContentListsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Content List
      summary: Create a Content List
      description: Create a content list
      operationId: post_content_lists
      requestBody:
        description: A ContentList object
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ContentList'
        required: true
      responses:
        '201':
          description: Content List successfully created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContentListResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /content-lists/{id}:
    get:
      tags:
        - Content List
      summary: Get a Content List
      description: Get a content list identified by its uberall unique id
      operationId: get_content_lists_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the content list
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Content list successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContentListResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Content List
      summary: Delete a Content List
      description: Delete a content list
      operationId: delete_content_lists_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the content list
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Content List successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Content List
      summary: Update a Content List
      description: Update a content list
      operationId: patch_content_lists_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the content list
          required: true
          schema:
            type: string
      requestBody:
        description: A ContentList object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/ContentListResponseWrapper'
        required: true
      responses:
        '200':
          description: Content List successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentList'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /custom-items:
    get:
      tags:
        - Custom Items
      summary: Get all Custom Items
      description: >-
        Get all custom items the current API user can manage.

        <br>To specify products with identifier please provide ?identifier= in
        the url param

        <br>By default, 50 are returned, you can use up to max=10000 param
      operationId: get_custom_items
      responses:
        '200':
          description: Successfully retrieved custom items
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomItemSearchResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Custom Items
      summary: Create a Custom Item
      description: Create a custom item. It can be added to a content list later
      operationId: post_custom_items
      requestBody:
        description: CustomItem object to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomItem'
        required: true
      responses:
        '201':
          description: Successfully created custom item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomItemResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Custom Items
      summary: Delete a Custom Item using identifier
      description: Delete a custom item identified by identifier in the url param
      operationId: delete_custom_items
      responses:
        '204':
          description: Successfully deleted custom item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /custom-items/{id}:
    get:
      tags:
        - Custom Items
      summary: Get a Custom Item
      description: Get a single custom item
      operationId: get_custom_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the custom item
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved custom item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomItemResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Custom Items
      summary: Delete a Custom Item
      description: Delete a custom item
      operationId: delete_custom_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the custom item
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Successfully deleted custom item
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Custom Items
      summary: Update a Custom Item
      description: >-
        Make changes to a custom item. Any blank parameter deletes an old value,
        any unspecified parameter does nothing
      operationId: patch_custom_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the custom item
          required: true
          schema:
            type: string
      requestBody:
        description: CustomItem object to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomItem'
        required: true
      responses:
        '200':
          description: Successfully updated custom item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomItemResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/customer-feedback:
    get:
      tags:
        - Dashboard
      summary: Get Customer Feedback
      description: >-
        Get the Customer Feedback of the user managed locations filtered by the
        given ids
      operationId: get_dashboard_customer_feedback
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want customer feedback for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want customer feedback data for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: textFilter
          in: query
          description: >-
            Filter locations to get customer feedback for by name, zip, street,
            city, label
          schema:
            type: string
          example: Berlin
        - name: type
          in: query
          description: The directory you want customer feedback data for
          schema:
            type: string
        - name: startDate
          in: query
          description: The start date
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: The end date
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Successfully retrieved customer feedback
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerFeedbackWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/customer-feedback-by-period:
    get:
      tags:
        - Dashboard
      summary: Get Customer Feedback by Period
      description: >-
        Get the Customer Feedback of the user managed locations filtered by the
        given ids grouped by period
      operationId: get_dashboard_customer_feedback_by_period
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want customer feedback by period for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: >-
            The ids of the locations you want customer feedback by period data
            for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: textFilter
          in: query
          description: >-
            Filter locations to get customer feedback by period for by name,
            zip, street, city, label
          schema:
            type: string
          example: Berlin
        - name: type
          in: query
          description: The directory you want customer feedback by period data for
          schema:
            type: string
        - name: startDate
          in: query
          description: The start date
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: The end date
          schema:
            type: string
            format: date
        - name: group
          in: query
          description: 'How to group the results, one of: DAY, WEEK, MONTH, YEAR'
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved customer feedback by period
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerFeedbackByPeriodWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/customer-feedback-keywords:
    get:
      tags:
        - Dashboard
      summary: Get Customer Feedback Keywords.
      description: >-
        Returns the 100 most mentioned Keywords and the average Rating of the
        Reviews where they appeared.
      operationId: get_dashboard_customer_feedback_keywords
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want customer feedback keywords for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: >-
            The ids of the locations you want customer feedback keywords data
            for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: textFilter
          in: query
          description: >-
            Filter locations to get customer feedback keywords for by name, zip,
            street, city, label
          schema:
            type: string
          example: Berlin
        - name: startDate
          in: query
          description: The start date
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: The end date
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Successfully retrieved customer feedback keywords
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerFeedbackKeywordsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/export-insights-data:
    get:
      tags:
        - Dashboard
      summary: Get Insights Export Data
      description: Get the exported insights data
      operationId: get_dashboard_export_insights_data
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want insights data for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want insights data for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: textFilter
          in: query
          description: >-
            Filter locations to get insights data for by name, zip, street,
            city, label
          schema:
            type: string
          example: Berlin
        - name: startDate
          in: query
          description: The start date YYYY-MM-DD
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: The end date YYYY-MM-DD
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Successfully exported insights data
          content:
            application/xlsx:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/export-insights-data-with-threshold:
    get:
      tags:
        - Dashboard
      summary: Get Insights Export Data with threshold
      description: >-
        Gets all insights data for the locations. When the request takes too
        much time, the user will receive the link to the file in an email.
      operationId: get_dashboard_export_insights_data_with_threshold
      parameters:
        - name: businessIds
          in: query
          description: Filter export data by these businessIds
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: Filter export data by these locationIds
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: textFilter
          in: query
          description: >-
            Filter export data by this query. It is applied across these
            location properties: name, street, streetNo, zip, city, country,
            identifier, labels
          schema:
            type: string
        - name: startDate
          in: query
          description: Filter export data from this date
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: Filter export data until this date
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Successfully exported insights data with threshold
          content:
            '*/*':
              schema:
                $ref: >-
                  #/components/schemas/DashboardExportInsightsDataResponseWrapper
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/feed:
    get:
      tags:
        - Dashboard
      summary: Get Feed
      description: Get the Feed of latest activities related to the managed locations
      operationId: get_dashboard_feed
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want feed items for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want feed items for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: textFilter
          in: query
          description: Filter locations to get feed for by name, zip, street, city, label
          schema:
            type: string
          example: Berlin
        - name: dateOffset
          in: query
          description: returns data up to this date, default is now
          schema:
            type: string
        - name: maxItems
          in: query
          description: The maximum number of feed items to return
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Successfully retrieved feed items
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FeedItemWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/insights-data:
    get:
      tags:
        - Dashboard
      summary: Get Insights Data
      description: Get Insights Data
      operationId: get_dashboard_insights_data
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want insights data for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want insights data for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: textFilter
          in: query
          description: >-
            Filter locations to get insights data for by name, zip, street,
            city, label
          schema:
            type: string
          example: Berlin
        - name: type
          in: query
          description: >-
            The directory you want insights for. Can be GOOGLE, FACEBOOK, BING
            or YELP_API
          required: true
          schema:
            type: string
        - name: startDate
          in: query
          description: The start date YYYY-MM-DD
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: The end date YYYY-MM-DD
          schema:
            type: string
            format: date
        - name: group
          in: query
          description: >-
            How to group the results, one of: HOUR (only for ACTIONS-PHONE),
            DAY, WEEK, MONTH, YEAR
          schema:
            type: string
        - name: metrics
          in: query
          description: The types of metrics you want to get
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Successfully retrieved insights data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/InsightsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/insights-data/warnings:
    get:
      tags:
        - Dashboard
      summary: Get Insights Warnings
      description: >-
        Get the Insights warnings. The list of locations/accounts
        connected/unconnected, which need a user action to be able collecting
        insights for.
      operationId: get_dashboard_insights_data_warnings
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want insights data warnings for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want insights data warnings for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: textFilter
          in: query
          description: >-
            Filter locations to get insights data warnings for by name, zip,
            street, city, label
          schema:
            type: string
          example: Berlin
        - name: type
          in: query
          description: The directory you want insights warnings for
          schema:
            type: string
        - name: max
          in: query
          description: Used for pagination. Maximum number of results per page
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Successfully retrieved insights data warnings
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserMissingConnectionWarningsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/listing-health/{id}:
    get:
      tags:
        - Dashboard
      summary: Get Listing Health
      description: Get the Listing Health for the locations managed by the current user
      operationId: get_dashboard_listing_health_id
      parameters:
        - name: id
          in: path
          description: The id of the location you want the listing health for
          required: true
          schema:
            type: integer
            format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want listing health data for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: businessIds
          in: query
          description: The ids of the businesses you want listing health for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: type
          in: query
          description: The directory you want listing health data for
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListingHealthWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/managers-count/{id}:
    get:
      tags:
        - Dashboard
      summary: Get Managers Count
      description: Get the Managers Count
      operationId: get_dashboard_managers_count_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the location
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved location managers count
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationManagersCountWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/next-best-actions/{id}:
    get:
      tags:
        - Dashboard
      summary: Get Next Best Actions
      description: Get the Next Best Actions recommended to the current user
      operationId: get_dashboard_next_best_actions_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the location
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved next best actions
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationTaskWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/profile-completeness:
    get:
      tags:
        - Dashboard
      summary: Get Profile Completeness
      description: >-
        Get the profile completeness of the locations managed by the current
        user
      operationId: get_dashboard_profile_completeness
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want profile completeness for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want profile completeness data for
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Successfully retrieved profile completeness
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProfileCompletenessWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/suppressed-duplicates:
    get:
      tags:
        - Dashboard
      summary: Get Suppressed Duplicates
      description: Get the suppressed duplicates info
      operationId: get_dashboard_suppressed_duplicates
      parameters:
        - name: businessIds
          in: query
          description: The ids of the businesses you want suppressed duplicates for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want suppressed duplicates data for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: type
          in: query
          description: The directory you want suppressed duplicates data for
          schema:
            type: string
        - name: startDate
          in: query
          description: The start date YYYY-MM-DD
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: The end date YYYY-MM-DD
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Successfully retrieved suppressed duplicates
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuppressedDuplicatesWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard/visibility-index/{id}:
    get:
      tags:
        - Dashboard
      summary: Get Visibility Index
      description: Get the Visibility Index of the locations managed by the current user
      operationId: get_dashboard_visibility_index_id
      parameters:
        - name: id
          in: path
          description: The id of the location you want the visibility index for
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved visibility index
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/VisibilityIndexWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard-exports:
    get:
      tags:
        - Dashboard Exports
      summary: Get a list of dashboard exports
      description: Get a list of dashboard exports.
      operationId: get_dashboard_exports
      parameters:
        - name: locationIds
          in: query
          description: List of location IDs to filter by
          schema:
            type: string
        - name: max
          in: query
          description: Max number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: List of dashboard exports successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DashboardExportDataListWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Dashboard Exports
      summary: Invoke a creation of a dashboard export
      description: Invoke creation of a dashboard export (in PDF format) asynchronously.
      operationId: post_dashboard_exports
      parameters:
        - name: start
          in: query
          description: Start date of export, in yyyy-MM-dd format
          required: true
          schema:
            type: string
          example: '2017-01-01'
        - name: end
          in: query
          description: End date of export, in yyyy-MM-dd format
          required: true
          schema:
            type: string
          example: '2017-12-31'
        - name: group
          in: query
          description: Grouping of the historical data
          required: true
          schema:
            type: string
        - name: whitelabelIdentifier
          in: query
          description: Whitelabel identifier string
          required: true
          schema:
            type: string
        - name: locationIds
          in: query
          description: List of location IDs
          required: true
          schema:
            type: string
        - name: language
          in: query
          description: Language identifier (i.e. 'fr', 'de')
          required: true
          schema:
            type: string
          example: fr
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/CreatePDFValidatorCommand'
      responses:
        '200':
          description: Export data created successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DashboardExportDataWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /dashboard-exports/{id}/download:
    get:
      tags:
        - Dashboard Exports
      summary: Download the result of a dashboard export (a PDF file)
      description: Download the result of a dashboard export (a PDF file).
      operationId: get_dashboard_exports_id_download
      parameters:
        - name: id
          in: path
          description: DashboardExportData Id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: PDF file successfully downloaded
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /dashboard-exports/{id}:
    get:
      tags:
        - Dashboard Exports
      summary: Get details of a dashboard export by ID
      description: Get details of dashboard export by ID.
      operationId: get_dashboard_exports_id
      parameters:
        - name: id
          in: path
          description: DashboardExportData Id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Details of dashboard found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DashboardExportDataWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /data-points/{id}/reply/{replyId}/approval:
    put:
      tags:
        - Data Points
      summary: Edit reply to a Data Point
      description: Editing an existing reply that needs approval to a Data Point
      operationId: put_data_points_id_reply_replyId_approval
      parameters:
        - name: id
          in: path
          description: The id of the root data point
          required: true
          schema:
            type: string
        - name: replyId
          in: path
          description: The id  of the replying data point
          required: true
          schema:
            type: string
        - name: replyText
          in: path
          description: The edited text of the reply
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Data Points
      summary: Approve reply to a Data Point
      description: Approves a reply to a data point.
      operationId: post_data_points_id_reply_replyId_approval
      parameters:
        - name: id
          in: path
          description: The id of the root data point
          required: true
          schema:
            type: string
        - name: replyId
          in: path
          description: The id  of the replying data point
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Data Points
      summary: Reject a reply to a Data Point
      description: Deletes a reply to a data point that needs approval.
      operationId: delete_data_points_id_reply_replyId_approval
      parameters:
        - name: id
          in: path
          description: The id of the root data point
          required: true
          schema:
            type: string
        - name: replyId
          in: path
          description: The id  of the replying data point
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /brand-data-points/{id}/reply/{replyId}/approval:
    put:
      tags:
        - Brand Data Points
      summary: Edit reply to a Brand Data Point
      description: Editing an existing reply that needs approval to a Brand Data Point
      operationId: put_brand_data_points_id_reply_replyId_approval
      parameters:
        - name: id
          in: path
          description: The id of the root brand data point to approve
          required: true
          schema:
            type: string
        - name: replyId
          in: path
          description: The id of the replying brand data point to approve
          required: true
          schema:
            type: string
        - name: replyText
          in: path
          description: The edited text of the reply
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandDataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Brand Data Points
      summary: Approve reply to a Brand Data Point
      description: Approves a reply to a brand data point.
      operationId: post_brand_data_points_id_reply_replyId_approval
      parameters:
        - name: id
          in: path
          description: The id of the root brand data point
          required: true
          schema:
            type: string
        - name: replyId
          in: path
          description: The id  of the replying brand data point
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandDataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Brand Data Points
      summary: Reject a reply to a Brand Data Point
      description: Deletes a reply to a brand data point that needs approval.
      operationId: delete_brand_data_points_id_reply_replyId_approval
      parameters:
        - name: id
          in: path
          description: The id of the root brand data point
          required: true
          schema:
            type: string
        - name: replyId
          in: path
          description: The id  of the replying brand data point
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandDataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /data-points/{id}/flag:
    post:
      tags:
        - Data Points
      summary: Report a Data Point
      description: Flag a data point on the directory
      operationId: post_data_points_id_flag
      parameters:
        - name: id
          in: path
          description: The data point id you want to report
          required: true
          schema:
            type: string
        - name: flagType
          in: query
          description: Must be one supported flagType for that directory
          required: true
          schema:
            type: string
          example: '[OFFENSIVE, SPAM, NOLONGERRELEVANT, EXTERNAL_URL]'
      responses:
        '200':
          description: Data point flagged
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /data-points/{id}:
    get:
      tags:
        - Data Points
      summary: Get a Data Point
      description: Get information about a single Data Point
      operationId: get_data_points_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the data point you want to retrieve
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/datapoints:
    get:
      tags:
        - Locations Data
      summary: DEPRECATED - Get Location's Data Points
      description: >-
        Deprecated. Use
        https://uberall.com/en/developers/apiDocumentation#_api_data-points-GET
        instead.
      operationId: get_locations_id_datapoints
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the location you want to inbox items for
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      deprecated: true
      security:
        - accessToken: []
        - privateKey: []
  /data-points/{id}/like:
    post:
      tags:
        - Data Points
      summary: Like a Data Point
      description: LIke a review (Facebook, Foursquare, ...)
      operationId: post_data_points_id_like
      parameters:
        - name: id
          in: path
          description: The data point id you want to like
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Data point liked
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Data Points
      summary: Unlike a Data Point
      description: Unlike a review (Facebook, Foursquare, ...)
      operationId: delete_data_points_id_like
      parameters:
        - name: id
          in: path
          description: The data point id you want to unlike
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Data point unliked
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /data-points/{id}/moderate:
    post:
      tags:
        - Data Points
      summary: Moderate a Data Point
      description: >-
        Moderate a Data Point. 

        Only Data Points that belong to a WEBSITE_WIDGETS directory can be
        moderated.
      operationId: post_data_points_id_moderate
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the data point you want to moderate
          required: true
          schema:
            type: string
        - name: operation
          in: query
          description: One of APPROVE or REJECT
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Data point moderated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /data-points/read:
    post:
      tags:
        - Data Points
      summary: Mark as Read
      description: Mark one or several inbox items as read
      operationId: post_data_points_read
      parameters:
        - name: businessIds
          in: query
          description: Filter by business ids
          schema:
            type: array
            items:
              type: string
        - name: countries
          in: query
          description: Filter by countries. ISO 3166-1 alpha-2 codes
          schema:
            type: array
            items:
              type: string
        - name: zip
          in: query
          description: >-
            Only change inbox items for locations where zip starts with given
            parameter
          schema:
            type: string
        - name: dataPointTypes
          in: query
          description: Filter by type of datapoints
          schema:
            type: array
            items:
              type: string
          example: '[PHOTO, REVIEW, CHECKIN]'
        - name: directoryTypes
          in: query
          description: Filter by directories
          schema:
            type: array
            items:
              type: string
        - name: ratings
          in: query
          description: Only change inbox items with a rating included in ratings
          schema:
            type: array
            items:
              type: string
        - name: replied
          in: query
          description: Only show elements you have/you have not replied to
          schema:
            type: boolean
        - name: selectAll
          in: query
          description: >-
            If all data points matching the current filter settings should be
            marked as read
          required: true
          schema:
            type: boolean
        - name: ids
          in: query
          description: The uberall unique ids for the inbox items you want to mark as read
          schema:
            type: array
            items:
              type: string
        - name: excludeIds
          in: query
          description: >-
            If selectAll is set to true this parameter can contain a list of
            data point ids that should not be marked as read
          schema:
            type: array
            items:
              type: string
        - name: query
          in: query
          description: Filter by name
          schema:
            type: string
      responses:
        '200':
          description: Inbox items marked as read
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Data Points
      summary: Mark as Unread
      description: Mark one or several inbox items as unread
      operationId: delete_data_points_read
      parameters:
        - name: businessIds
          in: query
          description: Filter by business ids
          schema:
            type: array
            items:
              type: string
        - name: countries
          in: query
          description: Filter by countries. ISO 3166-1 alpha-2 codes
          schema:
            type: array
            items:
              type: string
        - name: zip
          in: query
          description: >-
            Only change inbox items for locations where zip starts with given
            parameter
          schema:
            type: string
        - name: dataPointTypes
          in: query
          description: Filter by type of datapoints
          schema:
            type: array
            items:
              type: string
          example: '[PHOTO, REVIEW, CHECKIN]'
        - name: directoryTypes
          in: query
          description: Filter by directories
          schema:
            type: array
            items:
              type: string
        - name: ratings
          in: query
          description: Only change inbox items with a rating included in ratings
          schema:
            type: array
            items:
              type: string
        - name: replied
          in: query
          description: Only show elements you have/you have not replied to
          schema:
            type: boolean
        - name: selectAll
          in: query
          description: >-
            If all data points matching the current filter settings should be
            marked as unread
          required: true
          schema:
            type: boolean
        - name: ids
          in: query
          description: >-
            The uberall unique ids for the inbox items you want to mark as
            unread
          schema:
            type: array
            items:
              type: string
        - name: excludeIds
          in: query
          description: >-
            If selectAll is set to true this parameter can contain a list of
            data point ids that should not be marked as unread
          schema:
            type: array
            items:
              type: string
        - name: query
          in: query
          description: Filter by name
          schema:
            type: string
      responses:
        '200':
          description: Inbox items marked as unread
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /data-points:
    get:
      tags:
        - Data Points
      summary: Get All Data Points
      description: >-
        Get all data points, potentially filtered by directory, business,
        rating...
      operationId: get_data_points
      parameters:
        - name: max
          in: query
          description: Used for pagination. Maximum number of results per page
          schema:
            type: integer
            format: int64
        - name: page
          in: query
          description: The page number for pagination
          schema:
            type: integer
            format: int64
        - name: labels
          in: query
          description: Filter by location labels
          schema:
            type: array
            items:
              type: string
        - name: countries
          in: query
          description: The countries you want data points for. ISO 3166-1 alpha-2 codes
          schema:
            type: array
            items:
              type: string
        - name: businessIds
          in: query
          description: Ids of businesses you want data points for
          schema:
            type: array
            items:
              type: string
        - name: locationIds
          in: query
          description: The ids of the locations you want data points for
          schema:
            type: array
            items:
              type: string
        - name: zip
          in: query
          description: >-
            Only return inbox items for locations where zip starts with given
            parameter
          schema:
            type: string
        - name: dataPointTypes
          in: query
          description: Types of datapoints you want inbox items for
          schema:
            type: array
            items:
              type: string
          example: '[PHOTO, REVIEW, CHECKIN]'
        - name: directoryTypes
          in: query
          description: Directories you want inbox items for
          schema:
            type: array
            items:
              type: string
        - name: ratings
          in: query
          description: Only return inbox items with a rating included in ratings
          schema:
            type: array
            items:
              type: string
        - name: read
          in: query
          description: Only show read/not read elements
          schema:
            type: boolean
        - name: replied
          in: query
          description: Only show elements you have/you have not replied to
          schema:
            type: boolean
        - name: text
          in: query
          description: Only return data points with text or without
          schema:
            type: boolean
        - name: query
          in: query
          description: Filter by name
          schema:
            type: string
        - name: minActionDate
          in: query
          description: The min date of the DataPoint as unix timestamp in milliseconds
          schema:
            type: string
          example: 1514764800000
        - name: maxActionDate
          in: query
          description: The max date of the DataPoint as unix timestamp in milliseconds
          schema:
            type: string
          example: 1514764800000
        - name: minThreadActionDate
          in: query
          description: >-
            The min date of the last interaction with a DataPoint as unix
            timestamp in milliseconds
          schema:
            type: string
          example: 1514764800000
        - name: maxThreadActionDate
          in: query
          description: >-
            The max date of the last interaction with a DataPoint as unix
            timestamp in milliseconds
          schema:
            type: string
          example: 1514764800000
        - name: fieldMask
          in: query
          description: The fields you want to include in the response
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /brand-data-points/{id}/reply:
    patch:
      tags:
        - Brand Data Points
      summary: Reply to a Brand Data Point
      description: Reply with a text to a Brand Data Point, e.g. a review
      operationId: patch_brand_data_points_id_reply
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the brand data point you want to reply to
          required: true
          schema:
            type: string
        - name: reply
          in: query
          description: >-
            The text you want to reply, on most directories this will be
            published and can be read by the author of the original data point
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Reply sent
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BrandDataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /data-points/{id}/reply:
    patch:
      tags:
        - Data Points
      summary: Reply to a Data Point
      description: Reply with a text to a Data Point, e.g. a review
      operationId: patch_data_points_id_reply
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the data point you want to reply to
          required: true
          schema:
            type: string
        - name: reply
          in: query
          description: >-
            The text you want to reply, on most directories this will be
            published and can be read by the author of the original data point
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Reply sent
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DataPointResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /data-points/statistics:
    get:
      tags:
        - Data Points
      summary: Get Data Points' Statistics
      description: Returns statistics about the locations inbox.
      operationId: get_data_points_statistics
      parameters:
        - name: businessIds
          in: query
          description: Ids of businesses you want inbox statistics for
          schema:
            type: array
            items:
              type: string
        - name: countries
          in: query
          description: >-
            The countries you want data points' statistics for. ISO 3166-1
            alpha-2 codes
          schema:
            type: array
            items:
              type: string
        - name: locationIds
          in: query
          description: Only consider data points belonging to any of these locationIds
          schema:
            type: array
            items:
              type: string
        - name: dataPointTypes
          in: query
          description: Types of datapoints you want inbox statistics for
          schema:
            type: array
            items:
              type: string
          example: '[PHOTO, REVIEW, CHECKIN]'
        - name: directoryTypes
          in: query
          description: Directories you want inbox statistics for
          schema:
            type: array
            items:
              type: string
        - name: ratings
          in: query
          description: Ratings of datapoints you want inbox statistics for.
          schema:
            type: array
            items:
              type: string
        - name: minActionDate
          in: query
          description: Only consider data points created after that date
          schema:
            type: string
        - name: maxActionDate
          in: query
          description: Only consider data points created before that date
          schema:
            type: string
        - name: minThreadActionDate
          in: query
          description: >-
            The min date of the last interaction with a DataPoint as unix
            timestamp in milliseconds
          schema:
            type: string
          example: 1514764800000
        - name: maxThreadActionDate
          in: query
          description: >-
            The max date of the last interaction with a DataPoint as unix
            timestamp in millisecond
          schema:
            type: string
          example: 1514764800000
        - name: query
          in: query
          description: Filter by name
          schema:
            type: string
        - name: read
          in: query
          description: Only consider data points that the current user has already read
          schema:
            type: boolean
        - name: replied
          in: query
          description: Only consider data points that are either replied or not replieds
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatapointStatisticsResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/datapoints/statistics:
    get:
      tags:
        - Locations Data
      summary: DEPRECATED - Get Location's Data Point Statistics
      description: >-
        Deprecated. Use
        https://uberall.com/en/developers/apiDocumentation#_api_data-points_statistics-GET
        instead.
      operationId: get_locations_id_datapoints_statistics
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the location
          required: true
          schema:
            type: string
        - name: dataPointTypes
          in: query
          description: Types of datapoints you want inbox statistics for
          schema:
            type: array
            items:
              type: string
          example: '[PHOTO, REVIEW, CHECKIN]'
        - name: directoryTypes
          in: query
          description: Directories you want inbox statistics for
          schema:
            type: array
            items:
              type: string
        - name: ratings
          in: query
          description: Ratings of datapoints you want inbox statistics for.
          schema:
            type: array
            items:
              type: string
        - name: minActionDate
          in: query
          description: Only consider data points created after that date
          schema:
            type: string
        - name: maxActionDate
          in: query
          description: Only consider data points created before that date
          schema:
            type: string
        - name: minThreadActionDate
          in: query
          description: >-
            The min date of the last interaction with a DataPoint as unix
            timestamp in milliseconds
          schema:
            type: string
          example: 1514764800000
        - name: maxThreadActionDate
          in: query
          description: >-
            The max date of the last interaction with a DataPoint as unix
            timestamp in millisecond
          schema:
            type: string
          example: 1514764800000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatapointStatisticsResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      deprecated: true
      security:
        - accessToken: []
        - privateKey: []
  /data-points/timeseries:
    get:
      tags:
        - Data Points
      summary: Get Data Points' time series
      description: Returns time series of Data Points
      operationId: get_data_points_timeseries
      parameters:
        - name: dataPointTypes
          in: query
          description: Types of datapoints you want inbox statistics for
          schema:
            type: array
            items:
              type: string
          example: '[PHOTO, REVIEW, CHECKIN]'
        - name: directoryTypes
          in: query
          description: Directories you want data points time series for
          schema:
            type: array
            items:
              type: string
        - name: businessIds
          in: query
          description: Ids of businesses you want data points for
          schema:
            type: array
            items:
              type: string
        - name: zip
          in: query
          description: >-
            Only return Data Points time series for locations where zip starts
            with given parameter
          schema:
            type: string
        - name: ratings
          in: query
          description: Only return Data Points with a rating included in ratings
          schema:
            type: array
            items:
              type: string
        - name: read
          in: query
          description: Only show read/not read elements
          schema:
            type: boolean
        - name: replied
          in: query
          description: Only show elements you have/you have not replied to
          schema:
            type: boolean
        - name: countries
          in: query
          description: The countries you want data points for. ISO 3166-1 alpha-2 codes
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointTimeSeriesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /data-points/filters:
    get:
      tags:
        - Data Point Filters
      summary: Get available filters for filtering data points
      description: >-
        Get available filters for filtering data points, which the current api
        user has access to.
      operationId: get_data_points_filters
      parameters:
        - name: locationIds
          in: query
          description: Applies a filter of locationIds
          schema:
            type: array
            items:
              type: string
        - name: userId
          in: query
          description: Shows the filters of the user with this id
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiltersResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Data Point Filters
      summary: Create a new saved datapoint's filter
      description: Creates a new DataPointFilter
      operationId: post_data_points_filters
      requestBody:
        description: DataPointFilter object that needs to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPointFilter'
        required: true
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DataPointFilterResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /data-points/filters/{id}:
    get:
      tags:
        - Data Point Filters
      summary: Get a saved datapoint's filter
      description: The Uberall locationId
      operationId: get_data_points_filters_id
      parameters:
        - name: id
          in: path
          description: ID of a DataPointFilter
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointFilterResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Data Point Filters
      summary: Delete a saved datapoint's filter
      description: Deletes a specific DataPointFilter
      operationId: delete_data_points_filters_id
      parameters:
        - name: id
          in: path
          description: ID of a DataPointFilter
          required: true
          schema:
            type: string
        - name: userId
          in: query
          description: >-
            The user that is the owner of the filter. Required when request is
            done as API_ADMIN
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Data Point Filters
      summary: Update a saved datapoint's filter
      description: Changes a specific DataPointFilter
      operationId: patch_data_points_filters_id
      parameters:
        - name: id
          in: path
          description: ID of a DataPointFilter
          required: true
          schema:
            type: string
      requestBody:
        description: A DataPointFilter object that needs to be updated
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPointFilter'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointFilterResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /data-points/filters/list:
    get:
      tags:
        - Data Point Filters
      summary: List all saved datapoint's filters the user has access
      description: Shows owned or subscribed DataPointFilters
      operationId: get_data_points_filters_list
      parameters:
        - name: userId
          in: query
          description: Shows the filters of the user with this id
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointFiltersResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /data-points/filters/{id}/subscription:
    post:
      tags:
        - Data Point Filters
      summary: Subscribe to a saved datapoint's filter
      description: Subscribe to a specific DataPointFilter
      operationId: post_data_points_filters_id_subscription
      parameters:
        - name: id
          in: path
          description: ID of a DataPointFilter
          required: true
          schema:
            type: string
        - name: userId
          in: query
          description: ID of a user that should be subscribed to the filter
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointFilterResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Data Point Filters
      summary: Unsubscribe from a saved datapoint's filter
      description: Unsubscribe from a specific DataPointFilter
      operationId: delete_data_points_filters_id_subscription
      parameters:
        - name: id
          in: path
          description: ID of a DataPointFilter
          required: true
          schema:
            type: string
        - name: userId
          in: query
          description: ID of a user that should be unsubscribed from the filter
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointFilterResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /directory-brand/sales-partner/{salesPartnerId}/user-account/{accountId}/{directoryType}:
    get:
      tags:
        - Configuration
      summary: Get All Directory Brands
      description: Returns a list of directory brands for the given account and directory
      operationId: >-
        get_directory_brand_sales_partner_salesPartnerId_user_account_accountId_directoryType
      parameters:
        - name: salesPartnerId
          in: path
          description: Sales Partner ID
          required: true
          schema:
            type: string
        - name: accountId
          in: path
          description: Directory User Account ID
          required: true
          schema:
            type: string
        - name: directoryType
          in: path
          description: Type of Directory
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved Directory Brands
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DirectoryBrandPageResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Configuration
      summary: Create Directory Brand
      description: >-
        Create directory brand for the given sales partner id, directory user
        account and directory type
      operationId: >-
        post_directory_brand_sales_partner_salesPartnerId_user_account_accountId_directoryType
      parameters:
        - name: salesPartnerId
          in: path
          description: Sales Partner ID
          required: true
          schema:
            type: string
        - name: accountId
          in: path
          description: Directory User Account ID
          required: true
          schema:
            type: string
        - name: directoryType
          in: path
          description: Type of Directory
          required: true
          schema:
            type: string
      requestBody:
        description: Details for creating a directory brand
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/CreateDirectoryBrandRequest'
        required: true
      responses:
        '200':
          description: Successfully created Directory Brand
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DirectoryBrandWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /directories/directories-details/countries:
    get:
      tags:
        - Configuration
      summary: Get All Directories details by country
      description: Returns a list of directories details filtered by country
      operationId: get_directories_directories_details_countries
      parameters:
        - name: countries
          in: query
          description: >-
            Optional list parameter of comma separated ISO 3166 alpha-2 country
            codes to filter response
          schema:
            type: string
          example: US, DE
      responses:
        '200':
          description: Successfully retrieved Directories Details
          content:
            '*/*':
              schema:
                $ref: >-
                  #/components/schemas/DirectoriesDetailsCountriesResponseWrapper
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
  /sales-partners/{id}/user-accounts/{accountId}/{directoryType}:
    post:
      tags:
        - Sales Partners
      summary: Disconnect Directory User Account
      description: >-
        Disconnects the Dierctory User Account for the given sales partner and
        invalidates it if no other sales partner is connected to it
      operationId: post_sales_partners_id_user_accounts_accountId_directoryType
      parameters:
        - name: id
          in: path
          description: Sales Partner ID
          required: true
          schema:
            type: string
        - name: accountId
          in: path
          description: Directory User Account ID
          required: true
          schema:
            type: string
        - name: directoryType
          in: path
          description: Directory Type of User Account (in lower case)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully disconnected Apple account
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /events:
    get:
      tags:
        - Events
      summary: Get All Events
      description: >-
        Get all events the current API user can manage.

        <br>To specify events with identifier please provide ?identifier= in the
        URL param

        <br>By default, 50 are returned, you can use up to max=10000 in the URL
        param
      operationId: get_events
      responses:
        '200':
          description: Events successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EventSearchResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Events
      summary: Create an Event
      description: Create a new event. It can be added to a content list later
      operationId: post_events
      requestBody:
        description: Event object that needs to be created
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/EventResponseWrapper'
        required: true
      responses:
        '201':
          description: Event successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Events
      summary: Delete an Event using identifier
      description: Delete an event identified by identifier in the url param
      operationId: delete_events
      responses:
        '204':
          description: Event successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Events
      summary: Update an Event using identifier
      description: >-
        Make changes to an event, always use ?identifier= in url param to
        identify the event uniquely

        Any blank parameter deletes an old value, any unspecified parameter does
        nothing
      operationId: patch_events
      requestBody:
        description: Event object that needs to be updated
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/EventResponseWrapper'
        required: true
      responses:
        '200':
          description: Event successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /events/{id}:
    get:
      tags:
        - Events
      summary: Get an Event
      description: Get a single event identified by its uberall unique id
      operationId: get_events_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the event
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Event successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EventResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Events
      summary: Delete an Event
      description: Delete an event
      operationId: delete_events_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the event
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Event successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Events
      summary: Update an Event
      description: >-
        Make changes to an event. Any blank parameter deletes an old value, any
        unspecified parameter does nothing
      operationId: patch_events_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the event
          required: true
          schema:
            type: string
      requestBody:
        description: Event object that needs to be updated
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/EventResponseWrapper'
        required: true
      responses:
        '200':
          description: Event successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/facebook/page:
    get:
      tags:
        - Listings
      summary: Get Location's Facebook Page
      description: Get the Facebook page connected to a specific location
      operationId: get_locations_id_facebook_page
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the location you want the Facebook page for
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Facebook page retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryPageResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Listings
      summary: DEPRECATED - Connect Facebook Page
      description: Connect a Facebook page to the location
      operationId: post_locations_id_facebook_page
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the location
          required: true
          schema:
            type: string
        - name: fb_access_token
          in: query
          description: >-
            A Facebook API access token with "manage_pages", "publish_actions"
            and "read_page_mailboxes" permissions
          schema:
            type: string
        - name: pageId
          in: query
          description: The Facebook unique id of the page you want to connect
          schema:
            type: string
      responses:
        '200':
          description: Facebook page connected
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DirectoryPageResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      deprecated: true
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Listings
      summary: Disconnect Location's Facebook Page
      description: Disconnect the Facebook page connected to a specific location
      operationId: delete_locations_id_facebook_page
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the location
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Facebook page disconnected
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /businesses/{id}/business-connect/facebook/{facebookAccountId}/brand-page-list:
    get:
      tags:
        - Businesses
      summary: Returns only the Facebook brand pages for the given Facebook account
      description: Returns only the Facebook brand pages
      operationId: >-
        get_businesses_id_business_connect_facebook_facebookAccountId_brand_page_list
      parameters:
        - name: id
          in: path
          description: Id of the business that will be used for the search
          required: true
          schema:
            type: string
        - name: facebookAccountId
          in: path
          description: >-
            Unique facebook account id which will be used for locating brand
            pages
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Facebook brand pages retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BrandPagesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /features:
    get:
      tags:
        - Configuration
      summary: Get available and potential features per location (business)
      description: Get user features partitioned by location.
      operationId: get_features
      responses:
        '200':
          description: Features successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/google/page:
    get:
      tags:
        - Listings
      summary: >-
        Get information about the connected Google Page of the specified
        location
      description: Get information such as Google place id, write review URL, etc.
      operationId: get_locations_id_google_page
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the location
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved Google Page information
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GoogleVenueDetailsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Listings
      summary: Disconnect Google Page
      description: Disconnect the Google Page connected to the specified location
      operationId: delete_locations_id_google_page
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the location
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully disconnected Google Page
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/instagram/page:
    delete:
      tags:
        - Listings
      summary: Disconnect Instagram Page
      description: Disconnect the Instagram Page connected to the specified location
      operationId: delete_locations_id_instagram_page
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the location
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Instagram page has been disconnected
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /labels:
    get:
      tags:
        - Labels
      summary: Get All Labels
      description: Get all labels associated to locations of the user
      operationId: get_labels
      responses:
        '200':
          description: Successfully retrived labels
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LabelListWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /listings/{id}:
    patch:
      tags:
        - Listings
      summary: Edit Listing
      description: Used for MANUALLY_CREATED listings to update listingUrl and syncStatus
      operationId: patch_listings_id
      parameters:
        - name: id
          in: path
          description: The ID of the MANUALLY_CREATED listing to be updated
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully updated Listing
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /listings/{id}/flag:
    put:
      tags:
        - Listings
      summary: Flag a Listing
      description: Flag a listing if it is not corresponding to the right location
      operationId: put_listings_id_flag
      parameters:
        - name: id
          in: path
          description: The uberall unique ID for the listing to flag
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully flagged Listing
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /locations/available-lodging-fields:
    get:
      tags:
        - Locations Data
      summary: Get the available amenities (Google Lodging) fields for a location
      description: Get the list of all available amenities (Google Lodging) fields.
      operationId: get_locations_available_lodging_fields
      responses:
        '200':
          description: Available lodging fields successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LodgingFieldResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/cities:
    get:
      tags:
        - Locations Data
      summary: Get the city for locations
      description: Get the location's city
      operationId: get_locations_cities
      parameters:
        - name: locationIds
          in: query
          description: Get the cities for locations by location Ids
          schema:
            type: array
            items:
              type: string
        - name: businessIds
          in: query
          description: Get the cities for locations by business id
          schema:
            type: array
            items:
              type: string
        - name: postcodes
          in: query
          description: Get the cities for locations by postcodes
          schema:
            type: array
            items:
              type: string
        - name: countries
          in: query
          description: Get the cities for locations by country
          schema:
            type: array
            items:
              type: string
        - name: provinces
          in: query
          description: Get the cities for locations by province / state
          schema:
            type: array
            items:
              type: string
        - name: query
          in: query
          description: >-
            Restricts the response to the cities that contain this text, for
            example "ber" would return "Berlin" when appropriate.
          schema:
            type: string
        - name: max
          in: query
          description: Maximum number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Cities successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CitiesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/countries:
    get:
      tags:
        - Locations Data
      summary: Get the country for locations
      description: Get the country for each location
      operationId: get_locations_countries
      parameters:
        - name: businessIds
          in: query
          description: The business ids for the locations that should be returned
          required: true
          schema:
            type: string
        - name: max
          in: query
          description: Maximum number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Countries successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CountriesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations:
    get:
      tags:
        - Locations Data
      summary: Get Several Locations
      description: >-
        Get locations managed by the current API user. Some fields are omitted
        (such as paymentOptions and services). For a full list use the
        GET/api/locations/$id endpoint.
      operationId: get_locations
      parameters:
        - name: businessId
          in: query
          description: >-
            Only return locations in the business identified by businessId.
            Allowed multiple businessIds
          style: form
          schema:
            type: array
            items:
              type: integer
              format: int64
          example: /api/locations?businessId=123&businessId=456
        - name: businessIds
          in: query
          description: Returns all locations associated with multiple business ids
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: cities
          in: query
          description: Get locations in the requested cities
          schema:
            type: array
            items:
              type: string
        - name: classification
          in: query
          description: 'Possible values: REQUIRED, BASIC, ADVANCED, BONUS and COMPLETE'
          schema:
            type: string
        - name: countries
          in: query
          description: Get locations in the requested country
          schema:
            type: array
            items:
              type: string
        - name: endDateMax
          in: query
          description: >-
            Only locations with an endDate less than or equal to endDateMax will
            be returned
          schema:
            type: string
            format: date-time
          example: '2020-02-05T12:18:12.000+01:00'
        - name: endDateMin
          in: query
          description: >-
            Only locations with an endDate greater than or equal to endDateMin
            will be returned.
          schema:
            type: string
            format: date-time
          example: '2018-02-05T12:18:12.000+01:00'
        - name: excludedLocationIds
          in: query
          description: List of locationIds that should be excluded from the result
          schema:
            type: array
            items:
              type: integer
              format: int64
          example: excludedLocationIds=20&excludedLocationIds=21 for multiple locations
        - name: facebookStatus
          in: query
          description: 'Possible values: CONNECTED, NOT_CONNECTED'
          schema:
            type: string
        - name: fieldMask
          in: query
          description: >-
            Possible fieldMask options ( 'id', 'name', 'identifier', 'street',
            'streetNo', 'streetAndNumber', 'addressExtra', 'zip', 'city',
            'country',
                                                                           'dateCreated', 'endDate', 'province', 'lat', 'lng', 'addressDisplay', 'phone', 'fax', 'timeZone',
                                                                           'cellphone', 'website', 'email', 'legalIdent', 'taxNumber', 'descriptionShort',
                                                                           'descriptionLong', 'imprint', 'openingHoursNotes', 'status', 'photos', 'attributes',
                                                                           'firstSyncStarted', 'lastUpdated', 'lastSyncStarted', 'autoSync', 'locationSyncable', 'businessId', 'businessName', 'productPlanName',
                                                                           'googleInsights', 'labels', 'customFields', 'features', 'groups', 'openingHours', 'specialOpeningHours', 'nameDescriptor',
                                                                           'actionsRequired', 'profileCompleteness', 'suggestionsForFieldsAvailable', 'listingsInSync', 'activeListingsCount',
                                                                           'dataPoints', 'averageRating', 'directoriesMissingConnect' )
          style: form
          schema:
            type: array
            items:
              type: string
          example: fieldMask=city&fieldMask=zip
        - name: googleDirectoryStatus
          in: query
          description: >-
            Possible values: VERIFIED (the Google listing is verified and fully
            managed by us),
                                        UNVERIFIED (the Google listing is not verified),
                                        DISABLED (the Google listing is disabled),
                                        SUSPENDED (the Google listing is suspended),
                                        DUPLICATE (the Google listing is a duplicate),
                                        PENDING_VERIFICATION (a verification pin has been requested for the Google listing),
                                        NEEDS_REVERIFICATION (the verification process for the Google listing needs to be reverified),
                                        PENDING_REVIEW (there is no Google account connected for the listing)
          schema:
            type: string
        - name: googleStatus
          in: query
          description: >-
            Possible values: VERIFIED (the Google listing is verified and fully
            managed by us),
                                        VERIFICATION_STARTED (a verification pin has been requested for the Google listing),
                                        VERIFICATION_NOT_STARTED (the verification process has not been start for the Google listing),
                                        NOT_CONNECTED (there is no Google account connected for the listing),
                                        VERIFIED_BY_THIRD_PARTY (there is a verified listing on Google but we do not manage it)
          schema:
            type: string
        - name: groupIds
          in: query
          description: The groupId to which the location belongs
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: groups
          in: query
          description: The name of the group to which the location belongs
          schema:
            type: array
            items:
              type: string
        - name: identifier
          in: query
          description: >-
            Only return one location (per business) based on your internal
            identification system
          schema:
            type: string
        - name: labels
          in: query
          description: Only return locations that contain at least one of the given labels
          schema:
            type: array
            items:
              type: string
        - name: locationIds
          in: query
          description: Only return locations identified by ids listed in locationIds
          style: form
          schema:
            type: array
            items:
              type: integer
              format: int64
          example: '?locationIds=20&locationIds=22 for multiple locations'
        - name: max
          in: query
          description: >-
            Used for pagination. Maximum number of results per page. Default: 50
            (Without a defined FieldMask the maximum number of results is 50.)
          schema:
            type: integer
            format: int64
        - name: missingDirectoryField
          in: query
          description: Only return locations that have no value for the given field
          style: form
          schema:
            type: array
            items:
              type: string
        - name: needsReview
          in: query
          description: >-
            If set to true, only return locations with faulty data in need of
            review. Default: false.
          schema:
            type: boolean
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
        - name: order
          in: query
          description: use asc for ascending sort or desc for descending sort
          schema:
            type: string
        - name: postcodes
          in: query
          description: Get locations in the requested post / zip codes
          schema:
            type: array
            items:
              type: string
        - name: provinces
          in: query
          description: Get locations in the requested province / state
          schema:
            type: array
            items:
              type: string
        - name: query
          in: query
          description: Filter by name, zip, street, city, label
          schema:
            type: string
          example: Berlin
        - name: queryFields
          in: query
          description: >-
            The fields that will be searched to contain the value provided in
            the 'query' query parameter.
          schema:
            type: array
            items:
              type: string
        - name: selectAll
          in: query
          description: >-
            Setting selectAll to true allows finding ALL locations for any given
            businessId, locationIds and labels. In other words these fields are
            OR joined.
          schema:
            type: boolean
        - name: sort
          in: query
          description: >-
            The location property to sort by (ascending unless order is
            specified).
                                        One of name, street, streetNo, zip, city, phone, cellphone, fax, website, email, lastSyncStarted, country
          schema:
            type: string
        - name: status
          in: query
          description: Filter by locations status. One of ACTIVE, INACTIVE, CANCELLED
          schema:
            type: array
            items:
              type: string
        - name: syncNeeded
          in: query
          description: >-
            If set to true, filter locations that have been updated but did not
            start a sync yet
          schema:
            type: boolean
        - name: syncStarted
          in: query
          description: >-
            If set to true, filter locations that started a sync. If set to
            false, filter locations that never synced
          schema:
            type: boolean
        - name: temporarilyClosed
          in: query
          description: >-
            Filter for locations that are currently set to temporarily closed
            (True) or are not temporarily closed (False)
          schema:
            type: boolean
      responses:
        '200':
          description: Locations successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSearchResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Locations Data
      summary: Create a Location
      description: Create a location and add it to an existing business
      operationId: post_locations
      requestBody:
        description: Location object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Location'
        required: true
      responses:
        '200':
          description: Location successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Locations Data
      summary: Delete Several Locations
      description: >-
        Delete several locations identified by their uberall unique ids. 

        Locations can be deleted only if they are inactivated (status =
        INACTIVE) and are no longer billed (endDate < now).
      operationId: delete_locations
      parameters:
        - name: locations
          in: query
          description: The uberall unique ids for the locations you want to delete
          required: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Locations successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeleteSuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Locations Data
      summary: Update Several Locations
      description: >-
        Make changes to a list of locations. Any blank parameter deletes an old
        value, any unspecified parameter does nothing
      operationId: patch_locations
      requestBody:
        description: >-
          List of Maps with both location id and params to update : [{id: 123,
          status: CANCELLED}, ...]
        content:
          '*/*':
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Location'
        required: true
      responses:
        '200':
          description: Locations successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/dashboard:
    get:
      tags:
        - Locations Data
      summary: Get a Location's Dashboard
      description: Get all necessary information to build a location's dashboard
      operationId: get_locations_id_dashboard
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the location you want a dashboard for
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Location dashboard successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationDashboardResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      deprecated: true
      security:
        - accessToken: []
        - privateKey: []
  /locations/directories:
    get:
      tags:
        - Locations Data
      summary: Get the directories for locations
      description: Get the directories for a location
      operationId: get_locations_directories
      responses:
        '200':
          description: Directories successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DirectoriesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}:
    get:
      tags:
        - Locations Data
      summary: Get a Location
      description: >-
        Get all information about a specific location, including listing
        statuses
      operationId: get_locations_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the location
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Location successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Locations Data
      summary: Update a Location
      description: >-
        Make changes to a location. Any blank parameter deletes an old value,
        any unspecified parameter does nothing
      operationId: patch_locations_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the location you want to update
          required: true
          schema:
            type: string
      requestBody:
        description: Location object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Location'
        required: true
      responses:
        '200':
          description: Location successfully edited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /locations/businesses:
    get:
      tags:
        - Locations Data
      summary: Get a list of basic business details
      description: >-
        Get a list of basic business details containing "id" and "name", that
        can be viewed by the current user.
      operationId: get_locations_businesses
      parameters:
        - name: query
          in: query
          description: |-
            Value used to filter the results.
                                    The value will be searched for in the following fields: "name", "streetAndNo", "zip", "city", "country", "identifier".
          schema:
            type: string
        - name: sort
          in: query
          description: The business property to sort by. Can be "id" or "name".
          schema:
            type: string
        - name: max
          in: query
          description: >-
            Used for pagination. Maximum number of results per page. Default:
            1000
          schema:
            type: string
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: string
        - name: order
          in: query
          description: 'Sets the sorting order. Default: "asc".'
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved Businesses
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessPageResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/listings-details/list:
    get:
      tags:
        - Listings
      summary: Get all Listings for a specific Location
      description: Lists all the details of all Listings for a specific Location
      operationId: get_locations_id_listings_details_list
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the location
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Listings details successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListingsDetailsResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/keywords:
    get:
      tags:
        - Locations Data
      summary: Get the keywords for locations
      description: Get the keywords for locations
      operationId: get_locations_keywords
      parameters:
        - name: locationIds
          in: query
          description: The location ids that should have keywords returned
          schema:
            type: array
            items:
              type: string
        - name: businessIds
          in: query
          description: The business ids for the locations that should be returned
          schema:
            type: array
            items:
              type: string
        - name: excludedLocationIds
          in: query
          description: List of location ids which should be excluded from keywords search
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Keywords for locations successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/KeywordsWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/visibility-indexes/interesting:
    get:
      tags:
        - Locations Data
      summary: Get Historical Visibility Index
      description: >-
        Get a Visibility Index time series. Only days where the Visibility Index
        changed will be returned
      operationId: get_locations_id_visibility_indexes_interesting
      parameters:
        - name: id
          in: path
          description: >-
            The uberall unique id of the location you want the Visibility Index
            for
          required: true
          schema:
            type: string
        - name: startDate
          in: query
          description: startDate in YYYY-MM-dd
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: endDate in YYYY-MM-dd
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Historical visibility indexes successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VisibilityIndexesWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/labels:
    get:
      tags:
        - Locations Data
      summary: Get the labels for locations
      description: Get the labels assigned to a location
      operationId: get_locations_labels
      parameters:
        - name: query
          in: query
          description: >-
            Used for searching for a specific keyword within label names, only
            label names matching the given query via 'like' will be returned.
          schema:
            type: string
      responses:
        '200':
          description: Labels successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LabelsResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/postcodes:
    get:
      tags:
        - Locations Data
      summary: Get the post / zip code for locations
      description: Get the post / zip code assigned to a location
      operationId: get_locations_postcodes
      parameters:
        - name: locationIds
          in: query
          description: >-
            Get the post / zip codes for associated to the given list of
            location Ids
          schema:
            type: array
            items:
              type: string
        - name: businessIds
          in: query
          description: Get the post / zip codes for locations assigned to a business id
          schema:
            type: array
            items:
              type: string
        - name: countries
          in: query
          description: Get the post / zip codes for locations within a country
          schema:
            type: array
            items:
              type: string
        - name: provinces
          in: query
          description: Get the post / zip codes for locations within a province / state
          schema:
            type: array
            items:
              type: string
        - name: cities
          in: query
          description: Get the post / zip codes for locations within a city
          schema:
            type: array
            items:
              type: string
        - name: query
          in: query
          description: >-
            Restricts the response to the post/zip codes that contain this text,
            for example "374" would return "37490" when appropriate.
          schema:
            type: string
        - name: max
          in: query
          description: Maximum number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Postcodes successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PostcodesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/provinces:
    get:
      tags:
        - Locations Data
      summary: Get the province/state for locations
      description: >-
        Get a list of provinces/states, for locations available to the user,
        with filtering on businesses, countries, or a search text
      operationId: get_locations_provinces
      parameters:
        - name: businessIds
          in: query
          description: >-
            Get the provinces / states of locations associated with specific
            Business Id(s)
          schema:
            type: array
            items:
              type: string
        - name: countries
          in: query
          description: Get provinces / states for locations in a country
          schema:
            type: array
            items:
              type: string
        - name: query
          in: query
          description: >-
            Restricts the response to the provinces/states that contain this
            text, for example 'indi' would return 'Indiana' when appropriate.
          schema:
            type: string
        - name: max
          in: query
          description: Maximum number of items to return
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Provinces successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProvincesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/statistics:
    get:
      tags:
        - Locations Data
      summary: Get Locations' Statistics
      description: >-
        Get statistics about the locations the current user is managing: total
        and breakdown by status
      operationId: get_locations_statistics
      responses:
        '200':
          description: Location statistics successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationStatisticsResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/sync:
    post:
      tags:
        - Locations Data
      summary: Sync a Location
      description: Start a sync on all directories for a specific location
      operationId: post_locations_id_sync
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the location you want to sync
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Location successfully synced
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /locations/sync:
    post:
      tags:
        - Locations Data
      summary: Sync Several Locations
      description: >-
        Start a sync on all directories for several locations identified by
        their unique uberall id
      operationId: post_locations_sync
      requestBody:
        description: LocationSearchParams object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationSearchParams'
      responses:
        '200':
          description: Locations successfully synced
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/ev-data/{uid}:
    patch:
      tags:
        - Locations Data
      summary: Update EV Dynamic Data
      description: Update EV Charging data for a given EV Charging Station.
      operationId: patch_locations_id_ev_data_uid
      parameters:
        - name: id
          in: path
          description: >-
            The uberall unique id of the EV Charging station for which you want
            to update information.
          required: true
          schema:
            type: string
        - name: uid
          in: path
          description: The UID for the EV Charging station
          required: true
          schema:
            type: string
        - name: status
          in: query
          description: Query based on the location status
          required: true
          schema:
            type: string
      requestBody:
        description: A EvStatus object
        content:
          '*/*':
            schema:
              type: string
              description: EvStatus Enum Model
              enum:
                - AVAILABLE
                - BLOCKED
                - CHARGING
                - INOPERATIVE
                - OUTOFORDER
                - PLANNED
                - REMOVED
                - RESERVED
                - UNKNOWN
        required: true
      responses:
        '200':
          description: Request successfully sent to eco-movement
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EvDynamicDataWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/visibility-indexes:
    get:
      tags:
        - Locations Data
      summary: Get Location's Visibility Index
      description: Get the latest location's visibility index
      operationId: get_locations_id_visibility_indexes
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the location
          required: true
          schema:
            type: string
        - name: days
          in: query
          description: Use days to get the visibility index from as many days ago
          schema:
            type: string
      responses:
        '200':
          description: Visibility indexes successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VisibilityIndexWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /location-groups:
    get:
      tags:
        - Location Groups
      summary: Search through all LocationGroups
      description: >-
        Can be used to search for specific location groups or even return all,
        depending on the given params.
      operationId: get_location_groups
      parameters:
        - name: fieldMask
          in: query
          description: >-
            Used for bypassing pagination and reducing the response objects
            (List of String), following are supported ["id", "name"]
          schema:
            type: array
            items:
              type: string
        - name: locationGroupIds
          in: query
          description: >-
            Used for restricting the returned location groups within the given
            range of IDs.
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: query
          in: query
          description: >-
            Used for searching for a specific keyword within the location group
            names, only groups matching the given query via 'like' will be
            returned.
          schema:
            type: string
        - name: max
          in: query
          description: >-
            Used for pagination, specifies the amount of entries maximum
            returned per page (must be between 0-100).
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: >-
            Used for pagination, specifies the starting point from which the
            returned subset should start.
          schema:
            type: integer
            format: int64
        - name: page
          in: query
          description: >-
            Used for pagination, specifies which page you want to get back from
            a set of pages.
                                                    Can be used instead of using "offset". Can also be used in combination with "max" otherwise default "max" is being used.
                                                    Difference to "offset" is that you don't need to calculate the correct value, you can simply request page number 2 with max 10 result in it
                                                    (page: 2, max: 10). So you will get back results 10-19 while skipping the first 10 (0-9) ones.
          schema:
            type: integer
            format: int64
        - name: sort
          in: query
          description: >-
            Used for specify the field by which the list entries shall be
            sorted, possible values ["NAME", "LAST_UPDATED", "LOCATION_SIZE",
            "USER_SIZE"].
                                                        If none or invalid given list will automatically sorted by "id".
          schema:
            type: string
        - name: order
          in: query
          description: >-
            Used for specify the sorting direction in which the list entries
            shall be returned, possible values ['ASC', 'DESC'].
          schema:
            type: string
        - name: hideLocations
          in: query
          description: >-
            If given true value the endpoint will not return the locations array
            as part of the response, just the group id and name
          schema:
            type: boolean
      responses:
        '200':
          description: LocationGroups successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationGroupListResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
    post:
      tags:
        - Location Groups
      summary: Create a new LocationGroup
      description: Can be used to create a new LocationGroup
      operationId: post_location_groups
      requestBody:
        description: LocationGroup to create
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/LocationGroupParams'
        required: true
      responses:
        '200':
          description: LocationGroup created successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationGroupWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
  /location-groups/{id}:
    get:
      tags:
        - Location Groups
      summary: Get a single LocationGroup
      description: Can be used to retrieve a single LocationGroup.
      operationId: get_location_groups_id
      parameters:
        - name: id
          in: path
          description: ID of the LocationGroup that should be returned.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: LocationGroup successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationGroupWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
    delete:
      tags:
        - Location Groups
      summary: Delete a single LocationGroup
      description: Can be used for deleting a single LocationGroup.
      operationId: delete_location_groups_id
      parameters:
        - name: id
          in: path
          description: ID of the LocationGroup that should be deleted.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: LocationGroup deleted successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationGroupWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
    patch:
      tags:
        - Location Groups
      summary: Update a single LocationGroup
      description: Can be used for updating a single LocationGroup.
      operationId: patch_location_groups_id
      parameters:
        - name: id
          in: path
          description: ID of the LocationGroup that should be updated.
          required: true
          schema:
            type: string
      requestBody:
        description: LocationGroup to update
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/LocationGroupPatchParams'
        required: true
      responses:
        '200':
          description: LocationGroup updated successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationGroupWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
  /menu-items:
    get:
      tags:
        - Menu Items
      summary: Get All Menu Items
      description: >-
        Get all menu items the current API user can manage.

        <br>To specify products with identifier please provide ?identifier= in
        the URL param

        <br>By default, 50 are returned, you can use up to max=10000 in the URL
        param
      operationId: get_menu_items
      responses:
        '200':
          description: Menu Items successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MenuItemSearchResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Menu Items
      summary: Create a Menu Item
      description: Create a menu item. It can be added to a content list later
      operationId: post_menu_items
      requestBody:
        description: Menu Item object to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MenuItem'
        required: true
      responses:
        '201':
          description: Menu Item successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MenuItemResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Menu Items
      summary: Delete a Menu Item using identifier
      description: Delete a menu item identified by identifier in the url param
      operationId: delete_menu_items
      responses:
        '204':
          description: Menu Item successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Menu Items
      summary: Update a Menu Item using identifier
      description: >-
        Make changes to a menu item, always use ?identifier= in url param to
        identify the menu item uniquely

        Any blank parameter deletes an old value, any unspecified parameter does
        nothing
      operationId: patch_menu_items
      requestBody:
        description: Menu Item object to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MenuItem'
        required: true
      responses:
        '200':
          description: Menu Item successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MenuItemResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /menu-items/{id}:
    get:
      tags:
        - Menu Items
      summary: Get a Menu Item
      description: Get a sigle menu item
      operationId: get_menu_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the menu item
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Menu Item successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MenuItemResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Menu Items
      summary: Delete a Menu Item
      description: Delete a menu item
      operationId: delete_menu_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the menu item
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Menu Item successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Menu Items
      summary: Update a Menu Item
      description: >-
        Make changes to a menu item. Any blank parameter deletes an old value,
        any unspecified parameter does nothing
      operationId: patch_menu_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the menu item
          required: true
          schema:
            type: string
      requestBody:
        description: Menu Item object to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MenuItem'
        required: true
      responses:
        '200':
          description: Menu Item successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MenuItemResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /menu-items/accepted-extra-fields:
    get:
      tags:
        - Menu Items
      summary: Get accepted values for dietary restrictions and allergens
      description: >-
        Menu items can have additional information added to them. Certain fields
        are limited to specific values. Get the list of values here.
      operationId: get_menu_items_accepted_extra_fields
      responses:
        '200':
          description: Accepted Extra Fields successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedExtraFieldsResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /ping:
    get:
      tags:
        - Monitoring
      summary: Get API Status
      description: Get the current status of uberall API
      operationId: get_ping
      responses:
        '200':
          description: Service is alive
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
  /persons:
    get:
      tags:
        - Persons
      summary: Get All Persons
      description: >-
        Get all persons the current API user can manage.

        <br>To specify products with identifier please provide ?identifier= in
        the URL param

        <br>By default, 50 are returned, you can use up to max=10000 URL param
      operationId: get_persons
      responses:
        '200':
          description: Successfully retrieved persons
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PersonSearchResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Persons
      summary: Create a Person
      description: Create a person. It can be added to a content list later
      operationId: post_persons
      requestBody:
        description: Person object that needs to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Person'
        required: true
      responses:
        '201':
          description: Person created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Persons
      summary: Delete a Person using identifier
      description: Delete a person identified by identifier in the url param
      operationId: delete_persons
      responses:
        '204':
          description: Person deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
    patch:
      tags:
        - Persons
      summary: Update a Person using identifier
      description: >-
        Make changes to a person, always use ?identifier= in url param to
        identify the person uniquely

        Any blank parameter deletes an old value, any unspecified parameter does
        nothing
      operationId: patch_persons
      requestBody:
        description: Person object that needs to be updated
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Person'
        required: true
      responses:
        '200':
          description: Person updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PersonResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /persons/{id}:
    get:
      tags:
        - Persons
      summary: Get a Person
      description: Get a person identified by its uberall unique id
      operationId: get_persons_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the person you want to get
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved person
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Persons
      summary: Delete a Person
      description: Delete a person
      operationId: delete_persons_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the person you want to delete
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Person deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Persons
      summary: Update a Person
      description: >-
        Make changes to a person. Any blank parameter deletes an old value, any
        unspecified parameter does nothing
      operationId: patch_persons_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the person you want to update
          required: true
          schema:
            type: string
      requestBody:
        description: Person object that needs to be updated
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Person'
        required: true
      responses:
        '200':
          description: Person updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PersonResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /photos:
    post:
      tags:
        - Locations Photos
      summary: Upload a Photo
      description: Upload a photo
      operationId: post_photos
      requestBody:
        description: The photo data to upload
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationPhoto'
        required: true
      responses:
        '200':
          description: The photo has been uploaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationPhotoResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /photos/{id}:
    get:
      tags:
        - Locations Photos
      summary: Get a Photo
      description: Get a photo identified by its uberall unique id
      operationId: get_photos_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the photo
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved the photo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationPhotoResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Locations Photos
      summary: Delete a Photo
      description: Delete a photo identified by its uberall unique id
      operationId: delete_photos_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the photo
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The photo has been deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Locations Photos
      summary: Update a Photo
      description: Edit a photo
      operationId: patch_photos_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the photo
          required: true
          schema:
            type: string
      requestBody:
        description: The photo data to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationPhoto'
        required: true
      responses:
        '200':
          description: The photo has been updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationPhotoResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /products:
    get:
      tags:
        - Products
      summary: Get All Products
      description: >-
        Get all products the current API user can manage.

        <br>To specify products with identifier please provide ?identifier= in
        the URL param

        <br>By default, 50 are returned, you can use up to max=10000 URL param
      operationId: get_products
      responses:
        '200':
          description: Products successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProductSearchWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Products
      summary: Create a Product
      description: Create a product. It can be added to a content list later
      operationId: post_products
      requestBody:
        description: A Product object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Product'
        required: true
      responses:
        '201':
          description: Product successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Products
      summary: Delete a Product using identifier
      description: Delete a product identified by identifier in the url param
      operationId: delete_products
      responses:
        '200':
          description: Product successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Products
      summary: Update a Product using identifier
      description: >-
        Make changes to a product, always use ?identifier= in url param to
        identify the product uniquely

        Any blank parameter deletes an old value, any unspecified parameter does
        nothing
      operationId: patch_products
      requestBody:
        description: A Product object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Product'
        required: true
      responses:
        '200':
          description: Product successfully updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProductWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /products/{id}:
    get:
      tags:
        - Products
      summary: Get a Product
      description: Get a product identified by its uberall unique id
      operationId: get_products_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID for the product you want to get
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Product successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProductWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Products
      summary: Delete a Product
      description: Delete a product identified by its uberall unique id
      operationId: delete_products_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID for the product you want to delete
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Product successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Products
      summary: Update a Product
      description: >-
        Make changes to a product. Any blank parameter deletes an old value, any
        unspecified parameter does nothing
      operationId: patch_products_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID for the product you want to update
          required: true
          schema:
            type: string
      requestBody:
        description: A Product object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Product'
        required: true
      responses:
        '200':
          description: Product successfully updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProductWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /product-plans:
    get:
      tags:
        - Product Plans
      summary: Get All Product Plans
      description: Get all product plans available to the current API user
      operationId: get_product_plans
      parameters:
        - name: country
          in: query
          description: >-
            Optional parameter to retrieve plans and supported directories for a
            specific country
          schema:
            type: string
      responses:
        '200':
          description: Product Plans successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProductPlanListResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Product Plans
      summary: Create a Product Plan
      description: >-
        Create a new Product Plan. The new Product Plan will be always created
        into PENDING_APPROVAL status.
      operationId: post_product_plans
      requestBody:
        description: A Product Plan object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductPlan'
        required: true
      responses:
        '200':
          description: Product Plan successfully created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProductPlanResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /product-plans/{id}:
    patch:
      tags:
        - Product Plans
      summary: Update a Product Plan
      description: >-
        Update an existing Product Plan. Only defaultPlan, description, name,
        status are updatable via API.
      operationId: patch_product_plans_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the Product Plan
          required: true
          schema:
            type: string
      requestBody:
        description: A Product Plan object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductPlanRequestBody'
        required: true
      responses:
        '200':
          description: Product Plan successfully updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProductPlanResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /templates:
    get:
      tags:
        - Templates
      summary: Get All Templates
      description: >-
        Get all templates, potentially filtered by businesses, locations,
        authors, ...
      operationId: get_templates
      parameters:
        - name: query
          in: query
          description: Free text search that applies to title and message
          schema:
            type: string
        - name: tags
          in: query
          description: The tags values you want templates for
          schema:
            type: string
        - name: minLastEdited
          in: query
          description: The min date of the last update of the template
          schema:
            type: string
        - name: maxLastEdited
          in: query
          description: The max date of the last update of the template
          schema:
            type: string
        - name: minTimesUsed
          in: query
          description: The min usage count you want templates for
          schema:
            type: integer
            format: int64
        - name: maxTimesUsed
          in: query
          description: The max usage count you want templates for
          schema:
            type: integer
            format: int64
        - name: createdBy
          in: query
          description: The ids of authors you want templates for
          schema:
            type: string
        - name: businesses
          in: query
          description: The ids of businesses you want templates for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locations
          in: query
          description: The ids of locations you want templates for
          schema:
            type: string
        - name: page
          in: query
          description: Used for pagination. Page number we're interested in
          schema:
            type: integer
            format: int64
        - name: size
          in: query
          description: Number of templates per page
          schema:
            type: integer
            format: int64
        - name: sort
          in: query
          description: Name of the field we want to sort
          schema:
            type: string
        - name: direction
          in: query
          description: Use asc for ascending sort or desc for descending sort
          schema:
            type: string
      responses:
        '200':
          description: Templates retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseTemplatesWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Templates
      summary: Creates a Template
      description: Creates a template
      operationId: post_templates
      requestBody:
        description: Template to create
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/CreateTemplateRequest'
        required: true
      responses:
        '200':
          description: Template created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseTemplateWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /templates/{id}:
    get:
      tags:
        - Templates
      summary: Get a Template
      description: Get all information about a specific template
      operationId: get_templates_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the template
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Template retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseTemplateWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Templates
      summary: Delete a Template
      description: Delete a Template
      operationId: delete_templates_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the template
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Template deleted.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Templates
      summary: Update a Template
      description: >-
        Make changes to a template. Any blank parameter deletes an old value,
        any unspecified parameter does nothing
      operationId: patch_templates_id
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the template
          required: true
          schema:
            type: string
      requestBody:
        description: Template to update
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/CreateTemplateRequest'
        required: true
      responses:
        '200':
          description: Template updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseTemplateWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /templates/{id}/increment-usage:
    post:
      tags:
        - Templates
      summary: Increment the count of times a Template has been used
      description: >-
        Every time a template is used we trigger this endpoint to increment the
        usage count
      operationId: post_templates_id_increment_usage
      parameters:
        - name: id
          in: path
          description: The uberall unique id of the template
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Usage count incremented
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseTemplateWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /templates/authors:
    get:
      tags:
        - Templates
      summary: Returns a list of Authors
      description: Returns a list containing template authors for the input business ids
      operationId: get_templates_authors
      parameters:
        - name: businesses
          in: query
          description: The ids of businesses you want authors for
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Authors retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseUsersWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /templates/tags:
    get:
      tags:
        - Templates
      summary: Returns a list of Tags
      description: Returns a list containing template tags for the input business ids
      operationId: get_templates_tags
      parameters:
        - name: businesses
          in: query
          description: The ids of businesses you want templates for
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Tags retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/StringListSuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /sales-partners/{id}/sso-settings:
    patch:
      tags:
        - Sales Partners
      summary: Update SSO Settings of a SalesPartner
      description: Can be used to update certain SSO settings for a single SalesPartner.
      operationId: patch_sales_partners_id_sso_settings
      parameters:
        - name: id
          in: path
          description: ID of the SalesPartner
          required: true
          schema:
            type: string
      requestBody:
        description: >-
          Flag to indicate if single sign-on should be enforced. If enforced,
          users are allowed to log in via the single sign-on flow.
                                                  Furthermore, the User's details such as name, email, feature, and others will be updatable via single sign-on only
        content:
          '*/*':
            schema:
              type: object
              properties:
                forceSso:
                  type: boolean
      responses:
        '200':
          description: Successfully edited SalesPartner SSO settings
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SalesPartnerWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /sales-partners:
    get:
      tags:
        - Sales Partners
      summary: Search among child SalesPartners
      description: >-
        Can be used for searching through all children SalesPartner for the
        given parent SalesPartner
      operationId: get_sales_partners
      parameters:
        - name: id
          in: query
          description: Filter by specific uberall SalesPartner id
          schema:
            type: string
        - name: query
          in: query
          description: Filter by name or identifier
          schema:
            type: string
        - name: status
          in: query
          description: Filter by status
          schema:
            type: string
        - name: sort
          in: query
          description: 'SalesPartner property used for pagination. Default: ''id'''
          schema:
            type: string
        - name: order
          in: query
          description: 'Order used for pagination. Default: ''asc'''
          schema:
            type: string
        - name: max
          in: query
          description: >-
            Used for pagination. Maximum number of results per page. Default:
            1000
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Successfully retrieved all child SalesPartners
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SalesPartnerListResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Sales Partners
      summary: Create child SalesPartner
      description: >-
        Can be used to create new child SalesPartner that will be then
        associated to your parent SalesPartner.
      operationId: post_sales_partners
      requestBody:
        description: SalesPartner data to create a new child SalesPartner
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSalesPartnerRequestBody'
        required: true
      responses:
        '200':
          description: Successfully created child SalesPartner
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SalesPartnerWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /sales-partners/{id}:
    get:
      tags:
        - Sales Partners
      summary: Get a single SalesPartner
      description: >-
        Can be used for retrieving informations about a single SalesPartner.
        This could either be your own SalesPartner or if your SalesPartner is a
        parent an associated child SalesPartner.
      operationId: get_sales_partners_id
      parameters:
        - name: id
          in: path
          description: ID of the SalesPartner
          required: true
          schema:
            type: string
      responses:
        '200':
          description: SalesPartner successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SalesPartnerWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    put:
      tags:
        - Sales Partners
      summary: Update a single SalesPartner
      description: >-
        Can be used to either update your own SalesPartner or if your
        SalesPartner is a parent you will be able to also update associated
        child SalesPartners.
      operationId: put_sales_partners_id
      parameters:
        - name: id
          in: path
          description: ID of the SalesPartner
          required: true
          schema:
            type: string
      requestBody:
        description: SalesPartner data to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSalesPartnerRequestBody'
        required: true
      responses:
        '200':
          description: Successfully edited SalesPartner
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SalesPartnerWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /sales-partners/subscribable-event-types:
    get:
      tags:
        - Sales Partners
      summary: Get all possible webhooks types
      description: >-
        Can be used to get a full list of all subscribable event types. These
        event types (if subscribed to) will generate a PushMessage that is being
        sent out via the implemented webhook functionality to the set pushUrl of
        the SalesPartner
      operationId: get_sales_partners_subscribable_event_types
      responses:
        '200':
          description: Successfully retrieved all subscribable event types
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SubscribableEventTypesWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /sales-partners/{id}/photos:
    get:
      tags:
        - Sales Partners
      summary: Get all photos of a SalesPartner
      description: Can be used to get all photos of a SalesPartner
      operationId: get_sales_partners_id_photos
      parameters:
        - name: id
          in: path
          description: The SalesPartner ID
          required: true
          schema:
            type: string
        - name: photoTypes
          in: query
          description: Filter by photo types
          schema:
            type: string
            enum:
              - SMB_SETUP_WIZARD_STEP_1
              - SMB_SETUP_WIZARD_STEP_2
              - SMB_SETUP_WIZARD_STEP_3
        - name: offset
          in: query
          description: 'Offset (page number) for pagination. Default: 0'
          schema:
            type: integer
            format: int64
        - name: max
          in: query
          description: 'Maximum number of photos per page. Default: 20'
          schema:
            type: integer
            format: int64
        - name: sort
          in: query
          description: 'Which field to sort by. Default: ''id'''
          schema:
            type: string
        - name: order
          in: query
          description: 'Which direction to sort by. Default: ''desc'''
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            '*/*':
              schema:
                $ref: >-
                  #/components/schemas/SalesPartnerGenericPhotoListResponseWrapper
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
  /service-items:
    get:
      tags:
        - Service Items
      summary: Get All Service Items
      description: >-
        Get all service items the current API user can manage.

        <br>To specify services with identifier please provide ?identifier= in
        the URL param

        <br>By default, 50 are returned, you can use up to max=10000 in the URL
        param
      operationId: get_service_items
      responses:
        '200':
          description: Service Items successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ServiceItemSearchWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Service Items
      summary: Create a Service Item
      description: Create a menu item. It can be added to a content collection later
      operationId: post_service_items
      requestBody:
        description: A ServiceItem object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceItem'
        required: true
      responses:
        '201':
          description: Service Item successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceItemWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /service-items/{id}:
    get:
      tags:
        - Service Items
      summary: Get a Service Item
      description: Get a single service item
      operationId: get_service_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID for the service item
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Service Item successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ServiceItemWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Service Items
      summary: Delete a Service Item
      description: Delete a service item identified by identifier in the url param
      operationId: delete_service_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID for the service item
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Service Item successfully deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiSuccessResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Service Items
      summary: Update a Service Item
      description: >-
        Make changes to a service item.

        <br> Always use ?identifier= in url param to identify the service item
        uniquely. 

        <br>Any blank parameter deletes an old value, any unspecified parameter
        does nothing
      operationId: patch_service_items_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID for the service item you want to update
          required: true
          schema:
            type: string
      requestBody:
        description: A ServiceItem object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceItem'
        required: true
      responses:
        '200':
          description: Service Item successfully updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ServiceItemWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /social-posts/directories:
    get:
      tags:
        - Social Posting
      summary: Directories
      description: >-
        Get a list of directories where a posting is possible for the given
        combination of parameters.

        The response also contains warnings like missing directory connections.
      operationId: get_social_posts_directories
      parameters:
        - name: locationIds
          in: query
          description: Return directories where posting is possible for these locationIds
          schema:
            type: array
            items:
              type: string
        - name: businessIds
          in: query
          description: Return directories where posting is possible for these businessIds
          schema:
            type: array
            items:
              type: string
        - name: locationGroupIds
          in: query
          description: >-
            Return directories where posting is possible for these
            locationGroupIds
          schema:
            type: array
            items:
              type: string
        - name: labels
          in: query
          description: Return directories where posting is possible for these labels
          schema:
            type: array
            items:
              type: string
        - name: excludedLocationIds
          in: query
          description: List of excluded locationIds
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Directories retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostDirectoriesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /social-posts:
    get:
      tags:
        - Social Posting
      summary: Get several Social Posts
      description: Get several Social Posts.
      operationId: get_social_posts
      parameters:
        - name: offset
          in: query
          description: The offset of the first social post to return
          schema:
            type: integer
            format: int64
        - name: max
          in: query
          description: The maximum number of social posts to return
          schema:
            type: integer
            format: int64
        - name: locationIds
          in: query
          description: Return social posts for this locations
          schema:
            type: array
            items:
              type: string
        - name: socialPostStatuses
          in: query
          description: Return social posts with these statuses
          schema:
            type: array
            items:
              type: string
        - name: isStoreLocator
          in: query
          description: Is the post for store locator
          schema:
            type: boolean
      responses:
        '200':
          description: Social Posts retrieved.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostsResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Social Posting
      summary: Create a Social Post
      description: >-
        Create a new Social Post. 

        Requires either one businessId or one locationId or one label.

        When a combination of those fields is provided all matching locations
        are added together.
      operationId: post_social_posts
      requestBody:
        description: A SocialPost object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SocialPost'
        required: true
      responses:
        '200':
          description: Social Posts created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SocialPostWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /social-posts/{id}:
    get:
      tags:
        - Social Posting
      summary: Get a Social Post
      description: Get a Social Plan identified by its unique uberall ID.
      operationId: get_social_posts_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the Social Post you want to get
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Social Post retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Social Posting
      summary: Delete a Social Post
      description: Delete an existing Social Post identified by its unique uberall ID.
      operationId: delete_social_posts_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the Social Post that should be deleted
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Social Post deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Social Posting
      summary: Update a Social Post
      description: Edit an existing Social Post identified by its unique uberall ID.
      operationId: patch_social_posts_id
      parameters:
        - name: id
          in: path
          description: The uberall unique ID of the Social Post yu want to edit
          required: true
          schema:
            type: string
      requestBody:
        description: A SocialPost object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SocialPost'
        required: true
      responses:
        '200':
          description: Social Post updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /social-posts/directory-pages:
    get:
      tags:
        - Social Posting
      summary: Get a list of Directory Pages
      description: Get several Directory Pages.
      operationId: get_social_posts_directory_pages
      parameters:
        - name: types
          in: query
          description: The directory types we want pages for.
          schema:
            type: string
        - name: levels
          in: query
          description: >-
            String that represents the level of a directory page. The 2 possible
            values are "LISTING" and "BUSINESS"
          schema:
            type: string
        - name: locationIds
          in: query
          description: Return directory pages where input locationIds have access to
          schema:
            type: array
            items:
              type: string
        - name: page
          in: query
          description: Used for pagination. Page number we're interested in
          schema:
            type: integer
            format: int64
        - name: size
          in: query
          description: >-
            Used for pagination. It indicates the amount of result to be
            returned in a single page
          schema:
            type: integer
            format: int64
        - name: query
          in: query
          description: Filter by page name
          schema:
            type: string
      responses:
        '200':
          description: Directory Pages retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListDirectoryPagesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /social-posts/validate-apple-cta:
    post:
      tags:
        - Social Posting
      summary: Validate the Apple CTA
      description: Check if the CTA is valid for an Apple post
      operationId: post_social_posts_validate_apple_cta
      parameters:
        - name: cta
          in: query
          description: The call to action
          required: true
          schema:
            type: string
        - name: locationIds
          in: query
          description: The location IDs
          required: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: All locations support the CTA
        '205':
          description: No locations support the CTA
        '206':
          description: Some locations do not support the CTA
          content:
            application/json:
              schema:
                type: array
                items:
                  type: integer
                  format: int64
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /social-posts/templates:
    get:
      tags:
        - Social Posting Templates
      summary: Get a Social Post Template
      description: Get several Social Post Templates.
      operationId: get_social_posts_templates
      parameters:
        - name: userId
          in: query
          description: Shows the templates of the user with this id
          schema:
            type: string
        - name: max
          in: query
          description: Used for pagination. Maximum number of results per page.
          schema:
            type: integer
            format: int64
            default: 10
        - name: offset
          in: query
          description: Offset used for pagination.
          schema:
            type: integer
            format: int64
            default: 0
      responses:
        '200':
          description: Social Post Templates retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostTemplatesResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Social Posting Templates
      summary: Create a Social Post Template
      description: Create a new Social Post Template.
      operationId: post_social_posts_templates
      requestBody:
        description: The Social Post Template to create
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/SocialPostTemplate'
        required: true
      responses:
        '200':
          description: Social Post Template created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostTemplateResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /social-posts/templates/{id}:
    get:
      tags:
        - Social Posting Templates
      summary: Get all or several Social Post Templates
      description: Get a Social Plan Template identified by its unique uberall ID.
      operationId: get_social_posts_templates_id
      parameters:
        - name: id
          in: path
          description: Id of the Social Post Template
          required: true
          schema:
            type: string
        - name: userId
          in: query
          description: Id of the user requesting the social post template
          schema:
            type: string
      responses:
        '200':
          description: Social Post Template retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostTemplateResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Social Posting Templates
      summary: Delete a Social Post Template
      description: >-
        Delete an existing Social Post Template identified by its unique uberall
        ID.
      operationId: delete_social_posts_templates_id
      parameters:
        - name: id
          in: path
          description: Id of the Social Post Template that should be deleted
          required: true
          schema:
            type: string
        - name: userId
          in: query
          description: Id of the user requesting to delete the social post template
          schema:
            type: string
      responses:
        '200':
          description: Social Post Template deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Social Posting Templates
      summary: Update a Social Post Template
      description: >-
        Edit an existing Social Post Template identified by its unique uberall
        ID.
      operationId: patch_social_posts_templates_id
      parameters:
        - name: id
          in: path
          description: The unique uberall ID of the Social Post Template you want to edit
          required: true
          schema:
            type: string
      requestBody:
        description: A SocialPostTemplate object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/SocialPostTemplate'
        required: true
      responses:
        '200':
          description: Social Post Template updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostTemplateResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /social-templates:
    post:
      tags:
        - Digital Asset Management
      summary: Create a new social template as a digital asset
      description: >-
        Create a new social template as a part of the Digital Asset Management
        (DAM) framework.
      operationId: post_social_templates
      requestBody:
        description: A SocialPostTemplate object that should be created
        content:
          '*/*':
            schema:
              type: object
              properties:
                title:
                  type: string
                description:
                  type: string
                photos:
                  type: array
                  items:
                    $ref: '#/components/schemas/PhotoContainer'
                videos:
                  type: array
                  items:
                    type: string
                directories:
                  type: array
                  items:
                    type: string
                url:
                  type: string
                isStoreLocator:
                  type: boolean
                callToActions:
                  type: array
                  items:
                    $ref: '#/components/schemas/SocialPostTemplateCallToAction'
                asset:
                  $ref: '#/components/schemas/AssetInfo'
        required: true
      responses:
        '200':
          description: Social Template created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostTemplateResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
  /social-templates/{id}:
    patch:
      tags:
        - Digital Asset Management
      summary: Edit an existing social template
      description: Edit an existing social template identified by its unique uberall ID
      operationId: patch_social_templates_id
      parameters:
        - name: id
          in: path
          description: The unique uberall ID for the Social Post Template you want to edit
          required: true
          schema:
            type: string
      requestBody:
        description: A SocialPostTemplate object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/SocialPostTemplate'
        required: true
      responses:
        '200':
          description: Social Template updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SocialPostTemplateResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
  /search:
    get:
      tags:
        - Status Check
      summary: Returns a list of the last searches
      description: Returns a list of the last searches
      operationId: get_search
      parameters:
        - name: max
          in: query
          description: 'Used for pagination. Maximum number of results per page. Default: 50'
          schema:
            type: integer
            format: int64
          example: 50
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
          example: 0
      responses:
        '200':
          description: Successfully retrieved status reports
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SearchDataListWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - publicKey: []
    post:
      tags:
        - Status Check
      summary: Initiate a Search
      description: >-
        Initiate an online presence check starting with the name and address of
        the location
      operationId: post_search
      parameters:
        - name: name
          in: query
          description: The name of the location
          required: true
          schema:
            type: string
        - name: street
          in: query
          description: The street address of the location
          required: true
          schema:
            type: string
        - name: streetNo
          in: query
          description: |
            unless already in address field. The location's street number
          schema:
            type: integer
            format: int64
        - name: zip
          in: query
          description: Zip code
          schema:
            type: integer
            format: int64
        - name: country
          in: query
          description: >-
            The country of the location Country. One of AT, CH, DE, ES, UK, FR,
            IT, NL
          required: true
          schema:
            type: string
        - name: city
          in: query
          description: The city of the location
          schema:
            type: string
        - name: province
          in: query
          description: The province of the location
          schema:
            type: string
        - name: lat
          in: query
          description: The latitude of the location
          schema:
            type: string
        - name: lng
          in: query
          description: The longitude of the location
          schema:
            type: string
        - name: phone
          in: query
          description: The phone number of the location
          schema:
            type: string
      responses:
        '200':
          description: Successfully created search object
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SearchDataWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - publicKey: []
  /search/{id}:
    get:
      tags:
        - Status Check
      summary: Search in a Directory
      description: >-
        Search for a location identified by a uberall unique id in a specific
        directory
      operationId: get_search_id
      parameters:
        - name: id
          in: path
          description: The unique id of the SearchData returned by /api/search/
          required: true
          schema:
            type: string
        - name: directory
          in: query
          description: The directory you want to search in
          schema:
            type: string
        - name: token
          in: query
          description: The token you got using /api/search
          schema:
            type: string
      responses:
        '200':
          description: Successfully searched directory
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BasicListingResultWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - publicKey: []
  /store-finders/{storeKey}/locations/all:
    get:
      tags:
        - Store Finder
      summary: Get all locations
      description: Get all locations in your store finder
      operationId: get_store_finders_storeKey_locations_all
      parameters:
        - name: storeKey
          in: path
          description: Your store finder key
          required: true
          schema:
            type: string
        - name: country
          in: query
          description: Optional parameter to filter locations from a specific country
          schema:
            type: array
            items:
              type: string
        - name: fieldMask
          in: query
          description: The list of fields the response object should contain
          schema:
            type: array
            items:
              type: string
          example: fieldMask=name&fieldMask=id
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreFinderResponseListWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                fieldMask invalid:
                  description: fieldMask invalid
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid fieldMask provided.
                storeKey invalid:
                  description: storeKey invalid
                  value:
                    status: INVALID_PARAMETER
                    message: >-
                      Invalid storeKey provided. The provided StoreFinder have
                      no businesses attached.
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /store-finders/{storeKey}/locations/{id}**:
    get:
      tags:
        - Store Finder
      summary: Get location details
      description: Get details for a specific location within the store finder
      operationId: get_store_finders_storeKey_locations_id**
      parameters:
        - name: storeKey
          in: path
          description: Your store finder key
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: The location id, identifier or a custom slug
          required: true
          schema:
            type: string
        - name: language
          in: query
          description: >-
            The language the location data should be returned in (only
            applicable if location translation feature is enabled)
          schema:
            type: string
          example: en
        - name: country
          in: query
          description: Countries to filter for
          schema:
            type: array
            items:
              type: string
        - name: customFields
          in: query
          description: Should customFields be included in the response
          schema:
            type: boolean
        - name: identifier
          in: query
          description: When true id is the location identifier otherwise its id
          schema:
            type: boolean
        - name: reviewRatings
          in: query
          description: Review ratings to include in the detailed response
          schema:
            type: array
            items:
              type: string
              enum:
                - '1'
                - '2'
                - '3'
                - '4'
                - '5'
        - name: slug
          in: query
          description: >-
            If a slug was provided as ID which customField should we match it
            for
          schema:
            type: string
        - name: fieldMask
          in: query
          description: >-
            The list of fields the response object should contain, in the
            following format: "fieldMask=name&fieldMask=id"
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreFinderResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                fieldMask invalid:
                  description: fieldMask invalid
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid fieldMask provided.
                reviewRatings invalid:
                  description: reviewRatings invalid
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid reviewRatings provided.
                slug invalid:
                  description: slug invalid
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid slug provided.
                storeKey invalid:
                  description: storeKey invalid
                  value:
                    status: INVALID_PARAMETER
                    message: >-
                      Invalid storeKey provided. The provided StoreFinder have
                      no businesses attached.
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /store-finders/{storeKey}/filters:
    get:
      tags:
        - Store Finder
      summary: Get all possible filter values
      description: >-
        Will return all possible filter values for the given store finder. If
        locations are eligible for translations and a language is provided it
        will translate the values.
      operationId: get_store_finders_storeKey_filters
      parameters:
        - name: storeKey
          in: path
          description: Your store finder key
          required: true
          schema:
            type: string
        - name: language
          in: query
          description: The language to show the filter values in
          schema:
            type: string
          example: en
        - name: country
          in: query
          description: Optional parameter to filter locations from a specific country
          schema:
            type: array
            items:
              type: string
          example: FR
        - name: filters
          in: query
          description: The names of the filters for which the values should be returned
          schema:
            type: array
            items:
              type: string
          example: services
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreFinderFiltersWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                storeKey invalid:
                  description: storeKey invalid
                  value:
                    status: INVALID_PARAMETER
                    message: >-
                      Invalid storeKey provided. The provided StoreFinder have
                      no businesses attached.
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /store-finders/{storeKey}/locations:
    get:
      tags:
        - Store Finder
      summary: Search among the locations
      description: Search among the locations of the store finder
      operationId: get_store_finders_storeKey_locations
      parameters:
        - name: storeKey
          in: path
          description: Your store finder key
          required: true
          schema:
            type: string
        - name: '{filter}'
          in: query
          description: Only return those locations that match the given filter
          schema:
            type: array
            items:
              type: string
              format: string
          example: services=pickup&services=wifi&my-cool-filter=custom-value
        - name: cities
          in: query
          description: List of cites to search for
          schema:
            type: array
            items:
              type: string
        - name: language
          in: query
          description: >-
            The language the location data should be returned in (only
            applicable if location translation feature is enabled)
          schema:
            type: string
          example: en
        - name: fieldMask
          in: query
          description: >-
            The list of fields the response object should contain, in the
            following format: "fieldMask=name&fieldMask=id"
          schema:
            type: array
            items:
              type: string
        - name: geo
          in: query
          description: If geo search should be used.
          schema:
            type: boolean
        - name: lat
          in: query
          description: Latitude. For local search.
          schema:
            type: string
        - name: lng
          in: query
          description: Longitude. For local search.
          schema:
            type: string
        - name: coordinates
          in: query
          description: >-
            List of 4 coordinate points to search within (instead of lat/lng +
            radius).
          schema:
            maxItems: 4
            minItems: 4
            type: array
            items:
              type: string
              example: '52.42078412'
        - name: countries
          in: query
          description: List of countries to search for
          schema:
            type: array
            items:
              type: string
        - name: locationIds
          in: query
          description: Location ids to search within.
          schema:
            type: array
            items:
              type: string
        - name: max
          in: query
          description: Used for pagination. Maximum number of results per page
          schema:
            type: integer
            format: int64
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
        - name: openNow
          in: query
          description: Return locations that are open now.
          schema:
            type: boolean
        - name: provinces
          in: query
          description: List of provinces to search for
          schema:
            type: array
            items:
              type: string
        - name: query
          in: query
          description: Search term that needs to be matched.
          schema:
            type: array
            items:
              type: string
        - name: queryFields
          in: query
          description: List of fields the term in 'query' is matched against.
          schema:
            type: array
            items:
              type: string
        - name: radius
          in: query
          description: Radius (in meters). For local search.
          schema:
            type: string
        - name: zips
          in: query
          description: List of postcodes to search for
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreFinderLocationSearchResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                coordinates invalid:
                  description: coordinates invalid
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid coordinates provided.
                fieldMask averageRating invalid:
                  description: fieldMask averageRating invalid
                  value:
                    status: INVALID_PARAMETER
                    message: >-
                      Invalid fieldMask provided. AverageRating is only
                      supported for <= <number> Locations in the response
                fieldMask evData invalid:
                  description: fieldMask evData invalid
                  value:
                    status: INVALID_PARAMETER
                    message: >-
                      EvData is only supported for <= <number> Locations in the
                      response
                fieldMask invalid:
                  description: fieldMask invalid
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid fieldMask provided.
                lat invalid:
                  description: lat invalid
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid lat provided.
                lng invalid:
                  description: lng invalid
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid lon provided.
                locationIds invalid:
                  description: locationIds invalid
                  value:
                    status: INVALID_PARAMETER
                    message: >-
                      Invalid locationIds provided. Each provided id must be a
                      number
                storeKey invalid:
                  description: storeKey invalid
                  value:
                    status: INVALID_PARAMETER
                    message: >-
                      Invalid storeKey provided. The provided StoreFinder have
                      no businesses attached.
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /locations/{id}/suggestions:
    get:
      tags:
        - Suggestions
      summary: Get suggestions
      description: Get location suggestions given a search data
      operationId: get_locations_id_suggestions
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the location
          required: true
          schema:
            type: string
        - name: language
          in: query
          description: Filter suggestion attributes by language
          schema:
            type: string
        - name: directoryTypes
          in: query
          description: Filter suggestions by directories
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved suggestions
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuggestionResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    put:
      tags:
        - Suggestions
      summary: Update suggestions
      description: >-
        Update the given suggestion object, used to track the status of incoming
        suggestions. Note that rejecting a suggestion does not delete it, and
        accepting the suggestion won't automatically apply it to the location.
      operationId: put_locations_id_suggestions
      parameters:
        - name: id
          in: path
          description: The uberall unique id for the location
          required: true
          schema:
            type: string
      requestBody:
        description: >-
          List of Maps with both an id and a status key: [[id: 123, status:
          ACCEPTED], ...]
        content:
          '*/*':
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Suggestion'
        required: true
      responses:
        '200':
          description: Successfully updated suggestions
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuggestionListWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /locations/suggestions:
    get:
      tags:
        - Suggestions
      summary: Get Location Suggestions
      description: Get a list of suggestions for all locations managed by the logged user
      operationId: get_locations_suggestions
      parameters:
        - name: query
          in: query
          description: Filter by name, zip, street, city, label
          schema:
            type: string
          example: Berlin
        - name: sort
          in: query
          description: >-
            The location property to sort by (ascending unless order is
            specified)
          schema:
            type: string
        - name: order
          in: query
          description: use asc for ascending sort or desc for descending sort
          schema:
            type: string
        - name: max
          in: query
          description: Used for pagination. Maximum number of results per page.
          schema:
            type: integer
            format: int64
        - name: identifier
          in: query
          description: >-
            The location identifier, based on your internal identification
            system, you want the suggestions for.
          schema:
            type: string
        - name: offset
          in: query
          description: 'Offset used for pagination. Default: 0'
          schema:
            type: integer
            format: int64
        - name: businessId
          in: query
          description: The ids of the businesses you want suggestions for
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: locationIds
          in: query
          description: The ids of the locations you want suggestions for.
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Successfully retrieved suggestions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestionSearchResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
  /users:
    get:
      tags:
        - Users
      summary: Get All Users
      description: Get all users managed by the current API key
      operationId: get_users
      parameters:
        - name: query
          in: query
          description: Filter by first name, last name or email, e.g. 'tom@gmail.com'
          schema:
            type: string
          example: tom@gmail.com
        - name: max
          in: query
          description: Maximum number of users to display.
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          description: Offset for pagination.
          schema:
            type: integer
            format: int32
        - name: sort
          in: query
          description: Sorting criteria for result list.
          schema:
            type: string
        - name: order
          in: query
          description: Sort the order of the result list asc or desc
          schema:
            type: string
        - name: locationId
          in: query
          description: Id of a location the users must have administration rights to.
          schema:
            type: integer
            format: int64
        - name: identifier
          in: query
          description: Only return users with this identifier.
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved list
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserSearchWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Users
      summary: Create a User
      description: Create a new user, subject to throttling of 10 creations per 10 seconds.
      operationId: post_users
      requestBody:
        description: User data to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: Successfully created user
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserLeftWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /users/{id}:
    get:
      tags:
        - Users
      summary: Get a User
      description: Get a user identified by its uberall unique id
      operationId: get_users_id
      parameters:
        - name: id
          in: path
          description: User ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved user
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Users
      summary: Delete a User
      description: Delete a user identified by its uberall unique id
      operationId: delete_users_id
      parameters:
        - name: id
          in: path
          description: User ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted user
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Users
      summary: Update a User
      description: Edit an existing user
      operationId: patch_users_id
      parameters:
        - name: id
          in: path
          description: User ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully edited user
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /users/logout:
    post:
      tags:
        - Users
      summary: Log out the current user
      description: >-
        Logs out the current user and invalidates the access_token associated
        with this session
      operationId: post_users_logout
      responses:
        '200':
          description: Successfully logged out
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LogoutResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /users/{id}/all-sessions:
    delete:
      tags:
        - Users
      summary: Invalidate all active user sessions
      description: Invalidates all active sessions associated with the user
      operationId: delete_users_id_all_sessions
      parameters:
        - name: id
          in: path
          description: User ID
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Successfully logged out all sessions for user
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LogoutResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
  /sales-partners/webhooks:
    get:
      tags:
        - Webhooks
      summary: Get all webhooks that are currently set
      description: Returns a list of all active webhooks
      operationId: get_sales_partners_webhooks
      responses:
        '200':
          description: Successfully retrieved webhooks
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebhookListWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    post:
      tags:
        - Webhooks
      summary: Create a Webhook
      description: >-
        Creates a new webhook, consisting of a pushUrl and a event type. For a
        list of all possible types use the GET
        /api/sales-partners/subscribable-event-types.
      operationId: post_sales_partners_webhooks
      requestBody:
        description: Webhook data to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCommand'
        required: true
      responses:
        '200':
          description: Successfully created webhook
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebhookWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
  /sales-partners/webhooks/{id}:
    get:
      tags:
        - Webhooks
      summary: Get a Webhook
      description: Returns the webhook with the given id
      operationId: get_sales_partners_webhooks_id
      parameters:
        - name: id
          in: path
          description: Webhook ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved webhook
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebhookWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    delete:
      tags:
        - Webhooks
      summary: Delete a Webhook
      description: Deletes the webhook with the given id
      operationId: delete_sales_partners_webhooks_id
      parameters:
        - name: id
          in: path
          description: Webhook ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted webhook
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessResponseWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
      security:
        - accessToken: []
        - privateKey: []
    patch:
      tags:
        - Webhooks
      summary: Update a Webhook
      description: Edits the webhook with the given id
      operationId: patch_sales_partners_webhooks_id
      parameters:
        - name: id
          in: path
          description: Webhook ID
          required: true
          schema:
            type: string
      requestBody:
        description: Updated webhook data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCommand'
        required: true
      responses:
        '200':
          description: Successfully edited webhook
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebhookWrapper'
        '400':
          description: Bad Request - The request was invalid or cannot be otherwise served
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missing_parameter:
                  summary: Missing required parameter
                  value:
                    status: MISSING_PARAMETER
                    message: Required parameter is missing
                    response:
                      text: MISSING_PARAMETER
                invalid_parameter:
                  summary: Invalid parameter
                  value:
                    status: INVALID_PARAMETER
                    message: Invalid parameter value provided
                    response:
                      text: INVALID_PARAMETER
                wrong_type:
                  summary: Wrong parameter type
                  value:
                    status: WRONG_PARAMETER_TYPE
                    message: 'Parameter is of the wrong type. Expected: String'
                    response:
                      text: WRONG_PARAMETER_TYPE
                error:
                  summary: General error
                  value:
                    status: ERROR
                    message: Invalid request
                    response:
                      text: ERROR
                bad_request:
                  summary: Bad request
                  value:
                    status: BAD_REQUEST
                    message: The request is invalid or malformed
                    response:
                      text: BAD_REQUEST
                user_error:
                  summary: User error
                  value:
                    status: USER_ERROR
                    message: Error caused by incorrect user input
                    response:
                      text: USER_ERROR
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    status: NOT_AUTHORIZED
                    message: Authentication credentials are missing or invalid
                    response:
                      text: NOT_AUTHORIZED
                bad_token:
                  summary: Bad token
                  value:
                    status: BAD_ACCESS_TOKEN
                    message: Invalid authentication token
                    response:
                      text: BAD_ACCESS_TOKEN
                bad_private_key:
                  summary: Bad private key
                  value:
                    status: BAD_PRIVATE_KEY
                    message: Invalid private key provided
                    response:
                      text: BAD_PRIVATE_KEY
                bad_public_key:
                  summary: Bad public key
                  value:
                    status: BAD_PUBLIC_KEY
                    message: Invalid public key provided
                    response:
                      text: BAD_PUBLIC_KEY
        '403':
          description: >-
            Forbidden - The request is understood, but has been refused or
            access is not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    status: FORBIDDEN
                    message: You do not have permission to access this resource
                    response:
                      text: FORBIDDEN
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    status: QUOTA_LIMIT_EXCEED
                    message: Rate limit has been exceeded. Try again later
                    response:
                      text: QUOTA_LIMIT_EXCEED
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                not_found:
                  summary: Not found
                  value:
                    status: NOT_FOUND
                    message: The requested resource could not be found
                    response:
                      text: NOT_FOUND
        '409':
          description: Conflict - The request conflicts with current state of the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                conflict:
                  summary: Conflict
                  value:
                    status: CONFLICT
                    message: The request conflicts with current state of the server
                    response:
                      text: CONFLICT
      security:
        - accessToken: []
        - privateKey: []
components:
  schemas:
    AcceptedExtraFieldsResponseObject:
      type: object
      properties:
        allergens:
          type: array
          description: List of accepted allergens
          items:
            type: string
            description: List of accepted allergens
        dietaryRestrictions:
          type: array
          description: List of accepted dietary restrictions
          items:
            type: string
            description: List of accepted dietary restrictions
      description: The actual response object of the response
    AcceptedExtraFieldsResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/AcceptedExtraFieldsResponseObject'
    AccountConnectionDetails:
      type: object
      properties:
        id:
          type: integer
          description: ID of the account
          format: int64
          example: 123
        name:
          type: string
          description: Name of the account
          example: Sample Account
        type:
          type: string
          description: Type of the directory
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        totalLocationsCount:
          type: integer
          description: Total number of locations associated with this account
          format: int32
          example: 42
        url:
          type: string
          description: URL for the account
          example: https://example.com
    ApiErrorResponse:
      required:
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        errorCode:
          type: string
          enum:
            - NORMALIZATION_FAILED
            - DATA_CORRUPTED
            - INVALID_INPUT
            - NOT_SYNCABLE
            - PAYMENT_FAILED
            - FREE_TIER_REACHED
            - LIMIT_REACHED
            - INACTIVE
            - UNKNOWN
            - IDENTIFIER_NOT_UNIQUE
            - ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT
            - NO_ACCOUNT_CONNECTED
            - NO_PAGE_SELECTED
            - PAGE_NOT_CREATED
            - PAGE_IN_REVIEW
            - PAGE_CLAIMED_BY_OTHERS
            - OVERLAPPING_SOCIALPOST
            - TOO_MANY_REPLIES
            - REPLY_TOO_LONG
            - DEPRECATED
        response:
          type: object
          description: (optional) The actual response object of the response
      description: Uberall API Error Response
    ApiSuccessResponse:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          type: object
          description: The actual response object of the response
      description: Uberall API Success Response
    AssetInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of the DAM Asset
        description:
          type: string
          description: Description of the DAM Asset
        type:
          type: string
          description: Type of the DAM Asset that should be SOCIAL_POST_TEMPLATE
        status:
          type: string
          description: Status of the DAM Asset that can be VISIBLE or HIDDEN
        startDate:
          type: string
          description: Start date of the DAM Asset
        endDate:
          type: string
          description: End date of the DAM Asset
        allManagedResources:
          type: boolean
          description: >-
            Set to true if the Asset should be visible to all managed locations
            of the user
        locationIds:
          type: array
          description: Location IDs of the DAM Asset
          items:
            type: integer
            description: Location IDs of the DAM Asset
            format: int64
        businessIds:
          type: array
          description: Business IDs of the DAM Asset
          items:
            type: integer
            description: Business IDs of the DAM Asset
            format: int64
        excludedLocationIds:
          type: array
          description: Excluded location IDs of the DAM Asset
          items:
            type: integer
            description: Excluded location IDs of the DAM Asset
            format: int64
        labels:
          type: array
          description: Labels of the DAM Asset
          items:
            type: string
            description: Labels of the DAM Asset
        locationGroupIds:
          type: array
          description: Location Group IDs of the DAM Asset
          items:
            type: integer
            description: Location Group IDs of the DAM Asset
            format: int64
        folderId:
          type: integer
          description: Folder ID where the DAM asset should be created
          format: int64
      description: DAM Asset Model
    AttributeRecommendationsObject:
      type: object
      properties:
        recommendedAttributeExternalIds:
          type: array
          items:
            type: string
      description: The actual response object of the response
    AttributeRecommendationsWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/AttributeRecommendationsObject'
    AttributeWrapper:
      type: object
      properties:
        externalId:
          type: string
          description: The google attribute id
        value:
          type: string
          description: |-
            The value of the attribute. The value depends on the valueType.<br>
            BOOL: "true" or "false"<br>
            Single URL:"http://uberall.com" <br>
            Multiple URLs: ["http://uberall.com", "https://menuari2.com"] <br>
            ENUM:"supportedValue1" or "supportedValue2"<br>
            REPEATED_ENUM:"supportedValue1,supportedValue2"
        displayName:
          type: string
          description: The attribute's name in the required language.
        groupDisplayName:
          type: string
          description: Attribute group name
        valueMetadata:
          type: array
          description: List of possible values.
          items:
            $ref: '#/components/schemas/ValueMetadataItem'
        valueType:
          type: string
          description: |-
            The attribute type.
            e.g. BOOL, URL, ENUM, REPEATED_ENUM
          example: BOOL, URL, ENUM, REPEATED_ENUM
          enum:
            - BOOL
            - URL
            - ENUM
            - REPEATED_ENUM
      description: Attribute Wrapper Model
    AttributesResponseObject:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/AttributeWrapper'
      description: The actual response object of the response
    AttributesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/AttributesResponseObject'
    Attribution:
      required:
        - name
        - url
      type: object
      properties:
        name:
          type: string
          description: Name of the attribution
        url:
          type: string
          description: URL the attribution should point to
        id:
          type: integer
          format: int64
        logo:
          allOf:
            - $ref: '#/components/schemas/LogoDetails'
      description: Attribution Model
    AvailablePhotoTypesResponseObject:
      type: object
      properties:
        availablePhotoTypes:
          type: array
          items:
            type: string
      description: The actual response object of the response
    AvailablePhotoTypesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/AvailablePhotoTypesResponseObject'
    BasicListing:
      type: object
      properties:
        name:
          type: string
          description: The location's name used for this listing
        nameStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        street:
          type: string
          description: The location's street address
        streetStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        streetNo:
          type: string
          description: The location's street number
        streetNoStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        streetType:
          type: string
          description: >-
            Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER,
            CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA,
            RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
          enum:
            - ALAMEDA
            - AVENIDA
            - CALLE
            - CAMINO
            - CARRER
            - CARRETERA
            - GLORIETA
            - KALEA
            - PASAJE
            - PASEO
            - PLACA
            - PLAZA
            - RAMBLA
            - RONDA
            - RUA
            - SECTOR
            - TRAVESERA
            - TRAVESIA
            - URBANIZACION
        streetTypeStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        streetAndNo:
          type: string
          description: A localized combination of street and streetNo
        streetAndNoStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        addressExtra:
          type: string
          description: 'An address extra: e.g. building, floor...'
          example: building, floor, ...
        addressExtraStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        zip:
          type: string
          description: Zip code
        zipStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        city:
          type: string
          description: City
        cityStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        addressDisplay:
          type: boolean
          description: >-
            If set to false the address will not be published on the
            directories, this is useful for businesses that don't have customers
            come to them ( e.g. a plumber )
          example: true
        addressDisplayStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          example: PRESENT
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        phone:
          type: string
          description: The location's contact phone number
        phoneStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        fax:
          type: string
          description: The location fax number
        faxStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        cellphone:
          type: string
          description: A contact mobile phone number
        cellphoneStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        website:
          type: string
          description: A valid url for the location's website (use UTMs to add tracking)
        websiteStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        email:
          type: string
          description: A contact email for the location
        emailStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        descriptionLong:
          type: string
          description: A long description (up to 1000 characters) for the location
          example: A long description (up to 1000 characters) for the location
        descriptionLongStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        descriptionShort:
          type: string
          description: A short description (up to 200 characters) for the location
        descriptionShortStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        imprint:
          type: string
          description: The location's imprint
        imprintStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        openingHours:
          type: array
          description: >-
            The location's opening hours: e.g.

            <pre>[ &#123; 
                "dayOfWeek": 1,
                "closed": false,
                "from1": "08:00",
                "to1": "11:00"
              &#125;, 
              &#123;
                "dayOfWeek": 2,
                "closed": false,
                "from1": "08:00",
                "to1": "11:00",
                "from2": "13:00",
                "to2": "21:00"
              &#125;,
              &#123;
                "dayOfWeek": 3,
                "closed": true
              &#125;
            ]</pre>

            Please note that having more than 2 time periods for each day is not
            possible.
          example:
            - dayOfWeek: 1
              closed: false
              from1: '08:00'
              to1: '11:00'
            - dayOfWeek: 2
              closed: false
              from1: '08:00'
              to1: '11:00'
              from2: '13:00'
              to2: '21:00'
            - dayOfWeek: 3
              closed: true
          items:
            $ref: '#/components/schemas/OpeningHours'
        openingHoursStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        openingHoursNotes:
          type: string
          description: >-
            Additional info about opening hours: e.g. 'We never open on bank
            holidays' - max. 255 characters
          example: We never open on bank holidays
        openingHoursNotesStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        moreHours:
          type: array
          description: >-
            The location's additional service hours, such as delivery, pickup,
            happy hours etc. Submitted to Google.
          example: |-
            <pre>[&#123;
                "type": "ONLINE_SERVICE_HOURS",
                "hours": [&#123;
                    "dayOfWeek": 1,
                    "from1": "09:00",
                    "to1": "18:00"
                &#125;, &#123;
                    "dayOfWeek": 2,
                    "from1": "09:00",
                    "to1": "13:00"
                &#125;]
            &#125;, &#123;
                "type": "ACCESS",
                "hours": [&#123;
                    "dayOfWeek": 1,
                    "from1": "06:00",
                    "to1": "20:00"
                &#125;]
            &#125;]</pre>
          items:
            $ref: '#/components/schemas/MoreHours'
        moreHoursStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        specialOpeningHours:
          type: array
          description: >-
            The location's special opening hours: e.g.

            <pre>[ &#123; 
                "date": "2017-06-29",
                "closed": true
              &#125;, 
              &#123;
                "date": "2017-06-30",
                "from1": "11:00",
                "to1": "14:00",
                "from2": "16:00",
                "to2": "20:00"
              &#125;
            ]</pre>

            Please note that having more than 2 time periods for each day is not
            possible.
          example:
            - date: '2017-06-29'
              closed: true
            - date: '2017-06-30'
              from1: '11:00'
              to1: '14:00'
              from2: '16:00'
              to2: '20:00'
          items:
            $ref: '#/components/schemas/SpecialOpeningHours'
        specialOpeningHoursStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        keywordsStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        categoriesStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        attributesStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        photosStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        legalIdent:
          type: string
          description: A legal identifier of the location. SIRET number in France
        legalIdentStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        taxNumber:
          type: string
          description: The tax number of the location. CIF/NIF in Spain
        taxNumberStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        province:
          type: string
          description: Province. Only send when not blank
        provinceStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        country:
          type: string
          description: Country. One of AT, CH, DE, ES, UK, FR, IT, NL
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        countryStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        socialPost:
          description: >-
            A Social Post is a message for your customers that will be published
            on some of your listings. This can be a "News", a "Special Offer" or
            a "Question and Answer".
          allOf:
            - $ref: '#/components/schemas/SocialPost'
        socialPostStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        videosStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        contentListsStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        socialProfilesStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        paymentOptionsStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        brandsStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        servicesStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        transactionLinksStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        languagesStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        attribution:
          description: Attribution logo and url for data source
          allOf:
            - $ref: '#/components/schemas/Attribution'
        attributionStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        lat:
          type: number
          description: The latitude of the listing
          format: double
        latStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        lng:
          type: number
          description: The longitude of the listing
          format: double
        lngStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        serviceAreasStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        rating:
          type: number
          description: Average rating of the listing
          format: double
        ratingStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE or
            PRESENT
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        numberOfRatings:
          type: integer
          description: Number of ratings
          format: int32
        numberOfRatingsStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE or
            PRESENT
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        listingId:
          type: string
          description: The listing id in the directory's database
        listingUrl:
          type: string
          description: The listing url on the directory's website
        directoryType:
          type: string
          description: The directory where this listing appears
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        flowStatus:
          type: string
          description: >-
            The status of the current listing. One of  SUBMISSION_NEEDED,
            WAITING_USER_ACTION, WAITING_DIRECTORY_ACTION,
            ALL_INFORMATION_SUBMITTED, NO_ACTION_NEEDED, NOT_SUPPORTED,
            INACTIVE, NEEDS_REVIEW, MANUALLY_DEACTIVATED, REMOVAL_REVIEW_NEEDED,
            REMOVAL_NEEDED, REMOVAL_SUBMITTED, REMOVED, DONT_REMOVE
          enum:
            - SUBMISSION_NEEDED
            - WAITING_USER_ACTION
            - WAITING_DIRECTORY_ACTION
            - ALL_INFORMATION_SUBMITTED
            - NO_ACTION_NEEDED
            - NOT_SUPPORTED
            - INACTIVE
            - MANUALLY_DEACTIVATED
            - MANUALLY_CREATED
            - REMOVAL_REVIEW_NEEDED
            - REMOVAL_NEEDED
            - REMOVAL_SUBMITTED
            - REMOVED
            - DONT_REMOVE
            - CANNOT_REMOVE
            - CANCELLATION_NEEDED
            - CANCELLATION_SUBMITTED
        syncStatus:
          type: string
          description: >-
            The sync status of the listing. One of: IN_SYNC (location found on
            remote directory and in sync with reference data), NOT_IN_SYNC
            (location found on remote directory but differs from reference
            data), NOT_FOUND (location not found (yet) on remote directory),
            TECHNICAL_PROBLEMS (temporary problems when connecting with the
            directory),  NOT_SUPPORTED (if the location is incompatible with the
            directory or if we cannot search on that directory),
            NO_ONLINE_LISTING (for the types where there is no listing that can
            be checked online, e.g. GARMIN), LINK_ONLY (for the types where we
            can only link a listing by not update it)
          enum:
            - IN_SYNC
            - NOT_IN_SYNC
            - NOT_FOUND
            - TECHNICAL_PROBLEMS
            - NOT_SUPPORTED
            - NO_ONLINE_LISTING
            - LINK_ONLY
        claimStatus:
          type: string
          description: >-
            Claim status of the listing. One of CLAIMABLE, NOT_CLAIMABLE,
            CLAIMED_BY_US, CLAIMED_BY_OTHERS, CLAIMING_IN_PROGRESS, UNKNOWN
          enum:
            - CLAIMABLE
            - NOT_CLAIMABLE
            - CLAIMED_BY_US
            - CLAIMED_BY_OTHERS
            - CLAIMED_BY_ANOTHER_US
            - CLAIMING_IN_PROGRESS
            - UNKNOWN
        npi:
          type: string
          description: >-
            The National Provider Identifier (NPI) is a Health Insurance
            Portability and Accountability Act (HIPAA) Administrative
            Simplification Standard. The NPI is a unique identification number
            for covered health care providers.
          example: '1558444216'
        npiStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          example: MISSING
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        doctorCategoriesStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          example: MATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        nameDescriptor:
          type: string
          description: The location's name descriptor (submitted to Facebook).
        nameDescriptorStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        dateCreated:
          type: string
          description: The date and time the listing was created in our database
          format: date-time
        openingDate:
          type: string
          description: The original opening date of the business
          format: date
        openingDateStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        customFields:
          type: object
          additionalProperties:
            type: string
            description: Custom Fields for the directory
          description: Custom Fields for the directory
        customFieldsStatus:
          type: string
          description: The sync status of this specific field.
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        sublocality:
          type: string
          description: >-
            The sublocality field is only available for countries that require
            this for their postal address. The following countries have this
            for: Indonesia - Sub-district, Phillipines - Barangay, Thailand -
            Tambon / Khwaeng, Vietnam - Sublocality, Malaysia - Village, Nigeria
            - Local area, South Africa - Suburb.
        sublocalityStatus:
          type: string
          description: >-
            The sync status of this specific field. One of NOT_APPLICABLE,
            PRESENT, MISSING, MATCH, MISMATCH
          enum:
            - MATCH
            - MISMATCH
            - PRESENT
            - MISSING
            - NOT_APPLICABLE
        websiteExtra:
          type: string
          description: Utm or tracking path - only sent to GOOGLE
        categories:
          type: array
          description: Required - A list of category IDs describing the location
          items:
            type: integer
            format: int32
        keywords:
          type: array
          description: Keywords describing the location's activity
          items:
            type: string
        photos:
          type: boolean
          description: Boolean indicating whether or not the listing has photos
      description: Basic Listings Model
    BasicListingResultObject:
      type: object
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/BasicListing'
      description: The actual response object of the response
    BasicListingResultWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/BasicListingResultObject'
    BrandDataPoint:
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id of the data point
          format: int64
        actionDate:
          type: string
          description: >-
            The date when the review/photo/... was published in the online
            directory
          format: date-time
        author:
          type: string
          description: Username of the datapoints author
        authorImage:
          type: string
          description: Author profile picture url
        countComments:
          type: integer
          description: Number of comments to this item.
          format: int32
        directLink:
          type: string
          description: A link to the online profile
        directoryType:
          type: string
          description: Online directory reference name
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        flagged:
          type: boolean
          description: >-
            Whether the datapoint has been flagged. The exact nature of the
            flagging depends on the directory, but can be e.g. "Report as SPAM"
        lastUpdated:
          type: string
          description: Date of last update
          format: date-time
        rating:
          type: number
          description: 'Rating given by the user. Float value, max: 5.'
          format: float
        repliedByOwner:
          type: boolean
          description: True if the owner of the business has replied
        secondaryData:
          type: string
          description: >-
            Additional info about the datapoint (eg. text content on instagram
            pictures)
        threadActionDate:
          type: string
          description: >-
            The date of the last interaction in that thread. When a review
            receives a new comment, the parent will update.
          format: date-time
        type:
          type: string
          description: >-
            Datapoint Type. Values: [PHOTO, REVIEW, CHECKIN, CONVERSATION,
            QUESTION]
          enum:
            - REVIEW
            - PHOTO
            - CHECKIN
            - CONVERSATION
            - COMMENT
            - QUESTION
            - POST
            - IMAGE
            - VIDEO
            - CAROUSEL_ALBUM
            - LINK
            - EXPANDEDREVIEW
            - AD_POST
        liked:
          type: boolean
          description: Whether this datapoint has been liked or not
        data:
          type: string
          description: >-
            Content of the datapoint (text of the review, url of the photo,
            count of checkins...)
        dateCreated:
          type: string
          description: The date the datapoint was found
          format: date-time
      description: Brand Data Point Model
    BrandDataPointResponseObject:
      type: object
      properties:
        dataPoint:
          allOf:
            - $ref: '#/components/schemas/BrandDataPoint'
      description: The actual response object of the response
    BrandDataPointResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/BrandDataPointResponseObject'
    BrandPagesObject:
      type: object
      properties:
        id:
          type: string
          description: ID of the brand page
        name:
          type: string
          description: Name of the brand page
        link:
          type: string
          description: Link of the brand page
    BrandPagesResponseObject:
      type: object
      properties:
        brandPages:
          type: array
          items:
            $ref: '#/components/schemas/BrandPagesObject'
      description: The actual response object of the response
    BrandPagesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/BrandPagesResponseObject'
    Business:
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id for the business
          format: int64
        name:
          type: string
          description: The business's name
        type:
          type: string
          description: Business type. One of SMB or ENTERPRISE
          example: '[SMB, ENTERPRISE]'
          enum:
            - SMB
            - ENTERPRISE
        streetAndNo:
          type: string
          description: Address of the business
        addressLine2:
          type: string
          description: 'An address extra: e.g. building, floor...'
          example: building, floor...
        province:
          type: string
          description: Province. Only send when not blank
        zip:
          type: string
          description: Zipcode of the business
        city:
          type: string
          description: City of the business
        identifier:
          type: string
          description: The business identifier based on your internal identification system
        country:
          type: string
          description: Country of the business
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        phone:
          type: string
          description: Business's phone number
        productPlan:
          description: The chosen product plan
          allOf:
            - $ref: '#/components/schemas/ProductPlan'
        dateCreated:
          type: string
          description: The date and time the business was created in uberall database
          format: date-time
        status:
          type: string
          description: Business's status
          enum:
            - CREATED
            - NOT_CONFIRMED
            - ACTIVE
            - DELETED
        countryPrices:
          uniqueItems: true
          type: array
          description: List of country specific prices
          items:
            $ref: '#/components/schemas/PricePerCountry'
        customFields:
          type: string
          description: >-
            Custom fields allow for additional information to be added at the
            location level. All locations within the business will have the same
            list of custom fields.
        effectiveDate:
          type: string
          description: >-
            Date when the business automatically changes its product plan to the
            new product plan (defined by nextProductPlanId)
          format: date-time
        nextProductPlanId:
          type: integer
          description: >-
            ID of the next product plan applied for the business on the defined
            effectiveDate
          format: int64
        dateExpiration:
          type: string
          description: The date the business's contract expires
          format: date-time
        businessSyncable:
          type: boolean
          description: >-
            True if the business is allowed to start a sync. Only relevant for
            Businesses with more than 10 locations.
        numOfLocations:
          type: integer
          description: Number of active locations
          format: int32
      description: Business Model
    BusinessDirectoryAccountResponse:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the account
          format: int64
        accountId:
          type: string
          description: The external ID of the account
        name:
          type: string
          description: The name of the account as it appears on the directory
        usedInBusiness:
          type: integer
          description: Number of business connections that belong to this account
          format: int32
        canDisconnect:
          type: boolean
          description: Indicates if the account can be removed
      description: Response object for a business directory account
    BusinessDirectoryAccountResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/BusinessDirectoryAccountResponse'
    BusinessDirectoryPageResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the page
        accountId:
          type: integer
          description: The ID of the account that page belongs to
          format: int64
        name:
          type: string
          description: The external name of the page
        link:
          type: string
          description: The URL link to the page
        usedInBusiness:
          type: integer
          description: The number of businesses that belong to this page
          format: int32
        managedByAccount:
          type: boolean
          description: >-
            Indicates whether this page is managed by an account hence that has
            a business connection
      description: The response of an external entity of a business directory page
    BusinessDirectoryPageResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/BusinessDirectoryPageResponse'
    BusinessFiltersResponse:
      type: object
      properties:
        id:
          type: integer
          description: Business ID
          format: int64
        name:
          type: string
          description: Business Name
      description: Business
    BusinessPageResponse:
      type: object
      description: The actual response object of the response
    BusinessPageResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/BusinessPageResponse'
    BusinessResponseObject:
      type: object
      description: The actual response object of the response
    BusinessResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/BusinessResponseObject'
    BusinessStatistics:
      type: object
      properties:
        count:
          type: integer
          description: Total number of businesses
          format: int32
        countActive:
          type: integer
          description: Number of active businesses
          format: int32
        countWithoutLocations:
          type: integer
          description: Number of businesses without any locations
          format: int32
        countWithLocations:
          type: integer
          description: Number of businesses with at least one location
          format: int32
      description: Business Statistics Model
    BusinessStatisticsWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/BusinessStatistics'
    CallToAction:
      type: object
      properties:
        text:
          type: string
          description: The text of the call-to-action button
        url:
          type: string
          description: The URL of the call-to-action button
      description: Represents a Call-to-Action button with a label text and a URL
    CallTrackingNumber:
      type: object
      properties:
        number:
          type: string
          description: >-
            The call tracking number for the select directory -- must be
            different than the location's primary phone number.
        type:
          type: string
          description: Google, Facebook, or Bing
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
      description: Call Tracking Number
    Category:
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id for the category
          format: int64
        name:
          type: string
          description: The category description
        parent:
          description: The parent category
          allOf:
            - $ref: '#/components/schemas/Category'
        selectable:
          type: boolean
          description: Boolean indicating whether the category can be used
      description: Represents one of uberall's categories
    CheckConflictRequest:
      type: object
      properties:
        businesses:
          type: array
          description: >-
            List of business ids. Only check Auto Response Rules identified by
            the business ids listed in businesses
          items:
            type: integer
            format: int64
        locations:
          type: array
          description: >-
            List of location ids. nly check Auto Response Rules identified by
            the location ids listed in locations
          items:
            type: integer
            format: int64
        excludedLocations:
          type: array
          description: List of location ids that should be excluded from the check
          items:
            type: integer
            format: int64
        triggers:
          type: array
          description: >-
            Only check Auto Response Rules that also apply to these triggers,
            use ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR
          items:
            type: string
        ignoreRule:
          type: integer
          description: >-
            When editing an Auto Response Rule, send the id from the rule being
            edited in this field
          format: int64
      description: Check Conflict Request
    CitiesResponse:
      type: object
      properties:
        cities:
          type: array
          description: List of cities
          example:
            - City1
            - City2
          items:
            type: string
      description: Cities response model
    CitiesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/CitiesResponse'
    ConflictingRuleResponse:
      type: object
      properties:
        id:
          type: string
          description: id of conflicting Auto Response Rule
        name:
          type: string
          description: Name of conflicting Auto Response Rule
      description: Conflicting Rule Response Model
    ConflictingRulesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          uniqueItems: true
          type: array
          description: The actual response object of the response
          items:
            $ref: '#/components/schemas/ConflictingRuleResponse'
    Connect:
      type: object
      properties:
        connectionId:
          type: string
          description: Connection id that must be passed for directories like Twitter
        accountId:
          type: integer
          description: Directory account which will be used for establishing connection
          format: int64
    ConnectFlowUserDetails:
      type: object
      properties:
        name:
          type: string
          description: Connected account detail (Account name)
        email:
          type: string
          description: Connected account detail (email)
        dateConnected:
          type: string
          description: his should indicate the date that this user made the connection
          format: date-time
        defaultForSalesPartner:
          type: boolean
          description: >-
            This should indicate whether the connection in place has been
            produced by a salesPartner level connection
        defaultForBusiness:
          type: boolean
          description: >-
            This should indicate whether the connection in place has been
            produced by a business level connection
      description: Connect Flow User Details model
    ConnectedLocationsDetails:
      type: object
      properties:
        type:
          type: string
          description: The directory type
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        count:
          type: integer
          description: The number of accounts
          format: int32
    ContentCollection:
      required:
        - contentLists
        - identifier
        - name
        - type
      type: object
      properties:
        identifier:
          type: string
          description: Mandatory - A unique identifier for the collection
        name:
          type: string
          description: Mandatory - Name of the content collection
        description:
          type: string
          description: A description of the collection
        type:
          type: string
          description: >-
            Mandatory - the type of content collection. Values can be: MENU,
            PEOPLE, PRODUCTS, SERVICES, or CUSTOM
          enum:
            - MENU
            - PEOPLE
            - PRODUCTS
            - CUSTOM
            - SERVICES
            - EVENTS
        contentLists:
          type: array
          description: Mandatory - Sections within the content collections
          items:
            $ref: '#/components/schemas/ContentList'
        locationIds:
          uniqueItems: true
          type: array
          description: Location Ids that should be associated with this collection
          items:
            type: integer
            format: int64
        cuisineType:
          type: string
          description: >-
            Only applicable to Menu content collections - indicates the cuisine
            the restaurant serves
          enum:
            - AMERICAN
            - ASIAN
            - BRAZILIAN
            - BREAKFAST
            - BRUNCH
            - CHICKEN
            - CHINESE
            - FAMILY
            - FAST_FOOD
            - FRENCH
            - GREEK
            - GERMAN
            - HAMBURGER
            - INDIAN
            - INDONESIAN
            - ITALIAN
            - JAPANESE
            - KOREAN
            - LATIN_AMERICAN
            - MEDITERRANEAN
            - MEXICAN
            - PAKISTANI
            - PIZZA
            - SEAFOOD
            - SPANISH
            - SUSHI
            - THAI
            - TURKISH
            - VEGETARIAN
            - VIETNAMESE
            - OTHER_CUISINE
        url:
          type: string
          description: Applicable to Menu collections only - url to the brand webpage menu
        id:
          type: integer
          format: int64
      description: Content Collection
    ContentList:
      type: object
      properties:
        title:
          type: string
          description: 'The name of the content list: e.g. ''Lunch Menu'''
          example: Lunch Menu
        type:
          type: string
          description: >-
            The type of content list. One of SERVICES, PRODUCTS, MENU, PEOPLE or
            CUSTOM. The type cannot be updated after creation.
          enum:
            - MENU
            - PEOPLE
            - PRODUCTS
            - CUSTOM
            - SERVICES
            - EVENTS
        dateCreated:
          type: string
          description: The date the content list was created
          format: date-time
        lastUpdated:
          type: string
          description: The date the content list was last updated
          format: date-time
        description:
          type: string
          description: A description of the content list (section)
        itemIds:
          type: array
          description: >-
            The list of item ids that should be included within this section of
            the Content Collection
          items:
            type: integer
            format: int64
        translations:
          type: object
          description: Language translations for the section title of a content collection
      description: Content List
    ContentListResponseObject:
      type: object
      properties:
        contentList:
          allOf:
            - $ref: '#/components/schemas/ContentList'
      description: The actual response object of the response
    ContentListResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ContentListResponseObject'
    ContentListsObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        total:
          type: integer
          description: Total count of results
          format: int32
          example: 100
        totalLocationsCount:
          type: integer
          description: Total count of locations
          format: int32
          example: 100
        contentLists:
          type: array
          items:
            $ref: '#/components/schemas/ContentList'
      description: The actual response object of the response
    ContentListsWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ContentListsObject'
    CountByDirectoryDetails:
      type: object
      properties:
        directoryType:
          type: string
          description: The directory type
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        count:
          type: integer
          description: The count
          format: int32
    CountByRatingDetails:
      type: object
      properties:
        rating:
          type: integer
          description: The rating
          format: int32
        count:
          type: integer
          description: The count of ratings
          format: int32
    CountriesResponse:
      type: object
      properties:
        countries:
          type: array
          description: List of countries
          example:
            - Country1
            - Country2
          items:
            type: string
      description: CountriesResponse Model
    CountriesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/CountriesResponse'
    CreateDirectoryBrandRequest:
      required:
        - category
        - country
        - name
        - url
      type: object
      properties:
        name:
          type: string
          description: Name for the directory brand
        country:
          type: string
          description: Country for the directory brand
        category:
          type: string
          description: Category for the directory brand
        url:
          type: string
          description: Website URL for the directory brand
        appLink:
          type: string
          description: AppLink for the directory brand
      description: Details for creating a directory brand
    CreatePDFValidatorCommand:
      type: object
    CreateSalesPartnerRequestBody:
      required:
        - address
        - name
        - parent
      type: object
      properties:
        address:
          type: string
          description: >-
            Full address string of the new child SalesPartner (Be aware: Can't
            be NULL or empty)
        aggregateInvoicesToParent:
          type: boolean
          description: >-
            Indicates if the invoice for this SalesPartner should be aggregated
            to the parent invoice
        attribution:
          allOf:
            - $ref: '#/components/schemas/Attribution'
        canSeePrices:
          type: boolean
          description: >-
            Indicates if the child SalesPartner should be allowed to see price
            information for e.g. product plans
        country:
          type: string
          description: Country of the new child SalesPartner
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        emailAccounting:
          type: string
          description: Accounting email of the new child SalesPartner
        emailCustomerSupport:
          type: string
          description: Customer support email of the new child SalesPartner
        emailProjectLead:
          type: string
          description: Project lead email of the new child SalesPartner
        identifier:
          type: string
          description: >-
            Identifier of the new child SalesPartner (e.g. your own customer ID
            for better reference)
        minPasswordLength:
          type: integer
          description: Minimum password length for all users of the new child SalesPartner
          format: int32
        name:
          type: string
          description: 'Name of child SalesPartner (Be aware: Can''t be NULL or empty)'
        parent:
          type: integer
          description: >-
            Parent ID of the associated parent SalesPartner. (Be aware: You need
            the Uberall SalesPartner ID of the parent)
          format: int64
        phone:
          type: string
          description: Phone number of the new child SalesPartner
        preferredLanguage:
          type: object
          description: >-
            Preferred language of the new child SalesPartner, for invoice
            purpose (either 'de' oder 'en')
        salesPartnerStatus:
          type: string
          description: Sales Partner Status Enum
          enum:
            - CREATED
            - APPROVED
            - DECLINED
            - DELETED
            - INACTIVE
        vatId:
          type: string
          description: >-
            VAT (Value-Added Tax) ID number of the SalesPartner (e.g. for
            Germany: DE123456789)
    CreateTemplateRequest:
      required:
        - message
        - tags
        - title
      type: object
      properties:
        title:
          type: string
          description: The title of the template
        message:
          type: string
          description: The message that will be used in the response
        tags:
          type: string
          description: Template tags used for filtering
        businesses:
          type: array
          items:
            type: string
            description: List of business ids that have access to the template
    CurrentPreviousValue:
      type: object
      properties:
        current:
          type: number
          description: The value for the current period
        previous:
          type: number
          description: The value for the previous period
      description: CurrentPreviousValue Model
    CustomFieldsDetails:
      type: object
      properties:
        name:
          type: string
          description: The name of the custom field
          example: foo
        value:
          type: string
          description: The value of the custom field
          example: bar
    CustomItem:
      required:
        - title
      type: object
      properties:
        title:
          type: string
          description: mandatory, the custom name, e.g. 'Strong Coffee'
        description:
          type: string
        identifier:
          type: string
        listName:
          type: string
        id:
          type: integer
          description: The uberall unique id for the custom item
          format: int64
        price:
          type: integer
          description: optional, the price of the custom, e.g. 1500 ( i.e. 15,00 EUR )
          format: int32
        currency:
          type: object
          description: >-
            optional, indicating the currency for price and priceMax in
            ISO-4217, e.g. EUR
        category:
          type: string
          description: optional, a category name, e.g. 'Coffee'
          example: Coffee
        video:
          description: optional, a video about the custom
          allOf:
            - $ref: '#/components/schemas/Video'
        unit:
          type: string
          description: optional, indicating the unit of measure, e.g. 'per kg'
          example: per kg
        url:
          type: string
          description: optional, a url related to the custom item
        priceMax:
          type: integer
          description: >-
            optional, indicating there is a price range, e.g. 2500 ( i.e. 25,00
            EUR )
          format: int32
        image:
          description: Image of the custom-item (use the Image object format)
          allOf:
            - $ref: '#/components/schemas/Image'
      description: Custom Item
    CustomItemResponseObject:
      type: object
      properties:
        customItem:
          allOf:
            - $ref: '#/components/schemas/CustomItem'
      description: The actual response object of the response
    CustomItemResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/CustomItemResponseObject'
    CustomItemSearchResponseObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        total:
          type: integer
          description: Total count of results
          format: int32
          example: 100
        customItems:
          type: array
          items:
            $ref: '#/components/schemas/CustomItem'
      description: The actual response object of the response
    CustomItemSearchResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/CustomItemSearchResponseObject'
    CustomerFeedback:
      type: object
      properties:
        countByRating:
          type: array
          description: Average count by rating
          items:
            $ref: '#/components/schemas/CountByRatingDetails'
        ratingCount:
          type: integer
          description: The total count of rating
          format: int32
        repliedCount:
          type: integer
          description: The count of replied reviews
          format: int32
        averageRating:
          type: number
          description: Average rating obtained
          format: float
        interactionCount:
          type: integer
          description: The number of review and photos
          format: int32
        unreadInteractionCount:
          type: integer
          description: The number of reviews and photos unread
          format: int32
        unreadInteractions:
          type: array
          description: The reviews and photos unread
          items:
            $ref: '#/components/schemas/DataPoint'
        matchedLocationsCount:
          type: integer
          description: The number of locations matching the given textFilter query
          format: int32
      description: CustomerFeedback Model
    CustomerFeedbackByPeriod:
      type: object
      properties:
        interactionCountByPeriod:
          type: array
          description: The number of reviews and photos unread by period
          items:
            $ref: '#/components/schemas/InteractionCountByPeriodDetails'
        averageRatingByPeriod:
          type: array
          description: >-
            The average ratings of the incoming reviews in the given time
            periods of the total time span.
          items:
            $ref: '#/components/schemas/TimeSeriesSegment'
        matchedLocationsCount:
          type: integer
          description: The number of locations matching the given textFilter query
          format: int32
        totalRatingCount:
          type: integer
          description: The total number of reviews with rating in the given time span.
          format: int32
      description: CustomerFeedbackByPeriod Model
    CustomerFeedbackByPeriodWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/CustomerFeedbackByPeriod'
    CustomerFeedbackKeyword:
      type: object
      properties:
        keyword:
          type: string
          description: The actual Keyword
        percentage:
          description: How many documents contained the keyword at least once
          allOf:
            - $ref: '#/components/schemas/CurrentPreviousValue'
        rating:
          description: >-
            The average rating of all Reviews that contained this keyword at
            least once
          allOf:
            - $ref: '#/components/schemas/CurrentPreviousValue'
        ratingSum:
          description: Sum of ratings of reviews in which a keyword is present
          allOf:
            - $ref: '#/components/schemas/CurrentPreviousValue'
        aggregatedWords:
          type: array
          description: >-
            Contains the list of similar words that have been aggregated to this
            CustomerFeedbackKeyword object
          items:
            type: string
      description: CustomerFeedbackKeyword Model
    CustomerFeedbackKeywords:
      type: object
      properties:
        keywords:
          type: array
          description: The list of keywords
          items:
            $ref: '#/components/schemas/CustomerFeedbackKeyword'
        totalFeedbacksAnalyzed:
          type: integer
          description: The total number of Feedbacks that have been analyzed.
          format: int32
      description: CustomerFeedbackKeyword Model
    CustomerFeedbackKeywordsWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/CustomerFeedbackKeywords'
    CustomerFeedbackWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/CustomerFeedback'
    DashboardExportData:
      type: object
      properties:
        start:
          type: string
          description: Start date of export
          format: date-time
        end:
          type: string
          description: End date of export
          format: date-time
        group:
          type: string
          description: A time grouping parameter among HOUR, DAY, WEEK, MONTH, YEAR
          enum:
            - HOUR
            - DAY
            - WEEK
            - MONTH
            - YEAR
        language:
          type: string
          description: Language of a generated PDF report (e.g. 'de', 'fr', 'en')
          example: en
        token:
          type: string
          description: Token of the export job
        status:
          type: string
          description: >-
            Current status of the export process (e.g. 'FINISHED', 'SCHEDULED',
            'FAILED')
          example: FINISHED, SCHEDULED, FAILED
          enum:
            - CREATED
            - SCHEDULED
            - FAILED
            - FINISHED
        locationIds:
          uniqueItems: true
          type: array
          description: A list of location IDs for which to generate a report
          items:
            type: string
        whitelabelIdentifier:
          type: string
          description: >-
            Whitelabel identifier which will be used in the outline of the PDF
            report
        salesPartnerCountry:
          type: string
          description: Country of the SalesPartner
      description: Dashboard Export Data
    DashboardExportDataListObject:
      type: object
      properties:
        offset:
          type: integer
          description: The offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: The maximum number of results to return
          format: int32
          example: 10
        count:
          type: integer
          description: The total count of export data
          format: int32
          example: 100
        exportDatas:
          type: array
          items:
            $ref: '#/components/schemas/DashboardExportData'
      description: The actual response object of the response
    DashboardExportDataListWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DashboardExportDataListObject'
    DashboardExportDataWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DashboardExportData'
    DashboardExportInsightsDataResponse:
      type: object
      properties:
        fileUrl:
          type: string
          description: The download link. Only available when status is FINISHED.
        status:
          type: string
          description: |-
            One out of: EMAIL, FINISHED, FAILED
            EMAIL means the export will be send to the users email.
            FINISHED means the export is available at the given fileUrl.
            FAILED means that something went wrong.
          enum:
            - EMAIL
            - FINISHED
            - FAILED
      description: Dashboard Export Insights Data Response Model
    DashboardExportInsightsDataResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DashboardExportInsightsDataResponse'
    DashboardLocation:
      type: object
      properties:
        businessName:
          type: string
          description: Name of the business
      description: Dashboard Location Model
    DataPoint:
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id of the data point
          format: int64
        comments:
          type: array
          description: >-
            The list of comments of a Datapoint. Populated in the get, reply,
            approve and reject datapoint calls.
          items:
            $ref: '#/components/schemas/DataPoint'
        actionDate:
          type: string
          description: >-
            The date when the review/photo/... was published in the online
            directory
          format: date-time
        author:
          type: string
          description: Username of the datapoint's author
        authorImage:
          type: string
          description: Author profile picture url
        countComments:
          type: integer
          description: Number of comments to this item.
          format: int32
        directLink:
          type: string
          description: A link to the online profile
        directoryType:
          type: string
          description: Online directory reference name
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        flagged:
          type: boolean
          description: >-
            Whether the datapoint has been flagged. The exact nature of the
            flagging depends on the directory, but can be e.g. "Report as SPAM"
        lastUpdated:
          type: string
          description: Date of last update.
          format: date-time
        rating:
          type: number
          description: 'Rating given by the user. Float value, max: 5.'
          format: float
        repliedByOwner:
          type: boolean
          description: True if the owner of the business has replied
        secondaryData:
          type: string
          description: >-
            Additional info about the datapoint (eg. text content on instagram
            pictures)
        threadActionDate:
          type: string
          description: >-
            The date of the last interaction in that thread. When a review
            receives a new comment, the parent will update.
          format: date-time
        countLikes:
          type: integer
          description: Number of likes to this item
          format: int32
        locationId:
          type: integer
          description: The Location ID associated with this datapoint
          format: int64
        type:
          type: string
          description: >-
            Datapoint Type. Values: [PHOTO, REVIEW, CHECKIN, CONVERSATION,
            QUESTION]
          enum:
            - REVIEW
            - PHOTO
            - CHECKIN
            - CONVERSATION
            - COMMENT
            - QUESTION
            - POST
            - IMAGE
            - VIDEO
            - CAROUSEL_ALBUM
            - LINK
            - EXPANDEDREVIEW
            - AD_POST
        liked:
          type: boolean
          description: Whether this datapoint has been liked or not
        data:
          type: string
          description: >-
            Content of the datapoint (text of the review, url of the photo,
            count of checkins...)
        dateCreated:
          type: string
          description: The date the datapoint was found
          format: date-time
      description: Data Point Model
    DataPointFilter:
      required:
        - name
      type: object
      properties:
        name:
          type: string
          description: The filter name
        shared:
          type: boolean
          description: Defines if the filter is shared or not
        directories:
          uniqueItems: true
          type: array
          description: The list of directories for which the dataPoints should be filtered
          items:
            type: string
            enum:
              - FOURSQUARE
              - UBER
              - GOOGLE
              - WAZE
              - GOOGLE_MAPS
              - YELP
              - YELP_API
              - MEINESTADT
              - YELLOW_MAP
              - FOCUS
              - LOKALEAUSKUNFT
              - WEB_DE
              - GMX
              - ONE_AND_ONE
              - FREIEAUSKUNFT
              - POINTOO
              - NOKIA_HERE
              - FACEBOOK
              - TOMTOM
              - STADTBRANCHENBUCH
              - CYLEX
              - UNTERNEHMENSAUSKUNFT
              - ACOMPIO
              - BUSINESSBRANCHENBUCH
              - YALWA
              - THE_PHONEBOOK
              - SCOOT
              - CENTRAL_INDEX
              - CITIPAGES
              - ONE_NINE_TWO
              - ONE_ONE_EIGHT
              - THE_DAILY_RECORD
              - THE_EVENING_STANDARD
              - THE_SCOTSMAN
              - LIVERPOOL_ECHO
              - THE_SUN
              - THE_INDEPENDENT
              - TOUCH_LOCAL
              - THE_MIRROR
              - ANNUAIRE
              - INFOBEL
              - US_INFO_COM
              - GARMIN
              - FACTUAL
              - BING
              - WO_GIBTS_WAS
              - KOOMIO
              - ABCLOCAL
              - YELLBO
              - JELLOO
              - GUIDELOCAL
              - OEFFNUNGSZEITENBUCH
              - APPLE_MAPS
              - LOOCAL
              - REGIONAL_DE
              - WHERE_TO
              - TUPALO
              - GELBE_SEITEN
              - DAS_OERTLICHE
              - DIALO
              - BUNDES_TELEFONBUCH
              - BRANCHENBUCH_DEUTSCHLAND
              - MARKTPLATZ_MITTELSTAND
              - BUSQUEDA_LOCAL
              - RICERCARE_IMPRESE
              - PAGES24
              - NAVMII
              - AUDI
              - BMW
              - MERCEDES
              - VW
              - TOYOTA
              - FORD
              - FIAT
              - GM
              - ETRUSTED
              - INSTAGRAM
              - SHOPPING_TIME_NETWORK
              - CITY_SQUARES
              - SHOWMELOCAL
              - LOCALSTACK
              - CHAMBER_OF_COMMERCE
              - JUDYS_BOOK
              - BROWNBOOK
              - MY_LOCAL_SERVICES
              - YA_SABE
              - UNIVISION
              - AL_DIA_TX
              - LA_VOZ_TX
              - CHRON
              - STATESMAN
              - PALM_BEACH_POST
              - MUNDO_HISPANICO
              - EL_TIEMPO_LATINO
              - LATINOS_US
              - HOTFROG
              - INFO_IS_INFO
              - MANTA
              - US_CITY
              - GO_YELLOW
              - N49
              - PRATIQUE
              - JUSTACOTE
              - EZLOCAL
              - ELOCAL
              - TRUE_LOCAL
              - START_LOCAL
              - WOMO
              - AUSSIE_WEB
              - YELLOW_PAGES
              - SUPER_PAGES
              - WHITE_PAGES
              - DEX_KNOWS
              - KAUFDA_MANUAL
              - I_GLOBAL
              - BRANCHEN_INFO_MANUAL
              - GUTE_BANKEN_MANUAL
              - D_11880_COM_MANUAL
              - BANKOEFFNUNGSZEITEN_DE_MANUAL
              - BANK_OEFFNUNGSZEITEN_DE_MANUAL
              - CYLEX_MANUAL
              - FINDE_OFFEN_MANUAL
              - MEIN_PROSPEKT_MANUAL
              - DAS_SCHNELLE
              - SENSIS_WHITE_PAGES
              - SENSIS_TRUE_LOCAL
              - SENSIS_YELLOW_PAGES
              - FIND_OPEN
              - WAND
              - BELL_CA
              - GO_LOCAL
              - MEINUNGSMEISTER
              - YANDEX
              - YAHOO_MANUAL
              - HOLIDAY_CHECK
              - TRIP_ADVISOR
              - BONIAL_FR
              - ZIP_CH
              - PAGES_JAUNES
              - YELLOW_PAGES_SINGAPORE
              - INFOGROUP
              - WAZE_NEW
              - UBER_NEW
              - NEUSTAR
              - TRUSTPILOT
              - AUSKUNFT
              - BAIDU
              - NEXT_DOOR
              - MICROSOFT_CORTANA
              - GOOGLE_ASSISTANT
              - CBANQUE
              - ORANGE_118_712
              - SIRI
              - HUAWEI
              - DOCTOR_COM
              - CARE_DASH
              - DENTAL_PLANS
              - DOC_SPOT
              - HEALTHGRADES
              - SHARE_CARE
              - VITALS
              - WEB_MD
              - WELLNESS
              - ZOC_DOC
              - ZWIVEL
              - YP_COM_HEALTH
              - BING_HEALTH
              - NPPES
              - RATE_MDS
              - CITYSEARCH
              - INSIDER_PAGES
              - TWITTER
              - ALEXA
              - MAP_QUEST
              - WEBSITE_WIDGETS
              - ECO_MOVEMENT
              - GOOGLE_EV
              - APPLE_EV
              - TESLA_EV
              - EUROWAG_EV
              - OPIS_EV
              - TOMTOM_EV
              - HERE_EV
              - YELLOW_PAGES_CANADA
              - BBB
              - UBERALL_SOCIAL_ADS
              - APPLE_APPS
              - CONSUMER_AFFAIRS
              - CREDIT_KARMA
              - DELIVERY
              - GLASSDOOR
              - PLAY_GOOGLE
              - GRUBHUB
              - INDEED
              - LENDING_TREE
              - MENUISM
              - OPEN_TABLE
              - OPEN_TABLE_USA
              - WALLET_HUB
              - ZILLOW
              - ZOMATO
              - WHATS_APP
              - FOUR_SCREEN
              - AND_CHARGE
              - LINKED_IN
        countries:
          uniqueItems: true
          type: array
          description: The list of countries for which the dataPoints should be filtered
          items:
            type: string
            enum:
              - AF
              - AX
              - AL
              - DZ
              - AS
              - AD
              - AO
              - AI
              - AQ
              - AG
              - AR
              - AM
              - AW
              - AU
              - AT
              - AZ
              - BS
              - BH
              - BD
              - BB
              - BY
              - BE
              - BZ
              - BJ
              - BM
              - BT
              - BO
              - BQ
              - BA
              - BW
              - BV
              - BR
              - IO
              - BN
              - BG
              - BF
              - BI
              - KH
              - CM
              - CA
              - CV
              - KY
              - CF
              - TD
              - CL
              - CN
              - CX
              - CC
              - CO
              - KM
              - CG
              - CD
              - CK
              - CR
              - CI
              - HR
              - CU
              - CW
              - CY
              - CZ
              - DK
              - DJ
              - DM
              - DO
              - EC
              - EG
              - SV
              - GQ
              - ER
              - EE
              - ET
              - FK
              - FO
              - FJ
              - FI
              - FR
              - GF
              - PF
              - TF
              - GA
              - GM
              - GE
              - DE
              - GH
              - GI
              - GR
              - GL
              - GD
              - GP
              - GU
              - GT
              - GG
              - GN
              - GW
              - GY
              - HT
              - HM
              - VA
              - HN
              - HK
              - HU
              - IS
              - IN
              - ID
              - IR
              - IQ
              - IE
              - IM
              - IL
              - IT
              - JM
              - JP
              - JE
              - JO
              - KZ
              - KE
              - KI
              - KP
              - KR
              - XK
              - KW
              - KG
              - LA
              - LV
              - LB
              - LS
              - LR
              - LY
              - LI
              - LT
              - LU
              - MO
              - MK
              - MG
              - MW
              - MY
              - MV
              - ML
              - MT
              - MH
              - MQ
              - MR
              - MU
              - YT
              - MX
              - FM
              - MD
              - MC
              - MN
              - ME
              - MS
              - MA
              - MZ
              - MM
              - NA
              - NR
              - NP
              - NL
              - NC
              - NZ
              - NI
              - NE
              - NG
              - NU
              - NF
              - MP
              - 'NO'
              - OM
              - PK
              - PW
              - PS
              - PA
              - PG
              - PY
              - PE
              - PH
              - PN
              - PL
              - PT
              - PR
              - QA
              - RE
              - RO
              - RU
              - RW
              - BL
              - SH
              - KN
              - LC
              - MF
              - PM
              - VC
              - WS
              - SM
              - ST
              - SA
              - SN
              - RS
              - SC
              - SL
              - SG
              - SX
              - SK
              - SI
              - SB
              - SO
              - ZA
              - GS
              - SS
              - ES
              - LK
              - SD
              - SR
              - SJ
              - SZ
              - SE
              - CH
              - SY
              - TW
              - TJ
              - TZ
              - TH
              - TL
              - TG
              - TK
              - TO
              - TT
              - TN
              - TR
              - TM
              - TC
              - TV
              - UG
              - UA
              - AE
              - UK
              - US
              - UM
              - UY
              - UZ
              - VU
              - VE
              - VN
              - VG
              - VI
              - WF
              - EH
              - YE
              - ZM
              - ZW
        dataPointTypes:
          uniqueItems: true
          type: array
          description: >-
            The list of data point types (REVIEW or PHOTO) for which the
            dataPoints should be filtered
          items:
            type: string
            enum:
              - REVIEW
              - PHOTO
              - CHECKIN
              - CONVERSATION
              - COMMENT
              - QUESTION
              - POST
              - IMAGE
              - VIDEO
              - CAROUSEL_ALBUM
              - LINK
              - EXPANDEDREVIEW
              - AD_POST
        ratings:
          uniqueItems: true
          type: array
          description: >-
            The list of ratings (1, 2, 3, 4 or 5) for which the dataPoints
            should be filtered
          items:
            type: integer
            format: int32
        labels:
          uniqueItems: true
          type: array
          description: The list of labels for which the dataPoints should be filtered
          items:
            type: string
        isRead:
          type: boolean
          description: >-
            Flag to set when only datapoints should be shown that the current
            user already read
        hasReply:
          type: boolean
          description: Flag to set when only datapoints with a reply should be shown
        hasText:
          type: boolean
          description: Flag to set when only datapoints with text should be shown
        query:
          type: string
          description: >-
            Any combination of words that should be checked in the dataPoints
            text, reply messages and author
        timeSpan:
          type: string
          description: The date range for which the dataPoints should be filtered.
          enum:
            - TODAY
            - LAST_7_DAYS
            - LAST_14_DAYS
            - LAST_30_DAYS
            - LAST_90_DAYS
            - LAST_365_DAYS
            - ALL_TIME
        crossfeedFilterId:
          type: integer
          description: The id of a filter saved by a user in the Feed
          format: int64
        businessIds:
          uniqueItems: true
          type: array
          description: >-
            The list of businesses IDs for which the dataPoints should be
            filtered
          items:
            type: integer
            format: int64
        dateEnd:
          type: string
          description: The maximum date for which the dataPoints should be filtered
          format: date-time
        dateStart:
          type: string
          description: The minimum date for which the dataPoints should be filtered
          format: date-time
        ownerId:
          type: integer
          description: The id of the user that owns the filter
          format: int64
        ownerName:
          type: string
          description: The name of the user that owns the filter
        salesPartnerId:
          type: integer
          description: The sales partner to which the filter belongs
          format: int64
        subscriberIds:
          type: array
          description: The list of user's ids that are subscribed to the filter
          items:
            type: integer
            format: int64
      description: Data Point Filter Model
    DataPointFilterResponseObject:
      type: object
      properties:
        dataPointFilter:
          allOf:
            - $ref: '#/components/schemas/DataPointFilter'
      description: The actual response object of the response
    DataPointFilterResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DataPointFilterResponseObject'
    DataPointFiltersResponseObject:
      type: object
      properties:
        dataPointFilters:
          type: array
          items:
            $ref: '#/components/schemas/DataPointFilter'
      description: The actual response object of the response
    DataPointFiltersResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DataPointFiltersResponseObject'
    DataPointResponseObject:
      type: object
      properties:
        dataPoint:
          allOf:
            - $ref: '#/components/schemas/DataPoint'
      description: The actual response object of the response
    DataPointResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DataPointResponseObject'
    DataPointTimeSeriesResponse:
      type: object
      properties:
        timeseries:
          type: array
          description: A list of TimeSeriesValues
          items:
            $ref: '#/components/schemas/DataPointTimeSeriesValue'
      description: DataPoint Time Series Response Model
    DataPointTimeSeriesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DataPointTimeSeriesResponse'
    DataPointTimeSeriesValue:
      type: object
      properties:
        date:
          type: string
          description: The Date
        datapoints:
          type: object
          additionalProperties:
            type: integer
            description: >-
              A map with the count of Data points, for each type, for the
              specific date
            format: int32
          description: >-
            A map with the count of datapoints, for each type, for the specific
            date
          example:
            REVIEW: 2
            PHOTO: 1
      description: DataPoint Time Series Value Model
    DatapointStatisticsResponse:
      type: object
      properties:
        totalCount:
          type: integer
          description: Total number of datapoints
          format: int32
        photoCount:
          type: integer
          description: Number of photos
          format: int32
        postCount:
          type: integer
          description: Number of posts
          format: int32
        reviewCount:
          type: integer
          description: Number of reviews
          format: int32
        checkinCount:
          type: integer
          description: Number of checkins
          format: int32
        questionCount:
          type: integer
          description: Number of questions
          format: int32
        ratingCount:
          type: integer
          description: Number of ratings
          format: int32
        unreadCount:
          type: integer
          description: Number of unread datapoints
          format: int32
        pendingApprovalCount:
          type: integer
          description: Number of replies pending approval
          format: int32
        averageRating:
          type: number
          description: Average rating obtained
          format: float
        directories:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
              description: A value that can be either a String or an Integer
              anyOf:
                - type: string
                - type: integer
                  format: int32
            description: Breakdown by directory
            example:
              GOOGLE:
                REVIEW: 10
                PHOTO: 5
                QUESTION: 2
                CHECKIN: NOT_SUPPORTED
              FACEBOOK:
                REVIEW: 8
                PHOTO: 3
                CHECKIN: 12
                QUESTION: 0
          description: Breakdown by directory
          example:
            GOOGLE:
              REVIEW: 10
              PHOTO: 5
              QUESTION: 2
              CHECKIN: NOT_SUPPORTED
            FACEBOOK:
              REVIEW: 8
              PHOTO: 3
              CHECKIN: 12
              QUESTION: 0
      description: Datapoint statistics response Model
    DatapointStatisticsResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DatapointStatisticsResponse'
    DeleteSuccessResponseObject:
      type: object
      properties:
        deletedCount:
          type: integer
          description: Total count of deleted items
          format: int32
          example: 10
        failedCount:
          type: integer
          description: Total count of failed items
          format: int32
          example: 2
        deletedIds:
          type: array
          items:
            type: integer
            format: int64
        failed:
          type: array
          items:
            type: string
      description: The actual response object of the response
    DeleteSuccessResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DeleteSuccessResponseObject'
    DirectoriesDetailsCountriesResponseObject:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DirectoriesDetailsCountry'
        count:
          type: integer
          description: Total count of countries
          format: int32
          example: 195
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        nextOffset:
          type: integer
          description: Next offset for pagination
          format: int32
          example: 10
      description: The actual response object of the response
    DirectoriesDetailsCountriesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DirectoriesDetailsCountriesResponseObject'
    DirectoriesDetailsCountry:
      type: object
      properties:
        countryCode:
          type: string
          description: Code for country that directory supports in ISO 3166 alpha-2 format
          example: US
        directoryDetails:
          type: array
          description: Object that holds details for directory
          items:
            $ref: '#/components/schemas/DirectoryDetails'
      description: Details of directories by country
    DirectoriesResponse:
      type: object
      properties:
        count:
          type: integer
          description: The count of directories
          format: int32
          example: 5
        directories:
          type: array
          description: List of directory
          example:
            - Directory1
            - Directory2
          items:
            type: string
            description: List of directory
            example: '["Directory1","Directory2"]'
      description: Directories response model
    DirectoriesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DirectoriesResponse'
    DirectoryBrand:
      type: object
      properties:
        externalId:
          type: string
          description: External ID of the directory brand
          example: '12345'
        status:
          type: string
          description: Status of the directory brand
          example: active
        names:
          type: array
          items:
            type: string
        id:
          type: integer
          format: int64
        categories:
          type: array
          items:
            type: string
        country:
          type: string
      description: The actual response object of the response
    DirectoryBrandPageResponse:
      type: object
      properties:
        brands:
          type: array
          items:
            $ref: '#/components/schemas/DirectoryExternalBrandResponse'
        nextPageOffset:
          type: string
          description: offset for the next page from the external directory
          example: '10'
      description: Page response for directory brands
    DirectoryBrandPageResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DirectoryBrandPageResponse'
    DirectoryBrandUrl:
      type: object
      description: URLs of the external brand
    DirectoryBrandWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DirectoryBrand'
    DirectoryCategory:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the Directory Category
          format: int64
        type:
          type: string
          description: Type of the Directory
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        name:
          type: string
          description: String representation of the category
          example: Autowerkstatt
        externalId:
          type: string
          description: External id used by the directory to describe or chose a category
          example: '12345'
        parent:
          allOf:
            - $ref: '#/components/schemas/DirectoryCategory'
        selectable:
          type: boolean
          description: Indicates if the category is selectable
          example: false
        dateCreated:
          type: string
          description: Date when the category was created
          format: date-time
          example: '2023-01-01T00:00:00Z'
        lastUpdated:
          type: string
          description: Date when the category was last updated
          format: date-time
          example: '2023-01-01T00:00:00Z'
        country:
          type: string
          description: Country associated with the category
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
      description: Represents a category of a Directory uberall is connected to.
    DirectoryConnectInfo:
      type: object
      properties:
        status:
          type: string
          description: Listing Connect Status [CONNECTED, NOT_CONNECTED, NOT_NEEDED]
          enum:
            - CONNECTED
            - NOT_CONNECTED
            - NOT_NEEDED
        userDetails:
          allOf:
            - $ref: '#/components/schemas/ConnectFlowUserDetails'
      description: Directory Connect Info model
    DirectoryContactDetails:
      type: object
      properties:
        email:
          type: string
          description: Email address to be used to release a claim from another provider
        website:
          type: string
          description: >-
            Contact website address to be used to release a claim from another
            provider
      description: Directory contact details model
    DirectoryDetails:
      type: object
      properties:
        directoryName:
          type: string
          description: Name of the directory
          example: Google
        isSearchable:
          type: boolean
          description: Indicates whether directory has a search API that can be used
          example: true
      description: Details of a directory
    DirectoryExternalBrandResponse:
      type: object
      properties:
        id:
          type: string
          description: ID of the external brand
          example: '1'
        names:
          type: array
          items:
            type: string
            description: Names of the external brand
            example: '[''BrandName1'', ''BrandName2'']'
        countryCode:
          type: string
          description: Country code of the external brand
          example: US
        categories:
          type: array
          items:
            $ref: '#/components/schemas/DirectoryCategory'
        urls:
          type: array
          items:
            $ref: '#/components/schemas/DirectoryBrandUrl'
        etag:
          type: string
          description: ETag of the external brand
          example: etag123
        state:
          type: string
          description: State of the external brand
          example: active
        locationsCount:
          type: integer
          description: Count of locations for the external brand
          format: int64
          example: 10
        photos:
          type: object
          properties:
            description:
              type: string
              description: A description for the photo - max 255 chars
            sourceUrl:
              type: string
              description: The URL to the original photo
            identifier:
              type: string
              description: >-
                The photo identifier based on your internal identification
                system
            cropOffsetX:
              type: integer
              description: >-
                Horizontal pixel offset of the top-left corner of the cropped
                area [LANDSCAPE photo only]
              format: int32
            cropOffsetY:
              type: integer
              description: >-
                Vertical pixel offset of the top-left corner of the cropped area
                [LANDSCAPE photo only]
              format: int32
            cropWidth:
              type: integer
              description: Width of the 16:9 cropped area [LANDSCAPE photo only]
              format: int32
            cropHeight:
              type: integer
              description: Height of the 16:9 cropped area [LANDSCAPE photo only]
              format: int32
          description: Photos of the external brand
        ownershipType:
          type: string
          description: Ownership type of the external brand
          example: BRAND_OWNER
      description: Response for external brand directory
    DirectoryPage:
      type: object
      properties:
        directoryUserAccount:
          allOf:
            - $ref: '#/components/schemas/DirectoryUserAccount'
        token:
          allOf:
            - $ref: '#/components/schemas/OAuthToken'
        pageId:
          type: string
          description: External page ID
          example: '12345'
        name:
          type: string
          description: External page name
          example: Main Directory Page
        status:
          type: string
          description: Status of the page
          enum:
            - VALID
            - INVALID
            - CREATION_NEEDED
        type:
          type: string
          description: Type of the page
          enum:
            - FACEBOOK
            - INSTAGRAM
            - GOOGLE
            - TWITTER
            - APPLE_MAPS
            - TRUSTPILOT
            - LINKED_IN
        dateCreated:
          type: string
          description: Date the page was created
          format: date-time
          example: '2023-01-01T00:00:00Z'
        lastUpdated:
          type: string
          description: Date the page was last updated
          format: date-time
          example: '2023-01-01T00:00:00Z'
      description: Abstract class representing a directory page
    DirectoryPageResponse:
      type: object
      properties:
        id:
          type: integer
          description: The Uberall unique id for the directory page
          format: int64
        name:
          type: string
          description: The Directory Page name on the directory
        additionalInfo:
          type: string
          description: >-
            Additional info for the page allowing you to distinguish between
            pages with same name
        level:
          type: string
          description: >-
            The level of the page. It is either the business or listing page.
            [BUSINESS, LISTING]
          enum:
            - BUSINESS
            - LISTING
        type:
          type: string
          description: The Directory Page type [BUSINESS_PAGE, DIRECTORY_PAGE]
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
      description: Directory Page Response Model
    DirectoryPageResponseObject:
      type: object
      properties:
        page:
          allOf:
            - $ref: '#/components/schemas/DirectoryPage'
      description: The actual response object of the response
    DirectoryPageResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/DirectoryPageResponseObject'
    DirectoryUserAccount:
      type: object
      description: Directory user account associated with the page
    Disconnect:
      type: object
      properties:
        disconnectAll:
          type: boolean
          description: >-
            Boolean flag indicating whether disconnect should remove all created
            connections originated from business connect (only applies for
            Facebook)
    DoctorComData:
      type: object
      properties:
        npi:
          type: string
          description: National Provider Id (NPI)
        hospitals:
          type: array
          description: Hospital affiliations.
          items:
            $ref: '#/components/schemas/DoctorComDataHospital'
        educations:
          type: array
          description: List of universities where the provider received their degree(s).
          items:
            $ref: '#/components/schemas/DoctorComDataEducation'
        insurances:
          type: array
          description: Insurance providers and plans accepted by the provider.
          items:
            $ref: '#/components/schemas/DoctorComDataInsurance'
        credentials:
          type: string
          description: 'Medical professional''s credentials (max character limit: 25)'
        university:
          type: string
          description: >-
            DEPRECATED (Replaced by 'educations').  - The University where the
            provider received their degree
          deprecated: true
        hospitalAffiliations:
          type: string
          description: DEPRECATED (Replaced by 'hospitals').  - Hospital affiliations
          deprecated: true
        insurancesAccepted:
          type: string
          description: >-
            DEPRECATED (Replaced by 'insurances').  - Types of insurance
            accepted by the provider
          deprecated: true
        isProvider:
          type: boolean
          description: Defines if the listing is for a provider or not
        practiceName:
          type: string
          description: Name of the medical practice
        providerTitle:
          type: string
          description: Medical professional's title
        providerFirstname:
          type: string
          description: Medical professional's first name
        providerMiddlename:
          type: string
          description: Medical professional's middle name
        providerSurname:
          type: string
          description: Medical professional's surname
        doctorCategories:
          type: array
          description: Doctor.com categories
          items:
            type: integer
            format: int64
      description: Description of the provider
    DoctorComDataEducation:
      type: object
      properties:
        educationName:
          type: string
          description: The name of the educational institution.
        educationType:
          type: string
          description: The type of education degree (e.g. 'Medical Degree').
        startedYear:
          type: integer
          description: The year the provider started their education.
          format: int32
        graduationYear:
          type: integer
          description: >-
            The year the provider graduated from the educational institution.
            This value must be the current year or earlier.
          format: int32
      description: Doctor.com Education
    DoctorComDataHospital:
      type: object
      properties:
        hospitalName:
          type: string
          description: The name of the hospital the provider is affiliated with.
        hospitalCity:
          type: string
          description: The city the hospital is located in.
        hospitalState:
          type: string
          description: >-
            The state the hospital is located in. This should be the ISO 3166-2
            two-character code (e.g. NY).
      description: Doctor.com Hospital Affiliation
    DoctorComDataInsurance:
      type: object
      properties:
        companyName:
          type: string
          description: The name of the insurance provider company.
        insurancePlan:
          type: string
          description: The name of the insurance plan.
      description: Doctor.com Insurance
    EmailSettings:
      type: object
      properties:
        frequency:
          type: string
          description: >-
            Frequency of the emailType. The available frequencies by email type
            are: DIGEST: WEEKLY, MONTHLY or NEVER; ACTIVATION: ALWAYS or NEVER;
            START_VERIFICATION_GOOGLE: ALWAYS or NEVER;
            FINISH_VERIFICATION_GOOGLE: ALWAYS or NEVER;
            UNREAD_REVIEW_NOTIFICATION: ALWAYS or NEVER;
            PENDING_APPROVAL_REPLY_NOTIFICATION: DAILY, ALWAYS or NEVER.
          enum:
            - ALWAYS
            - DAILY
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - NEVER
        emailType:
          type: string
          description: >-
            Type of email. Currently, the types of email supported are: DIGEST,
            ACTIVATION, START_VERIFICATION_GOOGLE, FINISH_VERIFICATION_GOOGLE,
            UNREAD_REVIEW_NOTIFICATION, PENDING_APPROVAL_REPLY_NOTIFICATION,
            SOCIAL_POST_PENDING_APPROVAL_NOTIFICATION, NEW_CHATS_NOTIFICATION,
            NEW_CONTACT_FORM_NOTIFICATION
          enum:
            - DIGEST
            - UNREAD_REVIEW_NOTIFICATION
            - PENDING_APPROVAL_REPLY_NOTIFICATION
            - ACTIVATION
            - START_VERIFICATION_GOOGLE
            - FINISH_VERIFICATION_GOOGLE
            - NEW_CHATS_NOTIFICATION
            - NEW_CONTACT_FORM_NOTIFICATION
            - SOCIAL_POST_PENDING_APPROVAL_NOTIFICATION
            - DASHBOARD_EXPORT
            - RENEWAL_FAIL
            - RENEWAL_SUCCESS
            - RESET_PASSWORD_SP
            - SALES_PARTNER_APPROVAL
            - USER_INVITATION
            - SALES_PARTNER_ENTERPRISE_ONBOARDING_COMPLETE
            - NEW_CHAT_NOTIFICATION_LOCATION
            - NEW_CHAT_NOTIFICATION_BUSINESS
            - NEW_CONTACT_FORM_NOTIFICATION_LOCATION
            - NEW_CONTACT_FORM_NOTIFICATION_BUSINESS
            - TIMELY_TASK_NOTIFICATION_1
            - TIMELY_TASK_NOTIFICATION_2
            - TIMELY_TASK_NOTIFICATION_3
            - LOCATION_CLEANSING_FAILED_NOTIFICATION
        id:
          type: integer
          format: int64
      description: Email Settings Model
    EvConnector:
      required:
        - amperage
        - format
        - identifier
        - powerType
        - standard
        - updateTime
        - voltage
      type: object
      properties:
        identifier:
          type: string
          description: >-
            Required - Identifier of the connector within the EVSE created by
            the CPO. Two connectors may have the same id as long as they do not
            belong to the same EVSE object.
        standard:
          type: string
          description: Required - The socket or plug standard of the charging point
          enum:
            - CHADEMO
            - CHAOJI
            - DOMESTIC_A
            - DOMESTIC_B
            - DOMESTIC_C
            - DOMESTIC_D
            - DOMESTIC_E
            - DOMESTIC_F
            - DOMESTIC_G
            - DOMESTIC_H
            - DOMESTIC_I
            - DOMESTIC_J
            - DOMESTIC_K
            - DOMESTIC_L
            - DOMESTIC_M
            - DOMESTIC_N
            - DOMESTIC_O
            - GBT_AC
            - GBT_DC
            - IEC_60309_2_single_16
            - IEC_60309_2_three_16
            - IEC_60309_2_three_32
            - IEC_60309_2_three_64
            - IEC_62196_T1
            - IEC_62196_T1_COMBO
            - IEC_62196_T2
            - IEC_62196_T2_COMBO
            - IEC_62196_T3A
            - IEC_62196_T3C
            - NEMA_5_20
            - NEMA_6_30
            - NEMA_6_50
            - NEMA_10_30
            - NEMA_10_50
            - NEMA_14_30
            - NEMA_14_50
            - PANTOGRAPH_BOTTOM_UP
            - PANTOGRAPH_TOP_DOWN
            - TESLA_R
            - TESLA_S
        format:
          type: string
          description: >-
            Required - The format of the connector, whether it is a socket or a
            plug
          enum:
            - CABLE
            - SOCKET
        powerType:
          type: string
          description: >-
            Required - Connector Power Type. Values can be: AC_1_PHASE,
            AC_3_PHASE, DC
          enum:
            - AC_1_PHASE
            - AC_2_PHASE
            - AC_2_PHASE_SPLIT
            - AC_3_PHASE
            - DC
        voltage:
          type: integer
          description: Required - The voltage of the connector
          format: int32
        amperage:
          type: integer
          description: Required - The maximum amperage of the connector
          format: int32
        updateTime:
          type: string
          description: Date/time of the connector's last update
          format: date-time
      description: EV Connector
    EvData:
      required:
        - operator
        - owner
        - timezone
        - updateTime
      type: object
      properties:
        type:
          type: string
          description: Type of location of the charging station
          enum:
            - ON_STREET
            - OTHER
            - PARKING_GARAGE
            - PARKING_LOT
            - UNDERGROUND_GARAGE
            - ON_DRIVEWAY
            - ALONG_MOTORWAY
            - UNKNOWN
        owner:
          type: string
          description: Required - Owner of the location
        operator:
          type: string
          description: Required - Operator of the chargepoints of the location
        subOperator:
          type: string
          description: Suboperator of the chargepoints of the location
        timezone:
          type: string
          description: The time zone of the location
        isChargingClosed:
          type: boolean
          description: >-
            Indicates if the EVSEs can be used for charging outside the opening
            hours of the location. E.g. when the parking garage closes its
            barriers overnight, it will indicate if you still can charge till
            the next morning
        updateTime:
          type: string
          description: Date/time of the last EV data update
          format: date-time
        supplyEquipments:
          uniqueItems: true
          type: array
          description: Charging Station information
          items:
            $ref: '#/components/schemas/EvSupplyEquipment'
      description: EV Data
    EvDynamicDataObject:
      type: object
      properties:
        location:
          allOf:
            - $ref: '#/components/schemas/Location'
        uid:
          type: string
          description: UID
        status:
          type: string
          description: Status
      description: The actual response object of the response
    EvDynamicDataWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/EvDynamicDataObject'
    EvSupplyEquipment:
      required:
        - uid
        - updateTime
      type: object
      properties:
        uid:
          type: string
          description: Unique ID in the system of the CPO
        evseId:
          type: string
          description: >-
            Required - Unique id for the outside world. Compliant with
            “eMI3standard version V1.0”
        physicalReference:
          type: string
          description: >-
            A number/string printed on the outside of the EVSE for visual
            identification
        updateTime:
          type: string
          description: Date/time of the Equipment's last update
          format: date-time
        connectors:
          uniqueItems: true
          type: array
          description: Details on each connector
          items:
            $ref: '#/components/schemas/EvConnector'
        parkingRestrictions:
          uniqueItems: true
          type: array
          description: >-
            This value, if provided by CPO, represents the restriction to the
            parking spot for different purposes
          items:
            type: string
            enum:
              - CUSTOMERS
              - DISABLED
              - EV_ONLY
              - MOTORCYCLES
              - PLUGGED
      description: EV Supply Equipment
    Event:
      required:
        - timeEnd
        - timeStart
        - title
      type: object
      properties:
        title:
          type: string
          description: The title of the event
        description:
          type: string
          description: 'The description of the event: e.g. "Watch a lot of awesome movies."'
        identifier:
          type: string
          description: Unique Identifier for the Event
        listName:
          type: string
          description: Name of the Event
        timeStart:
          type: string
          description: The date the event starts
          format: date-time
        timeEnd:
          type: string
          description: The date the event ends
          format: date-time
        video:
          description: A video to promote the event
          allOf:
            - $ref: '#/components/schemas/Video'
        url:
          type: string
          description: The url of the page with more details about the event
      description: Event
    EventResponseObject:
      type: object
      properties:
        event:
          allOf:
            - $ref: '#/components/schemas/Event'
      description: The actual response object of the response
    EventResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/EventResponseObject'
    EventSearchResponseObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        total:
          type: integer
          description: Total count of results
          format: int32
          example: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
      description: The actual response object of the response
    EventSearchResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/EventSearchResponseObject'
    FeaturesResponse:
      type: object
      properties:
        locations:
          type: array
          description: Get user features partitioned by location.
          items:
            $ref: '#/components/schemas/LocationFeatureResponse'
        defaultFeatures:
          type: array
          description: A list with the default features for the user.
          items:
            type: string
            enum:
              - NEW_PHOTO_TYPES
              - ADS
              - ADS_READ
              - ADS_WRITE
              - ADVANCED_ANALYTICS
              - ADVANCED_ANALYTICS_2_0
              - AI_KNOWLEDGEBASE
              - AI_LOCALISATION
              - AI_LOCATION_INFORMATION
              - AI_SUGGESTED_REPLIES
              - APPLE_POSTING
              - APPLE_POSTING_WRITE
              - AUTO_RESPONSE
              - AUTO_RESPONSE_WRITE
              - AUTOMATION
              - BASIC
              - BASIC_PLUS
              - BULK_UPDATES
              - INSTAGRAM_POSTING
              - INSTAGRAM_POSTING_WRITE
              - LINKEDIN_POSTING
              - BUSINESS_LEVEL_CONNECT
              - CALL_TRACKING_NUMBERS
              - CAN_PAY_INVOICE
              - CAN_SEE_HELP_SECTION
              - CHATBOT
              - CHATBOT_READ
              - CHATBOT_WRITE
              - CHAT_READ
              - CHAT_WRITE
              - CLEANSING
              - CONTENT_COLLECTION
              - DAM
              - DASHBOARD
              - ENTERPRISE_ONBOARDING
              - FACEBOOK_UNOWNED_PAGE_CREATE
              - FACEBOOK_POSTING
              - FIRST_PARTY_REVIEW_APPROVAL
              - FORMS
              - GOOGLE_POSTING
              - HOMEPAGE
              - INBOX
              - INBOX_APPROVAL
              - INBOX_PREVIEW
              - INBOX_TEASER
              - INBOX_TWITTER
              - INBOX_READ
              - INBOX_WRITE
              - INBOX_2_0_BETA
              - INBOX_2_0_BETA_READ
              - INBOX_2_0_BETA_WRITE
              - INBOX_FLAG
              - LISTINGS
              - LIVE_CHAT
              - LOCAL_SEO_REPORT
              - LOCATION_APPROVAL_REQUESTS
              - LOCATION_GROUP
              - LOCATION_STATUS_CHANGE
              - LOCATION_TRANSLATION
              - LOCATION_READ
              - LOCATION_WRITE
              - LOCAL_INVENTORY
              - MANUAL_LISTINGS
              - NEAR_ME_CHECK
              - PHONE_OPTIONAL
              - OTHERS_POSTING
              - POSTING
              - POSTING_APPROVAL
              - POSTING_READ
              - POSTING_TONE_ADJUST
              - POSTING_WRITE
              - POSTING_PREVIEW
              - PRICE_INFO
              - QR_CODE_GENERATION
              - RESPONSE_LIBRARY
              - RESPONSE_LIBRARY_READ
              - RESPONSE_LIBRARY_WRITE
              - REVIEW_GENERATION_EMAIL
              - REVIEW_GENERATION_SMS
              - REVIEW_GENERATION_CREATE
              - REVIEW_GENERATION_SEND
              - LOCATION_APPROVAL
              - LOCATION_SCHEDULED_UPDATES
              - SINGLE_SIGN_ON
              - SOCIAL_ADS
              - STOREFINDER
              - STOREFINDER_TRIAL_MODE
              - LOCATOR_PAGES_BUILDER
              - STOREFINDER_ANALYTICS
              - STOREFINDER_GOOGLE
              - STOREFINDER_MAPBOX
              - SUPPORT
              - SUPPRESSION
              - TRACKING
              - TRANSACTION_LINKS
              - TWITTER_INBOX_READ
              - TWITTER_INBOX_WRITE
              - TWITTER_POSTING
              - TWITTER_POSTING_WRITE
              - UPGRADE
              - USER_OTHERS_EDIT
              - USER_SELF_EDIT
              - UTMS
              - WEBSITE_WIDGETS
              - EXPANDED_REVIEWS_RESTAURANT
              - EXPANDED_REVIEWS_FINANCE
              - WHATS_APP_MESSAGES
              - ACCESS_REQUEST_INVITATIONS
              - AI_BULK_REPLIES
              - SURVEYS
              - SURVEYS_READ
              - SURVEYS_WRITE
      description: Features Response Model
    FeaturesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/FeaturesResponse'
    FeedItem:
      type: object
      properties:
        date:
          type: string
          description: Action date of the feed item
          format: date-time
        type:
          type: string
          description: >-
            The Feed item type, one of [INTERACTION, TRACKING, LOCATION_EVENT,
            LISTING_EVENT]
          enum:
            - INTERACTION
            - TRACKING
            - LOCATION_EVENT
            - LISTING_EVENT
        properties:
          description: A Map containing the specific information related to the Feed
          allOf:
            - $ref: '#/components/schemas/FeedItemProperties'
      description: Feed item Model
    FeedItemProperties:
      type: object
      properties:
        event:
          allOf:
            - $ref: '#/components/schemas/LoggingEvent'
        location:
          allOf:
            - $ref: '#/components/schemas/FeedItemPropertiesLocation'
      description: Map containing the specific information related to the Feed
    FeedItemPropertiesLocation:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    FeedItemWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/FeedItem'
    FiltersResponse:
      type: object
      properties:
        directories:
          type: array
          description: List of directory names
          items:
            type: string
            enum:
              - FOURSQUARE
              - UBER
              - GOOGLE
              - WAZE
              - GOOGLE_MAPS
              - YELP
              - YELP_API
              - MEINESTADT
              - YELLOW_MAP
              - FOCUS
              - LOKALEAUSKUNFT
              - WEB_DE
              - GMX
              - ONE_AND_ONE
              - FREIEAUSKUNFT
              - POINTOO
              - NOKIA_HERE
              - FACEBOOK
              - TOMTOM
              - STADTBRANCHENBUCH
              - CYLEX
              - UNTERNEHMENSAUSKUNFT
              - ACOMPIO
              - BUSINESSBRANCHENBUCH
              - YALWA
              - THE_PHONEBOOK
              - SCOOT
              - CENTRAL_INDEX
              - CITIPAGES
              - ONE_NINE_TWO
              - ONE_ONE_EIGHT
              - THE_DAILY_RECORD
              - THE_EVENING_STANDARD
              - THE_SCOTSMAN
              - LIVERPOOL_ECHO
              - THE_SUN
              - THE_INDEPENDENT
              - TOUCH_LOCAL
              - THE_MIRROR
              - ANNUAIRE
              - INFOBEL
              - US_INFO_COM
              - GARMIN
              - FACTUAL
              - BING
              - WO_GIBTS_WAS
              - KOOMIO
              - ABCLOCAL
              - YELLBO
              - JELLOO
              - GUIDELOCAL
              - OEFFNUNGSZEITENBUCH
              - APPLE_MAPS
              - LOOCAL
              - REGIONAL_DE
              - WHERE_TO
              - TUPALO
              - GELBE_SEITEN
              - DAS_OERTLICHE
              - DIALO
              - BUNDES_TELEFONBUCH
              - BRANCHENBUCH_DEUTSCHLAND
              - MARKTPLATZ_MITTELSTAND
              - BUSQUEDA_LOCAL
              - RICERCARE_IMPRESE
              - PAGES24
              - NAVMII
              - AUDI
              - BMW
              - MERCEDES
              - VW
              - TOYOTA
              - FORD
              - FIAT
              - GM
              - ETRUSTED
              - INSTAGRAM
              - SHOPPING_TIME_NETWORK
              - CITY_SQUARES
              - SHOWMELOCAL
              - LOCALSTACK
              - CHAMBER_OF_COMMERCE
              - JUDYS_BOOK
              - BROWNBOOK
              - MY_LOCAL_SERVICES
              - YA_SABE
              - UNIVISION
              - AL_DIA_TX
              - LA_VOZ_TX
              - CHRON
              - STATESMAN
              - PALM_BEACH_POST
              - MUNDO_HISPANICO
              - EL_TIEMPO_LATINO
              - LATINOS_US
              - HOTFROG
              - INFO_IS_INFO
              - MANTA
              - US_CITY
              - GO_YELLOW
              - N49
              - PRATIQUE
              - JUSTACOTE
              - EZLOCAL
              - ELOCAL
              - TRUE_LOCAL
              - START_LOCAL
              - WOMO
              - AUSSIE_WEB
              - YELLOW_PAGES
              - SUPER_PAGES
              - WHITE_PAGES
              - DEX_KNOWS
              - KAUFDA_MANUAL
              - I_GLOBAL
              - BRANCHEN_INFO_MANUAL
              - GUTE_BANKEN_MANUAL
              - D_11880_COM_MANUAL
              - BANKOEFFNUNGSZEITEN_DE_MANUAL
              - BANK_OEFFNUNGSZEITEN_DE_MANUAL
              - CYLEX_MANUAL
              - FINDE_OFFEN_MANUAL
              - MEIN_PROSPEKT_MANUAL
              - DAS_SCHNELLE
              - SENSIS_WHITE_PAGES
              - SENSIS_TRUE_LOCAL
              - SENSIS_YELLOW_PAGES
              - FIND_OPEN
              - WAND
              - BELL_CA
              - GO_LOCAL
              - MEINUNGSMEISTER
              - YANDEX
              - YAHOO_MANUAL
              - HOLIDAY_CHECK
              - TRIP_ADVISOR
              - BONIAL_FR
              - ZIP_CH
              - PAGES_JAUNES
              - YELLOW_PAGES_SINGAPORE
              - INFOGROUP
              - WAZE_NEW
              - UBER_NEW
              - NEUSTAR
              - TRUSTPILOT
              - AUSKUNFT
              - BAIDU
              - NEXT_DOOR
              - MICROSOFT_CORTANA
              - GOOGLE_ASSISTANT
              - CBANQUE
              - ORANGE_118_712
              - SIRI
              - HUAWEI
              - DOCTOR_COM
              - CARE_DASH
              - DENTAL_PLANS
              - DOC_SPOT
              - HEALTHGRADES
              - SHARE_CARE
              - VITALS
              - WEB_MD
              - WELLNESS
              - ZOC_DOC
              - ZWIVEL
              - YP_COM_HEALTH
              - BING_HEALTH
              - NPPES
              - RATE_MDS
              - CITYSEARCH
              - INSIDER_PAGES
              - TWITTER
              - ALEXA
              - MAP_QUEST
              - WEBSITE_WIDGETS
              - ECO_MOVEMENT
              - GOOGLE_EV
              - APPLE_EV
              - TESLA_EV
              - EUROWAG_EV
              - OPIS_EV
              - TOMTOM_EV
              - HERE_EV
              - YELLOW_PAGES_CANADA
              - BBB
              - UBERALL_SOCIAL_ADS
              - APPLE_APPS
              - CONSUMER_AFFAIRS
              - CREDIT_KARMA
              - DELIVERY
              - GLASSDOOR
              - PLAY_GOOGLE
              - GRUBHUB
              - INDEED
              - LENDING_TREE
              - MENUISM
              - OPEN_TABLE
              - OPEN_TABLE_USA
              - WALLET_HUB
              - ZILLOW
              - ZOMATO
              - WHATS_APP
              - FOUR_SCREEN
              - AND_CHARGE
              - LINKED_IN
        countries:
          type: array
          description: List of countriy names
          items:
            type: string
            enum:
              - AF
              - AX
              - AL
              - DZ
              - AS
              - AD
              - AO
              - AI
              - AQ
              - AG
              - AR
              - AM
              - AW
              - AU
              - AT
              - AZ
              - BS
              - BH
              - BD
              - BB
              - BY
              - BE
              - BZ
              - BJ
              - BM
              - BT
              - BO
              - BQ
              - BA
              - BW
              - BV
              - BR
              - IO
              - BN
              - BG
              - BF
              - BI
              - KH
              - CM
              - CA
              - CV
              - KY
              - CF
              - TD
              - CL
              - CN
              - CX
              - CC
              - CO
              - KM
              - CG
              - CD
              - CK
              - CR
              - CI
              - HR
              - CU
              - CW
              - CY
              - CZ
              - DK
              - DJ
              - DM
              - DO
              - EC
              - EG
              - SV
              - GQ
              - ER
              - EE
              - ET
              - FK
              - FO
              - FJ
              - FI
              - FR
              - GF
              - PF
              - TF
              - GA
              - GM
              - GE
              - DE
              - GH
              - GI
              - GR
              - GL
              - GD
              - GP
              - GU
              - GT
              - GG
              - GN
              - GW
              - GY
              - HT
              - HM
              - VA
              - HN
              - HK
              - HU
              - IS
              - IN
              - ID
              - IR
              - IQ
              - IE
              - IM
              - IL
              - IT
              - JM
              - JP
              - JE
              - JO
              - KZ
              - KE
              - KI
              - KP
              - KR
              - XK
              - KW
              - KG
              - LA
              - LV
              - LB
              - LS
              - LR
              - LY
              - LI
              - LT
              - LU
              - MO
              - MK
              - MG
              - MW
              - MY
              - MV
              - ML
              - MT
              - MH
              - MQ
              - MR
              - MU
              - YT
              - MX
              - FM
              - MD
              - MC
              - MN
              - ME
              - MS
              - MA
              - MZ
              - MM
              - NA
              - NR
              - NP
              - NL
              - NC
              - NZ
              - NI
              - NE
              - NG
              - NU
              - NF
              - MP
              - 'NO'
              - OM
              - PK
              - PW
              - PS
              - PA
              - PG
              - PY
              - PE
              - PH
              - PN
              - PL
              - PT
              - PR
              - QA
              - RE
              - RO
              - RU
              - RW
              - BL
              - SH
              - KN
              - LC
              - MF
              - PM
              - VC
              - WS
              - SM
              - ST
              - SA
              - SN
              - RS
              - SC
              - SL
              - SG
              - SX
              - SK
              - SI
              - SB
              - SO
              - ZA
              - GS
              - SS
              - ES
              - LK
              - SD
              - SR
              - SJ
              - SZ
              - SE
              - CH
              - SY
              - TW
              - TJ
              - TZ
              - TH
              - TL
              - TG
              - TK
              - TO
              - TT
              - TN
              - TR
              - TM
              - TC
              - TV
              - UG
              - UA
              - AE
              - UK
              - US
              - UM
              - UY
              - UZ
              - VU
              - VE
              - VN
              - VG
              - VI
              - WF
              - EH
              - YE
              - ZM
              - ZW
        businesses:
          type: array
          description: List of business ids and names
          items:
            $ref: '#/components/schemas/BusinessFiltersResponse'
        labels:
          uniqueItems: true
          type: array
          description: List of labels
          items:
            type: string
        timeSpans:
          type: array
          items:
            type: string
            enum:
              - TODAY
              - LAST_7_DAYS
              - LAST_14_DAYS
              - LAST_30_DAYS
              - LAST_90_DAYS
              - LAST_365_DAYS
              - ALL_TIME
      description: Response object containing various filters for data points
    FiltersResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/FiltersResponse'
    GoogleServiceItem:
      type: object
      properties:
        serviceTypeId:
          type: string
          description: Service Type ID
        displayName:
          type: string
          description: Display Name
      description: Google Service
    GoogleServicesResponseObject:
      type: object
      properties:
        googleServices:
          type: array
          items:
            $ref: '#/components/schemas/GoogleServiceItem'
      description: The actual response object of the response
    GoogleServicesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/GoogleServicesResponseObject'
    GoogleVenueAttributesObject:
      type: object
      properties:
        valueType:
          type: string
          description: The type of the attribute's value
          enum:
            - BOOL
            - URL
            - ENUM
            - REPEATED_ENUM
        unsetValue:
          type: string
          description: Unset value
          nullable: true
        externalId:
          type: string
          description: External id
        value:
          type: string
          description: Value
          example: 'true'
      description: Attributes
    GoogleVenueCategoriesDetailsObject:
      type: object
      properties:
        moreHoursTypes:
          type: array
          description: List of more hours types
          items:
            $ref: '#/components/schemas/GoogleVenueMoreHoursTypesObject'
        displayName:
          type: string
          description: Display name
        name:
          type: string
          description: Name
        serviceTypes:
          type: array
          description: Service types
          items:
            $ref: '#/components/schemas/GoogleVenueServicesTypesObject'
    GoogleVenueCategoriesObject:
      type: object
      properties:
        primaryCategory:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueCategoriesDetailsObject'
        additionalCategories:
          type: array
          description: List of additional categories
          items:
            $ref: '#/components/schemas/GoogleVenueCategoriesDetailsObject'
      description: Categories
    GoogleVenueDateObject:
      type: object
      properties:
        month:
          type: integer
          description: Month
          format: int32
          example: 1
        year:
          type: integer
          description: Year
          format: int32
          example: 2025
        day:
          type: integer
          description: Day
          format: int32
          example: 3
      description: Opening date
    GoogleVenueDetailsObject:
      type: object
      properties:
        page:
          allOf:
            - $ref: '#/components/schemas/GoogleVenuePageObject'
      description: The actual response object of the response
    GoogleVenueDetailsWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueDetailsObject'
    GoogleVenueDimensionsObject:
      type: object
      properties:
        heightPixels:
          type: integer
          description: Height in pixels
          format: int32
          example: 1080
        widthPixels:
          type: integer
          description: Width in pixels
          format: int32
          example: 1920
      description: Dimensions
    GoogleVenueLatLngObject:
      type: object
      properties:
        latitude:
          type: number
          description: Latitude
          format: double
          example: 52.5415609
        longitude:
          type: number
          description: Longitude
          format: double
          example: 13.3831045
      description: Latitude and Longitued
    GoogleVenueLocationAssociationObject:
      type: object
      properties:
        category:
          type: string
          description: Category
          example: ADDITIONAL
      description: Location association
    GoogleVenueMediaObject:
      type: object
      properties:
        sourceUrl:
          type: string
          description: Source url
        googleUrl:
          type: string
          description: Google url
        createTime:
          type: string
          description: Create time
          format: date-time
        name:
          type: string
          description: Name
        mediaFormat:
          type: string
          description: Media format
          enum:
            - PHOTO
            - VIDEO
        locationAssociation:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueLocationAssociationObject'
        thumbnailUrl:
          type: string
          description: Thumbnail url
        dimensions:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueDimensionsObject'
    GoogleVenueMetadataObject:
      type: object
      properties:
        canModifyServiceList:
          type: boolean
          description: Can modify the service list
        placeId:
          type: string
          description: Place Id
        mapsUri:
          type: string
          description: Maps URI
        canPostOnGoogle:
          type: boolean
          description: Can post on Google
        canDelete:
          type: boolean
          description: Can delete
        hasVoiceOfMerchant:
          type: boolean
          description: Has voice of merchant
        newReviewUri:
          type: string
          description: New review URI
      description: Metadata of the Google Venue
    GoogleVenueMoreHoursTypesObject:
      type: object
      properties:
        displayName:
          type: string
          description: Display name
          example: Access
        localizedDisplayName:
          type: string
          description: Localized display name
          example: Zugang
        hoursTypeId:
          type: string
          description: Hours type id
          example: ACCESS
    GoogleVenueOpenInfo:
      type: object
      properties:
        canReopen:
          type: boolean
          description: Can reopen
        openingDate:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueDateObject'
        status:
          type: string
          description: Status
          example: OPEN
      description: Open info
    GoogleVenuePageObject:
      type: object
      properties:
        metadata:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueMetadataObject'
        diffMask:
          type: string
          description: Diff mask
          nullable: true
        verificationStatus:
          type: string
          description: Verification Status
          enum:
            - UNVERIFIED
            - VERIFIED
        profile:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueProfileObject'
        videos:
          type: array
          description: List of videos
          items:
            $ref: '#/components/schemas/GoogleVenueMediaObject'
        regularHours:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueRegularHoursObject'
        services:
          type: array
          description: List of services
          items:
            $ref: '#/components/schemas/GoogleVenueServicesObject'
        title:
          type: string
          description: Title
          example: Uberall
        specialHours:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueSpecialHoursObject'
        languageCode:
          type: object
          description: Language code
          example: de
        verificationHistory:
          type: array
          description: List of verification history
          items:
            $ref: '#/components/schemas/GoogleVenueVerificationHistoryObject'
        pageId:
          type: string
          description: Page id
        photos:
          type: array
          description: List of photos
          items:
            $ref: '#/components/schemas/GoogleVenueMediaObject'
        phoneNumbers:
          allOf:
            - $ref: '#/components/schemas/GoogleVenuePhoneNumbersObject'
        websiteUri:
          type: string
          description: Website URI
        name:
          type: string
          description: Name
        attributes:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueAttributesObject'
        categories:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueCategoriesObject'
        storefrontAddress:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueStorefrontAddressObject'
        pendingMask:
          type: string
          description: Pending mask
        transactionLinks:
          type: array
          description: Transaction links
          items:
            $ref: '#/components/schemas/GoogleVenueTransactionLinksObject'
        latlng:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueLatLngObject'
        openInfo:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueOpenInfo'
        storeCode:
          type: string
          description: Store code
    GoogleVenuePeriodsObject:
      type: object
      properties:
        openDay:
          type: string
          description: Open day
          example: MONDAY
        closeDay:
          type: string
          description: Close day
          example: MONDAY
        openTime:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueTimeObject'
        closeTime:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueTimeObject'
    GoogleVenuePhoneNumbersObject:
      type: object
      properties:
        primaryPhone:
          type: string
          description: Primary phone number
        additionalPhones:
          type: array
          description: Additional phone numbers
          items:
            type: string
      description: List of photos
    GoogleVenueProfileObject:
      type: object
      properties:
        description:
          type: string
          description: Profile description text
      description: Profile
    GoogleVenueRegularHoursObject:
      type: object
      properties:
        periods:
          type: array
          description: Periods
          items:
            $ref: '#/components/schemas/GoogleVenuePeriodsObject'
      description: Regular hours
    GoogleVenueServicesObject:
      type: object
      properties:
        identifier:
          type: string
          description: Service identifier
        country:
          type: string
          description: Service country
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        price:
          type: integer
          description: Service price
          format: int64
        translations:
          type: object
          description: Service translations
        description:
          type: string
          description: Service description
        googleService:
          type: string
          description: Google service
        currency:
          type: string
          description: Service currency
        id:
          type: integer
          description: Service id
          format: int64
        listName:
          type: string
          description: Service list name
        title:
          type: string
          description: Service title
        category:
          type: integer
          description: Service category
          format: int32
    GoogleVenueServicesTypesObject:
      type: object
      properties:
        displayName:
          type: string
          description: Display name
        serviceTypeId:
          type: string
          description: Service type id
    GoogleVenueSpecialHourPeriodsObject:
      type: object
      properties:
        startDate:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueDateObject'
        endDate:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueDateObject'
        openTime:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueTimeObject'
        closeTime:
          allOf:
            - $ref: '#/components/schemas/GoogleVenueTimeObject'
    GoogleVenueSpecialHoursObject:
      type: object
      properties:
        specialHourPeriods:
          type: array
          description: Special hours
          items:
            $ref: '#/components/schemas/GoogleVenueSpecialHourPeriodsObject'
      description: Special hours
    GoogleVenueStorefrontAddressObject:
      type: object
      properties:
        regionCode:
          type: string
          description: Region code
          example: DE
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        postalCode:
          type: string
          description: Postal code
          example: '13355'
        locality:
          type: string
          description: Locality
          example: Berlin
        addressLines:
          type: array
          description: Address lines
          example: Hussitenstraße 32-33
          items:
            type: string
        languageCode:
          type: object
          description: Language code
          example: de
      description: Storefront address
    GoogleVenueTimeObject:
      type: object
      properties:
        hours:
          type: integer
          description: Hours
          format: int32
        minutes:
          type: integer
          description: Minutes
          format: int32
      description: Close time
    GoogleVenueTransactionLinksObject:
      type: object
      properties:
        placeActionType:
          type: string
          description: Transaction Link Type
          enum:
            - APPOINTMENT
            - ONLINE_APPOINTMENT
            - FOOD_ORDERING
            - FOOD_DELIVERY
            - FOOD_TAKEOUT
            - DINING_RESERVATION
            - SHOP_ONLINE
            - AIRLINE_BOOK
            - AIRLINE_CHECK_IN
            - AIRLINE_FLIGHT_STATUS
            - BOOK
            - BOOK_ACTIVITIES
            - BOOK_RIDES
            - BOOK_TEETIMES
            - BOOK_TOURS
            - BUY_TICKETS
            - CAREERS
            - CHARGE_EV
            - COUPONS
            - DONATE
            - EVENTS
            - EVENTS_SHOWS
            - EVENTS_SPORTS
            - GIFT_CARD
            - HOTEL_AMENITIES
            - HOTEL_BOOK_ROOM
            - AVAILABLE_PARKING
            - RESERVE_PARKING
            - RESTAURANT_JOIN_WAITLIST
            - VIEW_MENU
            - SERVICE_QUOTE
            - STORE_DELIVERY
            - STORE_PICKUP
            - SERVICES
            - SUPPORT
            - SHOWTIMES
            - VIEW_AVAILABILITY
            - VIEW_PRICING
            - APPLE_APPOINTMENT
            - APPLE_FOOD_ORDERING
            - APPLE_FOOD_DELIVERY
            - APPLE_FOOD_TAKEOUT
            - APPLE_DINING_RESERVATION
            - APPLE_SHOP_ONLINE
            - APPLE_AIRLINE_BOOK_TRAVEL
            - APPLE_AIRLINE_CHECK_IN
            - APPLE_AIRLINE_FLIGHT_STATUS
            - APPLE_BOOK
            - APPLE_BOOK_ACTIVITIES
            - APPLE_BOOK_RIDES
            - APPLE_BOOK_TEETIMES
            - APPLE_BOOK_TOURS
            - APPLE_BUY_TICKETS
            - APPLE_CAREERS
            - APPLE_CHARGE_EV
            - APPLE_COUPONS
            - APPLE_DONATE
            - APPLE_EVENTS
            - APPLE_EVENTS_SHOWS
            - APPLE_EVENTS_SPORTS
            - APPLE_GIFT_CARD
            - APPLE_HOTEL_AMENITIES
            - APPLE_HOTEL_BOOK_ROOM
            - APPLE_PARKING_AVAILABLE_PARKING
            - APPLE_PARKING_RESERVE_PARKING
            - APPLE_RESTAURANT_JOIN_WAITLIST
            - APPLE_RESTAURANT_PICKUP
            - APPLE_RESTAURANT_VIEW_MENU
            - APPLE_RETAIL_SERVICE_QUOTE
            - APPLE_RETAIL_STORE_DELIVERY
            - APPLE_RETAIL_STORE_PICKUP
            - APPLE_SERVICES
            - APPLE_SUPPORT
            - APPLE_THEATER_NOW_PLAYING
            - APPLE_VIEW_AVAILABILITY
            - APPLE_VIEW_PRICING
        isEditable:
          type: boolean
          description: Is editable
        createTime:
          type: string
          description: Create time
          format: date-time
        name:
          type: string
          description: Name
        updateTime:
          type: string
          description: Update time
          format: date-time
        uri:
          type: string
          description: URI
        providerType:
          type: string
          description: Provider type
          example: MERCHANT
    GoogleVenueVerificationHistoryObject:
      type: object
      properties:
        method:
          type: string
          description: Method
          example: ADDRESS
        createTime:
          type: string
          description: State
          format: date-time
        name:
          type: string
          description: Name
        state:
          type: string
          description: State
          example: FAILED
    HoursObject:
      type: object
      properties:
        dayOfWeek:
          type: integer
          description: The MoreHours dayOfWeek, represented by a number
          format: int32
          example: 1
        from:
          type: string
          description: The MoreHours from as a String
          example: '08:00'
        to:
          type: string
          description: The MoreHours to as a String
          example: '18:00'
    Image:
      required:
        - type
        - uid
        - url
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id for the image
          format: int64
        url:
          type: string
          description: Image url
        type:
          type: string
          description: The image type, one of [LOGO, MAIN, IMAGE]
          enum:
            - LOGO
            - MAIN
            - IMAGE
        description:
          type: string
          description: Description of the image
        uid:
          type: string
          description: user identifier of the image
      description: Image
    InboxResponse:
      type: object
      properties:
        page:
          type: integer
          description: The page number for pagination
          format: int32
        pageSize:
          type: integer
          description: The number of datapoints to show on each page
          format: int32
        count:
          type: integer
          description: The total number of datapoints
          format: int64
        dataPoints:
          type: array
          description: A list of datapoints (reviews, photos, check-ins ...)
          items:
            $ref: '#/components/schemas/DataPoint'
        status:
          type: string
          description: >-
            Status indicating whether 'Inbox' is active for the current
            location. One of ACTIVE INACTIVE
        ignoredLocations:
          type: array
          description: A list of locations where datapoints are not tracked
          items:
            type: integer
            format: int64
      description: Inbox Response Model
    InboxResponseObject:
      type: object
      properties:
        inbox:
          allOf:
            - $ref: '#/components/schemas/InboxResponse'
      description: The actual response object of the response
    InboxResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/InboxResponseObject'
    InsightsObject:
      type: object
      properties:
        metrics:
          type: array
          description: List of metrics
          example:
            - name: ACTIONS_WEBSITE
              data:
                - period: '2025-04-01'
                  count: 683
                - period: '2025-04-02'
                  count: 658
            - name: ACTIONS_PHONE
              data:
                - period: '2025-04-01'
                  count: 840
                - period: '2025-04-02'
                  count: 886
            - name: ACTIONS_DRIVING_DIRECTIONS
              data:
                - period: '2025-04-01'
                  count: 11097
                - period: '2025-04-02'
                  count: 11332
            - name: BUSINESS_IMPRESSIONS_DESKTOP_MAPS
              data:
                - period: '2025-04-01'
                  count: 8436
                - period: '2025-04-02'
                  count: 8248
            - name: BUSINESS_IMPRESSIONS_MOBILE_MAPS
              data:
                - period: '2025-04-01'
                  count: 131141
                - period: '2025-04-02'
                  count: 133253
            - name: BUSINESS_CONVERSATIONS
              data: []
            - name: BUSINESS_BOOKINGS
              data: []
          items:
            $ref: '#/components/schemas/Metric'
        matchedLocationsCount:
          type: integer
          description: >-
            The number of locations matching the filter which the insights are
            returned for
          format: int32
      description: The actual response object of the response
    InsightsWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/InsightsObject'
    InteractionCountByPeriodDetails:
      type: object
      properties:
        period:
          type: string
          description: The period
        count:
          type: integer
          description: The number of reviews and photos unread
          format: int32
    KeywordsObject:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
      description: The actual response object of the response
    KeywordsWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/KeywordsObject'
    Label:
      required:
        - name
      type: object
      properties:
        name:
          type: string
          description: Label name as String.
        adminOnly:
          type: boolean
          description: Permission on label, whether it can be used by admins or everyone.
      description: Label
    LabelListObject:
      type: object
      properties:
        labels:
          type: array
          items:
            $ref: '#/components/schemas/Label'
      description: The actual response object of the response
    LabelListWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LabelListObject'
    LabelsResponse:
      type: object
      properties:
        labels:
          type: array
          description: List of labels
          items:
            type: string
      description: Labels response model
    LabelsResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LabelsResponse'
    ListDirectoryPagesResponse:
      type: object
      properties:
        page:
          type: integer
          description: The page number
          format: int32
        size:
          type: integer
          description: The number of elements in the page
          format: int32
        totalSize:
          type: integer
          description: The total number of elements
          format: int64
        directoryPages:
          type: array
          description: The list of directory pages
          items:
            $ref: '#/components/schemas/DirectoryPageResponse'
      description: List Directory Pages Response Model
    ListDirectoryPagesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ListDirectoryPagesResponse'
    Listing:
      type: object
      properties:
        id:
          type: integer
          description: The id of the listing.
          format: int64
        type:
          type: string
          description: The directory where this listing appears.
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        syncStatus:
          type: string
          description: The listing's sync status.
          enum:
            - IN_SYNC
            - NOT_IN_SYNC
            - NOT_FOUND
            - TECHNICAL_PROBLEMS
            - NOT_SUPPORTED
            - NO_ONLINE_LISTING
            - LINK_ONLY
        claimStatus:
          type: string
          description: Claim status of the listing.
          enum:
            - CLAIMABLE
            - NOT_CLAIMABLE
            - CLAIMED_BY_US
            - CLAIMED_BY_OTHERS
            - CLAIMED_BY_ANOTHER_US
            - CLAIMING_IN_PROGRESS
            - UNKNOWN
        listingId:
          type: string
          description: The listing's id in the directory's database.
        listingUrl:
          type: string
          description: The listing's URL on the directory's website.
        data:
          type: object
          description: >-
            A map containing optional information about the listing, e.g.
            latestVisibilityIndex.
        lastChecked:
          type: string
          description: The last time the listing was sync-checked.
          format: date-time
        lastSuccessfulUpdate:
          type: string
          description: The last time the listing was successfully updated.
          format: date-time
        accountInfo:
          type: object
          description: >-
            A map consisting of the name and pageId of the connected account if
            the listing is either Google or Facebook.
        connectSecret:
          type: string
        connectStatus:
          type: string
          description: Connect status of the listing.
          enum:
            - CONNECTED
            - NOT_CONNECTED
            - NOT_NEEDED
        mandatoryFields:
          type: array
          description: Mandatory fields for the specific Directory that are not set yet
          items:
            type: string
            enum:
              - NAME
              - NAME_DESCRIPTOR
              - STREET_NO
              - STREET
              - STREET_TYPE
              - ADDRESS_EXTRA
              - PROVINCE
              - ZIP
              - CITY
              - COUNTRY
              - LATITUDE
              - LONGITUDE
              - ADDRESS_DISPLAY
              - SERVICE_AREAS
              - CATEGORIES
              - OPENING_DATE
              - PHONE
              - CELLPHONE
              - FAX
              - WEBSITE
              - WEBSITE_EXTRA
              - EMAIL
              - OPENINGHOURS
              - OPENINGHOURS_NOTES
              - SPECIAL_OPENINGHOURS
              - MORE_HOURS
              - KEYWORDS
              - DESCRIPTION_SHORT
              - DESCRIPTION_LONG
              - IMPRINT
              - LEGAL_IDENT
              - TAX_NUMBER
              - ATTRIBUTION
              - IS_PUBLISHED
              - SOCIAL_PROFILES
              - ATTRIBUTES
              - PAYMENT_OPTIONS
              - BRANDS
              - LANGUAGES
              - SERVICES
              - CONTENT_LISTS
              - PHOTOS
              - VIDEOS
              - SOCIAL_POST
              - DOCTOR_CATEGORIES
              - NPI
              - EV_DATA
              - TRANSACTION_LINKS
              - SUBLOCALITY
              - CUSTOM_FIELDS
        status:
          type: string
          description: The listing's status.
          enum:
            - ACTIVE
            - INACTIVE
            - MANUAL
        typeName:
          type: string
          description: The directory's name in the language of the current locale.
      description: Listing
    ListingDetails:
      type: object
      properties:
        id:
          type: integer
          description: The id of the listing details
          format: int64
        type:
          type: string
          description: The directory where this listing appears
        typeName:
          type: string
          description: Listing type / Publisher name
        listingUrl:
          type: string
          description: Listing URL
        category:
          type: string
          description: The category of the directory of this listing
          example: social, search
        mandatoryFieldsMissing:
          type: array
          description: >-
            Mandatory field missing on the location which prevents the data to
            be submitted to the publisher
          items:
            type: string
        directorySpecificData:
          type: object
          properties:
            requestAdminRightsUrl:
              type: string
            status:
              type: string
          description: >-
            Directory specific data. e.g. Google publishing states which can be
            UNVERIFIED, DISABLED, SUSPENDED, DUPLICATE.
        directoryContactDetails:
          description: >-
            Contact details of the publisher when the listing needs to be
            claimed
          allOf:
            - $ref: '#/components/schemas/DirectoryContactDetails'
        directoryConnectInfo:
          allOf:
            - $ref: '#/components/schemas/DirectoryConnectInfo'
        status:
          type: string
          description: >-
            Listing Status [SYNCED, SUBMITTED, UPDATING, ACTION_REQUIRED,
            LINKED]
          enum:
            - SYNCED
            - SUBMITTED
            - UPDATING
            - LINKED
            - ACTION_REQUIRED
        action:
          type: string
          description: >-
            Action Required [CONNECT, VERIFY, CLAIM, ADD_MANDATORY_FIELDS,
            ACCESS]
          enum:
            - CONNECT
            - VERIFY
            - CLAIM
            - ADD_MANDATORY_FIELDS
            - ACCESS
      description: Listing details model
    ListingDto:
      type: object
      description: Listing details containing directory information and connection status
    ListingHealth:
      type: object
      properties:
        countFieldsInSync:
          type: integer
          description: (Deprecated - will always return 0) The number of fields in sync
          format: int32
          deprecated: true
        countListingsInSync:
          type: integer
          description: The number of listings in sync
          format: int32
        countListingsSubmitted:
          type: integer
          description: >-
            The number of listings in successfully submitted. These listings
            don't have live sync checks.
          format: int32
        countListingsBeingUpdated:
          type: integer
          description: The number of listings which are in the process of being updated
          format: int32
        countListingsLinked:
          type: integer
          description: >-
            The number of listings which have been linked. These listings do not
            get updated.
          format: int32
        countListingsActionRequired:
          type: integer
          description: The number of listings where client action is required.
          format: int32
        countLocationsRequireSync:
          type: integer
          description: The number of locations which require to be syncronized
          format: int32
        countLocationsNeedsReview:
          type: integer
          description: The number of locations which are in needs review.
          format: int32
          deprecated: true
        directoriesMissingConnect:
          uniqueItems: true
          type: array
          description: The list of DirectoryType missing connection
          deprecated: true
          items:
            type: string
            enum:
              - FOURSQUARE
              - UBER
              - GOOGLE
              - WAZE
              - GOOGLE_MAPS
              - YELP
              - YELP_API
              - MEINESTADT
              - YELLOW_MAP
              - FOCUS
              - LOKALEAUSKUNFT
              - WEB_DE
              - GMX
              - ONE_AND_ONE
              - FREIEAUSKUNFT
              - POINTOO
              - NOKIA_HERE
              - FACEBOOK
              - TOMTOM
              - STADTBRANCHENBUCH
              - CYLEX
              - UNTERNEHMENSAUSKUNFT
              - ACOMPIO
              - BUSINESSBRANCHENBUCH
              - YALWA
              - THE_PHONEBOOK
              - SCOOT
              - CENTRAL_INDEX
              - CITIPAGES
              - ONE_NINE_TWO
              - ONE_ONE_EIGHT
              - THE_DAILY_RECORD
              - THE_EVENING_STANDARD
              - THE_SCOTSMAN
              - LIVERPOOL_ECHO
              - THE_SUN
              - THE_INDEPENDENT
              - TOUCH_LOCAL
              - THE_MIRROR
              - ANNUAIRE
              - INFOBEL
              - US_INFO_COM
              - GARMIN
              - FACTUAL
              - BING
              - WO_GIBTS_WAS
              - KOOMIO
              - ABCLOCAL
              - YELLBO
              - JELLOO
              - GUIDELOCAL
              - OEFFNUNGSZEITENBUCH
              - APPLE_MAPS
              - LOOCAL
              - REGIONAL_DE
              - WHERE_TO
              - TUPALO
              - GELBE_SEITEN
              - DAS_OERTLICHE
              - DIALO
              - BUNDES_TELEFONBUCH
              - BRANCHENBUCH_DEUTSCHLAND
              - MARKTPLATZ_MITTELSTAND
              - BUSQUEDA_LOCAL
              - RICERCARE_IMPRESE
              - PAGES24
              - NAVMII
              - AUDI
              - BMW
              - MERCEDES
              - VW
              - TOYOTA
              - FORD
              - FIAT
              - GM
              - ETRUSTED
              - INSTAGRAM
              - SHOPPING_TIME_NETWORK
              - CITY_SQUARES
              - SHOWMELOCAL
              - LOCALSTACK
              - CHAMBER_OF_COMMERCE
              - JUDYS_BOOK
              - BROWNBOOK
              - MY_LOCAL_SERVICES
              - YA_SABE
              - UNIVISION
              - AL_DIA_TX
              - LA_VOZ_TX
              - CHRON
              - STATESMAN
              - PALM_BEACH_POST
              - MUNDO_HISPANICO
              - EL_TIEMPO_LATINO
              - LATINOS_US
              - HOTFROG
              - INFO_IS_INFO
              - MANTA
              - US_CITY
              - GO_YELLOW
              - N49
              - PRATIQUE
              - JUSTACOTE
              - EZLOCAL
              - ELOCAL
              - TRUE_LOCAL
              - START_LOCAL
              - WOMO
              - AUSSIE_WEB
              - YELLOW_PAGES
              - SUPER_PAGES
              - WHITE_PAGES
              - DEX_KNOWS
              - KAUFDA_MANUAL
              - I_GLOBAL
              - BRANCHEN_INFO_MANUAL
              - GUTE_BANKEN_MANUAL
              - D_11880_COM_MANUAL
              - BANKOEFFNUNGSZEITEN_DE_MANUAL
              - BANK_OEFFNUNGSZEITEN_DE_MANUAL
              - CYLEX_MANUAL
              - FINDE_OFFEN_MANUAL
              - MEIN_PROSPEKT_MANUAL
              - DAS_SCHNELLE
              - SENSIS_WHITE_PAGES
              - SENSIS_TRUE_LOCAL
              - SENSIS_YELLOW_PAGES
              - FIND_OPEN
              - WAND
              - BELL_CA
              - GO_LOCAL
              - MEINUNGSMEISTER
              - YANDEX
              - YAHOO_MANUAL
              - HOLIDAY_CHECK
              - TRIP_ADVISOR
              - BONIAL_FR
              - ZIP_CH
              - PAGES_JAUNES
              - YELLOW_PAGES_SINGAPORE
              - INFOGROUP
              - WAZE_NEW
              - UBER_NEW
              - NEUSTAR
              - TRUSTPILOT
              - AUSKUNFT
              - BAIDU
              - NEXT_DOOR
              - MICROSOFT_CORTANA
              - GOOGLE_ASSISTANT
              - CBANQUE
              - ORANGE_118_712
              - SIRI
              - HUAWEI
              - DOCTOR_COM
              - CARE_DASH
              - DENTAL_PLANS
              - DOC_SPOT
              - HEALTHGRADES
              - SHARE_CARE
              - VITALS
              - WEB_MD
              - WELLNESS
              - ZOC_DOC
              - ZWIVEL
              - YP_COM_HEALTH
              - BING_HEALTH
              - NPPES
              - RATE_MDS
              - CITYSEARCH
              - INSIDER_PAGES
              - TWITTER
              - ALEXA
              - MAP_QUEST
              - WEBSITE_WIDGETS
              - ECO_MOVEMENT
              - GOOGLE_EV
              - APPLE_EV
              - TESLA_EV
              - EUROWAG_EV
              - OPIS_EV
              - TOMTOM_EV
              - HERE_EV
              - YELLOW_PAGES_CANADA
              - BBB
              - UBERALL_SOCIAL_ADS
              - APPLE_APPS
              - CONSUMER_AFFAIRS
              - CREDIT_KARMA
              - DELIVERY
              - GLASSDOOR
              - PLAY_GOOGLE
              - GRUBHUB
              - INDEED
              - LENDING_TREE
              - MENUISM
              - OPEN_TABLE
              - OPEN_TABLE_USA
              - WALLET_HUB
              - ZILLOW
              - ZOMATO
              - WHATS_APP
              - FOUR_SCREEN
              - AND_CHARGE
              - LINKED_IN
      description: ListingHealth Model
    ListingHealthWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ListingHealth'
    ListingsDetailsResponse:
      type: object
      properties:
        statistic:
          description: Statistics or count of listings in different statuses
          allOf:
            - $ref: '#/components/schemas/Statistic'
        listingsResponse:
          type: array
          description: Detailed response for the listings
          items:
            $ref: '#/components/schemas/ListingDetails'
        firstSyncStarted:
          type: string
          description: Date & time the first sync was started on the location.
          format: date-time
      description: Listings details response model
    ListingsDetailsResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ListingsDetailsResponse'
    Location:
      required:
        - city
        - country
        - name
        - street
      type: object
      properties:
        id:
          type: integer
          description: Output only. The uberall unique id for the location
          format: int64
        listings:
          uniqueItems: true
          type: array
          description: >-
            Output only. List of this location's online listings together with
            their sync status
          items:
            $ref: '#/components/schemas/Listing'
        openingHours:
          uniqueItems: true
          type: array
          description: >-
            The location's opening hours: e.g.

            <pre>[ &#123; 
                "dayOfWeek": 1,
                "closed": false,
                "from1": "08:00",
                "to1": "11:00"
              &#125;, 
              &#123;
                "dayOfWeek": 2,
                "closed": false,
                "from1": "08:00",
                "to1": "11:00",
                "from2": "13:00",
                "to2": "21:00"
              &#125;,
              &#123;
                "dayOfWeek": 3,
                "closed": true
              &#125;
            ]</pre>

            Please note that having more than 2 time periods for each day is not
            possible.
          example:
            - dayOfWeek: 1
              closed: false
              from1: '08:00'
              to1: '11:00'
            - dayOfWeek: 2
              closed: false
              from1: '08:00'
              to1: '11:00'
              from2: '13:00'
              to2: '21:00'
            - dayOfWeek: 3
              closed: true
          items:
            $ref: '#/components/schemas/OpeningHours'
        specialOpeningHours:
          uniqueItems: true
          type: array
          description: >-
            The location's special opening hours: e.g.

            <pre>[ &#123;

            "date": "2017-06-29",

            "closed": true

            &#125;,

            &#123;

            "date": "2017-06-30",

            "from1": "11:00",

            "to1": "14:00",

            "from2": 16:00",

            "to2": "20:00"

            &#125;

            ]</pre>

            Please note that having more than 2 time periods for each day is not
            possible.
          example:
            - date: '2017-06-29'
              closed: true
            - date: '2017-06-30'
              from1: '11:00'
              to1: '14:00'
              from2: '16:00'
              to2: '20:00'
          items:
            $ref: '#/components/schemas/SpecialOpeningHours'
        name:
          type: string
          description: The location's name
        street:
          type: string
          description: The location's street address
        streetNo:
          type: string
          description: The location's street number
        streetType:
          type: string
          description: >-
            Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER,
            CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA,
            RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
          enum:
            - ALAMEDA
            - AVENIDA
            - CALLE
            - CAMINO
            - CARRER
            - CARRETERA
            - GLORIETA
            - KALEA
            - PASAJE
            - PASEO
            - PLACA
            - PLAZA
            - RAMBLA
            - RONDA
            - RUA
            - SECTOR
            - TRAVESERA
            - TRAVESIA
            - URBANIZACION
        addressExtra:
          type: string
          description: 'An address extra: e.g. building, floor...'
          example: building, floor, ...
        zip:
          type: string
          description: Zip code, optional only for some countries.
        city:
          type: string
          description: City
        province:
          type: string
          description: Province. Only send when not blank
        country:
          type: string
          description: Country of the location
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        lat:
          type: number
          description: The latitude coordinate of the location
          format: double
        lng:
          type: number
          description: The longitude coordinate of the location
          format: double
        addressDisplay:
          type: boolean
          description: Indicates if the address should be displayed or hidden
        phone:
          type: string
          description: >-
            The location's contact phone number, a valid phone number has to be
            provided.
        fax:
          type: string
          description: The location fax number
        cellphone:
          type: string
          description: A contact mobile phone number
        website:
          type: string
          description: A valid url for the location's website (use UTMs to add tracking)
        email:
          type: string
          description: A contact email for the location
        legalIdent:
          type: string
          description: A legal identifier of the location. SIRET  number in France
        taxNumber:
          type: string
          description: The tax number of the location. CIF/NIF in Spain
        emailVerification:
          type: string
          description: The locations verification status
          enum:
            - UNVERIFIED
            - VERIFIED
        descriptionShort:
          type: string
          description: >-
            A short description - up to 200 characters, all characters must
            match this regexp: <pre>[0-9\p'{'L'}'\(\)\[\]
            \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²`´·"'\+¡¿@°€£$] </pre>
        descriptionLong:
          type: string
          description: >-
            A long description - up to 1000 characters, all characters must
            match this regexp: <pre>[0-9\p'{'L'}'\(\)\[\]
            \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²³`´·"'\+¡¿@°€\^£$] </pre>
        imprint:
          type: string
          description: The imprint of the location
        openingHoursNotes:
          type: string
          description: >-
            Additional info about opening hours: e.g. 'We never open on bank
            holidays' - max. 255 characters, all characters must match this
            regexp: <pre>[0-9\p'{'L'}'\(\)\[\]
            \?:;\/!\\,\.\-%\\&\r\n\t_\*§²`´·"'\+¡¿@] </pre>
          example: We never open on bank holidays
        keywords:
          type: array
          description: Keywords describing the location's activity
          items:
            type: string
        labels:
          uniqueItems: true
          type: array
          description: Labels grouping similar locations
          example: '[''Campaign2018'', ''EastCoast'']'
          items:
            $ref: '#/components/schemas/Label'
        brands:
          type: array
          description: The brands offered by the location to its customers
          items:
            type: string
        paymentOptions:
          uniqueItems: true
          type: array
          description: >-
            The payment options accepted at the location (eg. cash, bank
            transfer, ...)
          example:
            - cash
            - credit card
            - invoice
          items:
            type: string
        languages:
          uniqueItems: true
          type: array
          description: >-
            The language(s) in which customers can interact with the location's
            staff
          items:
            type: string
        categories:
          type: array
          description: >-
            Required to start location sync  - A list of category IDs describing
            the location
          items:
            $ref: '#/components/schemas/Category'
        status:
          type: string
          description: >-
            The status of the location. One of:

            <ul><li>ACTIVE - will be synced and renewed</li>

            <li>INACTIVE - will not be synced anymore, claims of listings will
            be released where possible</li>

            <li>CANCELLED - will be synced, will not be renewed. Once endDate is
            reached, location will switch to INACTIVE</li>

            <li>CLOSED - location has shut down, we'll mark listings as
            permanently closed or remove listings from the internet where
            permanently closed status is not supported</li></ul>
          enum:
            - CREATED
            - ACTIVE
            - INACTIVE
            - CANCELLED
            - DELETED
            - CLOSED
        lastSyncStarted:
          type: string
          description: Output only. Date of the last sync for the location
          format: date-time
        identifier:
          type: string
          description: The location identifier based on your internal identification system
        photos:
          type: array
          description: The location's photos
          items:
            $ref: '#/components/schemas/LocationPhoto'
        dateCreated:
          type: string
          description: >-
            Output only. The date and time the location was created in our
            database
          format: date-time
        lastUpdated:
          type: string
          description: >-
            Output only. Date of the last changes made to the location. Includes
            updates by users, API, location cleansing, and duplicate checks
          format: date-time
        autoSync:
          type: boolean
          description: >-
            When autosync is set to true, information changed for the location
            in Uberall will automatically be syncronized to all connected
            listings without the need to explicitly start a sync again after
            it's been started once.
        openingDate:
          type: string
          description: The date the location will first open. Must be formatted YYYY-MM-DD
          format: date
        serviceAreas:
          type: array
          description: Service areas available on the location.
          items:
            $ref: '#/components/schemas/ServiceArea'
        callTrackingNumbers:
          uniqueItems: true
          type: array
          description: >-
            Add call tracking numbers for distribution to Google, Facebook, and
            Bing. The call tracking numbers must be different from the
            location's primary phone number
          items:
            $ref: '#/components/schemas/CallTrackingNumber'
        utms:
          uniqueItems: true
          type: array
          description: >-
            UTM parameter to be appended to the location's website. Codes can be
            sent to Google, Facebook, and Bing.
          items:
            $ref: '#/components/schemas/UTM'
        transactionLinks:
          uniqueItems: true
          type: array
          description: >-
            Links that appear on some directories for specific types of customer
            actions, such as food ordering, appointment setting, and booking
            reservations. Only available for specific business categories.
          items:
            $ref: '#/components/schemas/LocationTransactionLink'
        temporarilyClosed:
          description: >-
            Set a location to temporarily closed with the ability to set a
            re-open date. Temporarily closed is best used if a location will be
            closed for more than seven days. If less than seven days, use
            special hours to show the location is closed.
          allOf:
            - $ref: '#/components/schemas/LocationTemporarilyClosed'
        features:
          uniqueItems: true
          type: array
          description: Output only. List of features available to the location
          items:
            type: string
            enum:
              - NEW_PHOTO_TYPES
              - ADS
              - ADS_READ
              - ADS_WRITE
              - ADVANCED_ANALYTICS
              - ADVANCED_ANALYTICS_2_0
              - AI_KNOWLEDGEBASE
              - AI_LOCALISATION
              - AI_LOCATION_INFORMATION
              - AI_SUGGESTED_REPLIES
              - APPLE_POSTING
              - APPLE_POSTING_WRITE
              - AUTO_RESPONSE
              - AUTO_RESPONSE_WRITE
              - AUTOMATION
              - BASIC
              - BASIC_PLUS
              - BULK_UPDATES
              - INSTAGRAM_POSTING
              - INSTAGRAM_POSTING_WRITE
              - LINKEDIN_POSTING
              - BUSINESS_LEVEL_CONNECT
              - CALL_TRACKING_NUMBERS
              - CAN_PAY_INVOICE
              - CAN_SEE_HELP_SECTION
              - CHATBOT
              - CHATBOT_READ
              - CHATBOT_WRITE
              - CHAT_READ
              - CHAT_WRITE
              - CLEANSING
              - CONTENT_COLLECTION
              - DAM
              - DASHBOARD
              - ENTERPRISE_ONBOARDING
              - FACEBOOK_UNOWNED_PAGE_CREATE
              - FACEBOOK_POSTING
              - FIRST_PARTY_REVIEW_APPROVAL
              - FORMS
              - GOOGLE_POSTING
              - HOMEPAGE
              - INBOX
              - INBOX_APPROVAL
              - INBOX_PREVIEW
              - INBOX_TEASER
              - INBOX_TWITTER
              - INBOX_READ
              - INBOX_WRITE
              - INBOX_2_0_BETA
              - INBOX_2_0_BETA_READ
              - INBOX_2_0_BETA_WRITE
              - INBOX_FLAG
              - LISTINGS
              - LIVE_CHAT
              - LOCAL_SEO_REPORT
              - LOCATION_APPROVAL_REQUESTS
              - LOCATION_GROUP
              - LOCATION_STATUS_CHANGE
              - LOCATION_TRANSLATION
              - LOCATION_READ
              - LOCATION_WRITE
              - LOCAL_INVENTORY
              - MANUAL_LISTINGS
              - NEAR_ME_CHECK
              - PHONE_OPTIONAL
              - OTHERS_POSTING
              - POSTING
              - POSTING_APPROVAL
              - POSTING_READ
              - POSTING_TONE_ADJUST
              - POSTING_WRITE
              - POSTING_PREVIEW
              - PRICE_INFO
              - QR_CODE_GENERATION
              - RESPONSE_LIBRARY
              - RESPONSE_LIBRARY_READ
              - RESPONSE_LIBRARY_WRITE
              - REVIEW_GENERATION_EMAIL
              - REVIEW_GENERATION_SMS
              - REVIEW_GENERATION_CREATE
              - REVIEW_GENERATION_SEND
              - LOCATION_APPROVAL
              - LOCATION_SCHEDULED_UPDATES
              - SINGLE_SIGN_ON
              - SOCIAL_ADS
              - STOREFINDER
              - STOREFINDER_TRIAL_MODE
              - LOCATOR_PAGES_BUILDER
              - STOREFINDER_ANALYTICS
              - STOREFINDER_GOOGLE
              - STOREFINDER_MAPBOX
              - SUPPORT
              - SUPPRESSION
              - TRACKING
              - TRANSACTION_LINKS
              - TWITTER_INBOX_READ
              - TWITTER_INBOX_WRITE
              - TWITTER_POSTING
              - TWITTER_POSTING_WRITE
              - UPGRADE
              - USER_OTHERS_EDIT
              - USER_SELF_EDIT
              - UTMS
              - WEBSITE_WIDGETS
              - EXPANDED_REVIEWS_RESTAURANT
              - EXPANDED_REVIEWS_FINANCE
              - WHATS_APP_MESSAGES
              - ACCESS_REQUEST_INVITATIONS
              - AI_BULK_REPLIES
              - SURVEYS
              - SURVEYS_READ
              - SURVEYS_WRITE
        nameDescriptor:
          type: string
          description: >-
            An addition to the location's name which gives specific info about
            the location's address (e.g. Mall level 2 OR Inside Departures).
            Sent only to FACEBOOK
        evData:
          description: >-
            A description of the EV Charging station's location. Used to help
            customers find the station more easily
          allOf:
            - $ref: '#/components/schemas/EvData'
        doctorComData:
          description: Description of the provider
          allOf:
            - $ref: '#/components/schemas/DoctorComData'
        socialPostId:
          type: integer
          format: int64
        customFields:
          type: array
          description: >-
            A Map for identifying the value input for a specific custom field
            name on the location. Custom fields are created at the business
            level.

            <pre>
              "customFields": [
                '{'
                  "name": "foo",
                  "value": "bar"
                '}',
                '{'
                  "name": "baz",
                  "value": "qux"
                '}'
              ]
            </pre>
          items:
            $ref: '#/components/schemas/CustomFieldsDetails'
        services:
          type: array
          description: >-
            Services offered at the location. Do not use if Content Collections
            is enabled. Instead use the Service Item and Collection endpoints
          items:
            $ref: '#/components/schemas/ServiceItem'
        timeZone:
          type: string
          description: The location's timezone
        videos:
          type: array
          description: The location's videos
          items:
            $ref: '#/components/schemas/Video'
        visibilityIndex:
          type: integer
          description: Output only. The location's latest visibility index
          format: int32
        activeDirectoriesCount:
          type: integer
          description: Output only. Number of active directories
          format: int32
        activeListingsCount:
          type: integer
          description: Output only. Number of active listings
          format: int32
        attributes:
          type: array
          description: Google attributes
          items:
            $ref: '#/components/schemas/AttributeWrapper'
        businessId:
          type: integer
          description: >-
            ID of the business this location is linked to. Mandatory when
            creating a location. Sending a different ID than the current
            businessId when updating will lead to changing the business. This is
            only possible in case all connected accounts (Facebook, Google, …)
            are compatible.
          format: int32
          example: 1234
        cleansingComment:
          type: string
          description: >-
            Cleansing comment by user, set only when cleansingStatus is
            INVALID_DATA.

            Possible Values (ADDRESS_DETAILS_VERIFIED,
            NAME_ADDRESS_DETAILS_UPDATED, NON_CLOSURE_CONFIRMATION,)
          enum:
            - ADDRESS_DETAILS_VERIFIED
            - NAME_ADDRESS_DETAILS_UPDATED
            - NON_CLOSURE_CONFIRMATION
        cleansingInvalidDataReason:
          type: string
          description: >-
            Output only. Invalid Cleansing Reason (eg.
            INCOMPLETE_ADDRESS,ADDRESS_ IS_PO_BOX,ADDRESS_ DOES_NOT_EXIST,
            LOCATION_IS_CLOSED, INFORMATION_IS_WRONG, LOCATION_IS_MOVED,
            NON_LATIN_CHARACTERS_ADDRESS, OTHER).

            Guide on how to fix invalid data issues -
            http://ubr.al/fix_invalid_data
        cleansingStatus:
          type: string
          description: >-
            Output only. Current cleansing status for the location. Possible
            values: NOT_CLEANSED, PENDING, CLEANSED, INVALID_DATA
          enum:
            - NOT_CLEANSED
            - PENDING
            - CLEANSED
            - INVALID_DATA
        contentLists:
          type: array
          description: >-
            The content list IDs (EVENTS, PRODUCTS, MENU, PEOPLE) describing the
            location
          items:
            type: integer
            format: int32
        dataPoints:
          type: integer
          description: >-
            Output only. Number of dataPoints (reviews, photos) left by users at
            this location
          format: int32
        listingsBeingUpdated:
          type: integer
          description: Output only. Number of listings still being updated
          format: int32
        listingsInSync:
          type: integer
          description: Output only. The number of listings in sync
          format: int32
        mainPhoto:
          description: The location's main picture
          allOf:
            - $ref: '#/components/schemas/LocationPhoto'
        missingMandatoryFields:
          uniqueItems: true
          type: array
          description: >-
            Output only. Compile all the fields that are currently missing but
            mandatory for some directories. They have to be set in the Location
            object, so that the Listing can be created / updated on the
            respective platform. List of Strings, e.g. [NAME, ZIP, PHONE]
          items:
            type: string
            enum:
              - NAME
              - NAME_DESCRIPTOR
              - STREET_NO
              - STREET
              - STREET_TYPE
              - ADDRESS_EXTRA
              - PROVINCE
              - ZIP
              - CITY
              - COUNTRY
              - LATITUDE
              - LONGITUDE
              - ADDRESS_DISPLAY
              - SERVICE_AREAS
              - CATEGORIES
              - OPENING_DATE
              - PHONE
              - CELLPHONE
              - FAX
              - WEBSITE
              - WEBSITE_EXTRA
              - EMAIL
              - OPENINGHOURS
              - OPENINGHOURS_NOTES
              - SPECIAL_OPENINGHOURS
              - MORE_HOURS
              - KEYWORDS
              - DESCRIPTION_SHORT
              - DESCRIPTION_LONG
              - IMPRINT
              - LEGAL_IDENT
              - TAX_NUMBER
              - ATTRIBUTION
              - IS_PUBLISHED
              - SOCIAL_PROFILES
              - ATTRIBUTES
              - PAYMENT_OPTIONS
              - BRANDS
              - LANGUAGES
              - SERVICES
              - CONTENT_LISTS
              - PHOTOS
              - VIDEOS
              - SOCIAL_POST
              - DOCTOR_CATEGORIES
              - NPI
              - EV_DATA
              - TRANSACTION_LINKS
              - SUBLOCALITY
              - CUSTOM_FIELDS
        moreHours:
          uniqueItems: true
          type: array
          description: >-
            The location's additional service hours, such as delivery, pickup,
            happy hours etc. Submitted to Google. e.g.

            <pre>[&#123;
                "type": "ONLINE_SERVICE_HOURS",
                "hours": [&#123;
                    "dayOfWeek": 1,
                    "from1": "09:00",
                    "to1": "18:00"
                &#125;, &#123;
                    "dayOfWeek": 2,
                    "from1": "09:00",
                    "to1": "13:00"
                &#125;]
            &#125;, &#123;
                "type": "ACCESS",
                "hours": [&#123;
                    "dayOfWeek": 1,
                    "from1": "06:00",
                    "to1": "20:00"
                &#125;]
            &#125;]</pre>
          items:
            $ref: '#/components/schemas/MoreHoursResponse'
        profileCompleteness:
          type: integer
          description: >-
            Output only. Number representing completeness of location data, up
            to 100
          format: int32
        publishedListingsCount:
          type: integer
          description: Output only. Number of published listings
          format: int32
        socialProfiles:
          uniqueItems: true
          type: array
          description: >-
            The profiles of the location on social and professional networks
            (FACEBOOK, FOURSQUARE, INSTAGRAM, LINKEDIN, PINTEREST, TWITTER,
            VIMEO, XING, YOUTUBE)
          items:
            $ref: '#/components/schemas/SocialProfile'
      description: Location
    LocationConnectionDetails:
      type: object
      properties:
        id:
          type: integer
          description: ID of the entity
          format: int64
          example: 123
        name:
          type: string
          description: Name of the entity
          example: Sample Business
        addressLine1:
          type: string
          description: Street and number
          example: 123 Main St
        city:
          type: string
          description: City name
          example: New York
        zip:
          type: string
          description: ZIP/Postal code
          example: '10001'
        country:
          type: string
          description: Country code
          example: US
        streetNo:
          type: string
          description: Street Number
          example: '123'
        street:
          type: string
          description: Street
          example: Main St
        businessId:
          type: integer
          description: Business ID
          format: int64
          example: 456
        type:
          type: string
          description: Type of the directory
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        connectSecret:
          type: string
          description: Connection secret for authentication
        listingId:
          type: integer
          description: Listing ID
          format: int64
          example: 789
    LocationDashboardResponse:
      type: object
      properties:
        stats:
          description: Statistics related to the current location
          allOf:
            - $ref: '#/components/schemas/LocationDashboardStatistics'
        location:
          description: The location linked to this dashboard
          allOf:
            - $ref: '#/components/schemas/DashboardLocation'
        todos:
          type: object
          description: Todos related to the current location
      description: Location dashboard response model
    LocationDashboardResponseObject:
      type: object
      properties:
        dashboard:
          allOf:
            - $ref: '#/components/schemas/LocationDashboardResponse'
      description: The actual response object of the response
    LocationDashboardResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationDashboardResponseObject'
    LocationDashboardStatistics:
      type: object
      properties:
        activeDirectoriesCount:
          type: integer
          description: Output only. Number of active directories
          format: int32
        activeListingsCount:
          type: integer
          description: Output only. Number of active listings
          format: int32
        inboxActive:
          type: string
          description: ACTIVE if the inbox feature is included in the plan
        inboxTotal:
          type: integer
          description: Total number of datapoints
          format: int32
        inboxPhotos:
          type: integer
          description: Number of photo datapoints
          format: int32
        inboxReviews:
          type: integer
          description: Number of review datapoints
          format: int32
        managersCount:
          type: integer
          description: Number of users that manage this location
          format: int32
        profileCompleteness:
          type: integer
          description: Percentage of profile completeness
          format: int32
        publishedListingsCount:
          type: integer
          description: Number of managed online listings
          format: int32
        synced:
          type: integer
          description: Number of synced listings
          format: int32
        visibilityIndex:
          description: Latest visibility index
          allOf:
            - $ref: '#/components/schemas/VisibilityIndex'
        activeDirectories:
          type: array
          description: List of active directories
          items:
            type: string
        inactiveDirectories:
          type: array
          description: List of inactive directories
          items:
            type: string
        unfilledFields:
          type: array
          description: Unfilled location fields
          items:
            type: string
      description: Location dashboard statistics model
    LocationDetails:
      type: object
      properties:
        id:
          type: integer
          description: ID of the location
          format: int64
          example: 1
        name:
          type: string
          description: Name of the location
          example: Location 1
        status:
          type: string
          description: Status of the location
          example: ACTIVE
          enum:
            - CREATED
            - ACTIVE
            - INACTIVE
            - CANCELLED
            - DELETED
            - CLOSED
    LocationFeatureResponse:
      type: object
      properties:
        id:
          type: integer
          description: The id of the location.
          format: int64
        businessId:
          type: integer
          description: Business the location belongs to.
          format: int64
        currentFeatures:
          type: array
          description: The features enabled for the location.
          items:
            type: string
            enum:
              - NEW_PHOTO_TYPES
              - ADS
              - ADS_READ
              - ADS_WRITE
              - ADVANCED_ANALYTICS
              - ADVANCED_ANALYTICS_2_0
              - AI_KNOWLEDGEBASE
              - AI_LOCALISATION
              - AI_LOCATION_INFORMATION
              - AI_SUGGESTED_REPLIES
              - APPLE_POSTING
              - APPLE_POSTING_WRITE
              - AUTO_RESPONSE
              - AUTO_RESPONSE_WRITE
              - AUTOMATION
              - BASIC
              - BASIC_PLUS
              - BULK_UPDATES
              - INSTAGRAM_POSTING
              - INSTAGRAM_POSTING_WRITE
              - LINKEDIN_POSTING
              - BUSINESS_LEVEL_CONNECT
              - CALL_TRACKING_NUMBERS
              - CAN_PAY_INVOICE
              - CAN_SEE_HELP_SECTION
              - CHATBOT
              - CHATBOT_READ
              - CHATBOT_WRITE
              - CHAT_READ
              - CHAT_WRITE
              - CLEANSING
              - CONTENT_COLLECTION
              - DAM
              - DASHBOARD
              - ENTERPRISE_ONBOARDING
              - FACEBOOK_UNOWNED_PAGE_CREATE
              - FACEBOOK_POSTING
              - FIRST_PARTY_REVIEW_APPROVAL
              - FORMS
              - GOOGLE_POSTING
              - HOMEPAGE
              - INBOX
              - INBOX_APPROVAL
              - INBOX_PREVIEW
              - INBOX_TEASER
              - INBOX_TWITTER
              - INBOX_READ
              - INBOX_WRITE
              - INBOX_2_0_BETA
              - INBOX_2_0_BETA_READ
              - INBOX_2_0_BETA_WRITE
              - INBOX_FLAG
              - LISTINGS
              - LIVE_CHAT
              - LOCAL_SEO_REPORT
              - LOCATION_APPROVAL_REQUESTS
              - LOCATION_GROUP
              - LOCATION_STATUS_CHANGE
              - LOCATION_TRANSLATION
              - LOCATION_READ
              - LOCATION_WRITE
              - LOCAL_INVENTORY
              - MANUAL_LISTINGS
              - NEAR_ME_CHECK
              - PHONE_OPTIONAL
              - OTHERS_POSTING
              - POSTING
              - POSTING_APPROVAL
              - POSTING_READ
              - POSTING_TONE_ADJUST
              - POSTING_WRITE
              - POSTING_PREVIEW
              - PRICE_INFO
              - QR_CODE_GENERATION
              - RESPONSE_LIBRARY
              - RESPONSE_LIBRARY_READ
              - RESPONSE_LIBRARY_WRITE
              - REVIEW_GENERATION_EMAIL
              - REVIEW_GENERATION_SMS
              - REVIEW_GENERATION_CREATE
              - REVIEW_GENERATION_SEND
              - LOCATION_APPROVAL
              - LOCATION_SCHEDULED_UPDATES
              - SINGLE_SIGN_ON
              - SOCIAL_ADS
              - STOREFINDER
              - STOREFINDER_TRIAL_MODE
              - LOCATOR_PAGES_BUILDER
              - STOREFINDER_ANALYTICS
              - STOREFINDER_GOOGLE
              - STOREFINDER_MAPBOX
              - SUPPORT
              - SUPPRESSION
              - TRACKING
              - TRANSACTION_LINKS
              - TWITTER_INBOX_READ
              - TWITTER_INBOX_WRITE
              - TWITTER_POSTING
              - TWITTER_POSTING_WRITE
              - UPGRADE
              - USER_OTHERS_EDIT
              - USER_SELF_EDIT
              - UTMS
              - WEBSITE_WIDGETS
              - EXPANDED_REVIEWS_RESTAURANT
              - EXPANDED_REVIEWS_FINANCE
              - WHATS_APP_MESSAGES
              - ACCESS_REQUEST_INVITATIONS
              - AI_BULK_REPLIES
              - SURVEYS
              - SURVEYS_READ
              - SURVEYS_WRITE
        potentialFeatures:
          uniqueItems: true
          type: array
          description: >-
            Features that are currently not available for this location, but can
            potentially be enabled.
          items:
            type: string
            enum:
              - NEW_PHOTO_TYPES
              - ADS
              - ADS_READ
              - ADS_WRITE
              - ADVANCED_ANALYTICS
              - ADVANCED_ANALYTICS_2_0
              - AI_KNOWLEDGEBASE
              - AI_LOCALISATION
              - AI_LOCATION_INFORMATION
              - AI_SUGGESTED_REPLIES
              - APPLE_POSTING
              - APPLE_POSTING_WRITE
              - AUTO_RESPONSE
              - AUTO_RESPONSE_WRITE
              - AUTOMATION
              - BASIC
              - BASIC_PLUS
              - BULK_UPDATES
              - INSTAGRAM_POSTING
              - INSTAGRAM_POSTING_WRITE
              - LINKEDIN_POSTING
              - BUSINESS_LEVEL_CONNECT
              - CALL_TRACKING_NUMBERS
              - CAN_PAY_INVOICE
              - CAN_SEE_HELP_SECTION
              - CHATBOT
              - CHATBOT_READ
              - CHATBOT_WRITE
              - CHAT_READ
              - CHAT_WRITE
              - CLEANSING
              - CONTENT_COLLECTION
              - DAM
              - DASHBOARD
              - ENTERPRISE_ONBOARDING
              - FACEBOOK_UNOWNED_PAGE_CREATE
              - FACEBOOK_POSTING
              - FIRST_PARTY_REVIEW_APPROVAL
              - FORMS
              - GOOGLE_POSTING
              - HOMEPAGE
              - INBOX
              - INBOX_APPROVAL
              - INBOX_PREVIEW
              - INBOX_TEASER
              - INBOX_TWITTER
              - INBOX_READ
              - INBOX_WRITE
              - INBOX_2_0_BETA
              - INBOX_2_0_BETA_READ
              - INBOX_2_0_BETA_WRITE
              - INBOX_FLAG
              - LISTINGS
              - LIVE_CHAT
              - LOCAL_SEO_REPORT
              - LOCATION_APPROVAL_REQUESTS
              - LOCATION_GROUP
              - LOCATION_STATUS_CHANGE
              - LOCATION_TRANSLATION
              - LOCATION_READ
              - LOCATION_WRITE
              - LOCAL_INVENTORY
              - MANUAL_LISTINGS
              - NEAR_ME_CHECK
              - PHONE_OPTIONAL
              - OTHERS_POSTING
              - POSTING
              - POSTING_APPROVAL
              - POSTING_READ
              - POSTING_TONE_ADJUST
              - POSTING_WRITE
              - POSTING_PREVIEW
              - PRICE_INFO
              - QR_CODE_GENERATION
              - RESPONSE_LIBRARY
              - RESPONSE_LIBRARY_READ
              - RESPONSE_LIBRARY_WRITE
              - REVIEW_GENERATION_EMAIL
              - REVIEW_GENERATION_SMS
              - REVIEW_GENERATION_CREATE
              - REVIEW_GENERATION_SEND
              - LOCATION_APPROVAL
              - LOCATION_SCHEDULED_UPDATES
              - SINGLE_SIGN_ON
              - SOCIAL_ADS
              - STOREFINDER
              - STOREFINDER_TRIAL_MODE
              - LOCATOR_PAGES_BUILDER
              - STOREFINDER_ANALYTICS
              - STOREFINDER_GOOGLE
              - STOREFINDER_MAPBOX
              - SUPPORT
              - SUPPRESSION
              - TRACKING
              - TRANSACTION_LINKS
              - TWITTER_INBOX_READ
              - TWITTER_INBOX_WRITE
              - TWITTER_POSTING
              - TWITTER_POSTING_WRITE
              - UPGRADE
              - USER_OTHERS_EDIT
              - USER_SELF_EDIT
              - UTMS
              - WEBSITE_WIDGETS
              - EXPANDED_REVIEWS_RESTAURANT
              - EXPANDED_REVIEWS_FINANCE
              - WHATS_APP_MESSAGES
              - ACCESS_REQUEST_INVITATIONS
              - AI_BULK_REPLIES
              - SURVEYS
              - SURVEYS_READ
              - SURVEYS_WRITE
        limitReached:
          uniqueItems: true
          type: array
          description: >-
            indicates if location has reached its limit for given set of
            Features
          items:
            type: string
            enum:
              - NEW_PHOTO_TYPES
              - ADS
              - ADS_READ
              - ADS_WRITE
              - ADVANCED_ANALYTICS
              - ADVANCED_ANALYTICS_2_0
              - AI_KNOWLEDGEBASE
              - AI_LOCALISATION
              - AI_LOCATION_INFORMATION
              - AI_SUGGESTED_REPLIES
              - APPLE_POSTING
              - APPLE_POSTING_WRITE
              - AUTO_RESPONSE
              - AUTO_RESPONSE_WRITE
              - AUTOMATION
              - BASIC
              - BASIC_PLUS
              - BULK_UPDATES
              - INSTAGRAM_POSTING
              - INSTAGRAM_POSTING_WRITE
              - LINKEDIN_POSTING
              - BUSINESS_LEVEL_CONNECT
              - CALL_TRACKING_NUMBERS
              - CAN_PAY_INVOICE
              - CAN_SEE_HELP_SECTION
              - CHATBOT
              - CHATBOT_READ
              - CHATBOT_WRITE
              - CHAT_READ
              - CHAT_WRITE
              - CLEANSING
              - CONTENT_COLLECTION
              - DAM
              - DASHBOARD
              - ENTERPRISE_ONBOARDING
              - FACEBOOK_UNOWNED_PAGE_CREATE
              - FACEBOOK_POSTING
              - FIRST_PARTY_REVIEW_APPROVAL
              - FORMS
              - GOOGLE_POSTING
              - HOMEPAGE
              - INBOX
              - INBOX_APPROVAL
              - INBOX_PREVIEW
              - INBOX_TEASER
              - INBOX_TWITTER
              - INBOX_READ
              - INBOX_WRITE
              - INBOX_2_0_BETA
              - INBOX_2_0_BETA_READ
              - INBOX_2_0_BETA_WRITE
              - INBOX_FLAG
              - LISTINGS
              - LIVE_CHAT
              - LOCAL_SEO_REPORT
              - LOCATION_APPROVAL_REQUESTS
              - LOCATION_GROUP
              - LOCATION_STATUS_CHANGE
              - LOCATION_TRANSLATION
              - LOCATION_READ
              - LOCATION_WRITE
              - LOCAL_INVENTORY
              - MANUAL_LISTINGS
              - NEAR_ME_CHECK
              - PHONE_OPTIONAL
              - OTHERS_POSTING
              - POSTING
              - POSTING_APPROVAL
              - POSTING_READ
              - POSTING_TONE_ADJUST
              - POSTING_WRITE
              - POSTING_PREVIEW
              - PRICE_INFO
              - QR_CODE_GENERATION
              - RESPONSE_LIBRARY
              - RESPONSE_LIBRARY_READ
              - RESPONSE_LIBRARY_WRITE
              - REVIEW_GENERATION_EMAIL
              - REVIEW_GENERATION_SMS
              - REVIEW_GENERATION_CREATE
              - REVIEW_GENERATION_SEND
              - LOCATION_APPROVAL
              - LOCATION_SCHEDULED_UPDATES
              - SINGLE_SIGN_ON
              - SOCIAL_ADS
              - STOREFINDER
              - STOREFINDER_TRIAL_MODE
              - LOCATOR_PAGES_BUILDER
              - STOREFINDER_ANALYTICS
              - STOREFINDER_GOOGLE
              - STOREFINDER_MAPBOX
              - SUPPORT
              - SUPPRESSION
              - TRACKING
              - TRANSACTION_LINKS
              - TWITTER_INBOX_READ
              - TWITTER_INBOX_WRITE
              - TWITTER_POSTING
              - TWITTER_POSTING_WRITE
              - UPGRADE
              - USER_OTHERS_EDIT
              - USER_SELF_EDIT
              - UTMS
              - WEBSITE_WIDGETS
              - EXPANDED_REVIEWS_RESTAURANT
              - EXPANDED_REVIEWS_FINANCE
              - WHATS_APP_MESSAGES
              - ACCESS_REQUEST_INVITATIONS
              - AI_BULK_REPLIES
              - SURVEYS
              - SURVEYS_READ
              - SURVEYS_WRITE
        status:
          type: string
          description: Status of the location
          enum:
            - CREATED
            - ACTIVE
            - INACTIVE
            - CANCELLED
            - DELETED
            - CLOSED
      description: Location Feature Response Model
    LocationGroupListResponseModel:
      type: object
      properties:
        locationGroups:
          type: array
          description: The location groups
          items:
            $ref: '#/components/schemas/LocationGroupModel'
        count:
          type: integer
          description: The total number of location groups
          format: int32
        pageSize:
          type: integer
          description: The number of location groups per page
          format: int32
        max:
          type: integer
          description: The maximum number of location groups
          format: int32
        offset:
          type: integer
          description: The offset
          format: int32
        page:
          type: integer
          description: The page
          format: int32
      description: The actual response object of the response
    LocationGroupListResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationGroupListResponseModel'
    LocationGroupModel:
      type: object
      properties:
        id:
          type: integer
          description: ID of the LocationGroup.
          format: int64
        lastUpdated:
          type: string
          description: Last updated date of the Location Group
          format: date-time
        name:
          type: string
          description: Name of the LocationGroup.
        status:
          type: string
          description: Status of the Location Group
          enum:
            - ACTIVE
            - DELETED
        creator:
          type: integer
          format: int64
        salesPartner:
          type: integer
          format: int64
        locationsCount:
          type: integer
          format: int32
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationDetails'
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserDetails'
      description: The actual response object of the response
    LocationGroupParams:
      required:
        - name
      type: object
      properties:
        name:
          type: string
          description: Name (String) of the LocationGroup
        status:
          type: string
          description: >-
            Status of the LocationGroup, defaults to "ACTIVE", supported values:
            ["ACTIVE"].
          enum:
            - ACTIVE
            - DELETED
        locations:
          type: array
          description: >-
            List of location IDs (Long) that shall be assigned to the new
            LocationGroup.
          items:
            type: integer
            format: int64
        users:
          type: array
          description: >-
            List of user IDs (Long) that shall be assigned to the new
            LocationGroup.
          items:
            type: integer
            format: int64
      description: LocationGroup parameters model
    LocationGroupPatchParams:
      type: object
      properties:
        name:
          type: string
          description: Name (String) of the LocationGroup
        status:
          type: string
          description: >-
            Status of the LocationGroup, defaults to "ACTIVE", supported values:
            ["ACTIVE"].
          enum:
            - ACTIVE
            - DELETED
        locations:
          type: array
          description: >-
            List of location IDs (Long) that shall be assigned to the new
            LocationGroup.
                                    For clearing this field you can send either null or an empty list [].
          items:
            type: integer
            format: int64
        users:
          type: array
          description: >-
            List of user IDs (Long) that shall be assigned to the new
            LocationGroup. For clearing this field you can send either null or
            an empty list [].
          items:
            type: integer
            format: int64
    LocationGroupWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationGroupModel'
    LocationImport:
      type: object
      description: The actual response object of the response
    LocationImportListObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for the current page
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of items per page
          format: int32
          example: 10
        count:
          type: integer
          description: Total count of location imports
          format: int32
          example: 100
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationImport'
      description: The actual response object of the response
    LocationImportListWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationImportListObject'
    LocationManagersCount:
      type: object
      properties:
        managersCount:
          type: integer
          description: The number of managers managing the location
          format: int32
      description: Location Managers Count Model
    LocationManagersCountWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationManagersCount'
    LocationObject:
      type: object
      properties:
        location:
          allOf:
            - $ref: '#/components/schemas/Location'
      description: The actual response object of the response
    LocationPhoto:
      required:
        - type
        - url
      type: object
      properties:
        description:
          type: string
          description: A description for the photo - max 255 chars
        sourceUrl:
          type: string
          description: The URL to the original photo
        identifier:
          type: string
          description: The photo identifier based on your internal identification system
        cropOffsetX:
          type: integer
          description: >-
            Horizontal pixel offset of the top-left corner of the cropped area
            [LANDSCAPE photo only]
          format: int32
        cropOffsetY:
          type: integer
          description: >-
            Vertical pixel offset of the top-left corner of the cropped area
            [LANDSCAPE photo only]
          format: int32
        cropWidth:
          type: integer
          description: Width of the 16:9 cropped area [LANDSCAPE photo only]
          format: int32
        cropHeight:
          type: integer
          description: Height of the 16:9 cropped area [LANDSCAPE photo only]
          format: int32
        type:
          type: string
          description: >-
            Required - One of: <br>


            MAIN <br>

            LOGO <br>

            SQUARED_LOGO <br>

            DOCTOR_COM_PORTRAIT - Doctor.com clients only <br>

            LANDSCAPE - Updates Google Cover Photo<br>

            APPLE_LANDSCAPE <br>

            PHOTO  <br>

            STOREFINDER_LOGO - Only for Uberall locator product <br>

            STOREFINDER_COVER - Only for Uberall locator product<br>

            FACEBOOK_LANDSCAPE - Facebook Cover Photo <br>

            EXTERIOR - Google's Exterior Photo tag - availability dependent on a
            location's business category <br>

            INTERIOR - Google's Interior Photo tag  - availability dependent on
            a location's business category <br>

            FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability
            dependent on a location's business category  <br>

            MENU  - Google's Menu Photo tag, which should only be photos of the
            menu - availability dependent on a location's business category <br>

            PRODUCT  - Google's Product Photo tag - availability dependent on a
            location's business category <br>

            TEAMS  - Google's Teams Photo tag - availability dependent on a
            location's business category <br>

            AT_WORK  - Google's At Work Photo tag - availability dependent on a
            location's business category <br>

            COMMON_AREA  - Google's Common Area Photo tag - availability
            dependent on a location's business category <br>

            ROOMS - Google's Rooms Photo tag - availability dependent on a
            location's business category
          enum:
            - MAIN
            - DOCTOR_COM_PORTRAIT
            - LOGO
            - STOREFINDER_LOGO
            - SQUARED_LOGO
            - LANDSCAPE
            - STOREFINDER_COVER
            - FACEBOOK_LANDSCAPE
            - APPLE_LANDSCAPE
            - MENU
            - PHOTO
            - ROOMS
            - TEAMS
            - AT_WORK
            - PRODUCT
            - EXTERIOR
            - INTERIOR
            - COMMON_AREA
            - FOOD_AND_DRINK
        order:
          type: integer
          description: Sets the order in which the photos should be shown
          format: int32
        dateCreated:
          type: string
          description: The date when the object was created in uberall database
          format: date-time
        lastUpdated:
          type: string
          description: Date of the last changes made to the photo
          format: date-time
        url:
          type: string
          description: url of the photo
      description: Location Photo
    LocationPhotoResponse:
      required:
        - type
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id for the photo
          format: int64
        dateCreated:
          type: string
          description: The date when the object was created in uberall database
          format: date-time
        repoKey:
          type: string
          description: File name
        locationId:
          type: integer
          description: The uberall unique id of this photo's location
          format: int64
        description:
          type: string
          description: A description for the photo
        identifier:
          type: string
          description: The photo identifier based on your internal identification system
        main:
          type: boolean
          description: >-
            A boolean indicating whether this photo is the location's main
            photo. Maximum one per location
        logo:
          type: boolean
          description: >-
            A boolean indicating whether this photo is the location's logo.
            Maximum one logo per location
        type:
          type: string
          description: >-
            Required - One of: <br>


            MAIN <br>

            LOGO <br>

            SQUARED_LOGO <br>

            DOCTOR_COM_PORTRAIT - Doctor.com clients only <br>

            LANDSCAPE - Updates Google Cover Photo<br>

            APPLE_LANDSCAPE <br>

            PHOTO  <br>

            STOREFINDER_LOGO - Only for Uberall locator product <br>

            STOREFINDER_COVER - Only for Uberall locator product<br>

            FACEBOOK_LANDSCAPE - Facebook Cover Photo <br>

            EXTERIOR - Google's Exterior Photo tag - availability dependent on a
            location's business category <br>

            INTERIOR - Google's Interior Photo tag  - availability dependent on
            a location's business category <br>

            FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability
            dependent on a location's business category  <br>

            MENU  - Google's Menu Photo tag, which should only be photos of the
            menu - availability dependent on a location's business category <br>

            PRODUCT  - Google's Product Photo tag - availability dependent on a
            location's business category <br>

            TEAMS  - Google's Teams Photo tag - availability dependent on a
            location's business category <br>

            AT_WORK  - Google's At Work Photo tag - availability dependent on a
            location's business category <br>

            COMMON_AREA  - Google's Common Area Photo tag - availability
            dependent on a location's business category <br>

            ROOMS - Google's Rooms Photo tag - availability dependent on a
            location's business category
        publicUrl:
          type: string
          description: A public url for this photo
        thumbnailUrl:
          type: string
          description: Url for the image thumbnail
        cropOffsetX:
          type: integer
          description: >-
            Horizontal pixel offset of the top-left corner of the cropped area
            [LANDSCAPE photo only]
          format: int32
        cropOffsetY:
          type: integer
          description: >-
            Vertical pixel offset of the top-left corner of the cropped area
            [LANDSCAPE photo only]
          format: int32
        cropWidth:
          type: integer
          description: Width of the 16:9 cropped area [LANDSCAPE photo only]
          format: int32
        cropHeight:
          type: integer
          description: Height of the 16:9 cropped area [LANDSCAPE photo only]
          format: int32
        sourceUrl:
          type: string
          description: The client supplied url for a photo
      description: Location photo response model
    LocationPhotoResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationPhotoResponse'
    LocationResponse:
      type: object
      properties:
        location:
          description: A complete Location object
          allOf:
            - $ref: '#/components/schemas/Location'
        suggestionsForFields:
          type: array
          description: >-
            Map containing fields and the suggested values from different
            directories.
          items:
            $ref: '#/components/schemas/SuggestionsForFieldsDetails'
        suggestionsForFieldsAvailable:
          type: boolean
          description: true if any suggetions are available
      description: Location Response Model
    LocationResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationResponse'
    LocationSearchParams:
      type: object
      description: LocationSearchParams
    LocationSearchResponse:
      type: object
      properties:
        offset:
          type: integer
          format: int32
        max:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
        locations:
          type: array
          items:
            $ref: '#/components/schemas/StoreFinderResponse'
      description: Response containing store finder location search data
    LocationSearchResponseObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        count:
          type: integer
          description: Total count of results
          format: int32
          example: 100
        locations:
          type: array
          items:
            $ref: '#/components/schemas/LocationSearchResult'
      description: The actual response object of the response
    LocationSearchResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationSearchResponseObject'
    LocationSearchResult:
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id for the location
          format: int64
        identifier:
          type: string
          description: The location identifier based on your internal identification system
        name:
          type: string
          description: The location's name
        street:
          type: string
          description: The location's street address
        streetNo:
          type: string
          description: The location's street number
        streetType:
          type: string
          description: >-
            Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER,
            CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA,
            RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
          enum:
            - ALAMEDA
            - AVENIDA
            - CALLE
            - CAMINO
            - CARRER
            - CARRETERA
            - GLORIETA
            - KALEA
            - PASAJE
            - PASEO
            - PLACA
            - PLAZA
            - RAMBLA
            - RONDA
            - RUA
            - SECTOR
            - TRAVESERA
            - TRAVESIA
            - URBANIZACION
        addressExtra:
          type: string
          description: 'An address extra: e.g. building, floor...'
          example: building, floor...
        addressDisplay:
          type: boolean
          description: >-
            If set to false, directories are either not given address details or
            told not to display them. There are few directories where this is
            not possible, that hence might not receive data at all.
        zip:
          type: string
          description: Zip code
        city:
          type: string
          description: City
        province:
          type: string
          description: Province. Only send when not blank
        country:
          type: string
          description: Country. One of AT, CH, DE, ES, UK, FR, IT, NL
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        lat:
          type: number
          description: The latitude coordinate of the location
          format: double
        lng:
          type: number
          description: The longitude coordinate of the location
          format: double
        locationSyncable:
          type: boolean
          description: >-
            Boolean indicating whether the location has been updated and can be
            synced
        phone:
          type: string
          description: The location's contact phone number
        fax:
          type: string
          description: The location fax number
        cellphone:
          type: string
          description: A contact mobile phone number
        website:
          type: string
          description: A valid url for the location's website (use UTMs to add tracking)
        email:
          type: string
          description: A contact email for the location
        hasFacebook:
          type: boolean
          description: >-
            Boolean indicating whether the location has support Facebook
            included in its product plan
        legalIdent:
          type: string
          description: A legal identifier of the location. SIRET number in France
        taxNumber:
          type: string
          description: The tax number of the location. CIF/NIF in Spain
        descriptionShort:
          type: string
          description: A short description (up to 200 characters) for the location
        descriptionLong:
          type: string
          description: A long description (up to 1000 characters) for the location
        imprint:
          type: string
          description: imprint of the location
        openingHoursNotes:
          maxLength: 255
          type: string
          description: >-
            Additional info about opening hours: e.g. 'We never open on bank
            holidays' - max. 255 characters
          example: We never open on bank holidays
        openingHours:
          uniqueItems: true
          type: array
          description: >-
            The location's opening hours: e.g.

            <pre>[ &#123; 
                "dayOfWeek": 1,
                "closed": false,
                "from1": "08:00",
                "to1": "11:00"
              &#125;, 
              &#123;
                "dayOfWeek": 2,
                "closed": false,
                "from1": "08:00",
                "to1": "11:00",
                "from2": "13:00",
                "to2": "21:00"
              &#125;,
              &#123;
                "dayOfWeek": 3,
                "closed": true
              &#125;
            ]</pre>

            Please note that having more than 2 time periods for each day is not
            possible.
          example:
            - dayOfWeek: 1
              closed: false
              from1: '08:00'
              to1: '11:00'
            - dayOfWeek: 2
              closed: false
              from1: '08:00'
              to1: '11:00'
              from2: '13:00'
              to2: '21:00'
            - dayOfWeek: 3
              closed: true
          items:
            $ref: '#/components/schemas/OpeningHours'
        specialOpeningHours:
          uniqueItems: true
          type: array
          description: >-
            The location's special opening hours: e.g.

            <pre>[ &#123;

            "date": "2017-06-29",

            "closed": true

            &#125;,

            &#123;

            "date": "2017-06-30",

            "from1": "11:00",

            "to1": "14:00",

            "from2": "16:00",

            "to2": "20:00"

            &#125;

            ]</pre>

            Please note that having more than 2 time periods for each day is not
            possible.
          example:
            - date: '2017-06-29'
              closed: true
            - date: '2017-06-30'
              from1: '11:00'
              to1: '14:00'
              from2: '16:00'
              to2: '20:00'
          items:
            $ref: '#/components/schemas/SpecialOpeningHours'
        openNow:
          type: boolean
          description: >-
            Used for store finder. Boolean indicating whether the location is
            currently open
        keywords:
          type: array
          description: Keywords describing the location's activity
          items:
            type: string
        labels:
          uniqueItems: true
          type: array
          description: Labels grouping similar locations
          example: '[''Campaign2018'', ''EastCoast'']'
          items:
            $ref: '#/components/schemas/Label'
        categories:
          type: array
          description: Required - A list of category IDs describing the location
          items:
            type: integer
            format: int64
        attributes:
          type: array
          description: The location's Google attributes
          items:
            $ref: '#/components/schemas/AttributeWrapper'
        status:
          type: string
          description: >-
            The status of the location. One of:

            <ul><li>ACTIVE - will be synced and renewed</li>

            <li>INACTIVE - will not be synced anymore, claims of listings will
            be released where possible</li>

            <li>CANCELLED - will be synced, will not be renewed. Once endDate is
            reached, location will switch to INACTIVE</li>

            <li>CLOSED - location has shut down, we'll mark listings as
            permanently closed or remove listings from the internet where
            permanently closed status is not supported</li></ul>
          enum:
            - CREATED
            - ACTIVE
            - INACTIVE
            - CANCELLED
            - DELETED
            - CLOSED
        lastSyncStarted:
          type: string
          description: Output only. Date of the last sync for the location
          format: date-time
        endDate:
          type: string
          description: The date the location's contract expires
          format: date-time
        cancellationDate:
          type: string
          description: The date when the location was cancelled
          format: date-time
        dateCreated:
          type: string
          description: The date and time the location was created
          format: date-time
        lastUpdated:
          type: string
          description: Output only. Date of the last changes made to the location
          format: date-time
        sortableData:
          description: >-
            A JSON indicating which parameters can be used when sorting a list
            of locations including this one
          allOf:
            - $ref: '#/components/schemas/SortableData'
        businessId:
          type: integer
          description: The id of the business associated with this location
          format: int64
        socialPostId:
          type: integer
          description: Social Post Id of the location
          format: int64
        distance:
          type: integer
          description: >-
            Used for store finder. The distance between the current position and
            this location
          format: int32
        photos:
          type: array
          description: List of Photos
          items:
            $ref: '#/components/schemas/LocationPhoto'
        autoSync:
          type: boolean
          description: >-
            When autosync is set to true, information changed for the location
            in Uberall will automatically be syncronized to all connected
            listings without the need to explicitly start a sync again after
            it's been started once.
        skipFacebookPicturesUpdate:
          type: boolean
          description: Skip updating photos on Facebook
          example: true
        suggestionsForFieldsAvailable:
          type: boolean
          description: true if any suggetions are available
        features:
          type: array
          description: Output only. List of features available to the location
          items:
            type: string
      description: Location search result Model
    LocationStatisticsResponse:
      type: object
      properties:
        count:
          type: integer
          description: Total number of locations
          format: int32
        countActive:
          type: integer
          description: Number of active locations
          format: int32
        countInactive:
          type: integer
          description: Number of inactive locations
          format: int32
        countCancelled:
          type: integer
          description: Number of cancelled locations
          format: int32
        countClosed:
          type: integer
          description: Number of closed locations
          format: int32
        countSyncStarted:
          type: integer
          description: Number of locations where sync has been started
          format: int32
        countSyncNotStarted:
          type: integer
          description: Number of locations where sync has not been started
          format: int32
        countSyncNeeded:
          type: integer
          description: Number of locations where sync is needed
          format: int32
        suggestionsAvailable:
          type: boolean
          description: true if any suggetions are available
      description: Location statistics response model
    LocationTask:
      type: object
      properties:
        type:
          type: string
          description: >-
            The type of the task. The value could be on of
            [LISTING_FACEBOOK_CONNECTION_MISSING,
            LISTING_GOOGLE_CONNECTION_MISSING,
            LISTING_GOOGLE_VERIFICATION_MISSING, LISTING_GOOGLE_PIN_MISSING,
            LISTING_FIELDS_MISSING, DATAPOINT_UNREPLIED_RECENT,
            DATAPOINT_UNREAD, DATAPOINT_UNREPLIED_OLD,
            LOCATION_PROPERTIES_MISSING, LOCATION_ADD_PHOTOS,
            LOCATION_SOCIAL_POST_MISSING, LOCATION_RICH_DATA_MISSING,
            LOCATION_ADD_NEW_PHOTOS]
          enum:
            - LOCATION_START_FIRST_SYNC
            - LOCATION_START_NEW_SYNC
            - LISTING_FACEBOOK_CONNECTION_MISSING
            - LISTING_GOOGLE_CONNECTION_MISSING
            - LISTING_GOOGLE_VERIFICATION_MISSING
            - LISTING_GOOGLE_PIN_MISSING
            - LISTING_FIELDS_MISSING
            - DATAPOINT_UNREPLIED_RECENT
            - DATAPOINT_UNREAD
            - DATAPOINT_UNREPLIED_OLD
            - LOCATION_SUGGESTIONS_PROPERTIES
            - LOCATION_PROPERTIES_MISSING
            - LOCATION_SOCIAL_POST_MISSING
            - LOCATION_RICH_DATA_MISSING
            - LOCATION_ADD_NEW_PHOTOS
        properties:
          description: A Map with info related to the specific task
          allOf:
            - $ref: '#/components/schemas/LocationTaskProperties'
        priority:
          type: integer
          description: >-
            The priority of the task to be performed on the location. The value
            is from 1 to 90 and depends on the Task's type
          format: int32
        locationId:
          type: integer
          description: The location id which the next best action refers to
          format: int64
      description: LocationTask Model
    LocationTaskProperties:
      type: object
      properties:
        listing:
          allOf:
            - $ref: '#/components/schemas/ListingDto'
        missingField:
          type: string
          description: Missing field identifier (e.g., OPENING_HOURS, DESCRIPTION, PHONE)
          example: OPENING_HOURS
        lastPhotoUploadedAt:
          type: string
          description: Timestamp when the last photo was uploaded to the location
          format: date-time
        fields:
          type: array
          description: List of suggested field changes from user suggestions
          items:
            type: string
            enum:
              - NAME
              - NAME_DESCRIPTOR
              - STREET_NO
              - STREET
              - STREET_TYPE
              - ADDRESS_EXTRA
              - PROVINCE
              - ZIP
              - CITY
              - COUNTRY
              - LATITUDE
              - LONGITUDE
              - ADDRESS_DISPLAY
              - SERVICE_AREAS
              - CATEGORIES
              - OPENING_DATE
              - PHONE
              - CELLPHONE
              - FAX
              - WEBSITE
              - WEBSITE_EXTRA
              - EMAIL
              - OPENINGHOURS
              - OPENINGHOURS_NOTES
              - SPECIAL_OPENINGHOURS
              - MORE_HOURS
              - KEYWORDS
              - DESCRIPTION_SHORT
              - DESCRIPTION_LONG
              - IMPRINT
              - LEGAL_IDENT
              - TAX_NUMBER
              - ATTRIBUTION
              - IS_PUBLISHED
              - SOCIAL_PROFILES
              - ATTRIBUTES
              - PAYMENT_OPTIONS
              - BRANDS
              - LANGUAGES
              - SERVICES
              - CONTENT_LISTS
              - PHOTOS
              - VIDEOS
              - SOCIAL_POST
              - DOCTOR_CATEGORIES
              - NPI
              - EV_DATA
              - TRANSACTION_LINKS
              - SUBLOCALITY
              - CUSTOM_FIELDS
        locationId:
          type: integer
          description: Location ID related to this task
          format: int64
          example: 123
        count:
          type: integer
          description: Count of items (e.g., unread datapoints, unreplied reviews)
          format: int32
          example: 10
        queryString:
          type: string
          description: Query string for filtering content
          example: timeSpan=LAST_30_DAYS&dataPointTypes=review&status=unresolved
      description: A map with info related to the specific task
    LocationTaskWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationTask'
    LocationTemporarilyClosed:
      required:
        - temporarilyClosed
      type: object
      properties:
        temporarilyClosed:
          type: boolean
          description: >-
            Locations must have either TRUE or FALSE for this field to indicate
            if they are temporarily closed (TRUE) or not (FALSE).
        reopenDate:
          type: string
          description: >-
            Set a re-open date for a temporarily closed location (Format:
            YYYY-MM-DD). The location will re-open at 12:01am local time. Leave
            null if the re-open date is unknown.
      description: Location Temporarily Closed
    LocationTransactionLink:
      required:
        - type
        - url
      type: object
      properties:
        url:
          type: string
          description: >-
            The deep-link to the page where the customer can facilitate the
            transaction. This should not be a homepage or location page unless
            the customer can make their request directly on that page. UTM
            parameters are not recommended and may be stripped by specific
            directories.
        isPreferred:
          type: boolean
          description: >-
            Indicates to Google which one url per transaction link type should
            be set as the preferred flow for customers. Not required, but it is
            recommended to always flag one url, even if there is only one, as
            preferred because Google may pull in urls from third party partners.
        type:
          type: string
          description: >-
            The specific customer action type - APPOINTMENT, ONLINE_APPOINTMENT,
            FOOD_ORDERING, FOOD_DELIVERY, FOOD_TAKEOUT, DINING_RESERVATION,
            SHOP_ONLINE
          enum:
            - APPOINTMENT
            - ONLINE_APPOINTMENT
            - FOOD_ORDERING
            - FOOD_DELIVERY
            - FOOD_TAKEOUT
            - DINING_RESERVATION
            - SHOP_ONLINE
            - AIRLINE_BOOK
            - AIRLINE_CHECK_IN
            - AIRLINE_FLIGHT_STATUS
            - BOOK
            - BOOK_ACTIVITIES
            - BOOK_RIDES
            - BOOK_TEETIMES
            - BOOK_TOURS
            - BUY_TICKETS
            - CAREERS
            - CHARGE_EV
            - COUPONS
            - DONATE
            - EVENTS
            - EVENTS_SHOWS
            - EVENTS_SPORTS
            - GIFT_CARD
            - HOTEL_AMENITIES
            - HOTEL_BOOK_ROOM
            - AVAILABLE_PARKING
            - RESERVE_PARKING
            - RESTAURANT_JOIN_WAITLIST
            - VIEW_MENU
            - SERVICE_QUOTE
            - STORE_DELIVERY
            - STORE_PICKUP
            - SERVICES
            - SUPPORT
            - SHOWTIMES
            - VIEW_AVAILABILITY
            - VIEW_PRICING
            - APPLE_APPOINTMENT
            - APPLE_FOOD_ORDERING
            - APPLE_FOOD_DELIVERY
            - APPLE_FOOD_TAKEOUT
            - APPLE_DINING_RESERVATION
            - APPLE_SHOP_ONLINE
            - APPLE_AIRLINE_BOOK_TRAVEL
            - APPLE_AIRLINE_CHECK_IN
            - APPLE_AIRLINE_FLIGHT_STATUS
            - APPLE_BOOK
            - APPLE_BOOK_ACTIVITIES
            - APPLE_BOOK_RIDES
            - APPLE_BOOK_TEETIMES
            - APPLE_BOOK_TOURS
            - APPLE_BUY_TICKETS
            - APPLE_CAREERS
            - APPLE_CHARGE_EV
            - APPLE_COUPONS
            - APPLE_DONATE
            - APPLE_EVENTS
            - APPLE_EVENTS_SHOWS
            - APPLE_EVENTS_SPORTS
            - APPLE_GIFT_CARD
            - APPLE_HOTEL_AMENITIES
            - APPLE_HOTEL_BOOK_ROOM
            - APPLE_PARKING_AVAILABLE_PARKING
            - APPLE_PARKING_RESERVE_PARKING
            - APPLE_RESTAURANT_JOIN_WAITLIST
            - APPLE_RESTAURANT_PICKUP
            - APPLE_RESTAURANT_VIEW_MENU
            - APPLE_RETAIL_SERVICE_QUOTE
            - APPLE_RETAIL_STORE_DELIVERY
            - APPLE_RETAIL_STORE_PICKUP
            - APPLE_SERVICES
            - APPLE_SUPPORT
            - APPLE_THEATER_NOW_PLAYING
            - APPLE_VIEW_AVAILABILITY
            - APPLE_VIEW_PRICING
      description: Location Transaction Link
    LocationWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationObject'
    LodgingField:
      required:
        - category
        - externalId
      type: object
      properties:
        externalId:
          type: string
          description: >-
            The Google external id for each lodging amenity. Examples include:
            watercraftRental, turndownService, patio
        category:
          type: string
          description: >-
            High-level grouping of Lodging Amenity types, such as SERVICES,
            TRANSPORTATION, FAMILIES, etc
        displayName:
          type: string
          description: >-
            Amenity name as displayed in the UI, available in DE, EN, FR, ES,
            JA, and FI
      description: Represents a Google hotel lodging field.
    LodgingFieldResponseObject:
      type: object
      properties:
        availableLodgingFields:
          type: array
          items:
            $ref: '#/components/schemas/LodgingField'
      description: The actual response object of the response
    LodgingFieldResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LodgingFieldResponseObject'
    LoggingEvent:
      type: object
      properties:
        type:
          type: string
          description: >-
            The logging event type. One of LISTING_UPDATE, LISTING_SYNC_CHECK,
            LISTING_DATAPOINT_CHECK, LISTING_PUBLISHER_UPDATE,
            LISTING_BLACKLIST, LISTING_REVIEWED, LISTING_STATUS_CHANGE,
            LISTING_MANUAL, LISTING_SUPPRESS, LISTING_DELETE, LISTING_CANCEL,
            LISTING_FACEBOOK_PAGE_INVALIDATE, LISTING_FLAGGED,
            LISTING_LINK_CHANGE, LISTING_REMOVAL_SUPPRESS,
            LISTING_SUPPRESS_NOT_ALLOWED, LISTING_UPDATE_SPECIAL_OFFER,
            LISTING_REMOVAL_STATUS_CHECK, LOCATION_BILLING,
            LOCATION_SYNC_STARTED, LOCATION_PROFILE_CHANGED,
            LOCATION_SUBSCRIPTION_CHANGED, LOCATION_LISTING_ADDED,
            LOCATION_VISIBILITY_INDEX_CHANGED, LOCATION_STATUS_CHANGED,
            LOCATION_PRODUCT_PLAN_CHANGED,
            LOCATION_NORMALIZATION_STATUS_CHANGED, LOCATION_CREATED,
            LOCATION_DUPLICATE_LISTING_DETECTION,
            LOCATION_DUPLICATE_LISTING_CHECK, LOCATION_CHECKOUT,
            LOCATION_CHECKOUT_FREE, LOCATION_CHECKOUT_UPGRADE,
            LOCATION_CHECKOUT_SALESPARTNER, USER_PASSWORD_RESET,
            SALES_PARTNER_SIGNUP, SALES_PARTNER_APPROVAL,
            SALES_PARTNER_PASSWORD_RESET, SEARCH_DATA_RECHECK_LINK_SHARED,
            BUSINESS_COMMENT, BUSINESS_INVOICE_CREATED,
            BUSINESS_INVOICE_RENEWAL_SUCCESS, BUSINESS_INVOICE_RENEWAL_FAIL,
            BUSINESS_INVOICE_CREATED_FIRST_BASIC,
            BUSINESS_INVOICE_CREATED_FIRST_PREMIUM,
            BUSINESS_INVOICE_CREATED_UPGRADE_BASIC,
            BUSINESS_INVOICE_CREATED_UPGRADE_PREMIUM,
            BUSINESS_INVOICE_CREATED_ANOTHER_BASIC,
            BUSINESS_INVOICE_CREATED_ANOTHER_PREMIUM,
            BUSINESS_INVOICE_CREATED_RENEWAL, BUSINESS_DIRECTORY_ACCOUNT,
            BUSINESS_CSV_EXPORT, BUSINESS_UPDATE_PRICE, ADMIN_LOGIN_ALERT
        dateCreated:
          type: string
          description: The date the logging event was created
          format: date-time
        uuid:
          type: string
          description: The uuid
        id:
          type: integer
          description: The uberall unique id for the logging event
          format: int64
        source:
          type: integer
          description: The id of the object the logging event is about
          format: int64
        payload:
          type: object
          description: A JSON containing detailed information about the logging event
      description: LoggingEvent Model
    LoginCommand:
      type: object
      properties:
        userId:
          type: integer
          description: UserId (email or userId is required)
          format: int64
        email:
          type: string
          description: User email (email or userId is required)
        password:
          type: string
          description: User Password (password or private_key is required)
        private_key:
          type: string
          description: Private key (password or private_key is required)
          example: access_token
      description: Login Command
    LoginResponse:
      type: object
      properties:
        access_token:
          type: string
          description: Access Token
      description: User access_token
    LoginResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          description: User access_token
          allOf:
            - $ref: '#/components/schemas/LoginResponse'
    LogoDetails:
      required:
        - url
      type: object
      properties:
        url:
          type: string
          description: Url pointing to the attribution logo
        type:
          type: string
          description: Type
          example: LOGO
        description:
          type: string
          description: Description of the logo
      description: Logo details model
    LogoutResponse:
      type: object
      properties:
        success:
          type: boolean
          description: True if logout was successful
          example: true
        redirectUrl:
          type: string
          description: The URL that a user is redirected to when logging out
          example: http://example.com/redirect
      description: Details about the LogoutResponse
    LogoutResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LogoutResponse'
    MenuItem:
      required:
        - title
      type: object
      properties:
        title:
          type: string
          description: Title
        description:
          type: string
          description: >-
            Description of the menu item: e.g. 'With mozzarella, fresh basil and
            tomatoes'
        identifier:
          type: string
          description: Unique Identifier for the Menu
        listName:
          type: string
        id:
          type: integer
          description: The uberall unique id for the menu item
          format: int64
        price:
          type: integer
          description: 'Price of the menu item in cents: e.g. ''1500'' for 15 €'
          format: int32
        currency:
          type: object
          description: 'Currency used for prices in ISO-4217: e.g. EUR, USD, CHF'
        category:
          type: string
          description: >-
            Category or section of the menu item (e.g. Starters, Drinks, Desert,
            etc.)
          example: Starters, Drinks, Desert, etc.
        image:
          description: Image of the menu (use the Image object format)
          allOf:
            - $ref: '#/components/schemas/Image'
        url:
          type: string
          description: A valid page url with more details about the item
        priceMax:
          type: integer
          description: Maximum price if you want to use a price range for the item
          format: int32
        caloriesLow:
          type: integer
          description: The lowest possible number of calories for a menu item
          format: int32
        caloriesHigh:
          type: integer
          description: The high end of the range of calories for a menu item
          format: int32
        allergens:
          type: array
          description: Allergens in the food item (e.g. Eggs, Dairy, Wheat, etc.)
          example: Eggs, Dairy, Wheat, etc.
          items:
            type: string
        dietaryRestrictions:
          type: array
          description: >-
            Restrictive diet the menu item fits into (e.g. Vegetarian, Halal,
            etc.)
          example: Vegetarian, Halal, etc.
          items:
            type: string
      description: Menu Item
    MenuItemResponseObject:
      type: object
      properties:
        menuItem:
          allOf:
            - $ref: '#/components/schemas/MenuItem'
      description: The actual response object of the response
    MenuItemResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/MenuItemResponseObject'
    MenuItemSearchResponseObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        total:
          type: integer
          description: Total count of results
          format: int32
          example: 100
        menuItems:
          type: array
          items:
            $ref: '#/components/schemas/MenuItem'
      description: The actual response object of the response
    MenuItemSearchResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/MenuItemSearchResponseObject'
    Metric:
      type: object
      properties:
        name:
          type: string
          description: Name of the metric
          example: ACTIONS_WEBSITE
        data:
          type: array
          description: Data for the metric
          items:
            $ref: '#/components/schemas/MetricData'
      description: List of metrics
      example:
        - name: ACTIONS_WEBSITE
          data:
            - period: '2025-04-01'
              count: 683
            - period: '2025-04-02'
              count: 658
        - name: ACTIONS_PHONE
          data:
            - period: '2025-04-01'
              count: 840
            - period: '2025-04-02'
              count: 886
        - name: ACTIONS_DRIVING_DIRECTIONS
          data:
            - period: '2025-04-01'
              count: 11097
            - period: '2025-04-02'
              count: 11332
        - name: BUSINESS_IMPRESSIONS_DESKTOP_MAPS
          data:
            - period: '2025-04-01'
              count: 8436
            - period: '2025-04-02'
              count: 8248
        - name: BUSINESS_IMPRESSIONS_MOBILE_MAPS
          data:
            - period: '2025-04-01'
              count: 131141
            - period: '2025-04-02'
              count: 133253
        - name: BUSINESS_CONVERSATIONS
          data: []
        - name: BUSINESS_BOOKINGS
          data: []
    MetricData:
      type: object
      properties:
        period:
          type: string
          description: Period for the metric
          example: '2025-04-01'
        count:
          type: integer
          description: Count for the metric
          format: int32
          example: 683
      description: Data for the metric
    MissingChatbotConnection:
      type: object
      properties:
        totalLocationsCount:
          type: integer
          description: Total number of locations affected
          format: int32
        accounts:
          type: array
          description: List of affected accounts
          items:
            $ref: '#/components/schemas/AccountConnectionDetails'
      description: Details about missing chatbot connections
    MissingWarningsConnection:
      type: object
      properties:
        totalLocationsCount:
          type: integer
          description: Total number of locations affected
          format: int32
        accounts:
          type: array
          description: List of affected accounts
          items:
            $ref: '#/components/schemas/AccountConnectionDetails'
        locations:
          type: array
          description: List of affected locations
          items:
            $ref: '#/components/schemas/LocationConnectionDetails'
        businesses:
          type: array
          description: List of affected businesses
          items:
            $ref: '#/components/schemas/LocationConnectionDetails'
        totalBusinessesCount:
          type: integer
          description: Total number of businesses affected
          format: int32
      description: Details about missing permissions
    MoreHours:
      type: object
    MoreHoursObject:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/MoreHoursResultsDetails'
      description: The actual response object of the response
    MoreHoursResponse:
      type: object
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/MoreHoursType'
        hours:
          type: array
          description: The MoreHours of the given type
          items:
            $ref: '#/components/schemas/HoursObject'
    MoreHoursResultsDetails:
      type: object
      properties:
        hoursTypeId:
          type: string
          description: The hours type id
          example: ACCESS
        displayName:
          type: string
          description: The display name
          example: Zugang
    MoreHoursType:
      type: object
      properties:
        id:
          type: integer
          format: int64
      description: The MoreHours type
    MoreHoursWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/MoreHoursObject'
    MultiFactorAuthentication:
      type: object
      properties:
        email:
          type: string
          description: Email
        type:
          type: string
          description: Multi factor authentication type
          enum:
            - EMAIL
        id:
          type: integer
          format: int64
      description: Multi Factor Authentication Model
    NextOpen:
      type: object
      properties:
        date:
          type: string
          description: >-
            date when the location will be opened; for example "2018-11-16"
            (string) (this parameter is used only if closedNow true and
            neverOpens false)
          format: date
          example: '2018-11-16'
        dayOfWeek:
          type: string
          description: >-
            day of week when the location will be opened; format like
            OpeningHours: 1 for Monday, 2 for Tuesday, etc (this parameter is
            used only if closedNow true and neverOpens false)
          enum:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
            - SUNDAY
        hour:
          type: integer
          description: >-
            defines at which time at the date "date" the location will be open;
            for example: "13:00" (this parameter is used only if closedNow true
            and neverOpens false)
          format: int32
        closedNow:
          type: boolean
          description: true if the location is closed now; otherwise false
        neverOpens:
          type: boolean
          description: >-
            true if the location will never open again; otherwise false (this
            parameter is used only if closedNow true)
      description: Next Open Model
    OAuthToken:
      type: object
      description: OAuth token for the page
    OpeningHours:
      required:
        - dayOfWeek
      type: object
      properties:
        closed:
          type: boolean
          description: Indicates whether a location is closed on a day.
        fromX:
          type: string
          description: >-
            A beginning of a period. One or multiple periods are supported per
            dayOfWeek, e.g.: "from1": "09:00", "from2": "15:00"
        dayOfWeek:
          type: integer
          description: >-
            The weekday of an opening hours, e.g.: 1 for Monday, 2 for Tuesday,
            ...
          format: int32
        toX:
          type: string
          description: >-
            An end of a period. One or multiple periods are supported per
            dayOfWeek, e.g.: "to1": "14:30", "to2": "17:00"
      description: Opening Hours
    Person:
      required:
        - name
        - title
      type: object
      properties:
        title:
          type: string
          description: 'The person''s title: e.g. ''Store manager'''
        description:
          type: string
          description: >-
            Description for the person: e.g. 'Responsible for the day-to-day
            operations of the store'
        identifier:
          type: string
          description: Unique Identifier for the Person
        listName:
          type: string
          description: Name of the section this person belongs to
        id:
          type: integer
          description: The uberall unique id for the person
          format: int64
        name:
          type: string
          description: The person's full name
        image:
          description: Image of the person (use the Image object format)
          allOf:
            - $ref: '#/components/schemas/Image'
        url:
          type: string
          description: A valid url of a page with more details about the person
      description: Person
    PersonResponseObject:
      type: object
      properties:
        person:
          allOf:
            - $ref: '#/components/schemas/Person'
      description: The actual response object of the response
    PersonResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/PersonResponseObject'
    PersonSearchResponseObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        total:
          type: integer
          description: Total count of results
          format: int32
          example: 100
        persons:
          type: array
          items:
            $ref: '#/components/schemas/Person'
      description: The actual response object of the response
    PersonSearchResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/PersonSearchResponseObject'
    PhotoContainer:
      type: object
      properties:
        photo:
          type: object
          description: >-
            Placeholder to represent photo for a social post which can either be
            a base64 encoded string or a S3 link for image
        description:
          type: string
          description: Description for the social post photo
        redirectUrl:
          type: string
          description: The URL that a user is redirected to when clicking the photo
      description: Photo Container Model
    PostcodesResponse:
      type: object
      properties:
        postcodes:
          type: array
          items:
            type: string
      description: Response object containing a list of postcodes
    PostcodesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/PostcodesResponse'
    PricePerCountry:
      type: object
      properties:
        country:
          type: string
          description: Country
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        price:
          type: integer
          description: 'Price for the country in cents: e.g. 1500 for 15 €'
          format: int32
        marketDevelopmentFunds:
          type: integer
          description: Market Development Funds (MDF)
          format: int32
          example: 99
        priceSetup:
          type: integer
          description: Setup fee
          format: int32
      description: Price per country Model
    Product:
      required:
        - title
      type: object
      properties:
        title:
          type: string
          description: 'The name of the product: e.g. Strong Coffee'
        description:
          type: string
          description: 'Description of the product: e.g. ''The strongest coffee in the world'''
        identifier:
          type: string
          description: Unique Identifier for the Product
        listName:
          type: string
        id:
          type: integer
          description: The uberall unique id for the product
          format: int64
        price:
          type: integer
          description: 'Price of the product in cents: e.g. ''1500'' for 15 €'
          format: int32
        currency:
          type: object
          description: 'Currency used for prices in ISO-4217: e.g. EUR, USD, CHF'
        category:
          type: string
          description: 'A category the product belongs to: e.g. ''Coffee'''
          example: Coffee
        video:
          description: A video about the product
          allOf:
            - $ref: '#/components/schemas/Video'
        unit:
          type: string
          description: A unit of measure, e.g. 'per kg'
          example: per kg
        url:
          type: string
          description: A valid page url with more details about the product
        priceMax:
          type: integer
          description: Maximum price if you want to use a price range for the product
          format: int32
        image:
          description: Image of the product (use the Image object format)
          allOf:
            - $ref: '#/components/schemas/Image'
      description: Product Model
    ProductObject:
      type: object
      description: The actual response object of the response
    ProductPlan:
      required:
        - duration
        - name
      type: object
      properties:
        defaultPlan:
          type: boolean
          description: >-
            True, if this is the default ProductPlan. A new created business
            will get this product plan, if not declared differently.
        description:
          type: string
          description: Description of the plan
        identifier:
          type: string
          description: >-
            The Product Plan identifier based on your internal identification
            system
        name:
          type: string
          description: The name of the product plan
        status:
          type: string
          description: One among PENDING_APPROVAL, ACTIVE, INACTIVE
          enum:
            - ACTIVE
            - INACTIVE
            - PENDING_APPROVAL
            - DELETED
        automationDirectories:
          uniqueItems: true
          type: array
          description: List of directories supported by this plan
          items:
            type: string
            enum:
              - FOURSQUARE
              - UBER
              - GOOGLE
              - WAZE
              - GOOGLE_MAPS
              - YELP
              - YELP_API
              - MEINESTADT
              - YELLOW_MAP
              - FOCUS
              - LOKALEAUSKUNFT
              - WEB_DE
              - GMX
              - ONE_AND_ONE
              - FREIEAUSKUNFT
              - POINTOO
              - NOKIA_HERE
              - FACEBOOK
              - TOMTOM
              - STADTBRANCHENBUCH
              - CYLEX
              - UNTERNEHMENSAUSKUNFT
              - ACOMPIO
              - BUSINESSBRANCHENBUCH
              - YALWA
              - THE_PHONEBOOK
              - SCOOT
              - CENTRAL_INDEX
              - CITIPAGES
              - ONE_NINE_TWO
              - ONE_ONE_EIGHT
              - THE_DAILY_RECORD
              - THE_EVENING_STANDARD
              - THE_SCOTSMAN
              - LIVERPOOL_ECHO
              - THE_SUN
              - THE_INDEPENDENT
              - TOUCH_LOCAL
              - THE_MIRROR
              - ANNUAIRE
              - INFOBEL
              - US_INFO_COM
              - GARMIN
              - FACTUAL
              - BING
              - WO_GIBTS_WAS
              - KOOMIO
              - ABCLOCAL
              - YELLBO
              - JELLOO
              - GUIDELOCAL
              - OEFFNUNGSZEITENBUCH
              - APPLE_MAPS
              - LOOCAL
              - REGIONAL_DE
              - WHERE_TO
              - TUPALO
              - GELBE_SEITEN
              - DAS_OERTLICHE
              - DIALO
              - BUNDES_TELEFONBUCH
              - BRANCHENBUCH_DEUTSCHLAND
              - MARKTPLATZ_MITTELSTAND
              - BUSQUEDA_LOCAL
              - RICERCARE_IMPRESE
              - PAGES24
              - NAVMII
              - AUDI
              - BMW
              - MERCEDES
              - VW
              - TOYOTA
              - FORD
              - FIAT
              - GM
              - ETRUSTED
              - INSTAGRAM
              - SHOPPING_TIME_NETWORK
              - CITY_SQUARES
              - SHOWMELOCAL
              - LOCALSTACK
              - CHAMBER_OF_COMMERCE
              - JUDYS_BOOK
              - BROWNBOOK
              - MY_LOCAL_SERVICES
              - YA_SABE
              - UNIVISION
              - AL_DIA_TX
              - LA_VOZ_TX
              - CHRON
              - STATESMAN
              - PALM_BEACH_POST
              - MUNDO_HISPANICO
              - EL_TIEMPO_LATINO
              - LATINOS_US
              - HOTFROG
              - INFO_IS_INFO
              - MANTA
              - US_CITY
              - GO_YELLOW
              - N49
              - PRATIQUE
              - JUSTACOTE
              - EZLOCAL
              - ELOCAL
              - TRUE_LOCAL
              - START_LOCAL
              - WOMO
              - AUSSIE_WEB
              - YELLOW_PAGES
              - SUPER_PAGES
              - WHITE_PAGES
              - DEX_KNOWS
              - KAUFDA_MANUAL
              - I_GLOBAL
              - BRANCHEN_INFO_MANUAL
              - GUTE_BANKEN_MANUAL
              - D_11880_COM_MANUAL
              - BANKOEFFNUNGSZEITEN_DE_MANUAL
              - BANK_OEFFNUNGSZEITEN_DE_MANUAL
              - CYLEX_MANUAL
              - FINDE_OFFEN_MANUAL
              - MEIN_PROSPEKT_MANUAL
              - DAS_SCHNELLE
              - SENSIS_WHITE_PAGES
              - SENSIS_TRUE_LOCAL
              - SENSIS_YELLOW_PAGES
              - FIND_OPEN
              - WAND
              - BELL_CA
              - GO_LOCAL
              - MEINUNGSMEISTER
              - YANDEX
              - YAHOO_MANUAL
              - HOLIDAY_CHECK
              - TRIP_ADVISOR
              - BONIAL_FR
              - ZIP_CH
              - PAGES_JAUNES
              - YELLOW_PAGES_SINGAPORE
              - INFOGROUP
              - WAZE_NEW
              - UBER_NEW
              - NEUSTAR
              - TRUSTPILOT
              - AUSKUNFT
              - BAIDU
              - NEXT_DOOR
              - MICROSOFT_CORTANA
              - GOOGLE_ASSISTANT
              - CBANQUE
              - ORANGE_118_712
              - SIRI
              - HUAWEI
              - DOCTOR_COM
              - CARE_DASH
              - DENTAL_PLANS
              - DOC_SPOT
              - HEALTHGRADES
              - SHARE_CARE
              - VITALS
              - WEB_MD
              - WELLNESS
              - ZOC_DOC
              - ZWIVEL
              - YP_COM_HEALTH
              - BING_HEALTH
              - NPPES
              - RATE_MDS
              - CITYSEARCH
              - INSIDER_PAGES
              - TWITTER
              - ALEXA
              - MAP_QUEST
              - WEBSITE_WIDGETS
              - ECO_MOVEMENT
              - GOOGLE_EV
              - APPLE_EV
              - TESLA_EV
              - EUROWAG_EV
              - OPIS_EV
              - TOMTOM_EV
              - HERE_EV
              - YELLOW_PAGES_CANADA
              - BBB
              - UBERALL_SOCIAL_ADS
              - APPLE_APPS
              - CONSUMER_AFFAIRS
              - CREDIT_KARMA
              - DELIVERY
              - GLASSDOOR
              - PLAY_GOOGLE
              - GRUBHUB
              - INDEED
              - LENDING_TREE
              - MENUISM
              - OPEN_TABLE
              - OPEN_TABLE_USA
              - WALLET_HUB
              - ZILLOW
              - ZOMATO
              - WHATS_APP
              - FOUR_SCREEN
              - AND_CHARGE
              - LINKED_IN
        billingPeriod:
          type: integer
          description: Period in months for which the location is billed
          format: int32
        countryPrices:
          uniqueItems: true
          type: array
          description: List of country specific prices
          items:
            $ref: '#/components/schemas/PricePerCountry'
        defaultMarketDevelopmentFunds:
          type: integer
          description: Default Market Development Funds
          format: int32
        defaultOriginalPrice:
          type: integer
          description: Default Original Price in cent
          format: int32
        defaultPrice:
          type: integer
          description: >-
            Mandatory if countryPrices is not populated. Define a global price
            for the Product Plan that gets applied for all countries
          format: int32
        defaultPriceSetup:
          type: integer
          description: Set-up price per location in cent
          format: int32
        duration:
          type: integer
          description: Duration of the Product Plan in months
          format: int32
        features:
          uniqueItems: true
          type: array
          description: List of features supported by this plan
          items:
            type: string
            enum:
              - NEW_PHOTO_TYPES
              - ADS
              - ADS_READ
              - ADS_WRITE
              - ADVANCED_ANALYTICS
              - ADVANCED_ANALYTICS_2_0
              - AI_KNOWLEDGEBASE
              - AI_LOCALISATION
              - AI_LOCATION_INFORMATION
              - AI_SUGGESTED_REPLIES
              - APPLE_POSTING
              - APPLE_POSTING_WRITE
              - AUTO_RESPONSE
              - AUTO_RESPONSE_WRITE
              - AUTOMATION
              - BASIC
              - BASIC_PLUS
              - BULK_UPDATES
              - INSTAGRAM_POSTING
              - INSTAGRAM_POSTING_WRITE
              - LINKEDIN_POSTING
              - BUSINESS_LEVEL_CONNECT
              - CALL_TRACKING_NUMBERS
              - CAN_PAY_INVOICE
              - CAN_SEE_HELP_SECTION
              - CHATBOT
              - CHATBOT_READ
              - CHATBOT_WRITE
              - CHAT_READ
              - CHAT_WRITE
              - CLEANSING
              - CONTENT_COLLECTION
              - DAM
              - DASHBOARD
              - ENTERPRISE_ONBOARDING
              - FACEBOOK_UNOWNED_PAGE_CREATE
              - FACEBOOK_POSTING
              - FIRST_PARTY_REVIEW_APPROVAL
              - FORMS
              - GOOGLE_POSTING
              - HOMEPAGE
              - INBOX
              - INBOX_APPROVAL
              - INBOX_PREVIEW
              - INBOX_TEASER
              - INBOX_TWITTER
              - INBOX_READ
              - INBOX_WRITE
              - INBOX_2_0_BETA
              - INBOX_2_0_BETA_READ
              - INBOX_2_0_BETA_WRITE
              - INBOX_FLAG
              - LISTINGS
              - LIVE_CHAT
              - LOCAL_SEO_REPORT
              - LOCATION_APPROVAL_REQUESTS
              - LOCATION_GROUP
              - LOCATION_STATUS_CHANGE
              - LOCATION_TRANSLATION
              - LOCATION_READ
              - LOCATION_WRITE
              - LOCAL_INVENTORY
              - MANUAL_LISTINGS
              - NEAR_ME_CHECK
              - PHONE_OPTIONAL
              - OTHERS_POSTING
              - POSTING
              - POSTING_APPROVAL
              - POSTING_READ
              - POSTING_TONE_ADJUST
              - POSTING_WRITE
              - POSTING_PREVIEW
              - PRICE_INFO
              - QR_CODE_GENERATION
              - RESPONSE_LIBRARY
              - RESPONSE_LIBRARY_READ
              - RESPONSE_LIBRARY_WRITE
              - REVIEW_GENERATION_EMAIL
              - REVIEW_GENERATION_SMS
              - REVIEW_GENERATION_CREATE
              - REVIEW_GENERATION_SEND
              - LOCATION_APPROVAL
              - LOCATION_SCHEDULED_UPDATES
              - SINGLE_SIGN_ON
              - SOCIAL_ADS
              - STOREFINDER
              - STOREFINDER_TRIAL_MODE
              - LOCATOR_PAGES_BUILDER
              - STOREFINDER_ANALYTICS
              - STOREFINDER_GOOGLE
              - STOREFINDER_MAPBOX
              - SUPPORT
              - SUPPRESSION
              - TRACKING
              - TRANSACTION_LINKS
              - TWITTER_INBOX_READ
              - TWITTER_INBOX_WRITE
              - TWITTER_POSTING
              - TWITTER_POSTING_WRITE
              - UPGRADE
              - USER_OTHERS_EDIT
              - USER_SELF_EDIT
              - UTMS
              - WEBSITE_WIDGETS
              - EXPANDED_REVIEWS_RESTAURANT
              - EXPANDED_REVIEWS_FINANCE
              - WHATS_APP_MESSAGES
              - ACCESS_REQUEST_INVITATIONS
              - AI_BULK_REPLIES
              - SURVEYS
              - SURVEYS_READ
              - SURVEYS_WRITE
        initialBillingPeriod:
          type: integer
          description: Initial Billing Period
          format: int32
        initialDuration:
          type: integer
          description: Initial Duration
          format: int32
      description: Product Plan Model
    ProductPlanCountryPriceResponse:
      required:
        - country
        - price
      type: object
      properties:
        country:
          type: string
          description: Country
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        price:
          type: integer
          description: Price for the specific Country
          format: int32
        marketDevelopmentFunds:
          type: integer
          description: Market Development Funds (MDF)
          format: int32
        priceSetup:
          type: integer
          description: Setup fee
          format: int32
      description: Product Plan Country Price Response Model
    ProductPlanListResponseObject:
      type: object
      properties:
        plans:
          type: array
          items:
            $ref: '#/components/schemas/ProductPlanResponse'
      description: The actual response object of the response
    ProductPlanListResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ProductPlanListResponseObject'
    ProductPlanRequestBody:
      type: object
      properties:
        name:
          type: string
          description: The name of the product plan
        identifier:
          type: string
          description: >-
            The Product Plan identifier based on your internal identification
            system
        description:
          type: string
          description: Description of the plan
        defaultPlan:
          type: boolean
          description: >-
            True, if this is the default ProductPlan. A new created business
            will get this product plan, if not declared differently
        status:
          type: string
          description: >-
            Status of the Product Plan. Is possible to change an ACTIVE Product
            Plan to INACTIVE and vice versa.
          enum:
            - ACTIVE
            - INACTIVE
            - PENDING_APPROVAL
            - DELETED
    ProductPlanResponse:
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id
          format: int64
        name:
          type: string
          description: The name of the product plan
        salesPartnerId:
          type: integer
          description: Sales Partner of the Product Plan
          format: int64
        features:
          uniqueItems: true
          type: array
          description: List of features supported by this plan
          items:
            type: string
            enum:
              - NEW_PHOTO_TYPES
              - ADS
              - ADS_READ
              - ADS_WRITE
              - ADVANCED_ANALYTICS
              - ADVANCED_ANALYTICS_2_0
              - AI_KNOWLEDGEBASE
              - AI_LOCALISATION
              - AI_LOCATION_INFORMATION
              - AI_SUGGESTED_REPLIES
              - APPLE_POSTING
              - APPLE_POSTING_WRITE
              - AUTO_RESPONSE
              - AUTO_RESPONSE_WRITE
              - AUTOMATION
              - BASIC
              - BASIC_PLUS
              - BULK_UPDATES
              - INSTAGRAM_POSTING
              - INSTAGRAM_POSTING_WRITE
              - LINKEDIN_POSTING
              - BUSINESS_LEVEL_CONNECT
              - CALL_TRACKING_NUMBERS
              - CAN_PAY_INVOICE
              - CAN_SEE_HELP_SECTION
              - CHATBOT
              - CHATBOT_READ
              - CHATBOT_WRITE
              - CHAT_READ
              - CHAT_WRITE
              - CLEANSING
              - CONTENT_COLLECTION
              - DAM
              - DASHBOARD
              - ENTERPRISE_ONBOARDING
              - FACEBOOK_UNOWNED_PAGE_CREATE
              - FACEBOOK_POSTING
              - FIRST_PARTY_REVIEW_APPROVAL
              - FORMS
              - GOOGLE_POSTING
              - HOMEPAGE
              - INBOX
              - INBOX_APPROVAL
              - INBOX_PREVIEW
              - INBOX_TEASER
              - INBOX_TWITTER
              - INBOX_READ
              - INBOX_WRITE
              - INBOX_2_0_BETA
              - INBOX_2_0_BETA_READ
              - INBOX_2_0_BETA_WRITE
              - INBOX_FLAG
              - LISTINGS
              - LIVE_CHAT
              - LOCAL_SEO_REPORT
              - LOCATION_APPROVAL_REQUESTS
              - LOCATION_GROUP
              - LOCATION_STATUS_CHANGE
              - LOCATION_TRANSLATION
              - LOCATION_READ
              - LOCATION_WRITE
              - LOCAL_INVENTORY
              - MANUAL_LISTINGS
              - NEAR_ME_CHECK
              - PHONE_OPTIONAL
              - OTHERS_POSTING
              - POSTING
              - POSTING_APPROVAL
              - POSTING_READ
              - POSTING_TONE_ADJUST
              - POSTING_WRITE
              - POSTING_PREVIEW
              - PRICE_INFO
              - QR_CODE_GENERATION
              - RESPONSE_LIBRARY
              - RESPONSE_LIBRARY_READ
              - RESPONSE_LIBRARY_WRITE
              - REVIEW_GENERATION_EMAIL
              - REVIEW_GENERATION_SMS
              - REVIEW_GENERATION_CREATE
              - REVIEW_GENERATION_SEND
              - LOCATION_APPROVAL
              - LOCATION_SCHEDULED_UPDATES
              - SINGLE_SIGN_ON
              - SOCIAL_ADS
              - STOREFINDER
              - STOREFINDER_TRIAL_MODE
              - LOCATOR_PAGES_BUILDER
              - STOREFINDER_ANALYTICS
              - STOREFINDER_GOOGLE
              - STOREFINDER_MAPBOX
              - SUPPORT
              - SUPPRESSION
              - TRACKING
              - TRANSACTION_LINKS
              - TWITTER_INBOX_READ
              - TWITTER_INBOX_WRITE
              - TWITTER_POSTING
              - TWITTER_POSTING_WRITE
              - UPGRADE
              - USER_OTHERS_EDIT
              - USER_SELF_EDIT
              - UTMS
              - WEBSITE_WIDGETS
              - EXPANDED_REVIEWS_RESTAURANT
              - EXPANDED_REVIEWS_FINANCE
              - WHATS_APP_MESSAGES
              - ACCESS_REQUEST_INVITATIONS
              - AI_BULK_REPLIES
              - SURVEYS
              - SURVEYS_READ
              - SURVEYS_WRITE
        updatedDirectories:
          uniqueItems: true
          type: array
          description: List of directories supported by this plan
          items:
            type: string
            enum:
              - FOURSQUARE
              - UBER
              - GOOGLE
              - WAZE
              - GOOGLE_MAPS
              - YELP
              - YELP_API
              - MEINESTADT
              - YELLOW_MAP
              - FOCUS
              - LOKALEAUSKUNFT
              - WEB_DE
              - GMX
              - ONE_AND_ONE
              - FREIEAUSKUNFT
              - POINTOO
              - NOKIA_HERE
              - FACEBOOK
              - TOMTOM
              - STADTBRANCHENBUCH
              - CYLEX
              - UNTERNEHMENSAUSKUNFT
              - ACOMPIO
              - BUSINESSBRANCHENBUCH
              - YALWA
              - THE_PHONEBOOK
              - SCOOT
              - CENTRAL_INDEX
              - CITIPAGES
              - ONE_NINE_TWO
              - ONE_ONE_EIGHT
              - THE_DAILY_RECORD
              - THE_EVENING_STANDARD
              - THE_SCOTSMAN
              - LIVERPOOL_ECHO
              - THE_SUN
              - THE_INDEPENDENT
              - TOUCH_LOCAL
              - THE_MIRROR
              - ANNUAIRE
              - INFOBEL
              - US_INFO_COM
              - GARMIN
              - FACTUAL
              - BING
              - WO_GIBTS_WAS
              - KOOMIO
              - ABCLOCAL
              - YELLBO
              - JELLOO
              - GUIDELOCAL
              - OEFFNUNGSZEITENBUCH
              - APPLE_MAPS
              - LOOCAL
              - REGIONAL_DE
              - WHERE_TO
              - TUPALO
              - GELBE_SEITEN
              - DAS_OERTLICHE
              - DIALO
              - BUNDES_TELEFONBUCH
              - BRANCHENBUCH_DEUTSCHLAND
              - MARKTPLATZ_MITTELSTAND
              - BUSQUEDA_LOCAL
              - RICERCARE_IMPRESE
              - PAGES24
              - NAVMII
              - AUDI
              - BMW
              - MERCEDES
              - VW
              - TOYOTA
              - FORD
              - FIAT
              - GM
              - ETRUSTED
              - INSTAGRAM
              - SHOPPING_TIME_NETWORK
              - CITY_SQUARES
              - SHOWMELOCAL
              - LOCALSTACK
              - CHAMBER_OF_COMMERCE
              - JUDYS_BOOK
              - BROWNBOOK
              - MY_LOCAL_SERVICES
              - YA_SABE
              - UNIVISION
              - AL_DIA_TX
              - LA_VOZ_TX
              - CHRON
              - STATESMAN
              - PALM_BEACH_POST
              - MUNDO_HISPANICO
              - EL_TIEMPO_LATINO
              - LATINOS_US
              - HOTFROG
              - INFO_IS_INFO
              - MANTA
              - US_CITY
              - GO_YELLOW
              - N49
              - PRATIQUE
              - JUSTACOTE
              - EZLOCAL
              - ELOCAL
              - TRUE_LOCAL
              - START_LOCAL
              - WOMO
              - AUSSIE_WEB
              - YELLOW_PAGES
              - SUPER_PAGES
              - WHITE_PAGES
              - DEX_KNOWS
              - KAUFDA_MANUAL
              - I_GLOBAL
              - BRANCHEN_INFO_MANUAL
              - GUTE_BANKEN_MANUAL
              - D_11880_COM_MANUAL
              - BANKOEFFNUNGSZEITEN_DE_MANUAL
              - BANK_OEFFNUNGSZEITEN_DE_MANUAL
              - CYLEX_MANUAL
              - FINDE_OFFEN_MANUAL
              - MEIN_PROSPEKT_MANUAL
              - DAS_SCHNELLE
              - SENSIS_WHITE_PAGES
              - SENSIS_TRUE_LOCAL
              - SENSIS_YELLOW_PAGES
              - FIND_OPEN
              - WAND
              - BELL_CA
              - GO_LOCAL
              - MEINUNGSMEISTER
              - YANDEX
              - YAHOO_MANUAL
              - HOLIDAY_CHECK
              - TRIP_ADVISOR
              - BONIAL_FR
              - ZIP_CH
              - PAGES_JAUNES
              - YELLOW_PAGES_SINGAPORE
              - INFOGROUP
              - WAZE_NEW
              - UBER_NEW
              - NEUSTAR
              - TRUSTPILOT
              - AUSKUNFT
              - BAIDU
              - NEXT_DOOR
              - MICROSOFT_CORTANA
              - GOOGLE_ASSISTANT
              - CBANQUE
              - ORANGE_118_712
              - SIRI
              - HUAWEI
              - DOCTOR_COM
              - CARE_DASH
              - DENTAL_PLANS
              - DOC_SPOT
              - HEALTHGRADES
              - SHARE_CARE
              - VITALS
              - WEB_MD
              - WELLNESS
              - ZOC_DOC
              - ZWIVEL
              - YP_COM_HEALTH
              - BING_HEALTH
              - NPPES
              - RATE_MDS
              - CITYSEARCH
              - INSIDER_PAGES
              - TWITTER
              - ALEXA
              - MAP_QUEST
              - WEBSITE_WIDGETS
              - ECO_MOVEMENT
              - GOOGLE_EV
              - APPLE_EV
              - TESLA_EV
              - EUROWAG_EV
              - OPIS_EV
              - TOMTOM_EV
              - HERE_EV
              - YELLOW_PAGES_CANADA
              - BBB
              - UBERALL_SOCIAL_ADS
              - APPLE_APPS
              - CONSUMER_AFFAIRS
              - CREDIT_KARMA
              - DELIVERY
              - GLASSDOOR
              - PLAY_GOOGLE
              - GRUBHUB
              - INDEED
              - LENDING_TREE
              - MENUISM
              - OPEN_TABLE
              - OPEN_TABLE_USA
              - WALLET_HUB
              - ZILLOW
              - ZOMATO
              - WHATS_APP
              - FOUR_SCREEN
              - AND_CHARGE
              - LINKED_IN
        countryPrice:
          type: array
          description: Prices per location for each supported country
          items:
            $ref: '#/components/schemas/ProductPlanCountryPriceResponse'
        currency:
          type: string
          description: The abbreviation of the currency the product plan is charged in.
        defaultPlan:
          type: boolean
          description: >-
            True, if this is the default ProductPlan. A new created business
            will get this product plan, if not declared differently.
        identifier:
          type: string
          description: >-
            The Product Plan identifier based on your internal identification
            system
        description:
          type: string
          description: Description of the plan
        dateCreated:
          type: string
          description: The date and time the Product Plan was created in our database
          format: date-time
        lastUpdated:
          type: string
          description: The date and time the Product Plan was last updated
          format: date-time
        duration:
          type: integer
          description: Duration of the Product Plan in months
          format: int32
        initialDuration:
          type: integer
          description: Initial Duration
          format: int32
        billingPeriod:
          type: integer
          description: Cadency with which an invoice is generated for this Product Plan
          format: int32
        initialBillingPeriod:
          type: integer
          description: Initial Billing Period
          format: int32
        defaultPrice:
          type: integer
          description: >-
            Define a global price for the Product Plan that gets applied for all
            countries
          format: int32
        defaultOriginalPrice:
          type: integer
          description: Default Original Price in cent
          format: int32
        defaultPriceSetup:
          type: integer
          description: Set-up price per location in cent
          format: int32
        defaultMarketDevelopmentFunds:
          type: integer
          description: Default Market Development Funds
          format: int32
        status:
          type: string
          description: One among PENDING_APPROVAL, ACTIVE, INACTIVE
          enum:
            - ACTIVE
            - INACTIVE
            - PENDING_APPROVAL
            - DELETED
      description: Product Plan Response Model
    ProductPlanResponseObject:
      type: object
      properties:
        productPlanResponse:
          allOf:
            - $ref: '#/components/schemas/ProductPlanResponse'
      description: The actual response object of the response
    ProductPlanResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ProductPlanResponseObject'
    ProductSearchObject:
      type: object
      properties:
        total:
          type: integer
          description: The total number of results
          format: int32
          example: 100
        offset:
          type: integer
          description: The offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: The maximum number of results to return
          format: int32
          example: 10
        products:
          type: array
          items:
            $ref: '#/components/schemas/Product'
      description: The actual response object of the response
    ProductSearchWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ProductSearchObject'
    ProductWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ProductObject'
    ProfileCompleteness:
      type: object
      properties:
        averageProfileCompleteness:
          type: integer
          description: >-
            The average of the profile completeness across the locations managed
            by the user
          format: int32
        locationClassificationCounts:
          type: object
          additionalProperties:
            type: integer
            description: The number of locations in each classification
            format: int32
          description: The number of locations in each classification
      description: ProfileCompleteness Model
    ProfileCompletenessWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ProfileCompleteness'
    ProvincesResponse:
      type: object
      properties:
        provinces:
          type: array
          description: List of provinces
          example:
            - Province1
            - Province2
          items:
            type: string
      description: Provinces response model
    ProvincesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ProvincesResponse'
    ResponseBusiness:
      type: object
      properties:
        id:
          type: integer
          description: Business id
          format: int64
        name:
          type: string
          description: Business name
      description: Response business model
    ResponseLocation:
      type: object
      properties:
        id:
          type: integer
          description: Location id
          format: int64
        name:
          type: string
          description: Location name
        business:
          description: Which Business this Location belongs to
          allOf:
            - $ref: '#/components/schemas/ResponseBusiness'
      description: Response Location Model
    ResponseTemplate:
      type: object
      properties:
        id:
          type: integer
          description: The Uberall unique id of the template
          format: int64
        title:
          type: string
          description: The title of the template
        message:
          type: string
          description: The reply's text of the template
        usageCount:
          type: integer
          description: Number of times a template has been used
          format: int64
        status:
          type: string
          description: The status of the template
        tags:
          type: array
          description: The list of tags for the template
          items:
            type: string
        dateCreated:
          type: string
          description: The date in which the template was created
          format: date-time
        lastEdited:
          type: string
          description: The date in which the template was last edited
          format: date-time
        createdBy:
          description: The author who created the template
          allOf:
            - $ref: '#/components/schemas/ResponseUser'
        lastEditedBy:
          description: The author who last edited the template
          allOf:
            - $ref: '#/components/schemas/ResponseUser'
        businesses:
          type: array
          description: The list of business ids the templated was created for
          items:
            type: integer
            format: int32
      description: Response Template Model
    ResponseTemplateWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ResponseTemplate'
    ResponseTemplatesWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          type: array
          description: The actual response object of the response
          items:
            $ref: '#/components/schemas/ResponseTemplate'
    ResponseUser:
      type: object
      properties:
        id:
          type: integer
          description: User id
          format: int64
        firstname:
          type: string
          description: User First Name
        lastname:
          type: string
          description: User Last Name
      description: Response User Model
    ResponseUsersWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          type: array
          description: The actual response object of the response
          items:
            $ref: '#/components/schemas/ResponseUser'
    ResponseValue:
      type: object
      properties:
        response:
          type: string
          description: The review response text
        isOpenAI:
          type: boolean
          description: Whether or not the review response was generated with AI
      description: Response Value Model
    RuleResponse:
      type: object
      properties:
        id:
          type: string
          description: Uniquely identifies this Auto Response Rule
          readOnly: true
        businesses:
          type: array
          description: List of business ids that identify this Auto Response Rule
          items:
            $ref: '#/components/schemas/ResponseBusiness'
        locations:
          type: array
          description: List of location ids that identify this Auto Response Rule
          items:
            $ref: '#/components/schemas/ResponseLocation'
        excludedLocations:
          type: array
          description: >-
            List of location ids that do not identify this Auto Response Rule,
            even when they might belong to a business that does identify this
            rule
          items:
            $ref: '#/components/schemas/ResponseLocation'
        name:
          type: string
          description: Name for this Auto Response Rule
        status:
          type: string
          description: Status of this Auto Response Rule, either ACTIVE or INACTIVE
          enum:
            - ACTIVE
            - INACTIVE
            - DELETED
        triggers:
          type: array
          description: >-
            Triggers that apply to this Auto Response Rule, can be ONE_STAR,
            TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR
          items:
            type: string
        responses:
          type: array
          description: Possible responses for this Auto Response Rule
          items:
            $ref: '#/components/schemas/ResponseValue'
        dateCreated:
          type: string
          description: Date and time of creation
          format: date-time
          readOnly: true
        dateUpdated:
          type: string
          description: Date and time of last update
          format: date-time
          readOnly: true
        canEdit:
          type: boolean
          description: >-
            The current user can edit this rule when they have access to all
            businesses and locations that identify this rule
          readOnly: true
        locationCount:
          type: integer
          description: Count of locations to which this rule applies
          format: int32
          readOnly: true
      description: Rule Response
    RuleResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/RuleResponse'
    RulesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          type: array
          description: The actual response object of the response
          items:
            $ref: '#/components/schemas/RuleResponse'
    SalesPartner:
      type: object
      properties:
        id:
          type: integer
          description: The uberall sales partner id
          format: int64
        aggregateInvoicesToParent:
          type: boolean
          description: >-
            (only used for child SalesPartner) Indicates if the invoice for this
            SalesPartner should be aggregated to the parent invoice
        attribution:
          description: Attribution details of the SalesPartner
          allOf:
            - $ref: '#/components/schemas/Attribution'
        canSeePrices:
          type: boolean
          description: >-
            Indicates if the SalesPartner should be allowed to see price
            information for e.g. product plans
        emailCustomerSupport:
          type: string
          description: Customer support email of the SalesPartner
        emailProjectLead:
          type: string
          description: Project lead email of the SalesPartner
        forceSso:
          type: boolean
          description: >-
            If set to true, all users of this SalesPartner will only be allowed
            to log in our app via the SSO flow. Users cannot be created or
            updated directly - only via SSO. If set to false and "isSsoActive"
            is set, users can either log in via normal login or SSO
        identifier:
          type: string
          description: >-
            Identifier for SalesPartner, must be unique for child SalesPartner
            within parent SalesPartner
        minPasswordLength:
          type: integer
          description: Minimum password length
          format: int32
        name:
          type: string
          description: The name
        phone:
          type: string
          description: The phone number
        preferredLanguage:
          type: string
          description: >-
            Preferred language of the SalesPartner, for invoice purpose (either
            'de' or 'en')
        pushUrl:
          type: string
          description: URL where selected webhook events should be sent to
        salesPartnerStatus:
          type: string
          description: >-
            SalesPartner status of the SalesPartner (Be aware: Only sending
            'INACTIVE' for child SalesPartner update is allowed)
          enum:
            - CREATED
            - APPROVED
            - DECLINED
            - DELETED
            - INACTIVE
        subscribedWebhookEventTypes:
          uniqueItems: true
          type: array
          description: >-
            List of all event types the SalesPartner want to receive push
            messages for via webhook functionality, for a list of all possible
            types use the GET /api/salespartners/subscribable-event-types
            endpoint
          items:
            type: string
            enum:
              - ADMIN_ALERT
              - BRAND_DATA_POINT_REPLIED
              - BRAND_DATA_POINT_REPLIED_PENDING_APPROVAL
              - BRAND_DATA_POINT_REPLY_APPROVE
              - BRAND_DATA_POINT_REPLY_REJECT
              - BUSINESS_CHAIN_UPDATE
              - BUSINESS_CHANGED_SALES_PARTNER
              - BUSINESS_COMMENT
              - BUSINESS_CREATED
              - BUSINESS_CSV_EXPORT
              - BUSINESS_DIRECTORY_ACCOUNT
              - BUSINESS_DIRECTORY_CONNECT
              - BUSINESS_DUPLICATE_CHECK
              - BUSINESS_FACEBOOK_PAGE_INVALIDATE
              - BUSINESS_INVOICE_CHANGED
              - BUSINESS_INVOICE_CREATED
              - BUSINESS_INVOICE_CREATED_ANOTHER_BASIC
              - BUSINESS_INVOICE_CREATED_ANOTHER_PREMIUM
              - BUSINESS_INVOICE_CREATED_FIRST_BASIC
              - BUSINESS_INVOICE_CREATED_FIRST_PREMIUM
              - BUSINESS_INVOICE_CREATED_RENEWAL
              - BUSINESS_INVOICE_CREATED_UPGRADE_BASIC
              - BUSINESS_INVOICE_CREATED_UPGRADE_PREMIUM
              - BUSINESS_INVOICE_RENEWAL_FAIL
              - BUSINESS_INVOICE_RENEWAL_SUCCESS
              - BUSINESS_LOCATION_DATA_PULL
              - BUSINESS_MIGRATE_LOCATION
              - BUSINESS_NEW_CHATS
              - BUSINESS_NEW_CONTACT_FORM
              - BUSINESS_OLO_IMPORT
              - BUSINESS_OLO_SETTINGS_CREATED
              - BUSINESS_OLO_SETTINGS_DELETED
              - BUSINESS_OLO_SETTINGS_UPDATED
              - BUSINESS_PAGE_INVALIDATE
              - BUSINESS_PAY_INVOICE
              - BUSINESS_PRODUCT_PLAN_CHANGED
              - BUSINESS_STATUS_CHANGED
              - BUSINESS_TEMPLATE_UPDATE
              - BUSINESS_UPDATE_PAGE_SOCIAL_POST
              - BUSINESS_UPDATE_PRICE
              - DATA_POINT_AUTOMATED_REPLY
              - DATA_POINT_REPLIED
              - DATA_POINT_REPLIED_PENDING_APPROVAL
              - DATA_POINT_REPLY_APPROVE
              - DATA_POINT_REPLY_REJECT
              - DATA_POINT_SERVICE_NOW_SUBMITTED
              - DIRECTORY_BUSINESS_PAGE_DATA_POINT_CHECK
              - DIRECTORY_BUSINESS_PAGE_DATA_POINT_INVALID
              - LISTING_AUTOVALIDATION_FAILED
              - LISTING_BLACKLIST
              - LISTING_CANCEL
              - LISTING_DATAPOINT_CHECK
              - LISTING_DATAPOINT_INVALID
              - LISTING_DELETE
              - LISTING_DIRECTORY_CONNECT
              - LISTING_DIRECTORY_DUPLICATE_REMOVED
              - LISTING_FACEBOOK_PAGE_INVALIDATE
              - LISTING_FEED_CREATE
              - LISTING_FEED_DUPLICATE_REMOVED
              - LISTING_FEED_IN_SYNC_FIELDS
              - LISTING_FLAGGED
              - LISTING_GOOGLE_PAGE_CREATE
              - LISTING_GOOGLE_PAGE_INVALIDATE
              - LISTING_GOOGLE_PAGE_UPDATE
              - LISTING_INITIATE_OWNERSHIP_TRANSFER
              - LISTING_INVITATION_SENT
              - LISTING_LINK_CHANGE
              - LISTING_MANUAL
              - LISTING_NEEDS_REVIEW_DELETED
              - LISTING_PAGE_INVALIDATE
              - LISTING_PUBLISHER_UPDATE
              - LISTING_REMOVAL_STATUS_CHECK
              - LISTING_REMOVAL_SUPPRESS
              - LISTING_REVIEWED
              - LISTING_STATUS_CHANGE
              - LISTING_SUGGESTION
              - LISTING_SUPPRESS
              - LISTING_SUPPRESS_NOT_ALLOWED
              - LISTING_SYNC_CHECK
              - LISTING_UPDATE
              - LISTING_UPDATE_PAGE_SOCIAL_POST
              - LISTING_UPDATE_SOCIAL_POST
              - LISTING_WAITING_DIRECTORY_ACTION
              - LOCATION_BILLING
              - LOCATION_BUSINESS_CHANGED
              - LOCATION_CHECKOUT
              - LOCATION_CHECKOUT_FREE
              - LOCATION_CHECKOUT_SALESPARTNER
              - LOCATION_CHECKOUT_UPGRADE
              - LOCATION_CLEANSING
              - LOCATION_CONTRACT_UPDATED
              - LOCATION_CREATED
              - LOCATION_DUPLICATE_LISTING_CHECK
              - LOCATION_DUPLICATE_LISTING_DETECTION
              - LOCATION_FEED_CLOSED
              - LOCATION_FEED_PROFILE_CHANGED
              - LOCATION_GEOCODING_MANUAL
              - LOCATION_GOOGLE_RANK_CHECK
              - LOCATION_GROUP_CREATED
              - LOCATION_GROUP_DELETED
              - LOCATION_GROUP_UPDATED
              - LOCATION_INVOICE_CHANGED
              - LOCATION_LISTING_ADDED
              - LOCATION_NEEDS_REVIEW_DELETED
              - LOCATION_NEW_CHATS
              - LOCATION_NEW_CONTACT_FORM
              - LOCATION_NORMALIZATION_STATUS_CHANGED
              - LOCATION_OLO_IMPORT
              - LOCATION_PARTIAL_UPDATE
              - LOCATION_PAY_INVOICE
              - LOCATION_PROFILE_CHANGED
              - LOCATION_PROFILE_SUGGESTION_DECLINE
              - LOCATION_STATUS_CHANGED
              - LOCATION_SUBSCRIPTION_CHANGED
              - LOCATION_SUGGESTION_CREATED
              - LOCATION_SUGGESTION_UPDATED
              - LOCATION_SYNC_STARTED
              - LOCATION_VISIBILITY_INDEX_CHANGED
              - PRODUCT_PLAN_CREATED
              - PRODUCT_PLAN_DELETED
              - PRODUCT_PLAN_UPDATED
              - SALES_PARTNER_APPROVAL
              - SALES_PARTNER_CHILDREN_UPDATED
              - SALES_PARTNER_CREATED
              - SALES_PARTNER_DIRECTORY_BRAND
              - SALES_PARTNER_DIRECTORY_CONNECT
              - SALES_PARTNER_ENTERPRISE_ONBOARDING
              - SALES_PARTNER_INVOICE_CHANGED
              - SALES_PARTNER_INVOICE_PAYMENT_INFORMATION_CHANGED
              - SALES_PARTNER_ONE_AND_ONE_AUTHENTICATION
              - SALES_PARTNER_ONE_AND_ONE_CONTRACT_INFORMATION
              - SALES_PARTNER_PASSWORD_RESET
              - SALES_PARTNER_PAYMENT_METHOD_RESET
              - SALES_PARTNER_PAY_INVOICE
              - SALES_PARTNER_REPRESENTATIVE_UPDATE
              - SALES_PARTNER_SIGNUP
              - SALES_PARTNER_STATUS_CHANGED
              - SALES_PARTNER_TYPE_CHANGED
              - SALES_PARTNER_UPDATED
              - SALES_REPRESENTATIVE_UPDATE
              - SEARCH_DATA_RECHECK_LINK_SHARED
              - USER_ACTIVATION_EMAIL_SENT
              - USER_DASHBOARD_EXPORT_COMPLETE
              - USER_DIGEST_EMAIL_SENT
              - USER_FINISH_VERIFICATION_GOOGLE_EMAIL_SENT
              - USER_INVITATION
              - USER_INVITATION_EMAIL_SENT
              - USER_INVOICE_INVITATION
              - USER_MODIFY_EMAIL_SETTING
              - USER_NOTIFICATION_EMAIL_SENT
              - USER_PASSWORD_RESET
              - USER_PENDING_APPROVAL_REPLY_NOTIFICATION_EMAIL_SENT
              - USER_READ_DATA_POINT
              - USER_START_VERIFICATION_GOOGLE_EMAIL_SENT
              - USER_STATUS_CHANGED
              - USER_TIER1_EMAIL_SENT
              - USER_TIER2_EMAIL_SENT
              - USER_TIER3_EMAIL_SENT
              - USER_UNREAD_DATA_POINT
              - USER_UNREAD_REVIEW_NOTIFICATION_EMAIL_SENT
              - USER_UPDATED
              - USER_SOCIAL_POST_PENDING_APPROVAL_EMAIL_SENT
              - WIDGET_CONFIG_CREATED
              - WIDGET_CONFIG_DELETED
              - WIDGET_CONFIG_PUBLISHED
              - SOCIAL_POST_PENDING_APPROVAL
        whitelistedRedirectUrls:
          uniqueItems: true
          type: array
          description: >-
            Domains that are allowed to be redirected to upon finalizing a
            directory connect flow
          items:
            type: string
        currency:
          type: string
          description: The currency
        entity:
          type: string
          description: Uberall entity
          enum:
            - UBERALL_BV
            - UBERALL_CANADA_INC
            - UBERALL_FR
            - UBERALL_GMBH
            - UBERALL_INC
            - UBERALL_MF
            - UBERALL_UK
        isSsoActive:
          type: boolean
          description: >-
            If set to true this will activate the single sign-on flow for
            logging into our app. Note that all more details need to be set
            before it can be used.
        maxFreeLocations:
          type: integer
          description: Max free locations
          format: int32
        type:
          type: string
          description: The type, e.g. STANDARD or CUSTOM
        whitelabelInformations:
          uniqueItems: true
          type: array
          description: List of the sales partner's white-label information
          items:
            $ref: '#/components/schemas/WhitelabelInformation'
        onboardingStatus:
          type: string
          description: The onboarding status of the SalesPartner
          enum:
            - NOT_STARTED
            - IN_PROGRESS
            - FINISHED
            - ABORTED
        country:
          type: string
          description: The country
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        locationGroupIds:
          type: array
          items:
            type: integer
            format: int64
        contactPerson:
          type: integer
          description: The contact person
          format: int64
        address:
          type: string
          description: Full address field including street, zip and city.
        emailAccounting:
          type: string
          description: Accounting email of the SalesPartner
        parentId:
          type: integer
          format: int64
        vatId:
          type: string
      description: Sales Partner Model
    SalesPartnerGenericPhotoListResponseObject:
      type: object
      properties:
        photos:
          type: array
          items:
            $ref: '#/components/schemas/SalesPartnerGenericPhotoResponse'
        offset:
          type: integer
          description: The offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: The maximum number of photos to return
          format: int32
          example: 10
        count:
          type: integer
          description: The total count of found photos
          format: int32
          example: 100
      description: The actual response object of the response
    SalesPartnerGenericPhotoListResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SalesPartnerGenericPhotoListResponseObject'
    SalesPartnerGenericPhotoResponse:
      type: object
    SalesPartnerListResponseObject:
      type: object
      properties:
        count:
          type: integer
          description: The total count of found children
          format: int32
          example: 6
        pageCount:
          type: integer
          description: The number of children on the current page
          format: int32
          example: 6
        max:
          type: integer
          description: The maximum number of results to return
          format: int32
          example: 10
        offset:
          type: integer
          description: The offset for pagination
          format: int32
          example: 0
        children:
          type: array
          example:
            - id: 270
              identifier: null
              name: Dreamscape Networks FZ-LLC
              privateKey: >-
                c1Y3fRvwe0GHVEH5eM4TDZxousDwykwhv1lDRIhSeHAEVp5pLWiWdkbN3pJjwGBRATpQzXlh8MhIoYTaRX3MuyoDJBYHDwI3gJJIOjZX0KCGQj7HCdy7WEsc2Z66aFaD
              status: APPROVED
            - id: 464
              identifier: null
              name: Touch Local Ltd
              privateKey: bWSWLIjiwIlUeToEeqvt8mS4DfSil5td9Lb06Xqbnmm5Z62cXTEAtN4UIG0pUtOr
              status: APPROVED
            - id: 3518
              identifier: null
              name: Test Account
              privateKey: >-
                grB76Xs3qRBknUWvMoMHirTY8wfSJ2ipLyxX2rTBw63QCs45M6hh9DB5F8vBNgIFDoytsziYF8pA6XokCrVCqaOFzz5VR7Nj1W5sUWnpYXQdk1hLswvJrh2FIqIv2667
              status: APPROVED
            - id: 3519
              identifier: null
              name: Web.com
              privateKey: >-
                zU2peIsy4VJGMuEnNmCdNfawF5hyQdw9pNk7sIdibljeAafuqjKFCb81yiyUcMfN9fstjpKFniRow6E5VGHWAB3rwJtY697PoFpnplPKnmhJaLoZlVpj2i7yzHhWVGhV
              status: APPROVED
            - id: 3763
              identifier: null
              name: Network Solutions
              privateKey: >-
                sQwJtLBRPi3vV978gDyydnUx8YQsGRKvih3BI6Zcr965BTQ3GSM4LmJTenZChqZnPbJ6tY85Li5GEUnQAgAJf3JYarhu2i5lnWmY9mNG9MWSxVOhIrGk2dEvineVhyGO
              status: APPROVED
            - id: 3764
              identifier: null
              name: Register.com
              privateKey: >-
                wsISftqTjOOdoPlz3b7elRN7pFW20tLs8nWRubmUScRWr0dfyxUmLAGpTXPwMeOkuRl2Y590R39cTUoPSuzVGTerLAaYkib7jjB5gTOtk0y3hvlPpyARHPW6NosApUOk
              status: APPROVED
          items:
            $ref: '#/components/schemas/SalesPartnerResponseModel'
      description: The actual response object of the response
    SalesPartnerListResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SalesPartnerListResponseObject'
    SalesPartnerResponseModel:
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique SalesPartner id
          format: int64
        identifier:
          type: string
          description: >-
            Identifier for SalesPartner, must be unique for child SalesPartner
            within parent SalesPartner
        name:
          type: string
          description: Name of SalesPartner
        status:
          type: string
          description: Sales Partner Status Enum
          enum:
            - CREATED
            - APPROVED
            - DECLINED
            - DELETED
            - INACTIVE
        privateKey:
          type: string
          description: >-
            PrivateKey of the SalesPartner (only filled for APPROVED
            SalesPartners)
    SalesPartnerWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SalesPartnerWrapperObject'
    SalesPartnerWrapperObject:
      type: object
      properties:
        salesPartner:
          allOf:
            - $ref: '#/components/schemas/SalesPartner'
      description: The actual response object of the response
    SearchData:
      required:
        - id
      type: object
      properties:
        id:
          type: integer
          description: The uberall unique id
          format: int64
        name:
          type: string
          description: The location's name
        street:
          type: string
          description: The location's street address
        streetNo:
          type: string
          description: The location's street number
        city:
          type: string
          description: City
        zip:
          type: string
          description: Zip code
        country:
          type: string
          description: Country. One of AT, CH, DE, ES, UK, FR, IT, NL
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        token:
          type: string
          description: The token you will need for /api/search/$id
      description: Search Data
    SearchDataListObject:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/SearchData'
        offset:
          type: integer
          description: The offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: The maximum number of results to return
          format: int32
          example: 10
        count:
          type: integer
          description: The total count of search data
          format: int32
          example: 100
      description: The actual response object of the response
    SearchDataListWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SearchDataListObject'
    SearchDataObject:
      type: object
      properties:
        searchData:
          allOf:
            - $ref: '#/components/schemas/SearchData'
        alreadyManaged:
          type: boolean
          description: Indicates if the search data is already managed
          example: true
      description: The actual response object of the response
    SearchDataWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SearchDataObject'
    ServiceArea:
      required:
        - name
        - placeId
      type: object
      properties:
        name:
          type: string
          description: The name of the service area, e.g. Berlin, Deutschland
          example: Berlin, Deutschland
        placeId:
          type: string
          description: >-
            A unique place id , e.g. ChIJAVkDPzdOqEcRcDteW0YgIQQ, Place IDs
            uniquely identify a place in the Google Places database and on
            Google Maps. Please visit
            https://developers.google.com/places/place-id for more info
          example: ChIJAVkDPzdOqEcRcDteW0YgIQQ
      description: >-
        The areas where this location offers service, e.g. useful for food
        delivery
    ServiceItem:
      required:
        - title
      type: object
      properties:
        title:
          type: string
          description: Name of the service item as represented at the location
        description:
          type: string
          description: A description of the service
        identifier:
          type: string
          description: Required - A unique identifier for this service
        listName:
          type: string
        price:
          type: integer
          description: Price of the service item
          format: int32
        currency:
          type: object
          description: >-
            The currency of the price for this service - required when a price
            is given
        category:
          type: integer
          description: >-
            Business category the service should be applied to - this is
            required when applying a Google structured service but not necessary
            for freeform services.
          format: int64
        country:
          type: string
          description: >-
            The country where the locations providing this service are located -
            this is required when applying a Google structured service but not
            necessary for freeform services.
        googleService:
          type: string
          description: >-
            The Google name for a structured service - this is required when
            applying a Google structured service but not necessary for freeform
            services.
      description: Service Item
    ServiceItemObject:
      type: object
      description: The actual response object of the response
    ServiceItemSearchObject:
      type: object
      properties:
        query:
          type: string
          description: The search query
          example: service
        offset:
          type: integer
          description: The offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: The maximum number of results to return
          format: int32
          example: 10
        serviceItems:
          type: array
          items:
            $ref: '#/components/schemas/ServiceItem'
      description: The actual response object of the response
    ServiceItemSearchWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ServiceItemSearchObject'
    ServiceItemWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/ServiceItemObject'
    SocialPost:
      required:
        - directories
        - publicationDate
        - type
      type: object
      properties:
        title:
          type: string
          description: >-
            The title of the Social Post. For type QUESTION_AND_ANSWER this is
            going to be the question.
        description:
          type: string
          description: >-
            The description of the Social Post. For type QUESTION_AND_ANSWER
            this is going to be the answer.
        url:
          type: string
          description: >-
            A link for the Social Post. This is mandatory for a "Special Offer"
            and should point to a page concerning the offer.
        type:
          type: string
          description: >-
            The type of the Social Post. POST, OFFER, QUESTION_AND_ANSWER, EVENT
            or ALERT.
          enum:
            - POST
            - OFFER
            - ALERT
            - EVENT
            - QUESTION_AND_ANSWER
            - REEL
            - STORY
            - CAROUSEL
        alertType:
          type: string
          description: A special type for Google ALERT posts. Possible values are COVID_19.
          enum:
            - COVID_19
        id:
          type: integer
          description: Id
          format: int64
        status:
          type: string
          description: >-
            The current status of the Social Post (scheduled, active, inactive,
            deleted, not_published, published, impossible)
          enum:
            - SCHEDULED
            - APPROVAL_NEEDED
            - ACTIVE
            - INACTIVE
            - DELETED
            - IMPOSSIBLE
            - INCOMPLETE
            - ENDED
            - REJECTED
        dateStart:
          type: string
          description: >-
            The starting date of EVENT and OFFER type Social Posts. It is used
            to indicate when an EVENT/OFFER will start. For API versions older
            than 20210804, it is used as publicationDate.
          format: date-time
        dateEnd:
          type: string
          description: >-
            The ending date of the Social Post (type=OFFER). The post will be
            removed from the listings at that date. It also determines when a
            special offer should end.
          format: date-time
        publicationDate:
          type: string
          description: >-
            The date on which the Social Post will be published. It is used to
            schedule posts in the future. Format: YYYY-MM-dd'T'HH:mm:ssXXXXX 
            (Example: 2007-12-03T10:15:30+01:00)
          format: date-time
          example: '2024-06-25T11:01:00Z'
        isStoreLocator:
          type: boolean
          description: When enabled, the SocialPost will be visible in StoreLocator.
        productName:
          type: string
          description: >-
            The name of the product for a Product Social Post. A Social Post
            becomes a Product Social Post if that field is set.
        timeZone:
          type: string
          description: The timezone in which the Social Post should be created
          example: Europe/Berlin
        productPriceMin:
          type: integer
          description: >-
            Lower price of a Product Social Post if the product has a price
            range, or the price for the product.
          format: int32
        productPriceMax:
          type: integer
          description: >-
            Upper price of the product for Product Social Post. If the price is
            just a single price and not a range, set only productPriceMin.
          format: int32
        productCurrency:
          type: string
          description: >-
            The currency of a Product Social Post. It is a 3-letters symbol
            (EUR, USD, ...).
          enum:
            - EUR
            - USD
            - GBP
            - CHF
            - AUD
            - RUB
            - JPY
            - AED
            - AFN
            - ALL
            - AMD
            - ANG
            - AOA
            - ARS
            - AWG
            - AZN
            - BAM
            - BBD
            - BDT
            - BGN
            - BHD
            - BIF
            - BMD
            - BND
            - BOB
            - BOV
            - BRL
            - BSD
            - BTN
            - BWP
            - BYR
            - BZD
            - CAD
            - CDF
            - CHE
            - CHW
            - CLF
            - CLP
            - CNY
            - COP
            - COU
            - CRC
            - CUC
            - CUP
            - CVE
            - CZK
            - DJF
            - DKK
            - DOP
            - DZD
            - EGP
            - ERN
            - ETB
            - FJD
            - FKP
            - GEL
            - GHS
            - GIP
            - GMD
            - GNF
            - GTQ
            - GYD
            - HKD
            - HNL
            - HRK
            - HTG
            - HUF
            - IDR
            - ILS
            - INR
            - IQD
            - IRR
            - ISK
            - JMD
            - JOD
            - KES
            - KGS
            - KHR
            - KMF
            - KPW
            - KRW
            - KWD
            - KYD
            - KZT
            - LAK
            - LBP
            - LKR
            - LRD
            - LSL
            - LTL
            - LYD
            - MAD
            - MDL
            - MGA
            - MKD
            - MMK
            - MNT
            - MOP
            - MRO
            - MUR
            - MVR
            - MWK
            - MXN
            - MXV
            - MYR
            - MZN
            - NAD
            - NGN
            - NIO
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - PYG
            - QAR
            - RON
            - RSD
            - RWF
            - SAR
            - SBD
            - SCR
            - SDG
            - SEK
            - SGD
            - SHP
            - SLL
            - SOS
            - SRD
            - SSP
            - STD
            - SVC
            - SYP
            - SZL
            - THB
            - TJS
            - TMT
            - TND
            - TOP
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - UGX
            - USN
            - UYI
            - UYU
            - UZS
            - VEF
            - VND
            - VUV
            - WST
            - XAF
            - XCD
            - XDR
            - XOF
            - XPF
            - XSU
            - XUA
            - YER
            - ZAR
            - ZMW
            - ZWL
        labels:
          uniqueItems: true
          type: array
          description: >-
            The list of location labels as entered when creating/updating the
            Social Post.
          example: '[''Campaign2018'', ''EastCoast'']'
          items:
            type: string
        photos:
          type: array
          description: The social post's photos
          items:
            $ref: '#/components/schemas/SocialPostPhoto'
        callToActions:
          type: array
          description: Social Post Call to Action
          items:
            $ref: '#/components/schemas/SocialPostCallToAction'
        firstComment:
          type: string
          description: >-
            The first comment to be posted after a post creation. Only available
            for INSTAGRAM
        mentions:
          type: array
          description: The mentions of the social post
          items:
            $ref: '#/components/schemas/SocialPostMentions'
        statusPerDirectory:
          type: object
          additionalProperties:
            type: string
            description: Status of the post per directory
            example: '{"GOOGLE":"SCHEDULED","FACEBOOK":"PUBLISHED"}'
            enum:
              - SCHEDULED
              - APPROVAL_NEEDED
              - IN_PROGRESS
              - PUBLISHED
              - FAILED
              - INACTIVE
              - PARTIALLY_PUBLISHED
          description: Status of the post per directory
          example:
            GOOGLE: SCHEDULED
            FACEBOOK: PUBLISHED
        publicationsCount:
          type: integer
          description: Publications count
          format: int64
        canEdit:
          type: boolean
        locationName:
          type: string
        businessName:
          type: string
        warnings:
          type: array
          items:
            type: string
        insights:
          type: array
          items:
            $ref: '#/components/schemas/SocialPostInsights'
        owner:
          allOf:
            - $ref: '#/components/schemas/SocialPostOwner'
        businessIds:
          type: array
          description: >-
            The list of businesses IDs as entered when creating/updating the
            Social Post.
          items:
            type: integer
            format: int64
        locationIds:
          type: array
          description: >-
            The list of locations IDs as entered when creating/updating the
            Social Post.
          items:
            type: integer
            format: int64
        listingPages:
          type: array
          description: >-
            The list of listing page IDs as entered when creating/updating the
            Social Post.
          items:
            type: integer
            format: int64
        businessPages:
          type: array
          description: >-
            The list of business page IDs as entered when creating/updating the
            Social Post.
          items:
            type: integer
            format: int64
        locationGroups:
          type: array
          items:
            type: integer
            format: int64
        excludedLocationIds:
          type: array
          description: >-
            List of locationIds that should be excluded from the request. Can be
            used in combination with businessId when some locations should not
            be considered.
          items:
            type: integer
            format: int64
        directories:
          type: array
          description: >-
            The list of directories as entered when creating/updating the Social
            Post.
          items:
            $ref: '#/components/schemas/SocialPostDirectory'
        couponCode:
          type: string
          description: >-
            A couponCode for redeeming a "Special Offer"
            (SocialPost.type=OFFER). Currently only supported for Google Posts.
        termsAndConditions:
          type: string
          description: >-
            Terms and Conditions for redeeming a "Special Offer"
            (SocialPost.type=OFFER). Currently only supported for Google Posts.
        videos:
          type: array
          description: The video of the social post (can only be one)
          items:
            type: string
      description: >-
        A Social Post is a message for your customers that will be published on
        some of your listings. This can be a "News", a "Special Offer" or a
        "Question and Answer".
    SocialPostCallToAction:
      type: object
      properties:
        url:
          type: string
        directory:
          type: string
        type:
          type: string
      description: Social Post Call To Action Model
    SocialPostDirectoriesResponse:
      type: object
      properties:
        directories:
          type: array
          description: List of directories that are eligible for a post
          items:
            type: string
            enum:
              - FOURSQUARE
              - UBER
              - GOOGLE
              - WAZE
              - GOOGLE_MAPS
              - YELP
              - YELP_API
              - MEINESTADT
              - YELLOW_MAP
              - FOCUS
              - LOKALEAUSKUNFT
              - WEB_DE
              - GMX
              - ONE_AND_ONE
              - FREIEAUSKUNFT
              - POINTOO
              - NOKIA_HERE
              - FACEBOOK
              - TOMTOM
              - STADTBRANCHENBUCH
              - CYLEX
              - UNTERNEHMENSAUSKUNFT
              - ACOMPIO
              - BUSINESSBRANCHENBUCH
              - YALWA
              - THE_PHONEBOOK
              - SCOOT
              - CENTRAL_INDEX
              - CITIPAGES
              - ONE_NINE_TWO
              - ONE_ONE_EIGHT
              - THE_DAILY_RECORD
              - THE_EVENING_STANDARD
              - THE_SCOTSMAN
              - LIVERPOOL_ECHO
              - THE_SUN
              - THE_INDEPENDENT
              - TOUCH_LOCAL
              - THE_MIRROR
              - ANNUAIRE
              - INFOBEL
              - US_INFO_COM
              - GARMIN
              - FACTUAL
              - BING
              - WO_GIBTS_WAS
              - KOOMIO
              - ABCLOCAL
              - YELLBO
              - JELLOO
              - GUIDELOCAL
              - OEFFNUNGSZEITENBUCH
              - APPLE_MAPS
              - LOOCAL
              - REGIONAL_DE
              - WHERE_TO
              - TUPALO
              - GELBE_SEITEN
              - DAS_OERTLICHE
              - DIALO
              - BUNDES_TELEFONBUCH
              - BRANCHENBUCH_DEUTSCHLAND
              - MARKTPLATZ_MITTELSTAND
              - BUSQUEDA_LOCAL
              - RICERCARE_IMPRESE
              - PAGES24
              - NAVMII
              - AUDI
              - BMW
              - MERCEDES
              - VW
              - TOYOTA
              - FORD
              - FIAT
              - GM
              - ETRUSTED
              - INSTAGRAM
              - SHOPPING_TIME_NETWORK
              - CITY_SQUARES
              - SHOWMELOCAL
              - LOCALSTACK
              - CHAMBER_OF_COMMERCE
              - JUDYS_BOOK
              - BROWNBOOK
              - MY_LOCAL_SERVICES
              - YA_SABE
              - UNIVISION
              - AL_DIA_TX
              - LA_VOZ_TX
              - CHRON
              - STATESMAN
              - PALM_BEACH_POST
              - MUNDO_HISPANICO
              - EL_TIEMPO_LATINO
              - LATINOS_US
              - HOTFROG
              - INFO_IS_INFO
              - MANTA
              - US_CITY
              - GO_YELLOW
              - N49
              - PRATIQUE
              - JUSTACOTE
              - EZLOCAL
              - ELOCAL
              - TRUE_LOCAL
              - START_LOCAL
              - WOMO
              - AUSSIE_WEB
              - YELLOW_PAGES
              - SUPER_PAGES
              - WHITE_PAGES
              - DEX_KNOWS
              - KAUFDA_MANUAL
              - I_GLOBAL
              - BRANCHEN_INFO_MANUAL
              - GUTE_BANKEN_MANUAL
              - D_11880_COM_MANUAL
              - BANKOEFFNUNGSZEITEN_DE_MANUAL
              - BANK_OEFFNUNGSZEITEN_DE_MANUAL
              - CYLEX_MANUAL
              - FINDE_OFFEN_MANUAL
              - MEIN_PROSPEKT_MANUAL
              - DAS_SCHNELLE
              - SENSIS_WHITE_PAGES
              - SENSIS_TRUE_LOCAL
              - SENSIS_YELLOW_PAGES
              - FIND_OPEN
              - WAND
              - BELL_CA
              - GO_LOCAL
              - MEINUNGSMEISTER
              - YANDEX
              - YAHOO_MANUAL
              - HOLIDAY_CHECK
              - TRIP_ADVISOR
              - BONIAL_FR
              - ZIP_CH
              - PAGES_JAUNES
              - YELLOW_PAGES_SINGAPORE
              - INFOGROUP
              - WAZE_NEW
              - UBER_NEW
              - NEUSTAR
              - TRUSTPILOT
              - AUSKUNFT
              - BAIDU
              - NEXT_DOOR
              - MICROSOFT_CORTANA
              - GOOGLE_ASSISTANT
              - CBANQUE
              - ORANGE_118_712
              - SIRI
              - HUAWEI
              - DOCTOR_COM
              - CARE_DASH
              - DENTAL_PLANS
              - DOC_SPOT
              - HEALTHGRADES
              - SHARE_CARE
              - VITALS
              - WEB_MD
              - WELLNESS
              - ZOC_DOC
              - ZWIVEL
              - YP_COM_HEALTH
              - BING_HEALTH
              - NPPES
              - RATE_MDS
              - CITYSEARCH
              - INSIDER_PAGES
              - TWITTER
              - ALEXA
              - MAP_QUEST
              - WEBSITE_WIDGETS
              - ECO_MOVEMENT
              - GOOGLE_EV
              - APPLE_EV
              - TESLA_EV
              - EUROWAG_EV
              - OPIS_EV
              - TOMTOM_EV
              - HERE_EV
              - YELLOW_PAGES_CANADA
              - BBB
              - UBERALL_SOCIAL_ADS
              - APPLE_APPS
              - CONSUMER_AFFAIRS
              - CREDIT_KARMA
              - DELIVERY
              - GLASSDOOR
              - PLAY_GOOGLE
              - GRUBHUB
              - INDEED
              - LENDING_TREE
              - MENUISM
              - OPEN_TABLE
              - OPEN_TABLE_USA
              - WALLET_HUB
              - ZILLOW
              - ZOMATO
              - WHATS_APP
              - FOUR_SCREEN
              - AND_CHARGE
              - LINKED_IN
        totalLocationsCount:
          type: integer
          description: Total amount of considered directories
          format: int32
        directoryWarnings:
          type: array
          description: List of warnings for directories
          items:
            $ref: '#/components/schemas/SocialPostDirectoryWarning'
        locationWarnings:
          type: array
          description: List of warnings for locations
          items:
            $ref: '#/components/schemas/SocialPostWarning'
        googleAlertTypes:
          type: array
          description: Currently active types for Google ALERT
          items:
            type: string
      description: Social Post Directories Response Model
    SocialPostDirectoriesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SocialPostDirectoriesResponse'
    SocialPostDirectory:
      type: object
      properties:
        type:
          type: string
          description: The type of the directory
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
        url:
          type: string
          description: The URL of the directory
      description: Social Post Directory
    SocialPostDirectoryWarning:
      type: object
    SocialPostInsights:
      type: object
      properties:
        metrics:
          type: object
          additionalProperties:
            type: integer
            description: Metrics
            format: int64
          description: Metrics
          example:
            name: string
            value: string
      description: Social Post Insights Model
    SocialPostMentions:
      type: object
      properties:
        id:
          type: string
          description: Id
        name:
          type: string
          description: Name
        link:
          type: string
          description: Link
        avatar:
          type: string
          description: Avatar
      description: Social Post Mentions
    SocialPostOwner:
      type: object
      properties:
        id:
          type: integer
          description: User id
          format: int64
        name:
          type: string
          description: Firstname and lastname of the user.
        isApiAdmin:
          type: boolean
      description: Social Post Owner Model
    SocialPostPhoto:
      type: object
      properties:
        redirectUrl:
          type: string
        description:
          type: string
        photo:
          type: string
      description: Social Post Photo Model
    SocialPostResponseObject:
      type: object
      properties:
        socialPost:
          description: >-
            A Social Post is a message for your customers that will be published
            on some of your listings. This can be a "News", a "Special Offer" or
            a "Question and Answer".
          allOf:
            - $ref: '#/components/schemas/SocialPost'
      description: The actual response object of the response
    SocialPostResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SocialPostResponseObject'
    SocialPostTemplate:
      required:
        - type
        - userId
      type: object
      properties:
        title:
          type: string
          description: The title of the Social Post Template.
        description:
          type: string
          description: >-
            The description of the Social Post Template. It is required if the
            template has no photos.
        url:
          type: string
          description: A link for the Social Post Template.
        type:
          type: string
          description: >-
            The type of the Social Post Template. POST, OFFER or
            QUESTION_AND_ANSWER, EVENT or ALERT.
          enum:
            - POST
            - OFFER
            - ALERT
            - EVENT
            - QUESTION_AND_ANSWER
            - REEL
            - STORY
            - CAROUSEL
        alertType:
          type: string
          description: >-
            Set to COVID_19 if this Social Post Template is a COVID-19 Google
            Alert Post
          enum:
            - COVID_19
        shared:
          type: boolean
          description: Defines if the Social Post Template is shared or not.
        isStoreLocator:
          type: boolean
          description: When enabled, the SocialPost will be visible in StoreLocator
        callToActions:
          type: array
          description: Social Post Call to Action Description (URL & Type)
          items:
            $ref: '#/components/schemas/SocialPostTemplateCallToAction'
        directories:
          type: array
          items:
            type: string
            enum:
              - FOURSQUARE
              - UBER
              - GOOGLE
              - WAZE
              - GOOGLE_MAPS
              - YELP
              - YELP_API
              - MEINESTADT
              - YELLOW_MAP
              - FOCUS
              - LOKALEAUSKUNFT
              - WEB_DE
              - GMX
              - ONE_AND_ONE
              - FREIEAUSKUNFT
              - POINTOO
              - NOKIA_HERE
              - FACEBOOK
              - TOMTOM
              - STADTBRANCHENBUCH
              - CYLEX
              - UNTERNEHMENSAUSKUNFT
              - ACOMPIO
              - BUSINESSBRANCHENBUCH
              - YALWA
              - THE_PHONEBOOK
              - SCOOT
              - CENTRAL_INDEX
              - CITIPAGES
              - ONE_NINE_TWO
              - ONE_ONE_EIGHT
              - THE_DAILY_RECORD
              - THE_EVENING_STANDARD
              - THE_SCOTSMAN
              - LIVERPOOL_ECHO
              - THE_SUN
              - THE_INDEPENDENT
              - TOUCH_LOCAL
              - THE_MIRROR
              - ANNUAIRE
              - INFOBEL
              - US_INFO_COM
              - GARMIN
              - FACTUAL
              - BING
              - WO_GIBTS_WAS
              - KOOMIO
              - ABCLOCAL
              - YELLBO
              - JELLOO
              - GUIDELOCAL
              - OEFFNUNGSZEITENBUCH
              - APPLE_MAPS
              - LOOCAL
              - REGIONAL_DE
              - WHERE_TO
              - TUPALO
              - GELBE_SEITEN
              - DAS_OERTLICHE
              - DIALO
              - BUNDES_TELEFONBUCH
              - BRANCHENBUCH_DEUTSCHLAND
              - MARKTPLATZ_MITTELSTAND
              - BUSQUEDA_LOCAL
              - RICERCARE_IMPRESE
              - PAGES24
              - NAVMII
              - AUDI
              - BMW
              - MERCEDES
              - VW
              - TOYOTA
              - FORD
              - FIAT
              - GM
              - ETRUSTED
              - INSTAGRAM
              - SHOPPING_TIME_NETWORK
              - CITY_SQUARES
              - SHOWMELOCAL
              - LOCALSTACK
              - CHAMBER_OF_COMMERCE
              - JUDYS_BOOK
              - BROWNBOOK
              - MY_LOCAL_SERVICES
              - YA_SABE
              - UNIVISION
              - AL_DIA_TX
              - LA_VOZ_TX
              - CHRON
              - STATESMAN
              - PALM_BEACH_POST
              - MUNDO_HISPANICO
              - EL_TIEMPO_LATINO
              - LATINOS_US
              - HOTFROG
              - INFO_IS_INFO
              - MANTA
              - US_CITY
              - GO_YELLOW
              - N49
              - PRATIQUE
              - JUSTACOTE
              - EZLOCAL
              - ELOCAL
              - TRUE_LOCAL
              - START_LOCAL
              - WOMO
              - AUSSIE_WEB
              - YELLOW_PAGES
              - SUPER_PAGES
              - WHITE_PAGES
              - DEX_KNOWS
              - KAUFDA_MANUAL
              - I_GLOBAL
              - BRANCHEN_INFO_MANUAL
              - GUTE_BANKEN_MANUAL
              - D_11880_COM_MANUAL
              - BANKOEFFNUNGSZEITEN_DE_MANUAL
              - BANK_OEFFNUNGSZEITEN_DE_MANUAL
              - CYLEX_MANUAL
              - FINDE_OFFEN_MANUAL
              - MEIN_PROSPEKT_MANUAL
              - DAS_SCHNELLE
              - SENSIS_WHITE_PAGES
              - SENSIS_TRUE_LOCAL
              - SENSIS_YELLOW_PAGES
              - FIND_OPEN
              - WAND
              - BELL_CA
              - GO_LOCAL
              - MEINUNGSMEISTER
              - YANDEX
              - YAHOO_MANUAL
              - HOLIDAY_CHECK
              - TRIP_ADVISOR
              - BONIAL_FR
              - ZIP_CH
              - PAGES_JAUNES
              - YELLOW_PAGES_SINGAPORE
              - INFOGROUP
              - WAZE_NEW
              - UBER_NEW
              - NEUSTAR
              - TRUSTPILOT
              - AUSKUNFT
              - BAIDU
              - NEXT_DOOR
              - MICROSOFT_CORTANA
              - GOOGLE_ASSISTANT
              - CBANQUE
              - ORANGE_118_712
              - SIRI
              - HUAWEI
              - DOCTOR_COM
              - CARE_DASH
              - DENTAL_PLANS
              - DOC_SPOT
              - HEALTHGRADES
              - SHARE_CARE
              - VITALS
              - WEB_MD
              - WELLNESS
              - ZOC_DOC
              - ZWIVEL
              - YP_COM_HEALTH
              - BING_HEALTH
              - NPPES
              - RATE_MDS
              - CITYSEARCH
              - INSIDER_PAGES
              - TWITTER
              - ALEXA
              - MAP_QUEST
              - WEBSITE_WIDGETS
              - ECO_MOVEMENT
              - GOOGLE_EV
              - APPLE_EV
              - TESLA_EV
              - EUROWAG_EV
              - OPIS_EV
              - TOMTOM_EV
              - HERE_EV
              - YELLOW_PAGES_CANADA
              - BBB
              - UBERALL_SOCIAL_ADS
              - APPLE_APPS
              - CONSUMER_AFFAIRS
              - CREDIT_KARMA
              - DELIVERY
              - GLASSDOOR
              - PLAY_GOOGLE
              - GRUBHUB
              - INDEED
              - LENDING_TREE
              - MENUISM
              - OPEN_TABLE
              - OPEN_TABLE_USA
              - WALLET_HUB
              - ZILLOW
              - ZOMATO
              - WHATS_APP
              - FOUR_SCREEN
              - AND_CHARGE
              - LINKED_IN
        ownerId:
          type: integer
          description: >-
            The id of the user that owns the Social Post Template. (Only
            informational. If included in the request, it will be ignored.)
          format: int64
        ownerName:
          type: string
          description: >-
            The name of the user that owns the Social Post Template. (Only
            informational. If included in the request, it will be ignored.)
        videos:
          type: array
          description: List of videos (currently only supports one element)
          items:
            type: string
        userId:
          type: integer
          description: Id of the user that is doing the action
          format: int64
        photos:
          type: array
          description: >-
            The Social Post Template's photos. It should be a list containing
            BASE64 converted images or urls of photos from a previous Social
            Post. It is required if the template has no description.
          items:
            $ref: '#/components/schemas/PhotoContainer'
      description: Social Post Template Model
    SocialPostTemplateCallToAction:
      type: object
      properties:
        url:
          type: string
          description: The url of the call to action.
        type:
          type: string
          description: The type of the call to action.
          enum:
            - CALL
            - LEARN_MORE
            - SIGN_UP
            - DOWNLOAD
            - DIRECTIONS
            - WEBSITE
            - BOOK_TRAVEL
            - INSTALL_APP
            - LISTEN_MUSIC
            - NO_BUTTON
            - USE_APP
            - WATCH_MORE
            - WATCH_VIDEO
            - BOOK
            - ORDER
            - SHOP
            - APPLY
            - VIEW_QUOTE
            - SUBSCRIBE
            - REGISTER
            - JOIN
            - ATTEND
            - REQUEST_DEMO
            - SEE_MORE
        directory:
          type: string
          description: The directory of the call to action.
          enum:
            - FACEBOOK
            - GOOGLE
            - APPLE_MAPS
            - LINKED_IN
      description: Social Post Template Call To Action Model
    SocialPostTemplateResponseObject:
      type: object
      properties:
        socialPostTemplate:
          allOf:
            - $ref: '#/components/schemas/SocialPostTemplate'
      description: The actual response object of the response
    SocialPostTemplateResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SocialPostTemplateResponseObject'
    SocialPostTemplatesResponseObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        count:
          type: integer
          description: Count of social post templates
          format: int32
          example: 5
        socialPostTemplates:
          type: array
          items:
            $ref: '#/components/schemas/SocialPostTemplate'
      description: The actual response object of the response
    SocialPostTemplatesResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SocialPostTemplatesResponseObject'
    SocialPostWarning:
      type: object
    SocialPostWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          description: >-
            A Social Post is a message for your customers that will be published
            on some of your listings. This can be a "News", a "Special Offer" or
            a "Question and Answer".
          allOf:
            - $ref: '#/components/schemas/SocialPost'
    SocialPostsResponseObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        count:
          type: integer
          description: Count of social posts
          format: int32
          example: 5
        socialPosts:
          type: array
          items:
            $ref: '#/components/schemas/SocialPost'
      description: The actual response object of the response
    SocialPostsResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SocialPostsResponseObject'
    SocialProfile:
      type: object
      properties:
        url:
          type: string
          description: Url of the Social Profile
        type:
          type: string
          description: >-
            Social Profile Type. Values: [FACEBOOK, LINKEDIN, TWITTER, YOUTUBE,
            XING, INSTAGRAM, FOURSQUARE, PINTEREST]
          enum:
            - FACEBOOK
            - LINKEDIN
            - TWITTER
            - YOUTUBE
            - XING
            - INSTAGRAM
            - FOURSQUARE
            - PINTEREST
            - VIMEO
      description: Social Profile
    SortableData:
      type: object
      properties:
        activeDirectoriesCount:
          type: integer
          description: Output only. Number of active directories
          format: int32
        activeListingsCount:
          type: integer
          description: Output only. Number of active listings
          format: int32
        publishedListingsCount:
          type: integer
          description: Number of managed online listings
          format: int32
        visibilityIndex:
          type: integer
          description: Latest Visibility Index
          format: int32
        dataPoints:
          type: integer
          description: Number of datapoints
          format: int32
        businessId:
          type: integer
          description: Uberall Identifier of the location's business
          format: int64
        salesPartnerId:
          type: integer
          description: Uberall identifier of the SalesPartner
          format: int64
        profileCompleteness:
          type: integer
          description: >-
            Output only. Number representing completeness of location data, up
            to 100
          format: int32
        missingMandatoryFields:
          type: array
          description: >-
            Output only. Compile all the fields that are currently missing but
            mandatory for some directories. They have to be set in the Location
            object, so that the Listing can be created / updated on the
            respective platform. List of Strings, e.g. [NAME, ZIP, PHONE]
          example: '[NAME, ZIP, PHONE]'
          items:
            type: string
            enum:
              - NAME
              - NAME_DESCRIPTOR
              - STREET_NO
              - STREET
              - STREET_TYPE
              - ADDRESS_EXTRA
              - PROVINCE
              - ZIP
              - CITY
              - COUNTRY
              - LATITUDE
              - LONGITUDE
              - ADDRESS_DISPLAY
              - SERVICE_AREAS
              - CATEGORIES
              - OPENING_DATE
              - PHONE
              - CELLPHONE
              - FAX
              - WEBSITE
              - WEBSITE_EXTRA
              - EMAIL
              - OPENINGHOURS
              - OPENINGHOURS_NOTES
              - SPECIAL_OPENINGHOURS
              - MORE_HOURS
              - KEYWORDS
              - DESCRIPTION_SHORT
              - DESCRIPTION_LONG
              - IMPRINT
              - LEGAL_IDENT
              - TAX_NUMBER
              - ATTRIBUTION
              - IS_PUBLISHED
              - SOCIAL_PROFILES
              - ATTRIBUTES
              - PAYMENT_OPTIONS
              - BRANDS
              - LANGUAGES
              - SERVICES
              - CONTENT_LISTS
              - PHOTOS
              - VIDEOS
              - SOCIAL_POST
              - DOCTOR_CATEGORIES
              - NPI
              - EV_DATA
              - TRANSACTION_LINKS
              - SUBLOCALITY
              - CUSTOM_FIELDS
        directoriesMissingConnect:
          type: array
          description: The list of DirectoryType missing connection
          items:
            type: string
            enum:
              - NAME
              - NAME_DESCRIPTOR
              - STREET_NO
              - STREET
              - STREET_TYPE
              - ADDRESS_EXTRA
              - PROVINCE
              - ZIP
              - CITY
              - COUNTRY
              - LATITUDE
              - LONGITUDE
              - ADDRESS_DISPLAY
              - SERVICE_AREAS
              - CATEGORIES
              - OPENING_DATE
              - PHONE
              - CELLPHONE
              - FAX
              - WEBSITE
              - WEBSITE_EXTRA
              - EMAIL
              - OPENINGHOURS
              - OPENINGHOURS_NOTES
              - SPECIAL_OPENINGHOURS
              - MORE_HOURS
              - KEYWORDS
              - DESCRIPTION_SHORT
              - DESCRIPTION_LONG
              - IMPRINT
              - LEGAL_IDENT
              - TAX_NUMBER
              - ATTRIBUTION
              - IS_PUBLISHED
              - SOCIAL_PROFILES
              - ATTRIBUTES
              - PAYMENT_OPTIONS
              - BRANDS
              - LANGUAGES
              - SERVICES
              - CONTENT_LISTS
              - PHOTOS
              - VIDEOS
              - SOCIAL_POST
              - DOCTOR_CATEGORIES
              - NPI
              - EV_DATA
              - TRANSACTION_LINKS
              - SUBLOCALITY
              - CUSTOM_FIELDS
        listingsInSync:
          type: integer
          description: number of listings still in sync
          format: int32
        listingsBeingUpdated:
          type: integer
          description: Output only. Number of listings still being updated
          format: int32
        averageRating:
          type: number
          description: Average rating, e.g.
          format: double
        suggestionsForFieldsAvailable:
          type: boolean
          description: >-
            Output Only. Boolean that indicates which locations have pending
            suggestions.
      description: Sortable data model
    SpecialOpeningHours:
      required:
        - date
      type: object
      properties:
        closed:
          type: boolean
          description: Indicates whether a location is closed on a date.
        fromX:
          type: string
          description: >-
            A beginning of a period. Up to two periods are supported per date,
            e.g.: "from1": "09:00", "from2": "15:00"
        date:
          type: string
          description: 'The date of a special opening hour, e.g.: 2017-06-30'
        toX:
          type: string
          description: >-
            An end of a period. Up to two periods are supported per date, e.g.:
            "to1": "09:00", "to2": "15:00"
      description: Special Opening Hours
    Statistic:
      type: object
      properties:
        totalListings:
          type: integer
          description: Total Listings
          format: int32
        countListingsInSync:
          type: integer
          description: Count of Listings in sync
          format: int32
        countListingsSubmitted:
          type: integer
          description: >-
            Count of Listings where the latest information has been submitted
            successfully (however the publisher does not have an online
            verification)
          format: int32
        countListingsBeingUpdated:
          type: integer
          description: Count of Listings which are being updated
          format: int32
        countListingsLinked:
          type: integer
          description: >-
            Count of Listings which we have linked but do not update location
            data
          format: int32
        countListingsActionRequired:
          type: integer
          description: Count of Listings where action is required by the customer
          format: int32
      description: Statistics model
    StoreFinderCategoriesDetails:
      type: object
      properties:
        name:
          type: string
          description: The category name
    StoreFinderFilters:
      type: object
      properties:
        filters:
          type: object
          additionalProperties:
            uniqueItems: true
            type: array
            description: All filters with their possible values, including services
            items:
              $ref: '#/components/schemas/StoreFinderFiltersFilter'
          description: All filters with their possible values, including services
      description: Store Finder Filters Model
    StoreFinderFiltersFilter:
      type: object
      properties:
        label:
          type: string
        values:
          type: array
          items:
            type: string
      description: All filters with their possible values, including services
    StoreFinderFiltersWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/StoreFinderFilters'
    StoreFinderLocationSearchResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/LocationSearchResponse'
    StoreFinderResponse:
      type: object
      properties:
        addressExtra:
          type: string
          description: Additional address information, e.g. building, floor, etc.
          example: building, floor, etc.
        averageRating:
          type: number
          description: The average rating of all Google Reviews
          format: float
        brands:
          uniqueItems: true
          type: array
          description: The brands offered by the location to its customers
          items:
            type: string
        businessId:
          type: integer
          description: The id of the business associated with this location
          format: int64
        businessName:
          type: string
          description: Name of the business
        businessIdentifier:
          type: string
          description: The business identifier based on your internal identification system
        callToActions:
          type: array
          description: >-
            A list of callToAction objects, each with a title and URL, formatted
            as <pre>callToActions: [&#123; text: 'cta_text1', url: 'cta_url1'
            &#125;, &#123; text: 'cta_text2', url: 'cta_url2' &#125;]</pre>
          example: >-
            callToActions: [{ text: 'cta_text1', url: 'cta_url1' }, { text:
            'cta_text2', url: 'cta_url2' }]
          items:
            $ref: '#/components/schemas/CallToAction'
        categories:
          type: array
          description: A list of category IDs describing the location
          items:
            $ref: '#/components/schemas/StoreFinderCategoriesDetails'
        cellphone:
          type: string
          description: A contact mobile phone number
        city:
          type: string
          description: The city the location is residing in.
        country:
          type: string
          description: The country the location is residing in.
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        customItems:
          type: array
          description: >-
            Custom, rich content related specifically to this location (such as
            company values)
          items:
            $ref: '#/components/schemas/CustomItem'
        descriptionLong:
          type: string
          description: A long description - up to 1000 characters
        descriptionShort:
          type: string
          description: A short description - up to 200 characters
        email:
          type: string
          description: A contact email for the location
        events:
          type: array
          description: Events offered by this location
          items:
            $ref: '#/components/schemas/Event'
        fax:
          type: string
          description: The location fax number
        id:
          type: integer
          description: The uberall unique id for the location.
          format: int64
        identifier:
          type: string
          description: >-
            The location identifier based on your internal identification
            system.
        imprint:
          type: string
          description: The imprint of the location
        keywords:
          type: array
          description: Keywords describing the locations activity
          items:
            type: string
        languages:
          uniqueItems: true
          type: array
          description: >-
            The language(s) in which customers can interact with the location's
            staff
          items:
            type: string
        lat:
          type: number
          description: The latitude coordinate of the location.
          format: double
        lng:
          type: number
          description: The longitude coordinate of the location.
          format: double
        menus:
          type: array
          description: Menu items offered by this location
          items:
            $ref: '#/components/schemas/MenuItem'
        name:
          type: string
          description: The location's name.
        nextOpen:
          description: Defines when the location will be next opened.
          allOf:
            - $ref: '#/components/schemas/NextOpen'
        openingHours:
          uniqueItems: true
          type: array
          description: The location's opening hours.
          items:
            $ref: '#/components/schemas/OpeningHours'
        openingHoursNotes:
          type: string
          description: Additional information about the location's opening hours.
        specialOpeningHours:
          uniqueItems: true
          type: array
          description: The location's special opening hours
          items:
            $ref: '#/components/schemas/SpecialOpeningHours'
        openNow:
          type: boolean
          description: Shows if the location is currently open.
        paymentOptions:
          uniqueItems: true
          type: array
          description: >-
            The payment options accepted at the location (eg. cash, bank
            transfer, ...)
          example: cash, bank transfer, ...
          items:
            type: string
        people:
          type: array
          description: People associated with this location
          items:
            $ref: '#/components/schemas/Person'
        phone:
          type: string
          description: The location's contact phone number.
        photos:
          uniqueItems: true
          type: array
          description: The location's photos.
          items:
            $ref: '#/components/schemas/LocationPhoto'
        products:
          type: array
          description: Products offered by this location
          items:
            $ref: '#/components/schemas/Product'
        province:
          type: string
          description: The province the location is residing in.
        reviewCount:
          type: integer
          description: How many Google Reviews this location has in total
          format: int32
        reviews:
          type: array
          description: A list of up to five Google Reviews
          items:
            $ref: '#/components/schemas/StoreFinderReview'
        services:
          type: array
          description: >-
            The services offered by the location (eg. 'catering' for a
            restaurant)
          example: '''catering'' for a restaurant'
          items:
            $ref: '#/components/schemas/ServiceItem'
        socialProfiles:
          uniqueItems: true
          type: array
          description: >-
            The profiles of the location on social and professional networks
            (FACEBOOK, FOURSQUARE, INSTAGRAM, LINKEDIN, PINTEREST, TWITTER,
            VIMEO, XING, YOUTUBE)
          items:
            $ref: '#/components/schemas/SocialProfile'
        socialPost:
          type: object
          description: Social posts published for this location
        streetAndNumber:
          type: string
          description: The location's street address.
        taxNumber:
          type: string
          description: The tax number of the location. CIF/NIF in Spain
        timezone:
          type: string
          description: The location's timezone
        videos:
          uniqueItems: true
          type: array
          description: The location's videos
          items:
            $ref: '#/components/schemas/Video'
        zip:
          type: string
          description: The location's ZIP code.
        website:
          type: string
          description: A valid url for the location's website
        googlePlaceId:
          type: string
          description: >-
            A unique textual identifier to identify a place in the Google Places
            database and on Google Maps.
        street:
          type: string
          description: The location's street address
        streetNo:
          type: string
          description: The location's street number
      description: This is a response object that is being used in storefinder calls
    StoreFinderResponseListObject:
      type: object
      properties:
        locations:
          type: array
          items:
            $ref: '#/components/schemas/StoreFinderResponse'
      description: The actual response object of the response
    StoreFinderResponseListWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/StoreFinderResponseListObject'
    StoreFinderResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/StoreFinderResponse'
    StoreFinderReview:
      type: object
    StringListSuccessResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          type: array
          description: The actual response object of the response
          items:
            type: string
            description: The actual response object of the response
    SubscribableEventTypesObject:
      type: object
      properties:
        subscribableEventTypes:
          type: array
          items:
            type: string
      description: The actual response object of the response
    SubscribableEventTypesWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SubscribableEventTypesObject'
    SuccessResponseObject:
      type: object
      properties:
        success:
          type: boolean
          description: Success
          example: true
      description: The actual response object of the response
    SuccessResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SuccessResponseObject'
    Suggestion:
      type: object
      properties:
        id:
          type: integer
          description: id of the Suggestion
          format: int64
        status:
          type: string
          description: >-
            ACCEPTED, DECLINED or ACTIVE (if no decision was made for
            accepting/declining the suggestion)
          enum:
            - HIDDEN
            - PENDING
            - ACCEPTED
            - DECLINED
            - DECLINED_OLD_API
        value:
          type: object
          description: Suggestion Value
        directory:
          type: string
          description: Suggestion from directory
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
      description: Suggestion
    SuggestionListWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          type: array
          description: The actual response object of the response
          items:
            $ref: '#/components/schemas/Suggestion'
    SuggestionResponse:
      type: object
      properties:
        id:
          type: integer
          description: Id of the location
          format: int64
        name:
          type: string
          description: Name of the location
        streetAndNumber:
          type: string
          description: Street and streetNumber of the location
        zip:
          type: string
          description: Zip of the location
        city:
          type: string
          description: City of the location
        country:
          type: string
          description: Country of the location
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        status:
          type: string
          description: Status of the location
          enum:
            - CREATED
            - ACTIVE
            - INACTIVE
            - CANCELLED
            - DELETED
            - CLOSED
        suggestionsForFields:
          type: array
          description: >-
            Map containing fields and the suggested values from different
            directories.
          items:
            $ref: '#/components/schemas/SuggestionsForFieldsDetails'
      description: Suggestion Response Model
    SuggestionResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SuggestionResponse'
    SuggestionSearchResponseObject:
      type: object
      properties:
        offset:
          type: integer
          description: Offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: Maximum number of results per page
          format: int32
          example: 10
        count:
          type: integer
          description: Total count of results
          format: int32
          example: 100
        locations:
          type: array
          items:
            $ref: '#/components/schemas/SuggestionResponse'
      description: >-
        Search response object containing pagination details and a list of
        suggestion responses
    SuggestionSearchResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SuggestionSearchResponseObject'
    SuggestionsForFieldsDetails:
      type: object
      properties:
        fieldName:
          type: string
          description: Name of the field for which the suggestion is provided
        currentValue:
          type: object
          description: Current value of the field, can be String, List, etc.
        suggestions:
          type: array
          description: The suggestions for the field
          items:
            $ref: '#/components/schemas/Suggestion'
    SuppressedDuplicates:
      type: object
      properties:
        countByDirectory:
          type: array
          description: >-
            A Map with the number of suppressed duplicates divided by
            DirectoryType
          items:
            $ref: '#/components/schemas/CountByDirectoryDetails'
        totalCount:
          type: integer
          description: The total number of suppressed duplicates
          format: int32
      description: SuppressedDuplicates Model
    SuppressedDuplicatesWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/SuppressedDuplicates'
    TimeSeriesSegment:
      type: object
      properties:
        period:
          type: string
          description: The segment of the whole time period this object represents.
        value:
          type: number
          description: The value for this segment of the whole period.
      description: TimeSeriesSegment Model
    UTM:
      type: object
      properties:
        parameters:
          type: string
          description: >-
            The UTM parameter that should be appended to the location website
            url
        type:
          type: string
          description: Google, Facebook, or Bing
          enum:
            - FOURSQUARE
            - UBER
            - GOOGLE
            - WAZE
            - GOOGLE_MAPS
            - YELP
            - YELP_API
            - MEINESTADT
            - YELLOW_MAP
            - FOCUS
            - LOKALEAUSKUNFT
            - WEB_DE
            - GMX
            - ONE_AND_ONE
            - FREIEAUSKUNFT
            - POINTOO
            - NOKIA_HERE
            - FACEBOOK
            - TOMTOM
            - STADTBRANCHENBUCH
            - CYLEX
            - UNTERNEHMENSAUSKUNFT
            - ACOMPIO
            - BUSINESSBRANCHENBUCH
            - YALWA
            - THE_PHONEBOOK
            - SCOOT
            - CENTRAL_INDEX
            - CITIPAGES
            - ONE_NINE_TWO
            - ONE_ONE_EIGHT
            - THE_DAILY_RECORD
            - THE_EVENING_STANDARD
            - THE_SCOTSMAN
            - LIVERPOOL_ECHO
            - THE_SUN
            - THE_INDEPENDENT
            - TOUCH_LOCAL
            - THE_MIRROR
            - ANNUAIRE
            - INFOBEL
            - US_INFO_COM
            - GARMIN
            - FACTUAL
            - BING
            - WO_GIBTS_WAS
            - KOOMIO
            - ABCLOCAL
            - YELLBO
            - JELLOO
            - GUIDELOCAL
            - OEFFNUNGSZEITENBUCH
            - APPLE_MAPS
            - LOOCAL
            - REGIONAL_DE
            - WHERE_TO
            - TUPALO
            - GELBE_SEITEN
            - DAS_OERTLICHE
            - DIALO
            - BUNDES_TELEFONBUCH
            - BRANCHENBUCH_DEUTSCHLAND
            - MARKTPLATZ_MITTELSTAND
            - BUSQUEDA_LOCAL
            - RICERCARE_IMPRESE
            - PAGES24
            - NAVMII
            - AUDI
            - BMW
            - MERCEDES
            - VW
            - TOYOTA
            - FORD
            - FIAT
            - GM
            - ETRUSTED
            - INSTAGRAM
            - SHOPPING_TIME_NETWORK
            - CITY_SQUARES
            - SHOWMELOCAL
            - LOCALSTACK
            - CHAMBER_OF_COMMERCE
            - JUDYS_BOOK
            - BROWNBOOK
            - MY_LOCAL_SERVICES
            - YA_SABE
            - UNIVISION
            - AL_DIA_TX
            - LA_VOZ_TX
            - CHRON
            - STATESMAN
            - PALM_BEACH_POST
            - MUNDO_HISPANICO
            - EL_TIEMPO_LATINO
            - LATINOS_US
            - HOTFROG
            - INFO_IS_INFO
            - MANTA
            - US_CITY
            - GO_YELLOW
            - N49
            - PRATIQUE
            - JUSTACOTE
            - EZLOCAL
            - ELOCAL
            - TRUE_LOCAL
            - START_LOCAL
            - WOMO
            - AUSSIE_WEB
            - YELLOW_PAGES
            - SUPER_PAGES
            - WHITE_PAGES
            - DEX_KNOWS
            - KAUFDA_MANUAL
            - I_GLOBAL
            - BRANCHEN_INFO_MANUAL
            - GUTE_BANKEN_MANUAL
            - D_11880_COM_MANUAL
            - BANKOEFFNUNGSZEITEN_DE_MANUAL
            - BANK_OEFFNUNGSZEITEN_DE_MANUAL
            - CYLEX_MANUAL
            - FINDE_OFFEN_MANUAL
            - MEIN_PROSPEKT_MANUAL
            - DAS_SCHNELLE
            - SENSIS_WHITE_PAGES
            - SENSIS_TRUE_LOCAL
            - SENSIS_YELLOW_PAGES
            - FIND_OPEN
            - WAND
            - BELL_CA
            - GO_LOCAL
            - MEINUNGSMEISTER
            - YANDEX
            - YAHOO_MANUAL
            - HOLIDAY_CHECK
            - TRIP_ADVISOR
            - BONIAL_FR
            - ZIP_CH
            - PAGES_JAUNES
            - YELLOW_PAGES_SINGAPORE
            - INFOGROUP
            - WAZE_NEW
            - UBER_NEW
            - NEUSTAR
            - TRUSTPILOT
            - AUSKUNFT
            - BAIDU
            - NEXT_DOOR
            - MICROSOFT_CORTANA
            - GOOGLE_ASSISTANT
            - CBANQUE
            - ORANGE_118_712
            - SIRI
            - HUAWEI
            - DOCTOR_COM
            - CARE_DASH
            - DENTAL_PLANS
            - DOC_SPOT
            - HEALTHGRADES
            - SHARE_CARE
            - VITALS
            - WEB_MD
            - WELLNESS
            - ZOC_DOC
            - ZWIVEL
            - YP_COM_HEALTH
            - BING_HEALTH
            - NPPES
            - RATE_MDS
            - CITYSEARCH
            - INSIDER_PAGES
            - TWITTER
            - ALEXA
            - MAP_QUEST
            - WEBSITE_WIDGETS
            - ECO_MOVEMENT
            - GOOGLE_EV
            - APPLE_EV
            - TESLA_EV
            - EUROWAG_EV
            - OPIS_EV
            - TOMTOM_EV
            - HERE_EV
            - YELLOW_PAGES_CANADA
            - BBB
            - UBERALL_SOCIAL_ADS
            - APPLE_APPS
            - CONSUMER_AFFAIRS
            - CREDIT_KARMA
            - DELIVERY
            - GLASSDOOR
            - PLAY_GOOGLE
            - GRUBHUB
            - INDEED
            - LENDING_TREE
            - MENUISM
            - OPEN_TABLE
            - OPEN_TABLE_USA
            - WALLET_HUB
            - ZILLOW
            - ZOMATO
            - WHATS_APP
            - FOUR_SCREEN
            - AND_CHARGE
            - LINKED_IN
      description: UTM
    UpdateSalesPartnerRequestBody:
      type: object
      properties:
        address:
          type: string
          description: >-
            Full address string of the new child SalesPartner (Be aware: Can't
            be NULL or empty)
        aggregateInvoicesToParent:
          type: boolean
          description: >-
            Indicates if the invoice for this SalesPartner should be aggregated
            to the parent invoice
        attribution:
          allOf:
            - $ref: '#/components/schemas/Attribution'
        canSeePrices:
          type: boolean
          description: >-
            Indicates if the child SalesPartner should be allowed to see price
            information for e.g. product plans
        country:
          type: string
          description: Country of the new child SalesPartner
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - KH
            - CM
            - CA
            - CV
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - XK
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MK
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SZ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - UK
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        emailAccounting:
          type: string
          description: Accounting email of the new child SalesPartner
        emailCustomerSupport:
          type: string
          description: Customer support email of the new child SalesPartner
        emailProjectLead:
          type: string
          description: Project lead email of the new child SalesPartner
        identifier:
          type: string
          description: >-
            Identifier of the new child SalesPartner (e.g. your own customer ID
            for better reference)
        minPasswordLength:
          type: integer
          description: Minimum password length for all users of the new child SalesPartner
          format: int32
        name:
          type: string
          description: 'Name of child SalesPartner (Be aware: Can''t be NULL or empty)'
        phone:
          type: string
          description: Phone number of the new child SalesPartner
        preferredLanguage:
          type: object
          description: >-
            Preferred language of the new child SalesPartner, for invoice
            purpose (either 'de' oder 'en')
        salesPartnerStatus:
          type: string
          description: Sales Partner Status Enum
          enum:
            - CREATED
            - APPROVED
            - DECLINED
            - DELETED
            - INACTIVE
        vatId:
          type: string
          description: >-
            VAT (Value-Added Tax) ID number of the SalesPartner (e.g. for
            Germany: DE123456789)
    UpdateSuccessResponseObject:
      type: object
      properties:
        updatedCount:
          type: integer
          description: Total count of updated items
          format: int32
          example: 10
        failedCount:
          type: integer
          description: Total count of failed items
          format: int32
          example: 2
        missingIdCount:
          type: integer
          description: Total count of missing IDs
          format: int32
          example: 1
        updatedIds:
          type: array
          items:
            type: integer
            format: int64
        failed:
          type: array
          items:
            type: string
        warnings:
          type: array
          items:
            type: string
      description: The actual response object of the response
    UpdateSuccessResponseWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/UpdateSuccessResponseObject'
    User:
      required:
        - email
        - firstname
        - lastname
        - role
      type: object
      properties:
        email:
          type: string
          description: Email
        password:
          type: string
          description: >-
            The user's password. Only for POST requests. Don't use when creating
            a user with status INVITED!
        id:
          type: integer
          description: The uberall unique id for the user
          format: int64
        salutation:
          type: string
          description: One of MALE, FEMALE or OTHER
        firstname:
          type: string
          description: First Name
        lastname:
          type: string
          description: Last name
        phone:
          type: string
          description: The user's phone number
        status:
          type: string
          description: >-
            The status of the current user. One of CREATED, VERIFIED,
            UNVERIFIED, INVITED, INACTIVE, NO_LOGIN
          enum:
            - INVITED
            - CREATED
            - VERIFIED
            - UNVERIFIED
            - INACTIVE
            - DELETED
            - NO_LOGIN
        role:
          type: string
          description: User Role
          enum:
            - UBER_API_ADMIN
            - API_ADMIN
            - ADMIN
            - ACCOUNT_MANAGER
            - BUSINESS_MANAGER
            - LOCATION_MANAGER
            - BUSINESS_MANAGER_INBOX
        salesPartner:
          description: The "Sales Partner" this user belongs to
          allOf:
            - $ref: '#/components/schemas/SalesPartner'
        preferredLanguage:
          type: string
          description: >-
            Preferred language of a user. If not set, this will default to the
            language in context, e.g., location's for e-mails and browser
            language for our applications.
        identifier:
          type: string
          description: >-
            The unique user identifier based on your internal identification
            system
        features:
          uniqueItems: true
          type: array
          description: |-
            A list of features this user can work with. Values: 
            <pre>ADS_READ
            ADS_WRITE
            ADVANCED_ANALYTICS
            AI_SUGGESTED_REPLIES
            AI_BULK_REPLIES 
            APPLE_POSTING_WRITE
            AUTO_RESPONSE_WRITE
            BULK_UPDATES
            BUSINESS_LEVEL_CONNECT
            CAN_PAY_INVOICE
            CAN_SEE_HELP_SECTION
            CHAT_READ
            CHAT_WRITE
            CHATBOT_READ
            CHATBOT_WRITE
            DAM
            ENTERPRISE_ONBOARDING
            FIRST_PARTY_REVIEW_APPROVAL
            FORMS
            INBOX_2_0_BETA_READ
            INBOX_2_0_BETA_WRITE
            INBOX_APPROVAL
            INBOX_READ
            INBOX_WRITE
            INSTAGRAM_POSTING_WRITE
            LISTINGS_PAGE_NEW
            LISTINGS
            LIVE_CHAT
            LOCATION_GROUP
            LOCATION_READ
            LOCATION_SCHEDULED_UPDATES
            LOCATION_STATUS_CHANGE
            LOCATION_WRITE
            POSTING_APPROVAL
            POSTING_READ
            POSTING_WRITE
            PRICE_INFO
            RESPONSE_LIBRARY_READ
            RESPONSE_LIBRARY_WRITE
            REVIEW_GENERATION_CREATE
            REVIEW_GENERATION_SEND
            SINGLE_SIGN_ON
            SOCIAL_ADS
            SUPPRESSION
            TRACKING
            UPGRADE
            USER_OTHERS_EDIT
            USER_SELF_EDIT</pre>
          items:
            type: string
            enum:
              - NEW_PHOTO_TYPES
              - ADS
              - ADS_READ
              - ADS_WRITE
              - ADVANCED_ANALYTICS
              - ADVANCED_ANALYTICS_2_0
              - AI_KNOWLEDGEBASE
              - AI_LOCALISATION
              - AI_LOCATION_INFORMATION
              - AI_SUGGESTED_REPLIES
              - APPLE_POSTING
              - APPLE_POSTING_WRITE
              - AUTO_RESPONSE
              - AUTO_RESPONSE_WRITE
              - AUTOMATION
              - BASIC
              - BASIC_PLUS
              - BULK_UPDATES
              - INSTAGRAM_POSTING
              - INSTAGRAM_POSTING_WRITE
              - LINKEDIN_POSTING
              - BUSINESS_LEVEL_CONNECT
              - CALL_TRACKING_NUMBERS
              - CAN_PAY_INVOICE
              - CAN_SEE_HELP_SECTION
              - CHATBOT
              - CHATBOT_READ
              - CHATBOT_WRITE
              - CHAT_READ
              - CHAT_WRITE
              - CLEANSING
              - CONTENT_COLLECTION
              - DAM
              - DASHBOARD
              - ENTERPRISE_ONBOARDING
              - FACEBOOK_UNOWNED_PAGE_CREATE
              - FACEBOOK_POSTING
              - FIRST_PARTY_REVIEW_APPROVAL
              - FORMS
              - GOOGLE_POSTING
              - HOMEPAGE
              - INBOX
              - INBOX_APPROVAL
              - INBOX_PREVIEW
              - INBOX_TEASER
              - INBOX_TWITTER
              - INBOX_READ
              - INBOX_WRITE
              - INBOX_2_0_BETA
              - INBOX_2_0_BETA_READ
              - INBOX_2_0_BETA_WRITE
              - INBOX_FLAG
              - LISTINGS
              - LIVE_CHAT
              - LOCAL_SEO_REPORT
              - LOCATION_APPROVAL_REQUESTS
              - LOCATION_GROUP
              - LOCATION_STATUS_CHANGE
              - LOCATION_TRANSLATION
              - LOCATION_READ
              - LOCATION_WRITE
              - LOCAL_INVENTORY
              - MANUAL_LISTINGS
              - NEAR_ME_CHECK
              - PHONE_OPTIONAL
              - OTHERS_POSTING
              - POSTING
              - POSTING_APPROVAL
              - POSTING_READ
              - POSTING_TONE_ADJUST
              - POSTING_WRITE
              - POSTING_PREVIEW
              - PRICE_INFO
              - QR_CODE_GENERATION
              - RESPONSE_LIBRARY
              - RESPONSE_LIBRARY_READ
              - RESPONSE_LIBRARY_WRITE
              - REVIEW_GENERATION_EMAIL
              - REVIEW_GENERATION_SMS
              - REVIEW_GENERATION_CREATE
              - REVIEW_GENERATION_SEND
              - LOCATION_APPROVAL
              - LOCATION_SCHEDULED_UPDATES
              - SINGLE_SIGN_ON
              - SOCIAL_ADS
              - STOREFINDER
              - STOREFINDER_TRIAL_MODE
              - LOCATOR_PAGES_BUILDER
              - STOREFINDER_ANALYTICS
              - STOREFINDER_GOOGLE
              - STOREFINDER_MAPBOX
              - SUPPORT
              - SUPPRESSION
              - TRACKING
              - TRANSACTION_LINKS
              - TWITTER_INBOX_READ
              - TWITTER_INBOX_WRITE
              - TWITTER_POSTING
              - TWITTER_POSTING_WRITE
              - UPGRADE
              - USER_OTHERS_EDIT
              - USER_SELF_EDIT
              - UTMS
              - WEBSITE_WIDGETS
              - EXPANDED_REVIEWS_RESTAURANT
              - EXPANDED_REVIEWS_FINANCE
              - WHATS_APP_MESSAGES
              - ACCESS_REQUEST_INVITATIONS
              - AI_BULK_REPLIES
              - SURVEYS
              - SURVEYS_READ
              - SURVEYS_WRITE
        emailSettings:
          uniqueItems: true
          type: array
          description: >-
            A list of EmailSettings for this user. Only one EmailSettings object
            per EmailType possible.
          items:
            $ref: '#/components/schemas/EmailSettings'
        featuresDetailed:
          type: object
          additionalProperties:
            type: array
            description: User Features Detailed Model
            items:
              type: string
              description: User Features Detailed Model
          description: >-
            Map containing the feature names and corresponding feature-specific
            parameters. "featuresDetailed" is supported for the features
            LOCATION_WRITE and ADVANCED_ANALYTICS. 

            For LOCATION_WRITE a list of fields that this user can update is
            expected. 

            For ADVANCED_ANALYTICS a list of dashboards the user has access to
            is expected.

            For example:

            <pre>

            "featuresDetailed": '{'

            '{'
               "featuresDetailed":'{'
                  "LOCATION_WRITE":[
                     "fax",
                     "openingHours",
                     "callTrackingNumbers",
                     "streetNo",
                     "openingHoursNotes",
                     "specialOpeningHours",
                     "street",
                     "languages",
                     "customFields",
                     "contentLists",
                     "photos",
                     "services",
                     "moreHours",
                     "descriptionLong",
                     "zip",
                     "lat",
                     "openingDate",
                     "email",
                     "addressDisplay",
                     "labels",
                     "taxNumber",
                     "city",
                     "cellphone",
                     "contentCollections",
                     "attributes",
                     "categories",
                     "imprint",
                     "phone",
                     "utms",
                     "addressExtra",
                     "keywords",
                     "legalIdent",
                     "lng",
                     "paymentOptions",
                     "descriptionShort",
                     "socialProfiles",
                     "identifier",
                     "website",
                     "country",
                     "province",
                     "name",
                     "videos",
                     "brands",
                     "serviceAreas"
                  ],
                  "ADVANCED_ANALYTICS":[
                     "overview",
                     "listings-google",
                     "customer-feedback"
                  ]
               '}'
            '}'

            </pre>
        whitelabelInformation:
          allOf:
            - $ref: '#/components/schemas/WhitelabelInformation'
        isParent:
          type: boolean
        canManageLocationGroups:
          type: boolean
        multiFactorAuthentications:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/MultiFactorAuthentication'
        managedLocationsIdentifiers:
          type: array
          items:
            type: integer
            format: int64
        roles:
          type: array
          description: >-
            The user's role. One of ADMIN, BUSINESS_MANAGER,
            MULTI_BUSINESS_MANAGER, LOCATION_MANAGER.
          items:
            type: string
            description: Different roles a user account can have in the system.
            enum:
              - UBER_API_ADMIN
              - API_ADMIN
              - ADMIN
              - ACCOUNT_MANAGER
              - BUSINESS_MANAGER
              - LOCATION_MANAGER
              - BUSINESS_MANAGER_INBOX
        locationGroupIds:
          type: array
          description: A list of all location group IDs the user is assigned to.
          items:
            type: integer
            format: int64
        managedLocationsViaGroups:
          type: array
          description: >-
            A list of all location IDs the user can manage because of assignment
            to certain group(s)
          items:
            type: integer
            format: int64
        dateCreated:
          type: string
          format: date-time
        managedBusinesses:
          type: array
          description: A list of businesses managed by this user
          items:
            type: integer
            format: int64
        managedLocations:
          type: array
          description: A list of locations managed by this user
          items:
            type: integer
            format: int64
        connectedAccounts:
          type: array
          items:
            type: string
        paymentMethod:
          type: array
          items:
            type: string
        showSpSwitch:
          type: boolean
      description: User Model
    UserDetails:
      type: object
      properties:
        id:
          type: integer
          description: ID of the user
          format: int64
          example: 1
        email:
          type: string
          description: Email of the user
          example: jan.didschuneit@uberall.com
        firstName:
          type: string
          description: First name of the user
          example: Jan
        lastName:
          type: string
          description: Last name of the user
          example: Didschuneit
        role:
          type: string
          description: Different roles a user account can have in the system.
          example: ADMIN
          enum:
            - UBER_API_ADMIN
            - API_ADMIN
            - ADMIN
            - ACCOUNT_MANAGER
            - BUSINESS_MANAGER
            - LOCATION_MANAGER
            - BUSINESS_MANAGER_INBOX
        status:
          type: string
          description: User Status Enum
          example: VERIFIED
          enum:
            - INVITED
            - CREATED
            - VERIFIED
            - UNVERIFIED
            - INACTIVE
            - DELETED
            - NO_LOGIN
    UserLeftObject:
      type: object
      properties:
        user:
          allOf:
            - $ref: '#/components/schemas/User'
        usersLeft:
          type: integer
          description: The number of users left
          format: int32
          example: 1
      description: The actual response object of the response
    UserLeftWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/UserLeftObject'
    UserMissingConnectionWarnings:
      type: object
      properties:
        warnings:
          type: object
          properties:
            missingConnection:
              $ref: '#/components/schemas/MissingWarningsConnection'
            missingPermission:
              $ref: '#/components/schemas/MissingWarningsConnection'
            missingChatbotConnection:
              $ref: '#/components/schemas/MissingChatbotConnection'
          description: >-
            A Map with keys as missingConnection and missingPermission. 

            missingConnection is a Map with list of all connections missing
            connection. 

            missingPermission is a Map with the list of accounts connected, but
            missing a required permission for insights.
        totalItemsCount:
          type: integer
          description: Used for pagination. Total number of results of the request
          format: int32
        max:
          type: integer
          description: Used for pagination. Maximum number of results per page
          format: int32
        offset:
          type: integer
          description: 'Offset used for pagination. Default: 0'
          format: int32
        connectedLocations:
          type: array
          description: >-
            A Map with key as directory types and values the number of connected
            locations
          items:
            $ref: '#/components/schemas/ConnectedLocationsDetails'
        notConnectedLocations:
          type: array
          description: >-
            A Map with key as directory types and values the number of not
            connected locations
          items:
            $ref: '#/components/schemas/ConnectedLocationsDetails'
      description: UserMissingConnectionWarnings Model
      example:
        connectedLocations:
          - type: GOOGLE
            count: 100
          - type: FACEBOOK
            count: 50
        notConnectedLocations:
          - type: GOOGLE
            count: 5
          - type: FACEBOOK
            count: 10
        warnings:
          missingConnection:
            locations:
              - id: 1
                type: FACEBOOK
                name: Example Location
                city: Sample City
                country: XX
                addressLine1: 123 Sample Street
              - id: 2
                type: GOOGLE
                name: Another Location
                city: Testville
                country: XX
                addressLine1: 456 Test Road
            totalLocationsCount: 10
            totalBusinessesCount: 1
          missingPermission:
            accounts: []
            totalLocationsCount: 0
        totalItemsCount: 160
        max: 20
        offset: 0
    UserMissingConnectionWarningsWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/UserMissingConnectionWarnings'
    UserObject:
      type: object
      properties:
        user:
          allOf:
            - $ref: '#/components/schemas/User'
      description: The actual response object of the response
    UserSearchObject:
      type: object
      properties:
        offset:
          type: integer
          description: The offset for pagination
          format: int32
          example: 0
        max:
          type: integer
          description: The maximum number of results to return
          format: int32
          example: 10
        count:
          type: integer
          description: The total count of users
          format: int32
          example: 100
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
      description: The actual response object of the response
    UserSearchWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/UserSearchObject'
    UserWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/UserObject'
    ValueMetadataItem:
      type: object
      properties:
        value:
          type: string
          description: The value
        displayName:
          type: string
          description: Display name for this value
      description: Value metadata item
    Video:
      type: object
      properties:
        id:
          type: integer
          description: Identifier of the video in our system
          format: int64
        url:
          type: string
          description: Url of the video
        description:
          type: string
          description: Text description of the Video
        type:
          type: string
          description: 'Video Platform. Values: [YOUTUBE, VIMEO]'
          enum:
            - YOUTUBE
            - VIMEO
            - UBERALL
      description: Video
    VisibilityIndex:
      type: object
      properties:
        score:
          type: integer
          description: A score between 0 and 100 for the Visibility Index
          format: int32
        maxPoints:
          type: integer
          description: The total number of available points
          format: int32
        pointsReached:
          type: integer
          description: The actual number of points reached
          format: int32
        summary:
          type: object
          description: Detailed info about each directory
        reasons:
          type: array
          description: Reasons explaining the current Visibility Index
          items:
            $ref: '#/components/schemas/LoggingEvent'
        dateCreated:
          type: string
          description: The date the Visibility Index was created
          format: date-time
        forDay:
          type: string
          description: The date the Visibility Index reflects
          format: date-time
        result:
          type: string
          description: An overview of in sync/not in sync directories
      description: VisibilityIndex Model
    VisibilityIndexObject:
      type: object
      properties:
        visibilityIndex:
          allOf:
            - $ref: '#/components/schemas/VisibilityIndex'
      description: The actual response object of the response
    VisibilityIndexWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/VisibilityIndexObject'
    VisibilityIndexesObject:
      type: object
      properties:
        indexes:
          type: array
          items:
            $ref: '#/components/schemas/VisibilityIndex'
      description: The actual response object of the response
    VisibilityIndexesWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/VisibilityIndexesObject'
    Webhook:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the Webhook
          format: int64
        dateCreated:
          type: string
          description: Date of the creation
          format: date-time
        lastUpdated:
          type: string
          description: Date of last update
          format: date-time
        pushUrl:
          type: string
          description: URL where selected webhook event should be sent to
        type:
          type: string
          description: >-
            Event type the SalesPartner wants to receive push messages for via
            webhook functionality. For a list of all possible types use the GET
            /api/sales-partners/subscribable-event-types.
          enum:
            - ADMIN_ALERT
            - BRAND_DATA_POINT_REPLIED
            - BRAND_DATA_POINT_REPLIED_PENDING_APPROVAL
            - BRAND_DATA_POINT_REPLY_APPROVE
            - BRAND_DATA_POINT_REPLY_REJECT
            - BUSINESS_CHAIN_UPDATE
            - BUSINESS_CHANGED_SALES_PARTNER
            - BUSINESS_COMMENT
            - BUSINESS_CREATED
            - BUSINESS_CSV_EXPORT
            - BUSINESS_DIRECTORY_ACCOUNT
            - BUSINESS_DIRECTORY_CONNECT
            - BUSINESS_DUPLICATE_CHECK
            - BUSINESS_FACEBOOK_PAGE_INVALIDATE
            - BUSINESS_INVOICE_CHANGED
            - BUSINESS_INVOICE_CREATED
            - BUSINESS_INVOICE_CREATED_ANOTHER_BASIC
            - BUSINESS_INVOICE_CREATED_ANOTHER_PREMIUM
            - BUSINESS_INVOICE_CREATED_FIRST_BASIC
            - BUSINESS_INVOICE_CREATED_FIRST_PREMIUM
            - BUSINESS_INVOICE_CREATED_RENEWAL
            - BUSINESS_INVOICE_CREATED_UPGRADE_BASIC
            - BUSINESS_INVOICE_CREATED_UPGRADE_PREMIUM
            - BUSINESS_INVOICE_RENEWAL_FAIL
            - BUSINESS_INVOICE_RENEWAL_SUCCESS
            - BUSINESS_LOCATION_DATA_PULL
            - BUSINESS_MIGRATE_LOCATION
            - BUSINESS_NEW_CHATS
            - BUSINESS_NEW_CONTACT_FORM
            - BUSINESS_OLO_IMPORT
            - BUSINESS_OLO_SETTINGS_CREATED
            - BUSINESS_OLO_SETTINGS_DELETED
            - BUSINESS_OLO_SETTINGS_UPDATED
            - BUSINESS_PAGE_INVALIDATE
            - BUSINESS_PAY_INVOICE
            - BUSINESS_PRODUCT_PLAN_CHANGED
            - BUSINESS_STATUS_CHANGED
            - BUSINESS_TEMPLATE_UPDATE
            - BUSINESS_UPDATE_PAGE_SOCIAL_POST
            - BUSINESS_UPDATE_PRICE
            - DATA_POINT_AUTOMATED_REPLY
            - DATA_POINT_REPLIED
            - DATA_POINT_REPLIED_PENDING_APPROVAL
            - DATA_POINT_REPLY_APPROVE
            - DATA_POINT_REPLY_REJECT
            - DATA_POINT_SERVICE_NOW_SUBMITTED
            - DIRECTORY_BUSINESS_PAGE_DATA_POINT_CHECK
            - DIRECTORY_BUSINESS_PAGE_DATA_POINT_INVALID
            - LISTING_AUTOVALIDATION_FAILED
            - LISTING_BLACKLIST
            - LISTING_CANCEL
            - LISTING_DATAPOINT_CHECK
            - LISTING_DATAPOINT_INVALID
            - LISTING_DELETE
            - LISTING_DIRECTORY_CONNECT
            - LISTING_DIRECTORY_DUPLICATE_REMOVED
            - LISTING_FACEBOOK_PAGE_INVALIDATE
            - LISTING_FEED_CREATE
            - LISTING_FEED_DUPLICATE_REMOVED
            - LISTING_FEED_IN_SYNC_FIELDS
            - LISTING_FLAGGED
            - LISTING_GOOGLE_PAGE_CREATE
            - LISTING_GOOGLE_PAGE_INVALIDATE
            - LISTING_GOOGLE_PAGE_UPDATE
            - LISTING_INITIATE_OWNERSHIP_TRANSFER
            - LISTING_INVITATION_SENT
            - LISTING_LINK_CHANGE
            - LISTING_MANUAL
            - LISTING_NEEDS_REVIEW_DELETED
            - LISTING_PAGE_INVALIDATE
            - LISTING_PUBLISHER_UPDATE
            - LISTING_REMOVAL_STATUS_CHECK
            - LISTING_REMOVAL_SUPPRESS
            - LISTING_REVIEWED
            - LISTING_STATUS_CHANGE
            - LISTING_SUGGESTION
            - LISTING_SUPPRESS
            - LISTING_SUPPRESS_NOT_ALLOWED
            - LISTING_SYNC_CHECK
            - LISTING_UPDATE
            - LISTING_UPDATE_PAGE_SOCIAL_POST
            - LISTING_UPDATE_SOCIAL_POST
            - LISTING_WAITING_DIRECTORY_ACTION
            - LOCATION_BILLING
            - LOCATION_BUSINESS_CHANGED
            - LOCATION_CHECKOUT
            - LOCATION_CHECKOUT_FREE
            - LOCATION_CHECKOUT_SALESPARTNER
            - LOCATION_CHECKOUT_UPGRADE
            - LOCATION_CLEANSING
            - LOCATION_CONTRACT_UPDATED
            - LOCATION_CREATED
            - LOCATION_DUPLICATE_LISTING_CHECK
            - LOCATION_DUPLICATE_LISTING_DETECTION
            - LOCATION_FEED_CLOSED
            - LOCATION_FEED_PROFILE_CHANGED
            - LOCATION_GEOCODING_MANUAL
            - LOCATION_GOOGLE_RANK_CHECK
            - LOCATION_GROUP_CREATED
            - LOCATION_GROUP_DELETED
            - LOCATION_GROUP_UPDATED
            - LOCATION_INVOICE_CHANGED
            - LOCATION_LISTING_ADDED
            - LOCATION_NEEDS_REVIEW_DELETED
            - LOCATION_NEW_CHATS
            - LOCATION_NEW_CONTACT_FORM
            - LOCATION_NORMALIZATION_STATUS_CHANGED
            - LOCATION_OLO_IMPORT
            - LOCATION_PARTIAL_UPDATE
            - LOCATION_PAY_INVOICE
            - LOCATION_PROFILE_CHANGED
            - LOCATION_PROFILE_SUGGESTION_DECLINE
            - LOCATION_STATUS_CHANGED
            - LOCATION_SUBSCRIPTION_CHANGED
            - LOCATION_SUGGESTION_CREATED
            - LOCATION_SUGGESTION_UPDATED
            - LOCATION_SYNC_STARTED
            - LOCATION_VISIBILITY_INDEX_CHANGED
            - PRODUCT_PLAN_CREATED
            - PRODUCT_PLAN_DELETED
            - PRODUCT_PLAN_UPDATED
            - SALES_PARTNER_APPROVAL
            - SALES_PARTNER_CHILDREN_UPDATED
            - SALES_PARTNER_CREATED
            - SALES_PARTNER_DIRECTORY_BRAND
            - SALES_PARTNER_DIRECTORY_CONNECT
            - SALES_PARTNER_ENTERPRISE_ONBOARDING
            - SALES_PARTNER_INVOICE_CHANGED
            - SALES_PARTNER_INVOICE_PAYMENT_INFORMATION_CHANGED
            - SALES_PARTNER_ONE_AND_ONE_AUTHENTICATION
            - SALES_PARTNER_ONE_AND_ONE_CONTRACT_INFORMATION
            - SALES_PARTNER_PASSWORD_RESET
            - SALES_PARTNER_PAYMENT_METHOD_RESET
            - SALES_PARTNER_PAY_INVOICE
            - SALES_PARTNER_REPRESENTATIVE_UPDATE
            - SALES_PARTNER_SIGNUP
            - SALES_PARTNER_STATUS_CHANGED
            - SALES_PARTNER_TYPE_CHANGED
            - SALES_PARTNER_UPDATED
            - SALES_REPRESENTATIVE_UPDATE
            - SEARCH_DATA_RECHECK_LINK_SHARED
            - USER_ACTIVATION_EMAIL_SENT
            - USER_DASHBOARD_EXPORT_COMPLETE
            - USER_DIGEST_EMAIL_SENT
            - USER_FINISH_VERIFICATION_GOOGLE_EMAIL_SENT
            - USER_INVITATION
            - USER_INVITATION_EMAIL_SENT
            - USER_INVOICE_INVITATION
            - USER_MODIFY_EMAIL_SETTING
            - USER_NOTIFICATION_EMAIL_SENT
            - USER_PASSWORD_RESET
            - USER_PENDING_APPROVAL_REPLY_NOTIFICATION_EMAIL_SENT
            - USER_READ_DATA_POINT
            - USER_START_VERIFICATION_GOOGLE_EMAIL_SENT
            - USER_STATUS_CHANGED
            - USER_TIER1_EMAIL_SENT
            - USER_TIER2_EMAIL_SENT
            - USER_TIER3_EMAIL_SENT
            - USER_UNREAD_DATA_POINT
            - USER_UNREAD_REVIEW_NOTIFICATION_EMAIL_SENT
            - USER_UPDATED
            - USER_SOCIAL_POST_PENDING_APPROVAL_EMAIL_SENT
            - WIDGET_CONFIG_CREATED
            - WIDGET_CONFIG_DELETED
            - WIDGET_CONFIG_PUBLISHED
            - SOCIAL_POST_PENDING_APPROVAL
      description: Webhook Model
    WebhookCommand:
      required:
        - pushUrl
        - type
      type: object
      properties:
        pushUrl:
          type: string
          description: URL to receive webhooks
        type:
          type: string
          description: Logging event type to subscribe to
          enum:
            - ADMIN_ALERT
            - BRAND_DATA_POINT_REPLIED
            - BRAND_DATA_POINT_REPLIED_PENDING_APPROVAL
            - BRAND_DATA_POINT_REPLY_APPROVE
            - BRAND_DATA_POINT_REPLY_REJECT
            - BUSINESS_CHAIN_UPDATE
            - BUSINESS_CHANGED_SALES_PARTNER
            - BUSINESS_COMMENT
            - BUSINESS_CREATED
            - BUSINESS_CSV_EXPORT
            - BUSINESS_DIRECTORY_ACCOUNT
            - BUSINESS_DIRECTORY_CONNECT
            - BUSINESS_DUPLICATE_CHECK
            - BUSINESS_FACEBOOK_PAGE_INVALIDATE
            - BUSINESS_INVOICE_CHANGED
            - BUSINESS_INVOICE_CREATED
            - BUSINESS_INVOICE_CREATED_ANOTHER_BASIC
            - BUSINESS_INVOICE_CREATED_ANOTHER_PREMIUM
            - BUSINESS_INVOICE_CREATED_FIRST_BASIC
            - BUSINESS_INVOICE_CREATED_FIRST_PREMIUM
            - BUSINESS_INVOICE_CREATED_RENEWAL
            - BUSINESS_INVOICE_CREATED_UPGRADE_BASIC
            - BUSINESS_INVOICE_CREATED_UPGRADE_PREMIUM
            - BUSINESS_INVOICE_RENEWAL_FAIL
            - BUSINESS_INVOICE_RENEWAL_SUCCESS
            - BUSINESS_LOCATION_DATA_PULL
            - BUSINESS_MIGRATE_LOCATION
            - BUSINESS_NEW_CHATS
            - BUSINESS_NEW_CONTACT_FORM
            - BUSINESS_OLO_IMPORT
            - BUSINESS_OLO_SETTINGS_CREATED
            - BUSINESS_OLO_SETTINGS_DELETED
            - BUSINESS_OLO_SETTINGS_UPDATED
            - BUSINESS_PAGE_INVALIDATE
            - BUSINESS_PAY_INVOICE
            - BUSINESS_PRODUCT_PLAN_CHANGED
            - BUSINESS_STATUS_CHANGED
            - BUSINESS_TEMPLATE_UPDATE
            - BUSINESS_UPDATE_PAGE_SOCIAL_POST
            - BUSINESS_UPDATE_PRICE
            - DATA_POINT_AUTOMATED_REPLY
            - DATA_POINT_REPLIED
            - DATA_POINT_REPLIED_PENDING_APPROVAL
            - DATA_POINT_REPLY_APPROVE
            - DATA_POINT_REPLY_REJECT
            - DATA_POINT_SERVICE_NOW_SUBMITTED
            - DIRECTORY_BUSINESS_PAGE_DATA_POINT_CHECK
            - DIRECTORY_BUSINESS_PAGE_DATA_POINT_INVALID
            - LISTING_AUTOVALIDATION_FAILED
            - LISTING_BLACKLIST
            - LISTING_CANCEL
            - LISTING_DATAPOINT_CHECK
            - LISTING_DATAPOINT_INVALID
            - LISTING_DELETE
            - LISTING_DIRECTORY_CONNECT
            - LISTING_DIRECTORY_DUPLICATE_REMOVED
            - LISTING_FACEBOOK_PAGE_INVALIDATE
            - LISTING_FEED_CREATE
            - LISTING_FEED_DUPLICATE_REMOVED
            - LISTING_FEED_IN_SYNC_FIELDS
            - LISTING_FLAGGED
            - LISTING_GOOGLE_PAGE_CREATE
            - LISTING_GOOGLE_PAGE_INVALIDATE
            - LISTING_GOOGLE_PAGE_UPDATE
            - LISTING_INITIATE_OWNERSHIP_TRANSFER
            - LISTING_INVITATION_SENT
            - LISTING_LINK_CHANGE
            - LISTING_MANUAL
            - LISTING_NEEDS_REVIEW_DELETED
            - LISTING_PAGE_INVALIDATE
            - LISTING_PUBLISHER_UPDATE
            - LISTING_REMOVAL_STATUS_CHECK
            - LISTING_REMOVAL_SUPPRESS
            - LISTING_REVIEWED
            - LISTING_STATUS_CHANGE
            - LISTING_SUGGESTION
            - LISTING_SUPPRESS
            - LISTING_SUPPRESS_NOT_ALLOWED
            - LISTING_SYNC_CHECK
            - LISTING_UPDATE
            - LISTING_UPDATE_PAGE_SOCIAL_POST
            - LISTING_UPDATE_SOCIAL_POST
            - LISTING_WAITING_DIRECTORY_ACTION
            - LOCATION_BILLING
            - LOCATION_BUSINESS_CHANGED
            - LOCATION_CHECKOUT
            - LOCATION_CHECKOUT_FREE
            - LOCATION_CHECKOUT_SALESPARTNER
            - LOCATION_CHECKOUT_UPGRADE
            - LOCATION_CLEANSING
            - LOCATION_CONTRACT_UPDATED
            - LOCATION_CREATED
            - LOCATION_DUPLICATE_LISTING_CHECK
            - LOCATION_DUPLICATE_LISTING_DETECTION
            - LOCATION_FEED_CLOSED
            - LOCATION_FEED_PROFILE_CHANGED
            - LOCATION_GEOCODING_MANUAL
            - LOCATION_GOOGLE_RANK_CHECK
            - LOCATION_GROUP_CREATED
            - LOCATION_GROUP_DELETED
            - LOCATION_GROUP_UPDATED
            - LOCATION_INVOICE_CHANGED
            - LOCATION_LISTING_ADDED
            - LOCATION_NEEDS_REVIEW_DELETED
            - LOCATION_NEW_CHATS
            - LOCATION_NEW_CONTACT_FORM
            - LOCATION_NORMALIZATION_STATUS_CHANGED
            - LOCATION_OLO_IMPORT
            - LOCATION_PARTIAL_UPDATE
            - LOCATION_PAY_INVOICE
            - LOCATION_PROFILE_CHANGED
            - LOCATION_PROFILE_SUGGESTION_DECLINE
            - LOCATION_STATUS_CHANGED
            - LOCATION_SUBSCRIPTION_CHANGED
            - LOCATION_SUGGESTION_CREATED
            - LOCATION_SUGGESTION_UPDATED
            - LOCATION_SYNC_STARTED
            - LOCATION_VISIBILITY_INDEX_CHANGED
            - PRODUCT_PLAN_CREATED
            - PRODUCT_PLAN_DELETED
            - PRODUCT_PLAN_UPDATED
            - SALES_PARTNER_APPROVAL
            - SALES_PARTNER_CHILDREN_UPDATED
            - SALES_PARTNER_CREATED
            - SALES_PARTNER_DIRECTORY_BRAND
            - SALES_PARTNER_DIRECTORY_CONNECT
            - SALES_PARTNER_ENTERPRISE_ONBOARDING
            - SALES_PARTNER_INVOICE_CHANGED
            - SALES_PARTNER_INVOICE_PAYMENT_INFORMATION_CHANGED
            - SALES_PARTNER_ONE_AND_ONE_AUTHENTICATION
            - SALES_PARTNER_ONE_AND_ONE_CONTRACT_INFORMATION
            - SALES_PARTNER_PASSWORD_RESET
            - SALES_PARTNER_PAYMENT_METHOD_RESET
            - SALES_PARTNER_PAY_INVOICE
            - SALES_PARTNER_REPRESENTATIVE_UPDATE
            - SALES_PARTNER_SIGNUP
            - SALES_PARTNER_STATUS_CHANGED
            - SALES_PARTNER_TYPE_CHANGED
            - SALES_PARTNER_UPDATED
            - SALES_REPRESENTATIVE_UPDATE
            - SEARCH_DATA_RECHECK_LINK_SHARED
            - USER_ACTIVATION_EMAIL_SENT
            - USER_DASHBOARD_EXPORT_COMPLETE
            - USER_DIGEST_EMAIL_SENT
            - USER_FINISH_VERIFICATION_GOOGLE_EMAIL_SENT
            - USER_INVITATION
            - USER_INVITATION_EMAIL_SENT
            - USER_INVOICE_INVITATION
            - USER_MODIFY_EMAIL_SETTING
            - USER_NOTIFICATION_EMAIL_SENT
            - USER_PASSWORD_RESET
            - USER_PENDING_APPROVAL_REPLY_NOTIFICATION_EMAIL_SENT
            - USER_READ_DATA_POINT
            - USER_START_VERIFICATION_GOOGLE_EMAIL_SENT
            - USER_STATUS_CHANGED
            - USER_TIER1_EMAIL_SENT
            - USER_TIER2_EMAIL_SENT
            - USER_TIER3_EMAIL_SENT
            - USER_UNREAD_DATA_POINT
            - USER_UNREAD_REVIEW_NOTIFICATION_EMAIL_SENT
            - USER_UPDATED
            - USER_SOCIAL_POST_PENDING_APPROVAL_EMAIL_SENT
            - WIDGET_CONFIG_CREATED
            - WIDGET_CONFIG_DELETED
            - WIDGET_CONFIG_PUBLISHED
            - SOCIAL_POST_PENDING_APPROVAL
      description: Webhook Command Model
    WebhookListWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          type: array
          description: The actual response object of the response
          items:
            $ref: '#/components/schemas/Webhook'
    WebhookWrapper:
      required:
        - response
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - QUOTA_LIMIT_EXCEED
            - NOT_AUTHORIZED
            - FORBIDDEN
            - BAD_ACCESS_TOKEN
            - BAD_PRIVATE_KEY
            - BAD_PUBLIC_KEY
            - MISSING_PARAMETER
            - INVALID_PARAMETER
            - WRONG_PARAMETER_TYPE
            - CONFLICT
            - RESOURCE_LOCKED
            - SERVER_ERROR
            - ERROR
            - NOT_FOUND
            - BAD_REQUEST
            - USER_ERROR
            - PARTIAL_ERROR
        message:
          type: string
          description: (optional) Holds further information about the response
        warnings:
          type: array
          description: (optional) Holds further warnings
          items:
            type: string
            description: (optional) Holds further warnings
        response:
          allOf:
            - $ref: '#/components/schemas/Webhook'
    WhitelabelInformation:
      type: object
      properties:
        id:
          type: integer
          description: id
          format: int64
        name:
          type: string
          description: Name of white-label information
        identifier:
          type: string
          description: Url path of the white-label information
      description: Whitelabel Information Model
  securitySchemes:
    privateKey:
      type: apiKey
      description: Private authorization key
      name: privateKey
      in: header
    accessToken:
      type: apiKey
      description: Access Token key
      name: accessToken
      in: header
    publicKey:
      type: apiKey
      description: Public Key
      name: publicKey
      in: header
x-tagGroups:
  - name: Set up
    tags:
      - Users
      - Business Connections
      - Businesses
      - Configuration
      - Sales Partners
      - Monitoring
      - Product Plans
      - Webhooks
  - name: Products
    tags:
      - Auto Response
      - Brand Data Points
      - Dashboard
      - Dashboard Exports
      - Data Points
      - Data Point Filters
      - Templates
      - Social Posting
      - Social Posting Templates
      - Digital Asset Management
      - Status Check
      - Store Finder
  - name: Locations Hub
    tags:
      - Batch Operation
      - Categories
      - Collection Management
      - Content List
      - Locations Data
      - Custom Items
      - Events
      - Listings
      - Labels
      - Location Groups
      - Menu Items
      - Persons
      - Locations Photos
      - Products
      - Service Items
      - Suggestions
