Class: Copyleaks::ExportResults

Inherits:
Object
  • Object
show all
Defined in:
lib/copyleaks/models/exports/export_results.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, endpoint, verb, headers = nil) ⇒ ExportResults

Returns a new instance of ExportResults.

Parameters:

  • id (String) —

    Result identification to be downloaded. You get these identifications from the completed webhook. api.copyleaks.com/documentation/v3/webhooks/completed

  • endpoint (String) —

    The HTTP url to upload the data.

  • verb (String) —

    The HTTP verb (also called “HTTP Methods”) to upload the data to your specified endpoint.

  • headers (string[][]) (defaults to: nil) —

    List of headers to be submitted with the upload request. You may use this field to provide additional request headers, such as “Authorization” header. Example: [[“header-key1”, “header-value1”], [“header-key2”, “header-value2”]]



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/copyleaks/models/exports/export_results.rb', line 32

def initialize(id, endpoint, verb, headers = nil)
  raise 'Copyleaks::ExportResults - id - id must be of type String' unless id.instance_of?(String)
  raise 'Copyleaks::ExportResults - endpoint - endpoint must be of type String' unless endpoint.instance_of?(String)
  raise 'Copyleaks::ExportResults - verb - verb must be of type String' unless verb.instance_of?(String)

  @id = id
  @endpoint = endpoint
  @verb = verb
  @headers = headers
end

Instance Attribute Details

#endpoint ⇒ Object (readonly)

Returns the value of attribute endpoint.



26
27
28
 
# File 'lib/copyleaks/models/exports/export_results.rb', line 26

def endpoint
  @endpoint
end

#headers ⇒ Object (readonly)

Returns the value of attribute headers.



26
27
28
 
# File 'lib/copyleaks/models/exports/export_results.rb', line 26

def headers
  @headers
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



26
27
28
 
# File 'lib/copyleaks/models/exports/export_results.rb', line 26

def id
  @id
end

#verb ⇒ Object (readonly)

Returns the value of attribute verb.



26
27
28
 
# File 'lib/copyleaks/models/exports/export_results.rb', line 26

def verb
  @verb
end

Instance Method Details

#as_json(*_args) ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'lib/copyleaks/models/exports/export_results.rb', line 43

def as_json(*_args)
  {
    id: @id,
    endpoint: @endpoint,
    verb: @verb,
    headers: @headers
  }.select { |_k, v| !v.nil? }
end

#to_json(*options) ⇒ Object 



52
53
54
 
# File 'lib/copyleaks/models/exports/export_results.rb', line 52

def to_json(*options)
  as_json(*options).to_json(*options)
end