{"id":22916653,"url":"https://github.com/synergitech/cinolla-php","last_synced_at":"2025-04-01T12:44:22.864Z","repository":{"id":258566790,"uuid":"866031716","full_name":"SynergiTech/cinolla-php","owner":"SynergiTech","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-19T11:09:33.000Z","size":111,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-19T12:23:45.702Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SynergiTech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-01T14:30:06.000Z","updated_at":"2025-02-19T11:09:38.000Z","dependencies_parsed_at":"2025-02-07T07:40:28.430Z","dependency_job_id":"d58717a3-b458-49fc-aad3-64eb044a99b7","html_url":"https://github.com/SynergiTech/cinolla-php","commit_stats":null,"previous_names":["synergitech/cinolla-php"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SynergiTech%2Fcinolla-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SynergiTech%2Fcinolla-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SynergiTech%2Fcinolla-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SynergiTech%2Fcinolla-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SynergiTech","download_url":"https://codeload.github.com/SynergiTech/cinolla-php/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246642172,"owners_count":20810556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-14T06:14:07.869Z","updated_at":"2025-04-01T12:44:22.856Z","avatar_url":"https://github.com/SynergiTech.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cinolla-PHP\n\nWelcome to Cinolla Client API documentation for version 3. Please see below for the available API endpoints and their required parameters and responses.\nIf you have any questions, please contact [support@cinolla.com](mailto:support@cinolla.com).\n\n\n## Installation \u0026 Usage\n\n### Requirements\n\nPHP 8.1 and later.\n\n### Composer\n\nTo install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"https://github.com/synergitech/cinolla-php.git\"\n    }\n  ],\n  \"require\": {\n    \"synergitech/cinolla-php\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n\u003c?php\nrequire_once('/path/to/Cinolla-PHP/vendor/autoload.php');\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n\n// Configure API key authorization: ApiKeyAuth\n$config = SynergiTech\\Cinolla\\Configuration::getDefaultConfiguration()-\u003esetApiKey('x-api-key', 'YOUR_API_KEY');\n// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n// $config = SynergiTech\\Cinolla\\Configuration::getDefaultConfiguration()-\u003esetApiKeyPrefix('x-api-key', 'Bearer');\n\n\n$apiInstance = new SynergiTech\\Cinolla\\Api\\BookingsApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$bookingHash = 'bookingHash_example'; // string\n\ntry {\n    $result = $apiInstance-\u003egetBooking($bookingHash);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling BookingsApi-\u003egetBooking: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n```\n\n## API Endpoints\n\nAll URIs are relative to *https://api.prod.cinolla.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BookingsApi* | [**getBooking**](docs/Api/BookingsApi.md#getbooking) | **GET** /v3/client/bookings/{bookingHash} | Get detail for a single Booking\n*BookingsApi* | [**getBookings**](docs/Api/BookingsApi.md#getbookings) | **GET** /v3/client/bookings | Get a collection of Bookings\n*ContactsApi* | [**getContact**](docs/Api/ContactsApi.md#getcontact) | **GET** /v3/client/contacts/{contactHash} | Get detail for a single Contact\n*ContactsApi* | [**getContacts**](docs/Api/ContactsApi.md#getcontacts) | **GET** /v3/client/contacts | Returns a collection of Contacts\n*CoursesApi* | [**getCourseRuns**](docs/Api/CoursesApi.md#getcourseruns) | **GET** /v3/client/courses/{id}/course-runs | Returns a collection of Course Runs for a given course\n*CoursesApi* | [**getCourses**](docs/Api/CoursesApi.md#getcourses) | **GET** /v3/client/courses | Returns a collection of Courses\n*CustomFormsApi* | [**getCustomFormSubmissions**](docs/Api/CustomFormsApi.md#getcustomformsubmissions) | **GET** /v3/client/custom-forms/{customFormHash}/submissions | Get a collection of Custom Form Submissions\n*CustomFormsApi* | [**getCustomForms**](docs/Api/CustomFormsApi.md#getcustomforms) | **GET** /v3/client/custom-forms | Get a collection of Custom Forms\n*InvoicesApi* | [**getInvoice**](docs/Api/InvoicesApi.md#getinvoice) | **GET** /v3/client/invoices/{id} | Get detail for a single Invoice\n*InvoicesApi* | [**getInvoices**](docs/Api/InvoicesApi.md#getinvoices) | **GET** /v3/client/invoices | Get a collection of Invoices\n*LineItemsApi* | [**getLineItems**](docs/Api/LineItemsApi.md#getlineitems) | **GET** /v3/client/lineitems | Returns a collection of Line Items.\n*PaymentsApi* | [**createPayment**](docs/Api/PaymentsApi.md#createpayment) | **POST** /v3/client/payments | Create a new Payment.\n*PaymentsApi* | [**getPayments**](docs/Api/PaymentsApi.md#getpayments) | **GET** /v3/client/payments | Fetch a collection of Payments.\n\n## Models\n\n- [Address](docs/Model/Address.md)\n- [Booking](docs/Model/Booking.md)\n- [Booking2](docs/Model/Booking2.md)\n- [BookingType](docs/Model/BookingType.md)\n- [BookingType2](docs/Model/BookingType2.md)\n- [Centre](docs/Model/Centre.md)\n- [Centre2](docs/Model/Centre2.md)\n- [ClientBookingCollection](docs/Model/ClientBookingCollection.md)\n- [ClientBookingCollectionCentre](docs/Model/ClientBookingCollectionCentre.md)\n- [ClientBookingCollectionContact](docs/Model/ClientBookingCollectionContact.md)\n- [ClientBookingCollectionOrganisation](docs/Model/ClientBookingCollectionOrganisation.md)\n- [ClientBookingDetail](docs/Model/ClientBookingDetail.md)\n- [ClientBookingDetailCentre](docs/Model/ClientBookingDetailCentre.md)\n- [ClientBookingDetailContact](docs/Model/ClientBookingDetailContact.md)\n- [ClientBookingDetailOrganisation](docs/Model/ClientBookingDetailOrganisation.md)\n- [Contact](docs/Model/Contact.md)\n- [Contact2](docs/Model/Contact2.md)\n- [Contact3](docs/Model/Contact3.md)\n- [Contact4](docs/Model/Contact4.md)\n- [Contact5](docs/Model/Contact5.md)\n- [Contact6](docs/Model/Contact6.md)\n- [ContactBelongsToOrganisation](docs/Model/ContactBelongsToOrganisation.md)\n- [ContactBelongsToOrganisation2](docs/Model/ContactBelongsToOrganisation2.md)\n- [ContactBelongsToOrganisation2Organisation](docs/Model/ContactBelongsToOrganisation2Organisation.md)\n- [ContactBelongsToOrganisationOrganisation](docs/Model/ContactBelongsToOrganisationOrganisation.md)\n- [ContactDefaultBillingAddress](docs/Model/ContactDefaultBillingAddress.md)\n- [ContactOrganisation](docs/Model/ContactOrganisation.md)\n- [ContactOrganisation2](docs/Model/ContactOrganisation2.md)\n- [ContactOrganisation3](docs/Model/ContactOrganisation3.md)\n- [ContactOrganisation4](docs/Model/ContactOrganisation4.md)\n- [ContactOrganisation5](docs/Model/ContactOrganisation5.md)\n- [ContactOrganisation6](docs/Model/ContactOrganisation6.md)\n- [ContactOrganisationAccountManager](docs/Model/ContactOrganisationAccountManager.md)\n- [CourseRun](docs/Model/CourseRun.md)\n- [CourseRunDate](docs/Model/CourseRunDate.md)\n- [CustomFieldsData](docs/Model/CustomFieldsData.md)\n- [CustomForm](docs/Model/CustomForm.md)\n- [CustomFormSubmissions](docs/Model/CustomFormSubmissions.md)\n- [IncomeCode](docs/Model/IncomeCode.md)\n- [IncomeCode2](docs/Model/IncomeCode2.md)\n- [InvoicedBooking](docs/Model/InvoicedBooking.md)\n- [InvoicedBooking2](docs/Model/InvoicedBooking2.md)\n- [InvoicedBooking2Booking](docs/Model/InvoicedBooking2Booking.md)\n- [InvoicedBooking2Contact](docs/Model/InvoicedBooking2Contact.md)\n- [InvoicedBooking2InvoicedBookingDeposit](docs/Model/InvoicedBooking2InvoicedBookingDeposit.md)\n- [InvoicedBooking2Organisation](docs/Model/InvoicedBooking2Organisation.md)\n- [InvoicedBooking3](docs/Model/InvoicedBooking3.md)\n- [InvoicedBookingBooking](docs/Model/InvoicedBookingBooking.md)\n- [InvoicedBookingContact](docs/Model/InvoicedBookingContact.md)\n- [InvoicedBookingDeposit](docs/Model/InvoicedBookingDeposit.md)\n- [InvoicedBookingDeposit2](docs/Model/InvoicedBookingDeposit2.md)\n- [InvoicedBookingInvoicedBookingDeposit](docs/Model/InvoicedBookingInvoicedBookingDeposit.md)\n- [InvoicedBookingLineItem](docs/Model/InvoicedBookingLineItem.md)\n- [InvoicedBookingLineItem2](docs/Model/InvoicedBookingLineItem2.md)\n- [InvoicedBookingOrganisation](docs/Model/InvoicedBookingOrganisation.md)\n- [LineItem](docs/Model/LineItem.md)\n- [Payment](docs/Model/Payment.md)\n- [Payment2](docs/Model/Payment2.md)\n- [PaymentAllocation](docs/Model/PaymentAllocation.md)\n- [PaymentAllocationInvoicedBooking](docs/Model/PaymentAllocationInvoicedBooking.md)\n- [PaymentAllocationRefund](docs/Model/PaymentAllocationRefund.md)\n\n## Authorization\n\n### BearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: x-api-key\n- **Location**: HTTP header\n\n\n## Tests\n\nTo run the tests, use:\n\n```bash\ncomposer install\nvendor/bin/phpunit\n```\n\n## Author\n\n\n\n## About this package\n\nThis PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: `3.0.0`\n    - Package version: `2024.09.03`\n    - Generator version: `7.12.0-SNAPSHOT`\n- Build package: `org.openapitools.codegen.languages.PhpNextgenClientCodegen`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynergitech%2Fcinolla-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsynergitech%2Fcinolla-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynergitech%2Fcinolla-php/lists"}