Ballerina library

opendesign

Module opendesign

OverviewPrerequisitesQuickstart

API

Client

Definitions

Artboard
ArtboardContentNotFoundError
ArtboardNotFoundError
ClientHttp1Settings
ConnectionConfig
Design
DesignArtboardProcessing
DesignExport
DesignExportNotFoundError
DesignIdExportsBody
DesignNotFoundError
DesignNotPagedError
DesignNotProcessedError
DesignProcessing
DesignsFigmalinkBody
DesignsfigmalinkExports
DesignsLinkBody
DesignSummary
DesignsUploadBody
FigmaDesign
InactiveAccountError
InlineResponse200
InlineResponse2001
InlineResponse2004
InlineResponse2005
InlineResponse201
InlineResponse2011
InlineResponse400
InlineResponse4001
InlineResponse4002
InlineResponse4003
InlineResponse4004
InlineResponse401
InlineResponse404
InlineResponse4041
InlineResponse4042
InlineResponse406
InlineResponse429
InlineResponse500
InvalidAuthTokenError
InvalidFormatError
InvalidHeaderError
InvalidInputError
InvalidUploadFileFieldError
InvalidUploadLinkError
MissingUploadFileError
MultipleDesignExportsError
NoAuthTokenError
Page
ProxyConfig
RateLimitReachedError
ServerError

AuthTokenError
InlineResponse2002
InlineResponse2003

ArtboardId
ArtboardStatusEnum
DesignExportStatusEnum
DesignExportTargetFormatEnum
DesignFormatEnum
DesignId
DesignImportFormatEnum
DesignStatusEnum
ErrorDocsUrl
FigmaFrameId
MultipartFilePart
PageId
PageStatusEnum

ballerinax/opendesign Ballerina library

1.5.0

Overview

This is a generated connector for Open Design REST API v0.3.4 OpenAPI specification.

Open Design read and display data from designs using code. Unlock the power of programmatic design.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Brex Onboarding connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/opendesign module into the Ballerina project.

Copy
import ballerinax/opendesign;

Step 2: Create a new connector instance

Create a opendesign:ClientConfig with the <JWT_TOKEN> obtained, and initialize the connector with it.

Copy
opendesign:ClientConfig clientConfig = {
    authConfig : {
        token: <JWT_TOKEN>
    }
};

opendesign:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

    Following is an example on test if your token is valid using the connector.

    Copy
    public function main() {
    opendesign:InlineResponse200|error response = baseClient->checkToken();
    if (response is opendesign:InlineResponse200) {
        log:printInfo(response.toString());
    } else {
        log:printError(response.message());
    }
}

  2. Use bal run command to compile and run the Ballerina program.

Clients

opendesign: Client

Isolated

This is a generated connector for Open Design REST API v0.3.4 OpenAPI specification. Open Design read and display data from designs using code. Unlock the power of programmatic design.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Open Design account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://api.opendesign.dev" - URL of the target service

checkToken

Isolated FunctionRemote Function
function checkToken() returns InlineResponse200|error

Auth Token Check

Return Type

postDesignUpload

Isolated FunctionRemote Function
function postDesignUpload(DesignsUploadBody payload) returns InlineResponse201|error

Design File Upload

Parameters
Return Type
Isolated FunctionRemote Function
function postDesignLink(DesignsLinkBody payload) returns InlineResponse201|error

URL-Based Design File Import

Parameters
Return Type
Isolated FunctionRemote Function
function postDesignFigmaLink(DesignsFigmalinkBody payload) returns InlineResponse2011|error

Figma Design File Import

Parameters
Return Type
  • InlineResponse2011|error - Returns the created design entity or its processing status (in case a export was requested).

getDesignList

Isolated FunctionRemote Function
function getDesignList() returns InlineResponse2001|error

Design List

Return Type

getDesign

Isolated FunctionRemote Function
function getDesign(string designId) returns DesignProcessing|InlineResponse2002|error

Design Info

Parameters
  • designId string - A unique identifier (UUID) of an imported design file.
Return Type

postDesignExport

Isolated FunctionRemote Function
function postDesignExport(string designId, DesignIdExportsBody payload) returns DesignExport|error

Start Design Export

Parameters
  • designId string - A unique identifier (UUID) of an imported design file.
Return Type

getDesignExport

Isolated FunctionRemote Function
function getDesignExport(string designId, string exportId) returns DesignExport|error

Design Export Info

Parameters
  • designId string - A unique identifier (UUID) of an imported design file.
  • exportId string - An identifier of a export task of an imported design file.
Return Type

getDesignSummary

Isolated FunctionRemote Function
function getDesignSummary(string designId) returns DesignProcessing|InlineResponse2003|error

Design Summary

Parameters
  • designId string - A unique identifier (UUID) of an imported design file.
Return Type

getDesignPageList

Isolated FunctionRemote Function
function getDesignPageList(string designId) returns InlineResponse2004|error

Page List

Parameters
  • designId string - A unique identifier (UUID) of an imported design file.
Return Type

getDesignArtboardList

Isolated FunctionRemote Function
function getDesignArtboardList(string designId) returns InlineResponse2005|error

Artboard List

Parameters
  • designId string - A unique identifier (UUID) of an imported design file.
Return Type

Records

opendesign: Artboard

Fields
  • id ArtboardId - An identifier of an artboard within a design file.
  • page_id string? - The design file page containing the artboard in case of paged (has_pages=true) designs.
  • name string - The name of the design file artboard.
  • has_content boolean - Flag denoting there is content in the design file artboard and the client can obtain it via a GET …/content request.

opendesign: ArtboardContentNotFoundError

The specified artboard does not have any content.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: ArtboardNotFoundError

The specified artboard is not present in the design file.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: 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

opendesign: 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
  • 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-forwarded header
  • 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
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

opendesign: Design

A design file descriptor

Fields
  • id string - A unique identifier (UUID) of an imported design file.
  • name string - The name of the design.
  • created_at int - UTC timestamp (in milliseconds) when the design file was imported.
  • completed_at int - UTC timestamp (in milliseconds) when the processing of the design file successfully finished.
  • has_pages boolean - Flag denoting there are pages in the design file and the client can obtain the page list via a GET …/pages request.

opendesign: DesignArtboardProcessing

A descriptor of a design artboard which is being processed.

Fields
  • id ArtboardId - An identifier of an artboard within a design file.
  • design_id DesignId - A unique identifier (UUID) of an imported design file.

opendesign: DesignExport

Fields
  • id string - An identifier of a export task of an imported design file.
  • created_at int - UTC timestamp (in milliseconds) when the design export started.
  • completed_at int - UTC timestamp (in milliseconds) when the design export successfully finished.
  • result_url string - The URL of the produced design file in the result_format format when the export is successfully finished.

opendesign: DesignExportNotFoundError

The specified design file export task is not found.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: DesignIdExportsBody

Fields

opendesign: DesignNotFoundError

The specified design file is not found.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: DesignNotPagedError

The specified design file is not paged (has_pages=false).

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: DesignNotProcessedError

The provided file format is not valid or supported.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: DesignProcessing

A descriptor of a design file which is being processed.

Fields
  • id string - A unique identifier (UUID) of an imported design file.

opendesign: DesignsFigmalinkBody

Fields
  • design_name string? - Name of the design.
  • figma_token string - An access token from Figma.
  • figma_filekey string - ID of the file in Figma.
  • figma_ids FigmaFrameId[]? - Frame IDs to sync. When not specified, all frames are included.
  • exports DesignsfigmalinkExports[]? - Design file exports to intiate automatically with the import. (Only Sketch is supported currently as the target format.)

opendesign: DesignsfigmalinkExports

Fields

opendesign: DesignsLinkBody

Fields
  • url string - A publicly accessible URL of the design file to import.
  • format DesignImportFormatEnum? - The design file format. (This is not needed when the format can be inferred from the file extension.)
  • design_name string? - Name of the design. (When no name is provided, the server infers the name from the URL.)

opendesign: DesignSummary

Fields
  • pages Page[]? - The list of pages within the paged (has_pages=true) design file.
  • artboards Artboard[] - The list of artboards within the design file.
  • id string - A unique identifier (UUID) of an imported design file.
  • name string - The name of the design.
  • created_at int - UTC timestamp (in milliseconds) when the design file was imported.
  • completed_at int - UTC timestamp (in milliseconds) when the processing of the design file successfully finished.
  • has_pages boolean - Flag denoting there are pages in the design file and the client can obtain the page list via a GET …/pages request.

opendesign: DesignsUploadBody

Fields
  • format DesignImportFormatEnum? - The design file format. (This is not needed when the format can be inferred from the file extension.)

opendesign: FigmaDesign

A descriptor of a figma design file

Fields
  • id string - A unique identifier (UUID) of an imported design file.
  • name string - The name of the design.
  • created_at int - UTC timestamp (in milliseconds) when the design file was imported.
  • completed_at int - UTC timestamp (in milliseconds) when the processing of the design file successfully finished.
  • has_pages boolean - Flag denoting there are pages in the design file and the client can obtain the page list via a GET …/pages request.

opendesign: InactiveAccountError

The auth token provided via the Authorization HTTP header is associated with an account which is either expired or blocked.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: InlineResponse200

Fields
  • expires_at int - UTC timestamp (in milliseconds) when the provided token expires.

opendesign: InlineResponse2001

Fields
  • designs Design[] - List of design entities

opendesign: InlineResponse2004

Fields
  • pages Page[] - The list of pages within the paged (has_pages=true) design file.

opendesign: InlineResponse2005

Fields
  • artboards Artboard[] - The list of artboards within the design file.

opendesign: InlineResponse201

A design file descriptor

Fields
  • design Design - A design file descriptor

opendesign: InlineResponse2011

Fields
  • exports DesignExport[] - Inititated design file exports for the import.

opendesign: InlineResponse400

Fields

opendesign: InlineResponse4001

Fields

opendesign: InlineResponse4002

Fields

opendesign: InlineResponse4003

Fields

opendesign: InlineResponse4004

Fields

opendesign: InlineResponse401

Fields

opendesign: InlineResponse404

Fields

opendesign: InlineResponse4041

Fields

opendesign: InlineResponse4042

Fields

opendesign: InlineResponse406

Fields

opendesign: InlineResponse429

Fields

opendesign: InlineResponse500

Fields

opendesign: InvalidAuthTokenError

The auth token provided via the Authorization HTTP header is not valid.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: InvalidFormatError

The provided file format is not valid or supported.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: InvalidHeaderError

A required HTTP header is either not provided of invalid.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: InvalidInputError

Some of the input parameters are invalid or missing.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: InvalidUploadFileFieldError

The multipart request contain the file data under the wrong field name.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: InvalidUploadLinkError

The provided file URL is not valid.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: MissingUploadFileError

The multipart request does not contain file data.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: MultipleDesignExportsError

The provided file format is not valid or supported.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: NoAuthTokenError

The endpoint requires an auth token provided via the Authorization HTTP header.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: Page

Fields
  • id PageId - An identifier of an page within a design file.
  • status PageStatusEnum - The processing status of a page within a design file.

opendesign: 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

opendesign: RateLimitReachedError

The rate limit for the operation has been reached.

Fields
  • message string - Error message
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

opendesign: ServerError

Fields
  • message string? - A human-readable technical message of the error.
  • docs_url ErrorDocsUrl? - The URL of a documentation web page with more info about the error.

Union types

opendesign: AuthTokenError

NoAuthTokenError|InvalidAuthTokenError|InactiveAccountError

AuthTokenError

opendesign: InlineResponse2002

Design|DesignProcessing

InlineResponse2002

opendesign: InlineResponse2003

DesignSummary|DesignProcessing

InlineResponse2003

Descriptor for a design

String types

opendesign: ArtboardId

string

ArtboardId

An identifier of an artboard within a design file.

opendesign: ArtboardStatusEnum

string

ArtboardStatusEnum

The processing status of an artboard within a design file.

opendesign: DesignExportStatusEnum

string

DesignExportStatusEnum

The processing status of the design file export task.

opendesign: DesignExportTargetFormatEnum

string

DesignExportTargetFormatEnum

The target design file format of a export. (Only Sketch is supported currently.)

opendesign: DesignFormatEnum

string

DesignFormatEnum

The design file format.

opendesign: DesignId

string

DesignId

A unique identifier (UUID) of an imported design file.

opendesign: DesignImportFormatEnum

string

DesignImportFormatEnum

The design file format. (This is not needed when the format can be inferred from the file extension.)

opendesign: DesignStatusEnum

string

DesignStatusEnum

The processing status of the design file.

opendesign: ErrorDocsUrl

string

ErrorDocsUrl

The URL of a documentation web page with more info about the error.

opendesign: FigmaFrameId

string

FigmaFrameId

An identifier of a "frame" component within a Figma file.

opendesign: MultipartFilePart

string

MultipartFilePart

A multipart file upload field.

opendesign: PageId

string

PageId

An identifier of an page within a design file.

opendesign: PageStatusEnum

string

PageStatusEnum

The processing status of a page within a design file.

Import

import ballerinax/opendesign;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 0

Weekly downloads

Source repository

Keywords

Content & Files/Images & Design

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.0

1.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/mime/2.6.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC