KnowledgeBase
extends AbstractApiResourceGroup
in package
Company documents and sections. Requires knowledge_base_read or knowledge_base_write API scope.
Tags
Table of Contents
Methods
- documents() : KnowledgeBaseDocumentsResponse
- Makes GET "/api/v5/knowledge-base/documents" request.
- documentsCreate() : IdResponse
- Makes POST "/api/v5/knowledge-base/documents/create" request.
- documentsDelete() : SuccessResponse
- Makes POST "/api/v5/knowledge-base/documents/{id}/delete" request.
- documentsEdit() : IdResponse
- Makes POST "/api/v5/knowledge-base/documents/{id}/edit" request.
- documentsGet() : KnowledgeBaseDocumentResponse
- Makes GET "/api/v5/knowledge-base/documents/{id}" request.
- documentsHistory() : KnowledgeBaseDocumentsHistoryResponse
- Makes GET "/api/v5/knowledge-base/documents/history" request.
- sections() : KnowledgeBaseSectionsResponse
- Makes GET "/api/v5/knowledge-base/sections" request.
- sectionsCreate() : IdResponse
- Makes POST "/api/v5/knowledge-base/sections/create" request.
- sectionsDelete() : SuccessResponse
- Makes POST "/api/v5/knowledge-base/sections/{id}/delete" request.
- sectionsEdit() : IdResponse
- Makes POST "/api/v5/knowledge-base/sections/{id}/edit" request.
Methods
documents()
Makes GET "/api/v5/knowledge-base/documents" request.
public
documents([KnowledgeBaseDocumentsRequest|null $request = null ]) : KnowledgeBaseDocumentsResponse
Example (initialize $client with SimpleClientFactory first):
$request = new \RetailCrm\Api\Model\Request\KnowledgeBase\KnowledgeBaseDocumentsRequest();
$response = $client->knowledgeBase->documents($request);
Parameters
- $request : KnowledgeBaseDocumentsRequest|null = null
Tags
Return values
KnowledgeBaseDocumentsResponsedocumentsCreate()
Makes POST "/api/v5/knowledge-base/documents/create" request.
public
documentsCreate(KnowledgeBaseDocumentsCreateRequest $request) : IdResponse
Example (initialize $client with SimpleClientFactory first):
$request = new \RetailCrm\Api\Model\Request\KnowledgeBase\KnowledgeBaseDocumentsCreateRequest();
$request->document = new \RetailCrm\Api\Model\Entity\KnowledgeBase\KnowledgeBaseDocumentInput();
$request->document->title = 'Shipping';
$response = $client->knowledgeBase->documentsCreate($request);
Parameters
- $request : KnowledgeBaseDocumentsCreateRequest
Tags
Return values
IdResponsedocumentsDelete()
Makes POST "/api/v5/knowledge-base/documents/{id}/delete" request.
public
documentsDelete(int|string $id[, KnowledgeBaseDocumentByRequest|null $request = null ]) : SuccessResponse
Defaults to externalId; pass by=id to use the internal document ID.
Example (initialize $client with SimpleClientFactory first):
$request = new \RetailCrm\Api\Model\Request\KnowledgeBase\KnowledgeBaseDocumentByRequest();
$request->by = 'id';
$response = $client->knowledgeBase->documentsDelete(123, $request);
Parameters
- $id : int|string
- $request : KnowledgeBaseDocumentByRequest|null = null
Tags
Return values
SuccessResponsedocumentsEdit()
Makes POST "/api/v5/knowledge-base/documents/{id}/edit" request.
public
documentsEdit(int|string $id, KnowledgeBaseDocumentsEditRequest $request) : IdResponse
Defaults to externalId; pass by=id to use the internal document ID.
Example (initialize $client with SimpleClientFactory first):
$request = new \RetailCrm\Api\Model\Request\KnowledgeBase\KnowledgeBaseDocumentsEditRequest();
$request->document = new \RetailCrm\Api\Model\Entity\KnowledgeBase\KnowledgeBaseDocumentInput();
$request->document->title = 'Shipping';
$request->by = 'id';
$response = $client->knowledgeBase->documentsEdit(123, $request);
Parameters
- $id : int|string
- $request : KnowledgeBaseDocumentsEditRequest
Tags
Return values
IdResponsedocumentsGet()
Makes GET "/api/v5/knowledge-base/documents/{id}" request.
public
documentsGet(int|string $id[, KnowledgeBaseDocumentByRequest|null $request = null ]) : KnowledgeBaseDocumentResponse
Defaults to externalId; pass by=id to use the internal document ID.
Example (initialize $client with SimpleClientFactory first):
$request = new \RetailCrm\Api\Model\Request\KnowledgeBase\KnowledgeBaseDocumentByRequest();
$request->by = 'id';
$response = $client->knowledgeBase->documentsGet(123, $request);
Parameters
- $id : int|string
- $request : KnowledgeBaseDocumentByRequest|null = null
Tags
Return values
KnowledgeBaseDocumentResponsedocumentsHistory()
Makes GET "/api/v5/knowledge-base/documents/history" request.
public
documentsHistory([KnowledgeBaseDocumentsHistoryRequest|null $request = null ]) : KnowledgeBaseDocumentsHistoryResponse
Example (initialize $client with SimpleClientFactory first):
$request = new \RetailCrm\Api\Model\Request\KnowledgeBase\KnowledgeBaseDocumentsHistoryRequest();
$response = $client->knowledgeBase->documentsHistory($request);
Parameters
- $request : KnowledgeBaseDocumentsHistoryRequest|null = null
Tags
Return values
KnowledgeBaseDocumentsHistoryResponsesections()
Makes GET "/api/v5/knowledge-base/sections" request.
public
sections() : KnowledgeBaseSectionsResponse
Example (initialize $client with SimpleClientFactory first):
$response = $client->knowledgeBase->sections();
Tags
Return values
KnowledgeBaseSectionsResponsesectionsCreate()
Makes POST "/api/v5/knowledge-base/sections/create" request.
public
sectionsCreate(KnowledgeBaseSectionsCreateRequest $request) : IdResponse
Example (initialize $client with SimpleClientFactory first):
$request = new \RetailCrm\Api\Model\Request\KnowledgeBase\KnowledgeBaseSectionsCreateRequest();
$request->section = new \RetailCrm\Api\Model\Entity\KnowledgeBase\KnowledgeBaseSectionInput();
$request->section->name = 'Shipping';
$response = $client->knowledgeBase->sectionsCreate($request);
Parameters
- $request : KnowledgeBaseSectionsCreateRequest
Tags
Return values
IdResponsesectionsDelete()
Makes POST "/api/v5/knowledge-base/sections/{id}/delete" request.
public
sectionsDelete(int $id) : SuccessResponse
Deletes the section, all its subsections and their documents.
Example (initialize $client with SimpleClientFactory first):
$response = $client->knowledgeBase->sectionsDelete(123);
Parameters
- $id : int
Tags
Return values
SuccessResponsesectionsEdit()
Makes POST "/api/v5/knowledge-base/sections/{id}/edit" request.
public
sectionsEdit(int $id, KnowledgeBaseSectionsEditRequest $request) : IdResponse
Example (initialize $client with SimpleClientFactory first):
$request = new \RetailCrm\Api\Model\Request\KnowledgeBase\KnowledgeBaseSectionsEditRequest();
$request->section = new \RetailCrm\Api\Model\Entity\KnowledgeBase\KnowledgeBaseSectionInput();
$request->section->name = 'Shipping';
$response = $client->knowledgeBase->sectionsEdit(123, $request);
Parameters
- $id : int
- $request : KnowledgeBaseSectionsEditRequest