savvii / openprovider-rest
PHP client for the Openprovider REST API
1.0.1
2023-02-09 01:54 UTC
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-12-06 16:41:15 UTC
README
Inspired by Openprovider's version which is unfortunately outdated at the moment of writing.
The code in this package is generated by the OpenAPI Generator project
Installation & Usage
Requirements
PHP 7.4 and later
Composer
Run composer require savvii/openprovider-rest
Getting Started
Example for PHP 8.0 or newer because it really helps to be able to use Named Arguments.
<?php require_once(__DIR__ . '/vendor/autoload.php'); $config = \Savvii\OpenproviderRest\Configuration::getDefaultConfiguration(); $config->setApiKeyPrefix('Authorization', 'Bearer'); $config->setDebug(false); $loginResult = (new \Savvii\OpenproviderRest\Api\AuthApi())->login( new \Savvii\OpenproviderRest\Model\AuthLoginRequest([ 'username' => '__FILL_ME__', 'password' => '__FILL_ME__' ]) ); $config->setApiKey('Authorization', $loginResult->getData()->getToken()); $domainApi = new \Savvii\OpenproviderRest\Api\DomainServiceApi(config: $config); $listResponse = $domainApi->listDomains(full_name: 'savvii.nl', limit: 1); $data = $listResponse->getData(); if (1 == $data->getTotal()) { $result = $data->getResults()[0]; printf("ID: %d, Auth Code: %s\n\n", $result->getId(), $result->getAuthCode()); $arrayResult = json_decode($result, true); var_dump($arrayResult); }
API Endpoints
All URIs are relative to https://api.openprovider.eu
Models
- AdditionalDataGetAdditionalDataResponse
- AdditionalDataSelectOption
- AdditionalDataSpecification
- ApproveremailListApproverEmailsResponse
- ApproveremailListApproverEmailsResponseData
- ApproveremailResendApproverEmailRequest
- ApproveremailResendApproverEmailResponse
- ApproveremailResendApproverEmailResponseData
- ApproveremailUpdateApproverEmailAddressRequest
- ApproveremailUpdateApproverEmailAddressResponse
- ApproveremailUpdateApproverEmailAddressResponseData
- AttributesCompanySize
- AttributesIndustry
- AuthLoginRequest
- AuthLoginResponse
- AuthLoginResponseData
- AuthcodeAuthInfo
- AuthcodeGetAuthCodeResponse
- AuthcodeGetAuthCodeResponseData
- AuthcodeResetAuthCodeRequest
- AuthcodeResetAuthCodeResponse
- AuthcodeResetAuthCodeResponseData
- AuthcodeRgpStatuses
- ContactAdditionalData
- ContactAddress
- ContactClientIpList
- ContactCreateContactRequest
- ContactCreateContactResponse
- ContactCreateContactResponseData
- ContactDeleteContactResponse
- ContactDeleteContactResponseData
- ContactGetContactResponse
- ContactListContactsResponse
- ContactListContactsResponseData
- ContactName
- ContactPhone
- ContactUpdateContactRequest
- ContactUpdateContactResponse
- ContactUpdateContactResponseData
- CsrCreateCsrRequest
- CsrCreateCsrResponse
- CsrCreateCsrResponseData
- CsrCsrPublicKey
- CsrCsrSubject
- CsrDecodeCsrRequest
- CsrDecodeCsrResponse
- CsrDecodeCsrResponseData
- CustomerCreateCustomerRequest
- CustomerCreateCustomerResponse
- CustomerCreateCustomerResponseData
- CustomerCustomerAdditionalData
- CustomerDeleteCustomerResponse
- CustomerDeleteCustomerResponseData
- CustomerExtensionAdditionalData
- CustomerExtensionData
- CustomerFax
- CustomerFile
- CustomerGetCustomerResponse
- CustomerGetCustomerResponseData
- CustomerGetDataResponse
- CustomerListCustomersResponse
- CustomerListCustomersResponseData
- CustomerListCustomersResponseDataResults
- CustomerTags
- CustomerUpdateCustomerRequest
- CustomerUpdateCustomerResponse
- CustomerUpdateCustomerResponseData
- DomainAbuseDetails
- DomainAdditionalData
- DomainApiHistory
- DomainApproveTransferRequest
- DomainCheckAdditionalData
- DomainCheckDomainRequest
- DomainCheckDomainResponse
- DomainCheckDomainResponseData
- DomainCheckDomainResult
- DomainCreateDomainRequest
- DomainCreateDomainResponse
- DomainCreateDomainResponseData
- DomainDeleteDomainResponse
- DomainDeleteDomainResponseData
- DomainDnssecKey
- DomainDomain
- DomainGetDomainResponse
- DomainGetDomainResponseData
- DomainHistory
- DomainListDomainsRequestOrderBy
- DomainListDomainsRequestResponseField
- DomainListDomainsResponse
- DomainListDomainsResponseData
- DomainNameserver
- DomainOperationPrice
- DomainOwner
- DomainPremiumPrice
- DomainPrice
- DomainPriceGroup
- DomainRegistryStatus
- DomainRegistryStatuses
- DomainRenewDomainRequest
- DomainRenewDomainResponse
- DomainRenewDomainResponseData
- DomainRestoreDomainRequest
- DomainRestoreDomainResponse
- DomainRestoreDomainResponseData
- DomainSendFoa1Request
- DomainSuggestNameDomainRequest
- DomainSuggestNameDomainResponse
- DomainSuggestNameDomainResponseData
- DomainSuggestNameDomainResult
- DomainTokenCreateTokenRequest
- DomainTokenCreateTokenResponse
- DomainTokenCreateTokenResponseData
- DomainTradeDomainRequest
- DomainTradeDomainResponse
- DomainTradeDomainResponseData
- DomainTransferAdditionalData
- DomainTransferDomainRequest
- DomainTransferDomainResponse
- DomainTransferDomainResponseData
- DomainTryAgainLastOperationRequest
- DomainUINDocumentType
- DomainUpdateAdditionalData
- DomainUpdateDomainRequest
- DomainUpdateDomainResponse
- DomainUpdateDomainResponseData
- DomainWhoisPrivacyData
- EmailCreateEmailRequest
- EmailCreateEmailResponse
- EmailCreateEmailResponseData
- EmailDeleteEmailResponse
- EmailDeleteEmailResponseData
- EmailDomainEmailVerification
- EmailFields
- EmailListDomainVerificationsResponse
- EmailListDomainVerificationsResponseData
- EmailListEmailsResponse
- EmailListEmailsResponseData
- EmailListEmailsResponseDataResults
- EmailRestartEmailVerificationRequest
- EmailRestartEmailVerificationResponse
- EmailRestartEmailVerificationResponseData
- EmailStartEmailVerificationRequest
- EmailStartEmailVerificationResponse
- EmailStartEmailVerificationResponseData
- EmailTags
- EmailUpdateEmailRequest
- EmailUpdateEmailResponse
- EmailUpdateEmailResponseData
- EmailVerificationRecipient
- ErrorError
- ErrorWarning
- HelperstagTag
- HistoryZoneHistory
- InvoiceInvoice
- InvoiceListInvoicesResponse
- InvoiceListInvoicesResponseData
- InvoicePrice
- InvoicePrices
- LicenseCreateLicenseResponseData
- LicenseCreatePleskLicenseRequest
- LicenseCreatePleskLicenseResponse
- LicenseCreateVirtuozzoLicenseRequest
- LicenseCreateVirtuozzoLicenseResponse
- LicenseDeleteLicenseResponse
- LicenseDeleteLicenseResponseData
- LicenseExtendedLicense
- LicenseGetLicenseKeyResponse
- LicenseGetLicenseResponse
- LicenseKey
- LicenseLicenseItem
- LicenseLicenseKey
- LicenseLicenseWithPriceVersion
- LicenseListItemsOrderBy
- LicenseListItemsResponse
- LicenseListItemsResponseData
- LicenseListLicensesOrderBy
- LicenseListLicensesResponse
- LicenseListLicensesResponseData
- LicenseListLicensesWithPriceVersionResponse
- LicenseListLicensesWithPriceVersionResponseData
- LicenseResetHwidRequest
- LicenseResetHwidResponse
- LicenseResetHwidResponseData
- LicenseUpdateLicenseResponse
- LicenseUpdateLicenseResponseData
- LicenseUpdatePleskLicenseRequest
- LicenseUpdateVirtuozzoLicenseRequest
- LicenselicenseLicense
- NameserverCreateNameserverResponse
- NameserverGetNameserverResponse
- NameserverListNameserversResponse
- NameserverListNameserversResponseData
- NameserverNameserver
- NameserverNameserverBoolResponse
- NameserverNameserverBoolResponseData
- NsGroupCreateGroupRequest
- NsGroupCreateGroupResponse
- NsGroupGetGroupResponse
- NsGroupGroup
- NsGroupGroupBoolResponse
- NsGroupGroupBoolResponseData
- NsGroupListGroupsOrderBy
- NsGroupListGroupsResponse
- NsGroupListGroupsResponseData
- NsGroupNameServersSet
- NsGroupUpdateGroupRequest
- OrderCancelOrderRequest
- OrderCancelOrderResponse
- OrderCancelOrderResponseData
- OrderCreateEasyDmarcRequest
- OrderCreateEasyDmarcResponse
- OrderCreateOrderRequest
- OrderCreateOrderResponse
- OrderCreateOrderResponseData
- OrderDeleteEasyDmarcResponse
- OrderDeleteEasyDmarcResponseData
- OrderDomain
- OrderEasyDmarcOrder
- OrderGetEasyDmarcResponse
- OrderGetEasyDmarcSsoResponse
- OrderGetEasyDmarcSsoResponseData
- OrderGetOrderResponse
- OrderListEasyDmarcOrder
- OrderListEasyDmarcRequestOrderBy
- OrderListEasyDmarcResponse
- OrderListEasyDmarcResponseData
- OrderListOrdersRequestOrderBy
- OrderListOrdersResponse
- OrderListOrdersResponseData
- OrderRecentEasyDmarcAction
- OrderReissueOrderRequest
- OrderReissueOrderResponse
- OrderReissueOrderResponseData
- OrderRenewOrderRequest
- OrderRenewOrderResponse
- OrderRenewOrderResponseData
- OrderRetryEasyDmarcRequest
- OrderRetryEasyDmarcResponse
- OrderSslOrder
- OrderSslOrderAdditionalData
- OrderSslOrderDomainValidationMethods
- OrderSslOrderDomainValidationStatuses
- OrderSslOrderOptions
- OrderUpdateOrderRequest
- OrderUpdateOrderResponse
- OrderUpdateOrderResponseData
- OtptokenCreateOtpTokenRequest
- OtptokenCreateOtpTokenResponse
- OtptokenCreateOtpTokenResponseData
- PaymentListPaymentsResponse
- PaymentListPaymentsResponseData
- PaymentListPaymentsResponseDataResults
- PaymentPrice
- PaymentPrices
- PersoncontactContact
- PriceGetPriceResponse
- PriceGetPriceResponseData
- PricePromotionData
- ProductGetProductResponse
- ProductListProductsRequestOrderBy
- ProductListProductsResponse
- ProductListProductsResponseData
- ProductSslProduct
- ProductSslProductLevelPrices
- ProductSslProductPrice
- ProductSslProductPriceGroup
- ProductSslProductPrices
- ProductSslProductReseller
- ProductSslProductSupportedSoftware
- ProductSslProductWarranty
- RecordListZoneRecordsOrderBy
- RecordListZoneRecordsResponse
- RecordListZoneRecordsResponseData
- RecordRecordInfo
- ResellerGetResellerResponse
- ResellerReseller
- ResellerResellerAdditionalData
- ResellerSettings
- ResellerStatistics
- ResellerUpdateResellerRequest
- ResellerUpdateResellerResponse
- ResellerUpdateResellerResponseData
- ResponseBoolResponse
- ResponseBoolResponseData
- SeDomainAliasUpdates
- SeDomainCreateDomainRequest
- SeDomainDestination
- SeDomainDomain
- SeDomainGetDomainResponse
- SeDomainProducts
- SeDomainRecords
- SeDomainUpdateDomainRequest
- SettingsGetSettingsResponse
- SettingsGetSettingsResponseData
- SettingsPaymentMethodLimit
- SettingsPaymentMethodLimits
- SettingsPaymentMethodSettings
- SettingsPaymentMethods
- SettingsSignedContracts
- SettingsTacContract
- SettingsTransactionFee
- SpamExpertGenerateLoginURLRequest
- SpamExpertGenerateLoginURLResponse
- SpamExpertGenerateLoginURLResponseData
- StatisticsCurrencyStatistics
- StatisticsCustomerStatistics
- StatisticsDnsStatistics
- StatisticsDomainStatistics
- StatisticsDomainStatisticsByStatus
- StatisticsGetStatisticsResponse
- StatisticsGetStatisticsResponseData
- StatisticsLicenseStatistics
- StatisticsSpamExpertsStatistics
- StatisticsSslStatistics
- StatisticsSslStatisticsByStatus
- TagCreateTagResponse
- TagCreateTagResponseData
- TagDeleteTagResponse
- TagDeleteTagResponseData
- TagListTagsResponse
- TagListTagsResponseData
- TemplateCreateTemplateRequest
- TemplateCreateTemplateResponse
- TemplateCreateTemplateResponseData
- TemplateGetTemplateResponse
- TemplateListTemplatesResponse
- TemplateListTemplatesResponseData
- TemplateRecord
- TemplateTemplate
- TemplateTemplateBoolResponse
- TemplateTemplateBoolResponseData
- TldApplicationMode
- TldDescription
- TldGetTldResponse
- TldIdnScript
- TldLevelPrice
- TldListTldsResponse
- TldListTldsResponseData
- TldPrice
- TldPriceInCurrency
- TldPriceWithPromoInfo
- TldPrices
- TldPromoDetails
- TldTld
- TransactionListTransactionsResponse
- TransactionListTransactionsResponseData
- TransactionListTransactionsResponseDataResults
- TransactionPrice
- TransactionPrices
- ZoneCreateZoneRequest
- ZoneDomain
- ZoneGetZoneResponse
- ZoneListZonesOrderBy
- ZoneListZonesResponse
- ZoneListZonesResponseData
- ZonePremiumDnsData
- ZoneRecord
- ZoneRecordUpdates
- ZoneRecordWithOriginal
- ZoneSectigoData
- ZoneUpdateZoneRequest
- ZoneZone
- ZoneZoneBoolResponse
- ZoneZoneBoolResponseData
Tests
To run the tests, use:
composer install vendor/bin/phpunit
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0.0-beta
- Package version:
1.0.0
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen