Ballerina library

apideck.lead

Module apideck.lead

OverviewPrerequisites

API

Client

Definitions

Address
ApiKeysConfig
BadRequest
BankAccount
ClientHttp1Settings
ConnectionConfig
CustomField
Email
InlineResponse200
InlineResponse2001
InlineResponse201
Lead
LinksMeta
MetaCursors
NotFoundResponse
NotImplemented
PaymentRequired
PhoneNumber
ProxyConfig
SocialLinkUnauthorized
UnexpectedError
UnifiedId
Unprocessable
Website

ballerinax/apideck.lead Ballerina library

1.5.1

Overview

This is a generated connector from Apideck Lead API v5.3.0 OpenAPI specification.

You can use this API to access all Lead API endpoints.

Prerequisites

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

Clients

apideck.lead: Client

Isolated

This is a generated connector from Apideck Lead API v5.3.0 OpenAPI specification. You can use this API to access all Lead 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)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://unify.apideck.com" - URL of the target service

leadsAll

Isolated FunctionRemote Function
function leadsAll(string xApideckConsumerId, string xApideckAppId, boolean raw, string? xApideckServiceId, string? cursor, int 'limit) returns InlineResponse200|error

List leads

Parameters
  • xApideckConsumerId string - ID of the consumer which you want to get or push data from
  • xApideckAppId string - The ID of your Unify application
  • raw boolean (default true) - Include raw response. Mostly used for debugging purposes
  • cursor string? (default ()) - Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
  • 'limit int (default 20) - Number of records to return
Return Type

leadsAdd

Isolated FunctionRemote Function
function leadsAdd(string xApideckConsumerId, string xApideckAppId, Lead payload, boolean raw, string? xApideckServiceId) returns InlineResponse201|error

Create lead

Parameters
  • xApideckConsumerId string - ID of the consumer which you want to get or push data from
  • xApideckAppId string - The ID of your Unify application
  • payload Lead - Lead information
  • raw boolean (default true) - Include raw response. Mostly used for debugging purposes
Return Type

leadsOne

Isolated FunctionRemote Function
function leadsOne(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns InlineResponse2001|error

Get lead

Parameters
  • id string - ID of the record you are acting upon.
  • xApideckConsumerId string - ID of the consumer which you want to get or push data from
  • xApideckAppId string - The ID of your Unify application
  • raw boolean (default true) - Include raw response. Mostly used for debugging purposes
Return Type

leadsDelete

Isolated FunctionRemote Function
function leadsDelete(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns InlineResponse201|error

Delete lead

Parameters
  • id string - ID of the record you are acting upon.
  • xApideckConsumerId string - ID of the consumer which you want to get or push data from
  • xApideckAppId string - The ID of your Unify application
  • raw boolean (default true) - Include raw response. Mostly used for debugging purposes
Return Type

leadsUpdate

Isolated FunctionRemote Function
function leadsUpdate(string id, string xApideckConsumerId, string xApideckAppId, Lead payload, string? xApideckServiceId, boolean raw) returns InlineResponse201|error

Update lead

Parameters
  • id string - ID of the record you are acting upon.
  • xApideckConsumerId string - ID of the consumer which you want to get or push data from
  • xApideckAppId string - The ID of your Unify application
  • payload Lead - Lead information
  • raw boolean (default true) - Include raw response. Mostly used for debugging purposes
Return Type

Records

apideck.lead: Address

Fields
  • 'string string? - The address string. Some APIs don't provide structured address data.
  • line1 string? - Line 1 of the address e.g. number, street, suite, apt #, etc.
  • line2 string? - Line 2 of the address
  • postal_code string? - Zip code or equivalent.
  • country string? - country code according to ISO 3166-1 alpha-2.

apideck.lead: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields
  • authorization string - To use API you have to sign up and get your own API key. 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. Authenticate your API requests by including your test or live secret API key in the request header.
    • Bearer authorization header: Authorization: Bearer <your-apideck-api-key>
    • Application id header: x-apideck-app-id: <your-apideck-app-id>
    You should use the public keys on the SDKs and the secret keys to authenticate API requests. Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub. Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys

apideck.lead: BadRequest

Fields
  • status_code decimal? - HTTP status code
  • 'error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
  • type_name string? - The type of error returned
  • message string? - A human-readable message providing more details about the error.
  • detail string|record {}? - Contains parameter or domain specific information related to the error and why it occured.
  • ref string? - Link to documentation of error type

apideck.lead: BankAccount

Fields
  • bsb_number string? - A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.
  • bank_code string? - A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.
  • account_number string? - A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.
  • account_name string? - The name which you used in opening your bank account.

apideck.lead: 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

apideck.lead: 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

apideck.lead: CustomField

Fields

apideck.lead: Email

Fields

apideck.lead: InlineResponse200

Fields
  • status_code int - HTTP Response Status Code
  • status string - HTTP Response Status
  • 'service string - Apideck ID of service provider
  • 'resource string - Unified API resource name
  • operation string - Operation performed
  • meta Meta? - Reponse metadata

apideck.lead: InlineResponse2001

Fields
  • status_code int - HTTP Response Status Code
  • status string - HTTP Response Status
  • 'service string - Apideck ID of service provider
  • 'resource string - Unified API resource name
  • operation string - Operation performed

apideck.lead: InlineResponse201

Fields
  • status_code int - HTTP Response Status Code
  • status string - HTTP Response Status
  • 'service string - Apideck ID of service provider
  • 'resource string - Unified API resource name
  • operation string - Operation performed

apideck.lead: Lead

Fields
  • company_name string - Company name
  • company_id string? - Company ID
  • contact_id string? - Contact ID
  • lead_source string? - Lead source
  • first_name string? - First name
  • description string? - Lead description
  • language string? - language code according to ISO 639-1. For the United States - EN
  • status string? - Comapny status
  • monetary_amount decimal? - Monetory amount
  • websites Website[]? - Company websites
  • addresses Address[]? - Company addresses
  • tags Tags? -
  • updated_at string? - Updated date
  • created_at string? - Created date

Links to navigate to previous or next pages through the API

Fields
  • previous string? - Link to navigate to the previous page through the API
  • current string? - Link to navigate to the current page through the API
  • next string? - Link to navigate to the previous page through the API

apideck.lead: Meta

Reponse metadata

Fields
  • items_on_page int? - Number of items returned in the data property of the response
  • cursors MetaCursors? - Cursors to navigate to previous or next pages through the API

apideck.lead: MetaCursors

Cursors to navigate to previous or next pages through the API

Fields
  • previous string? - Cursor to navigate to the previous page of results through the API
  • current string? - Cursor to navigate to the current page of results through the API
  • next string? - Cursor to navigate to the next page of results through the API

apideck.lead: NotFoundResponse

Fields
  • status_code decimal? - HTTP status code
  • 'error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
  • type_name string? - The type of error returned
  • message string? - A human-readable message providing more details about the error.
  • detail string|record {}? - Contains parameter or domain specific information related to the error and why it occured.
  • ref string? - Link to documentation of error type

apideck.lead: NotImplemented

Fields
  • status_code decimal? - HTTP status code
  • 'error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
  • type_name string? - The type of error returned
  • message string? - A human-readable message providing more details about the error.
  • detail string|record {}? - Contains parameter or domain specific information related to the error and why it occured.
  • ref string? - Link to documentation of error type

apideck.lead: PaymentRequired

Fields
  • status_code decimal? - HTTP status code
  • 'error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
  • type_name string? - The type of error returned
  • message string? - A human-readable message providing more details about the error.
  • detail string? - Contains parameter or domain specific information related to the error and why it occured.
  • ref string? - Link to documentation of error type

apideck.lead: PhoneNumber

Fields

apideck.lead: 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
Fields

apideck.lead: Unauthorized

Fields
  • status_code decimal? - HTTP status code
  • 'error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
  • type_name string? - The type of error returned
  • message string? - A human-readable message providing more details about the error.
  • detail string? - Contains parameter or domain specific information related to the error and why it occured.
  • ref string? - Link to documentation of error type

apideck.lead: UnexpectedError

Fields
  • status_code decimal? - HTTP status code
  • 'error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
  • type_name string? - The type of error returned
  • message string? - A human-readable message providing more details about the error.
  • detail string|record {}? - Contains parameter or domain specific information related to the error and why it occured.
  • ref string? - Link to documentation of error type

apideck.lead: UnifiedId

Fields

apideck.lead: Unprocessable

Fields
  • status_code decimal? - HTTP status code
  • 'error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
  • type_name string? - The type of error returned
  • message string? - A human-readable message providing more details about the error.
  • detail string? - Contains parameter or domain specific information related to the error and why it occured.
  • ref string? - Link to documentation of error type

apideck.lead: Website

Fields

Import

import ballerinax/apideck.lead;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 1

Weekly downloads

Source repository

Keywords

Sales & CRM/Customer Relationship Management

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.1
See more...

Dependencies

ballerina/url/2.2.3ballerina/constraint/1.1.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC