Apiv4 entity parity

Here are the entities in APIv3 & not v4

In some cases by design - others we should maybe add...

Prioritised

• Attachment.php - get has been added to support viewing attachments in SearchKit but create is still missing
• Extension.php - various install, uninstall etc functions (support for some actions already implemented)

Partially done - lets resolve

• MembershipLog.php https://github.com/civicrm/civicrm-core/pull/21106

Standard crud - note that doing these involves checking all pseudoconstants are correctly defined

• SmsProvider.php
• Premium.php
• RecurringEntity.php

Mailing related - in scope

• MailingAB.php
• MailingComponent.php
• MailingContact.php
• MailingEventResubscribe.php
• MailingRecipients.php

From here on down we are out of scope for 'entity parity'

Order related - needed when we get to afform payment forms - out of scope for entity parity

• Order.php
• Payment.php

Varied utils - out of scope for 'entity parity' - ad hoc

• SystemLog.php
• User.php
• Logging.php

Migration doubtful - to be done ad hoc if we decide to

• ReportTemplate.php
• ParticipantPayment.php - likely should not be brought over
• CxnApp.php
• Cxn.php
• Profile.php

Do not migrate

• ActivityType.php (by design)
• CustomSearch.php (by design)
• Constant.php (by design)
• SurveyRespondant.php(by design)
• MembershipPayment.php (by design - use Line Item)

Done

• AclRole.php ACLEntityRole https://github.com/civicrm/civicrm-core/pull/20474
• Batch.php https://github.com/civicrm/civicrm-core/pull/19931
• CaseContact.php https://github.com/civicrm/civicrm-core/pull/19907
• Case.php https://github.com/civicrm/civicrm-core/pull/19907
• CaseType.php
• ContributionProduct.php #2683 (closed)
• Dedupe.php
• EntityBatch.php #2682 (closed)
• EntityFinancialAccount.php - https://github.com/civicrm/civicrm-core/pull/19927
• EntityFinancialTrxn.php - https://github.com/civicrm/civicrm-core/pull/19932
• Exception.php DedupeException.php https://github.com/civicrm/civicrm-core/pull/20466
• File.php (part of attachment) https://github.com/civicrm/civicrm-core/pull/21158
• FinancialItem.php - https://github.com/civicrm/civicrm-core/pull/20433
• Job.php (crud portion)
• Job.php
• JobLog.php
• Mailing.php - there are a bunch of related entities - see further down)
• MailingEventConfirm.php
• MailingEventQueue.php
• MailingEventSubscribe.php
• MailingEventUnsubscribe.php
• MailingGroup.php
• MailingJob.php
• Membership.php - see #2634 (closed) https://github.com/civicrm/civicrm-core/pull/21106
• MembershipBlock.php https://github.com/civicrm/civicrm-core/pull/21106
• MembershipStatus.php https://github.com/civicrm/civicrm-core/pull/21106
• ParticipantStatusType.php
• PaymentToken.php
• Pcp.php
• PrintLabel.php https://github.com/civicrm/civicrm-core/pull/21500
• Product.php - since 5.41
• ReportInstance.php
• Rule.php DedupeRule.php https://github.com/civicrm/civicrm-core/pull/20466
• RuleGroup.php DedupeRuleGroup.php https://github.com/civicrm/civicrm-core/pull/20466
• Survey.php https://github.com/civicrm/civicrm-core/pull/21355
• WordReplacement.php https://github.com/civicrm/civicrm-core/pull/20559

changed the description

changed the description

changed the description

changed the description

mentioned in commit becebb63

mentioned in commit 027ef846

added comp:APIv4 label

added triaged label

mentioned in commit 177b66d2

marked the checklist item EntityFinancialTrxn.php - https://github.com/civicrm/civicrm-core/pull/19932 as completed

changed the description

marked the checklist item PaymentToken.php as completed

mentioned in commit bbfe4595

@colemanw @seamuslee @monish.deb @totten I'm looking at adding the DedupeRule & DedupeRuleGroup & DedupeException api but my hesitation is the BAO names are actually Rule and RuleGroup & Exception which feels a bit 'vague'

In the past we HAVE renamed BAO (price sets) and it was a PITA but only because we let it be

CRM_Dedupe_DAO_Rule -> rename to CRM_Dedupe_DAO_DedupeRule means every reference needs to be updated

But, if we create a new old class

CRM_Dedupe_DAO_Rule extends CRM_Dedupe_DAO_DedupeRule

we actually don't need to pro-actively update any code outside the actual DAO/BAO

That sounds like a good plan. It's probably possible to create an api in v4 that doesn't match the DAO name, but it sounds like the DAOs kinda need renaming anyway.

I have submitted a core PR https://github.com/civicrm/civicrm-core/pull/20466 for renaming Rule to DedupeRule, but its a partial patch as I am not sure about few items listed here

marked the checklist item CaseContact.php https://github.com/civicrm/civicrm-core/pull/19907 as completed

marked the checklist item Case.php https://github.com/civicrm/civicrm-core/pull/19907 as completed

marked the checklist item CaseType.php as completed