Class: Inttegro::FileLink

Inherits:

T::Struct

• Object
• T::Struct
• Inttegro::FileLink

Defined in:

lib/inttegro/file_link/file_link.rb,
lib/inttegro/file_link/base.rb,
lib/inttegro/file_link/kind.rb,
lib/inttegro/file_link/page.rb,
lib/inttegro/file_link/actor.rb,
lib/inttegro/file_link/access.rb,
lib/inttegro/file_link/status.rb,
lib/inttegro/file_link/creation.rb,
lib/inttegro/file_link/delivery.rb,
lib/inttegro/file_link/response.rb,
lib/inttegro/file_link/page_request.rb,
lib/inttegro/file_link/delivery_mode.rb,
lib/inttegro/file_link/page_response.rb,
lib/inttegro/file_link/access_request.rb,
lib/inttegro/file_link/create_request.rb,
lib/inttegro/file_link/lookup_request.rb,
lib/inttegro/file_link/revoke_request.rb

Overview

Public file link metadata. Token hashes and provider URLs are not exposed.

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: Access, AccessRequest, Actor, CreateRequest, Creation, Delivery, DeliveryMode, Kind, LookupRequest, Page, PageRequest, PageResponse, Response, RevokeRequest, Status

Instance Attribute Summary

• #access ⇒ Inttegro::FileLink::Access readonly

  Value of the access field in the Inttegro API payload.

• #active ⇒ Boolean readonly

  Value of the active field in the Inttegro API payload.

• #created_at ⇒ Time readonly

  Value of the created_at field in the Inttegro API payload.

• #created_by ⇒ Inttegro::FileLink::Actor readonly

  Value of the created_by field in the Inttegro API payload.

• #custom_data ⇒ Inttegro::CustomData^? readonly

  Merchant-defined string values attached to a resource.

• #delivery ⇒ Inttegro::FileLink::Delivery readonly

  Value of the delivery field in the Inttegro API payload.

• #expires_at ⇒ Time readonly

  Value of the expires_at field in the Inttegro API payload.

• #file_id ⇒ String readonly

  Value of the file_id field in the Inttegro API payload.

• #id ⇒ String readonly

  Value of the id field in the Inttegro API payload.

• #kind ⇒ Inttegro::FileLink::Kind readonly

  Value of the kind field in the Inttegro API payload.

• #metadata ⇒ Hash{String => String}^? readonly

  System-managed string metadata attached to a file resource.

• #purpose ⇒ String readonly

  Value of the purpose field in the Inttegro API payload.

• #revoked_at ⇒ Time^? readonly

  Value of the revoked_at field in the Inttegro API payload.

• #revoked_by ⇒ Inttegro::FileLink::Actor^? readonly

  Value of the revoked_by field in the Inttegro API payload.

• #status ⇒ Inttegro::FileLink::Status readonly

  Value of the status field in the Inttegro API payload.

• #updated_at ⇒ Time readonly

  Value of the updated_at field in the Inttegro API payload.

Instance Attribute Details

#access ⇒ Inttegro::FileLink::Access (readonly)

Value of the access field in the Inttegro API payload.

Required in the API payload. Wire name: access.

Returns:

• (Inttegro::FileLink::Access)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#active ⇒ Boolean (readonly)

Value of the active field in the Inttegro API payload.

Required in the API payload. Wire name: active.

Returns:

• (Boolean)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), 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)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#created_by ⇒ Inttegro::FileLink::Actor (readonly)

Value of the created_by field in the Inttegro API payload.

Required in the API payload. Wire name: created_by.

Returns:

• (Inttegro::FileLink::Actor)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#custom_data ⇒ Inttegro::CustomData^? (readonly)

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.

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

Returns:

• (Inttegro::CustomData, nil)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#delivery ⇒ Inttegro::FileLink::Delivery (readonly)

Value of the delivery field in the Inttegro API payload.

Required in the API payload. Wire name: delivery.

Returns:

• (Inttegro::FileLink::Delivery)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#expires_at ⇒ Time (readonly)

Value of the expires_at field in the Inttegro API payload.

Required in the API payload. Wire name: expires_at.

Returns:

• (Time)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#file_id ⇒ String (readonly)

Value of the file_id field in the Inttegro API payload.

Required in the API payload. Wire name: file_id.

Returns:

• (String)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), 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)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#kind ⇒ Inttegro::FileLink::Kind (readonly)

Value of the kind field in the Inttegro API payload.

Required in the API payload. Wire name: kind.

Returns:

• (Inttegro::FileLink::Kind)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#metadata ⇒ Hash{String => String}^? (readonly)

System-managed string metadata attached to a file resource.

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

Returns:

• (Hash{String => String}, nil)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#purpose ⇒ String (readonly)

Value of the purpose field in the Inttegro API payload.

Required in the API payload. Wire name: purpose.

Returns:

• (String)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#revoked_at ⇒ Time^? (readonly)

Value of the revoked_at field in the Inttegro API payload.

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

Returns:

• (Time, nil)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#revoked_by ⇒ Inttegro::FileLink::Actor^? (readonly)

Value of the revoked_by field in the Inttegro API payload.

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

Returns:

• (Inttegro::FileLink::Actor, nil)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#status ⇒ Inttegro::FileLink::Status (readonly)

Value of the status field in the Inttegro API payload.

Required in the API payload. Wire name: status.

Returns:

• (Inttegro::FileLink::Status)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end

#updated_at ⇒ Time (readonly)

Value of the updated_at field in the Inttegro API payload.

Required in the API payload. Wire name: updated_at.

Returns:

• (Time)

# File 'lib/inttegro/file_link/file_link.rb', line 119

class FileLink
  const :id, String
  const :kind, Inttegro::FileLink::Kind
  const :file_id, String
  const :purpose, String
  const :status, Inttegro::FileLink::Status
  const :active, T::Boolean
  const :delivery, Inttegro::FileLink::Delivery
  const :access, Inttegro::FileLink::Access
  const :created_by, Inttegro::FileLink::Actor
  const :revoked_by, T.nilable(Inttegro::FileLink::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :revoked_at, T.nilable(Time), default: nil
end