README

API documentation for the Widgetic API Gateway

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/widgetic/api-sdk-php.git"
    }
  ],
  "require": {
    "widgetic/api-sdk-php": "*@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 Bearer (JWT) authorization: apiKeyAuth
$config = WidgeticApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new WidgeticApi\Api\BrandKitApi(
    // 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
);
$asset_id = 'asset_id_example'; // string
$organization_id = 'organization_id_example'; // string

try {
    $result = $apiInstance->deleteBrandKitAsset_0($asset_id, $organization_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandKitApi->deleteBrandKitAsset_0: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.widgetic.com/v1

Class	Method	HTTP request	Description
BrandKitApi	deleteBrandKitAsset_0	DELETE /brand-kit/assets/{assetId}	Remove a font or icon from the Brand Kit
BrandKitApi	deleteBrandKit_0	DELETE /brand-kit	Reset the Brand Kit to the default
BrandKitApi	getBrandKit_0	GET /brand-kit	The Brand Kit of the current workspace
BrandKitApi	patchBrandKitAsset_0	PATCH /brand-kit/assets/{assetId}	Rename an icon or relabel a font variant
BrandKitApi	patchBrandKit_0	PATCH /brand-kit	Change part of the Brand Kit
BrandKitApi	postBrandKitFont_0	POST /brand-kit/fonts	Upload a font file to the Brand Kit
BrandKitApi	postBrandKitIcon_0	POST /brand-kit/icons	Add a named SVG icon to the Brand Kit
BrandKitApi	putBrandKit_0	PUT /brand-kit	Save Brand Kit tokens
CanvasesApi	createCanvas_0	POST /canvases	Create Canvas
CanvasesApi	deleteCanvas_0	DELETE /canvases/{id}	Delete Canvas
CanvasesApi	getAllCanvases_0	GET /canvases	Get All Canvases
CanvasesApi	getCanvas_0	GET /canvases/{id}	Get Canvas
CanvasesApi	updateCanvas_0	PUT /canvases/{id}	Update Canvas
CompositionsApi	addAiAnswersKnowledgeDocument_0	POST /compositions/{id}/adapters/ai-answers/knowledge/documents	Add a document for a widget's AI to answer from
CompositionsApi	addAiAnswersKnowledgeFile_0	POST /compositions/{id}/adapters/ai-answers/knowledge/documents/file	Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
CompositionsApi	checkCompositionAccess_0	GET /compositions/{id}/access	Check Composition Access
CompositionsApi	createCompositionContentItem_0	POST /compositions/{id}/content/{list}/items	Add a content list item
CompositionsApi	createCompositionDatabaseRecord_0	POST /compositions/{id}/database/{table}	Create Record In Composition Database
CompositionsApi	createComposition_0	POST /compositions	Create Composition
CompositionsApi	deleteCompositionContentItem_0	DELETE /compositions/{id}/content/{list}/items/{itemId}	Delete a content list item
CompositionsApi	deleteCompositionDataSource_0	DELETE /compositions/{id}/data-source	Remove the composition data source binding
CompositionsApi	deleteCompositionDatabaseRecord_0	DELETE /compositions/{id}/database/{table}/{recordId}	Delete Record From Composition Database
CompositionsApi	deleteComposition_0	DELETE /compositions/{id}	Delete Composition
CompositionsApi	describeCompositionEntries_0	GET /compositions/{id}/entries	Describe What a Composition Keeps
CompositionsApi	duplicateComposition_0	POST /compositions/{id}/duplicate	Duplicate Composition
CompositionsApi	getAiAnswersKnowledge_0	GET /compositions/{id}/adapters/ai-answers/knowledge	See the documents a widget's AI answers from
CompositionsApi	getAllCompositions_0	GET /compositions	Get All Compositions
CompositionsApi	getCompositionById_0	GET /compositions/{id}	Get Composition
CompositionsApi	getCompositionContentSchema_0	GET /compositions/{id}/schema/content	Get Content Schema
CompositionsApi	getCompositionContent_0	GET /compositions/{id}/content	Get Current Content
CompositionsApi	getCompositionDataSource_0	GET /compositions/{id}/data-source	Read the composition data source binding
CompositionsApi	getCompositionDatabaseRecord_0	GET /compositions/{id}/database/{table}/{recordId}	Get Record From Composition Database
CompositionsApi	getCompositionDatabaseRecords_0	GET /compositions/{id}/database/{table}	Get All Records From Composition Database Table
CompositionsApi	getCompositionDesignSchema_0	GET /compositions/{id}/schema/design	Get Design Schema
CompositionsApi	getCompositionDesign_0	GET /compositions/{id}/design	Get Composition Design
CompositionsApi	getCompositionEmbedSchema_0	GET /compositions/{id}/schema/embed	Get Embed Schema
CompositionsApi	getCompositionEmbedSettings_0	GET /compositions/{id}/embed-settings	Get Composition Embed Settings
CompositionsApi	getCompositionPreview_0	GET /compositions/{id}/preview	Get Composition Preview
CompositionsApi	getCompositionVersions_0	GET /compositions/{id}/versions	Get Composition Versions
CompositionsApi	getCompositionsBatch_0	POST /compositions/batch	Get Compositions Batch
CompositionsApi	patchCompositionContentItem_0	PATCH /compositions/{id}/content/{list}/items/{itemId}	Update a content list item
CompositionsApi	readCompositionEntries_0	GET /compositions/{id}/entries/{table}	Read the Entries of a Composition's Table
CompositionsApi	removeAiAnswersKnowledgeDocument_0	DELETE /compositions/{id}/adapters/ai-answers/knowledge/documents/{documentId}	Remove a document from a widget's knowledge base
CompositionsApi	setCompositionDataSource_0	PUT /compositions/{id}/data-source	Bind a public JSON data source for embed refresh
CompositionsApi	setDynamicContent_0	PUT /compositions/{id}/content	Set Dynamic Content
CompositionsApi	updateCompositionDatabaseRecord_0	PUT /compositions/{id}/database/{table}/{recordId}	Update Record In Composition Database
CompositionsApi	updateCompositionStatus_0	PUT /compositions/{id}/status	Update Composition Status
CompositionsApi	updateComposition_0	PUT /compositions/{id}	Update Composition
CompositionsApi	validateCompositionContent_0	POST /compositions/{id}/content/validate	Validate Content
CreditsApi	getUserCreditBalance_0	GET /credits/user/{userId}/balance	Get an account's credit balance
CreditsApi	getUserCreditTransactions_0	GET /credits/user/{userId}/transactions	List an account's credit ledger
EntitlementsApi	getManagedUserEntitlements_0	GET /entitlements/managed-users/{managedUserId}	Get managed user entitlements
EntitlementsApi	getPartnerEntitlements_0	GET /entitlements/partners/{partnerId}	Get partner entitlements
InvoicesApi	getInvoicesByPartnerId_0	GET /invoices/partner/{partnerId}	List a partner's invoices
ManagedUsersApi	copyPresetForManagedUser_0	POST /managed-users/{id}/presets/{key}/copy	Give a managed user a copy of one of your presets
ManagedUsersApi	createCompositionFromPreset_0	POST /managed-users/{id}/presets/{key}/composition	Create a composition from one of your presets in one call
ManagedUsersApi	createManagedUserEditorSession_0	POST /managed-users/{id}/editor-sessions	Create an editor session for a managed user
ManagedUsersApi	createManagedUser_0	POST /managed-users	Create Managed User
ManagedUsersApi	deleteManagedUser_0	DELETE /managed-users/{id}	Delete Managed User
ManagedUsersApi	getAllManagedUsers_0	GET /managed-users	Get Managed Users
ManagedUsersApi	getManagedUserById_0	GET /managed-users/{id}	Get Managed User By ID
ManagedUsersApi	getManagedUserDesignDefaults_0	GET /managed-users/{id}/design-defaults	Read design defaults for one managed user
ManagedUsersApi	getManagedUserLimits_0	GET /managed-users/{id}/limits	Read monthly credit cap and usage for one managed user
ManagedUsersApi	getManagedUserStorageUsage_0	GET /managed-users/{id}/storage-usage	Storage used by one managed user's uploads
ManagedUsersApi	getManagedUserUsage_0	GET /managed-users/{id}/usage	What a managed user's editor sessions spent
ManagedUsersApi	getManagedUsersByManagerId_0	GET /users/{managerId}/managed-users	Get Managed Users By Manager
ManagedUsersApi	revokeManagedUserEditorSession_0	DELETE /managed-users/{id}/editor-sessions/{sessionId}	End one editor session of a managed user
ManagedUsersApi	revokeManagedUserEditorSessions_0	DELETE /managed-users/{id}/editor-sessions	End every editor session of a managed user
ManagedUsersApi	setManagedUserDesignDefaults_0	PUT /managed-users/{id}/design-defaults	Set or clear design defaults for one managed user
ManagedUsersApi	setManagedUserLimits_0	PUT /managed-users/{id}/limits	Set or clear the monthly credit cap for one managed user
ManagedUsersApi	updateManagedUser_0	PUT /managed-users/{id}	Update Managed User
OperationsApi	operationsIdGet_0	GET /operations/{id}	Get operation status
PartnerApi	addAiAnswersKnowledgeDocument	POST /compositions/{id}/adapters/ai-answers/knowledge/documents	Add a document for a widget's AI to answer from
PartnerApi	addAiAnswersKnowledgeFile	POST /compositions/{id}/adapters/ai-answers/knowledge/documents/file	Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
PartnerApi	addPersonalWorkspaceDomain	POST /users/{id}/workspace/domains	Allow a website to show your widgets
PartnerApi	archiveWorkspaceWorkflow	POST /workspaces/{workspaceId}/workflows/{workflowId}/archive	Archive a Workflow
PartnerApi	callPublicCompositionAdapter	POST /embed/compositions/{compositionId}/adapters/{adapterId}/{operation}	Call a gateway operation of an adapter a published widget uses
PartnerApi	checkCompositionAccess	GET /compositions/{id}/access	Check Composition Access
PartnerApi	confirmPartnerAdapterConnection	POST /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm	Confirm a partner's adapter address with the code that was emailed to it
PartnerApi	confirmUserAdapterConnection	POST /users/{userId}/adapter-connections/{adapterId}/{credentialKey}/confirm	Confirm an adapter address with the code that was emailed to it
PartnerApi	copyPresetForManagedUser	POST /managed-users/{id}/presets/{key}/copy	Give a managed user a copy of one of your presets
PartnerApi	createCanvas	POST /canvases	Create Canvas
PartnerApi	createComposition	POST /compositions	Create Composition
PartnerApi	createCompositionContentItem	POST /compositions/{id}/content/{list}/items	Add a content list item
PartnerApi	createCompositionDatabaseRecord	POST /compositions/{id}/database/{table}	Create Record In Composition Database
PartnerApi	createCompositionFromPreset	POST /managed-users/{id}/presets/{key}/composition	Create a composition from one of your presets in one call
PartnerApi	createCompositionFromWidget	POST /widgets/{id}/composition	Create a composition for a widget in one call
PartnerApi	createManagedUser	POST /managed-users	Create Managed User
PartnerApi	createManagedUserEditorSession	POST /managed-users/{id}/editor-sessions	Create an editor session for a managed user
PartnerApi	createPartnerExtraCreditsInvoice	POST /partners/{partnerId}/credits/extra-invoice	Buy extra credits for a partner
PartnerApi	createPublicCompositionEntry	POST /embed/compositions/{compositionId}/entries/{table}	Append a visitor entry through the gateway
PartnerApi	createUserApiKey	POST /users/{id}/keys	Create an API key
PartnerApi	createWidget	POST /widgets	Create Widget
PartnerApi	createWorkspaceWorkflow	POST /workspaces/{workspaceId}/workflows	Create a Workflow
PartnerApi	createWorkspaceWorkflowFromPreset	POST /workspaces/{workspaceId}/workflows/from-preset	Start a Workflow from a starting point
PartnerApi	deleteBrandKit	DELETE /brand-kit	Reset the Brand Kit to the default
PartnerApi	deleteBrandKitAsset	DELETE /brand-kit/assets/{assetId}	Remove a font or icon from the Brand Kit
PartnerApi	deleteCanvas	DELETE /canvases/{id}	Delete Canvas
PartnerApi	deleteComposition	DELETE /compositions/{id}	Delete Composition
PartnerApi	deleteCompositionContentItem	DELETE /compositions/{id}/content/{list}/items/{itemId}	Delete a content list item
PartnerApi	deleteCompositionDataSource	DELETE /compositions/{id}/data-source	Remove the composition data source binding
PartnerApi	deleteCompositionDatabaseRecord	DELETE /compositions/{id}/database/{table}/{recordId}	Delete Record From Composition Database
PartnerApi	deleteCompositionEntryItems	DELETE /compositions/{id}/entries/{table}/items	Delete composition entry items by id or host context
PartnerApi	deleteManagedUser	DELETE /managed-users/{id}	Delete Managed User
PartnerApi	deletePersonalWorkspaceDomain	DELETE /users/{id}/workspace/domains/{domainId}	Stop allowing a website to show your widgets
PartnerApi	deleteUserApiKey	DELETE /users/{id}/keys/{keyId}	Delete an API key
PartnerApi	deleteWorkspaceWorkflow	DELETE /workspaces/{workspaceId}/workflows/{workflowId}	Delete a Workflow
PartnerApi	describeCompositionEntries	GET /compositions/{id}/entries	Describe What a Composition Keeps
PartnerApi	discardWorkspaceWorkflowChanges	POST /workspaces/{workspaceId}/workflows/{workflowId}/discard	Discard the Unpublished Changes of a Workflow
PartnerApi	duplicateComposition	POST /compositions/{id}/duplicate	Duplicate Composition
PartnerApi	duplicateWorkspaceWorkflow	POST /workspaces/{workspaceId}/workflows/{workflowId}/duplicate	Duplicate a Workflow
PartnerApi	exportCompositionEntryItems	GET /compositions/{id}/entries/{table}/export	Export composition entry items
PartnerApi	getAiAnswersKnowledge	GET /compositions/{id}/adapters/ai-answers/knowledge	See the documents a widget's AI answers from
PartnerApi	getAllCanvases	GET /canvases	Get All Canvases
PartnerApi	getAllCompositions	GET /compositions	Get All Compositions
PartnerApi	getAllManagedUsers	GET /managed-users	Get Managed Users
PartnerApi	getBrandKit	GET /brand-kit	The Brand Kit of the current workspace
PartnerApi	getCanvas	GET /canvases/{id}	Get Canvas
PartnerApi	getCompositionById	GET /compositions/{id}	Get Composition
PartnerApi	getCompositionContent	GET /compositions/{id}/content	Get Current Content
PartnerApi	getCompositionContentSchema	GET /compositions/{id}/schema/content	Get Content Schema
PartnerApi	getCompositionDataSource	GET /compositions/{id}/data-source	Read the composition data source binding
PartnerApi	getCompositionDatabaseRecord	GET /compositions/{id}/database/{table}/{recordId}	Get Record From Composition Database
PartnerApi	getCompositionDatabaseRecords	GET /compositions/{id}/database/{table}	Get All Records From Composition Database Table
PartnerApi	getCompositionDesign	GET /compositions/{id}/design	Get Composition Design
PartnerApi	getCompositionDesignSchema	GET /compositions/{id}/schema/design	Get Design Schema
PartnerApi	getCompositionEmbedSchema	GET /compositions/{id}/schema/embed	Get Embed Schema
PartnerApi	getCompositionEmbedSettings	GET /compositions/{id}/embed-settings	Get Composition Embed Settings
PartnerApi	getCompositionPreview	GET /compositions/{id}/preview	Get Composition Preview
PartnerApi	getCompositionVersions	GET /compositions/{id}/versions	Get Composition Versions
PartnerApi	getCompositionsBatch	POST /compositions/batch	Get Compositions Batch
PartnerApi	getInvoicesByPartnerId	GET /invoices/partner/{partnerId}	List a partner's invoices
PartnerApi	getManagedUserById	GET /managed-users/{id}	Get Managed User By ID
PartnerApi	getManagedUserDesignDefaults	GET /managed-users/{id}/design-defaults	Read design defaults for one managed user
PartnerApi	getManagedUserEntitlements	GET /entitlements/managed-users/{managedUserId}	Get managed user entitlements
PartnerApi	getManagedUserLimits	GET /managed-users/{id}/limits	Read monthly credit cap and usage for one managed user
PartnerApi	getManagedUserStorageUsage	GET /managed-users/{id}/storage-usage	Storage used by one managed user's uploads
PartnerApi	getManagedUserUsage	GET /managed-users/{id}/usage	What a managed user's editor sessions spent
PartnerApi	getManagedUsersByManagerId	GET /users/{managerId}/managed-users	Get Managed Users By Manager
PartnerApi	getMyPartners	GET /partners/mine	Find the partner you administer
PartnerApi	getPartnerAdapterConnections	GET /partners/{partnerId}/adapter-connections	See which adapter keys a partner has connected
PartnerApi	getPartnerAnalyticsByManagedUser	GET /partners/{partnerId}/analytics/managed-users	What each managed user's widgets did
PartnerApi	getPartnerAnalyticsSummary	GET /partners/{partnerId}/analytics/summary	What was done with a partner's published widgets
PartnerApi	getPartnerAnalyticsTimeline	GET /partners/{partnerId}/analytics/timeline	What was done with a partner's widgets, day by day
PartnerApi	getPartnerAnalyticsTopWidgets	GET /partners/{partnerId}/analytics/top-widgets	Which widgets were viewed the most
PartnerApi	getPartnerBillingOverview	GET /partners/{partnerId}/billing-overview	Get comprehensive partner billing overview
PartnerApi	getPartnerContract	GET /partners/{partnerId}/contract	Get a partner's contract
PartnerApi	getPartnerCreditBalance	GET /partners/{partnerId}/credits/balance	Get partner credit balance
PartnerApi	getPartnerCreditTransactions	GET /partners/{partnerId}/credits/transactions	Get partner credit transaction history
PartnerApi	getPartnerDataDatabase	GET /partners/{partnerId}/data-database	See the Neon database a partner keeps the data of its compositions in
PartnerApi	getPartnerDesignDefaults	GET /partners/{partnerId}/design-defaults	Read partner-wide design defaults
PartnerApi	getPartnerEntitlements	GET /entitlements/partners/{partnerId}	Get partner entitlements
PartnerApi	getPartnerEntryContextSigning	GET /partners/{partnerId}/entry-context-signing	See how the context of your embeds is signed
PartnerApi	getPartnerNotificationSettings	GET /partners/{partnerId}/notifications/settings	Where your notifications go
PartnerApi	getPartnerStorageDestination	GET /partners/{partnerId}/storage	Get where a partner's uploaded files are stored
PartnerApi	getPartnerStorageUsage	GET /partners/{partnerId}/storage/usage	What a partner's customers store
PartnerApi	getPersonalWorkspaceDomains	GET /users/{id}/workspace/domains	List the websites allowed to show your widgets
PartnerApi	getPublicCompositionEmbed	GET /embed/compositions/{compositionId}	Resolve a composition UUID to a published widget URL
PartnerApi	getPublicCompositionIframe	GET /embed/compositions/{compositionId}/frame	Embed a published composition with its saved values
PartnerApi	getPublicWorkflow	GET /embed/workflows/{workflowId}	Read the published Workflow of an embed
PartnerApi	getPublicWorkflowFrame	GET /embed/workflows/{workflowId}/frame	Show a published Workflow in a page of its own
PartnerApi	getPublicWorkflowVersion	GET /embed/workflows/{workflowId}/versions/{versionId}	Read one published version of a Workflow
PartnerApi	getUserAdapterConnections	GET /users/{userId}/adapter-connections	See which adapter keys an account has connected
PartnerApi	getUserApiKeyUsageLogs	GET /users/{id}/api-keys/{keyId}/logs	Read what an API key was used for
PartnerApi	getUserApiKeys	GET /users/{id}/keys	List the API keys of an account
PartnerApi	getUserCreditBalance	GET /credits/user/{userId}/balance	Get an account's credit balance
PartnerApi	getUserCreditTransactions	GET /credits/user/{userId}/transactions	List an account's credit ledger
PartnerApi	getWidgets	GET /widgets	List Widgets
PartnerApi	getWidgetsBatch	POST /widgets/batch	Get Widgets Batch
PartnerApi	getWorkspaceWorkflow	GET /workspaces/{workspaceId}/workflows/{workflowId}	Get a Workflow
PartnerApi	getWorkspaceWorkflowStats	GET /workspaces/{workspaceId}/workflows/{workflowId}/stats	Get what Visitors Did in a Workflow
PartnerApi	getWorkspaceWorkflowVersion	GET /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}	Get a Published Version of a Workflow
PartnerApi	listCompositionEntryItems	GET /compositions/{id}/entries/{table}/items	List composition entry items with paging and filters
PartnerApi	listManagedUserEntries	GET /managed-users/{id}/entries	List entries across a managed user's compositions
PartnerApi	listPartnerNotificationDeliveries	GET /partners/{partnerId}/notifications/deliveries	How your notifications reached you
PartnerApi	listPartnerNotifications	GET /partners/{partnerId}/notifications	What your partner account was told
PartnerApi	listPartnerPresets	GET /partners/{partnerId}/presets	List the widgets a partner offers as presets
PartnerApi	listPartnerWorkflowPresets	GET /partners/{partnerId}/workflow-presets	List the workflows a partner offers as places to start
PartnerApi	listWorkspaceWorkflowCompositionOptions	GET /workspaces/{workspaceId}/workflows/composition-options	List the compositions a workflow can show, and what each can do
PartnerApi	listWorkspaceWorkflowPresets	GET /workspaces/{workspaceId}/workflows/presets	List the starting points for a new Workflow
PartnerApi	listWorkspaceWorkflowVersions	GET /workspaces/{workspaceId}/workflows/{workflowId}/versions	List the Published Versions of a Workflow
PartnerApi	listWorkspaceWorkflows	GET /workspaces/{workspaceId}/workflows	List the Workflows of a Workspace
PartnerApi	operationsIdGet	GET /operations/{id}	Get operation status
PartnerApi	patchBrandKit	PATCH /brand-kit	Change part of the Brand Kit
PartnerApi	patchBrandKitAsset	PATCH /brand-kit/assets/{assetId}	Rename an icon or relabel a font variant
PartnerApi	patchCompositionContentItem	PATCH /compositions/{id}/content/{list}/items/{itemId}	Update a content list item
PartnerApi	pauseWorkspaceWorkflow	POST /workspaces/{workspaceId}/workflows/{workflowId}/pause	Pause a Workflow
PartnerApi	postBrandKitFont	POST /brand-kit/fonts	Upload a font file to the Brand Kit
PartnerApi	postBrandKitIcon	POST /brand-kit/icons	Add a named SVG icon to the Brand Kit
PartnerApi	postPublicCompositionEmbedStatus	POST /embed/compositions/status	Batch-check whether compositions are currently served for embed
PartnerApi	publishWorkspaceWorkflow	POST /workspaces/{workspaceId}/workflows/{workflowId}/publish	Publish the Draft of a Workflow
PartnerApi	putBrandKit	PUT /brand-kit	Save Brand Kit tokens
PartnerApi	readCompositionEntries	GET /compositions/{id}/entries/{table}	Read the Entries of a Composition's Table
PartnerApi	removeAiAnswersKnowledgeDocument	DELETE /compositions/{id}/adapters/ai-answers/knowledge/documents/{documentId}	Remove a document from a widget's knowledge base
PartnerApi	removePartnerAdapterConnection	DELETE /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}	Remove an adapter key from a partner
PartnerApi	removePartnerDataDatabase	DELETE /partners/{partnerId}/data-database	Stop keeping the data of a partner's compositions in its own database
PartnerApi	removePartnerPreset	DELETE /partners/{partnerId}/presets/{key}	Take a widget off the partner's presets
PartnerApi	removePartnerStorageDestination	DELETE /partners/{partnerId}/storage	Stop storing a partner's uploaded files in its own bucket
PartnerApi	removePartnerWorkflowPreset	DELETE /partners/{partnerId}/workflow-presets/{key}	Stop offering a workflow as a place to start
PartnerApi	removeUserAdapterConnection	DELETE /users/{userId}/adapter-connections/{adapterId}/{credentialKey}	Remove an adapter key from an account
PartnerApi	replayPartnerNotificationDelivery	POST /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay	Send a webhook delivery again
PartnerApi	reportPublicWorkflowEvents	POST /embed/workflows/{workflowId}/events	Report what visitors did in a Workflow, as counts
PartnerApi	restoreWorkspaceWorkflowVersion	POST /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore	Restore a Version of a Workflow into the Draft
PartnerApi	resumeWorkspaceWorkflow	POST /workspaces/{workspaceId}/workflows/{workflowId}/resume	Resume a Paused Workflow
PartnerApi	revokeManagedUserEditorSession	DELETE /managed-users/{id}/editor-sessions/{sessionId}	End one editor session of a managed user
PartnerApi	revokeManagedUserEditorSessions	DELETE /managed-users/{id}/editor-sessions	End every editor session of a managed user
PartnerApi	rotatePartnerEntryContextSecret	POST /partners/{partnerId}/entry-context-signing/secret	Make a secret to sign the context of your embeds
PartnerApi	rotatePartnerWebhookSecret	POST /partners/{partnerId}/notifications/webhook-secret	Make a new secret for your webhook
PartnerApi	saveWorkspaceWorkflow	PUT /workspaces/{workspaceId}/workflows/{workflowId}	Save the Draft of a Workflow
PartnerApi	sendPartnerNotificationTestEvent	POST /partners/{partnerId}/notifications/test-event	Send a test event to your webhook
PartnerApi	setCompositionDataSource	PUT /compositions/{id}/data-source	Bind a public JSON data source for embed refresh
PartnerApi	setDynamicContent	PUT /compositions/{id}/content	Set Dynamic Content
PartnerApi	setManagedUserDesignDefaults	PUT /managed-users/{id}/design-defaults	Set or clear design defaults for one managed user
PartnerApi	setManagedUserLimits	PUT /managed-users/{id}/limits	Set or clear the monthly credit cap for one managed user
PartnerApi	setPartnerAdapterConnection	PUT /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}	Connect an adapter key to a partner
PartnerApi	setPartnerDataDatabase	PUT /partners/{partnerId}/data-database	Keep the data of a partner's compositions in a Neon database of its own
PartnerApi	setPartnerDesignDefaults	PUT /partners/{partnerId}/design-defaults	Set or clear partner-wide design defaults
PartnerApi	setPartnerPreset	PUT /partners/{partnerId}/presets/{key}	Make a widget a preset, or replace a preset
PartnerApi	setPartnerStorageDestination	PUT /partners/{partnerId}/storage	Set where a partner's uploaded files are stored
PartnerApi	setPartnerWorkflowPreset	PUT /partners/{partnerId}/workflow-presets/{key}	Offer a workflow as a place to start, or replace what a key offers
PartnerApi	setUserAdapterConnection	PUT /users/{userId}/adapter-connections/{adapterId}/{credentialKey}	Connect an adapter key to an account
PartnerApi	unarchiveWorkspaceWorkflow	POST /workspaces/{workspaceId}/workflows/{workflowId}/unarchive	Unarchive a Workflow
PartnerApi	updateCanvas	PUT /canvases/{id}	Update Canvas
PartnerApi	updateComposition	PUT /compositions/{id}	Update Composition
PartnerApi	updateCompositionDatabaseRecord	PUT /compositions/{id}/database/{table}/{recordId}	Update Record In Composition Database
PartnerApi	updateCompositionStatus	PUT /compositions/{id}/status	Update Composition Status
PartnerApi	updateManagedUser	PUT /managed-users/{id}	Update Managed User
PartnerApi	updatePartnerEntryContextSigning	PUT /partners/{partnerId}/entry-context-signing	Require a signed context, or stop requiring it
PartnerApi	updatePartnerNotificationSettings	PUT /partners/{partnerId}/notifications/settings	Choose where your notifications go
PartnerApi	updatePersonalWorkspaceDomain	PUT /users/{id}/workspace/domains/{domainId}	Change a website on your list
PartnerApi	updateUserApiKey	PUT /users/{id}/keys/{keyId}	Rename an API key, or switch it off or on
PartnerApi	uploadPublicCompositionAdapterFile	PUT /embed/compositions/{compositionId}/adapters/upload/files/{ticket}	Send the file a visitor chose through the upload adapter of a published widget
PartnerApi	uploadsGet	GET /uploads	List the account's uploads
PartnerApi	uploadsIdDelete	DELETE /uploads/{id}	Delete an upload
PartnerApi	uploadsIdGet	GET /uploads/{id}	Get an upload by id
PartnerApi	uploadsLimitsGet	GET /uploads/limits	Upload size limits and accepted file types
PartnerApi	uploadsPost	POST /uploads	Upload a file
PartnerApi	validateCompositionContent	POST /compositions/{id}/content/validate	Validate Content
PartnerApi	validateToken	GET /tokens/validate	Validate current authentication token
PartnerApi	verifyPartnerDataDatabase	POST /partners/{partnerId}/data-database/verify	Check that a partner's own database still works
PartnerApi	verifyPartnerStorageDestination	POST /partners/{partnerId}/storage/verify	Check that a partner's storage destination still works
PartnersApi	confirmPartnerAdapterConnection_0	POST /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm	Confirm a partner's adapter address with the code that was emailed to it
PartnersApi	createPartnerExtraCreditsInvoice_0	POST /partners/{partnerId}/credits/extra-invoice	Buy extra credits for a partner
PartnersApi	getMyPartners_0	GET /partners/mine	Find the partner you administer
PartnersApi	getPartnerAdapterConnections_0	GET /partners/{partnerId}/adapter-connections	See which adapter keys a partner has connected
PartnersApi	getPartnerAnalyticsByManagedUser_0	GET /partners/{partnerId}/analytics/managed-users	What each managed user's widgets did
PartnersApi	getPartnerAnalyticsSummary_0	GET /partners/{partnerId}/analytics/summary	What was done with a partner's published widgets
PartnersApi	getPartnerAnalyticsTimeline_0	GET /partners/{partnerId}/analytics/timeline	What was done with a partner's widgets, day by day
PartnersApi	getPartnerAnalyticsTopWidgets_0	GET /partners/{partnerId}/analytics/top-widgets	Which widgets were viewed the most
PartnersApi	getPartnerBillingOverview_0	GET /partners/{partnerId}/billing-overview	Get comprehensive partner billing overview
PartnersApi	getPartnerContract_0	GET /partners/{partnerId}/contract	Get a partner's contract
PartnersApi	getPartnerCreditBalance_0	GET /partners/{partnerId}/credits/balance	Get partner credit balance
PartnersApi	getPartnerCreditTransactions_0	GET /partners/{partnerId}/credits/transactions	Get partner credit transaction history
PartnersApi	getPartnerDataDatabase_0	GET /partners/{partnerId}/data-database	See the Neon database a partner keeps the data of its compositions in
PartnersApi	getPartnerDesignDefaults_0	GET /partners/{partnerId}/design-defaults	Read partner-wide design defaults
PartnersApi	getPartnerEntryContextSigning_0	GET /partners/{partnerId}/entry-context-signing	See how the context of your embeds is signed
PartnersApi	getPartnerNotificationSettings_0	GET /partners/{partnerId}/notifications/settings	Where your notifications go
PartnersApi	getPartnerStorageDestination_0	GET /partners/{partnerId}/storage	Get where a partner's uploaded files are stored
PartnersApi	getPartnerStorageUsage_0	GET /partners/{partnerId}/storage/usage	What a partner's customers store
PartnersApi	listPartnerNotificationDeliveries_0	GET /partners/{partnerId}/notifications/deliveries	How your notifications reached you
PartnersApi	listPartnerNotifications_0	GET /partners/{partnerId}/notifications	What your partner account was told
PartnersApi	listPartnerPresets_0	GET /partners/{partnerId}/presets	List the widgets a partner offers as presets
PartnersApi	listPartnerWorkflowPresets_0	GET /partners/{partnerId}/workflow-presets	List the workflows a partner offers as places to start
PartnersApi	removePartnerAdapterConnection_0	DELETE /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}	Remove an adapter key from a partner
PartnersApi	removePartnerDataDatabase_0	DELETE /partners/{partnerId}/data-database	Stop keeping the data of a partner's compositions in its own database
PartnersApi	removePartnerPreset_0	DELETE /partners/{partnerId}/presets/{key}	Take a widget off the partner's presets
PartnersApi	removePartnerStorageDestination_0	DELETE /partners/{partnerId}/storage	Stop storing a partner's uploaded files in its own bucket
PartnersApi	removePartnerWorkflowPreset_0	DELETE /partners/{partnerId}/workflow-presets/{key}	Stop offering a workflow as a place to start
PartnersApi	replayPartnerNotificationDelivery_0	POST /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay	Send a webhook delivery again
PartnersApi	rotatePartnerEntryContextSecret_0	POST /partners/{partnerId}/entry-context-signing/secret	Make a secret to sign the context of your embeds
PartnersApi	rotatePartnerWebhookSecret_0	POST /partners/{partnerId}/notifications/webhook-secret	Make a new secret for your webhook
PartnersApi	sendPartnerNotificationTestEvent_0	POST /partners/{partnerId}/notifications/test-event	Send a test event to your webhook
PartnersApi	setPartnerAdapterConnection_0	PUT /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}	Connect an adapter key to a partner
PartnersApi	setPartnerDataDatabase_0	PUT /partners/{partnerId}/data-database	Keep the data of a partner's compositions in a Neon database of its own
PartnersApi	setPartnerDesignDefaults_0	PUT /partners/{partnerId}/design-defaults	Set or clear partner-wide design defaults
PartnersApi	setPartnerPreset_0	PUT /partners/{partnerId}/presets/{key}	Make a widget a preset, or replace a preset
PartnersApi	setPartnerStorageDestination_0	PUT /partners/{partnerId}/storage	Set where a partner's uploaded files are stored
PartnersApi	setPartnerWorkflowPreset_0	PUT /partners/{partnerId}/workflow-presets/{key}	Offer a workflow as a place to start, or replace what a key offers
PartnersApi	updatePartnerEntryContextSigning_0	PUT /partners/{partnerId}/entry-context-signing	Require a signed context, or stop requiring it
PartnersApi	updatePartnerNotificationSettings_0	PUT /partners/{partnerId}/notifications/settings	Choose where your notifications go
PartnersApi	verifyPartnerDataDatabase_0	POST /partners/{partnerId}/data-database/verify	Check that a partner's own database still works
PartnersApi	verifyPartnerStorageDestination_0	POST /partners/{partnerId}/storage/verify	Check that a partner's storage destination still works
PublicEmbedApi	callPublicCompositionAdapter_0	POST /embed/compositions/{compositionId}/adapters/{adapterId}/{operation}	Call a gateway operation of an adapter a published widget uses
PublicEmbedApi	createPublicCompositionEntry_0	POST /embed/compositions/{compositionId}/entries/{table}	Append a visitor entry through the gateway
PublicEmbedApi	getPublicCompositionEmbed_0	GET /embed/compositions/{compositionId}	Resolve a composition UUID to a published widget URL
PublicEmbedApi	getPublicCompositionIframe_0	GET /embed/compositions/{compositionId}/frame	Embed a published composition with its saved values
PublicEmbedApi	getPublicWorkflowFrame_0	GET /embed/workflows/{workflowId}/frame	Show a published Workflow in a page of its own
PublicEmbedApi	getPublicWorkflowVersion_0	GET /embed/workflows/{workflowId}/versions/{versionId}	Read one published version of a Workflow
PublicEmbedApi	getPublicWorkflow_0	GET /embed/workflows/{workflowId}	Read the published Workflow of an embed
PublicEmbedApi	postPublicCompositionEmbedStatus_0	POST /embed/compositions/status	Batch-check whether compositions are currently served for embed
PublicEmbedApi	reportPublicWorkflowEvents_0	POST /embed/workflows/{workflowId}/events	Report what visitors did in a Workflow, as counts
PublicEmbedApi	uploadPublicCompositionAdapterFile_0	PUT /embed/compositions/{compositionId}/adapters/upload/files/{ticket}	Send the file a visitor chose through the upload adapter of a published widget
TokensApi	validateToken_0	GET /tokens/validate	Validate current authentication token
UploadsApi	uploadsGet_0	GET /uploads	List the account's uploads
UploadsApi	uploadsIdDelete_0	DELETE /uploads/{id}	Delete an upload
UploadsApi	uploadsIdGet_0	GET /uploads/{id}	Get an upload by id
UploadsApi	uploadsLimitsGet_0	GET /uploads/limits	Upload size limits and accepted file types
UploadsApi	uploadsPost_0	POST /uploads	Upload a file
UsersApi	addPersonalWorkspaceDomain_0	POST /users/{id}/workspace/domains	Allow a website to show your widgets
UsersApi	confirmUserAdapterConnection_0	POST /users/{userId}/adapter-connections/{adapterId}/{credentialKey}/confirm	Confirm an adapter address with the code that was emailed to it
UsersApi	createUserApiKey_0	POST /users/{id}/keys	Create an API key
UsersApi	deletePersonalWorkspaceDomain_0	DELETE /users/{id}/workspace/domains/{domainId}	Stop allowing a website to show your widgets
UsersApi	deleteUserApiKey_0	DELETE /users/{id}/keys/{keyId}	Delete an API key
UsersApi	getPersonalWorkspaceDomains_0	GET /users/{id}/workspace/domains	List the websites allowed to show your widgets
UsersApi	getUserAdapterConnections_0	GET /users/{userId}/adapter-connections	See which adapter keys an account has connected
UsersApi	getUserApiKeyUsageLogs_0	GET /users/{id}/api-keys/{keyId}/logs	Read what an API key was used for
UsersApi	getUserApiKeys_0	GET /users/{id}/keys	List the API keys of an account
UsersApi	removeUserAdapterConnection_0	DELETE /users/{userId}/adapter-connections/{adapterId}/{credentialKey}	Remove an adapter key from an account
UsersApi	setUserAdapterConnection_0	PUT /users/{userId}/adapter-connections/{adapterId}/{credentialKey}	Connect an adapter key to an account
UsersApi	updatePersonalWorkspaceDomain_0	PUT /users/{id}/workspace/domains/{domainId}	Change a website on your list
UsersApi	updateUserApiKey_0	PUT /users/{id}/keys/{keyId}	Rename an API key, or switch it off or on
WidgetsApi	createCompositionFromWidget_0	POST /widgets/{id}/composition	Create a composition for a widget in one call
WidgetsApi	createWidget_0	POST /widgets	Create Widget
WidgetsApi	getWidgetsBatch_0	POST /widgets/batch	Get Widgets Batch
WidgetsApi	getWidgets_0	GET /widgets	List Widgets
WorkflowsApi	archiveWorkspaceWorkflow_0	POST /workspaces/{workspaceId}/workflows/{workflowId}/archive	Archive a Workflow
WorkflowsApi	createWorkspaceWorkflowFromPreset_0	POST /workspaces/{workspaceId}/workflows/from-preset	Start a Workflow from a starting point
WorkflowsApi	createWorkspaceWorkflow_0	POST /workspaces/{workspaceId}/workflows	Create a Workflow
WorkflowsApi	deleteWorkspaceWorkflow_0	DELETE /workspaces/{workspaceId}/workflows/{workflowId}	Delete a Workflow
WorkflowsApi	discardWorkspaceWorkflowChanges_0	POST /workspaces/{workspaceId}/workflows/{workflowId}/discard	Discard the Unpublished Changes of a Workflow
WorkflowsApi	duplicateWorkspaceWorkflow_0	POST /workspaces/{workspaceId}/workflows/{workflowId}/duplicate	Duplicate a Workflow
WorkflowsApi	getWorkspaceWorkflowStats_0	GET /workspaces/{workspaceId}/workflows/{workflowId}/stats	Get what Visitors Did in a Workflow
WorkflowsApi	getWorkspaceWorkflowVersion_0	GET /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}	Get a Published Version of a Workflow
WorkflowsApi	getWorkspaceWorkflow_0	GET /workspaces/{workspaceId}/workflows/{workflowId}	Get a Workflow
WorkflowsApi	listPartnerWorkflowPresets_1	GET /partners/{partnerId}/workflow-presets	List the workflows a partner offers as places to start
WorkflowsApi	listWorkspaceWorkflowCompositionOptions_0	GET /workspaces/{workspaceId}/workflows/composition-options	List the compositions a workflow can show, and what each can do
WorkflowsApi	listWorkspaceWorkflowPresets_0	GET /workspaces/{workspaceId}/workflows/presets	List the starting points for a new Workflow
WorkflowsApi	listWorkspaceWorkflowVersions_0	GET /workspaces/{workspaceId}/workflows/{workflowId}/versions	List the Published Versions of a Workflow
WorkflowsApi	listWorkspaceWorkflows_0	GET /workspaces/{workspaceId}/workflows	List the Workflows of a Workspace
WorkflowsApi	pauseWorkspaceWorkflow_0	POST /workspaces/{workspaceId}/workflows/{workflowId}/pause	Pause a Workflow
WorkflowsApi	publishWorkspaceWorkflow_0	POST /workspaces/{workspaceId}/workflows/{workflowId}/publish	Publish the Draft of a Workflow
WorkflowsApi	removePartnerWorkflowPreset_1	DELETE /partners/{partnerId}/workflow-presets/{key}	Stop offering a workflow as a place to start
WorkflowsApi	restoreWorkspaceWorkflowVersion_0	POST /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore	Restore a Version of a Workflow into the Draft
WorkflowsApi	resumeWorkspaceWorkflow_0	POST /workspaces/{workspaceId}/workflows/{workflowId}/resume	Resume a Paused Workflow
WorkflowsApi	saveWorkspaceWorkflow_0	PUT /workspaces/{workspaceId}/workflows/{workflowId}	Save the Draft of a Workflow
WorkflowsApi	setPartnerWorkflowPreset_1	PUT /partners/{partnerId}/workflow-presets/{key}	Offer a workflow as a place to start, or replace what a key offers
WorkflowsApi	unarchiveWorkspaceWorkflow_0	POST /workspaces/{workspaceId}/workflows/{workflowId}/unarchive	Unarchive a Workflow
WorkspacesApi	archiveWorkspaceWorkflow_1	POST /workspaces/{workspaceId}/workflows/{workflowId}/archive	Archive a Workflow
WorkspacesApi	createWorkspaceWorkflowFromPreset_1	POST /workspaces/{workspaceId}/workflows/from-preset	Start a Workflow from a starting point
WorkspacesApi	createWorkspaceWorkflow_1	POST /workspaces/{workspaceId}/workflows	Create a Workflow
WorkspacesApi	deleteWorkspaceWorkflow_1	DELETE /workspaces/{workspaceId}/workflows/{workflowId}	Delete a Workflow
WorkspacesApi	discardWorkspaceWorkflowChanges_1	POST /workspaces/{workspaceId}/workflows/{workflowId}/discard	Discard the Unpublished Changes of a Workflow
WorkspacesApi	duplicateWorkspaceWorkflow_1	POST /workspaces/{workspaceId}/workflows/{workflowId}/duplicate	Duplicate a Workflow
WorkspacesApi	getWorkspaceWorkflowStats_1	GET /workspaces/{workspaceId}/workflows/{workflowId}/stats	Get what Visitors Did in a Workflow
WorkspacesApi	getWorkspaceWorkflowVersion_1	GET /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}	Get a Published Version of a Workflow
WorkspacesApi	getWorkspaceWorkflow_1	GET /workspaces/{workspaceId}/workflows/{workflowId}	Get a Workflow
WorkspacesApi	listWorkspaceWorkflowCompositionOptions_1	GET /workspaces/{workspaceId}/workflows/composition-options	List the compositions a workflow can show, and what each can do
WorkspacesApi	listWorkspaceWorkflowPresets_1	GET /workspaces/{workspaceId}/workflows/presets	List the starting points for a new Workflow
WorkspacesApi	listWorkspaceWorkflowVersions_1	GET /workspaces/{workspaceId}/workflows/{workflowId}/versions	List the Published Versions of a Workflow
WorkspacesApi	listWorkspaceWorkflows_1	GET /workspaces/{workspaceId}/workflows	List the Workflows of a Workspace
WorkspacesApi	pauseWorkspaceWorkflow_1	POST /workspaces/{workspaceId}/workflows/{workflowId}/pause	Pause a Workflow
WorkspacesApi	publishWorkspaceWorkflow_1	POST /workspaces/{workspaceId}/workflows/{workflowId}/publish	Publish the Draft of a Workflow
WorkspacesApi	restoreWorkspaceWorkflowVersion_1	POST /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore	Restore a Version of a Workflow into the Draft
WorkspacesApi	resumeWorkspaceWorkflow_1	POST /workspaces/{workspaceId}/workflows/{workflowId}/resume	Resume a Paused Workflow
WorkspacesApi	saveWorkspaceWorkflow_1	PUT /workspaces/{workspaceId}/workflows/{workflowId}	Save the Draft of a Workflow
WorkspacesApi	unarchiveWorkspaceWorkflow_1	POST /workspaces/{workspaceId}/workflows/{workflowId}/unarchive	Unarchive a Workflow

Models

Authorization

Authentication schemes defined for the API:

apiKeyAuth

Type: Bearer authentication (JWT)

bearerAuth

Type: Bearer authentication (JWT)

BearerAuth

Type: Bearer authentication (JWT)

ApiKeyAuth

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

webhookSignature

Type: API key
API key parameter name: X-Webhook-Signature
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: 1.0.0
- Package version: 1.11.111
- Generator version: 7.9.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

widgetic / api-sdk-php

Package info

Security

Statistics