Palenca (Vech) console API

openapi: 3.1.0
info:
  title: Palenca accounts console API
  description: Palenca API
  version: 2.0.0
tags:
- name: console
paths:
  /console/companies/{company_id}:
    get:
      tags:
      - console
      summary: Get Company
      operationId: get_company_console_companies__company_id__get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_CompanyDataPrivate_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - console
      summary: Update Company
      operationId: update_company_console_companies__company_id__patch
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__api__schemas__companies__UpdateCompanyParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_CompanyDataPrivate_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies:
    post:
      tags:
      - console
      summary: Create Company
      operationId: create_company_console_companies_post
      parameters:
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__api__schemas__companies__CreateCompanyParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_CompanyDataPrivate_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/widgets/{widget_id}:
    get:
      tags:
      - console
      summary: Get Widget
      operationId: get_widget_console_companies__company_id__widgets__widget_id__get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Widget Id
        name: widget_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WidgetConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - console
      summary: Update Company Widget
      operationId: update_company_widget_console_companies__company_id__widgets__widget_id__put
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Widget Id
        name: widget_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__api__schemas__admin__UpdateWidgetParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WidgetConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/widgets/accounts/{account_id}:
    get:
      tags:
      - console
      summary: Get Widget Id
      operationId: get_widget_id_console_companies__company_id__widgets_accounts__account_id__get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WidgetConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/widgets:
    get:
      tags:
      - console
      summary: List Company Widgets
      operationId: list_company_widgets_console_companies__company_id__widgets_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WidgetsConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - console
      summary: Create Company Widget
      operationId: create_company_widget_console_companies__company_id__widgets_post
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__api__schemas__admin__CreateWidgetParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WidgetConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/webhooks/events:
    get:
      tags:
      - console
      summary: List Webhook Topics
      operationId: list_webhook_topics_console_webhooks_events_get
      parameters:
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WebhooksDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/webhooks:
    get:
      tags:
      - console
      summary: List Webhooks
      operationId: list_webhooks_console_companies__company_id__webhooks_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WebhooksDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - console
      summary: Create Webhook
      operationId: create_webhook_console_companies__company_id__webhooks_post
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WebhookDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/webhooks/{webhook_id}:
    put:
      tags:
      - console
      summary: Update Webhook
      operationId: update_webhook_console_companies__company_id__webhooks__webhook_id__put
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Webhook Id
        name: webhook_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WebhookDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - console
      summary: Delete Webhook
      operationId: delete_webhook_console_companies__company_id__webhooks__webhook_id__delete
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Webhook Id
        name: webhook_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WebhookDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/webhooks/{webhook_id}/status:
    put:
      tags:
      - console
      summary: Update Webhook Status
      operationId: update_webhook_status_console_companies__company_id__webhooks__webhook_id__status_put
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Webhook Id
        name: webhook_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WebhookDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/webhooks/{webhook_id}/logs:
    get:
      tags:
      - console
      summary: Get Webhook
      operationId: get_webhook_console_companies__company_id__webhooks__webhook_id__logs_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Webhook Id
        name: webhook_id
        in: path
      - required: false
        schema:
          $ref: '#/components/schemas/WebhookLogStatus'
        name: status
        in: query
      - required: false
        schema:
          type: string
          title: From Date
        name: from_date
        in: query
      - required: false
        schema:
          type: string
          title: To Date
        name: to_date
        in: query
      - required: false
        schema:
          type: string
          title: Date Field
          default: created_at
        name: date_field
        in: query
      - required: false
        schema:
          type: string
          title: Order By
          default: -created_at
        name: order_by
        in: query
      - required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/WebhookActions'
          - type: string
          title: Event
        name: event
        in: query
      - required: false
        schema:
          type: integer
          title: Items Per Page
          default: 500
        name: items_per_page
        in: query
      - required: false
        schema:
          type: integer
          title: Page
          default: 1
        name: page
        in: query
      - required: false
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: query
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasePaginationResponse_WebhookDetailsConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/webhooks/{webhook_id}/logs/{log_id}/retry:
    post:
      tags:
      - console
      summary: Retry Webhook Events
      operationId: retry_webhook_events_console_companies__company_id__webhooks__webhook_id__logs__log_id__retry_post
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Webhook Id
        name: webhook_id
        in: path
      - required: true
        schema:
          type: string
          title: Log Id
        name: log_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_WebhookDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/accounts/{account_id}:
    get:
      tags:
      - console
      summary: Get Account
      operationId: get_account_console_companies__company_id__accounts__account_id__get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: false
        schema:
          type: string
          title: Accept-Language
        name: accept-language
        in: header
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_AccountsDataConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/accounts:
    get:
      tags:
      - console
      summary: List Accounts
      operationId: list_accounts_console_companies__company_id__accounts_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: integer
          title: Page
          default: 1
        name: page
        in: query
      - required: false
        schema:
          type: integer
          title: Items Per Page
          default: 100
        name: items_per_page
        in: query
      - required: false
        schema:
          type: string
          title: Order By
          default: -created_at
        name: order_by
        in: query
      - required: false
        schema:
          type: string
          title: Query
        name: query
        in: query
      - required: false
        schema:
          $ref: '#/components/schemas/LoginStatus'
        name: status
        in: query
      - required: false
        schema:
          type: string
          title: From Date
        name: from_date
        in: query
      - required: false
        schema:
          type: string
          title: To Date
        name: to_date
        in: query
      - required: false
        schema:
          type: string
          title: Date Field
          default: created_at
        name: date_field
        in: query
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_AccountsDataConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/accounts/{account_id}/profile:
    get:
      tags:
      - console
      summary: Get Profile
      operationId: get_profile_console_companies__company_id__accounts__account_id__profile_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_ProfileDataBaseResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/accounts/{account_id}/employment:
    get:
      tags:
      - console
      summary: Get Employment
      operationId: get_employment_console_companies__company_id__accounts__account_id__employment_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_EmploymentDataBaseResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/accounts/{account_id}/earnings:
    get:
      tags:
      - console
      summary: Get Earnings Without Duplicates
      operationId: get_earnings_without_duplicates_console_companies__company_id__accounts__account_id__earnings_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/DateRange'
          default: month
        name: date_range
        in: query
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_EarningsDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/logins:
    get:
      tags:
      - console
      summary: List Logins
      operationId: list_logins_console_companies__company_id__logins_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: false
        schema:
          type: integer
          title: Page
          default: 1
        name: page
        in: query
      - required: false
        schema:
          type: integer
          title: Items Per Page
          default: 100
        name: items_per_page
        in: query
      - required: false
        schema:
          type: string
          title: Order By
          default: -created_at
        name: order_by
        in: query
      - required: false
        schema:
          type: string
          title: Query
        name: query
        in: query
      - required: false
        schema:
          $ref: '#/components/schemas/LoginStatus'
        name: status
        in: query
      - required: false
        schema:
          type: string
          title: From Date
        name: from_date
        in: query
      - required: false
        schema:
          type: string
          title: To Date
        name: to_date
        in: query
      - required: false
        schema:
          type: string
          title: Date Field
          default: created_at
        name: date_field
        in: query
      - required: false
        schema:
          $ref: '#/components/schemas/LoginSourceCode'
        name: source
        in: query
      - required: false
        schema:
          $ref: '#/components/schemas/PlatformCode'
        name: platform
        in: query
      - required: false
        schema:
          type: string
          title: Exclude Platforms
        name: exclude_platforms
        in: query
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_AccountsDataConsoleResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/accounts/{account_id}/logins:
    get:
      tags:
      - console
      summary: Get Logins
      operationId: get_logins_console_companies__company_id__accounts__account_id__logins_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_AccountLoginsDataResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/accounts/{account_id}/refresh:
    post:
      tags:
      - console
      summary: Refresh Account
      operationId: refresh_account_console_companies_accounts__account_id__refresh_post
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/accounts/retry/{account_id}:
    post:
      tags:
      - console
      summary: Retry Imss Login
      operationId: retry_imss_login_console_companies_accounts_retry__account_id__post
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/accounts/{account_id}/earnings/exists:
    get:
      tags:
      - console
      summary: Does Account Have Earnings
      operationId: does_account_have_earnings_console_companies__company_id__accounts__account_id__earnings_exists_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/companies/{company_id}/accounts/{account_id}/raw-data:
    get:
      tags:
      - console
      summary: Get Raw Data
      operationId: get_raw_data_console_companies__company_id__accounts__account_id__raw_data_get
      parameters:
      - required: true
        schema:
          type: string
          format: uuid
          title: Company Id
        name: company_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
          title: Account Id
        name: account_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/status/{status_details}:
    get:
  

# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palenca-vech/refs/heads/main/openapi/palenca-vech-console-api-openapi.yml