Class: Inttegro::Application

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/app/application.rb,
lib/inttegro/app/base.rb,
lib/inttegro/app/updated.rb,
lib/inttegro/app/looked_up.rb,
lib/inttegro/app/secret_key.rb,
lib/inttegro/app/relationship.rb,
lib/inttegro/app/create_request.rb,
lib/inttegro/app/update_request.rb,
lib/inttegro/app/create_response.rb,
lib/inttegro/app/lookup_response.rb,
lib/inttegro/app/management_role.rb,
lib/inttegro/app/update_response.rb,
lib/inttegro/app/credential_owner.rb,
lib/inttegro/app/relationship_kind.rb,
lib/inttegro/app/relationship_policy.rb,
lib/inttegro/app/relationship_status.rb,
lib/inttegro/app/create_request_relationship_policy.rb

Overview

Typed representation of the application 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.

Defined Under Namespace

Classes: CreateRequest, CreateRequestRelationshipPolicy, CreateResponse, CredentialOwner, LookedUp, LookupResponse, ManagementRole, Relationship, RelationshipKind, RelationshipPolicy, RelationshipStatus, SecretKey, UpdateRequest, UpdateResponse, Updated

Instance Attribute Summary collapse

Instance Attribute Details

#alias ⇒ String? (readonly)

Value of the alias field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/app/application.rb', line 60

class Application
  const :id, String
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :created_at, Time
  const :secret_key, T.nilable(Inttegro::Application::SecretKey), default: nil
  const :relationship, T.nilable(Inttegro::Application::Relationship), default: nil
end

#created_at ⇒ Time (readonly)

Value of the created_at field in the Inttegro API payload.

Required in the API payload. Wire name: created_at.

Returns:

  • (Time) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/app/application.rb', line 60

class Application
  const :id, String
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :created_at, Time
  const :secret_key, T.nilable(Inttegro::Application::SecretKey), default: nil
  const :relationship, T.nilable(Inttegro::Application::Relationship), default: nil
end

#description ⇒ String? (readonly)

Value of the description field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/app/application.rb', line 60

class Application
  const :id, String
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :created_at, Time
  const :secret_key, T.nilable(Inttegro::Application::SecretKey), default: nil
  const :relationship, T.nilable(Inttegro::Application::Relationship), default: nil
end

#id ⇒ String (readonly)

Value of the id field in the Inttegro API payload.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/app/application.rb', line 60

class Application
  const :id, String
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :created_at, Time
  const :secret_key, T.nilable(Inttegro::Application::SecretKey), default: nil
  const :relationship, T.nilable(Inttegro::Application::Relationship), default: nil
end

#name ⇒ String (readonly)

Value of the name field in the Inttegro API payload.

Required in the API payload. Wire name: name.

Returns:

  • (String) 


60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/app/application.rb', line 60

class Application
  const :id, String
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :created_at, Time
  const :secret_key, T.nilable(Inttegro::Application::SecretKey), default: nil
  const :relationship, T.nilable(Inttegro::Application::Relationship), default: nil
end

#relationship ⇒ Inttegro::Application::Relationship? (readonly)

Relationship receipt for the created child app.

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

Returns:



60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/app/application.rb', line 60

class Application
  const :id, String
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :created_at, Time
  const :secret_key, T.nilable(Inttegro::Application::SecretKey), default: nil
  const :relationship, T.nilable(Inttegro::Application::Relationship), default: nil
end

#secret_key ⇒ Inttegro::Application::SecretKey? (readonly)

Value of the secret_key field in the Inttegro API payload.

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

Returns:



60
61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/app/application.rb', line 60

class Application
  const :id, String
  const :name, String
  const :alias, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :created_at, Time
  const :secret_key, T.nilable(Inttegro::Application::SecretKey), default: nil
  const :relationship, T.nilable(Inttegro::Application::Relationship), default: nil
end