Class: Increase::Models::FileCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/file_create_params.rb,
sig/increase/models/file_create_params.rbs

Overview

See Also:

• Increase::Resources::Files#create

Defined Under Namespace

Modules: Purpose

Instance Attribute Summary

• #description ⇒ String^?

  The description you choose to give the File.

• #file ⇒ Pathname, ...

  The file contents.

• #purpose ⇒ Symbol, Increase::Models::FileCreateParams::Purpose

  What the File will be used for in Increase's systems.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(file:, purpose:, description: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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:, purpose:, description: nil, request_options: {}) ⇒ Object

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

Parameters:

• file (Pathname, StringIO, IO, String, Increase::FilePart) —

  The file contents. This should follow the specifications of [RFC 7578](https://d

• purpose (Symbol, Increase::Models::FileCreateParams::Purpose) —

  What the File will be used for in Increase's systems.

• description (String) (defaults to: nil) —

  The description you choose to give the File.

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

# File 'lib/increase/models/file_create_params.rb', line 30

Instance Attribute Details

#description ⇒ String^?

The description you choose to give the File.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/increase/models/file_create_params.rb', line 28

optional :description, String

#file ⇒ Pathname, ...

The file contents. This should follow the specifications of RFC 7578 which defines file transfers for the multipart/form-data protocol.

Parameters:

• value (Increase::Internal::file_input)

Returns:

• (Pathname, StringIO, IO, String, Increase::FilePart)

# File 'lib/increase/models/file_create_params.rb', line 16

required :file, Increase::Internal::Type::FileInput

#purpose ⇒ Symbol, Increase::Models::FileCreateParams::Purpose

What the File will be used for in Increase's systems.

Parameters:

• value (Increase::Models::FileCreateParams::purpose)

Returns:

• (Symbol, Increase::Models::FileCreateParams::Purpose)

# File 'lib/increase/models/file_create_params.rb', line 22

required :purpose, enum: -> { Increase::FileCreateParams::Purpose }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/increase/models/file_create_params.rbs', line 30

def to_hash: -> {