Module logoraisr
ballerinax/logoraisr Ballerina library
1.5.2
Overview
The Logoraisr API v1 connector(https://docs.logoraisr.com/) OpenAPI Specification. Logoraisr API provides capability to access operations related to your graphic design tasks automatically using best-in-class algorithms and artificial intelligence.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
Clients
logoraisr: Client
Isolated
This is a generated connector from Logoraisr API v1 OpenAPI Specification. Logoraisr API provides capability to access operations related to your graphic design tasks automatically using best-in-class algorithms and artificial intelligence.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create an Logoraisr account and obtain OAuth tokens following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.logoraisr.com/rest-v1" - URL of the target service
readPreviews
Isolated FunctionRemote Function
function readPreviews(string fileId) returns PreviewResponse|errorGets preview image of uploaded file
Parameters
- fileId string - Id of the file for which the preview_img_url is generated.
Return Type
- PreviewResponse|error - Returns preview response or an error
listProcesses
Isolated FunctionRemote Function
Gets process list.
listProjects
Isolated FunctionRemote Function
Gets user project list.
createProject
Isolated FunctionRemote Function
function createProject(ProjectRequest payload) returns ProjectResponse|errorCreates a new project.
Parameters
- payload ProjectRequest - Project details
Return Type
- ProjectResponse|error - Returns project response or an error
readProjects
Isolated FunctionRemote Function
Gets project details.
Parameters
- projectNumber string - Number of the project.
getReports
Isolated FunctionRemote Function
Gets user report list.
createReport
Isolated FunctionRemote Function
function createReport(ReportRequest payload) returns ReportResponse|errorCreates a new report.
Parameters
- payload ReportRequest - Report request details
Return Type
- ReportResponse|error - Returns report response or an error
readReports
Isolated FunctionRemote Function
Gets report details.
Parameters
- reportNumber string - Report number
readResults
Isolated FunctionRemote Function
function readResults(string resultFileId) returns ResultResponse|errorGets the result from image processing
Parameters
- resultFileId string - Id of the result_file for which the result_file_url is generated.
Return Type
- ResultResponse|error - Returns result from image processing or an error
Records
logoraisr: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
logoraisr: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
logoraisr: Color
Fields
- red? int - RGB-Red color value.
- green? int - RGB-Green color value.
- blue? int - RGB-Blue color value
- percentage? string - Percentage of pixels that holds this color.
- number_of_pixel? int - Number of pixels that holds this color.
- hex? string - Hex-label of this color.
logoraisr: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
logoraisr: FileResponse
Fields
- file_id? string - Returns the file_id. To apply processes to the uploaded file, this file_id must be referenced in the API-calls.
logoraisr: PreviewResponse
Fields
- preview_img_url? string - Url from which the preview file can be downloaded.
logoraisr: Process
Fields
- processing_algorithm string - Schlüssel welcher Verarbeitungs-Algorithmus angewendet wird. Zur Auswahl stehen "logo-to-vector", "logo-super-resolution", "logo-segmentation" und "image-processing".
- resize? string - Changes the size of the image according to the specified size. Example: "resize": "200x300".
- flip? boolean - Flips the image around the horizontal axis, from top to bottom. Example: "flip": true
- mirror? boolean - Mirrors the image around the vertical axis, i.e. from right to left. Example: "mirror": true
- rotate? int - Rotates the image around the center according to the specified degree. Example: "rotate": 90
- crop? string - Crops the image according to the specified mechanism. If you specify the size "WidthexHeight", the image will be cropped centered. If coordinates "x1,y1,x2,y2" are given, the image is cropped according to the coordinates. The image will be cropped to the size of the stories if "faces" are specified as. Example Centered: "crop": "200x300". Example Region: "crop": "200,300,150,300". Example Faces: "crop": "faces".
logoraisr: Project
Fields
- id? int - Id of the created project.
- project_number? int - Number of the created project.
- file_id? string - Id of the file on which the process was applied.
- result_file_id? string - Id of the result file which the process created.
- process_id string - Process which should applied. Processes are "color-classification".
- process? Process -
- created? string - The Date when the project was created.
- project_title? string - Name of the project with which it was saved.
- paypal_payment_id? string - Id of the paypal payment.
logoraisr: ProjectRequest
Fields
- process? Process -
- file_id string - Id of the file on which the process is to be applied.
- project_title string - Name of the project with which it is saved.
logoraisr: ProjectResponse
Fields
- project_number? int - Number of the created project.
- project_id? int - Id of the created project.
- result_file_id? string - Id of the result_file. This id must be specified to create the result_file_url.
logoraisr: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
logoraisr: Report
Fields
- report_number int - Number of the created report.
- created? string - The Date when the report was created.
- file_id string - Id of the file on which the report was applied.
- process_id int - Process_id of the process which was applied. Processes are "color-classification".
- result_id int - Result_id of the result which was created.
- result? Result -
logoraisr: ReportRequest
Fields
- process string - Process which should applied. Processes are "color-classification".
- file_id string - Id of the file on which the process is to be applied.
logoraisr: ReportResponse
Fields
- report_number? int - Number of the report which was created.
- created? string - The Date when the project was created.
- file_id? string - Id of the file on which the process was applied.
- processing_algorithm? string - Process which was applied. Processes are "color-classification".
- result? Result -
logoraisr: Result
Fields
- number_of_pixel_in_image? int - Number of pixel in image.
- width? int - Width of image.
- height? int - Height of image.
- colors? Color[] -
logoraisr: ResultResponse
Fields
- result_file_url? string - Url from which the result file can be downloaded.