Class: ContextDev::Models::BatchRetrieveResponse::Credits

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::BatchRetrieveResponse::Credits

Defined in:

lib/context_dev/models/batch_retrieve_response.rb,
sig/context_dev/models/batch_retrieve_response.rbs

Overview

See Also:

• ContextDev::Models::BatchRetrieveResponse#credits

Instance Attribute Summary

• #net ⇒ Integer

  reserved minus refunded plus ocr_charged — what the batch has cost so far.

• #ocr_charged ⇒ Integer

  Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered page, on top of reserved.

• #refunded ⇒ Integer

  Credits returned for pages that did not succeed.

• #reserved ⇒ Integer

  Credits debited from your balance the moment the batch was accepted.

Instance Method Summary

• #initialize ⇒ Object constructor
• #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 ⇒ Object

# File 'sig/context_dev/models/batch_retrieve_response.rbs', line 110

def initialize: (

Instance Attribute Details

#net ⇒ Integer

reserved minus refunded plus ocr_charged — what the batch has cost so far. Equal to reserved until the batch settles.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/context_dev/models/batch_retrieve_response.rb', line 144

required :net, Integer

#ocr_charged ⇒ Integer

Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered page, on top of reserved. Stays 0 until the batch settles.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/context_dev/models/batch_retrieve_response.rb', line 151

required :ocr_charged, Integer

#refunded ⇒ Integer

Credits returned for pages that did not succeed. Stays 0 until the batch reaches a final status, then settles in one movement.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/context_dev/models/batch_retrieve_response.rb', line 158

required :refunded, Integer

#reserved ⇒ Integer

Credits debited from your balance the moment the batch was accepted. This is a charge, not a forecast — the whole amount leaves the balance up front.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/context_dev/models/batch_retrieve_response.rb', line 165

required :reserved, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/context_dev/models/batch_retrieve_response.rbs', line 117

def to_hash: -> {