iris-crm/php-sdk

PHP SDK for IRIS CRM

Maintainers

Details

github.com/iris-crm/php-sdk

Homepage

Source

Issues

Installs: 5 877

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 0

Forks: 2

Open Issues: 0

dev-master 2022-08-30 06:03 UTC

Requires

Requires (Dev)

proprietary 1aea3e8d8a5a2df3aa94f8ab3956eabcabe3211c

phpapisdkswagger

This package is auto-updated.

Last update: 2025-04-23 20:59:57 UTC

README

Welcome to IRIS’s API!

The API is organized around REST. All requests should be made over SSL.

All request and response bodies, including errors, are encoded in JSON.

Open API

The Open API provides numerous functions to access or to update your CRM lead and merchant data using simple REST calls.

You can use the E-Signature API to:

  • Generate an e-signature document

  • Send an e-signature document

  • Download an e-signature document

  • Get a list of all lead e-signatures documents

  • Get a list of available applications

  • Create a new application field mapping

  • Get a list of available application field mappings

  • Get an application field mapping list

  • Update an application field mapping

  • Delete an application field mapping

You can use the Helpdesk API to:

  • Create a new ticket

  • Get a list of helpdesk tickets

  • Add a ticket comment

  • Get detailed ticked information

  • Update a ticket

  • Delete a ticket

  • Upload an attachment to a ticket, comment, checklist, or ticket type

  • Download an attachment from a ticket

  • Create a new helpdesk ticket type

  • Get a list of helpdesk ticket types

  • Get details for a helpdesk ticket type

  • Update a helpdesk ticket type

  • Delete a ticket type

  • Download an attachment from a ticket type

  • Get a list of available users to notify and assign

You can use the Lead API to:

  • Create a lead

  • Get a list of leads

  • Get detailed lead information

  • Update a lead

  • Create a new lead field

  • Get a list of available lead fields

  • Get a lead field

  • Update a lead field

  • Update a lead field order position

  • Create a lead field tab

  • Get a list of all lead field tabs

  • Get a lead field tab

  • Update a lead field tab

  • Create a lead note

  • Get lead notes

  • Create a lead appointment

  • Get lead appointments

  • Populate PDF Document

  • Create a lead task

  • Get lead tasks

  • Assign a user

  • Get a list of assigned users

  • Unassign a user from a lead

  • Upload a document

  • Get a list of available documents

  • Get a list of available document labels

  • Download a document

  • Send an email to lead with template

  • Get a list of email templates

  • Download a mailbox email attachment

  • Send an SMS to lead with selected SMS template

  • Get list of SMS templates

  • Get a list of all lead campaign activity

  • Get a list of all lead deletion activity

  • Get a list of all lead duplicate activity

  • Get a list of all lead links activity

  • Get a list of all lead source activity

  • Get a list of all lead status activity

  • Get a list of available campaigns

  • Get a list of available groups

  • Get a list of available sources

  • Get a list of available statuses

  • Get a list of available users

You can use the Merchant API to:

  • Get a list of merchants

  • Get detailed merchant information

  • Update an existing merchant

  • Get a list of batches and transactions

  • Get a list of chargebacks

  • Get a list of retrievals

  • Get a list of statements

  • Download a statement

You can use the Residuals API to:

  • Get residuals summary data

  • Get residuals summary with merchant rows

  • Get residuals details with merchant rows

  • Get residuals line items

  • Get residuals templates

  • Get a list of users with assigned residuals templates

Generate an API token

When you send an API request, you will need to include an API token in your request in order to authenticate your account.

The tokens are generated in the CRM by each user individually, and each user may create one or more tokens.

To generate a new API Token, open your user settings page by clicking on your username in the top-right corner, and clicking on the ** Settings ** link or you can use the link.

Then open the ** API Settings ** tab, click ** Create New API Token **, configure your token’s settings as needed, and click ** Add New Token **:

Your new token will now be created and displayed in a popup window:

Once the token is created, it will be shown in the list of available API Tokens where you can copy the token, update its settings, or delete it once it’s no longer needed:

** Note: ** The created tokens will inherit the user’s permissions to assigned merchants, leads, groups and processors.

Using the API

Authentication to the API is performed via X-API-KEY header. Requests not properly authenticated will return a 401 error code.

curl -X GET "https://iriscrm.com/api/v1/merchants/[MID HERE]" -H "accept: application/json" -H "X-API-KEY: [YOURKEY]"

Note that all requests should be made over SSL. All request and response bodies, including errors, are encoded in JSON.

The API returns standard HTTP success or error status codes. In case of errors, additional information about what went wrong will be encoded in the response as JSON.

By default, you can make 120 requests per minute. Check the returned HTTP headers of any API request to see your current rate limit status.

Using the Subscription API

API Subscriptions are used to send information about an event to a URL and trigger an API call. This is more efficient than doing scheduled API calls.

To create a subscription, use the API Settings page or send a request using the instructions in the Subscriptions section below.

All you need to know is the events you want to be subscribed for and the url to which the updates need to be sent.

To create subscriptions using our GUI open tab ** API Settings ** at ** https://iriscrm.com/settings **:

Authentication

Authenticate your account by including your secret key in API requests. Do not share your secret API keys in publicly accessible areas, client-side code, and so forth. Authentication to the API is performed via X-API-KEY header. Requests not properly authenticated will return a 401 error code.

Errors

Our API returns standard HTTP success or error status codes. For errors, we will also include extra information about what went wrong encoded in the response as JSON.

Limiting

You can make 120 requests per minute. If you will reach a limit you will get a 429: Too Many Attempts. response from the server. Check the returned HTTP headers of any API request to see your current rate limit status.

Headers description:

  • X-RateLimit-Limit tells you the max number of requests you're allowed to make within this application's time period

  • X-RateLimit-Remaining tells you how many requests you have left within this current time period

  • Retry-After tells you how many seconds to wait until you try again. (you'll only get Retry-After if you've hit the limit).

Change Log

1.6.0 (2021-03-02)

Created:

  • Added Get pricing templates endpoint

1.5.20 (2021-02-12)

Updated:

  • Added filename property to the lead.document.uploaded subscription response

1.5.19 (2021-02-17)

Updated:

  • Added deposits endpoint

  • Added authorization_code property to the chargeback response

1.5.18 (2021-01-14)

Updated:

  • Added id and invoice_number properties to the transactions section of the transactions response

1.5.16 (2020-12-11)

Updated:

  • Renamed task priority from "Low" to "Normal"

1.5.15 (2021-01-18)

Updated:

  • Added due value for sort_by and date_filter parameters on the get a list of Tickets endpoint

  • Added due parameter on the get a list of Tickets endpoint

  • Added due parameter on the get detailed information of Tickets endpoint

  • Added only_business_days parameter on the get a list of Tickets endpoint

  • Added only_business_days parameter on the get detailed information of Tickets endpoint

  • Added only_business_days property to the Ticket on the Ticket create endpoint

  • Added only_business_days property to the Ticket on the Ticket update endpoint

  • Added only_business_days property to the Ticket Type on the get a list of Ticket Type endpoint

  • Added only_business_days parameter on the get detailed information of Ticket Type endpoint

  • Added only_business_days property to the Ticket Type on the Ticket Type create endpoint

  • Added only_business_days property to the Ticket Type on the Ticket Type update endpoint

  • Added attached_files property to the Ticket on the Ticket create endpoint

  • Added attached_files property to the Ticket Checklist on the Ticket create endpoint

  • Added attached_files property to the Ticket Checklist on the Ticket update endpoint

  • Added attached_files property to the Ticket Comment on the Comment create endpoint

1.5.14 (2020-11-26)

Updated:

  • Added template_id, completed_by, and completed_at properties to the checklist section of the ticket create response

  • Added template_id, completed_by, and completed_at properties to the checklist section of ticket details response

  • Added template_id, completed_by, and completed_at properties to the checklist section of ticket update response

  • Added template_id, completed_by, and completed_at properties to the checklist section of ticket's checklist updated subscription response

1.5.13 (2020-11-20)

Updated:

  • Added priority property to the Ticket Type on the Ticket Type create endpoint

  • Added priority property to the Ticket Type on the Ticket Type update endpoint

1.5.12 (2020-11-02)

Updated:

  • Changed due_date property to the datetime format on the ticket create endpoint

  • Changed due_date property to the datetime format on the ticket update endpoint

1.5.11 (2020-10-20)

Updated:

  • Added notify_assigned_users property for ticket creation payload.

1.5.10 (2020-10-19)

Updated:

  • Added group_id property for ticket creation payload.

  • Added group_id property for ticket update payload.

1.5.9 (2020-11-02)

Updated:

  • Added new_files property for ticket update payload.

  • Added new_files property for ticket type update payload.

1.5.8 (2020-10-20)

Updated:

  • Added preview_images property for ticket request and response data.

  • Added preview_images property for ticket comment request and response data.

  • Added preview_images property for ticket and ticket comment properties.

  • Added preview_images property for ticket request and response data.

1.5.7 (2020-10-05)

Updated:

  • Added notify_assigned_users property for ticket creation payload.

1.5.5 (2020-07-23)

Updated:

  • Added endpoint with file labels what can be used for document upload.

1.5.5 (2020-10-20)

Updated:

  • Added endpoint with file labels what can be used for document upload.

1.5.4 (2020-07-13)

Updated:

  • Added files_count property to the ticket create endpoint response.

  • Added files_count property to the response of ticket list endpoint.

  • Added files_count property to the response of ticket detailed information endpoint.

  • Added files_count property to the ticket update endpoint response.

  • Added files_count property to the ticket.created subscription data.

  • Added files_count property to the ticket.updated subscription data.

  • Added files_count property to the ticket.resolved subscription data.

  • Added files_count property to the ticket.checklist.updated subscription data.

1.5.3 (2020-07-06)

Updated:

  • Added search filter to the tickets list endpoint.

1.5.2 (2020-07-10)

Updated:

  • Added due_date property to the ticket create endpoint request and response.

  • Added due_date property to the response of ticket list endpoint.

  • Added due_date property to the response of ticket detailed information endpoint.

  • Added due_date property to the ticket update endpoint request and response.

  • Added due_date property to the ticket.created subscription data.

  • Added due_date property to the ticket.updated subscription data.

  • Added due_date property to the ticket.resolved subscription data.

  • Added due_date property to the ticket.checklist.updated subscription data.

1.5.1 (2020-08-10)

Created:

  • Added a Residuals API to work with your residuals reports.

1.4.9 (2020-06-26)

Updated:

  • Added hide_resolved filter to the tickets list endpoint.

1.4.8 (2020-06-12)

Updated:

  • Added set_for, set_at, set_by, modified, modified_by, date_end, confirmed_by, seen_by, rescheduled, rescheduled_by, and rescheduled_count properties to the lead appointments endpoint response.

  • Added set_for, set_by, modified_by, confirmed_by, seen_by, rescheduled_by, rescheduled_count, date_filter, start_date, end_date, and done filters to the lead appointments endpoint.

  • Added sorting to the lead appointments endpoint.

  • Marked user property as deprecated on the lead appointments endpoint response.

1.4.7 (2020-05-13)

Updated:

  • Added old_status_id to lead status activity endpoint.

  • Added new_status_id to lead status activity endpoint.

1.4.6 (2020-05-01)

Created:

  • Added lead.signature.generated subscription endpoint.

  • Added lead.signature.opened subscription endpoint

  • Added lead.signature.signed subscription endpoint

Updated:

  • Added createdAt and createdBy properties to the lead.updated subscription endpoint

  • Added email, contact, phone and address properties to the lead.deleted subscription endpoint

  • Added email, contact, phone and address properties to the lead.restored subscription endpoint

  • Added createdAt and createdBy properties to the lead.status.updated subscription endpoint

1.4.5 (2020-04-21)

Updated:

  • Added files property to the ticket creation details endpoint response.

  • Added file property for each checklist item in the ticket creation details endpoint response.

  • Added files property to the Helpdesk tickets details endpoint.

  • Added files property for each comment in the Helpdesk tickets details endpoint.

  • Added file property for each checklist item in the Helpdesk tickets details endpoint.

  • Added files property to the Helpdesk ticket update endpoint.

  • Added files property for each comment in the Helpdesk ticket update endpoint.

  • Added file property for each checklist item in the Helpdesk ticket update endpoint

  • Added file property for each checklist item in the ticket type creation details endpoint response.

  • Added file property for each checklist item on the ticket type endpoint.

  • Added file property for each checklist item on the ticket type update endpoint.

  • Added files property for ticket created subscription.

  • Added files property for ticket updated subscription.

  • Added files property for ticket resolved subscription.

  • Added files property for ticket commented subscription.

  • Added files property for ticket checklist updated subscription.

  • Added file property for each checklist item on checklist updated subscription.

Created:

  • Added endpoint for download attachments from Ticket Type

1.4.4 (2020-04-02)

Updated:

  • Added resolver filter to the Helpdesk tickets endpoint.

1.4.3 (2020-04-01)

Updated:

  • Added status_updated option for date_filter filter to the Helpdesk tickets endpoint.

1.4.2 (2020-03-27)

Updated:

  • Added lid filter to the Helpdesk tickets endpoint.

  • Added mid filter to the Helpdesk tickets endpoint.

1.4.1 (2020-03-20)

Updated:

  • Added hash and url properties to the 'Send an e-signature document' endpoint.

1.4.0 (2020-03-05)

Updated:

  • Added assigned_users, lead_url properties to the subscriptions response for the lead.created subscription.

  • Added assigned_users, lead_url properties to the subscriptions response for the lead.updated subscription.

  • Added assigned_users, lead_url properties to the subscriptions response for the lead.deleted subscription.

  • Added assigned_users, lead_url properties to the subscriptions response for the lead.restored subscription.

  • Added assigned_users, lead_url properties to the subscriptions response for the lead.status.updated subscription.

  • Added assigned_users, lead_url properties to the subscriptions response for the lead.note.added subscription.

  • Added assigned_users, lead_url properties to the subscriptions response for the lead.document.uploaded subscription.

  • Added assigned_users, lead_url properties to the subscriptions response for the lead.email.received subscription.

  • Added ticket_url and assigned_users properties to the subscriptions response for the ticket.created subscription.

  • Added ticket_url and assigned_users properties to the subscriptions response for the ticket.updated subscription.

  • Added ticket_url and assigned_users properties to the subscriptions response for the ticket.resolved subscription.

  • Added ticket_url and assigned_users properties to the subscriptions response for the ticket.commented subscription.

  • Added ticket_url and assigned_users properties to the subscriptions response for the ticket.checklist.updated subscription.

  • Added application_url, identifier and lid properties to the subscriptions response for the turboapp.submitted subscription.

  • Added application_url, identifier and lid properties to the subscriptions response for the turboapp.updated subscription.

  • Added application_url, identifier and lid properties to the subscriptions response for the turboapp.approved subscription.

  • Added application_url, identifier and lid properties to the subscriptions response for the turboapp.declined subscription.

  • Changed all subscriptions dates properties to the snake case

1.3.5 (2020-02-26)

Created:

  • Added a Helpdesk API to work with your helpdesk data.

1.3.4 (2020-02-25)

Updated:

  • Added a lid property to the "turboapp.submitted" subscription.

1.3.3 (2020-02-24)

Updated:

  • Added a salesRep parameter to 'lead.status.updated' subscription.

1.3.2 (2019-11-21)

Updated:

  • Added a expire parameter to 'Generate an e-signature document' endpoint.

  • Added the ability to add multiple signers to the document and added an expire parameter to 'Send an e-signature document' endpoint.

1.3.1 (2019-11-18)

Updated:

  • Rename subscriptions from "application.created" to "turboapp.submitted" and "application.updated" to "turboapp.updated".

Created:

  • Added new subscriptions for "turboapp.approved" event.

  • Added new subscriptions for "turboapp.declined" event.

1.2.2 (2019-09-03)

Updated:

  • Added a per_page property to all list endpoints.

1.2.1 (2019-08-26)

Updated:

  • Added a leads property to merchants endpoint.

1.2.0 (2019-07-26)

Updated:

  • The endpoint for creating API subscriptions has been updated. Status based options have been added to some events.

  • The endpoint for updating API subscriptions has been updated. Status based options have been added to some events.

1.1.0 (2019-07-24)

Created:

  • Added an endpoint for getting SMS templates.

  • Added new subscriptions for application.created event

  • Added new subscriptions for application.updated event

Updated:

  • Added a sic_code property to merchants endpoint

1.0.0 (2019-06-20)

Created:

  • Added change log.

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, please run:

composer require iris-crm/php-sdk

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$page = 56; // int | Page number
$per_page = 56; // int | Count of records per page

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsGet($app_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$map_id = 56; // int | Mapping Id

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsMapIdDelete($app_id, $map_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsMapIdDelete: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$map_id = 56; // int | Mapping Id

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsMapIdGet($app_id, $map_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsMapIdGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$map_id = 56; // int | Mapping Id
$body = new \Swagger\Client\Model\ApplicationField(); // \Swagger\Client\Model\ApplicationField | 

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsMapIdPatch($app_id, $map_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsMapIdPatch: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$body = new \Swagger\Client\Model\ApplicationField(); // \Swagger\Client\Model\ApplicationField | 

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsPost($app_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsPost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->leadsApplicationsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$lead_id = 56; // int | Lead Id
$application_id = 56; // int | Application Id
$body = new \Swagger\Client\Model\Body9(); // \Swagger\Client\Model\Body9 | 

try {
    $result = $apiInstance->leadsLeadIdSignaturesApplicationIdGeneratePost($lead_id, $application_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsLeadIdSignaturesApplicationIdGeneratePost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$lead_id = 56; // int | Lead Id
$application_id = 56; // int | Application Id
$body = new \Swagger\Client\Model\Body10(); // \Swagger\Client\Model\Body10 | 

try {
    $result = $apiInstance->leadsLeadIdSignaturesApplicationIdSendPost($lead_id, $application_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsLeadIdSignaturesApplicationIdSendPost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$lead_id = 56; // int | Lead Id
$page = 56; // int | Page number
$per_page = 56; // int | Count of records per page

try {
    $result = $apiInstance->leadsLeadIdSignaturesGet($lead_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsLeadIdSignaturesGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$application_id = 56; // int | Application Id

try {
    $result = $apiInstance->leadsSignaturesApplicationIdDownloadGet($application_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsSignaturesApplicationIdDownloadGet: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://iriscrm.com/api/v1

Class Method HTTP request Description
ESignatureApi leadsApplicationsAppIdMappingsGet GET /leads/applications/{appId}/mappings Get a list of available application field mappings
ESignatureApi leadsApplicationsAppIdMappingsMapIdDelete DELETE /leads/applications/{appId}/mappings/{mapId} Delete an application field mapping
ESignatureApi leadsApplicationsAppIdMappingsMapIdGet GET /leads/applications/{appId}/mappings/{mapId} Get an application field mapping list
ESignatureApi leadsApplicationsAppIdMappingsMapIdPatch PATCH /leads/applications/{appId}/mappings/{mapId} Update an application field mapping
ESignatureApi leadsApplicationsAppIdMappingsPost POST /leads/applications/{appId}/mappings Create a new application field mapping
ESignatureApi leadsApplicationsGet GET /leads/applications Get a list of available applications
ESignatureApi leadsLeadIdSignaturesApplicationIdGeneratePost POST /leads/{leadId}/signatures/{applicationId}/generate Generate an e-signature document
ESignatureApi leadsLeadIdSignaturesApplicationIdSendPost POST /leads/{leadId}/signatures/{applicationId}/send Send an e-signature document
ESignatureApi leadsLeadIdSignaturesGet GET /leads/{leadId}/signatures Get a list of all lead e-signatures documents
ESignatureApi leadsSignaturesApplicationIdDownloadGet GET /leads/signatures/{applicationId}/download Download an e-signature document
HelpdeskApi helpdeskFilePost POST /helpdesk/file Upload an attachment to a ticket, comment, checklist, or ticket type
HelpdeskApi helpdeskGet GET /helpdesk Get a list of helpdesk tickets
HelpdeskApi helpdeskPost POST /helpdesk Create a new ticket
HelpdeskApi helpdeskTicketIdAssignmentsGet GET /helpdesk/{ticketId}/assignments Get ticked assignment logs
HelpdeskApi helpdeskTicketIdCommentPost POST /helpdesk/{ticketId}/comment Add a ticket comment
HelpdeskApi helpdeskTicketIdDelete DELETE /helpdesk/{ticketId} Delete a ticket
HelpdeskApi helpdeskTicketIdDownloadAttachmentIdGet GET /helpdesk/{ticketId}/download/{attachmentId} Download an attachment from a ticket
HelpdeskApi helpdeskTicketIdGet GET /helpdesk/{ticketId} Get detailed ticked information
HelpdeskApi helpdeskTicketIdPatch PATCH /helpdesk/{ticketId} Update a ticket
HelpdeskApi helpdeskTypesGet GET /helpdesk/types Get a list of helpdesk ticket types
HelpdeskApi helpdeskTypesPost POST /helpdesk/types Create a new helpdesk ticket type
HelpdeskApi helpdeskTypesTypeIdDelete DELETE /helpdesk/types/{typeId} Delete a ticket type
HelpdeskApi helpdeskTypesTypeIdDownloadAttachmentIdGet GET /helpdesk/types/{typeId}/download/{attachmentId} Download an attachment from a ticket type
HelpdeskApi helpdeskTypesTypeIdGet GET /helpdesk/types/{typeId} Get details for a helpdesk ticket type
HelpdeskApi helpdeskTypesTypeIdPatch PATCH /helpdesk/types/{typeId} Update a helpdesk ticket type
HelpdeskApi helpdeskUsersGet GET /helpdesk/users Get a list of available users to notify and assign
LeadsApi leadsCampaignsGet GET /leads/campaigns Get a list of available campaigns
LeadsApi leadsEmailsTemplatesGet GET /leads/emails/templates Get a list of email templates
LeadsApi leadsFieldsFieldIdGet GET /leads/fields/{fieldId} Get a lead field
LeadsApi leadsFieldsFieldIdOrderPatch PATCH /leads/fields/{fieldId}/order Update a lead field order position
LeadsApi leadsFieldsFieldIdPatch PATCH /leads/fields/{fieldId} Update a lead field
LeadsApi leadsFieldsGet GET /leads/fields Get a list of available lead fields
LeadsApi leadsFieldsPost POST /leads/fields Create a new lead field
LeadsApi leadsFieldsTabsGet GET /leads/fields/tabs Get a list of all lead field tabs
LeadsApi leadsFieldsTabsPost POST /leads/fields/tabs Create a lead field tab
LeadsApi leadsFieldsTabsTabIdGet GET /leads/fields/tabs/{tabId} Get a lead field tab
LeadsApi leadsFieldsTabsTabIdPatch PATCH /leads/fields/tabs/{tabId} Update a lead field tab
LeadsApi leadsFileLabelsGet GET /leads/file_labels Get a list of available document labels
LeadsApi leadsGet GET /leads Get a list of leads
LeadsApi leadsGroupsGet GET /leads/groups Get a list of available groups
LeadsApi leadsLeadIdActivityCampaignGet GET /leads/{leadId}/activity/campaign Get a list of all lead campaign activity
LeadsApi leadsLeadIdActivityDeletionGet GET /leads/{leadId}/activity/deletion Get a list of all lead deletion activity
LeadsApi leadsLeadIdActivityDuplicatesGet GET /leads/{leadId}/activity/duplicates Get a list of all lead duplicate activity
LeadsApi leadsLeadIdActivityLinksGet GET /leads/{leadId}/activity/links Get a list of all lead links activity
LeadsApi leadsLeadIdActivitySourceGet GET /leads/{leadId}/activity/source Get a list of all lead source activity
LeadsApi leadsLeadIdActivityStatusGet GET /leads/{leadId}/activity/status Get a list of all lead status activity
LeadsApi leadsLeadIdApplicationsApplicationIdPopulatePost POST /leads/{leadId}/applications/{applicationId}/populate Populate PDF Document
LeadsApi leadsLeadIdAppointmentsGet GET /leads/{leadId}/appointments Get lead appointments
LeadsApi leadsLeadIdAppointmentsPost POST /leads/{leadId}/appointments Create a lead appointment
LeadsApi leadsLeadIdDocumentsDocumentIdGet GET /leads/{leadId}/documents/{documentId} Download a document
LeadsApi leadsLeadIdDocumentsGet GET /leads/{leadId}/documents Get a list of available documents
LeadsApi leadsLeadIdDocumentsPost POST /leads/{leadId}/documents Upload a document
LeadsApi leadsLeadIdEmailsTemplateIdPost POST /leads/{leadId}/emails/{templateId} Send an email to lead with template
LeadsApi leadsLeadIdGet GET /leads/{leadId} Get detailed lead information
LeadsApi leadsLeadIdMailboxEmailIdAttachmentAttachmentIdGet GET /leads/{leadId}/mailbox/{emailId}/attachment/{attachmentId} Download a mailbox email attachment
LeadsApi leadsLeadIdNotesGet GET /leads/{leadId}/notes Get lead notes
LeadsApi leadsLeadIdNotesPost POST /leads/{leadId}/notes Create a lead note
LeadsApi leadsLeadIdPatch PATCH /leads/{leadId} Update a lead
LeadsApi leadsLeadIdSmsTemplateIdPost POST /leads/{leadId}/sms/{templateId} Send an SMS to lead with selected SMS template
LeadsApi leadsLeadIdTasksGet GET /leads/{leadId}/tasks Get lead tasks
LeadsApi leadsLeadIdTasksPost POST /leads/{leadId}/tasks Create a lead task
LeadsApi leadsLeadIdUsersGet GET /leads/{leadId}/users Get a list of assigned users
LeadsApi leadsLeadIdUsersPost POST /leads/{leadId}/users Assign a user
LeadsApi leadsLeadIdUsersUserIdDelete DELETE /leads/{leadId}/users/{userId} Unassign a user from a lead
LeadsApi leadsPost POST /leads Create a lead
LeadsApi leadsPricingTemplatesGet GET /leads/pricing_templates Get pricing templates
LeadsApi leadsSmsTemplatesGet GET /leads/sms/templates Get list of SMS templates
LeadsApi leadsSourcesGet GET /leads/sources Get a list of available sources
LeadsApi leadsStatusesGet GET /leads/statuses Get a list of available statuses
LeadsApi leadsUsersGet GET /leads/users Get a list of available users
MerchantsApi merchantsGet GET /merchants Get a list of merchants
MerchantsApi merchantsMerchantNumberChargebacksGet GET /merchants/{merchantNumber}/chargebacks Get a list of chargebacks
MerchantsApi merchantsMerchantNumberDepositsYearMonthGet GET /merchants/{merchantNumber}/deposits/{year}/{month} Get a list of deposits records and totals
MerchantsApi merchantsMerchantNumberGet GET /merchants/{merchantNumber} Get detailed merchant information
MerchantsApi merchantsMerchantNumberPatch PATCH /merchants/{merchantNumber} Update an existing merchant
MerchantsApi merchantsMerchantNumberRetrievalsGet GET /merchants/{merchantNumber}/retrievals Get a list of retrievals
MerchantsApi merchantsMerchantNumberStatementsGet GET /merchants/{merchantNumber}/statements Get a list of statements
MerchantsApi merchantsMerchantNumberStatementsStatementIdGet GET /merchants/{merchantNumber}/statements/{statementId} Download a statement
MerchantsApi merchantsMerchantNumberTransactionsGet GET /merchants/{merchantNumber}/transactions Get a list of batches and transactions
ResidualsApi residualsLineitemsYearMonthGet GET /residuals/lineitems/{year}/{month} Get residuals line items
ResidualsApi residualsReportsDetailsProcessorIdYearMonthGet GET /residuals/reports/details/{processor_id}/{year}/{month} Get residuals details with merchant rows
ResidualsApi residualsReportsSummaryRowsProcessorIdYearMonthGet GET /residuals/reports/summary/rows/{processor_id}/{year}/{month} Get residuals summary with merchant rows
ResidualsApi residualsReportsSummaryYearMonthGet GET /residuals/reports/summary/{year}/{month} Get residuals summary data
ResidualsApi residualsTemplatesAssignedYearMonthGet GET /residuals/templates/assigned/{year}/{month} Get a list of users with assigned residuals templates
ResidualsApi residualsTemplatesGet GET /residuals/templates/ Get residuals templates
SubscriptionsApi subscriptionsGet GET /subscriptions Return a list of subscriptions
SubscriptionsApi subscriptionsPost POST /subscriptions Create a subscription
SubscriptionsApi subscriptionsSampleApiUpdatedGet GET /subscriptions/sample/api.updated Receive a notification when this API is updated
SubscriptionsApi subscriptionsSampleLeadCreatedGet GET /subscriptions/sample/lead.created 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
SubscriptionsApi subscriptionsSampleLeadDeletedGet GET /subscriptions/sample/lead.deleted Receive a notification when a lead in this CRM is deleted
SubscriptionsApi subscriptionsSampleLeadDocumentUploadedGet GET /subscriptions/sample/lead.document.uploaded Receive a notification when a lead document is uploaded
SubscriptionsApi subscriptionsSampleLeadEmailReceivedGet GET /subscriptions/sample/lead.email.received 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
SubscriptionsApi subscriptionsSampleLeadNoteAddedGet GET /subscriptions/sample/lead.note.added 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
SubscriptionsApi subscriptionsSampleLeadRestoredGet GET /subscriptions/sample/lead.restored Receive a notification when a deleted lead is restored in this CRM
SubscriptionsApi subscriptionsSampleLeadSignatureGeneratedGet GET /subscriptions/sample/lead.signature.generated Receive a notification when a lead's e-signature document is generated
SubscriptionsApi subscriptionsSampleLeadSignatureOpenedGet GET /subscriptions/sample/lead.signature.opened Receive a notification when a lead's e-signature document is opened by the recipient
SubscriptionsApi subscriptionsSampleLeadSignatureSignedGet GET /subscriptions/sample/lead.signature.signed Receive a notification when a lead's e-signature document is signed by the recipient
SubscriptionsApi subscriptionsSampleLeadStatusUpdatedGet GET /subscriptions/sample/lead.status.updated 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
SubscriptionsApi subscriptionsSampleLeadUpdatedGet GET /subscriptions/sample/lead.updated 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
SubscriptionsApi subscriptionsSampleResidualsLineitemAddedGet GET /subscriptions/sample/residuals.lineitem.added Receive a notification when a residuals line item is added
SubscriptionsApi subscriptionsSampleResidualsReportPublishedGet GET /subscriptions/sample/residuals.report.published Receive a notification when a residuals report is published
SubscriptionsApi subscriptionsSampleSubscriptionTestGet GET /subscriptions/sample/subscription.test Test payload for checking server response
SubscriptionsApi subscriptionsSampleTicketChecklistUpdatedGet GET /subscriptions/sample/ticket.checklist.updated Receive a notification when a ticket's checklist is updated
SubscriptionsApi subscriptionsSampleTicketCommentEditedGet GET /subscriptions/sample/ticket.comment.edited Receive a notification when a ticket comment is edited
SubscriptionsApi subscriptionsSampleTicketCommentedGet GET /subscriptions/sample/ticket.commented Receive a notification when a ticket comment is added
SubscriptionsApi subscriptionsSampleTicketCreatedGet GET /subscriptions/sample/ticket.created Receive a notification when a ticket is created
SubscriptionsApi subscriptionsSampleTicketResolvedGet GET /subscriptions/sample/ticket.resolved Receive a notification when a ticket is resolved
SubscriptionsApi subscriptionsSampleTicketUpdatedGet GET /subscriptions/sample/ticket.updated Receive a notification when a ticket is updated
SubscriptionsApi subscriptionsSampleTurboappApprovedGet GET /subscriptions/sample/turboapp.approved Receive a notification when a merchant is approved
SubscriptionsApi subscriptionsSampleTurboappDeclinedGet GET /subscriptions/sample/turboapp.declined Receive a notification when a merchant is declined
SubscriptionsApi subscriptionsSampleTurboappSubmittedGet GET /subscriptions/sample/turboapp.submitted Receive a notification when a TurboApp is submitted to a processor
SubscriptionsApi subscriptionsSampleTurboappUpdatedGet GET /subscriptions/sample/turboapp.updated Receive a notification when the underwriting status is updated
SubscriptionsApi subscriptionsSubscriptionIdDelete DELETE /subscriptions/{subscriptionId} Delete a subscription
SubscriptionsApi subscriptionsSubscriptionIdGet GET /subscriptions/{subscriptionId} Return a subscription by its id
SubscriptionsApi subscriptionsSubscriptionIdPatch PATCH /subscriptions/{subscriptionId} Update a subscription

Documentation For Models

Documentation For Authorization

Token

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

Author

support@iriscrm.com