Class: LockstepSdk::TranscriptionValidationRequestModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/transcription_validation_request_model.rb

Overview

Represents a transcription validation request that is used to validate if file is of a specific type.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ TranscriptionValidationRequestModel

Initialize the TranscriptionValidationRequestModel using the provided prototype



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 25

def initialize(params = {})
    @transcription_validation_request_id = params.dig(:transcription_validation_request_id)
    @group_key = params.dig(:group_key)
    @status_code = params.dig(:status_code)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
    @items = params.dig(:items)
end

Instance Attribute Details

#created ⇒ Date-time

Returns The date on which this transcription validation request was created.

Returns:

  • (Date-time) —

    The date on which this transcription validation request was created.



50
51
52
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 50

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID number of the user who created this transcription validation request.

Returns:

  • (Uuid) —

    The ID number of the user who created this transcription validation request.



54
55
56
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 54

def created_user_id
  @created_user_id
end

#group_key ⇒ Uuid

Returns Group account transcription validation request is associated with.

Returns:

  • (Uuid) —

    Group account transcription validation request is associated with.



42
43
44
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 42

def group_key
  @group_key
end

#items ⇒ TranscriptionValidationRequestItemModel

Returns All items attached to this transcription validation request. To retrieve this collection, specify ‘Items` in the “Include” parameter for your query.

Returns:

  • (TranscriptionValidationRequestItemModel) —

    All items attached to this transcription validation request. To retrieve this collection, specify ‘Items` in the “Include” parameter for your query.



66
67
68
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 66

def items
  @items
end

#modified ⇒ Date-time

Returns The date on which this transcription validation request was last modified.

Returns:

  • (Date-time) —

    The date on which this transcription validation request was last modified.



58
59
60
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 58

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID number of the user who most recently modified this transcription validation request.

Returns:

  • (Uuid) —

    The ID number of the user who most recently modified this transcription validation request.



62
63
64
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 62

def modified_user_id
  @modified_user_id
end

#status_code ⇒ String

Returns A code identifying the status of this transcription validation request. Recognized Transcription Validation Request status codes are: * ‘New` - Represents a transcription validation request that is considered new and needs work to complete * `In Progress` - Represents a transcription validation request that is currently being worked on * `Failed` - Represents a transcription validation request that could not complete the validation process * `Complete` - Represents a transcription validation request that is considered complete and does not need any further work.

Returns:

  • (String) —

    A code identifying the status of this transcription validation request. Recognized Transcription Validation Request status codes are: * ‘New` - Represents a transcription validation request that is considered new and needs work to complete * `In Progress` - Represents a transcription validation request that is currently being worked on * `Failed` - Represents a transcription validation request that could not complete the validation process * `Complete` - Represents a transcription validation request that is considered complete and does not need any further work



46
47
48
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 46

def status_code
  @status_code
end

#transcription_validation_request_id ⇒ Uuid

Returns The unique identifier of the transcription validation request.

Returns:

  • (Uuid) —

    The unique identifier of the transcription validation request.



38
39
40
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 38

def transcription_validation_request_id
  @transcription_validation_request_id
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 70

def as_json(options={})
    {
        'transcriptionValidationRequestId' => @transcription_validation_request_id,
        'groupKey' => @group_key,
        'statusCode' => @status_code,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
        'items' => @items,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



85
86
87
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_model.rb', line 85

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end