Files
query-orchestration/api/queryAPI/api.gen.go
T

1743 lines
65 KiB
Go
Raw Normal View History

// Package queryapi provides primitives to interact with the openapi HTTP API.
2025-01-15 19:45:51 +00:00
//
// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.4.1 DO NOT EDIT.
package queryapi
2025-01-15 19:45:51 +00:00
import (
"bytes"
"compress/gzip"
"encoding/base64"
"fmt"
"net/http"
"net/url"
"path"
"strings"
"time"
2025-01-15 19:45:51 +00:00
"github.com/getkin/kin-openapi/openapi3"
"github.com/labstack/echo/v4"
2025-08-05 07:03:35 -07:00
"github.com/oapi-codegen/nullable"
2025-01-15 19:45:51 +00:00
"github.com/oapi-codegen/runtime"
openapi_types "github.com/oapi-codegen/runtime/types"
2025-01-15 19:45:51 +00:00
)
const (
2025-04-21 15:12:38 -07:00
CognitoAuthScopes = "cognitoAuth.Scopes"
JwtAuthScopes = "jwtAuth.Scopes"
)
// Defines values for AdminUserActionResponseAction.
const (
Disable AdminUserActionResponseAction = "disable"
Enable AdminUserActionResponseAction = "enable"
)
2025-08-05 07:03:35 -07:00
// Defines values for BatchStatus.
const (
BatchStatusCancelled BatchStatus = "cancelled"
BatchStatusCompleted BatchStatus = "completed"
BatchStatusFailed BatchStatus = "failed"
BatchStatusProcessing BatchStatus = "processing"
)
// Defines values for ClientStatus.
const (
INSYNC ClientStatus = "IN_SYNC"
NOTSYNCED ClientStatus = "NOT_SYNCED"
NOTSYNCING ClientStatus = "NOT_SYNCING"
)
// Defines values for ExportStatus.
const (
2025-08-05 07:03:35 -07:00
ExportStatusCompleted ExportStatus = "completed"
ExportStatusFailed ExportStatus = "failed"
ExportStatusInProgress ExportStatus = "in_progress"
)
// Defines values for FieldFilterCondition.
const (
ClosedInterval FieldFilterCondition = "closed_interval"
Exclude FieldFilterCondition = "exclude"
GreaterThan FieldFilterCondition = "greater_than"
Include FieldFilterCondition = "include"
LeftClosedInterval FieldFilterCondition = "left_closed_interval"
LessThan FieldFilterCondition = "less_than"
OpenInterval FieldFilterCondition = "open_interval"
RightClosedInterval FieldFilterCondition = "right_closed_interval"
)
2025-01-15 19:45:51 +00:00
// Defines values for QueryType.
const (
CONTEXTFULL QueryType = "CONTEXT_FULL"
JSONEXTRACTOR QueryType = "JSON_EXTRACTOR"
)
// Defines values for ListAdminUsersParamsStatus.
const (
All ListAdminUsersParamsStatus = "all"
Disabled ListAdminUsersParamsStatus = "disabled"
Enabled ListAdminUsersParamsStatus = "enabled"
)
// Defines values for ListAdminUsersParamsSortBy.
const (
CreatedAt ListAdminUsersParamsSortBy = "created_at"
Email ListAdminUsersParamsSortBy = "email"
LastName ListAdminUsersParamsSortBy = "last_name"
)
// Defines values for ListAdminUsersParamsSortOrder.
const (
Asc ListAdminUsersParamsSortOrder = "asc"
Desc ListAdminUsersParamsSortOrder = "desc"
)
// AdminUserActionResponse Response for user enable/disable actions with success status and timestamp
type AdminUserActionResponse struct {
// Action Action performed
Action AdminUserActionResponseAction `json:"action"`
// CognitoSubjectId Cognito subject identifier for the action response
CognitoSubjectId *string `json:"cognito_subject_id,omitempty"`
// Email Email of the user acted upon
Email openapi_types.Email `json:"email"`
// Success Whether the action succeeded
Success bool `json:"success"`
// Timestamp Timestamp of the action
Timestamp *time.Time `json:"timestamp,omitempty"`
}
// AdminUserActionResponseAction Action performed
type AdminUserActionResponseAction string
// AdminUserCreate Request body for creating a new user with email, name, and role assignments
type AdminUserCreate struct {
// Email User email address (used as Cognito username)
Email openapi_types.Email `json:"email"`
// FirstName User's given name for account creation
FirstName string `json:"first_name"`
// LastName User's family name for account creation
LastName string `json:"last_name"`
// Roles List of roles to assign in Permit.io
Roles []string `json:"roles"`
}
// AdminUserCreateResponse Response after creating a user, including Cognito subject ID and sync status
type AdminUserCreateResponse struct {
// CognitoSubjectId Created user's Cognito unique subject identifier
CognitoSubjectId string `json:"cognito_subject_id"`
// CreatedAt Timestamp when the user was created in the system
CreatedAt *time.Time `json:"created_at,omitempty"`
// Email User email address
Email openapi_types.Email `json:"email"`
// Enabled Whether the created user is enabled in Cognito
Enabled *bool `json:"enabled,omitempty"`
// FirstName Created user's given name
FirstName *string `json:"first_name,omitempty"`
// LastName Created user's family name
LastName *string `json:"last_name,omitempty"`
// PermitSynced Whether user was successfully created in Permit.io
PermitSynced bool `json:"permit_synced"`
// RolesAssigned Roles successfully assigned in Permit.io
RolesAssigned *[]string `json:"roles_assigned,omitempty"`
// Status Cognito user status
Status string `json:"status"`
}
// AdminUserDeleteResponse Response for user deletion with status from each system (Cognito and Permit.io)
type AdminUserDeleteResponse struct {
// CognitoSubjectId Cognito subject identifier of the deleted user
CognitoSubjectId *string `json:"cognito_subject_id,omitempty"`
// DeletedFrom Deletion status from each system
DeletedFrom struct {
// Cognito Whether user was deleted from Cognito
Cognito bool `json:"cognito"`
// Permit Whether user was deleted from Permit.io
Permit bool `json:"permit"`
} `json:"deleted_from"`
// Email Email of the deleted user
Email openapi_types.Email `json:"email"`
// Success Whether the deletion succeeded
Success bool `json:"success"`
// Timestamp Timestamp of the deletion
Timestamp *time.Time `json:"timestamp,omitempty"`
}
// AdminUserDetails Complete user information from Cognito and Permit.io including roles and timestamps
type AdminUserDetails struct {
// CognitoSubjectId User's Cognito unique subject identifier from authentication system
CognitoSubjectId string `json:"cognito_subject_id"`
// CreatedAt Timestamp when the user account was created
CreatedAt *time.Time `json:"created_at,omitempty"`
// Email Email address of the user account
Email openapi_types.Email `json:"email"`
// Enabled Current enabled status of the user in Cognito
Enabled bool `json:"enabled"`
// FirstName User's given name retrieved from Cognito
FirstName *string `json:"first_name,omitempty"`
// LastName User's family name retrieved from Cognito
LastName *string `json:"last_name,omitempty"`
// Roles Roles assigned in Permit.io
Roles *[]string `json:"roles,omitempty"`
// Status Current Cognito user account status
Status string `json:"status"`
// UpdatedAt Timestamp of last update
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
// AdminUserList Paginated list of users with total count and pagination metadata
type AdminUserList struct {
// HasMore Whether more pages are available
HasMore *bool `json:"has_more,omitempty"`
// Page Current page number
Page int32 `json:"page"`
// PageSize Number of users per page
PageSize int32 `json:"page_size"`
// Total Total number of users matching filter
Total int32 `json:"total"`
// Users List of users for current page
Users []AdminUserDetails `json:"users"`
}
// AdminUserUpdate Request body for updating user attributes (first name, last name, and roles)
type AdminUserUpdate struct {
// FirstName Updated given name for the user
FirstName *string `json:"first_name,omitempty"`
// LastName Updated family name for the user
LastName *string `json:"last_name,omitempty"`
// Roles Complete list of roles to assign (replaces existing roles)
Roles *[]string `json:"roles,omitempty"`
}
2025-08-05 07:03:35 -07:00
// BatchID The batch upload id.
type BatchID = openapi_types.UUID
// BatchStatus The status of a batch upload
type BatchStatus string
// BatchUploadDetails defines model for BatchUploadDetails.
type BatchUploadDetails struct {
// BatchId The batch upload id.
BatchId BatchID `json:"batch_id"`
// ClientId The client external id
ClientId ClientID `json:"client_id"`
// CompletedAt When the batch upload completed processing
CompletedAt nullable.Nullable[time.Time] `json:"completed_at,omitempty"`
// CreatedAt When the batch upload was created
CreatedAt time.Time `json:"created_at"`
// FailedDocuments Number of documents that failed processing
FailedDocuments int32 `json:"failed_documents"`
// FailedFilenames List of filenames that failed processing
FailedFilenames *[]string `json:"failed_filenames,omitempty"`
// InvalidTypeDocuments Number of non-PDF files found in archive
InvalidTypeDocuments int32 `json:"invalid_type_documents"`
// OriginalFilename Original filename of the uploaded ZIP archive
OriginalFilename string `json:"original_filename"`
// ProcessedDocuments Number of documents processed so far
ProcessedDocuments int32 `json:"processed_documents"`
// ProgressPercent Processing progress percentage
ProgressPercent int32 `json:"progress_percent"`
// Status The status of a batch upload
Status BatchStatus `json:"status"`
// TotalDocuments Total number of documents in the batch
TotalDocuments int32 `json:"total_documents"`
}
// BatchUploadList List of batch uploads for a client
type BatchUploadList struct {
Batches []BatchUploadSummary `json:"batches"`
// TotalCount Total number of batches for this client
TotalCount int32 `json:"total_count"`
}
// BatchUploadResponse Response returned when a batch upload is accepted for processing
type BatchUploadResponse struct {
// BatchId The batch upload id.
BatchId BatchID `json:"batch_id"`
// Status The status of a batch upload
Status BatchStatus `json:"status"`
// StatusUrl URL to check batch status
StatusUrl string `json:"status_url"`
}
// BatchUploadSummary Summary information about a batch upload
type BatchUploadSummary struct {
// BatchId The batch upload id.
BatchId BatchID `json:"batch_id"`
// ClientId The client external id
ClientId ClientID `json:"client_id"`
// CompletedAt When the batch upload completed processing
CompletedAt nullable.Nullable[time.Time] `json:"completed_at,omitempty"`
// CreatedAt When the batch upload was created
CreatedAt time.Time `json:"created_at"`
// FailedDocuments Number of documents that failed processing
FailedDocuments int32 `json:"failed_documents"`
// InvalidTypeDocuments Number of non-PDF files found in archive
InvalidTypeDocuments int32 `json:"invalid_type_documents"`
// OriginalFilename Original filename of the uploaded ZIP archive
OriginalFilename string `json:"original_filename"`
// ProcessedDocuments Number of documents processed so far
ProcessedDocuments int32 `json:"processed_documents"`
// ProgressPercent Processing progress percentage
ProgressPercent int32 `json:"progress_percent"`
// Status The status of a batch upload
Status BatchStatus `json:"status"`
// TotalDocuments Total number of documents in the batch
TotalDocuments int32 `json:"total_documents"`
}
// ClientCanSync If the client is allowing active syncs
type ClientCanSync = bool
// ClientCreate The properties for creation.
2025-01-21 18:24:14 +00:00
type ClientCreate struct {
// Id The client external id
Id ClientID `json:"id"`
2025-01-21 18:24:14 +00:00
// Name The client name
Name ClientName `json:"name"`
}
// ClientID The client external id
type ClientID = string
// ClientIDBody The client id.
type ClientIDBody struct {
// Id The client external id
Id ClientID `json:"id"`
2025-01-21 18:24:14 +00:00
}
// ClientName The client name
type ClientName = string
// ClientStatus Specifies the status of a client.
type ClientStatus string
// ClientStatusBody A client status information object.
type ClientStatusBody struct {
// Status Specifies the status of a client.
Status ClientStatus `json:"status"`
}
// ClientUpdate The properties that may be updated.
2025-01-21 18:24:14 +00:00
type ClientUpdate struct {
// CanSync If the client is allowing active syncs
CanSync *ClientCanSync `json:"can_sync,omitempty"`
2025-01-21 18:24:14 +00:00
// Name The client name
Name *ClientName `json:"name,omitempty"`
2025-01-21 18:24:14 +00:00
}
// CodeVersion The desired code version.
type CodeVersion = int64
// Collector Collector model.
type Collector struct {
// ActiveVersion The desired version.
ActiveVersion Version `json:"active_version"`
// ClientId The client external id
ClientId ClientID `json:"client_id"`
// Fields The fields in the collector.
Fields CollectorFields `json:"fields"`
// LatestVersion The desired version.
LatestVersion Version `json:"latest_version"`
// MinimumCleanerVersion The desired code version.
MinimumCleanerVersion CodeVersion `json:"minimum_cleaner_version"`
// MinimumTextVersion The desired code version.
MinimumTextVersion CodeVersion `json:"minimum_text_version"`
}
// CollectorField The field properties for the collector.
type CollectorField struct {
// Name The output field name.
Name CollectorFieldName `json:"name"`
// QueryId The query id.
QueryId QueryID `json:"query_id"`
}
// CollectorFieldName The output field name.
type CollectorFieldName = string
// CollectorFields The fields in the collector.
type CollectorFields = []CollectorField
// CollectorSet Payload for updating a Collector.
type CollectorSet struct {
// ActiveVersion The desired version.
ActiveVersion *Version `json:"active_version,omitempty"`
// Fields The fields in the collector.
Fields *CollectorFields `json:"fields,omitempty"`
// MinimumCleanerVersion The desired code version.
MinimumCleanerVersion *CodeVersion `json:"minimum_cleaner_version,omitempty"`
// MinimumTextVersion The desired code version.
MinimumTextVersion *CodeVersion `json:"minimum_text_version,omitempty"`
}
// DocClient The properties of a client.
type DocClient struct {
// CanSync If the client is allowing active syncs
CanSync ClientCanSync `json:"can_sync"`
// Id The client external id
Id ClientID `json:"id"`
// Name The client name
Name ClientName `json:"name"`
}
// Document The document properties.
type Document struct {
// ClientId The client external id
ClientId ClientID `json:"client_id"`
// Fields The fields and the value for the document
Fields map[string]interface{} `json:"fields"`
// Hash The document hash
Hash Hash `json:"hash"`
// Id The document id.
Id DocumentID `json:"id"`
}
// DocumentID The document id.
type DocumentID = openapi_types.UUID
// DocumentSummary The document summary properties.
type DocumentSummary struct {
// Hash The document hash
Hash Hash `json:"hash"`
// Id The document id.
Id DocumentID `json:"id"`
}
// ErrorMessage Description of error
type ErrorMessage struct {
// Message Message describing the cause.
Message string `json:"message"`
}
// ExportDetails Payload for export trigger response.
type ExportDetails struct {
// ClientId The client external id
ClientId ClientID `json:"client_id"`
// OutputLocation The location in which the export zip file will be found.
OutputLocation *string `json:"output_location,omitempty"`
// Status The possible export states.
Status ExportStatus `json:"status"`
}
// ExportID The export id.
type ExportID = openapi_types.UUID
// ExportStatus The possible export states.
type ExportStatus string
2025-01-15 19:45:51 +00:00
// ExportTrigger Payload for triggering an export.
type ExportTrigger struct {
// FieldFilters Filter the scope based on field output values.
FieldFilters *[]FieldFilter `json:"field_filters,omitempty"`
// IngestionFilters Filter the scope based on ingestion parameters.
IngestionFilters *struct {
// EndDate The last date of ingestion.
EndDate *time.Time `json:"end_date,omitempty"`
// StartDate This first date of ingestion.
StartDate *time.Time `json:"start_date,omitempty"`
} `json:"ingestion_filters,omitempty"`
2025-01-15 19:45:51 +00:00
}
// FieldFilter Filtering a column
type FieldFilter struct {
// Condition The possible field filtering conditions.
Condition FieldFilterCondition `json:"condition"`
// FieldName The output field name.
FieldName CollectorFieldName `json:"field_name"`
// Values The values useful to the filter.
Values []string `json:"values"`
}
// FieldFilterCondition The possible field filtering conditions.
type FieldFilterCondition string
// Hash The document hash
type Hash = string
// IdMessage A single uuid.
2025-01-15 19:45:51 +00:00
type IdMessage struct {
// Id Unique identifier for entity.
Id openapi_types.UUID `json:"id"`
}
// ListDocuments The documents in the client.
type ListDocuments = []DocumentSummary
// ListQueries A set of queries.
2025-01-15 19:45:51 +00:00
type ListQueries struct {
// Queries List of queries.
Queries []Query `json:"queries"`
}
// Query A logic unit of execution.
2025-01-15 19:45:51 +00:00
type Query struct {
// ActiveVersion The desired version.
ActiveVersion Version `json:"active_version"`
2025-01-15 19:45:51 +00:00
// Config Configuration for the query.
Config *QueryConfig `json:"config,omitempty"`
2025-01-15 19:45:51 +00:00
// Id The query id.
Id QueryID `json:"id"`
2025-01-15 19:45:51 +00:00
// LatestVersion The desired version.
LatestVersion Version `json:"latest_version"`
2025-01-15 19:45:51 +00:00
// RequiredQueries List of required query IDs.
RequiredQueries *RequiredQueryIDs `json:"required_queries,omitempty"`
2025-01-15 19:45:51 +00:00
// Type Specifies the type of the query.
Type QueryType `json:"type"`
}
// QueryConfig Configuration for the query.
type QueryConfig = string
// QueryCreate The parameters required to create a query.
2025-01-15 19:45:51 +00:00
type QueryCreate struct {
// Config Configuration for the query.
Config *QueryConfig `json:"config,omitempty"`
2025-01-15 19:45:51 +00:00
// RequiredQueries List of required query IDs.
RequiredQueries *RequiredQueryIDs `json:"required_queries,omitempty"`
2025-01-15 19:45:51 +00:00
// Type Specifies the type of the query.
Type QueryType `json:"type"`
}
// QueryID The query id.
type QueryID = openapi_types.UUID
// QueryTestRequest The properties for a query test request.
2025-01-15 19:45:51 +00:00
type QueryTestRequest struct {
// DocumentId The document id.
DocumentId DocumentID `json:"document_id"`
2025-01-15 19:45:51 +00:00
// QueryVersion The desired version.
QueryVersion Version `json:"query_version"`
2025-01-15 19:45:51 +00:00
}
// QueryTestResponse The response from a query test.
2025-01-15 19:45:51 +00:00
type QueryTestResponse struct {
// Value Result of the query test.
Value string `json:"value"`
}
// QueryType Specifies the type of the query.
type QueryType string
// QueryUpdate The properties that may be updated for a query.
2025-01-15 19:45:51 +00:00
type QueryUpdate struct {
// ActiveVersion The desired version.
ActiveVersion *Version `json:"active_version,omitempty"`
2025-01-15 19:45:51 +00:00
// Config Configuration for the query.
Config *QueryConfig `json:"config,omitempty"`
2025-01-15 19:45:51 +00:00
// RequiredQueries List of required query IDs.
RequiredQueries *RequiredQueryIDs `json:"required_queries,omitempty"`
2025-01-15 19:45:51 +00:00
}
// RequiredQueryIDs List of required query IDs.
type RequiredQueryIDs = []QueryID
// Version The desired version.
type Version = int32
// UserEmail defines model for UserEmail.
type UserEmail = openapi_types.Email
// BadGateway Description of error
type BadGateway = ErrorMessage
// Conflict Description of error
type Conflict = ErrorMessage
// Forbidden Description of error
type Forbidden = ErrorMessage
// InternalError Description of error
type InternalError = ErrorMessage
// InvalidRequest Description of error
type InvalidRequest = ErrorMessage
2025-08-05 07:03:35 -07:00
// NotFound Description of error
type NotFound = ErrorMessage
// TooManyRequests Description of error
type TooManyRequests = ErrorMessage
// Unauthorized Description of error
type Unauthorized = ErrorMessage
// ListAdminUsersParams defines parameters for ListAdminUsers.
type ListAdminUsersParams struct {
// Page Page number for pagination
Page *int32 `form:"page,omitempty" json:"page,omitempty"`
// PageSize Number of results per page
PageSize *int32 `form:"page_size,omitempty" json:"page_size,omitempty"`
// Search Search term for email/name filtering
Search *string `form:"search,omitempty" json:"search,omitempty"`
// Status Filter by user status
Status *ListAdminUsersParamsStatus `form:"status,omitempty" json:"status,omitempty"`
// SortBy Field to sort by
SortBy *ListAdminUsersParamsSortBy `form:"sort_by,omitempty" json:"sort_by,omitempty"`
// SortOrder Sort direction
SortOrder *ListAdminUsersParamsSortOrder `form:"sort_order,omitempty" json:"sort_order,omitempty"`
}
// ListAdminUsersParamsStatus defines parameters for ListAdminUsers.
type ListAdminUsersParamsStatus string
// ListAdminUsersParamsSortBy defines parameters for ListAdminUsers.
type ListAdminUsersParamsSortBy string
// ListAdminUsersParamsSortOrder defines parameters for ListAdminUsers.
type ListAdminUsersParamsSortOrder string
// DeleteAdminUserParams defines parameters for DeleteAdminUser.
type DeleteAdminUserParams struct {
// Confirm Must be set to true to confirm deletion
Confirm bool `form:"confirm" json:"confirm"`
}
// UploadDocumentMultipartBody defines parameters for UploadDocument.
type UploadDocumentMultipartBody struct {
// File The file to upload
File openapi_types.File `json:"file"`
// Filename Optional custom filename
Filename *string `json:"filename,omitempty"`
}
2025-08-05 07:03:35 -07:00
// ListDocumentBatchesParams defines parameters for ListDocumentBatches.
type ListDocumentBatchesParams struct {
// Limit Maximum number of items to return
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
// Offset Number of items to skip
Offset *int32 `form:"offset,omitempty" json:"offset,omitempty"`
}
// UploadDocumentBatchMultipartBody defines parameters for UploadDocumentBatch.
type UploadDocumentBatchMultipartBody struct {
// Archive The file to be uploaded as a ZIP archive
Archive openapi_types.File `json:"archive"`
}
2025-04-07 14:10:39 -07:00
// LoginCallbackParams defines parameters for LoginCallback.
type LoginCallbackParams struct {
// Code Authorization code from Cognito
Code string `form:"code" json:"code"`
// State State parameter for CSRF protection
State string `form:"state" json:"state"`
}
// CreateAdminUserJSONRequestBody defines body for CreateAdminUser for application/json ContentType.
type CreateAdminUserJSONRequestBody = AdminUserCreate
// UpdateAdminUserJSONRequestBody defines body for UpdateAdminUser for application/json ContentType.
type UpdateAdminUserJSONRequestBody = AdminUserUpdate
2025-01-21 18:24:14 +00:00
// CreateClientJSONRequestBody defines body for CreateClient for application/json ContentType.
type CreateClientJSONRequestBody = ClientCreate
// UpdateClientJSONRequestBody defines body for UpdateClient for application/json ContentType.
type UpdateClientJSONRequestBody = ClientUpdate
// SetCollectorByClientIdJSONRequestBody defines body for SetCollectorByClientId for application/json ContentType.
type SetCollectorByClientIdJSONRequestBody = CollectorSet
2025-01-15 19:45:51 +00:00
// UploadDocumentMultipartRequestBody defines body for UploadDocument for multipart/form-data ContentType.
type UploadDocumentMultipartRequestBody UploadDocumentMultipartBody
2025-08-05 07:03:35 -07:00
// UploadDocumentBatchMultipartRequestBody defines body for UploadDocumentBatch for multipart/form-data ContentType.
type UploadDocumentBatchMultipartRequestBody UploadDocumentBatchMultipartBody
2025-03-05 19:37:06 +00:00
// TriggerExportJSONRequestBody defines body for TriggerExport for application/json ContentType.
type TriggerExportJSONRequestBody = ExportTrigger
2025-01-15 19:45:51 +00:00
// CreateQueryJSONRequestBody defines body for CreateQuery for application/json ContentType.
type CreateQueryJSONRequestBody = QueryCreate
// UpdateQueryJSONRequestBody defines body for UpdateQuery for application/json ContentType.
type UpdateQueryJSONRequestBody = QueryUpdate
// TestQueryJSONRequestBody defines body for TestQuery for application/json ContentType.
type TestQueryJSONRequestBody = QueryTestRequest
// ServerInterface represents all server handlers.
type ServerInterface interface {
// List users
// (GET /admin/users)
ListAdminUsers(ctx echo.Context, params ListAdminUsersParams) error
// Create a new user
// (POST /admin/users)
CreateAdminUser(ctx echo.Context) error
// Delete user permanently
// (DELETE /admin/users/{email})
DeleteAdminUser(ctx echo.Context, email UserEmail, params DeleteAdminUserParams) error
// Get user by email
// (GET /admin/users/{email})
GetAdminUser(ctx echo.Context, email UserEmail) error
// Check if user exists
// (HEAD /admin/users/{email})
CheckAdminUserExists(ctx echo.Context, email UserEmail) error
// Update user attributes
// (PATCH /admin/users/{email})
UpdateAdminUser(ctx echo.Context, email UserEmail) error
// Disable user
// (POST /admin/users/{email}/disable)
DisableAdminUser(ctx echo.Context, email UserEmail) error
// Enable user
// (POST /admin/users/{email}/enable)
EnableAdminUser(ctx echo.Context, email UserEmail) error
2025-01-21 18:24:14 +00:00
// Create a new client
// (POST /client)
2025-01-21 18:24:14 +00:00
CreateClient(ctx echo.Context) error
// Get a client by ID
// (GET /client/{id})
GetClient(ctx echo.Context, id ClientID) error
2025-01-21 18:24:14 +00:00
// Update a client
// (PATCH /client/{id})
UpdateClient(ctx echo.Context, id ClientID) error
// Get a collector by client ID
// (GET /client/{id}/collector)
GetCollectorByClientId(ctx echo.Context, id ClientID) error
// Set a collector
// (PATCH /client/{id}/collector)
SetCollectorByClientId(ctx echo.Context, id ClientID) error
// List the documents for a client
// (GET /client/{id}/document)
ListDocumentsByClientId(ctx echo.Context, id ClientID) error
// Upload a file
// (POST /client/{id}/document)
UploadDocument(ctx echo.Context, id ClientID) error
2025-08-05 07:03:35 -07:00
// List batch uploads for a client
// (GET /client/{id}/document/batch)
ListDocumentBatches(ctx echo.Context, id ClientID, params ListDocumentBatchesParams) error
// Upload multiple PDF documents as ZIP archive
// (POST /client/{id}/document/batch)
UploadDocumentBatch(ctx echo.Context, id ClientID) error
// Cancel a batch upload
// (DELETE /client/{id}/document/batch/{batch_id})
CancelDocumentBatch(ctx echo.Context, id ClientID, batchId BatchID) error
// Get batch upload status
// (GET /client/{id}/document/batch/{batch_id})
GetDocumentBatch(ctx echo.Context, id ClientID, batchId BatchID) error
2025-03-05 19:37:06 +00:00
// Trigger an export
// (POST /client/{id}/export)
TriggerExport(ctx echo.Context, id ClientID) error
// Get client sync status
// (GET /client/{id}/status)
GetStatusByClientId(ctx echo.Context, id ClientID) error
// Get document details by its id
// (GET /document/{id})
GetDocument(ctx echo.Context, id DocumentID) error
// Check export state.
// (GET /export/{id})
ExportState(ctx echo.Context, id ExportID) error
2025-04-07 14:10:39 -07:00
// Get the home page menu
// (GET /home)
GetHomePage(ctx echo.Context) error
// Login to the application
// (GET /login)
Login(ctx echo.Context) error
// OAuth2 callback endpoint
// (GET /login-callback)
LoginCallback(ctx echo.Context, params LoginCallbackParams) error
// Logout from the application
// (GET /logout)
Logout(ctx echo.Context) error
2025-01-15 19:45:51 +00:00
// List queries
// (GET /query)
2025-01-15 19:45:51 +00:00
ListQueries(ctx echo.Context) error
// Create a new query
// (POST /query)
2025-01-15 19:45:51 +00:00
CreateQuery(ctx echo.Context) error
// Get a query by ID
// (GET /query/{id})
GetQuery(ctx echo.Context, id QueryID) error
2025-01-15 19:45:51 +00:00
// Update a query
// (PATCH /query/{id})
UpdateQuery(ctx echo.Context, id QueryID) error
2025-01-15 19:45:51 +00:00
// Test a query
// (POST /query/{id}/test)
TestQuery(ctx echo.Context, id QueryID) error
2025-01-15 19:45:51 +00:00
}
// ServerInterfaceWrapper converts echo contexts to parameters.
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
// ListAdminUsers converts echo context to params.
func (w *ServerInterfaceWrapper) ListAdminUsers(ctx echo.Context) error {
var err error
ctx.Set(JwtAuthScopes, []string{})
// Parameter object where we will unmarshal all parameters from the context
var params ListAdminUsersParams
// ------------- Optional query parameter "page" -------------
err = runtime.BindQueryParameter("form", true, false, "page", ctx.QueryParams(), &params.Page)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter page: %s", err))
}
// ------------- Optional query parameter "page_size" -------------
err = runtime.BindQueryParameter("form", true, false, "page_size", ctx.QueryParams(), &params.PageSize)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter page_size: %s", err))
}
// ------------- Optional query parameter "search" -------------
err = runtime.BindQueryParameter("form", true, false, "search", ctx.QueryParams(), &params.Search)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter search: %s", err))
}
// ------------- Optional query parameter "status" -------------
err = runtime.BindQueryParameter("form", true, false, "status", ctx.QueryParams(), &params.Status)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter status: %s", err))
}
// ------------- Optional query parameter "sort_by" -------------
err = runtime.BindQueryParameter("form", true, false, "sort_by", ctx.QueryParams(), &params.SortBy)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter sort_by: %s", err))
}
// ------------- Optional query parameter "sort_order" -------------
err = runtime.BindQueryParameter("form", true, false, "sort_order", ctx.QueryParams(), &params.SortOrder)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter sort_order: %s", err))
}
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.ListAdminUsers(ctx, params)
return err
}
// CreateAdminUser converts echo context to params.
func (w *ServerInterfaceWrapper) CreateAdminUser(ctx echo.Context) error {
var err error
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.CreateAdminUser(ctx)
return err
}
// DeleteAdminUser converts echo context to params.
func (w *ServerInterfaceWrapper) DeleteAdminUser(ctx echo.Context) error {
var err error
// ------------- Path parameter "email" -------------
var email UserEmail
err = runtime.BindStyledParameterWithOptions("simple", "email", ctx.Param("email"), &email, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter email: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Parameter object where we will unmarshal all parameters from the context
var params DeleteAdminUserParams
// ------------- Required query parameter "confirm" -------------
err = runtime.BindQueryParameter("form", true, true, "confirm", ctx.QueryParams(), &params.Confirm)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter confirm: %s", err))
}
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.DeleteAdminUser(ctx, email, params)
return err
}
// GetAdminUser converts echo context to params.
func (w *ServerInterfaceWrapper) GetAdminUser(ctx echo.Context) error {
var err error
// ------------- Path parameter "email" -------------
var email UserEmail
err = runtime.BindStyledParameterWithOptions("simple", "email", ctx.Param("email"), &email, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter email: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetAdminUser(ctx, email)
return err
}
// CheckAdminUserExists converts echo context to params.
func (w *ServerInterfaceWrapper) CheckAdminUserExists(ctx echo.Context) error {
var err error
// ------------- Path parameter "email" -------------
var email UserEmail
err = runtime.BindStyledParameterWithOptions("simple", "email", ctx.Param("email"), &email, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter email: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.CheckAdminUserExists(ctx, email)
return err
}
// UpdateAdminUser converts echo context to params.
func (w *ServerInterfaceWrapper) UpdateAdminUser(ctx echo.Context) error {
var err error
// ------------- Path parameter "email" -------------
var email UserEmail
err = runtime.BindStyledParameterWithOptions("simple", "email", ctx.Param("email"), &email, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter email: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.UpdateAdminUser(ctx, email)
return err
}
// DisableAdminUser converts echo context to params.
func (w *ServerInterfaceWrapper) DisableAdminUser(ctx echo.Context) error {
var err error
// ------------- Path parameter "email" -------------
var email UserEmail
err = runtime.BindStyledParameterWithOptions("simple", "email", ctx.Param("email"), &email, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter email: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.DisableAdminUser(ctx, email)
return err
}
// EnableAdminUser converts echo context to params.
func (w *ServerInterfaceWrapper) EnableAdminUser(ctx echo.Context) error {
var err error
// ------------- Path parameter "email" -------------
var email UserEmail
err = runtime.BindStyledParameterWithOptions("simple", "email", ctx.Param("email"), &email, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter email: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.EnableAdminUser(ctx, email)
return err
}
2025-01-21 18:24:14 +00:00
// CreateClient converts echo context to params.
func (w *ServerInterfaceWrapper) CreateClient(ctx echo.Context) error {
var err error
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-21 18:24:14 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.CreateClient(ctx)
return err
}
// GetClient converts echo context to params.
func (w *ServerInterfaceWrapper) GetClient(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
2025-01-21 18:24:14 +00:00
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-21 18:24:14 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetClient(ctx, id)
return err
}
// UpdateClient converts echo context to params.
func (w *ServerInterfaceWrapper) UpdateClient(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
2025-01-21 18:24:14 +00:00
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-21 18:24:14 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.UpdateClient(ctx, id)
return err
}
// GetCollectorByClientId converts echo context to params.
func (w *ServerInterfaceWrapper) GetCollectorByClientId(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetCollectorByClientId(ctx, id)
return err
}
// SetCollectorByClientId converts echo context to params.
func (w *ServerInterfaceWrapper) SetCollectorByClientId(ctx echo.Context) error {
2025-01-15 19:45:51 +00:00
var err error
// ------------- Path parameter "id" -------------
var id ClientID
2025-01-15 19:45:51 +00:00
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-15 19:45:51 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.SetCollectorByClientId(ctx, id)
2025-01-15 19:45:51 +00:00
return err
}
// ListDocumentsByClientId converts echo context to params.
func (w *ServerInterfaceWrapper) ListDocumentsByClientId(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.ListDocumentsByClientId(ctx, id)
return err
}
// UploadDocument converts echo context to params.
func (w *ServerInterfaceWrapper) UploadDocument(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.UploadDocument(ctx, id)
return err
}
2025-08-05 07:03:35 -07:00
// ListDocumentBatches converts echo context to params.
func (w *ServerInterfaceWrapper) ListDocumentBatches(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Parameter object where we will unmarshal all parameters from the context
var params ListDocumentBatchesParams
// ------------- Optional query parameter "limit" -------------
err = runtime.BindQueryParameter("form", true, false, "limit", ctx.QueryParams(), &params.Limit)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter limit: %s", err))
}
// ------------- Optional query parameter "offset" -------------
err = runtime.BindQueryParameter("form", true, false, "offset", ctx.QueryParams(), &params.Offset)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter offset: %s", err))
}
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.ListDocumentBatches(ctx, id, params)
return err
}
// UploadDocumentBatch converts echo context to params.
func (w *ServerInterfaceWrapper) UploadDocumentBatch(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.UploadDocumentBatch(ctx, id)
return err
}
// CancelDocumentBatch converts echo context to params.
func (w *ServerInterfaceWrapper) CancelDocumentBatch(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
// ------------- Path parameter "batch_id" -------------
var batchId BatchID
err = runtime.BindStyledParameterWithOptions("simple", "batch_id", ctx.Param("batch_id"), &batchId, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter batch_id: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.CancelDocumentBatch(ctx, id, batchId)
return err
}
// GetDocumentBatch converts echo context to params.
func (w *ServerInterfaceWrapper) GetDocumentBatch(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ClientID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
// ------------- Path parameter "batch_id" -------------
var batchId BatchID
err = runtime.BindStyledParameterWithOptions("simple", "batch_id", ctx.Param("batch_id"), &batchId, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter batch_id: %s", err))
}
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetDocumentBatch(ctx, id, batchId)
return err
}
// TriggerExport converts echo context to params.
func (w *ServerInterfaceWrapper) TriggerExport(ctx echo.Context) error {
2025-01-15 19:45:51 +00:00
var err error
// ------------- Path parameter "id" -------------
var id ClientID
2025-01-15 19:45:51 +00:00
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-15 19:45:51 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.TriggerExport(ctx, id)
2025-01-15 19:45:51 +00:00
return err
}
// GetStatusByClientId converts echo context to params.
func (w *ServerInterfaceWrapper) GetStatusByClientId(ctx echo.Context) error {
2025-03-05 19:37:06 +00:00
var err error
// ------------- Path parameter "id" -------------
var id ClientID
2025-03-05 19:37:06 +00:00
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-03-05 19:37:06 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetStatusByClientId(ctx, id)
2025-03-05 19:37:06 +00:00
return err
}
// GetDocument converts echo context to params.
func (w *ServerInterfaceWrapper) GetDocument(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id DocumentID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetDocument(ctx, id)
return err
}
// ExportState converts echo context to params.
func (w *ServerInterfaceWrapper) ExportState(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id ExportID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.ExportState(ctx, id)
return err
}
2025-04-07 14:10:39 -07:00
// GetHomePage converts echo context to params.
func (w *ServerInterfaceWrapper) GetHomePage(ctx echo.Context) error {
var err error
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-04-07 14:10:39 -07:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetHomePage(ctx)
return err
}
// Login converts echo context to params.
func (w *ServerInterfaceWrapper) Login(ctx echo.Context) error {
var err error
ctx.Set(CognitoAuthScopes, []string{"openid", "email", "profile"})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.Login(ctx)
return err
}
// LoginCallback converts echo context to params.
func (w *ServerInterfaceWrapper) LoginCallback(ctx echo.Context) error {
var err error
// Parameter object where we will unmarshal all parameters from the context
var params LoginCallbackParams
// ------------- Required query parameter "code" -------------
err = runtime.BindQueryParameter("form", true, true, "code", ctx.QueryParams(), &params.Code)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter code: %s", err))
}
// ------------- Required query parameter "state" -------------
err = runtime.BindQueryParameter("form", true, true, "state", ctx.QueryParams(), &params.State)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter state: %s", err))
}
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.LoginCallback(ctx, params)
return err
}
// Logout converts echo context to params.
func (w *ServerInterfaceWrapper) Logout(ctx echo.Context) error {
var err error
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-04-07 14:10:39 -07:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.Logout(ctx)
return err
}
2025-01-15 19:45:51 +00:00
// ListQueries converts echo context to params.
func (w *ServerInterfaceWrapper) ListQueries(ctx echo.Context) error {
var err error
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-15 19:45:51 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.ListQueries(ctx)
return err
}
// CreateQuery converts echo context to params.
func (w *ServerInterfaceWrapper) CreateQuery(ctx echo.Context) error {
var err error
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-15 19:45:51 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.CreateQuery(ctx)
return err
}
2025-01-21 18:24:14 +00:00
// GetQuery converts echo context to params.
func (w *ServerInterfaceWrapper) GetQuery(ctx echo.Context) error {
2025-01-15 19:45:51 +00:00
var err error
// ------------- Path parameter "id" -------------
var id QueryID
2025-01-15 19:45:51 +00:00
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-15 19:45:51 +00:00
// Invoke the callback with all the unmarshaled arguments
2025-01-21 18:24:14 +00:00
err = w.Handler.GetQuery(ctx, id)
2025-01-15 19:45:51 +00:00
return err
}
// UpdateQuery converts echo context to params.
func (w *ServerInterfaceWrapper) UpdateQuery(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id QueryID
2025-01-15 19:45:51 +00:00
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-15 19:45:51 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.UpdateQuery(ctx, id)
return err
}
// TestQuery converts echo context to params.
func (w *ServerInterfaceWrapper) TestQuery(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id QueryID
2025-01-15 19:45:51 +00:00
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
2025-04-21 15:12:38 -07:00
ctx.Set(JwtAuthScopes, []string{})
2025-01-15 19:45:51 +00:00
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.TestQuery(ctx, id)
return err
}
// This is a simple interface which specifies echo.Route addition functions which
// are present on both echo.Echo and echo.Group, since we want to allow using
// either of them for path registration
type EchoRouter interface {
CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}
// RegisterHandlers adds each server route to the EchoRouter.
func RegisterHandlers(router EchoRouter, si ServerInterface) {
RegisterHandlersWithBaseURL(router, si, "")
}
// Registers handlers, and prepends BaseURL to the paths, so that the paths
// can be served under a prefix.
func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string) {
wrapper := ServerInterfaceWrapper{
Handler: si,
}
router.GET(baseURL+"/admin/users", wrapper.ListAdminUsers)
router.POST(baseURL+"/admin/users", wrapper.CreateAdminUser)
router.DELETE(baseURL+"/admin/users/:email", wrapper.DeleteAdminUser)
router.GET(baseURL+"/admin/users/:email", wrapper.GetAdminUser)
router.HEAD(baseURL+"/admin/users/:email", wrapper.CheckAdminUserExists)
router.PATCH(baseURL+"/admin/users/:email", wrapper.UpdateAdminUser)
router.POST(baseURL+"/admin/users/:email/disable", wrapper.DisableAdminUser)
router.POST(baseURL+"/admin/users/:email/enable", wrapper.EnableAdminUser)
router.POST(baseURL+"/client", wrapper.CreateClient)
router.GET(baseURL+"/client/:id", wrapper.GetClient)
router.PATCH(baseURL+"/client/:id", wrapper.UpdateClient)
router.GET(baseURL+"/client/:id/collector", wrapper.GetCollectorByClientId)
router.PATCH(baseURL+"/client/:id/collector", wrapper.SetCollectorByClientId)
router.GET(baseURL+"/client/:id/document", wrapper.ListDocumentsByClientId)
router.POST(baseURL+"/client/:id/document", wrapper.UploadDocument)
2025-08-05 07:03:35 -07:00
router.GET(baseURL+"/client/:id/document/batch", wrapper.ListDocumentBatches)
router.POST(baseURL+"/client/:id/document/batch", wrapper.UploadDocumentBatch)
router.DELETE(baseURL+"/client/:id/document/batch/:batch_id", wrapper.CancelDocumentBatch)
router.GET(baseURL+"/client/:id/document/batch/:batch_id", wrapper.GetDocumentBatch)
router.POST(baseURL+"/client/:id/export", wrapper.TriggerExport)
router.GET(baseURL+"/client/:id/status", wrapper.GetStatusByClientId)
router.GET(baseURL+"/document/:id", wrapper.GetDocument)
router.GET(baseURL+"/export/:id", wrapper.ExportState)
2025-04-07 14:10:39 -07:00
router.GET(baseURL+"/home", wrapper.GetHomePage)
router.GET(baseURL+"/login", wrapper.Login)
router.GET(baseURL+"/login-callback", wrapper.LoginCallback)
router.GET(baseURL+"/logout", wrapper.Logout)
router.GET(baseURL+"/query", wrapper.ListQueries)
router.POST(baseURL+"/query", wrapper.CreateQuery)
router.GET(baseURL+"/query/:id", wrapper.GetQuery)
router.PATCH(baseURL+"/query/:id", wrapper.UpdateQuery)
router.POST(baseURL+"/query/:id/test", wrapper.TestQuery)
2025-01-15 19:45:51 +00:00
}
// Base64 encoded, gzipped, json marshaled Swagger object
var swaggerSpec = []string{
"H4sIAAAAAAAC/+x9C3PbNtboX8Hw7p1tt3rLr/jOzl3VTlr3pnHWdm73a+JPA5GQhJYiFAK0o2T837/B",
"AUCCJEhRiuSkrWc601jE4+DgvIFz8Mnz2WLJIhIJ7p1+8uYEBySGf15hQV7SBRXyj4BwP6ZLQVnkncIn",
"FMpviEZTFi+w/IBohNQf6J0HX//PPY0Cdv9PQRekrf79zvNaHvmAF8uQeKdev9czjfo9r+Vxf04WWM7o",
"bHMk2yzwh5ckmom5dzoctLwlFoLEEqz/fttrP7v9zjRWf/3Na3litZQDcRHTaOY9PDzIXjFeEKHX+j0W",
"/vzivLzSmzlBE/kRJcuQ4QBdnHe8lkfltyUWc6/lRXghB4dWYxp4LS8m7xMak8A7FXFC7EX9LSZT79T7",
"X90M6131lXcNDBK6s5CSSFQB5MPXalA+A4h0YgnFOfOTRQ0cgf6+F0isySUszz8sWVwJCYGve4EjnVhC",
"8e+ExKsqIC7OEZsiMSfovWy2e1DM7BKSN5zEzxeYhmVY3ly9bJPIZwEJUMJJjIhsh3AQxITzCrCgTS1k",
"irWtpjk+7Dm5LCZ8ySJONJMFP2BB7vFK/uWzSJAIhAteLkPqgwzp/sblGj413Zw4ZvHPhHM8I2rGPCqe",
"f5CiAYeIk/iO+gQR2UGioErQuWbTbbtZQ5jqjEXTkPri0VZzRThLYp8gHMYEBytEPlAuOGIx4kKKZF9D",
"tKMFvmDxhAYBiR5thRcRT6ZT6oN8W5J4QTmnLOJIMPmnJEEk5pQj7MseO1rnRaSoBKB7xLVatCm5dIek",
"eRHd4ZAGV+R9Qrh4xCXBtChW86IJC1Y7WtErJl6wJAoen9kiJtBUTr2jldww9jOOVnpv+GMuCGQxSpYs",
"QoIxtMDRyuwV38HqWt4VEfGqPZoKEpf10qtkMSGx1JGc+CwKOJqQKYsJEvGKRjOEZ5gCS6emX1+qFYcG",
"opEYDpQGootk4Z2eHB30ei1vQSP1d6aNaCTIjMQSIVJrRjgRcxbTjyR4fMTfz0mEEguEnVDUg0ERjDEK",
"FjSSxsEIJKSZ22HDG6imLNZmQoQnIekGlMv/axHL0T0Vc8QT3yecg55JOMJRgKRRzwVeLL2Wt4zZksSC",
"KkWvepanVCAZQU6kIUQiuV1vPT0p/AL/uLW9hOxrwcZoeT6bRVSwMU8mvxFfSAO8NO+ZaoN0G0QDEgk6",
"pSSGxUuLTYGMjL2S81FwfzLwh8FBmxxOj9rHJ896bTzxgzaZ9gfDg8Mj+UveHBocHuX8ko7LC2lpQ6oE",
"Lph1xpSEncG+kLbckkU5wH5j86gTMPIv/VPHZwuvtbGh1vL07pZB+WVOxJzkUARtSaB2z4CibEU97oSx",
"kOBIDpzRSNliNp/MSjXV2Asc9AaH7X6v3T+66R+cDg5Ph8Nf7QUGWJC2nCO/yEOHMWpbtm/TBbdSHOnZ",
"b9OeDGhFLiJlqbOYYOFkpUzdAUX5siGINBSRe7WHwEYwWwtJm7sFTBQzyWmc01m0AB+8yEsVNPKmZNej",
"bxJOAoQ5MuQup5UzfbsTorHdbNz+OGr/2ms/64z/93fv3rVvv/uX9Rv88O5dR/90+2nQenDS/5TGXIyV",
"A+Ja4N85mtE7EgG+ALHY91kSCY3gArX8xOZRHvC+Vgrp3024MsTrgJriBQ1XDaE6Z2QHQEk6cfDnS8qF",
"5B/4LI1kRUqIRui1tJ5FhzIbmrcelsTstbw7Su5JLOmdCrKAoYswrodqgT9cqN6Hak36r37aFscxXpXY",
"z9CYRQA23s1yGzBjA/2GpTVis6TkixaikR8mgfylqB4uzoE1+Srytb4rcWUjrQMAKhf87xZXRvR9Qhy6",
"6HF0jq+gGmNRJ5LBUknVzz3mSPeTlCV/5ysuyKJOWA9PDw63FNat5lJvP/pQ2SBBvT70rf1FlGvzCTCk",
"97qJhqyTgQUKymRhE7H3WYKuMLMl8BrItvUzg2cvxpLD6rCcEp9W19MkDFc2JTplXBWmQaaMlYB0zXoF",
"MjQ3lWn8ZeRpXoS2PC2LKs1bQFcqsLJdenF5dfZ8fPbj6NUPz8evR9fXv1xenZeZcB14BRnuEIGZNZWJ",
"zdxO1wr0cxKSRgI9dVgC2UPapMpFUa7JNGYLRLA/1zIKfWPwI4V6uovfbifTqz0JbcUCTJpzHkei6xnH",
"cuFliM8NjirQU4WGBlxplgpDbiDyFE1sOsEGvO6m1JQanWTYxBer3NvHdcRSst+bK2ZmqNPvx6f9w305",
"YzmSXiM0BKahUyhKsIW2YOxTSptc8zLBsgmVQZ0Lc2xnBb5paP0psHAi5vIXFYdyWVlflWFoHB/LQHST",
"zOFN79lp//B02Nu1Sfg85wPngyYA3CNbiGdJHJNIpNagFrs2YLszEMtOckxETMldjVTei73ocIwbQLKt",
"+VjhDCsD7g9is2kyydluhp0cNtzZ5asXF1c/P9/Cbmt5yTJowNpsiuQOI9W6TvT3Tvu93Yj+ZkakYbZa",
"TfCScsfyXuMZjcBdCHWoRGJaB7UFEzhECudS1C9VYyl5F0TgAAtckvlzzMcLFpNqFS2/yqEkLcYE4TtM",
"QxPbXmsa4RmpJhb5FUVwipI7JWnVnIz0e73cyUi/fDKiph1z+pHUHdooxC1JDHDYAEgJWQvBuvlhIxy0",
"CfsTFSBYYOHPpY6e0lAUMHFwXAfJoH9wfHAyPJKt6o6KWh7MVB1uU4BApNfaGs+SI3XnRSXjJSdFAF21",
"0TMFnMGaJhp7E2v55I1i7/VBbJADEs9KNgkR00kiCEffgErSQWwQGfl4Ni/7VrVKTEmnYqjXqMuC7oqw",
"mON9h3k1RMU4rxOkc0ba1wsKd2n2FOVNbdmwItz7TUyWIfYJVzdCUgP2W7feIwEVLP4SQeASWTa/eEeD",
"3NGw1+s/OzzpBdM2mR4dto+Pjo/aJwF51n52cDA8xM+Gw+ExtnVUkoBysS27I8dqAKDrCq0tgcoMOpwD",
"0DrMXMZMOjRyxBbcrwRvRgKDaQj/8HHkkzCv0wowvIFRLf8Gh+Hl1Dt92+AWoep7nSwWOJZmyKciOwIc",
"4ykNiSTuGkmXNkFijgVSHVFugRaBBcwfdpbBVLpwzO8fw78rqOug9+xoM/LSqmwdUd22SiEQocC2vUA8",
"YYkobKHl/+mFZhjKb4vb2DBIs8dUagLrO5slwQhN1T8b6Q7n9tZrD60oxsobWqtkNURa4FGeQZ7p+8Nd",
"aNmCVjOYyIN7WyUzFA4aRAtjIpJY+gPguhY3nEujmyxB2rM4T9iOndIufqNrvLbxv7aDljhpp3ESu292",
"Sqnvz4n/u16Iw1foqh3rjkajrrmi24XW3Y2FZkzbMZmSmER+0bjvD9ZZ99aV6BRMa3lr9tbQdwkL+sNa",
"dt7FFipUNuiTXZy2RL7T4/rFhFBylJj2ydNgExcrSkLlYOTdimahHTc0+YDOVvEarWMMAfI61yJt1EDL",
"DHZj4VN1VXEsvzQDMmJR+/X5C9AJXN0IRDRCOPbn9I40dsiag8hiKv3RMNXTZegudZNUUaWBJthHEqBf",
"L167QPTSJXc+0mV+O5tqZr0/m29y2hFxhqY4Z08f7Gh/lzGbxYTz8ZLEPnEpvtcpeSHTGOnGBf+2Hqb+",
"upuHWyoCpQZrUFvU3BmCqcXSOcLs9faluZWYz8Sli3wtNVBcnJuaHFKkknMdW56TfC5to4T2GY6uV5Ff",
"RvCF4iWdbiNthTBk93CJxBf0jsAVEe65Ajl65IoLY9KPyFSTdWVMXWnPa63NdI+RE+vbv5Iti3sJOwdj",
"VONrTVoSMTkXNH8YMBqNyv7Xeilj5vyeBavaeZWDuD3uypioRsErpzS2gCldlRiNYiLIViczasoqn/R6",
"SXw6peCh5b1TBUrHckwvXo2v/+vVmdfyXl3ewD8hoGz+uHj1g9MftQFwb8PIrFvPb5tmCnflvWkmFHOL",
"L50cqp+r96kq2FVgQLA6FniFJkSHvx205OMI7jE0g9gIle1YsrwcFpD/T2LuvFcNuXiES6wgnwUE3amW",
"HS8v7Y8ObGn/bDAYDo8HveHRyeHB8fFRgzjxGQtD4gsWu2JU+hNasICEHeel8DsyvssWUYcPs9ZtTfAp",
"JWGwnrgM0C9UcwgLCsLFFmBqzI19qQJI3HQEe2OtUQT5ILYaonjAYilkjZNqUCumLyGlVdxMJwPmcOsm",
"WoCoqAlB5ZrOZTpqxE25uRVXtTzIymxAR3aapY1LLdPTYdavulpNsEQsE6ERIAfubKcaCgRcjeXUKMyh",
"tlHMqbCTuXgTwFmMN6UdronzSG4FPmbujAGjs+ot31p0bC0Fvh5mLlHYOfOVoFur1QpGwI602RcyR1sZ",
"xLdurIAfsCZRPcOBAyOfp2cq+Q4uEc0JusNhkp0jGZBsIzEN06/6KZerbhmwq4HyR82fQxP1MT8ceqdv",
"+61Ba3jrop455vN16/tRtmm004Uc/dLO2doHZk4RVreHa8sNVB4FTYbTk/bx8OCk/QxP+u0+OTycDKf9",
"ExIcb3EUZOCpDETmgOI6KllHYo+LfZjNhehcwqLjxmj6lxQhkJacp9KF6eqtWIIWCRf65IQgjMzHh+Li",
"F1UTakiQ+nUiiR4UFU44yW90Ot1Met8LgmaM5Y51tlCiBcwZKJ14g1IQlVcObcWmC1KImM5mJE7zCnck",
"dZT1MA6ZuifopkzzVSr++zn154BVDdhHuoSYIbqnYSjdnjTDOcM2H552u7g76qo+3UFvcNgb9IddyT8d",
"n98VsN07OMmhG/p3vpP/6RGgIsunk4du57t37+QITqOmmWOoNqPCMbQFT42T2KioSIW0Ie2D4LDfPu4P",
"/fazE0LaB0cH5GR40u9P+8MtpE1uPW7VzjinkzAFDGo+cNu/t8+aaTQ2AbHs5Pm2cuIbRan1VK3JGQy2",
"SIPRcVz2ICEcLgvnJZoX8EFFK3y2JGiCOQkQi7Q1rE1j0Hu8sZEKtpsauoGFSqMZ4RKebcBMO6OsiFAZ",
"CyQKxtXBB7g2Iz9LEZsO2Glw2DIcuFkmFpXTUY7UlZ1dTVi2LFy2hr0lFehVpr/PwmQROa5XRwEVDWxm",
"a6KztI8xzsbbO4yKBN0bqL6hhJNpEiLBgFAUMeVodnOfbpOrYNYKWxa+UtBv67flzMZwjcBRjDlNtyyd",
"KSd9QsL5WN/OmkHkOzZ/+iHjJBjTSJD4Di6tsSWJ7L9DMhXjcrOYzuau37W9AYJZ/csl2n7U9laN2abN",
"0jo9VrFPF0GlCTVCnEazkCDQlBVR6cLRvkoMKJQmkH+IVWdjddIslv2ScnFec75k4SkLH6T+ZCOxXLSh",
"14tmCdS/ExJTF+eNECdwxea9alHG7fuqruZyjtWz0QogGlS452ZdfXDzpYHChXU1oGNpIZtRHyURBTjJ",
"B+In7hOh7UOpLJrSWaMVn6mmjRyRNGD2GeFTg72xtYF1Xa90ez23OjEFVDeA9UY2dPpMMEQpvllaV+W+",
"nqUYLobH5e9JrFOQdBAgrRNXJ37evfvU+ce7d+4SCmrSumPG1ERBZrFwhQi6IJyBUNK9m1PKl99D6F25",
"OVWGPuDgsS6YKuAJF1ZxrrWnw3qfkCRCU7GpvGlGWI83ix2YkPamTFvAvT17ccjKLVGIqLrEJzERp2m/",
"kCBnIaKMABUrc90FTEKRK86YDrCx4i+sWk1ZvT5NznVntrJnqXKkMap+ur58NX7+n5ur0dnN5ZXX8s4u",
"X908/8/N+MWbly+dRg/Mu/3Bp01vX1r1fL5AcfklpVbVZVWMxFQ0c3G+odmguGuNwdPoWLfiRHfr+zuc",
"+ElMxepagpvLZh0lwmEzj/KJqQlcmxot8EeWJjOii/PXHXQhpaeyGK9enJ0cDw7RT7/coIkUXMtYko+v",
"ZZoBAdYUsntFX7o2GkxzxgJS+vFNHHqn3lyIJT/tdgPmf1x1ZINOwtsEc9HudzDApdfT8dmiy2SLQTet",
"vAaVhtkyV2LJG6kSZzob7+8cmUQ06atIker9QAS6vDg/Q4L9TrTDOqXqfkexs/kEN7l+J58Ft5rOJmb4",
"XY79270wOzYhOCbxC0MeP/1y4xWvwsutgMEQmwhMIxLo8jhpPnRun7fdTmACuBEFIGVCVC5flcij0ZSZ",
"CnxY1VA1+7CkMZ7hOxzjZfIvjGMiTJ6urlU7gt/QReTLyZIcYq32pUJ8o9cXqUOTN8SAW9Fl7M8JF9pI",
"0yVjgeVD6hOtocowUFPIM4HCcXXwCCqAWlzzjV5fSMfdSAOv1+l1+hDtXZIIL6l36g07vc4QUr3EHEi3",
"Cyk93TRdbUYq0hK4yVmTSnT0y3W64ZAImSU+tjIvXyV0cRbDAS1PlibaJ/UBNL4I9Ohpchlcw7Mqa791",
"5GOaFEZ14T6d2ZQlBlGb7bVObssqMQZkipNQfH7a40Or+q5qDBZDLtuxCjiVcueE8PDz8iLLAF4THPtz",
"JEi8UOEByTFdlZ9mtq0CVA5dc3BuflJSESOdrAq1Z5wApBkAZUR5OAwtm8fk+7ZM4Uf5T9nkthFMJAQX",
"R1IumqyqwGGxGMNXFzxG8qcQ6b+t+6R2BmETuK4lOAGNiV9D7QAViwOQmU5Ecd8CS/0l53GBcFuovz3o",
"9XZW8zSfdu0oeppLld1R5dwDtQBXj3Sh3ULpY+jWX98tVxkWOg3Xd8oKZMseg2frexSL/z60vMNmq7JL",
"VNsWHAjZ1Ap4eyu3nZsTa7UNacIwnkmZrHKBr5V6824fWt6SufxQFVbgdhFLGqEJE/OcBsmXUFElS3SC",
"PYOhcFgqc9lBFwFZLJkkRNTWOVocDXo9dPn/EJ3qnON8mXMYUgVIfRxaGcllpaRAT4lU17UnXJjrq7tl",
"Ah2AcbDBjSn6EahTY3cQJslgzGrvPzwG+xaqKDpW8KZqJ9I8fDs1nKbb+u2OmH6guPeLLNuUmrOLwv01",
"ZFmvgSxL3z94ZOEnew3W97Kem2guL88MSxqRVy02H1o587v7CYyEByVHQ+KKvkgxiSWc4UoXE+Oa+5Vh",
"Xi9bOwiOclNJhyhHNI4JuAyTkHSQjmxweAiCxot/SjmigxepWV6Wlqryni0ta234nxMu0ITAUYxgCOaQ",
"0kzNaRcPc5k4ulntUyOlgm6PYsoUChBWCQVTBW4PQmHQO/5iy1riWFAcppQZoG8WSShoWxnu3/5F5N7B",
"+h7pUxRfq9GndlzJlWUmcuosQGfg4EqX8OJ5E6aBqJIuYenVobzQ+YGIvH22f/bW1XYq+Rq+P9H5H4bO",
"fyDKt0mprY7C5T45fJw58X/n0uPQelhbuFmNPknYXRZbtC2tX5YI7bVAtZAkDG36KTgjco6UDJ/DBBUU",
"7yp3De138jrLf9pyxLaCoH3WqNBrCR9eraIuTqKwdnHZeBa7ZF/NPH8YFnMJGkY4vCoEq5aLJhRQkZb7",
"3IX8+RoZFjghde+J4YTquETeDHUBlTXpZk/iyVmXkPxeUduLl4qaZQTeQZdRuEJZyTJQbWmwD/k4svNE",
"ka5Aaoqfye9ycycE+XMczUiA7ihWpXRIFCwZjRxRdAXWowUs9PFwXcDCwo1gWVHILxCjWKe4zcH1X9BL",
"/zNocUWLRaLb2O8271ZBGtXnyA1nLPRcDZ666zSyjd8WWko3PFKpjIUjVCXzscCWjMAxkV3g5b/ADoY6",
"nHM18+PayoXHwypNZn0888R6f1BHUT/1tlWgq6tfatsLv12RthpecpxkLsoSHq4yinNwYQddES5YLPvk",
"r6v4eIknNKRiVc9rz6OvltXSeuJPnPZH5DRFWQ0YzU9zu5scyumqK6qatbrad0cDEtQ4o9D/zNR03IeV",
"mat9VGFi1h6H+TZ0dcZmf8cw6ypDDpjV9z/NgdBX6RzaRy8pCRhW0XWAHLzS/USDh8rLT1kMEyOurt36",
"hm0mK0QF16/Gl6KTFo/sSQdkpRyqKe4PHJX8WkOG2Nr/i/MaGts0AJGlaK+PP0D+rK7VbUtxSfyVwlt1",
"fgThXR8fMMJ747iAk8L/LO77V+xb443lade3S31tIFnTMmBauGrarpKxpvn3K808wT4Fbla/zCVwU9Cf",
"ZO4+ZK5NGSlV2BSZVY3apwC+JsJMn4G0XvReVxPrHoSwXUBrvRDWdzGcxdPWyeWDulJ+ctQnsbx7jrjO",
"c0Q9ExQlc2CVulojmCU1mDdDskzuycoua+uSzLnE8McRzflc9Bp7OF2GXNgTQe7wmrDI5fsXnq0wBJru",
"0a6ktDPKoV4AkIaFqqMApYp0kQ0ImseFC8bWe11FkxmeUcmqrVXLa7jutMSx6E5ZvGjDcFDIxWcBjWaq",
"tI0KeOpeNzqVz6J69foJ+bAMIXltikNOWh4XK8j7kQOrbUmZolg7JyRV1eQUCtK3DdLMkgmNMNywy73d",
"czw8PuifDA56zuL81RXlDUb9hAu2QFbx7nLxeP3WS03t+M53azNoYcnlBNqyBNBvEwAiJnL7tvI6DCmk",
"JfKfZMiufA3Ns7ChtRKjSqWpV0oaeRxh5Vs7ICN0gnWQCbBqDfd9+vJM/bVXlbhlFdyHRGDJk+omUMWF",
"1xBoxJnOM9h1gtirMmz8d3jfwQUZm045qQBtNw8F7PPebvE5ppokpByRPLH77kyG2peuvpDJYL14giC7",
"mMIdPaXdQ4Jen78omjl8Ffl6LblHZ+pMie/14xqfZU+Yl1lqTQr1QMvWJoU1R7VVMbGejME8j8XmtsY6",
"VW8GbKLtK7Yxt3sNLIDBPuRN3Wnt9/Y7StWPiz2JoJ1ZHBWcjXmBiLc2SLqfzBM3tdk9Z/CoIy++MQc1",
"Vig3T8WGqzoZo8Yoy5h1MZsc1aWvS+aCN3/EywJ/hqN/taXlt+lq1eMa+zcwT1o63ltRWjiNyBdmLYXg",
"19DaXuy1mhudOULWMc4nyv1ygfucKMue79qHadda2zZ9mPG2KLBVLeLN76I1MCwvIioonNla9bO1CC+H",
"TnUdZVVUeU/HA/mKzRXnAxpQbR+prPtHvVKT1Ud1QPg8Vx/96fR3L/yrKSSr1W1xri43XmkBZUXYG5wx",
"gP+kVVGjc1/9ltjjHPoWXy+rPlzQS3g6/925GjHPw2WEsp97N5KMU+O94cUwYZ2mwps5aXFoTcuqMmil",
"5bTnK2JqDgfRppHsJ3rdOb0GBdxmpLBb68euwwrEq1/KqCVdnbQKh7jKqVRvQQD12u8yFG63py9MkH2S",
"bP6VlGrdP8ccTQiJsqevnwh4l2mW9ishnRrNvynJpo+mKIKdM3WMWCVkobCTJNUfb35+iRYkSqCinnJT",
"szQNndLhLhTwI1uQ16oM3xqyFeSD6M7FIszTax4qgER3So+M5DoUZBJGO+YJwxUingcnh8eFknn/cJXM",
"KxH/j+k0Eoongt+ZxHbuYZpokYh53tYN2YxGlXSb9/mgLZqG7F6qgZjoKn7RDAlmV7/VDSUAjjs1MGGB",
"gIcqPl1kGjWBPXo2cp5kXlY+AfXm6qW5MeEcJGOOrIJ5TNdUxDZVTTv/cB7rPxFwLQE/tApVlt+a0sKt",
"tMKkKRtcPG2DrdP7aenm9TTe9nEYTrD/eyWx/4ijINSkfilHGSDTBwVJbN5j09SjAx/oiviEGvM5V6FZ",
"vUEMVWJs5sBRgMgHlRPPEdWSl/1OIl7BLWcG8jUn86P62SsLUQWktgpVHSO8HbV/xe2Pvfazd+/a49tm",
"5VLB9MoKcQECzq6vXkikivq6oMJ1y74C2H5vcLAxsLebSiaLCHUN6SyEo2hlQ0ll5Gr1aNuLrP9bJbP+",
"StInJ1CKjG5KU6wTKCypvnj6ks2UOIDkXJYoB1ohTj3zq+7vcQ5EEwVVulTNU1Mu46UC5DO0qRwfLAVp",
"hlqknJoQn0e9oQHwiWb3dP1EbSHI+U104nvz+lLjG2b67Qn7mUKoeu3HVJCYYvf1afOE1Z6vTJtpHJ7G",
"qLiCJ/d6hzef3qf7a2gNavpvWlVZ1ebcOH/739o82Mfpkv2k1DbZ2+8t2L6Ckyb11MJT4vYjJW6b3a/g",
"ilQEb5G1rXilPmk7Y4w9CV39HGAVnT2F4veQOphufC5fsCxvNwpjpg80bZarbQnsBqnae5fTawq5qfRf",
"/VatiXSaN6XSJ762yKJQ1P6Uuv0IqdsbSdSu0E8KfgYzOM2W5/AcKQhk9QhhEqnD0ioLJv82duGSDOFi",
"76xhv7FYwR+FRxU3uSfT2wew1beKbxSMPAmfch53dTtGonQ9e8F48V3Fc1YxCxI/fS4MijsljofefLbo",
"3vWBvfQ85bw7zSDSqg5BqkqjGm428CwQmL8qUQ4xVgxjsortkYqZxk0Hs2/f67FKB+FNx8q8KD1SDvtN",
"R1EnndYo+SPOpsPki8ZZz81ZQYSmY0EEbIEjPAORAsEuqKFHzXtv1vh2FbCH24f/CQAA///wF/j8lMkA",
"AA==",
2025-01-15 19:45:51 +00:00
}
// GetSwagger returns the content of the embedded swagger specification file
// or error if failed to decode
func decodeSpec() ([]byte, error) {
zipped, err := base64.StdEncoding.DecodeString(strings.Join(swaggerSpec, ""))
if err != nil {
return nil, fmt.Errorf("error base64 decoding spec: %w", err)
}
zr, err := gzip.NewReader(bytes.NewReader(zipped))
if err != nil {
return nil, fmt.Errorf("error decompressing spec: %w", err)
}
var buf bytes.Buffer
_, err = buf.ReadFrom(zr)
if err != nil {
return nil, fmt.Errorf("error decompressing spec: %w", err)
}
return buf.Bytes(), nil
}
var rawSpec = decodeSpecCached()
// a naive cached of a decoded swagger spec
func decodeSpecCached() func() ([]byte, error) {
data, err := decodeSpec()
return func() ([]byte, error) {
return data, err
}
}
// Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error) {
res := make(map[string]func() ([]byte, error))
if len(pathToFile) > 0 {
res[pathToFile] = rawSpec
}
return res
}
// GetSwagger returns the Swagger specification corresponding to the generated code
// in this file. The external references of Swagger specification are resolved.
// The logic of resolving external references is tightly connected to "import-mapping" feature.
// Externally referenced files must be embedded in the corresponding golang packages.
// Urls can be supported but this task was out of the scope.
func GetSwagger() (swagger *openapi3.T, err error) {
resolvePath := PathToRawSpec("")
loader := openapi3.NewLoader()
loader.IsExternalRefsAllowed = true
loader.ReadFromURIFunc = func(loader *openapi3.Loader, url *url.URL) ([]byte, error) {
pathToFile := url.String()
pathToFile = path.Clean(pathToFile)
getSpec, ok := resolvePath[pathToFile]
if !ok {
err1 := fmt.Errorf("path not found: %s", pathToFile)
return nil, err1
}
return getSpec()
}
var specData []byte
specData, err = rawSpec()
if err != nil {
return
}
swagger, err = loader.LoadFromData(specData)
if err != nil {
return
}
return
}