This interface allows you to get, list, create, update and delete elastic sync mapping filters.
Plenty\Modules\ElasticSync\Contracts\Core
public createSyncMappingFilter(int $mappingId, array $data):void
Create a sync mapping filter.
int | $mappingId | The id of the mapping |
array | $data | The request data |
public getSyncMappingFilter(int $filterId):void
Get a sync mapping filter.
int | $filterId |
public listSyncMappingFilters(int $mappingId, array $filters = [], array $with = []):void
List sync mapping filters.
int | $mappingId | |
array | $filters | |
array | $with |
public updateSyncMappingFilter(int $filterId, array $data):void
Update a sync mapping filter.
int | $filterId | |
array | $data |
public deleteSyncMappingFilter(int $filterId):void
Delete a sync mapping filter.
int | $filterId |
public createSyncMappingFilters(int $mappingId, array $data):void
Create sync mapping filters.
int | $mappingId | The id of the mapping |
array | $data | The request data |
public updateSyncMappingFilters(int $mappingId, array $data):void
Update sync mapping filters.
int | $mappingId | |
array | $data |
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters(array $filters = []):void
Sets the filter array.
array | $filters |
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
This interface allows you to get, list, create, update and delete elastic sync mappings.
Plenty\Modules\ElasticSync\Contracts\Core
public createSyncMapping(int $syncId, array $data):void
Create a sync mapping.
int | $syncId | |
array | $data | The request data |
public getSyncMapping(int $mappingId, array $with = []):void
Get a sync mapping.
int | $mappingId | |
array | $with |
public listSyncMappings(int $syncId, int $page = 1, int $itemsPerPage = 50, int $paginate = 1, array $filters = [], array $with = []):PaginatedResult
List sync mappings.
int | $syncId | |
int | $page | |
int | $itemsPerPage | |
int | $paginate | |
array | $filters | |
array | $with |
public updateSyncMapping(int $mappingId, array $data):void
Update a sync mapping.
int | $mappingId | |
array | $data |
public deleteSyncMapping(int $mappingId):void
Delete a sync mapping.
int | $mappingId |
public deleteSyncMappings(array $mappingIds):void
Delete one or more mappings.
array | $mappingIds |
public copySyncMapping(array $mappingIds):array
Copy sync mapping.
array | $mappingIds |
public mappingValues(string $sync_type):array
Get the mapping values.
string | $sync_type |
public fieldValuesMap():array
Get the field value map for all sync types.
public listVariationMatched():array
Get a list with variation matches.
public modelKeyToFieldValueKey(string $syncType):array
Get the model key to field value key.
string | $syncType |
public filterLabelList():array
Get the label list for mapping filtration.
public mappingValuesTree(array $data):array
Get the mapping values tree.
array | $data |
public csvColumns(int $syncId):array
Get the csv columns of a sync.
int | $syncId |
public rowCsv(int $syncId):array
Get the csv rows.
int | $syncId |
public getPlentyFieldsValueMap(string $syncDataType):array
Get the plenty fields value map for a particular sync type.
string | $syncDataType |
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters(array $filters = []):void
Sets the filter array.
array | $filters |
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
This interface allows you to get, list, create, update and delete elastic sync mapping rows.
Plenty\Modules\ElasticSync\Contracts\Core
public createSyncMappingRow(int $mappingId, array $data):void
Create a sync mapping row.
int | $mappingId | The id of the mapping |
array | $data | The request data |
public getSyncMappingRow(int $rowId):void
Get a sync mapping row.
int | $rowId |
public listSyncMappingRows(int $mappingId, array $filters = [], array $with = [], int $page = 1, int $itemsPerPage = 25):void
List sync mapping rows.
int | $mappingId | |
array | $filters | |
array | $with | |
int | $page | |
int | $itemsPerPage |
public updateSyncMappingRow(int $rowId, array $data):void
Update a sync mapping row.
int | $rowId | |
array | $data |
public deleteSyncMappingRow(int $rowId):void
Delete a sync mapping row.
int | $rowId |
public updateSyncMappingRows(int $mappingId, array $data):void
Update sync mapping rows.
int | $mappingId | |
array | $data |
public createSyncMappingRows(int $mappingId, array $data):void
Create sync mapping rows.
int | $mappingId | The id of the mapping |
array | $data | The request data |
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters(array $filters = []):void
Sets the filter array.
array | $filters |
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
This interface allows you to get, list, create, update and delete elastic sync matches.
Plenty\Modules\ElasticSync\Contracts\Core
public createSyncMatching(int $syncId, array $data):void
Create a sync matching.
int | $syncId | The id of the sync |
array | $data | The request data |
public getSyncMatching(int $matchingId):void
Get a sync matching.
int | $matchingId |
public listSyncMatches(int $syncId, array $filters = [], array $with = []):void
List sync matches.
int | $syncId | |
array | $filters | |
array | $with |
public updateSyncMatching(int $matchingId, array $data):void
Update a sync matching.
int | $matchingId | |
array | $data |
public deleteSyncMatching(int $matchingId):void
Delete a sync matching.
int | $matchingId |
public getEntity(int $syncId):array
Get an entity.
int | $syncId |
public matchingFields(string $syncType):array
Get a list of all mappings for a particular sync type.
string | $syncType |
public createSyncMatches(int $syncId, array $data):void
Create sync matches.
int | $syncId | The id of the sync |
array | $data | The request data |
public updateSyncMatches(int $syncId, array $data):void
Update sync matches.
int | $syncId | |
array | $data |
public listDecimals():array
Get list of decimals.
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters(array $filters = []):void
Sets the filter array.
array | $filters |
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
This interface allows you to get, list, create, update and delete elastic sync options.
Plenty\Modules\ElasticSync\Contracts\Core
public createSyncOption(int $syncId, array $data):void
Create a sync option.
int | $syncId | The sync id |
array | $data | The request data |
public getSyncOption(int $optionId):void
Get a sync option.
int | $optionId |
public listSyncOptions(int $syncId, array $filters = [], array $with = []):void
List sync options.
int | $syncId | The sync id |
array | $filters | |
array | $with |
public updateSyncOption(int $optionId, array $data):void
Update a sync option.
int | $optionId | |
array | $data |
public deleteSyncOption(int $optionId):void
Delete a sync option.
int | $optionId |
public createSyncOptions(int $syncId, array $data):void
Create sync options.
int | $syncId | The sync id |
array | $data | The request data |
public updateSyncOptions(int $syncId, array $data):void
Update sync options.
int | $syncId | |
array | $data |
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters(array $filters = []):void
Sets the filter array.
array | $filters |
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
This interface allows you to get, list, create, update and delete elastic sync syncs.
Plenty\Modules\ElasticSync\Contracts\Core
public createSync(array $data):void
Create a sync.
array | $data | The request data |
public getSync(int $syncId, array $with = []):array
Get a sync.
int | $syncId | |
array | $with |
public listSyncs(int $page = 1, int $itemsPerPage = 50, int $paginate = 1, array $filters = [], array $with = []):PaginatedResult
Get all syncs
int | $page | |
int | $itemsPerPage | |
int | $paginate | |
array | $filters | |
array | $with |
public updateSync(int $syncId, array $data):void
Update a sync.
int | $syncId | |
array | $data |
public deleteSync(int $syncId):void
Delete a sync.
int | $syncId |
public deleteSyncs(array $syncIds):void
Delete syncs.
array | $syncIds |
public getListTypes():array
Get list of sync types.
public getListIntervals():array
Get list of sync intervals.
public getListDecimals():array
Get list of sync decimals.
public export(array $syncIds):array
Export the syncs.
array | $syncIds |
public copy(array $syncIds):array
Copy the syncs.
array | $syncIds |
public resetCache():array
Reset the cache.
public sourcePreview(int $syncId):array
Preview the syncs.
int | $syncId |
public scheduleTimes():string
Get schedule times.
public getReportLogs(int $page = 1, int $itemsPerPage = 50, int $paginate = 1, array $filters = [], array $with = []):PaginatedResult
Check Report Log.
int | $page | |
int | $itemsPerPage | |
int | $paginate | |
array | $filters | |
array | $with |
public saveCsvToS3(array $data):void
Save the CSV on S3.
array | $data |
public importSyncDifferent(array $data):void
Import the sync with different plentyId.
array | $data |
public getPreviewValues(int $syncId):array
Get preview of csv values.
int | $syncId |
public run(int $syncId, array $data):void
Execute the run procedure.
int | $syncId | |
array | $data |
public newRun(int $syncId, array $data):array
Execute the new run procedure.
int | $syncId | |
array | $data |
public report($id):array
Get Log by ID
$id |
public reportAvailable(int $page = 1, int $itemsPerPage = 50, int $paginate = 1, array $filters = [], array $with = []):array
Check Report Log.
int | $page | |
int | $itemsPerPage | |
int | $paginate | |
array | $filters | |
array | $with |
public exportSync(int $syncId):array
Export the sync.
int | $syncId |
public syncStatus():array
Get syncs status.
public updateCsvSync(array $data):void
Update the Csv of a Sync.
array | $data |
public importSyncJson(array $data):void
Save the CSV on S3.
array | $data |
public importSyncJsonDifferent(array $data):void
Import the sync with different plentyId.
array | $data |
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters(array $filters = []):void
Sets the filter array.
array | $filters |
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
describes properties of a Model
Plenty\Modules\ElasticSync\Contracts\Mapper
public getPropertyInformation(string $modelClassName):array
string | $modelClassName |
This interface provides methods to CRUD report options
Plenty\Modules\ElasticSync\Contracts\Report
public create(array $data):RunReportOption
Creates a run report option
array | $data |
public get(int $id):RunReportOption
Gets a run report option
int | $id |
public update(int $id, array $data):RunReportOption
Updates a run report option
int | $id | |
array | $data |
public delete(int $id):void
Deletes a run report option
int | $id |
public set($report, string $name, string $value = null, string $type = "string"):void
Sets a run report option
$report | ||
string | $name | |
string | $value | |
string | $type |
public getOptionByName($report, string $name):void
Gets the option of a report by name
$report | ||
string | $name |
public getValueByName($report, string $name):void
Gets the value of a report option
$report | ||
string | $name |
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters(array $filters = []):void
Sets the filter array.
array | $filters |
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
This interface provides methods to list reports
Plenty\Modules\ElasticSync\Contracts\Report
public getRunReport(int $id):RunReport
Gets a run report
int | $id |
public getRunReportLog(int $id):void
Gets a run report log
int | $id |
public cancelRun(int $id):void
Cancels a run
int | $id |
public listRunReports(int $page = 1, int $itemsPerPage = 50, array $filters = []):PaginatedResult
Lists run reports
int | $page | |
int | $itemsPerPage | |
array | $filters |
public listJobReports(int $reportId, int $page = 1, int $itemsPerPage = 50, array $filters = []):array
Lists job reports for a specific run
int | $reportId | |
int | $page | |
int | $itemsPerPage | |
array | $filters |
public listJobs(int $reportId):array
int | $reportId |
public listOutcomes(int $reportId, string $job):array
int | $reportId | |
string | $job |
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters(array $filters = []):void
Sets the filter array.
array | $filters |
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
The elastic sync mapping model.
Plenty\Modules\ElasticSync\Models\Core
Type | Name | Description |
---|---|---|
int | id | The ID of the elastic sync mapping |
int | syncId | The ID of the elastic sync sync |
string | name | The name of the elastic sync mapping |
int | position | The position of the elastic sync mapping |
bool | active | The state of the elastic sync mapping |
public toArray()
Returns this model as an array.
The elastic sync mapping filter model.
Plenty\Modules\ElasticSync\Models\Core
Type | Name | Description |
---|---|---|
int | id | The ID of the elastic sync mapping filter |
int | mappingId | The ID of the elastic sync mapping |
string | type | The type of the elastic sync mapping filter |
string | operator | The operator of the elastic sync mapping filter |
string | source | The source of the elastic sync mapping filter |
string | value | The value of the elastic sync mapping filter |
public toArray()
Returns this model as an array.
The elastic sync mapping row model.
Plenty\Modules\ElasticSync\Models\Core
Type | Name | Description |
---|---|---|
int | id | The ID of the elastic sync mapping row |
int | mappingId | The ID of the elastic sync mapping |
string | targetModel | The target model of the elastic sync mapping row |
string | targetAttribute | The target attribute of the elastic sync mapping row |
bool | active | The state of the elastic sync mapping row |
string | entityType | The entity type of the elastic sync mapping row (array values: 'ownValue', 'ownAssignment', 'regularExpression', 'csvColumn') |
string | value | The value of the elastic sync mapping row |
string | settings | The settings of the elastic sync mapping row |
string | identifiers | The identifiers of the elastic sync mapping row |
public toArray()
Returns this model as an array.
The elastic sync matching model.
Plenty\Modules\ElasticSync\Models\Core
Type | Name | Description |
---|---|---|
int | id | The ID of the elastic sync matching |
int | syncId | The ID of the elastic sync sync |
string | target | The target of the elastic sync matching |
string | source | The source of the elastic sync matching |
string | additionalValue | The additional value of the elastic sync matching |
public toArray()
Returns this model as an array.
The elastic sync option model.
Plenty\Modules\ElasticSync\Models\Core
Type | Name | Description |
---|---|---|
int | id | The ID of the elastic sync option |
int | syncId | The ID of the elastic sync sync |
string | optionIdentifier | The option identifier of the elastic sync option |
string | key | The key of the elastic sync option |
string | value | The value of the elastic sync option |
createdAt | The date when the elastic sync option was created | |
updatedAt | The date when the elastic sync option was last updated |
public toArray()
Returns this model as an array.
The elastic sync sync model.
Plenty\Modules\ElasticSync\Models\Core
Type | Name | Description |
---|---|---|
int | id | The ID of the elastic sync sync |
string | name | The name of the elastic sync sync |
string | syncType | The type of the elastic sync sync |
string | sourceType | The source type of the elastic sync sync |
string | sourceDataType | The source data type of the elastic sync sync |
lastRun | The date when elastic sync sync was last run | |
createdAt | The date when the elastic sync sync was created | |
updatedAt | The date when the elastic sync sync was last updated | |
Collection | matching | The matching relation |
Collection | options | The options relation |
Collection | mappings | The mapping relation |
Collection | reports | The reports relation |
public toArray()
Returns this model as an array.
property information
Plenty\Modules\ElasticSync\Models\DataProvider
public getType():string
public getName():string
public getDescription():string
The run report model.
Plenty\Modules\ElasticSync\Models\Report
Type | Name | Description |
---|---|---|
int | id | The ID of the run report |
int | sync_id | The ID of the sync |
int | jobs_total | The total number of jobs |
int | jobs_completed | The number of completed jobs |
int | errors | The number of errors |
string | children_identifier | The identifier used by children job reports |
string | report_filename | The name of the S3 report counterpart |
int | rows | The number of rows in the file |
int | rows_successful | The number of successful rows in the file |
string | date | The date when this report was created |
public toArray()
Returns this model as an array.
The run report option model.
Plenty\Modules\ElasticSync\Models\Report
Type | Name | Description |
---|---|---|
int | id | The ID of the run report option |
int | run_report_id | The ID of the run report |
string | name | The name |
string | value | The value |
string | type | The type |
public toArray()
Returns this model as an array.
The mapping model.
Plenty\Modules\ElasticSync\Models\Sync
Type | Name | Description |
---|---|---|
int | id | The ID of the mapping |
string | data | The data of the mapping |
createdAt | The date when the mapping was created | |
updatedAt | The date when the mapping was last updated | |
Mapping | mapping | The mapping from ElasticSync. |
public toArray()
Returns this model as an array.
The sync model.
Plenty\Modules\ElasticSync\Models\Sync
Type | Name | Description |
---|---|---|
int | id | The ID of the sync |
string | data | The data of the sync |
createdAt | The date when the sync was created | |
updatedAt | The date when the sync was last updated | |
Sync | sync | The sync from ElasticSync. |
public toArray()
Returns this model as an array.
The synclog model.
Plenty\Modules\ElasticSync\Models\Sync
Type | Name | Description |
---|---|---|
int | id | The ID of the synclog |
int | syncId | The syncId of the synclog |
string | syncHash | The syncHash of the synclog |
string | jobHash | The jobHash of the synclog |
string | hashDate | The hashDate of the synclog |
createdAt | The date when the synclog was created | |
updatedAt | The date when the synclog was last updated | |
SyncLog | syncLog | The sync log from ElasticSync. |
public toArray()
Returns this model as an array.