Class: Increase::Models::FileLinkCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::FileLinkCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/file_link_create_params.rb

Overview

See Also:

• Resources::FileLinks#create

Instance Attribute Summary

• #expires_at ⇒ Time^?

  The time at which the File Link will expire.

• #file_id ⇒ String

  The File to create a File Link for.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(file_id: , expires_at: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see FileLinkCreateParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(file_id: , expires_at: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::FileLinkCreateParams for more details.

Parameters:

• file_id (String) (defaults to: ) —

  The File to create a File Link for.

• expires_at (Time) (defaults to: nil) —

  The time at which the File Link will expire. The default is 1 hour from the time

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/increase/models/file_link_create_params.rb', line 23

Instance Attribute Details

#expires_at ⇒ Time^?

The time at which the File Link will expire. The default is 1 hour from the time of the request. The maxiumum is 1 day from the time of the request.

Returns:

• (Time, nil)

# File 'lib/increase/models/file_link_create_params.rb', line 21

optional :expires_at, Time

#file_id ⇒ String

The File to create a File Link for.

Returns:

• (String)

# File 'lib/increase/models/file_link_create_params.rb', line 14

required :file_id, String