Class: NgrokAPI::Models::TLSCertificate

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/models/tls_certificate.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:, result:) ⇒ TLSCertificate

Returns a new instance of TLSCertificate.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 30

def initialize(client:, result:)
  @client = client
  @result = result
  @id = @result['id']
  @uri = @result['uri']
  @created_at = @result['created_at']
  @description = @result['description']
  @metadata = @result['metadata']
  @certificate_pem = @result['certificate_pem']
  @subject_common_name = @result['subject_common_name']
  @subject_alternative_names = @result['subject_alternative_names']
  @issued_at = @result['issued_at']
  @not_before = @result['not_before']
  @not_after = @result['not_after']
  @key_usages = @result['key_usages']
  @extended_key_usages = @result['extended_key_usages']
  @private_key_type = @result['private_key_type']
  @issuer_common_name = @result['issuer_common_name']
  @serial_number = @result['serial_number']
  @subject_organization = @result['subject_organization']
  @subject_organizational_unit = @result['subject_organizational_unit']
  @subject_locality = @result['subject_locality']
  @subject_province = @result['subject_province']
  @subject_country = @result['subject_country']
end

Instance Attribute Details

#certificate_pem ⇒ Object (readonly)

Returns the value of attribute certificate_pem.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def certificate_pem
  @certificate_pem
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def client
  @client
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def created_at
  @created_at
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def description
  @description
end

#extended_key_usages ⇒ Object (readonly)

Returns the value of attribute extended_key_usages.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def extended_key_usages
  @extended_key_usages
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def id
  @id
end

#issued_at ⇒ Object (readonly)

Returns the value of attribute issued_at.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def issued_at
  @issued_at
end

#issuer_common_name ⇒ Object (readonly)

Returns the value of attribute issuer_common_name.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def issuer_common_name
  @issuer_common_name
end

#key_usages ⇒ Object (readonly)

Returns the value of attribute key_usages.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def key_usages
  @key_usages
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def metadata
  @metadata
end

#not_after ⇒ Object (readonly)

Returns the value of attribute not_after.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def not_after
  @not_after
end

#not_before ⇒ Object (readonly)

Returns the value of attribute not_before.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def not_before
  @not_before
end

#private_key_type ⇒ Object (readonly)

Returns the value of attribute private_key_type.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def private_key_type
  @private_key_type
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def result
  @result
end

#serial_number ⇒ Object (readonly)

Returns the value of attribute serial_number.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def serial_number
  @serial_number
end

#subject_alternative_names ⇒ Object (readonly)

Returns the value of attribute subject_alternative_names.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def subject_alternative_names
  @subject_alternative_names
end

#subject_common_name ⇒ Object (readonly)

Returns the value of attribute subject_common_name.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def subject_common_name
  @subject_common_name
end

#subject_country ⇒ Object (readonly)

Returns the value of attribute subject_country.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def subject_country
  @subject_country
end

#subject_locality ⇒ Object (readonly)

Returns the value of attribute subject_locality.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def subject_locality
  @subject_locality
end

#subject_organization ⇒ Object (readonly)

Returns the value of attribute subject_organization.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def subject_organization
  @subject_organization
end

#subject_organizational_unit ⇒ Object (readonly)

Returns the value of attribute subject_organizational_unit.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def subject_organizational_unit
  @subject_organizational_unit
end

#subject_province ⇒ Object (readonly)

Returns the value of attribute subject_province.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def subject_province
  @subject_province
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



6
7
8
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 6

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



56
57
58
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 56

def ==(other)
  @result == other.result
end

#delete ⇒ Object

Delete a TLS certificate

https://ngrok.com/docs/api#api-tls-certificates-delete



68
69
70
71
72
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 68

def delete
  @client.delete(
    id: @id
  )
end

#to_s ⇒ Object 



60
61
62
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 60

def to_s
  @result.to_s
end

#update(description: nil, metadata: nil) ⇒ Object

Update attributes of a TLS Certificate by ID

https://ngrok.com/docs/api#api-tls-certificates-update



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ngrokapi/models/tls_certificate.rb', line 78

def update(
  description: nil,
  metadata: nil
)
  @description = description if description
  @metadata = metadata if metadata
  @client.update(
    id: @id,
    description: description,
    metadata: metadata
  )
end