Module apideck.proxy
ballerinax/apideck.proxy Ballerina library
1.5.2
Overview
The Apideck Proxy API v5.3.0 connector(https://developers.apideck.com/apis/proxy/reference) OpenAPI specification.
You can use this API to access all Proxy API endpoints.
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:
- Create a Apideck account
- Obtain tokens by following this guide
Clients
apideck.proxy: Client
Isolated
This is a generated connector from Apideck Proxy API v5.3.0 OpenAPI specification. You can use this API to access all Proxy API endpoints.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object.
You can find your API keys on the unify settings of your Apideck app.Your Apideck application_id can also be found on the same page.
Obtain API keys 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://unify.apideck.com" - URL of the target service
getProxy
Isolated FunctionRemote Function
function getProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, string? xApideckDownstreamAuthorization) returns json|errorGET
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
putProxy
Isolated FunctionRemote Function
function putProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, json payload, string? xApideckDownstreamAuthorization) returns json|errorPUT
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- payload json - Depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT.
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
postProxy
Isolated FunctionRemote Function
function postProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, json payload, string? xApideckDownstreamAuthorization) returns json|errorPOST
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- payload json - Depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT.
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
deleteProxy
Isolated FunctionRemote Function
function deleteProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, string? xApideckDownstreamAuthorization) returns json|errorDELETE
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
patchProxy
Isolated FunctionRemote Function
function patchProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, json payload, string? xApideckDownstreamAuthorization) returns json|errorPATCH
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- payload json - Depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT.
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
Records
apideck.proxy: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
apideck.proxy: 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
apideck.proxy: 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
apideck.proxy: InlineResponse401
Fields
- detail? string - Contains parameter or domain specific information related to the error and why it occured.
- 'error? string - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- message? string - A human-readable message providing more details about the error.
- ref? string - Link to documentation of error type
- status_code? decimal - HTTP status code
- type_name? string - The type of error returned
apideck.proxy: 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