Class: OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit

Defined in:

lib/openai/models/admin/organization/projects/project_spend_limit.rb,
sig/openai/models/admin/organization/projects/project_spend_limit.rbs

Overview

See Also:

• OpenAI::Resources::Admin::Organization::Projects::SpendLimit#retrieve

Defined Under Namespace

Modules: Currency, Interval Classes: Enforcement

Instance Attribute Summary

• #currency ⇒ String, ...

  The currency for the threshold amount.

• #enforcement ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Enforcement

  The current enforcement state of the hard spend limit.

• #interval ⇒ String, ...

  The time interval for evaluating spend against the threshold.

• #object ⇒ Symbol, :"project.spend_limit"

  The object type, which is always project.spend_limit.

• #threshold_amount ⇒ Integer

  The hard spend limit amount, in cents.

Instance Method Summary

• #initialize(currency:, enforcement:, interval:, threshold_amount:, object: :"project.spend_limit") ⇒ Object constructor

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

• #to_hash ⇒ {

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(currency:, enforcement:, interval:, threshold_amount:, object: :"project.spend_limit") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit for more details.

Represents a hard spend limit configured at the project level.

Parameters:

• currency (String, Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Currency) —

  The currency for the threshold amount. Currently, only USD is supported.

• enforcement (OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Enforcement) —

  The current enforcement state of the hard spend limit.

• interval (String, Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Interval) —

  The time interval for evaluating spend against the threshold. Currently, only `m

• threshold_amount (Integer) —

  The hard spend limit amount, in cents.

• object (Symbol, :"project.spend_limit") (defaults to: :"project.spend_limit") —

  The object type, which is always project.spend_limit.

# File 'lib/openai/models/admin/organization/projects/project_spend_limit.rb', line 41

Instance Attribute Details

#currency ⇒ String, ...

The currency for the threshold amount. Currently, only USD is supported.

Parameters:

• value (OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::currency)

Returns:

• (String, Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Currency)

# File 'lib/openai/models/admin/organization/projects/project_spend_limit.rb', line 14

required :currency, union: -> { OpenAI::Admin::Organization::Projects::ProjectSpendLimit::Currency }

#enforcement ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Enforcement

The current enforcement state of the hard spend limit.

Parameters:

• value (OpenAI::Admin::Organization::Projects::ProjectSpendLimit::Enforcement)

Returns:

• (OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Enforcement)

# File 'lib/openai/models/admin/organization/projects/project_spend_limit.rb', line 20

required :enforcement, -> { OpenAI::Admin::Organization::Projects::ProjectSpendLimit::Enforcement }

#interval ⇒ String, ...

The time interval for evaluating spend against the threshold. Currently, only month is supported.

Parameters:

• value (OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::interval)

Returns:

• (String, Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Interval)

# File 'lib/openai/models/admin/organization/projects/project_spend_limit.rb', line 27

required :interval, union: -> { OpenAI::Admin::Organization::Projects::ProjectSpendLimit::Interval }

#object ⇒ Symbol, :"project.spend_limit"

The object type, which is always project.spend_limit.

Parameters:

• value (:"project.spend_limit")

Returns:

• (Symbol, :"project.spend_limit")

# File 'lib/openai/models/admin/organization/projects/project_spend_limit.rb', line 33

required :object, const: :"project.spend_limit"

#threshold_amount ⇒ Integer

The hard spend limit amount, in cents.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/openai/models/admin/organization/projects/project_spend_limit.rb', line 39

required :threshold_amount, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/admin/organization/projects/project_spend_limit.rbs', line 36

def to_hash: -> {