Class: Inttegro::Application::UpdateRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/app/update_request.rb

Overview

Typed representation of the update request object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#alias ⇒ String? (readonly)

Short name for the application. Use an empty string to clear it.

Optional in the API payload; omitted values default to nil. Wire name: alias.

Returns:

  • (String, nil) 


41
42
43
44
45
46
 
# File 'lib/inttegro/app/update_request.rb', line 41

class UpdateRequest < T::Struct
  const :name, T.nilable(String), default: nil
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
end

#description ⇒ String? (readonly)

Application description. Use an empty string to clear it.

Optional in the API payload; omitted values default to nil. Wire name: description.

Returns:

  • (String, nil) 


41
42
43
44
45
46
 
# File 'lib/inttegro/app/update_request.rb', line 41

class UpdateRequest < T::Struct
  const :name, T.nilable(String), default: nil
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
end

#legal_entity_type ⇒ String? (readonly)

Caller-defined legal-entity label. Send an empty string to clear it.

Optional in the API payload; omitted values default to nil. Wire name: legal_entity_type.

Returns:

  • (String, nil) 


41
42
43
44
45
46
 
# File 'lib/inttegro/app/update_request.rb', line 41

class UpdateRequest < T::Struct
  const :name, T.nilable(String), default: nil
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
end

#name ⇒ String? (readonly)

Display name for the application. Cannot be empty.

Optional in the API payload; omitted values default to nil. Wire name: name.

Returns:

  • (String, nil) 


41
42
43
44
45
46
 
# File 'lib/inttegro/app/update_request.rb', line 41

class UpdateRequest < T::Struct
  const :name, T.nilable(String), default: nil
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
end