Class: LogaltyCertificateIssuanceApiCerty::CancelRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb

Overview

CancelRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(additional_properties: nil) ⇒ CancelRequest

Returns a new instance of CancelRequest.



33
34
35
36
37
38
39
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 33

def initialize(additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @operation = 'cancel'
  @additional_properties = additional_properties
end

Instance Attribute Details

#operation ⇒ String (readonly)

Fixed value ‘cancel`.

Returns:

  • (String) 


14
15
16
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 14

def operation
  @operation
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 42

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.


  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  CancelRequest.new(additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 17

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['operation'] = 'operation'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



29
30
31
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 29

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 24

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (CancelRequest | Hash) —

    value against the validation is performed.



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 61

def self.validate(value)
  if value.instance_of? self
    return APIHelper.valid_type?(value.operation,
                                 ->(val) { val.instance_of? String })
  end

  return false unless value.instance_of? Hash

  APIHelper.valid_type?(value['operation'],
                        ->(val) { val.instance_of? String })
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



81
82
83
84
85
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 81

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} operation: #{@operation.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



74
75
76
77
78
 
# File 'lib/logalty_certificate_issuance_api_certy/models/cancel_request.rb', line 74

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} operation: #{@operation}, additional_properties:"\
  " #{@additional_properties}>"
end