Cinolla-PHP

Welcome to Cinolla Client API documentation for version 3. Please see below for the available API endpoints and their required parameters and responses. If you have any questions, please contact [email protected].

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/synergitech/cinolla-php.git"
    }
  ],
  "require": {
    "synergitech/cinolla-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Cinolla-PHP/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // 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
);
$bookingHash = 'bookingHash_example'; // string

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

API Endpoints

All URIs are relative to https://api.prod.cinolla.com

Class	Method	HTTP request	Description
BookingsApi	getBooking	GET /v3/client/bookings/{bookingHash}	Get detail for a single Booking
BookingsApi	getBookings	GET /v3/client/bookings	Get a collection of Bookings
ContactsApi	getContact	GET /v3/client/contacts/{contactHash}	Get detail for a single Contact
ContactsApi	getContacts	GET /v3/client/contacts	Returns a collection of Contacts
CoursesApi	getCourseRuns	GET /v3/client/courses/{id}/course-runs	Returns a collection of Course Runs for a given course
CoursesApi	getCourses	GET /v3/client/courses	Returns a collection of Courses
CustomFormsApi	getCustomFormSubmissions	GET /v3/client/custom-forms/{customFormHash}/submissions	Get a collection of Custom Form Submissions
CustomFormsApi	getCustomForms	GET /v3/client/custom-forms	Get a collection of Custom Forms
InvoicesApi	getInvoice	GET /v3/client/invoices/{id}	Get detail for a single Invoice
InvoicesApi	getInvoices	GET /v3/client/invoices	Get a collection of Invoices
LineItemsApi	getLineItems	GET /v3/client/lineitems	Returns a collection of Line Items.
PaymentsApi	createPayment	POST /v3/client/payments	Create a new Payment.
PaymentsApi	getPayments	GET /v3/client/payments	Fetch a collection of Payments.

Models

• Address
• Booking
• Booking2
• Booking2Contact
• BookingContact
• BookingType
• BookingType2
• ClientBookingCollection
• ClientBookingCollectionContact
• ClientBookingDetail
• ClientBookingDetailContact
• Contact
• Contact2
• Contact3
• Contact4
• Contact5
• Contact6
• ContactDefaultBillingAddress
• CourseRun
• CourseRunDate
• CustomFieldsData
• CustomForm
• CustomFormSubmissions
• IncomeCode
• IncomeCode2
• InvoicedBooking
• InvoicedBooking2
• InvoicedBooking2Booking
• InvoicedBooking3
• InvoicedBookingBooking
• InvoicedBookingLineItem
• InvoicedBookingLineItem2
• LineItem
• Payment
• Payment2
• PaymentAllocation
• PaymentAllocationInvoicedBooking
• PaymentAllocationRefund

Authorization

BearerAuth

• Type: Bearer authentication (JWT)

ApiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 3.0.0
  • Package version: 2024.09.03
  • Generator version: 7.8.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen