Class: Usps::Imis::BusinessObject

Inherits:
Object
  • Object
show all
Includes:
Requests
Defined in:
lib/usps/imis/business_object.rb

Overview

DEV

Constant Summary collapse

API_PATH =

Endpoint for general API requests

'api'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api, business_object_name, ordinal: nil) ⇒ BusinessObject

A new instance of BusinessObject



30
31
32
33
34
 
# File 'lib/usps/imis/business_object.rb', line 30

def initialize(api, business_object_name, ordinal: nil)
  @api = api
  @business_object_name = business_object_name
  @ordinal = ordinal
end

Instance Attribute Details

#api ⇒ Object (readonly)

The parent Api object



18
19
20
 
# File 'lib/usps/imis/business_object.rb', line 18

def api
  @api
end

#business_object_name ⇒ Object (readonly)

Name of the iMIS Business Object



22
23
24
 
# File 'lib/usps/imis/business_object.rb', line 22

def business_object_name
  @business_object_name
end

#ordinal ⇒ Object (readonly)

Ordinal to build override ID param of the URL (e.g. used for Panels)



26
27
28
 
# File 'lib/usps/imis/business_object.rb', line 26

def ordinal
  @ordinal
end

Instance Method Details

#delete ⇒ true Also known as: destroy

Remove a business object for the current member

Returns:

  • (true) —

    Only on success response (i.e. blank string from the API)



118
 
# File 'lib/usps/imis/business_object.rb', line 118

def delete = submit(uri, authorize(http_delete)).body == '' # rubocop:disable Naming/PredicateMethod

#get(*fields) ⇒ Usps::Imis::Data+ Also known as: read

Get a business object for the current member

If fields is provided, will return only those field values

Parameters:

  • fields (String) —

    Field names to return

Returns:



50
 
# File 'lib/usps/imis/business_object.rb', line 50

def get(*fields) = fields.any? ? get_fields(*fields) : raw_object

#get_field(field) ⇒ Object Also known as: fetch, []

Get a single named field from a business object for the current member

Parameters:

  • field (String) —

    Field name to return

Returns:

  • Response data field value from the API



59
 
# File 'lib/usps/imis/business_object.rb', line 59

def get_field(field) = raw_object[field]

#get_fields(*fields) ⇒ Array Also known as: fetch_all

Get named fields from a business object for the current member

Parameters:

  • names (Array<String>) —

    Field names to return

Returns:

  • (Array) —

    Response data from the API



69
70
71
72
 
# File 'lib/usps/imis/business_object.rb', line 69

def get_fields(*fields)
  values = raw_object
  fields.map { values[it] }
end

#instance_variables_to_inspect ⇒ Object

Ruby 3.5 instance variable filter



123
 
# File 'lib/usps/imis/business_object.rb', line 123

def instance_variables_to_inspect = instance_variables - %i[@api]

#post(body) ⇒ Usps::Imis::Data Also known as: create

Create a business object for the current member

Parameters:

  • body (Hash) —

    Full raw API object data

Returns:



111
 
# File 'lib/usps/imis/business_object.rb', line 111

def post(body) = put_object(http_post, body)

#put(body) ⇒ Usps::Imis::Data Also known as: update

Update a business object for the current member

Any properties not included will be left unmodified

Parameters:

  • body (Hash) —

    Full raw API object data

Returns:



102
 
# File 'lib/usps/imis/business_object.rb', line 102

def put(body) = put_object(http_put, body)

#put_field(field, value) ⇒ Usps::Imis::Data Also known as: []=

Update a single named field on a business object for the current member

Parameters:

  • field (String) —

    Name of the field

  • value —

    Value of the field

Returns:



82
 
# File 'lib/usps/imis/business_object.rb', line 82

def put_field(field, value) = put(filter_fields(field => value))

#put_fields(fields) ⇒ Usps::Imis::Data Also known as: patch

Update only specific fields on a business object for the current member

Parameters:

  • fields (Hash) —

    Conforms to pattern { field_key => value }

Returns:



91
 
# File 'lib/usps/imis/business_object.rb', line 91

def put_fields(fields) = put(filter_fields(fields))

#query ⇒ Usps::Imis::Query

Run a query on the entire business object

Returns:



40
 
# File 'lib/usps/imis/business_object.rb', line 40

def query = api.query(business_object_name)