Skip to content

SynergiTech/cinolla-php

BranchesTags

Repository files navigation

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
$groups = new \SynergiTech\Cinolla\Model\Groups(); // \SynergiTech\Cinolla\Model\Groups | The Group to create

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

API Endpoints

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

Class Method HTTP request Description
BookingsApi addGroupToBooking POST /v3/client/bookings/{bookingHash}/groups Add a group to a booking
BookingsApi addTagsToBooking POST /v3/client/bookings/{bookingHash}/tags Add tags to a booking
BookingsApi createBooking POST /v3/client/bookings Create a new Booking
BookingsApi getBooking GET /v3/client/bookings/{bookingHash} Get detail for a single Booking
BookingsApi getBookingGuests GET /v3/client/bookings/{bookingHash}/guests Returns all guests on a booking
BookingsApi getBookingTags GET /v3/client/bookings/tags Returns all available booking tags
BookingsApi getBookings GET /v3/client/bookings Get a collection of Bookings
BookingsApi removeTagsFromBooking DELETE /v3/client/bookings/{bookingHash}/tags Remove tags from a booking
BookingsApi updateBooking PATCH /v3/client/bookings/{bookingHash} Update an existing Booking
ContactsApi createContact POST /v3/client/contacts Create a new Contact
ContactsApi getContact GET /v3/client/contacts/{contactHash} Get detail for a single Contact
ContactsApi getContacts GET /v3/client/contacts Returns a collection of Contacts
ContactsApi updateContact PATCH /v3/client/contacts/{contactHash} Update an existing Contact
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
CreditNotesApi getCreditNote GET /v3/client/credit-notes/{id} Get detail for a single Credit Note
CreditNotesApi getCreditNoteDocuments GET /v3/client/credit-notes/{id}/documents Get documents for a Credit Note
CreditNotesApi getCreditNotes GET /v3/client/credit-notes Get a collection of Credit Notes
CustomFormsApi getAppClientapiCustomformsGetcustomformjson GET /v3/client/custom-forms/{idOrHash}/json
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
EnquiriesApi createEnquiry POST /v3/client/enquiries Create a new Enquiry
EnquiriesApi getEnquiries GET /v3/client/enquiries Returns a collection of Enquiries
EnquiriesApi getEnquiry GET /v3/client/enquiries/{id} Get detail for a single Enquiry
HubSpotApi disconnectHubSpot POST /v3/client/hubspot/disconnect Disconnect HubSpot integration
HubSpotApi getHubSpotConnectionStatus GET /v3/client/hubspot/status Check HubSpot connection status
HubSpotApi getHubSpotOAuthUrl GET /v3/client/hubspot/oauth/authorize Get the HubSpot OAuth authorization URL
HubSpotApi handleHubSpotOAuthCallback GET /v3/client/hubspot/oauth/callback Handle the HubSpot OAuth callback
HubSpotApi handleHubSpotWebhook POST /v3/client/hubspot/webhooks Receive and process HubSpot webhook events
InvoicesApi getInvoice GET /v3/client/invoices/{id} Get detail for a single Invoice
InvoicesApi getInvoiceDocuments GET /v3/client/invoices/{id}/documents Get documents for an Invoice
InvoicesApi getInvoices GET /v3/client/invoices Get a collection of Invoices
LineItemsApi getLineItems GET /v3/client/lineitems Returns a collection of Line Items.
OrganisationsApi createOrganisation POST /v3/client/organisations Create a new Organisation
OrganisationsApi getOrganisation GET /v3/client/organisations/{organisationHash} Get detail for a single Organisation
OrganisationsApi getOrganisations GET /v3/client/organisations Returns a collection of Organisations
OrganisationsApi updateOrganisation PATCH /v3/client/organisations/{organisationHash} Update an existing Organisation
PaymentsApi createPayment POST /v3/client/payments Create a new Payment.
PaymentsApi getPayments GET /v3/client/payments Fetch a collection of Payments.
ResourcesApi getResource GET /v3/client/resources/{id} Get detail for a single Resource
ResourcesApi getResources GET /v3/client/resources Get a collection of Resources
WebhooksApi createWebhookSubscription POST /v3/client/webhooks Create a new webhook subscription
WebhooksApi deleteWebhookSubscription DELETE /v3/client/webhooks/{id} Delete a webhook subscription
WebhooksApi getWebhookSubscriptions GET /v3/client/webhooks Returns all webhook subscriptions
WebhooksApi updateWebhookSubscription PATCH /v3/client/webhooks/{id} Update the active status of a webhook subscription

Models

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.12.0
  • Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages