WordliftClient

Subscription management and related services.

For more information, please visit https://wordlift.io.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/WordliftClient/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: ApiKey
$config = Wordlift\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Wordlift\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


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

API Endpoints

All URIs are relative to https://api.wordlift.io

Class	Method	HTTP request	Description
AccountApi	getMe	GET /accounts/me	Get
AccountsApi	getAccount	GET /accounts/{id}	Get an account.
AccountsApi	listAccounts	GET /accounts	List
AccountsApi	updateAccount	PUT /accounts/{id}	Update an account.
AddOnsApi	listConfigurations	GET /addon/configurations	List
AnalyticsImportsApi	createAnalyticsImport	POST /analytics-imports	Create
BotifyCrawlImportsApi	createBotifyCrawlImport	POST /botify-crawl-imports	Create
CustomDomainsApi	validate	POST /validations	Validate
DataURIApi	get	GET /data-uri	Get the Web Data URI for a Web Page URL.
EmbeddingApi	createEmbedding	POST /kg/embeddings	Create
GoogleMerchantsApi	listGoogleMerchants	GET /ext/google/shopping/merchants	List
GoogleSearchConsoleApi	listWebsiteSearch	GET /ext/google/searchconsole/searches	List Website Search data
GoogleSearchConsoleApi	listWebsites	GET /ext/google/searchconsole/websites	List
GoogleSearchConsoleOAuth2Api	createAuthCodeExchange	POST /google-search-console/oauth2/auth-code-exchanges	Get an Access Code
GoogleSearchConsoleOAuth2Api	createAuthorizeUri	POST /google-search-console/oauth2/authorize-uris	Create an Authorization URI
GoogleSearchConsoleSearchesApi	listWebsiteSearch1	GET /accounts/me/google/searches	List Website Search data
IncludeExcludesWordPressPluginApi	listIncludeExcludes	GET /accounts/me/include-excludes	List
IncludeExcludesWordPressPluginApi	updateIncludeExcludes	PUT /accounts/me/include-excludes	Update
InternalLinksApi	createInternalLink	POST /internal-links	Create
InternalLinksApi	createInternalLinkSuggestion	POST /internal-links/suggestions	Suggest
MerchantSyncsApi	createSync	POST /merchants/{merchantId}/syncs	Start
MerchantSyncsApi	getMerchantSync	GET /merchants/{merchantId}/syncs/{id}	Get by id
MerchantSyncsApi	listMerchantSyncs	GET /merchants/{merchantId}/syncs	List
MerchantsApi	createMerchant	POST /merchants	Create
MerchantsApi	deleteMerchant	DELETE /merchants/{id}	Delete by id
MerchantsApi	getMerchant	GET /merchants/{id}	Get by id
MerchantsApi	listMerchants	GET /merchants	List
MerchantsApi	updateMerchant	PUT /merchants/{id}	Update
OAuth2AuthorizedClientsApi	createOAuth2AuthorizedClient	POST /oauth2/authorized-clients	Create
OAuth2AuthorizedClientsApi	deleteOAuth2AuthorizedClient	DELETE /oauth2/authorized-clients/{id}	Delete
OAuth2AuthorizedClientsApi	getOAuth2AuthorizedClient	GET /oauth2/authorized-clients/{id}	Get
OAuth2AuthorizedClientsApi	listOAuth2AuthorizedClients	GET /oauth2/authorized-clients	List
OAuth2AuthorizedClientsApi	updateOAuth2AuthorizedClient	PUT /oauth2/authorized-clients/{id}	Update
PlatformConsumptionsApi	createOrUpdateMyPlatformConsumption	PUT /platform-limit/consumptions/me	Create or update the Platform Consumption
PlatformConsumptionsApi	getMyPlatformConsumption	GET /platform-limit/consumptions/me	Get the Platform Consumption
PlatformLimitsApi	createPlatformLimit	POST /platform-limit/limits	Create Platform Limit
PlatformLimitsApi	deletePlatformLimit	DELETE /platform-limit/limits/{id}	Delete Platform Limit
PlatformLimitsApi	getPlatformLimit	GET /platform-limit/limits/{id}	Get Platform Limit
PlatformLimitsApi	listPlatformLimits	GET /platform-limit/limits	List Platform Limits
PlatformLimitsApi	updatePlatformLimit	PUT /platform-limit/limits/{id}	Update Platform Limit
PluginDiagnosticsApi	updateDiagnosticPluginCollection	PUT /accounts/me/plugin/diagnostics/plugins-collection	Update
RedeemCodesApi	redeemCode	POST /redeem-codes	Redeem the provided code and get a key
SitemapImportsApi	createSitemapImport	POST /sitemap-imports	Create
VectorSearchNodesApi	updateNodesCollection	PUT /vector-search/nodes-collection	Update
VectorSearchQueriesApi	createQuery	POST /vector-search/queries	Create
VectorSearchQuestionsApi	createVectorSearchQuestion	POST /vector-search/questions-collection	Create

Models

• Account
• AccountInfo
• AccountSubscription
• ActiveAccount
• AddOnConfiguration
• AnalyticsImportRequest
• AnchorText
• BotifyCrawlImportRequest
• BuildAuthorizeUriRequest
• BuildAuthorizeUriResponse
• DiagnosticPlugin
• DiagnosticPluginRequest
• DomainValidationRequest
• EmbeddingRequest
• ExchangeAuthCodeRequest
• ExchangeAuthCodeResponse
• Filter
• FilterValue
• IncludeExclude
• IncludeExcludeRequest
• InternalLink
• InternalLinkDestination
• InternalLinkRequest
• InternalLinkSource
• Item
• KgEmbeddingRequest
• Merchant
• MerchantEntry
• MerchantRequest
• MerchantSync
• MerchantView
• NetworkAccountInfo
• NodeRequest
• NodeRequestMetadataValue
• OAuth2AuthorizedClient
• OAuth2AuthorizedClientRequest
• PageActiveAccount
• PageAddOnConfiguration
• PageMerchantEntry
• PageMerchantSync
• PageMerchantView
• PageOAuth2AuthorizedClient
• PagePlatformLimit
• PageVectorSearchQueryResponseItem
• PageVectorSearchQuestionResponseItem
• PageWebsite
• PageWebsiteSearch
• PageWithLimits
• PlatformLimit
• PlatformLimitRequest
• ProblemDetail
• Request
• Response
• SitemapImportRequest
• UpdateAccountRequest
• VectorSearchQueryRequest
• VectorSearchQueryResponseItem
• VectorSearchQueryResponseItemFieldsValueInner
• VectorSearchQueryResponseItemMetadataValue
• VectorSearchQuestionRequest
• VectorSearchQuestionResponseItem
• WebPage
• Website
• WebsiteSearch
• WithLimits

Authorization

Authentication schemes defined for the API:

ApiKey

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

BasicAuth

• Type: HTTP basic authentication

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://s.wordlift.io/oauth/authorize/
• Scopes:
  • basic: basic scope

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

hello@wordlift.io

About this package

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

• API version: 1.0
  • Generator version: 7.9.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PhpClientCodegen