Class: Sink::BaseModel

Inherits:

Object

• Object
• Sink::BaseModel

Defined in:

lib/sink/base_model.rb

Direct Known Subclasses

Models::APIStatus, Models::Address, Models::AllofBaseParent, Models::ArrayMissingItemsResponse, Models::ArrayObjectItem, Models::ArrayObjectItemsResponse, Models::Balance, Models::BasicSharedModelObject, Models::BodyParamTopLevelAllOfResponse, Models::BodyParamUnionOverlappingPropResponse, Models::Card, Models::CardListResponse, Models::CardProvisionFooResponse, Models::ChildInlinedResponseResponse, Models::ChildModel, Models::ChildModel::InlineObject, Models::Class, Models::Client, Models::Company, Models::CompanyPayment, Models::ComplexQueryArrayQueryResponse, Models::ConfigToolModelRefFromNestedResponseBodyResponse, Models::ConfigToolModelRefFromNestedResponseBodyResponse::Foo, Models::DecoratorTestKeepMeResponse, Models::DocstringLeadingDoubleQuoteResponse, Models::DocstringTrailingDoubleQuoteResponse, Models::Documents, Models::EEOC, Models::EmploymentData, Models::EnumBasicResponse, Models::EnvelopeInlineResponseResponse, Models::Export, Models::FileCreateMultipartResponse, Models::FileEverythingMultipartResponse, Models::FileNoFileMultipartResponse, Models::FileWithOptionalParamResponse, Models::FundingAccount, Models::Import, Models::Interface, Models::KeepThisResourceKeepThisMethodResponse, Models::MakeAmbiguousSchemasExplicitMakeAmbiguousSchemasExplicitResponse, Models::MakeAmbiguousSchemasLooserMakeAmbiguousSchemasLooserResponse, Models::MapNullableItemsResponse, Models::MethodConfigSkippedTestsAllResponse, Models::MethodConfigSkippedTestsGoResponse, Models::MethodConfigSkippedTestsJavaResponse, Models::MethodConfigSkippedTestsKotlinResponse, Models::MethodConfigSkippedTestsNodeAndPythonResponse, Models::MethodConfigSkippedTestsNodeResponse, Models::MethodConfigSkippedTestsPythonResponse, Models::MethodConfigSkippedTestsRubyResponse, Models::ModelFromNestedPath, Models::ModelFromNestedResponseBodyRef, Models::ModelFromSchemasRef, Models::ModelFromSchemasRefOpenAPIUri, Models::ModelFromSchemasRefOpenAPIUriJmespath, Models::ModelFromSchemasRefOpenAPIUriJsonpath, Models::ModelLevel1, Models::ModelLevel2, Models::ModelLevel3, Models::ModelReferencedInParentAndChild, Models::ModelWithNestedModel, Models::MyModel, Models::NameChildPropImportClashResponse, Models::NameChildPropImportClashResponse::Balance, Models::NamePropertiesCommonConflictsResponse, Models::NamePropertiesIllegalGoIdentifiersResponse, Models::NameResponsePropertyClashesModelImportResponse, Models::NameResponseShadowsPydanticResponse, Models::NestedRequestModelA, Models::NestedRequestModelB, Models::NestedRequestModelC, Models::NestedRequestModelC::Baz, Models::ObjectMissingItemsResponse, Models::ObjectMixedKnownAndUnknownResponse, Models::ObjectMultipleArrayPropertiesSameRefResponse, Models::ObjectMultipleArrayPropertiesSameRefResponse::Bar, Models::ObjectMultipleArrayPropertiesSameRefResponse::Foo, Models::ObjectMultipleArrayPropertiesSameRefResponse::RequiredProp, Models::ObjectMultiplePropertiesSameModelResponse, Models::ObjectMultiplePropertiesSameRefResponse, Models::ObjectMultiplePropertiesSameRefResponse::Bar, Models::ObjectMultiplePropertiesSameRefResponse::Foo, Models::ObjectMultiplePropertiesSameRefResponse::RequiredProp, Models::ObjectSkippedProps, Models::ObjectTwoDimensionalArrayPrimitivePropertyResponse, Models::ObjectWithAnyOfNullProperty, Models::ObjectWithAnyOfNullProperty::Foo, Models::ObjectWithChildRef, Models::ObjectWithOneOfNullProperty, Models::ObjectWithOneOfNullProperty::Foo, Models::ObjectWithUnionProperties, Models::OpenAPIFormatArrayTypeOneEntryResponse, Models::OpenAPIFormatArrayTypeOneEntryWithNullResponse, Models::OpenAPISpecialUsedUsedAsPropertyNameResponse, Models::PageCursorSharedRefPagination, Models::ParentModelWithChildRef, Models::PathParamColonSuffixResponse, Models::PathParamFileExtensionResponse, Models::PathParamMultipleResponse, Models::PathParamQueryParamResponse, Models::PathParamSingularResponse, Models::PrimitiveStringsResponse, Models::Private, Models::Public, Models::RecursionCreateEnvelopeResponse, Models::ResponseAllofSimpleResponse, Models::ResponseMissingRequiredResponse, Models::ResponseNestedArrayResponse, Models::ResponseNestedArrayResponse::Object, Models::ResponseObjectAllPropertiesResponse, Models::ResponseObjectNoPropertiesResponse, Models::ResponseObjectWithAdditionalPropertiesPropResponse, Models::ResponseObjectWithAdditionalPropertiesPropResponse::Foo, Models::ResponseObjectWithHeavilyNestedUnionResponse, Models::ResponseOnlyReadOnlyPropertiesResponse, Models::ResponsesAllofCrossObject, Models::Return, Models::RootResponse, Models::SelfRecursion, Models::SharedCursorNestedResponsePropMeta, Models::SharedCursorNestedResponsePropMeta::Pagination, Models::SharedSelfRecursion, Models::ShippingAddress, Models::SimpleAllof, Models::SimpleObject, Models::SkipThisResourceINeverAppearResponse, Models::StreamingBasicResponse, Models::StreamingNestedParamsResponse, Models::StreamingNoDiscriminatorResponse, Models::StreamingQueryParamDiscriminatorResponse, Models::StreamingWithUnrelatedDefaultParamResponse, Models::TypeDatesResponse, Models::TypeDatetimesResponse, Models::UnionDiscriminatedVariantA, Models::UnionDiscriminatedVariantB, Models::Version1_30NameCreateResponse, Models::Widget, Models::WriteOnlyResponseSimpleResponse, PageCursorNestedItems::Data, PageCursorNestedItems::ObjectProp, PageCursorNestedObjectRef::ObjectProp, PageCursorSharedRef::PageCursorSharedRefPagination

Instance Method Summary

• #[](key) ⇒ Object^?

  Returns the raw value associated with the given key, if found.

• #deconstruct_keys(keys) ⇒ Hash{Symbol => Object}
• #initialize(data = {}) ⇒ BaseModel constructor

  Create a new instance of a model.

• #inspect ⇒ String
• #to_h ⇒ Hash{Symbol => Object} (also: #to_hash)

  Returns a Hash of the data underlying this object.

• #to_s ⇒ String

Constructor Details

#initialize(data = {}) ⇒ BaseModel

Create a new instance of a model.

Parameters:

• data (Hash{Symbol => Object}) (defaults to: {}) —

  Raw data to initialize the model with.

# File 'lib/sink/base_model.rb', line 150

def initialize(data = {})
  @data = {}
  # TODO: what if data isn't a hash?
  data.each do |field_name, value|
    next if value.nil?

    field = self.class.fields[field_name.to_sym]
    if field
      next if field[:mode] == :w
    end
    @data[field_name.to_sym] = value
  end
end

Instance Method Details

#[](key) ⇒ Object^?

Returns the raw value associated with the given key, if found. Otherwise, nil is returned. It is valid to lookup keys that are not in the API spec, for example to access undocumented features. This method does not parse response data into higher-level types. Lookup by anything other than a Symbol is an ArgumentError.

Parameters:

• key (Symbol) —

  Key to look up by.

Returns:

• (Object, nil) —

  The raw value at the given key.

# File 'lib/sink/base_model.rb', line 188

def [](key)
  if !key.instance_of?(Symbol)
    raise ArgumentError, "Expected symbol key for lookup, got #{key.inspect}"
  end
  @data[key]
end

#deconstruct_keys(keys) ⇒ Hash{Symbol => Object}

Parameters:

• keys (Array<Symbol>, nil)

Returns:

• (Hash{Symbol => Object})

# File 'lib/sink/base_model.rb', line 197

def deconstruct_keys(keys)
  (keys || self.class.fields.keys).to_h do |k|
    if !k.instance_of?(Symbol)
      raise ArgumentError, "Expected symbol key for lookup, got #{k.inspect}"
    end

    if !self.class.fields.key?(k)
      raise KeyError, "Expected one of #{self.class.fields.keys}, got #{k.inspect}"
    end

    [k, method(k).call]
  end
end

#inspect ⇒ String

Returns:

• (String)

# File 'lib/sink/base_model.rb', line 212

def inspect
  "#<#{self.class.name}:0x#{object_id.to_s(16)} #{deconstruct_keys(nil).map do |k, v|
    "#{k}=#{v.inspect}"
  end.join(' ')}>"
end

#to_h ⇒ Hash{Symbol => Object} Also known as: to_hash

Returns a Hash of the data underlying this object. Keys are Symbols and values are the raw values from the response. The return value indicates which values were ever set on the object - i.e. there will be a key in this hash if they ever were, even if the set value was nil. This method is not recursive. The returned value is shared by the object, so it should not be mutated.

Returns:

• (Hash{Symbol => Object}) —

  Data for this object.

# File 'lib/sink/base_model.rb', line 173

def to_h
  @data
end

#to_s ⇒ String

Returns:

• (String)

# File 'lib/sink/base_model.rb', line 219

def to_s
  @data.to_s
end