Ballerina library

journey.io

Module journey.io

OverviewPrerequisites

API

Client

Definitions

AccountidUsersBody
AccountsUpsertBody
AccountsupsertMembers
ApiKeysConfig
ClientHttp1Settings
ConnectionConfig
EventsBody
EventsIdentification
EventsIdentificationAccount
InlineResponse200
InlineResponse2001
InlineResponse2001Data
InlineResponse200Data
InlineResponse201
InlineResponse201Meta
InlineResponse400
InlineResponse400Errors
InlineResponse400ErrorsParameters
InlineResponse401
LinkBody
LinkIdentification
ProxyConfig
UsersUpsertBody

ballerinax/journey.io Ballerina library

1.5.1

Overview

This is a generated connector for Journey.io API v1.0.0 OpenAPI specification.

The journy.io API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Prerequisites

Clients

journey.io: Client

Isolated

This is a generated connector for Journey.io API v1.0.0 OpenAPI specification. The journy.io API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Journy.io account and obtain the API Key following this guide.

init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://api.journy.io" - URL of the target service
Isolated FunctionRemote Function
function link(LinkBody payload) returns InlineResponse201|error

Link web activity to user

Parameters
Return Type

trackJourneyEvent

Isolated FunctionRemote Function
function trackJourneyEvent(EventsBody payload) returns InlineResponse201|error

Push event

Parameters
Return Type

upsertUser

Isolated FunctionRemote Function
function upsertUser(UsersUpsertBody payload) returns InlineResponse201|error

Create or update user

Parameters
Return Type

upsertAccount

Isolated FunctionRemote Function
function upsertAccount(AccountsUpsertBody payload) returns InlineResponse201|error

Create or update account

Parameters
Return Type

addUserToAccount

Isolated FunctionRemote Function
function addUserToAccount(string accountId, AccountidUsersBody payload) returns InlineResponse201|error

Add user to account

Parameters
  • accountId string - Unique identifier for the account in your database
Return Type

removeUserFromAccount

Isolated FunctionRemote Function
function removeUserFromAccount(string accountId) returns InlineResponse201|error

Remove user from account

Parameters
  • accountId string - Unique identifier for the account in your database
Return Type

getValidity

Isolated FunctionRemote Function
function getValidity() returns InlineResponse200|error

Validate API key

Return Type

getTrackingSnippet

Isolated FunctionRemote Function
function getTrackingSnippet(string domain) returns InlineResponse2001|error

Get snippet for a website

Parameters
  • domain string - The domain you want to receive a snippet for
Return Type

Records

journey.io: AccountidUsersBody

The user being added/removed from the account

Fields
  • userId string - Unique identifier for the user in your database

journey.io: AccountsUpsertBody

Update properties and/or members of an account

Fields
  • properties record {}? - The properties being set, possible values are strings, booleans, numbers and datetimes (ISO 8601)

journey.io: AccountsupsertMembers

Identification requires an accountId, domain or both

Fields

journey.io: ApiKeysConfig

Closed record

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

Fields
  • xApiKey string - Represents API Key X-Api-Key

journey.io: 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

journey.io: 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

journey.io: EventsBody

Event for a user or an account

Fields
  • metadata record {}? - Event metadata, possible values are strings, booleans, numbers and datetimes (ISO 8601)
  • triggeredAt string? - If left blank this defaults to the current datetime

journey.io: EventsIdentification

Event identification requires a user, account or both

Fields

journey.io: EventsIdentificationAccount

Account identification requires an accountId, domain or both

Fields
  • domain string? - The domain associated with the account (e.g. acme-inc.com)
  • accountId string? - Unique identifier for the account in your database

journey.io: InlineResponse200

Fields

journey.io: InlineResponse2001

Fields

journey.io: InlineResponse2001Data

A snippet

Fields

journey.io: InlineResponse200Data

Validation of API Key

Fields

journey.io: InlineResponse201

Fields

journey.io: InlineResponse201Meta

Fields

journey.io: InlineResponse400

Fields

journey.io: InlineResponse400Errors

Map that sums up all received values that seemed incorrect

Fields
  • fields record {}? - All input fields that seemed incorrect

journey.io: InlineResponse400ErrorsParameters

All query-, header- and path- parameters that seemed incorrect

Fields
  • query record {}? -
  • path record {}? -

journey.io: InlineResponse401

Fields

journey.io: LinkBody

Link web activity to user

Fields

journey.io: LinkIdentification

User identification requires a userId, email or both

Fields
  • email string? - Email address of the user
  • userId string? - Unique identifier for the user in your database

journey.io: 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

journey.io: UsersUpsertBody

Update properties of a user

Fields
  • properties record {}? - The properties being set, possible values are strings, booleans, numbers and datetimes (ISO 8601)

Import

import ballerinax/journey.io;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: 2

Current verison: 1

Weekly downloads

Source repository

Keywords

Business Intelligence/Analytics

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC