Class: TranscriptionsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/transcriptions_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ TranscriptionsClient

Initialize the TranscriptionsClient class with an API client instance.

Parameters:

  • connection (LockstepApi) —

    The API client object for this connection



22
23
24
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 22

def initialize(connection)
    @connection = connection
end

Instance Method Details

#create_transcription_validation_request(body:) ⇒ Object

Creates one Transcription Validation Request with all the associated request items within this account and returns the record as created.

A Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.

Parameters:

  • body (TranscriptionRequestSubmit) —

    The files which will be verified



71
72
73
74
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 71

def create_transcription_validation_request(body:)
    path = "/api/v1/Transcriptions/validate"
    @connection.request(:post, path, body, nil)
end

#creates_a_transcriptionvalidationrequestitemmodel(body:) ⇒ Object

Retrieves the TranscriptionValidationRequestItemModel specified by this unique identifier.

A TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.

Parameters:

  • body (TranscriptionRequestSubmit) —

    The TranscriptionValidationRequestItemModels to add to an existing TranscriptionValidationRequestItemModel



98
99
100
101
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 98

def creates_a_transcriptionvalidationrequestitemmodel(body:)
    path = "/api/v1/Transcriptions/validation-items"
    @connection.request(:post, path, body, nil)
end

#delete_a_transcriptionvalidationrequestitemmodel(id:) ⇒ Object

Deletes the TranscriptionValidationRequestItemModel specified by this unique identifier.

A TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the TranscriptionValidationRequestItemModel



134
135
136
137
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 134

def delete_a_transcriptionvalidationrequestitemmodel(id:)
    path = "/api/v1/Transcriptions/validation-items/#{id}"
    @connection.request(:delete, path, nil, nil)
end

#delete_transcription_validation_request(id:) ⇒ Object

Deletes the Transcription Validation Request and all associated items referred to by this unique identifier.

A Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the transcription validation request to delete



60
61
62
63
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 60

def delete_transcription_validation_request(id:)
    path = "/api/v1/Transcriptions/validate/#{id}"
    @connection.request(:delete, path, nil, nil)
end

#query_transcription_validation_request_items(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object

Queries TranscriptionValidationRequestItemModels for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.

More information on querying can be found on the [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.

Parameters:



149
150
151
152
153
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 149

def query_transcription_validation_request_items(filter:, include_param:, order:, page_size:, page_number:)
    path = "/api/v1/Transcriptions/validation-items/query"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @connection.request(:get, path, nil, params)
end

#query_transcription_validation_requests(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object

Queries transcription validation requests transactions for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.

More information on querying can be found on the [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.

Parameters:



86
87
88
89
90
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 86

def query_transcription_validation_requests(filter:, include_param:, order:, page_size:, page_number:)
    path = "/api/v1/Transcriptions/validate/query"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @connection.request(:get, path, nil, params)
end

#retrieve_a_transcriptionvalidationrequestitemmodel(id:) ⇒ Object

Retrieves the TranscriptionValidationRequestItemModel specified by this unique identifier.

A TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the TranscriptionValidationRequestItemModel



109
110
111
112
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 109

def retrieve_a_transcriptionvalidationrequestitemmodel(id:)
    path = "/api/v1/Transcriptions/validation-items/#{id}"
    @connection.request(:get, path, nil, nil)
end

#retrieve_an_emailreplygeneratorresponse(body:) ⇒ Object

Retrieves the Email Reply Generator Response containing a list of email reply suggestions

An Email Reply Generator Request represents an email to be sent for a list of email reply suggestions.

Parameters:

  • body (EmailReplyGeneratorRequest) —

    The Email Reply Generator Request to be sent



161
162
163
164
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 161

def retrieve_an_emailreplygeneratorresponse(body:)
    path = "/api/v1/Transcriptions/email-reply-suggestions"
    @connection.request(:post, path, body, nil)
end

#retrieve_transcription_validation_request(id:, include_param:) ⇒ Object

Retrieves the Transcription Validation Request specified by this unique identifier, optionally including nested data sets.

A Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the transcription validation request

  • include_param (string) —

    To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Items



34
35
36
37
38
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 34

def retrieve_transcription_validation_request(id:, include_param:)
    path = "/api/v1/Transcriptions/validate/#{id}"
    params = {:include => include_param}
    @connection.request(:get, path, nil, params)
end

#update_a_transcriptionvalidationrequestitemmodel(id:, body:) ⇒ Object

Updates the TranscriptionValidationRequestItemModel specified by this unique identifier.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.

A TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the TranscriptionValidationRequestItemModel

  • body (object) —

    A list of changes to apply to this TranscriptionValidationRequestItemModel



123
124
125
126
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 123

def update_a_transcriptionvalidationrequestitemmodel(id:, body:)
    path = "/api/v1/Transcriptions/validation-items/#{id}"
    @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
end

#update_transcription_validation_request(id:, body:) ⇒ Object

Updates an existing Transcription Validation Request with the information supplied to this PATCH call.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.

A Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the Transcription Validation Request to update

  • body (object) —

    A list of changes to apply to this Transcription Validation Request



49
50
51
52
 
# File 'lib/lockstep_sdk/clients/transcriptions_client.rb', line 49

def update_transcription_validation_request(id:, body:)
    path = "/api/v1/Transcriptions/validate/#{id}"
    @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
end