README

This page contains complete API documentation for CRM software.

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/QualityUnit/Crm-Api-Php-client.git"
    }
  ],
  "require": {
    "QualityUnit/Crm-Api-Php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure OAuth2 access token for authorization: privileges
$config = Qu\CrmClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: api_key
$config = Qu\CrmClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Qu\CrmClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new Qu\CrmClient\Api\AdminPanelApi(
    // 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->getSubscriptionSources();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminPanelApi->getSubscriptionSources: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://crm.qualityunit.com/api/v3

Class	Method	HTTP request	Description
AdminPanelApi	getSubscriptionSources	GET /admin_panel/sources	Subscription source list
AdminPanelApi	getSubscriptionView	GET /admin_panel/subscription_view/{subscriptionId}	Subscription view data
AttributesApi	getAttribute	GET /attributes/{attributeId}	Attribute
AttributesApi	getAttributes	GET /attributes	Attribute list
AttributesApi	setAttribute	PUT /attributes/{attributeId}	Attribute
BillingApi	checkVat	POST /billing/_check_vat	Vat validity
CountriesApi	getCountries	GET /countries	Country list
CouponApi	getCoupon	GET /coupons/{couponCode}	Coupon
CouponsApi	extendCouponValidity	POST /coupons/{couponCode}/_extend_validity	Extend coupon validity
DevApi	devCreateSubscription	POST /dev/_create_subscription	Create dev subscription
EventLogsApi	getEventLogs	GET /event_logs	Event logs list
HackApi	hackDummyPaymentMethod	POST /_hack/_dummy_payment_method	Set dummy payment method
InternalApi	accountUserLogin	GET /subscriptions/{subscriptionId}/_login	Login as account user
InternalApi	cancelDiscount	DELETE /discounts/{discountId}	Cancel discount
InternalApi	createAddon	POST /addons	Create new addon
InternalApi	createCoupon	POST /coupons	Create coupon
InternalApi	createDiscount	POST /discounts	Create discount
InternalApi	customResellerUrl	GET /subscriptions/{subscriptionId}/upgrade_url	Custom reseller upgrade URL
InternalApi	deleteAddon	DELETE /addons/{codename}	Addon
InternalApi	elasticReindex	POST /subscriptions/{subscriptionId}/elastic_reindex	Elastic reindex subscription LA data
InternalApi	elasticReindexStatus	GET /subscriptions/{subscriptionId}/elastic_status	LA elastic reindex status
InternalApi	generateForAgents	POST /my-account/{subscriptionId}/_authorize	'My Account' token
InternalApi	getAccountUsers	GET /subscriptions/{subscriptionId}/account_users	Account users
InternalApi	getAddon	GET /addons/{codename}	Addon
InternalApi	getAddons	GET /addons	Addon list
InternalApi	getCoupons	GET /coupons	Coupons list
InternalApi	getDiscount	GET /discounts/{discountId}	Discount
InternalApi	getDiscounts	GET /discounts	Discount list
InternalApi	getOutboxEmail	GET /outbox/{emailId}	Email
InternalApi	getOutboxEmails	GET /outbox	Email list
InternalApi	getSubscriptionStatusHistory	GET /subscriptions/{subscriptionId}/status_history	Status history
InternalApi	updateAddon	PUT /addons/{codename}	Addon
InvoicesApi	downloadInvoice	GET /invoices/{invoiceNumber}/_download	Download invoice
InvoicesApi	getInvoice	GET /invoices/{invoiceNumber}	Invoice
InvoicesApi	getInvoices	GET /invoices	Invoice list
InvoicesApi	refundInvoice	POST /invoices/{invoiceNumber}/_refund	Refund invoice
InvoicesApi	regenerateInvoice	POST /invoices/{invoiceNumber}/_regenerate_pdf	Regenerate invoice pdf
LakbdomainApi	checkCertificate	PUT /lakbdomain/_check_certificate	Certificate check
LiveagentApi	setKnowledgebases	POST /subscriptions/{subscriptionId}/liveagent/knowledgebases	Set knowledgebase settings
MassActionsApi	massDelete	POST /subscriptions/massAction/_delete	Delete multiple subscriptions
MassActionsApi	massSuspend	POST /subscriptions/massAction/_suspend	Suspend multiple subscriptions
MassActionsApi	massTerminate	POST /subscriptions/massAction/_terminate	Terminate multiple subscriptions
MassActionsApi	massUpdate	POST /subscriptions/massAction/_update	Update multiple subscriptions
MinionsApi	addNewMinion	POST /minions	Add new minion
MinionsApi	deleteMinion	DELETE /minions/{minionId}	Delete minion
MinionsApi	editMinion	PUT /minions/{minionId}	Edit minion
MinionsApi	getMinion	GET /minions/{minionId}	Minion
MinionsApi	getMinionClusterNames	GET /minions/options/clusterNames	Minion cluster names list
MinionsApi	getMinionRoles	GET /minions/options/roles	Minion roles list
MinionsApi	getMinions	GET /minions	Minions list
MinionsApi	reSyncMinion	POST /minions/{minionId}/_reSync	Resync minion and set it up
MinionsApi	setMinionDown	POST /minions/{minionId}/_setDown	Set minion down
MinionsApi	setMinionUp	POST /minions/{minionId}/_setUp	Set minion up
MyAccountApi	cancelStop	POST /my-account/_cancelStop	Restart billing
MyAccountApi	changeAddonsForMyAccount	PUT /my-account/addons	Addon change
MyAccountApi	downloadInvoiceForMyAccount	GET /my-account/invoices/{invoiceNumber}/_download	Download invoice
MyAccountApi	downloadSummary	GET /my-account/summary/{orderNumber}/_download	Downloads summary
MyAccountApi	generate	POST /checkout/_authorize	'My Account' token
MyAccountApi	getAccountInvoices	GET /my-account/invoices	Invoices list
MyAccountApi	getAccountSummaries	GET /my-account/summary/history	Summaries list
MyAccountApi	getActiveAddonsForMyAccount	GET /my-account/addons	Plan addons list
MyAccountApi	getAgentsCount	GET /my-account/usage/agents/count	Agents count
MyAccountApi	getAllVariationAddonsForMyAccount	GET /my-account/variations/{variationId}/addons	Variations addons
MyAccountApi	getBillingInfoForMyAccount	GET /my-account/billingInfo	Billing info
MyAccountApi	getBillingStatusForMyAccount	GET /my-account/billingStatus	Billing status
MyAccountApi	getCouponForMyAccount	GET /my-account/coupons/{couponCode}	Coupon
MyAccountApi	getKnowledgebasesCount	GET /my-account/usage/knowledgebases/count	Knowledgebases count
MyAccountApi	getPaymentMethodForMyAccount	GET /my-account/paymentMethod	Get Payment method
MyAccountApi	getPaymentProcessorForMyAccount	GET /my-account/paymentProcessor	Payment processor
MyAccountApi	getSubscriptionForMyAccount	GET /my-account/subscription	Subscription
MyAccountApi	getSummaryForMyAccount	GET /my-account/summary	Current period summary
MyAccountApi	getUpgradeVariationsForMyAccount	GET /my-account/upgradeVariations	Upgrade variation list
MyAccountApi	getVariationForMyAccount	GET /my-account/variation	Variation
MyAccountApi	parameters	GET /my-account/parameters	'My Account' parameters
MyAccountApi	predictPrice	POST /my-account/_predictPrice	Returns list of items and predicted price
MyAccountApi	sendPaymentError	POST /my-account/sendPaymentError	Sends payment error to server
MyAccountApi	stopAccount	POST /my-account/_stop	Stop billing
MyAccountApi	updateBillingInfo	PUT /my-account/billingInfo	Billing info
MyAccountApi	updatePaymentMethod	PUT /my-account/paymentMethod	Update payment method
MyAccountApi	upgradePlan	POST /my-account/_upgrade	Change plan
MyAccountApi	validateBillingInfoForMyAccount	POST /my-account/_validateBillingInfo	Test Billing info
ProductsApi	createProductVersion	POST /products/{productId}/versions	Create new product version
ProductsApi	deleteProductVersion	DELETE /products/{productId}/versions/{productVersionName}	Delete product version
ProductsApi	getAllProductAvailableVersions	GET /products/{productId}/available_versions	Product available versions
ProductsApi	getProduct	GET /products/{productId}	Product
ProductsApi	getProductVersion	GET /products/{productId}/versions/{productVersionName}	Product version
ProductsApi	getProductVersions	GET /products/{productId}/versions	Product versions
ProductsApi	getProducts	GET /products	Products list
ProductsApi	markProductVersionForDeletion	PUT /products/{productId}/versions/{productVersionName}/mark_for_deletion	Mark product version for deletion
ProductsApi	updateProductVersion	PUT /products/{productId}/versions/{productVersionName}	Update product version
RedeemCodesApi	createRedeemCode	POST /redeem_codes	Create redeem code
RedeemCodesApi	deleteRedeemCode	DELETE /redeem_codes/{redeemCode}	Delete Redeem code
RedeemCodesApi	getRedeemCode	GET /redeem_codes/{redeemCode}	Redeem code
RedeemCodesApi	getRedeemCodes	GET /redeem_codes	Redeem codes list
RedeemCodesApi	redeemCodeSignup	POST /redeem_code/signup	Create subscription
RedeemCodesApi	redeemCodesImport	POST /redeem_codes/import	Import redeem codes
RefundsApi	getRefund	GET /refunds/{refundId}	Refund
RefundsApi	getRefunds	GET /refunds	Refund list
ResellerApi	getResellerBilledPeriods	GET /reseller/subscriptions/{subscriptionId}/billed_periods	Reseller subscription billed period list
ResellerApi	getResellerInvoices	GET /reseller/invoices	Reseller invoice list
ResellerApi	getResellerSubscription	GET /reseller/subscriptions/{subscriptionId}	Get reseller subscription
ResellerApi	getResellerSubscriptionUsage	GET /reseller/subscriptions/{subscriptionId}/usage/agents	Get reseller subscription usage
ResellerApi	getResellerSubscriptions	GET /reseller/subscriptions	Get reseller subscriptions
ResellerApi	resellerChangePlan	POST /reseller/subscriptions/{subscriptionId}/_upgrade	Change plan
ResellerApi	resellerSignup	POST /reseller/subscriptions	Create reseller subscription
ResellerApi	suspendResellerSubscription	POST /reseller/subscriptions/{subscriptionId}/_suspend	Suspend reseller subscription
ResellerApi	unsuspendResellerSubscription	POST /reseller/subscriptions/{subscriptionId}/_unsuspend	Unsuspend reseller subscription
SettingsApi	getSettings	GET /settings	Settings list
SettingsApi	updateSettingGroup	PUT /settings	Update setting group
StatsApi	getAccountStats	GET /stats/account	Account stats
StatsApi	getAgentsStats	GET /stats/agents	Agents stats for accounts with 10 or more agents
StatsApi	getSaleStats	GET /stats/sale	Sale stats
StatsApi	getVersionsStats	GET /stats/versions	Versions stats
SubscriptionsApi	addFreeAddons	POST /subscriptions/{subscriptionId}/_addFreeAddons	Add free addons
SubscriptionsApi	aetAccountManager	PUT /subscriptions/{subscriptionId}/account_manager	Assign account manager
SubscriptionsApi	agreeWithRequestBilling	POST /subscriptions/{subscriptionId}/pap_request_billing	PAP agree with additional billing
SubscriptionsApi	changeAddons	PUT /subscriptions/{subscriptionId}/addons	Addon change
SubscriptionsApi	changePlan	POST /subscriptions/{subscriptionId}/_upgrade	Change plan
SubscriptionsApi	checkDomain	POST /subscriptions/_check_domain	Domain availability
SubscriptionsApi	clearLastPaymentFail	POST /subscriptions/{subscriptionId}/_clearLastPaymentFail	Clear last payment fail
SubscriptionsApi	delete	POST /subscriptions/{subscriptionId}/_delete	Delete subscription
SubscriptionsApi	extendValidity	POST /subscriptions/{subscriptionId}/_extendValidity	Extends account validity
SubscriptionsApi	getAccount	GET /accounts/{accountId}	Account
SubscriptionsApi	getAccountManager	GET /subscriptions/{subscriptionId}/account_manager	Get account manager
SubscriptionsApi	getActiveAddons	GET /subscriptions/{subscriptionId}/addons	Addon list
SubscriptionsApi	getBillingInfo	GET /subscriptions/{subscriptionId}/billingInfo	Billing info
SubscriptionsApi	getBillingMetrics	GET /subscriptions/{subscriptionId}/billingMetrics	Billing metrics
SubscriptionsApi	getBillingStatus	GET /subscriptions/{subscriptionId}/billingStatus	Billing status
SubscriptionsApi	getDomainInfo	GET /subscriptions/{subscriptionId}/domain	Domain info
SubscriptionsApi	getFailedPayment	GET /failed_payments/{failedPaymentId}	Failed payment
SubscriptionsApi	getFailedPayments	GET /failed_payments	Failed payment list
SubscriptionsApi	getInstallProgress	GET /subscriptions/{subscriptionId}/install_progress	Install progress
SubscriptionsApi	getNote	GET /subscriptions/{subscriptionId}/note	Note
SubscriptionsApi	getPaymentMethod	GET /subscriptions/{subscriptionId}/paymentMethod	Payment method
SubscriptionsApi	getPaymentProcessor	GET /subscriptions/{subscriptionId}/paymentProcessor	Payment processor
SubscriptionsApi	getSource	GET /subscriptions/{subscriptionId}/source	Install source
SubscriptionsApi	getSubscription	GET /subscriptions/{subscriptionId}	Subscription
SubscriptionsApi	getSubscriptionAttributes	GET /subscriptions/{subscriptionId}/attributes	Subscription attribute list
SubscriptionsApi	getSubscriptionDiscounts	GET /subscriptions/{subscriptionId}/discounts	Subscription discounts
SubscriptionsApi	getSubscriptionInvoices	GET /subscriptions/{subscriptionId}/invoices	Subscription invoice list
SubscriptionsApi	getSubscriptions	GET /subscriptions	Subscription list
SubscriptionsApi	getUpgradeVariations	GET /subscriptions/{subscriptionId}/upgradeVariations	Upgrade variation list
SubscriptionsApi	isAdditionalBillingAgreed	GET /subscriptions/{subscriptionId}/pap_request_billing	PAP get additional billing
SubscriptionsApi	refreshAccount	POST /subscriptions/{subscriptionId}/_refreshAccount	Refresh account
SubscriptionsApi	removeLock	PUT /subscriptions/{subscriptionId}/unlock	Remove lock
SubscriptionsApi	requestAction	POST /subscriptions/{subscriptionId}/_requestAction	Request billing action
SubscriptionsApi	resumeBilling	POST /subscriptions/{subscriptionId}/_cancelStop	Restart billing
SubscriptionsApi	setBillingInfo	PUT /subscriptions/{subscriptionId}/billingInfo	Billing info
SubscriptionsApi	setCustomDomain	PUT /subscriptions/{subscriptionId}/custom_domain	Custom domain
SubscriptionsApi	setDefaultDomain	PUT /subscriptions/{subscriptionId}/default_domain	Default domain
SubscriptionsApi	setDomain	PUT /subscriptions/{subscriptionId}/domain	Custom domain
SubscriptionsApi	setLock	PUT /subscriptions/{subscriptionId}/lock	Set subscription lock
SubscriptionsApi	setNote	PUT /subscriptions/{subscriptionId}/note	Note
SubscriptionsApi	setOwnerEmail	PUT /subscriptions/{subscriptionId}/owner_email	Owner's email
SubscriptionsApi	setPapTrackingParams	PUT /subscriptions/{subscriptionId}/pap_tracking_params	PAP tracking params
SubscriptionsApi	setPaymentMethod	PUT /subscriptions/{subscriptionId}/paymentMethod	Payment method
SubscriptionsApi	setSource	PUT /subscriptions/{subscriptionId}/source	Install source
SubscriptionsApi	setSubscriptionUsage	PUT /subscriptions/{subscriptionId}/usage	Subscription usage
SubscriptionsApi	setUpdatePolicy	PUT /subscriptions/{subscriptionId}/update_policy	Set update policy
SubscriptionsApi	signup	POST /subscriptions	Create subscription
SubscriptionsApi	stopBilling	POST /subscriptions/{subscriptionId}/_stop	Stop billing
SubscriptionsApi	suspend	POST /subscriptions/{subscriptionId}/_suspend	Suspend subscription
SubscriptionsApi	switchVariation	POST /subscriptions/{subscriptionId}/_switchVariation	Switch variation for subscription
SubscriptionsApi	terminate	POST /subscriptions/{subscriptionId}/_terminate	Terminate subscription
SubscriptionsApi	unsuspend	POST /subscriptions/{subscriptionId}/_unsuspend	Unsuspend subscription
SubscriptionsApi	updateApplication	POST /subscriptions/{subscriptionId}/_update	Update subscription
SubscriptionsApi	validateBillingInfo	POST /subscriptions/{subscriptionId}/_validateBillingInfo	Test Billing info
TasksApi	getRichTask	GET /executor/tasks/{taskId}	Task
TasksApi	getRichTaskAttempt	GET /executor/task_attempts/{taskAttemptId}	Task attempt
TasksApi	getTaskAction	GET /executor/actions/{actionId}	Action
TasksApi	getTaskMinionJob	GET /executor/actions/{actionId}/minion_jobs/{minionId}	Minion job
TasksApi	getTasks	GET /executor/tasks	List of tasks
TasksApi	markTaskBroken	POST /executor/tasks/{taskId}/_mark_broken	Mark task broken
TasksApi	retryTaskAttempt	POST /executor/tasks/{taskId}/_retry	Retry task attempt
TemplatesApi	getTemplate	GET /templates/{templateId}	Template
TemplatesApi	getTemplates	GET /templates	Template list
TemplatesApi	updateTemplate	PUT /templates/{templateId}	Template
TokenApi	getAccessToken	POST /token	Access token
VariationsApi	editAddon	POST /variations/{variationId}/addons/{codename}/_change_state	Change addon's state
VariationsApi	getAllVariationAddons	GET /variations/{variationId}/addons	Variations addons
VariationsApi	getVariation	GET /variations/{variationId}	Variation
VariationsApi	getVariationAddons	GET /variations/{variationId}/available_addons	Variations addons
VariationsApi	getVariations	GET /variations	Variation list
VariationsApi	updateVariation	PUT /variations/{variationId}	Variation

Models

Authorization

privileges

Type: OAuth
Flow: accessCode
Authorization URL: ``
Scopes:
- hack.dummy_payment: set dummy payment
- account.switch_variation: Switch variation
- agent.login: Log into an account
- attribute.read: Read attributes
- attribute.write: Change attributes
- dev.create_subscription: Create dev subscription
- event_logs.read: Event logs read
- invoice.read: Read invoices
- job.read: Jobs read
- product.read: Products read
- product.write: Products write
- refund.read: Refunds read
- refund.write: Refunds write
- reseller.own: Read info related to reseller making the call
- reseller.signup: Create new reseller subscription
- reseller.read: Read information about reseller
- reseller.write: Manage reseller or reseller subscriptions
- subscription.own: Read/write own subscriptions (use 'me' as subscriptionId)
- subscription.read: Subscriptions read
- subscription.basicOperations: Subscriptions operations allowed for agent
- subscription.write: Subscriptions write
- subscription.delete: Subscriptions delete
- subscription.reindex: Reindex of account
- subscription.massActions: Subscriptions mass actions
- subscription.changeDomain: Change default or custom domain
- subscription.changeDefaultDomain: Change default domain
- subscription.changeCustomDomain: Change custom domain
- task.read: Tasks read
- task.write: Tasks write
- template.read: Read templates
- template.write: Change templates
- variation.read: Variations read
- variation.write: Variations write
- minion.read: Minions read
- minion.write: Minions write
- stats.sale: Sale stats
- stats.account: Account numbers stats
- settings.read: Read settings
- settings.write: Change settings
- stats.versions: Get stat versions
- stats.agents: Get stat agents
- addon.read: Read addons
- addon.write: Modify addons

api_key

Type: API key
API key parameter name: apikey
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@qualityunit.com

About this package

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

API version: 3.0.0
- Package version: 1.35.0
Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen

qualityunit / crm-client

Maintainers

Details