Skip to content

Commit

Permalink
Add documentation for service CompanyConfigurationCard
Browse files Browse the repository at this point in the history 
Signed-off-by: mesilov <[email protected]>
  • Loading branch information
@mesilov
mesilov committed Dec 1, 2024
1 parent 0977afc commit ed507f5
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions docs/EN/Services/bitrix24-php-sdk-methods.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,15 @@
|`crm`|[crm.item.list](https://training.bitrix24.com/rest_help/crm/dynamic/methodscrmitem/crm_item_list.php)|Returns array with SPA items with entityTypeId|[`Bitrix24\SDK\Services\CRM\Item\Service\Item::list`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Item/Service/Item.php#L148-L162)<br/>Return type<br/>[`Bitrix24\SDK\Services\CRM\Item\Result\ItemsResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Item/Result/ItemsResult.php)<br/><br/>⚡️Batch methods: <br/><ul><li>`Bitrix24\SDK\Services\CRM\Item\Service\Batch::list`<br/>Return type: `Generator<int, Bitrix24\SDK\Services\CRM\Item\Result\ItemItemResult, mixed, mixed>`</li></ul>|
|`crm`|[crm.item.update](https://training.bitrix24.com/rest_help/crm/dynamic/methodscrmitem/crm_item_update.php)|Updates the specified (existing) item.|[`Bitrix24\SDK\Services\CRM\Item\Service\Item::update`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Item/Service/Item.php#L177-L189)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\UpdatedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/UpdatedItemResult.php)|
|`crm`|[crm.duplicate.findbycomm](https://training.bitrix24.com/rest_help/crm/auxiliary/duplicates/crm.duplicate.findbycomm.php)|The method returns IDs for leads, contacts or companies that contain the specified phone numbers or e-mails.|[`Bitrix24\SDK\Services\CRM\Duplicates\Service\Duplicate::findByEmail`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Duplicates/Service/Duplicate.php#L61-L69)<br/>Return type<br/>[`Bitrix24\SDK\Services\CRM\Duplicates\Result\DuplicateResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Duplicates/Result/DuplicateResult.php)|
|`crm`|[crm.company.contact.fields](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-fields.html)|Get Field Descriptions for Company-Contact Connection|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::fields`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L58-L61)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\FieldsResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/FieldsResult.php)|
|`crm`|[crm.company.contact.items.set](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-set.html)|Set a set of contacts associated with the specified company crm.company.contact.items.set|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::setItems`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L76-L102)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\UpdatedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/UpdatedItemResult.php)|
|`crm`|[crm.company.contact.items.get](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-get.html)|Get a set of contacts associated with the specified company crm.company.contact.items.get|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::get`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L115-L120)<br/>Return type<br/>[`Bitrix24\SDK\Services\CRM\Company\Result\CompanyContactConnectionResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Result/CompanyContactConnectionResult.php)|
|`crm`|[crm.company.contact.items.delete](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-delete.html)|Clear the set of contacts associated with the specified company|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::deleteItems`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L133-L138)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\DeletedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/DeletedItemResult.php)|
|`crm`|[crm.company.contact.add](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-add.html)|Add Contact to the Specified Company|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::add`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L151-L161)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\UpdatedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/UpdatedItemResult.php)|
|`crm`|[crm.company.contact.delete](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-delete.html)|Delete Contact from Specified Company|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::delete`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L175-L183)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\DeletedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/DeletedItemResult.php)|
|`crm`|[crm.company.details.configuration.get](https://apidocs.bitrix24.com/api-reference/crm/companies/custom-form/crm-company-details-configuration-get.html)|The method crm.company.details.configuration.get retrieves the settings of company cards for all users|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyDetailsConfiguration::getGeneral`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyDetailsConfiguration.php#L58-L63)<br/>Return type<br/>[`Bitrix24\SDK\Services\CRM\Common\Result\ElementCardConfiguration\CardConfigurationsResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Common/Result/ElementCardConfiguration/CardConfigurationsResult.php)|
|`crm`|[crm.company.details.configuration.reset](https://apidocs.bitrix24.com/api-reference/crm/companies/custom-form/crm-company-details-configuration-set.html)|Set Parameters for Individual CRM Company Detail Card Configuration|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyDetailsConfiguration::setGeneral`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyDetailsConfiguration.php#L146-L166)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\UpdatedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/UpdatedItemResult.php)|
|`crm`|[crm.company.details.configuration.forceCommonScopeForAll](https://apidocs.bitrix24.com/api-reference/crm/companies/custom-form/crm-company-details-configuration-force-common-scope-for-all.html)|Set Common Detail Form for All Users |[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyDetailsConfiguration::setForceCommonConfigForAll`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyDetailsConfiguration.php#L178-L181)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\UpdatedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/UpdatedItemResult.php)|
|`crm`|[crm.company.contact.fields](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-fields.html)|Get Field Descriptions for Company-Contact Connection|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::fields`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L48-L51)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\FieldsResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/FieldsResult.php)|
|`crm`|[crm.company.contact.items.set](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-set.html)|Set a set of contacts associated with the specified company crm.company.contact.items.set|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::setItems`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L66-L92)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\UpdatedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/UpdatedItemResult.php)|
|`crm`|[crm.company.contact.items.get](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-get.html)|Get a set of contacts associated with the specified company crm.company.contact.items.get|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::get`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L105-L110)<br/>Return type<br/>[`Bitrix24\SDK\Services\CRM\Company\Result\CompanyContactConnectionResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Result/CompanyContactConnectionResult.php)|
|`crm`|[crm.company.contact.items.delete](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-delete.html)|Clear the set of contacts associated with the specified company|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::deleteItems`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L123-L128)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\DeletedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/DeletedItemResult.php)|
|`crm`|[crm.company.contact.add](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-add.html)|Add Contact to the Specified Company|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::add`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L141-L151)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\UpdatedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/UpdatedItemResult.php)|
|`crm`|[crm.company.contact.delete](https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-delete.html)|Delete Contact from Specified Company|[`Bitrix24\SDK\Services\CRM\Company\Service\CompanyContact::delete`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/CompanyContact.php#L165-L173)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\DeletedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/DeletedItemResult.php)|
|`crm`|[crm.company.fields](https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-fields.html)|The method crm.company.fields returns the description of company fields, including custom fields.|[`Bitrix24\SDK\Services\CRM\Company\Service\Company::fields`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/Company.php#L63-L66)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\FieldsResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/FieldsResult.php)|
|`crm`|[crm.company.add](https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-add.html)|Add new company|[`Bitrix24\SDK\Services\CRM\Company\Service\Company::add`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/Company.php#L143-L154)<br/>Return type<br/>[`Bitrix24\SDK\Core\Result\AddedItemResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Core/Result/AddedItemResult.php)<br/><br/>⚡️Batch methods: <br/><ul><li>`Bitrix24\SDK\Services\CRM\Company\Service\Batch::add`<br/>Return type: `Generator<int, Bitrix24\SDK\Core\Result\AddedItemBatchResult, mixed, mixed>`</li></ul>|
|`crm`|[crm.company.get](https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-get.html)|The method crm.company.get returns a company by its identifier.|[`Bitrix24\SDK\Services\CRM\Company\Service\Company::get`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Service/Company.php#L172-L175)<br/>Return type<br/>[`Bitrix24\SDK\Services\CRM\Company\Result\CompanyResult`](https://github.com/bitrix24/b24phpsdk/blob/master/src/Services/CRM/Company/Result/CompanyResult.php)|
Expand Down

0 comments on commit ed507f5

Please sign in to comment.