Class: Telnyx::Models::TermsOfServiceRetrieveInfoResponse::Agreement

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/terms_of_service_retrieve_info_response.rb

Defined Under Namespace

Modules: ProductType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(current_version: nil, description: nil, effective_date: nil, product_type: nil, terms_url: nil) ⇒ Object

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/telnyx/models/terms_of_service_retrieve_info_response.rb', line 16

class Agreement < Telnyx::Internal::Type::BaseModel
  # @!attribute current_version
  #
  #   @return [String, nil]
  optional :current_version, String

  # @!attribute description
  #
  #   @return [String, nil]
  optional :description, String

  # @!attribute effective_date
  #
  #   @return [Date, nil]
  optional :effective_date, Date

  # @!attribute product_type
  #   Telnyx product the Terms of Service apply to.
  #
  #   @return [Symbol, Telnyx::Models::TermsOfServiceRetrieveInfoResponse::Agreement::ProductType, nil]
  optional :product_type,
           enum: -> { Telnyx::Models::TermsOfServiceRetrieveInfoResponse::Agreement::ProductType }

  # @!attribute terms_url
  #
  #   @return [String, nil]
  optional :terms_url, String

  # @!method initialize(current_version: nil, description: nil, effective_date: nil, product_type: nil, terms_url: nil)
  #   @param current_version [String]
  #
  #   @param description [String]
  #
  #   @param effective_date [Date]
  #
  #   @param product_type [Symbol, Telnyx::Models::TermsOfServiceRetrieveInfoResponse::Agreement::ProductType] Telnyx product the Terms of Service apply to.
  #
  #   @param terms_url [String]

  # Telnyx product the Terms of Service apply to.
  #
  # @see Telnyx::Models::TermsOfServiceRetrieveInfoResponse::Agreement#product_type
  module ProductType
    extend Telnyx::Internal::Type::Enum

    BRANDED_CALLING = :branded_calling
    NUMBER_REPUTATION = :number_reputation

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#current_version ⇒ String?

Returns:

  • (String, nil) 


20
 
# File 'lib/telnyx/models/terms_of_service_retrieve_info_response.rb', line 20

optional :current_version, String

#description ⇒ String?

Returns:

  • (String, nil) 


25
 
# File 'lib/telnyx/models/terms_of_service_retrieve_info_response.rb', line 25

optional :description, String

#effective_date ⇒ Date?

Returns:

  • (Date, nil) 


30
 
# File 'lib/telnyx/models/terms_of_service_retrieve_info_response.rb', line 30

optional :effective_date, Date

#product_type ⇒ Symbol, ...

Telnyx product the Terms of Service apply to.

Returns:



36
37
 
# File 'lib/telnyx/models/terms_of_service_retrieve_info_response.rb', line 36

optional :product_type,
enum: -> { Telnyx::Models::TermsOfServiceRetrieveInfoResponse::Agreement::ProductType }

#terms_url ⇒ String?

Returns:

  • (String, nil) 


42
 
# File 'lib/telnyx/models/terms_of_service_retrieve_info_response.rb', line 42

optional :terms_url, String