README

Coveo平台API

更多信息，请访问 https://connect.coveo.com/s/discussions。

安装与使用

要求

PHP 8.1及更高版本。

Composer

要通过Composer安装绑定，请将以下内容添加到composer.json

composer require neclimdul/coveo-source-api

入门

请按照安装过程进行操作，然后运行以下命令

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

use NecLimDul\Coveo\SourceApi\ApiException;

// Configure OAuth2 access token for authorization: oauth2
$config = \NecLimDul\Coveo\SourceApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new \NecLimDul\Coveo\SourceApi\Api\MappingsApi(
    // If you want to 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
);
$organization_id = 'organization_id_example'; // string | The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`
$source_id = 'source_id_example'; // string | The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
$base_rule_model = new \NecLimDul\Coveo\SourceApi\Model\BaseRuleModel(); // \NecLimDul\Coveo\SourceApi\Model\BaseRuleModel
$rebuild = false; // bool | Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.<br />**Default:** `false`

try {
    $result = $apiInstance->addCommonMappingSettingsRule($organization_id, $source_id, $base_rule_model, $rebuild);
    print_r($result);
} catch (ApiException $e) {
    echo 'Exception when calling MappingsApi->addCommonMappingSettingsRule: ', $e->getMessage(), PHP_EOL;
}

API端点

所有URI都相对于https://platform.cloud.coveo.com

模型

• AddressPattern
• AdobeExperienceManagerSourceModel
• AmazonS3SourceModel
• AuthenticationFailedConfiguration
• BaseRuleModel
• BaseTypedMappingSettingsModelBaseRuleModel
• BatchOperationProgressModelTypedMappingSettingsModel
• BatchOperationResourceStatusModelTypedMappingSettingsModel
• BoxEnterprise2SourceModel
• BoxEnterpriseSourceModel
• BoxSingleUserSourceModel
• CascadingSecurityProvider
• 目录源模型
• 字符集检测提示
• 通用映射设置模型
• 配置
• 配置错误
• Confluence2托管源模型
• Confluence2源模型
• 自定义登录顺序
• 自定义源模型
• 数据文件
• 数据库源模型
• 详细安全标识模型
• 文档配置
• 文档权限模型
• 文档处理器
• 文档处理器配置
• 文档处理器参数
• DropboxForBusiness源模型
• Dropbox源模型
• 扩展配置
• 扩展数据文件
• 扩展设置
• 按扩展设置的扩展设置
• 扩展设置
• 字段映射模型
• 文件源模型
• 表单操作
• 表单认证步骤
• 表单认证配置
• 表单元素标识符
• 表单输入
• 通用REST源模型
• GetSource200响应
• GetSourcesOut参数
• Gmail域宽源模型
• GoogleDrive域宽源模型
• GraphQl源模型
• 小时分钟对
• 标识符和显示名称模型
• 项目修改周期
• Jira2托管源模型
• Jira2源模型
• Jive托管源模型
• Jive源模型
• 知识库发布状态
• Khoros源模型
• 语言提示
• 轻量级源模型
• 映射模型
• 映射配置模型
• 内存限制
• 元数据报告页面模型
• 元数据值模型
• MicrosoftDynamics条件
• MicrosoftDynamics条件
• MicrosoftDynamicsFetchXml查询
• MicrosoftDynamicsFetchXml查询
• MicrosoftDynamics对象
• MicrosoftDynamics关系
• MicrosoftDynamics源模型
• 下一操作
• 页面模型源字段模型
• 参数
• 参数模型
• 权限
• 权限级别
• 权限级别模型
• 权限模型
• 权限模型状态根本原因模型
• 权限集
• 权限集模型
• 推送源模型
• RSS源模型
• 原始源配置
• 规则模型
• SAP源模型
• Salesforce条件
• Salesforce字段
• SalesforceIn条件值
• Salesforce对象
• Salesforce关系
• Salesforce源模型
• 调度频率
• 调度模型
• 安全标识信息模型
• 安全提供程序
• 安全提供程序模型
• 安全提供程序引用模型
• ServiceNow源模型
• SharePointOnline2源模型
• SharePointOnline源模型
• SharePoint源模型
• 单个权限模型
• Sitecore源模型
• 网站地图源模型
• Slack源模型
• 源配置快照映射模型
• 源配置快照模型
• 源扩展模型
• 源扩展映射
• 源扩展模型
• 源字段模型
• 源信息
• 源最后操作
• 源元数据模型
• 源元数据状态模型
• 源模型
• 源权限更新模型
• 源状态
• Twitter2源模型
• 类型映射设置模型
• URL过滤器
• 用户身份
• 用户身份模型
• Web2源模型
• YouTube源模型
• Zendesk源模型

授权

oauth2

• 类型: OAuth
• 流程: implicit
• 授权URL: https://platform.cloud.coveo.com/oauth/authorize
• 作用域:
  • full: required

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

关于此包

此PHP包是由OpenAPI Generator项目自动生成的

• API版本: 1.0.0
• 构建包: org.openapitools.codegen.languages.PhpClientCodegen