Class: Inttegro::Application::CreateRequest

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

Overview

Typed representation of the create 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)

Optional short name for the application.

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/app/create_request.rb', line 56

class CreateRequest < T::Struct
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
  const :placement_parent_application_id, T.nilable(String), default: nil
  const :relationship_policy, T.nilable(Inttegro::Application::CreateRequestRelationshipPolicy), default: nil
end

#description ⇒ String? (readonly)

Optional application description.

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/app/create_request.rb', line 56

class CreateRequest < T::Struct
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
  const :placement_parent_application_id, T.nilable(String), default: nil
  const :relationship_policy, T.nilable(Inttegro::Application::CreateRequestRelationshipPolicy), default: nil
end

#legal_entity_type ⇒ String? (readonly)

Caller-defined legal-entity label. Common values are government, non_profit, business, and individual.

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/app/create_request.rb', line 56

class CreateRequest < T::Struct
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
  const :placement_parent_application_id, T.nilable(String), default: nil
  const :relationship_policy, T.nilable(Inttegro::Application::CreateRequestRelationshipPolicy), default: nil
end

#name ⇒ String (readonly)

Display name for the application.

Required in the API payload. Wire name: name.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/app/create_request.rb', line 56

class CreateRequest < T::Struct
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
  const :placement_parent_application_id, T.nilable(String), default: nil
  const :relationship_policy, T.nilable(Inttegro::Application::CreateRequestRelationshipPolicy), default: nil
end

#placement_parent_application_id ⇒ String? (readonly)

Optional application under which the new app should be placed.

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/app/create_request.rb', line 56

class CreateRequest < T::Struct
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
  const :placement_parent_application_id, T.nilable(String), default: nil
  const :relationship_policy, T.nilable(Inttegro::Application::CreateRequestRelationshipPolicy), default: nil
end

#relationship_policy ⇒ Inttegro::Application::CreateRequestRelationshipPolicy? (readonly)

Optional direct-placement relationship policy. Omitted values default to parent management and child credentials.

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

Returns:



56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/app/create_request.rb', line 56

class CreateRequest < T::Struct
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :legal_entity_type, T.nilable(String), default: nil
  const :placement_parent_application_id, T.nilable(String), default: nil
  const :relationship_policy, T.nilable(Inttegro::Application::CreateRequestRelationshipPolicy), default: nil
end