SfvbThemeJobResponse.md

UltracartClient::SfvbThemeJobResponse

Properties

Name	Type	Description	Notes
complete	Boolean	True once the job has stopped, whether it succeeded or failed.	[optional]
description	String	Human readable description of the job.	[optional]
error_message	String	Failure detail. Populated only when status is error.	[optional]
finished_dts	String	When the job stopped. Null until it does.	[optional]
job_id	Integer	Job handle. Poll getSfvbThemeJob with this.	[optional]
progress	Integer	Percent complete, 0-100.	[optional]
progress_description	String	What the job is doing right now, for example 'Duplicating locale text'.	[optional]
started_dts	String	When the job started running. Null until it does.	[optional]
status	String	Raw job status.	[optional]
submitted_dts	String	When the job was queued.	[optional]
success	Boolean	True only when the job finished successfully. Check complete first.	[optional]
target_path	String	Path the new theme is being created at. Returned when the job is started and on every poll, so you do not have to keep the response that started it. The theme oid itself is NOT returned, so once the job completes you list themes and match on this path. It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending.	[optional]

Example

require 'ultracart_api'

instance = UltracartClient::SfvbThemeJobResponse.new(
  complete: null,
  description: null,
  error_message: null,
  finished_dts: null,
  job_id: null,
  progress: null,
  progress_description: null,
  started_dts: null,
  status: null,
  submitted_dts: null,
  success: null,
  target_path: null
)