Class: LockstepSdk::TranscriptionRequestSubmit

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

Overview

A request to transcribe the provided file content to a Lockstep Platform object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ TranscriptionRequestSubmit

Initialize the TranscriptionRequestSubmit using the provided prototype



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

def initialize(params = {})
    @file_content = params.dig(:file_content)
    @file_url = params.dig(:file_url)
    @file_content_url = params.dig(:file_content_url)
    @file_name = params.dig(:file_name)
    @invoice_type_code = params.dig(:invoice_type_code)
    @transcription_validation_request_id = params.dig(:transcription_validation_request_id)
end

Instance Attribute Details

#file_content ⇒ String

Returns The base64 string of document content.

Returns:

  • (String) —

    The base64 string of document content



36
37
38
 
# File 'lib/lockstep_sdk/models/transcription_request_submit.rb', line 36

def file_content
  @file_content
end

#file_content_url ⇒ String

Returns The location of the file provided.

Returns:

  • (String) —

    The location of the file provided



44
45
46
 
# File 'lib/lockstep_sdk/models/transcription_request_submit.rb', line 44

def file_content_url
  @file_content_url
end

#file_name ⇒ String

Returns The name of the file provided.

Returns:

  • (String) —

    The name of the file provided



48
49
50
 
# File 'lib/lockstep_sdk/models/transcription_request_submit.rb', line 48

def file_name
  @file_name
end

#file_url ⇒ String

Returns The location of the file provided.

Returns:

  • (String) —

    The location of the file provided



40
41
42
 
# File 'lib/lockstep_sdk/models/transcription_request_submit.rb', line 40

def file_url
  @file_url
end

#invoice_type_code ⇒ String

Returns The type of TranscriptionRequestSubmit.InvoiceTypeCode requested to transcribe content to.

Returns:

  • (String) —

    The type of TranscriptionRequestSubmit.InvoiceTypeCode requested to transcribe content to.



52
53
54
 
# File 'lib/lockstep_sdk/models/transcription_request_submit.rb', line 52

def invoice_type_code
  @invoice_type_code
end

#transcription_validation_request_id ⇒ Uuid

Returns Group account transcription validation request item is associated with.

Returns:

  • (Uuid) —

    Group account transcription validation request item is associated with.



56
57
58
 
# File 'lib/lockstep_sdk/models/transcription_request_submit.rb', line 56

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/lockstep_sdk/models/transcription_request_submit.rb', line 60

def as_json(options={})
    {
        'fileContent' => @file_content,
        'fileUrl' => @file_url,
        'fileContentUrl' => @file_content_url,
        'fileName' => @file_name,
        'invoiceTypeCode' => @invoice_type_code,
        'transcriptionValidationRequestId' => @transcription_validation_request_id,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



73
74
75
 
# File 'lib/lockstep_sdk/models/transcription_request_submit.rb', line 73

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