Module iris.subscriptions

ballerinax/iris.subscriptions Ballerina library

1.5.1

Overview

This is a generated connector for IRIS Subscriptions API v1.6.4 OpenAPI specification. Connect with the Subscriptions API to create, view, and manage your event notification subscriptions.
A webhook listener URL is required from you to be able to create the subscription and receive notifications. Learn about API updates and new endpoints by subscribing to the api.updated event. Receive alerts in real-time including lead status changes, e-signature document actions, and helpdesk ticket changes. Subscription API responses provide you with detailed information on a silver platter to avoid sorting through data unnecessarily.

Prerequisites

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

Create a IRIS CRM account
Obtain tokens by following this guide

Quickstart

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

Step 1: Import connector

First, import the ballerinax/iris.subscriptions module into the Ballerina project.


import ballerinax/iris.subscriptions;

Step 2: Create a new connector instance

Create a subscriptions:ApiKeysConfig with the API key obtained, and initialize the connector with it.


subscriptions:ApiKeysConfig config = {
    xApiKey: "<API_KEY>"
}
subscriptions:Client baseClient = check new Client(config);

Step 3: Invoke connector operation

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 how to get a list of subscriptions using the connector.

Return a list of subscriptions


public function main() returns error? {
    subscriptions:InlineResponse20056 response = check baseClient->getSubscriptions();
    log:printInfo(response.toString());
}

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

Clients

iris.subscriptions: Client

Isolated

Constructor

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

init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)

apiKeyConfig ApiKeysConfig - API keys for authorization

serviceUrl string - URL of the target service

config ConnectionConfig {} - The configurations to be used when initializing the connector

getSubscriptions

Isolated FunctionRemote Function

function getSubscriptions(int? page, int? perPage) returns InlineResponse200|error

Return a list of subscriptions

Parameters

page int? (default ()) - Page Number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse200|error - A JSON array of subscriptions

createSubscription

Isolated FunctionRemote Function

function createSubscription(BriefSubscriptionInfo payload) returns BriefSubscriptionInfo|error

Create a subscription

Parameters

payload BriefSubscriptionInfo - Subscription details

Return Type

BriefSubscriptionInfo|error - Subscription has been created successfully

getSubscriptionsById

Isolated FunctionRemote Function

function getSubscriptionsById(int subscriptionId) returns BriefSubscriptionInfo|error

Return a subscription by its id

Parameters

subscriptionId int - Subscription Id

Return Type

BriefSubscriptionInfo|error - Subscription

deleteSubscription

Isolated FunctionRemote Function

function deleteSubscription(int subscriptionId) returns InlineResponse2001|error

Delete a subscription

Parameters

subscriptionId int - Subscription Id

Return Type

InlineResponse2001|error - Subscription (1) has been deleted successfully

updateSubscription

Isolated FunctionRemote Function

function updateSubscription(int subscriptionId, BriefSubscriptionInfo payload) returns BriefSubscriptionInfo|error

Update a subscription

Parameters

subscriptionId int - Subscription Id

payload BriefSubscriptionInfo - Subscription details

Return Type

BriefSubscriptionInfo|error - Subscription has been updated successfully

testPayloadForCheckingServerResponse

Isolated FunctionRemote Function

function testPayloadForCheckingServerResponse() returns TestSubscription|error

Test payload for checking server response

Return Type

TestSubscription|error - Response

receiveNotificationWhenApiUpdated

Isolated FunctionRemote Function

function receiveNotificationWhenApiUpdated() returns ApiUpdated|error

Receive a notification when this API is updated

Return Type

ApiUpdated|error - API details

receiveNotificationWhenLeadCreated

Isolated FunctionRemote Function

function receiveNotificationWhenLeadCreated() returns LeadCreatedEventInfo|error

Receive a notification when a lead is created in this CRM, with the option to only receive a notification when a lead is in the status(es) specified here

Return Type

LeadCreatedEventInfo|error - Lead details

receiveNotificationWhenLeadUpdated

Isolated FunctionRemote Function

function receiveNotificationWhenLeadUpdated() returns LeadUpdatedEventInfo|error

Receive a notification when a lead's campaign, status, group, or field values are updated in this CRM, with the option to only receive a notification when a lead is in the status(es) specified here

Return Type

LeadUpdatedEventInfo|error - Lead details

receiveNotificationWhenLeadDeleted

Isolated FunctionRemote Function

function receiveNotificationWhenLeadDeleted() returns LeadDeletedEventInfo|error

Receive a notification when a lead in this CRM is deleted

Return Type

LeadDeletedEventInfo|error - Lead details

receiveNotificationWhenLeadRestored

Isolated FunctionRemote Function

function receiveNotificationWhenLeadRestored() returns LeadRestoredEventInfo|error

Receive a notification when a deleted lead is restored in this CRM

Return Type

LeadRestoredEventInfo|error - Lead details

receiveNotificationWhenLeadStatusUpdated

Isolated FunctionRemote Function

function receiveNotificationWhenLeadStatusUpdated() returns LeadStatusUpdatedEventInfo|error

Receive a notification when a lead's status is updated in this CRM, with the option to only receive a notification when a lead is moved to or from the status(es) specified here

Return Type

LeadStatusUpdatedEventInfo|error - Lead details

receiveNotificationWhenLeadEsignatureGenerated

Isolated FunctionRemote Function

function receiveNotificationWhenLeadEsignatureGenerated() returns SignatureGenerated|error

Receive a notification when a lead's e-signature document is generated

Return Type

SignatureGenerated|error - Lead details

receiveNotificationWhenLeadEsignatureOpened

Isolated FunctionRemote Function

function receiveNotificationWhenLeadEsignatureOpened() returns SignatureOpened|error

Receive a notification when a lead's e-signature document is opened by the recipient

Return Type

SignatureOpened|error - Lead details

receiveNotificationWhenLeadEsignatureSigned

Isolated FunctionRemote Function

function receiveNotificationWhenLeadEsignatureSigned() returns SignatureSigned|error

Receive a notification when a lead's e-signature document is signed by the recipient

Return Type

SignatureSigned|error - Lead details

receiveNotificationWhenLeadNoteAdded

Isolated FunctionRemote Function

function receiveNotificationWhenLeadNoteAdded() returns LeadNoteAddedEventInfo|error

Receive a notification when a lead in this CRM has a note posted, with the option to only receive a notification when a lead is in the status(es) specified here

Return Type

LeadNoteAddedEventInfo|error - Lead details

receiveNotificationWhenLeadDocumentUploaded

Isolated FunctionRemote Function

function receiveNotificationWhenLeadDocumentUploaded() returns LeadDocumentUploadedEventInfo|error

Receive a notification when a lead document is uploaded

Return Type

LeadDocumentUploadedEventInfo|error - Lead details

receiveNotificationWhenLeadEmailReceived

Isolated FunctionRemote Function

function receiveNotificationWhenLeadEmailReceived() returns LeadEmailReceivedEventInfo|error

Receive a notification when an email message is received on a lead in this CRM, with the option to only receive a notification when a lead is in the status(es) specified here

Return Type

LeadEmailReceivedEventInfo|error - Lead details

receiveNotificationWhenTurboAppSubmitted

Isolated FunctionRemote Function

function receiveNotificationWhenTurboAppSubmitted() returns TurboAppSubmited|error

Receive a notification when a TurboApp is submitted to a processor

Return Type

TurboAppSubmited|error - Application details

receiveNotificationWhenTurboAppUpdated

Isolated FunctionRemote Function

function receiveNotificationWhenTurboAppUpdated() returns TurboAppUpdated|error

Receive a notification when the underwriting status is updated

Return Type

TurboAppUpdated|error - Application account details

receiveNotificationWhenTurboAppApproved

Isolated FunctionRemote Function

function receiveNotificationWhenTurboAppApproved() returns TurboAppApproved|error

Receive a notification when a merchant is approved

Return Type

TurboAppApproved|error - Application details

receiveNotificationWhenTurboAppDeclined

Isolated FunctionRemote Function

function receiveNotificationWhenTurboAppDeclined() returns TurboAppDeclined|error

Receive a notification when a merchant is declined

Return Type

TurboAppDeclined|error - Application details

receiveNotificationWhenTurboAppCreated

Isolated FunctionRemote Function

function receiveNotificationWhenTurboAppCreated() returns TicketCreated|error

Receive a notification when a ticket is created

Return Type

TicketCreated|error - Ticket created

receiveNotificationWhenTicketUpdated

Isolated FunctionRemote Function

function receiveNotificationWhenTicketUpdated() returns TicketUpdated|error

Receive a notification when a ticket is updated

Return Type

TicketUpdated|error - Ticket updated

receiveNotificationWhenTicketResolved

Isolated FunctionRemote Function

function receiveNotificationWhenTicketResolved() returns TicketResolved|error

Receive a notification when a ticket is resolved

Return Type

TicketResolved|error - Ticket resolved

receiveNotificationWhenTicketCommented

Isolated FunctionRemote Function

function receiveNotificationWhenTicketCommented() returns TicketCommented|error

Receive a notification when a ticket comment is added

Return Type

TicketCommented|error - Ticket commented

receiveNotificationWhenTicketCommentEdited

Isolated FunctionRemote Function

function receiveNotificationWhenTicketCommentEdited() returns SubscriptionCommentEdited|error

Receive a notification when a ticket comment is edited

Return Type

SubscriptionCommentEdited|error - Ticket comment edited

receiveNotificationWhenReportPublished

Isolated FunctionRemote Function

function receiveNotificationWhenReportPublished() returns ReportPublished|error

Receive a notification when a residuals report is published

Return Type

ReportPublished|error - Report details

receiveNotificationWhenLineItemAdded

Isolated FunctionRemote Function

function receiveNotificationWhenLineItemAdded() returns LineItemAdded|error

Receive a notification when a residuals line item is added

Return Type

LineItemAdded|error - Line item details

receiveNotificationWhenChargebackAdded

Isolated FunctionRemote Function

function receiveNotificationWhenChargebackAdded() returns ChargebackAdded|error

Receive a notification when a new chargeback case created

Return Type

ChargebackAdded|error - Chargeback case details

receiveNotificationWhenChargebackUpdated

Isolated FunctionRemote Function

function receiveNotificationWhenChargebackUpdated() returns ChargebackUpdated|error

Receive a notification when chargeback case status changed

Return Type

ChargebackUpdated|error - Chargeback case details

receiveNotificationForChargebackReminder

Isolated FunctionRemote Function

function receiveNotificationForChargebackReminder() returns ChargebackReminder|error

Receive a notification in 7/3/1 days before the chargeback case due date

Return Type

ChargebackReminder|error - Chargeback case details

receiveNotificationWhenRetrievalAdded

Isolated FunctionRemote Function

function receiveNotificationWhenRetrievalAdded() returns RetrievalAdded|error

Receive a notification when a new retrieval case created

Return Type

RetrievalAdded|error - Retrieval case details

receiveNotificationWhenRetrievalUpdated

Isolated FunctionRemote Function

function receiveNotificationWhenRetrievalUpdated() returns RetrievalUpdated|error

Receive a notification when retrieval case status changed

Return Type

RetrievalUpdated|error - Retrieval case details

receiveNotificationForRetrievalReminder

Isolated FunctionRemote Function

function receiveNotificationForRetrievalReminder() returns RetrievalReminder|error

Receive a notification in 7/3/1 days before the retrieval case due date

Return Type

RetrievalReminder|error - Retrieval case details

Records

iris.subscriptions: AdjustmentsInner

Fields

date string? - Adjustment date

'type string? - Adjustment type

amount string? - Adjustment amount

iris.subscriptions: ApiKeysConfig

Closed record

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

Fields

xApiKey string - Represents API Key X-API-KEY

iris.subscriptions: ApiUpdated

Fields

hook ApiupdatedHook? -

data ApiupdatedData? -

iris.subscriptions: ApiupdatedData

Fields

'version string? - Version number

update string? - Should users do an update of their API clients functional

details ApiupdatedDataDetails[]? -

createdAt string? - Date and time of creation (ISO 8601)

iris.subscriptions: ApiupdatedDataDetails

Fields

description string? - Description of update

link string? - Link to endpoint documentation

'type string? - Type of API update

iris.subscriptions: ApiupdatedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: ApplicationField

Fields

id int? - Application field Id

'from int - Application field from field Id

'record int? - Application field record

to string? - Name of mapped field

toAlt string? - Alt of mapped field

toType string? - Type of mapped field

special string? - Special type of mapped field

info ApplicationfieldInfo[]? -

iris.subscriptions: ApplicationfieldDuplicates

Fields

instance int? - Activity Id

left int? - Padding from left

right int? - Padding from right

top int? - Padding from top

bottom int? - Padding from bottom

height int? - Height of field

width int? - Width of field

page_number int? - Page number

iris.subscriptions: ApplicationfieldInfo

Fields

field_name string? - Field name

field_type string? - Field type

left int? - Padding from left

right int? - Padding from right

top int? - Padding from top

bottom int? - Padding from bottom

field_height int? - Height of field

field_width int? - Width of field

page_number int? - Page number

page_height int? - Page height

page_width int? - Page width

page_rotation int? - Page rotation

export_value string? - Export value

duplicates ApplicationfieldDuplicates[]? -

iris.subscriptions: ApplicationSubscription

Fields

id int? -

title string? -

group_id int? -

group_name string? -

iris.subscriptions: BriefApplicationInfo

Fields

id int? - Application Id

name string? - Application name

'e\-sign string? - Is E-Sign available?

iris.subscriptions: BriefCampaignInfo

Fields

id int? - Campaign Id

name string? - Campaign name

iris.subscriptions: BriefCategoryInfo

Fields

id int? - Status category Id

name string? - Status category name

iris.subscriptions: BriefEmailTemplate

Fields

id int? -

title string? -

iris.subscriptions: BriefGroupInfo

Fields

id int? - Group Id

name string? - Group name

iris.subscriptions: BriefLeadInfo

Fields

id int? - Lead Id

mid int? - Lead merchant Id

name string? - Lead name

group BriefGroupInfo? -

category BriefCategoryInfo? -

status BriefStatusInfo? -

campaign BriefCampaignInfo? -

'source BriefSourceInfo? -

created string? - Lead creation date (Y-m-d\TH:i:sP)

modified string? - Lead modification date (Y-m-d\TH:i:sP)

iris.subscriptions: BriefMerchantInfo

Fields

mid string? - Merchant number

name string? - Merchant name

opened string? - Merchant open date

closed string? - Merchant closed date

created string? - Merchant created date

modified string? - Merchant modified date

first_batch string? - Merchant first batch date

last_batch string? - Merchant last batch date

group string? - Group name

processor string? - Processor name

datasource string? - Data source name

sic_code string? - SIC Code

vim string? - Is VIM?

deactivated string? - Merchant deactivation date

status string? - Merchant status

active string? - Merchant active flag

iris.subscriptions: BriefSmsTemplate

Fields

id int? -

title string? -

iris.subscriptions: BriefSourceInfo

Fields

id int? - Source Id

name string? - Source name

iris.subscriptions: BriefStatusInfo

Fields

id int? - Status Id

name string? - Status name

iris.subscriptions: BriefSubscriptionInfo

Fields

id int? - Subscription Id

url string - Subscription URL

events string[] - Subscription Events

options BriefsubscriptioninfoOptions? - Options for each event

multiple_at_once boolean? - Report multiple items in one request

iris.subscriptions: BriefsubscriptioninfoOptions

Options for each event

Fields

leadStatusUpdated BriefsubscriptioninfoOptionsLeadstatusupdated? - Statuses from which a lead should be updated

leadCreated BriefsubscriptioninfoOptionsLeadcreated? - Statuses with which a lead should be created

leadNoteAdded BriefsubscriptioninfoOptionsLeadnoteadded? - Statuses of leads whose notes should be added

leadDocumentUploaded BriefsubscriptioninfoOptionsLeaddocumentuploaded? - Statuses of leads whose documents should be uploaded

leadEmailReceived BriefsubscriptioninfoOptionsLeademailreceived? - Statuses of leads whose emails should received

iris.subscriptions: BriefsubscriptioninfoOptionsLeadcreated

Statuses with which a lead should be created

Fields

statuses int[]? - Statuses with which a created lead should be reported (any if not specified)

iris.subscriptions: BriefsubscriptioninfoOptionsLeaddocumentuploaded

Statuses of leads whose documents should be uploaded

Fields

statuses int[]? - Statuses of leads whose uploaded documents should be reported (any if not specified)

iris.subscriptions: BriefsubscriptioninfoOptionsLeademailreceived

Statuses of leads whose emails should received

Fields

statuses int[]? - Statuses of leads whose received emails should be reported (any if not specified)

iris.subscriptions: BriefsubscriptioninfoOptionsLeadnoteadded

Statuses of leads whose notes should be added

Fields

statuses int[]? - Statuses of leads whose added notes should be reported (any if not specified)

iris.subscriptions: BriefsubscriptioninfoOptionsLeadstatusupdated

Statuses from which a lead should be updated

Fields

previousStatuses int[]? - Statuses from which a lead should be updated to report the update (any if not specified)

newStatuses int[]? - Statuses to which a lead should be updated to report the update (any if not specified)

iris.subscriptions: BriefTabInfo

Fields

id int? - Tab Id

name string? - Tab name

iris.subscriptions: BriefTicketChecklistInfo

Fields

id int? - Checklist item Id

template_id int? - Checklist template Id

name string? - Checklist item name

index int? - Index in list

required boolean? - Flag is checklist are required

fileRequired boolean? - Flag is checklist file are required

commentRequiredToDoneTicket boolean? - Flag is comment are required to resolve ticket

commentRequiredToDoneItem boolean? - Flag is checklist are required to resolve checklist item

commentedAt anydata? - Datetime when user have commented checklist item

commentedBy int? - User Id of user who have commented checklist item

iris.subscriptions: BriefTicketComments

Fields

id int? - Comment id

ticketId int? - Ticket id

comment string? - Comment text

created string? - Comment created date

createdBy int? - Comment creator id

modified string? - Comment modified date

modifiedBy int? - Id of user who left comment

files File[]? -

preview_images File[]? -

merchantVisible boolean? - Indicates if the comment is visible to Merchant users

iris.subscriptions: BriefTicketInfo

Fields

Fields Included from * Ticket

id int
subject string
description string
status TicketStatus
type TicketType
group TicketGroup
priority TicketPriority
lead_id int
mid int
merchantVisible boolean
anydata...

Fields Included from * TicketCreatedBlock

created string
created_by int
anydata...

modified string? - Ticket modified date

modified_by int? - Id of user who made last change

resolved string? - Ticket resolved date

resolved_by int? - Id of user who made last change

due_date string? - Ticket due date

due string? - Ticket SLA

only_business_days boolean? - Calculate only business days

last_comment string? - Ticket last comment date

files_count int? - Count of ticket files

iris.subscriptions: BriefTicketTypeInfo

Fields

id int? - Ticket type id

name string? - Ticket type name

description string? - Ticket type description

daysToResolve int? - Days to Resolve

only_business_days boolean? - Calculate only business days

status TicketStatus? -

priority TicketPriority? -

created string? - Ticket type created date

createdBy int? - Ticket type creator id

modified string? - Ticket type modified date

modifiedBy int? - Id of user who made last change

'order int? - Ticket type order

permissions int[]? -

due_date string? - Ticket due date

assignees BrieftickettypeinfoAssignees? -

iris.subscriptions: BrieftickettypeinfoAssignees

Fields

everyTime int[]? -

roundRobin int[]? -

iris.subscriptions: BriefTicketUsersInfo

Fields

id int? - User id

name string? - User name

'class string? - User class

iris.subscriptions: BriefUserInfo

Fields

id int? - User Id

name string? - User name

iris.subscriptions: BriefUserInfoWithClass

Fields

id int? - User Id

username string? - User username

full_name string? - User name

email string? - User email

status string? - User status

'class string? - User class

iris.subscriptions: CampaignActivity

Fields

id int? - Activity Id

newValue string? - New value of activity

assignedBy int? - User Id

assignedAt string? - Assigned date (Y-m-d\TH:i:sP)

iris.subscriptions: CategoryWithStatuses

Fields

id int? - Status category Id

name string? - Status category name

statuses BriefStatusInfo[]? -

iris.subscriptions: Chargeback

Fields

id int? - Chargeback internal ID

merchant_id string? - Merchant ID

dba string? - Merchant DBA

case_number string? - Case number

chargeback_date string? - Chargeback date

transaction_date string? - Transaction date

respond_due string? - Respond due date

amount string? - Amount

original_amount string? - Original amount of transaction

currency string? - Transaction currency

reason string? - Chargeback reason

reason_code string? - Chargeback reason code

card_number string? - Cardholder number

reply_form string? - Reply form type. Affects reply options.

cycle_indicator string? - Chargeback cycle indicator

transaction_id string? - Transaction ID

reference_number string? - Transaction ID

case_status string? - Case status

case_status_description string? - Status description

mcc string? - MCC code

dispute_jurisdiction string? - Dispute jurisdiction

card_product_type string? - Card product

process_date string? - Process date

transaction_method string? - Transaction method

invoice_number string? - Invoice number

microfilm_number string? - Microfilm number

airline_ticket_number string? - Airline ticket number

order_number string? - Order number

tracking_number string? - Tracking number

last_status_date string? - Date of the last status update

updated_at string? - Date of the most recent update

case_action string? - Case action

action string? - Can the case be viewed of replied

foreign_amount string? - Foreign amount of transaction

transaction_locator string? - Transaction locator

authorization_code string? - Authorization code

'type string? - Chargeback type

iris.subscriptions: ChargebackAdded

Fields

hook ChargebackaddedHook? -

data ChargebackaddedData? -

iris.subscriptions: ChargebackaddedData

Fields

chargebacks ChargebackReplyResponse[]? -

iris.subscriptions: ChargebackaddedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: ChargebackReminder

Fields

hook ChargebackreminderHook? -

data ChargebackreminderData? -

iris.subscriptions: ChargebackreminderData

Fields

chargebacks record { due_in int }[]? -

iris.subscriptions: ChargebackreminderHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: ChargebackReplyCreditIssuedRequest

Fields

credit_date string - Credit transaction date

credit_amount string - Credit transaction amount

user_note string - User note

file string[] - Files to attach

iris.subscriptions: ChargebackReplyDisputeRequest

Fields

selected_doc_types string - Selected documents

other_description string? - Other document description

compelling_doc string? - Compelling document

selected_compelling string? - Selected compelling

selected_digital_goods_04 string? - Digital goods compelling documents

download_date string? - Download date

download_time string? - Download time

purchaser_ip_addr string? - Purchaser IP address

geographical_location string? - Physical location

device_id string? - PhDevice ID

device_name string? - Device ID

purchaser_name string? - Purchaser name

purchaser_email string? - Purchaser email

arn_04 string? - ARN

tran_date_04 string? - Transaction date

arn_09 string? - ARN

tran_date_09 string? - Transaction date

arn_13 string? - ARN

tran_date_13 string? - Transaction date

ip_address string? - IP address

email_address string? - Email address

phone_number string? - Phone number

physical_address string? - Physical address

user_note string - User note

file string[] - Files to attach

iris.subscriptions: ChargebackReplyResponse

Fields

chargeback ChargebackreplyresponseChargeback? -

items ChargebackreplyresponseItems? -

Fields Included from * DisputeDetailsResponse

transactions DisputedetailsresponseTransactions[]
auth_records DisputedetailsresponseTransactions[]
notes DisputedetailsresponseNotes[]
messages DisputedetailsresponseMessages[]
directories DisputedetailsresponseDirectories[]
anydata...

iris.subscriptions: ChargebackreplyresponseChargeback

Fields

id string? -

merchant_id string? -

dba string? -

cycle_indicator string? -

date string? -

transaction_date string? -

amount string? -

reason_code string? -

reason string? -

card_number string? -

case_number string? -

case_action string? -

action string? -

reply_form string? -

case_status string? -

case_status_description string? -

last_status_date string? -

respond_due string? -

original_amount string? -

updated_at string? -

mcc string? -

dispute_jurisdiction string? -

card_product_type string? -

process_date string? -

transaction_method string? -

invoice_number string? -

microfilm_number string? -

airline_ticket_number string? -

order_number string? -

tracking_number string? -

iris.subscriptions: ChargebackreplyresponseItems

Fields

reason string? -

message_from_bank string? -

merchant_due_date string? -

financial_disposition_date string? -

'type string? -

iris.subscriptions: ChargebackUpdated

Fields

hook ChargebackupdatedHook? -

data ChargebackaddedData? -

iris.subscriptions: ChargebackupdatedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: ChecklistFullInfo

Fields

Fields Included from * BriefTicketChecklistInfo

id int
template_id int
name string
index int
required boolean
fileRequired boolean
commentRequiredToDoneTicket boolean
commentRequiredToDoneItem boolean
commentedAt anydata
commentedBy int
anydata...

completed boolean? - Flag is checklist are done

completed_by int? - User ID who compleated the checklist

completed_at anydata? - Datetime when user have completed the checklist item

files File[]? -

iris.subscriptions: CheckListRequest

Fields

index int? - Checklist item index

files string[]? -

attached_files int[]? -

completed boolean? - Flag checklist are item completed

comment string? - Comment for checklist item

iris.subscriptions: 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

iris.subscriptions: CommentSubscriptionData

Fields

ticket_url string? -

assignedUsers UserListStructure? - Assigned users

files File[]? -

merchantVisible boolean? - Indicates if the comment is visible for Merchant users

iris.subscriptions: 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-forwarded header

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

iris.subscriptions: DeletionActivity

Fields

id int? - Activity Id

deletedId int? - User Id

deletedAt string? - Date of deletion (Y-m-d\TH:i:sP)

undeletedId int? - User Id

undeletedAt string? - Date of undeletion (Y-m-d\TH:i:sP)

iris.subscriptions: DepositsInner

Fields

date string? - Deposit date

amount string? - Deposit amount

transactions int? - Transactions count

batch string? - Deposit batch number

iris.subscriptions: DisputeDetailsResponse

Fields

transactions DisputedetailsresponseTransactions[]? -

auth_records DisputedetailsresponseTransactions[]? -

notes DisputedetailsresponseNotes[]? -

messages DisputedetailsresponseMessages[]? -

directories DisputedetailsresponseDirectories[]? -

iris.subscriptions: DisputedetailsresponseDirectories

Fields

time string? -

title string? -

files DisputedetailsresponseFiles[]? -

iris.subscriptions: DisputedetailsresponseFields

Fields

'key string? -

value string? -

iris.subscriptions: DisputedetailsresponseFiles

Fields

time string? -

title string? -

url string? - site url

api_url string? - api url

iris.subscriptions: DisputedetailsresponseMessages

Fields

message string? -

description string? -

added_at string? -

viewed_on string? -

iris.subscriptions: DisputedetailsresponseNotes

Fields

message string? -

added_at string? -

iris.subscriptions: DisputedetailsresponseTransactions

Fields

reference string? -

fields DisputedetailsresponseFields[]? -

iris.subscriptions: DisputeFile

Fields

name string? - File name

directory string? - Folder name

content string? - base64 encoded content

iris.subscriptions: DuplicateActivity

Fields

id int? - Activity Id

oldLeadId int? - Old lead Id

newLeadId int? - New lead Id

duplicatedBy int? - User Id

duplicatedAt string? - Date of duplication (Y-m-d\TH:i:sP)

iris.subscriptions: File

Fields

id int? -

name string? -

size int? -

created string? - File creation date (Y-m-d\TH:i:sP)

created_by int? -

iris.subscriptions: FileLabel

Fields

id int? - Label Id

'order int? - Label display order

name string? - Label name

iris.subscriptions: FullLeadSubscription

Fields

Fields Included from * ShortLeadSubscription

id int
lead_url string
name string
email string
contact string
phone string
address LeademailreceivedeventinfoDataAddress
assignedUsers UserListStructure
anydata...

id int? - Lead ID

lead_url string? - Lead URL

name string? - Lead Name

email string? - Lead Default Email

contact string? - Lead Default Contact Name

phone string? - Lead Default Contact Phone Number

address LeademailreceivedeventinfoDataAddress? -

group FullleadsubscriptionGroup? -

category FullleadsubscriptionCategory? -

status FullleadsubscriptionStatus? -

campaign FullleadsubscriptionCampaign? -

'source FullleadsubscriptionSource? -

createdAt string? - Date and time of creation (ISO 8601)

createdBy UserStructure? -

iris.subscriptions: FullleadsubscriptionCampaign

Fields

id int? - Campaign ID

name string? - Campaign Name

iris.subscriptions: FullleadsubscriptionCategory

Fields

id int? - Status category ID

name string? - Status category Name

iris.subscriptions: FullleadsubscriptionGroup

Fields

id int? - Group ID

name string? - Group Name

iris.subscriptions: FullleadsubscriptionSource

Fields

id int? - Source ID

name string? - Source Name

iris.subscriptions: FullleadsubscriptionStatus

Fields

id int? - Status ID

name string? - Status Name

iris.subscriptions: InlineResponse200

Fields

data BriefSubscriptionInfo[]? -

links Links? -

meta Meta? -

iris.subscriptions: InlineResponse2001

Fields

message string? - Subscription deletion message

iris.subscriptions: InlineResponse401

Fields

message string? -

iris.subscriptions: InlineResponse403

Fields

message string? -

iris.subscriptions: InlineResponse404

Fields

message string? -

iris.subscriptions: InlineResponse405

Fields

message string? -

iris.subscriptions: LeadAppointment

Fields

id int? - Appointment Id

user BriefUserInfo? -

set_for BriefUserInfo? -

set_at string? - Appointment creation date and time in format ISO 8601 (Y-m-d\TH:i:sP)

set_by BriefUserInfo? -

modified string? - Appointment modification date and time in format ISO 8601 (Y-m-d\TH:i:sP)

modified_by BriefUserInfo? -

text string? - Appointment description

date string? - Appointment date and time in format ISO 8601 (Y-m-d\TH:i:sP)

date_end string? - Appointment end date and time in format ISO 8601 (Y-m-d\TH:i:sP)

done string? - Is appointment done?

confirmed string? - Appointment confirmed date and time in format ISO 8601 (Y-m-d\TH:i:sP)

confirmed_by BriefUserInfo? -

seen string? - Appointment seen date and time in format ISO 8601 (Y-m-d\TH:i:sP)

seen_by BriefUserInfo? -

rescheduled string? - Appointment rescheduled date and time in format ISO 8601 (Y-m-d\TH:i:sP)

rescheduled_by BriefUserInfo? -

rescheduled_count int? -

iris.subscriptions: LeadCreatedEventInfo

Fields

hook LeadcreatedeventinfoHook? -

data LeadcreatedeventinfoData? -

iris.subscriptions: LeadcreatedeventinfoData

Fields

lead FullLeadSubscription? -

leads FullLeadSubscription[]? - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.subscriptions: LeadcreatedeventinfoHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LeadDeletedEventInfo

Fields

hook LeaddeletedeventinfoHook? -

data LeaddeletedeventinfoData? -

iris.subscriptions: LeaddeletedeventinfoData

Fields

lead record { deletedBy UserStructure }? -

leads record { deletedBy UserStructure }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.subscriptions: LeaddeletedeventinfoHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LeadDocumentUploadedEventInfo

Fields

hook LeaddocumentuploadedeventinfoHook? -

data LeaddocumentuploadedeventinfoData? -

iris.subscriptions: LeaddocumentuploadedeventinfoData

Fields

lead record { document record { id int, label string, filename string, file string, uploadedAt string, uploadedBy UserStructure } }? -

leads record { document record { id int, label string, filename string, file string, uploaded_at string, uploaded_by UserStructure } }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.subscriptions: LeaddocumentuploadedeventinfoHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LeadEmailReceivedEventInfo

Fields

hook LeademailreceivedeventinfoHook? -

data LeademailreceivedeventinfoData? -

iris.subscriptions: LeademailreceivedeventinfoData

Fields

lead LeademailreceivedeventinfoDataLead? - 'lead' property is passed when 'Multiple at once' feature is disabled

leads LeademailreceivedeventinfoDataLeads[]? - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.subscriptions: LeademailreceivedeventinfoDataAddress

Fields

address string? - Lead Default Address

city string? - Lead Default City

state string? - Lead Default State

zip string? - Lead Default ZIP

iris.subscriptions: LeademailreceivedeventinfoDataEmail

Fields

'from string? - Sent from (name and email)

to string? - Sent to(email)

subject string? - Email subject

bodyText string? - Email message without html

bodyHtml string? - Email message including html

sentAt string? - Date and time of receiving the email (ISO 8601)

iris.subscriptions: LeademailreceivedeventinfoDataLead

'lead' property is passed when 'Multiple at once' feature is disabled

Fields

id int? - Lead ID

lead_url string? - Lead URL

name string? - Lead Name

emailAddress string? - Lead Default Email

contact string? - Lead Default Contact Name

phone string? - Lead Default Contact Phone Number

address LeademailreceivedeventinfoDataLeadAddress? - Address

email LeademailreceivedeventinfoDataLeadEmail? - Email

assignedUsers UserListStructure? - Assigned users

iris.subscriptions: LeademailreceivedeventinfoDataLeadAddress

Address

Fields

address string? - Lead Default Address

city string? - Lead Default City

state string? - Lead Default State

zip string? - Lead Default ZIP

iris.subscriptions: LeademailreceivedeventinfoDataLeadEmail

Fields

'from string? - Sent from (name and email)

to string? - Sent to(email)

subject string? - Email subject

bodyText string? - Email message without html

bodyHtml string? - Email message including html

sentAt string? - Date and time of receiving the email (ISO 8601)

iris.subscriptions: LeademailreceivedeventinfoDataLeads

Fields

id int? - Lead ID

lead_url string? - Lead URL

name string? - Lead Name

emailAddress string? - Lead Default Email

contact string? - Lead Default Contact Name

phone string? - Lead Default Contact Phone Number

address LeademailreceivedeventinfoDataAddress? -

email LeademailreceivedeventinfoDataEmail? -

assignedUsers UserListStructure? - Assigned users

iris.subscriptions: LeademailreceivedeventinfoHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LeadField

Fields

id int? - Field Id

tab int - Field tab Id

label string - Field label

'type string - Field type

length int? - Field size

default string? - Field default value

alignment string? - Field alignment

searchable int? - Searchable field

special string? - Field special value

options LeadfieldOptions? -

'order int? -

readOnly boolean? - Whether the field is read only

required boolean? - Whether the field is required

iris.subscriptions: LeadfieldOptions

Fields

dupecheck boolean? - Enable dupecheck

contactid string? - Id of contact field

mask string? - Field mask

copy LeadfieldOptionsCopy? - Copy button properties

hyperlink boolean? - Enable hyperlink

sms boolean? - Enable SMS

dialer boolean? - Enable dialer

googlemaps record {}? - Google Maps search properties

zipcode_autocomplete LeadfieldOptionsZipcodeAutocomplete? - ZIP Code autofill properties

iris.subscriptions: LeadfieldOptionsCopy

Copy button properties

Fields

title string? - Button label

'from record {}? - Copy from

to record {}? - Copy to

iris.subscriptions: LeadfieldOptionsDropdown

Add new list item

Fields

'key string? - Key

value string? - Value

iris.subscriptions: LeadfieldOptionsZipcodeAutocomplete

ZIP Code autofill properties

Fields

city record {}? - City fields

state record {}? - State fields

zipcode record {}? - Zipcode fields

iris.subscriptions: LeadFieldOrder

Fields

value int - New order position of lead field

'type string? - Type of changing order position

iris.subscriptions: LeadFieldTab

Fields

id int? - Tab Id

active int? - Active tab

position int - Tab position

'class string - Tab class

name string - Tab class

'order int - Tab order

iris.subscriptions: LeadNoteAddedEventInfo

Fields

hook LeadnoteaddedeventinfoHook? -

data LeadnoteaddedeventinfoData? -

iris.subscriptions: LeadnoteaddedeventinfoData

Fields

lead record { note record { id int, name string, pinned boolean, images string[], createdAt string, createdBy UserStructure } }? -

leads record { note record { id int, name string, pinned boolean, images string[], createdAt string, createdBy UserStructure } }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.subscriptions: LeadnoteaddedeventinfoHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LeadRestoredEventInfo

Fields

hook LeadrestoredeventinfoHook? -

data LeadrestoredeventinfoData? -

iris.subscriptions: LeadrestoredeventinfoData

Fields

lead record { restoredAt string, restoredBy UserStructure }? -

leads record { restoredAt string, restoredBy UserStructure }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.subscriptions: LeadrestoredeventinfoHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LeadStatusUpdatedEventInfo

Fields

hook LeadstatusupdatedeventinfoHook? -

data LeadstatusupdatedeventinfoData? -

iris.subscriptions: LeadstatusupdatedeventinfoData

Fields

lead record { previousStatus record { id int, name string }, newStatus record { id int, name string }, statusUpdatedAt string, statusUpdatedBy UserStructure, salesRep UserStructure }? -

leads record { previousStatus record { id int, name string }, newStatus record { id int, name string }, statusUpdatedAt string, statusUpdatedBy UserStructure, salesRep UserStructure }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.subscriptions: LeadstatusupdatedeventinfoHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LeadUpdatedEventInfo

Fields

hook LeadupdatedeventinfoHook? -

data LeadupdatedeventinfoData? -

iris.subscriptions: LeadupdatedeventinfoData

Fields

lead record { updated_at string, updated_by UserStructure }? -

leads record { updated_at string, updated_by UserStructure }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.subscriptions: LeadupdatedeventinfoHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LineItemAdded

Fields

hook LineitemaddedHook? -

data LineitemaddedData? -

iris.subscriptions: LineitemaddedData

Fields

line_items LineItems[]? -

iris.subscriptions: LineitemaddedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: LineItems

Fields

id int? -

'type string? -

item_id int? -

user LineitemsUser? -

merchant LineitemsMerchant? -

related_mid int? -

related_dba string? -

description string? -

income int? -

expense int? -

percentage int? -

agent_net int? -

is_recurring boolean? -

created string? - Created date of line item

modified string? - Last update date of line item

agents LineitemsAgents[]? -

recurring_start_date string? - Date of start recurring line item

recurring_payment_count int? - Count of payments what was already done

recurring_max_payment_count int? - Count of payments which will be done (this will be null if there is no limit)

recurring_period string? -

iris.subscriptions: LineitemsAgents

Fields

user_id int? -

username string? -

full_name string? -

agent_net int? -

percentage int? -

iris.subscriptions: LineitemsMerchant

Fields

mid string? -

dba string? -

iris.subscriptions: LineitemsUser

Fields

user_id int? -

username string? -

full_name string? -

'class string? -

iris.subscriptions: Links

Fields

first string? - An URL to the first page of the data set

last string? - An URL to the last page of the data set

prev string? - An URL to the previous page of the data set

next string? - An URL to the next page of the data set

iris.subscriptions: LinksActivity

Fields

id int? - Activity Id

status string? - Status of link

lead string? - Lead Id

merchant string? - Merchant Id

linkedBy int? - User Id

linkedAt string? - Linking date (Y-m-d\TH:i:sP)

iris.subscriptions: MerchantRow

Fields

merchant string? -

transactions int? -

sales_amount int? -

income int? -

expense int? -

net int? -

bps int? -

users boolean? -

percentage int? -

agent_net int? -

mid int? -

iris.subscriptions: Meta

Fields

current_page int? - The current page number of a data set

'from int? - The current position of a data set

last_page string? - The last page of a data set

path string? - API path

per_page int? - A number of records per page

to int? - The last position in a data set

total int? - Total number of records in a data set

iris.subscriptions: MonetaryBatch

Fields

date string? - Batch date

reference_number string? - Batch description

amount string? - Batch amount

count string? - A number of transactions

terminal_number string? - Batch terminal number

transactions MonetarybatchTransactions[]? -

iris.subscriptions: MonetarybatchTransactions

Fields

id int? - Transaction ID

date string? - Transaction date

'type string? - Transaction type

amount string? - Transaction amount

cardholder string? - Cardholder number

auth_code string? - Transaction auth code

pos_entry_mode string? - POS entry mode

invoice_number string? - Invoice number

void_reject_chargeback boolean? - Is a transaction rejected?

iris.subscriptions: 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

iris.subscriptions: ReportPublished

Fields

hook ReportpublishedHook? -

data ReportpublishedData? -

iris.subscriptions: ReportpublishedData

Fields

reports ReportpublishedDataReports[]? -

iris.subscriptions: ReportpublishedDataReports

Fields

id int? -

month int? -

year int? -

sys_prin int? -

created string? - Ticket created date

created_by UserStructure? -

added_merchants_count int? -

rows_count int? -

revision int? -

deactivated_merchants_count int? -

processor_id int? -

processor_name string? -

sum_transactions int? -

sum_volume decimal? -

sum_net decimal? -

sum_agent_net int? -

iris.subscriptions: ReportpublishedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: ResidualsDetails

Fields

MID string? -

DBA string? -

iris.subscriptions: ResidualTemplate

Fields

id int? -

name string? -

creator_id int? -

creator_name string? -

created_at string? - Created date of template

revision int? -

rules TemplateRules[]? -

iris.subscriptions: ResidualTemplateAssigned

Fields

user_id int? -

username string? -

full_name string? -

templates ResidualtemplateassignedTemplates[]? -

iris.subscriptions: ResidualtemplateassignedTemplates

Fields

id int? -

name string? -

'version int? -

processor_id int? -

rules TemplateRules[]? -

iris.subscriptions: Retrieval

Fields

id int? - Chargeback internal ID

merchant_id string? - Merchant ID

dba string? - Merchant DBA

case_number string? - Case number

retrieval_date string? - Request date

transaction_date string? - Transaction date

amount string? - Amount

respond_due string? - Respond due date

original_amount string? - Original amount of transaction

currency string? - Transaction currency

reason string? - Retrieval case reason

reason_code string? - Retrieval case reason code

card_number string? - Cardholder number

transaction_id string? - Transaction ID

reference_number string? - Transaction ID

case_status string? - Case status

case_status_description string? - Status description

mcc string? - MCC code

dispute_jurisdiction string? - Dispute jurisdiction

card_product_type string? - Card product

transaction_method string? - Transaction method

invoice_number string? - Invoice number

microfilm_number string? - Microfilm number

airline_ticket_number string? - Airline ticket number

order_number string? - Order number

tracking_number string? - Tracking number

last_status_date string? - Date of the last status update

updated_at string? - Date of the most recent update

case_action string? - Case action

action string? - Can the case be viewed of replied

foreign_amount string? - Foreign amount of transaction

transaction_locator string? - Transaction locator

iris.subscriptions: RetrievalAdded

Fields

hook RetrievaladdedHook? -

data RetrievaladdedData? -

iris.subscriptions: RetrievaladdedData

Fields

retrievals RetrievalsReplyResponse[]? -

iris.subscriptions: RetrievaladdedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: RetrievalReminder

Fields

hook RetrievalreminderHook? -

data RetrievalreminderData? -

iris.subscriptions: RetrievalreminderData

Fields

retrievals record { due_in int }[]? -

iris.subscriptions: RetrievalreminderHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: RetrievalReplyCreditIssuedRequest

Fields

credit_date string - Credit transaction date

credit_amount string - Credit transaction amount

user_note string - User note

file string[] - Files to attach

iris.subscriptions: RetrievalReplyResponseRequest

Fields

user_note string - User note

file string[] - Files to attach

iris.subscriptions: RetrievalReplyUnableRequest

Fields

user_note string - User note

file string[] - Files to attach

iris.subscriptions: RetrievalsReplyResponse

Fields

retrieval RetrievalsreplyresponseRetrieval? -

Fields Included from * DisputeDetailsResponse

transactions DisputedetailsresponseTransactions[]
auth_records DisputedetailsresponseTransactions[]
notes DisputedetailsresponseNotes[]
messages DisputedetailsresponseMessages[]
directories DisputedetailsresponseDirectories[]
anydata...

iris.subscriptions: RetrievalsreplyresponseRetrieval

Fields

id string? -

merchant_id string? -

dba string? -

date string? -

transaction_date string? -

amount string? -

reason_code string? -

reason string? -

card_number string? -

case_number string? -

case_action string? -

action string? -

case_status string? -

case_status_description string? -

last_status_date string? -

respond_due string? -

original_amount string? -

updated_at string? -

mcc string? -

dispute_jurisdiction string? -

card_product_type string? -

foreign_amount string? -

transaction_method string? -

transaction_locator string? -

invoice_number string? -

microfilm_number string? -

airline_ticket_number string? -

order_number string? -

tracking_number string? -

iris.subscriptions: RetrievalUpdated

Fields

hook RetrievalupdatedHook? -

data RetrievaladdedData? -

iris.subscriptions: RetrievalupdatedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: ShortLeadSubscription

Fields

id int? - Lead ID

lead_url string? - Lead URL

name string? - Lead Name

email string? - Lead Default Email

contact string? - Lead Default Contact Name

phone string? - Lead Default Contact Phone Number

address LeademailreceivedeventinfoDataAddress? -

assignedUsers UserListStructure? - Assigned users

iris.subscriptions: SignatureGenerated

Fields

hook SignaturegeneratedHook? -

data SignaturegeneratedData? -

iris.subscriptions: SignaturegeneratedData

Fields

signatures SignaturegeneratedDataSignatures[]? -

iris.subscriptions: SignaturegeneratedDataSignatures

Fields

signature SignatureSubscription? -

application ApplicationSubscription? -

lead FullLeadSubscription? -

iris.subscriptions: SignaturegeneratedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: SignatureOpened

Fields

hook SignatureopenedHook? -

data SignaturegeneratedData? -

iris.subscriptions: SignatureopenedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: SignatureSigned

Fields

hook SignaturesignedHook? -

data SignaturegeneratedData? -

iris.subscriptions: SignaturesignedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: SignatureSubscription

Fields

id int? -

hash string? -

url string? -

status string? -

created string? - Signature created date

created_by UserStructure? -

multi_signer boolean? -

completed boolean? -

signers SignaturesubscriptionSigners[]? -

iris.subscriptions: SignaturesubscriptionSigners

Fields

name string? -

email string? -

iris.subscriptions: SourceActivity

Fields

id int? - Activity Id

newValue string? - New value of activity

assignedBy int? - User Id

assignedAt string? - Assigned date (Y-m-d\TH:i:sP)

iris.subscriptions: StatusActivity

Fields

id int? - Activity Id

changedBy int? - User Id

changedAt string? - Deleted date (Y-m-d\TH:i:sP)

oldStatus string? - Old status

old_status_id int? - Old Status Id

newStatus string? - New status

new_status_id int? - New Status Id

iris.subscriptions: SubscriptionCommentEdited

Fields

hook SubscriptioncommenteditedHook? -

data TicketcommentedData? -

iris.subscriptions: SubscriptioncommenteditedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: SummaryResponse

Fields

processor_id int? -

name string? -

created string? -

created_by int? -

modified string? -

modified_by int? -

merchants_count int? -

sum_transactions int? -

sum_sales_amount decimal? -

sum_income decimal? -

sum_expense decimal? -

sum_net decimal? -

sum_bps decimal? -

sum_agent_net int? -

iris.subscriptions: TemplateRules

Fields

column string? -

rule string? -

value int? -

'field string? -

iris.subscriptions: TestSubscription

Fields

hook TestsubscriptionHook? -

data TestsubscriptionData? -

iris.subscriptions: TestsubscriptionData

Fields

message string? -

iris.subscriptions: TestsubscriptionHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: Ticket

Fields

id int? - Ticket id

subject string? - Ticket subject

description string? - Ticket description

status TicketStatus? -

'type TicketType? -

group TicketGroup? -

priority TicketPriority? -

lead_id int? - Assigned Lead ID

mid int? - Assigned Merchant ID

merchantVisible boolean? - Indicates if the ticket is visible to Merchant users

iris.subscriptions: TicketCommented

Fields

hook TicketcommentedHook? -

data TicketcommentedData? -

iris.subscriptions: TicketcommentedData

Fields

comments record { id int, ticketId int, comment string, created string, createdBy UserStructure, modified string, modified_by UserStructure }[]? -

iris.subscriptions: TicketcommentedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: TicketCreated

Fields

hook TicketcreatedHook? -

data TicketcreatedData? -

iris.subscriptions: TicketCreatedBlock

Fields

created string? - Ticket created date

created_by int? - Ticket creator id

iris.subscriptions: TicketcreatedData

Fields

tickets record {}[]? -

iris.subscriptions: TicketcreatedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: TicketDetail

Fields

general File[]? -

checklist ChecklistFullInfo[]? -

iris.subscriptions: TicketGroup

Fields

id int? - Group id

name string? - Group name

iris.subscriptions: TicketPriority

Fields

id int? - Priority id

name string? - Priority name

iris.subscriptions: TicketResolved

Fields

hook TicketresolvedHook? -

data TicketresolvedData? -

iris.subscriptions: TicketresolvedData

Fields

tickets record { created string, created_by UserStructure, modified string, modified_by UserStructure, last_comment string, resolved string, resolved_by UserStructure }[]? -

iris.subscriptions: TicketresolvedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: TicketStatus

Fields

id int? - Status id

name string? - Status name

iris.subscriptions: TicketSubscriptionData

Fields

ticket_url string? -

assignedUsers UserListStructure? - Assigned users

files File[]? -

preview_images File[]? -

due_date string? - Ticket due date

due string? - Ticket SLA

only_business_days boolean? - Calculate only business days

iris.subscriptions: TicketType

Fields

id int? - Type id

name string? - Ticket type

iris.subscriptions: TicketTypeRequest

Fields

name string? - Ticket type name

description string? - Ticket type description

daysToResolve int? - Days to Resolve

only_business_days boolean? - Calculate only business days

status string? - Status

priority int? - Priority (0 - Normal, 1 - Medium, 2 - Rush)

permissions int[]? -

assignees BrieftickettypeinfoAssignees? -

iris.subscriptions: TicketUpdated

Fields

hook TicketupdatedHook? -

data TicketupdatedData? -

iris.subscriptions: TicketupdatedData

Fields

tickets record { modified string, modified_by UserStructure, last_comment string }[]? -

iris.subscriptions: TicketupdatedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: TurboAppApproved

Fields

hook TurboappapprovedHook? -

data TurboappapprovedData? -

iris.subscriptions: TurboappapprovedData

Fields

accounts TurboappapprovedDataAccounts[]? -

iris.subscriptions: TurboappapprovedDataAccounts

Fields

id int? - Account ID

application_url string? - Application URL

identifier string? - Application identifier

processor string? - Processor name

dba string? - Merchant name

mid int? - Merchant ID

lid int? - Lead ID related to the application

activation_status TurboappupdatedDataActivationStatus? -

application_status TurboappupdatedDataActivationStatus? -

contact_name string? -

contact_address string? -

contact_phone string? -

salesman string? -

co_name string? -

approved_at string? - Date and time of account approve (ISO 8601)

legal_name string? - Merchant name

comments TurboappupdatedDataComments? -

entitlements TurboappapprovedDataEntitlements? -

users string[]? -

date_submitted string? - Date and time of account submit (ISO 8601)

date_decision string? - Date and time of decision (ISO 8601)

mcc_code string? - MCC code

annual_sales string? - Annual sales

average_ticket string? - Average ticket

tier string? -

tier_status string? -

iris.subscriptions: TurboappapprovedDataEntitlements

Fields

card_type string? -

srv string? -

proc_flag string? -

iris.subscriptions: TurboappapprovedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: TurboAppDeclined

Fields

hook TurboappdeclinedHook? -

data TurboappdeclinedData? -

iris.subscriptions: TurboappdeclinedData

Fields

accounts TurboappdeclinedDataAccounts[]? -

iris.subscriptions: TurboappdeclinedDataAccounts

Fields

id int? - Account ID

application_url string? - Application URL

identifier string? - Application identifier

processor string? - Processor name

dba string? - Merchant name

mid int? - Merchant ID

lid int? - Lead ID related to the application

activation_status TurboappdeclinedDataActivationStatus? -

application_status TurboappdeclinedDataActivationStatus? -

contact_name string? -

contact_address string? -

contact_phone string? -

salesman string? -

co_name string? -

declined_at string? - Date and time of account was declined (ISO 8601)

legal_name string? - Merchant name

comments TurboappdeclinedDataComments? -

entitlements TurboappapprovedDataEntitlements? -

users string[]? -

date_submitted string? - Date and time of account submit (ISO 8601)

date_decision string? - Date and time of decision (ISO 8601)

mcc_code string? - MCC code

annual_sales string? - Annual sales

average_ticket string? - Average ticket

tier string? -

tier_status string? -

iris.subscriptions: TurboappdeclinedDataActivationStatus

Fields

old string? -

'new string? -

iris.subscriptions: TurboappdeclinedDataComments

Fields

date string? - Date and time of comment (ISO 8601)

co string? -

text string? -

iris.subscriptions: TurboappdeclinedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: TurboAppSubmited

Fields

hook TurboappsubmitedHook? -

data TurboappsubmitedData? -

iris.subscriptions: TurboappsubmitedData

Fields

applications TurboappsubmitedDataApplications[]? -

iris.subscriptions: TurboappsubmitedDataApplications

Fields

id int? - Application ID

application_url string? - Application URL

identifier string? - Application identifier

submission_id string? - Application submission identifier

dba string? - Merchant name

lid int? - Lead ID related to the application

createdAt string? - Date and time of creation (ISO 8601)

createdBy UserStructure? -

finishedAt string? - Date and time of submission (ISO 8601)

finishedBy UserStructure? -

iris.subscriptions: TurboappsubmitedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: TurboAppUpdated

Fields

hook TurboappupdatedHook? -

data TurboappupdatedData? -

iris.subscriptions: TurboappupdatedData

Fields

accounts TurboappupdatedDataAccounts[]? -

iris.subscriptions: TurboappupdatedDataAccounts

Fields

id int? - Account ID

application_url string? - Application URL

identifier string? - Application identifier

dba string? - Merchant name

mid int? - Merchant ID

lid int? - Lead ID related to the application

comments TurboappupdatedDataComments? -

activation_status TurboappupdatedDataActivationStatus? -

application_status TurboappupdatedDataActivationStatus? -

contact_name string? -

salesman string? -

updatedAt string? - Date and time of account update (ISO 8601)

iris.subscriptions: TurboappupdatedDataActivationStatus

Fields

old string? -

'new string? -

iris.subscriptions: TurboappupdatedDataComments

Fields

date string? - Date and time of comment (ISO 8601)

co string? -

text string? -

iris.subscriptions: TurboappupdatedHook

Fields

requestId int? - Request ID

event string? - Event ID

iris.subscriptions: TypeDetail

Fields

general BriefTicketTypeInfo? -

checklist ChecklistFullInfo[]? -

iris.subscriptions: UserStructure

Fields

id int? - User ID

name string? - User Name

userClass string? - User Class

Import

import ballerinax/iris.subscriptions;

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Sales & CRM/Customer Relationship Management

Cost/Paid

Contributors

Other versions

1.5.1

1.5.0 1.4.0 1.2.0 1.1.0

Dependencies

ballerina/url/2.2.3 ballerina/http/2.6.1

Cookie policy

Delete policy

clients

records

ballerinax/iris.subscriptions Ballerina library

Overview

Prerequisites

Quickstart

Step 1: Import connector

Step 2: Create a new connector instance

Step 3: Invoke connector operation

Clients

iris.subscriptions: Client

Constructor

getSubscriptions

Parameters

Return Type

createSubscription

Parameters

Return Type

getSubscriptionsById

Parameters

Return Type

deleteSubscription

Parameters

Return Type

updateSubscription

Parameters

Return Type

testPayloadForCheckingServerResponse

Return Type

receiveNotificationWhenApiUpdated

Return Type

receiveNotificationWhenLeadCreated

Return Type

receiveNotificationWhenLeadUpdated

Return Type

receiveNotificationWhenLeadDeleted

Return Type

receiveNotificationWhenLeadRestored

Return Type

receiveNotificationWhenLeadStatusUpdated

Return Type

receiveNotificationWhenLeadEsignatureGenerated

Return Type

receiveNotificationWhenLeadEsignatureOpened

Return Type

receiveNotificationWhenLeadEsignatureSigned

Return Type

receiveNotificationWhenLeadNoteAdded

Return Type

receiveNotificationWhenLeadDocumentUploaded

Return Type

receiveNotificationWhenLeadEmailReceived

Return Type

receiveNotificationWhenTurboAppSubmitted

Return Type

receiveNotificationWhenTurboAppUpdated

Return Type

receiveNotificationWhenTurboAppApproved

Return Type

receiveNotificationWhenTurboAppDeclined

Return Type

receiveNotificationWhenTurboAppCreated

Return Type

receiveNotificationWhenTicketUpdated

Return Type

receiveNotificationWhenTicketResolved

Return Type

receiveNotificationWhenTicketCommented

Return Type

receiveNotificationWhenTicketCommentEdited

Return Type

receiveNotificationWhenReportPublished

Return Type

receiveNotificationWhenLineItemAdded

Return Type

receiveNotificationWhenChargebackAdded

Return Type

receiveNotificationWhenChargebackUpdated

Return Type

receiveNotificationForChargebackReminder