Class: WscSdk::ModelList

Inherits:

Hash

• Object
• Hash
• WscSdk::ModelList

Includes:

ApiResponse

Defined in:

lib/wsc_sdk/model_list.rb

Overview

A class to manage lists of models

Instance Method Summary

• #add(model) ⇒ Object

  Add a model to the list.

• #pagination ⇒ Hash

  Get pagination data for the list.

• #pagination=(pagination) ⇒ Object

  Assign pagination data to the list.

Methods included from ApiResponse

#success?

Instance Method Details

#add(model) ⇒ Object

Add a model to the list

Parameters:

• model (WscSdk::Model) —

  The model to add to the list

# File 'lib/wsc_sdk/model_list.rb', line 16

def add(model)
  self[model.primary_key] = model
end

#pagination ⇒ Hash

Get pagination data for the list

Returns:

• (Hash) —

  A hash of pagination data

# File 'lib/wsc_sdk/model_list.rb', line 37

def pagination
  @pagination ||= WscSdk::Pagination.new()
end

#pagination=(pagination) ⇒ Object

Assign pagination data to the list

Parameters:

• pagination (Hash, WscSdk::Pagination) —

  A hash of pagination options or an instance of WscSdk::Pagination

# File 'lib/wsc_sdk/model_list.rb', line 25

def pagination= pagination
  if pagination.is_a?(Hash)
    @pagination = WscSdk::Pagination.new(pagination)
  elsif pagination.is_a?(WscSdk::Pagination)
    @pagination = pagination
  end
end