Class: Softlayer::Account::Shipment

Inherits:
Entity show all
Defined in:
lib/softlayer/account/shipment.rb,
lib/softlayer/account/shipment/item.rb,
lib/softlayer/account/shipment/type.rb,
lib/softlayer/account/shipment/status.rb,
lib/softlayer/account/shipment/resource.rb,
lib/softlayer/account/shipment/tracking.rb,
lib/softlayer/account/shipment/item/type.rb,
lib/softlayer/account/shipment/resource/type.rb,
lib/softlayer/account/shipment/tracking/data.rb

Defined Under Namespace

Modules: Resource, Tracking Classes: Item, Representer, Status, Type

Constant Summary collapse

SERVICE =
'SoftLayer_Account_Shipment'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Model

all, all_request_for, create, find, #init_headers, parse, process_message, #request, request, service_name, #service_name, #to_hash, #to_softlayer

Methods included from Model::Operations

extended, #filter, included, #limit, #mask, #request_headers

Instance Attribute Details

#accountObject

Returns the value of attribute account.



25
26
27
# File 'lib/softlayer/account/shipment.rb', line 25

def 
  @account
end

#account_idObject

Returns the value of attribute account_id.



10
11
12
# File 'lib/softlayer/account/shipment.rb', line 10

def 
  @account_id
end

#courierObject

Returns the value of attribute courier.



26
27
28
# File 'lib/softlayer/account/shipment.rb', line 26

def courier
  @courier
end

#courier_idObject

Returns the value of attribute courier_id.



11
12
13
# File 'lib/softlayer/account/shipment.rb', line 11

def courier_id
  @courier_id
end

#courier_nameObject

Returns the value of attribute courier_name.



12
13
14
# File 'lib/softlayer/account/shipment.rb', line 12

def courier_name
  @courier_name
end

#create_employeeObject

Returns the value of attribute create_employee.



27
28
29
# File 'lib/softlayer/account/shipment.rb', line 27

def create_employee
  @create_employee
end

#create_userObject

Returns the value of attribute create_user.



28
29
30
# File 'lib/softlayer/account/shipment.rb', line 28

def create_user
  @create_user
end

#create_user_idObject

Returns the value of attribute create_user_id.



13
14
15
# File 'lib/softlayer/account/shipment.rb', line 13

def create_user_id
  @create_user_id
end

#destination_addressObject

Returns the value of attribute destination_address.



29
30
31
# File 'lib/softlayer/account/shipment.rb', line 29

def destination_address
  @destination_address
end

#destination_address_idObject

Returns the value of attribute destination_address_id.



14
15
16
# File 'lib/softlayer/account/shipment.rb', line 14

def destination_address_id
  @destination_address_id
end

#destination_dateObject

Returns the value of attribute destination_date.



15
16
17
# File 'lib/softlayer/account/shipment.rb', line 15

def destination_date
  @destination_date
end

#idObject

Returns the value of attribute id.



16
17
18
# File 'lib/softlayer/account/shipment.rb', line 16

def id
  @id
end

#modify_employeeObject

Returns the value of attribute modify_employee.



30
31
32
# File 'lib/softlayer/account/shipment.rb', line 30

def modify_employee
  @modify_employee
end

#modify_userObject

Returns the value of attribute modify_user.



31
32
33
# File 'lib/softlayer/account/shipment.rb', line 31

def modify_user
  @modify_user
end

#modify_user_idObject

Returns the value of attribute modify_user_id.



17
18
19
# File 'lib/softlayer/account/shipment.rb', line 17

def modify_user_id
  @modify_user_id
end

#noteObject

Returns the value of attribute note.



18
19
20
# File 'lib/softlayer/account/shipment.rb', line 18

def note
  @note
end

#origination_addressObject

Returns the value of attribute origination_address.



32
33
34
# File 'lib/softlayer/account/shipment.rb', line 32

def origination_address
  @origination_address
end

#origination_address_idObject

Returns the value of attribute origination_address_id.



19
20
21
# File 'lib/softlayer/account/shipment.rb', line 19

def origination_address_id
  @origination_address_id
end

#origination_dateObject

Returns the value of attribute origination_date.



20
21
22
# File 'lib/softlayer/account/shipment.rb', line 20

def origination_date
  @origination_date
end

#shipment_item_countObject

Returns the value of attribute shipment_item_count.



23
24
25
# File 'lib/softlayer/account/shipment.rb', line 23

def shipment_item_count
  @shipment_item_count
end

#shipment_itemsObject

Returns the value of attribute shipment_items.



33
34
35
# File 'lib/softlayer/account/shipment.rb', line 33

def shipment_items
  @shipment_items
end

#statusObject

Returns the value of attribute status.



34
35
36
# File 'lib/softlayer/account/shipment.rb', line 34

def status
  @status
end

#status_idObject

Returns the value of attribute status_id.



21
22
23
# File 'lib/softlayer/account/shipment.rb', line 21

def status_id
  @status_id
end

#tracking_dataObject

Returns the value of attribute tracking_data.



35
36
37
# File 'lib/softlayer/account/shipment.rb', line 35

def tracking_data
  @tracking_data
end

#tracking_data_countObject

Returns the value of attribute tracking_data_count.



24
25
26
# File 'lib/softlayer/account/shipment.rb', line 24

def tracking_data_count
  @tracking_data_count
end

#typeObject

Returns the value of attribute type.



36
37
38
# File 'lib/softlayer/account/shipment.rb', line 36

def type
  @type
end

#type_idObject

Returns the value of attribute type_id.



22
23
24
# File 'lib/softlayer/account/shipment.rb', line 22

def type_id
  @type_id
end

Class Method Details

.get_all_couriersObject



47
48
49
# File 'lib/softlayer/account/shipment.rb', line 47

def self.get_all_couriers
  request(:get_all_couriers, Array[Softlayer::Auxiliary::Shipping::Courier])
end

.get_all_couriers_by_type(message) ⇒ Object

courier_type_key_name



52
53
54
# File 'lib/softlayer/account/shipment.rb', line 52

def self.get_all_couriers_by_type(message)
  request(:get_all_couriers_by_type, Array[Softlayer::Auxiliary::Shipping::Courier], message)
end

.get_all_shipment_statusesObject



56
57
58
# File 'lib/softlayer/account/shipment.rb', line 56

def self.get_all_shipment_statuses
  request(:get_all_shipment_statuses, Array[Softlayer::Account::Shipment::Status])
end

.get_all_shipment_typesObject



60
61
62
# File 'lib/softlayer/account/shipment.rb', line 60

def self.get_all_shipment_types
  request(:get_all_shipment_types, Array[Softlayer::Account::Shipment::Type])
end

Instance Method Details

#edit_object(message) ⇒ Object

template_object



39
40
41
# File 'lib/softlayer/account/shipment.rb', line 39

def edit_object(message)
  request(:edit_object, Boolean, message)
end

#get_accountObject



43
44
45
# File 'lib/softlayer/account/shipment.rb', line 43

def 
  request(:get_account, Softlayer::Account)
end

#get_courierObject



64
65
66
# File 'lib/softlayer/account/shipment.rb', line 64

def get_courier
  request(:get_courier, Softlayer::Auxiliary::Shipping::Courier)
end

#get_create_employeeObject



68
69
70
# File 'lib/softlayer/account/shipment.rb', line 68

def get_create_employee
  request(:get_create_employee, Softlayer::User::Employee)
end

#get_create_userObject



72
73
74
# File 'lib/softlayer/account/shipment.rb', line 72

def get_create_user
  request(:get_create_user, Softlayer::User::Customer)
end

#get_destination_addressObject



76
77
78
# File 'lib/softlayer/account/shipment.rb', line 76

def get_destination_address
  request(:get_destination_address, Softlayer::Account::Address)
end

#get_modify_employeeObject



80
81
82
# File 'lib/softlayer/account/shipment.rb', line 80

def get_modify_employee
  request(:get_modify_employee, Softlayer::User::Employee)
end

#get_modify_userObject



84
85
86
# File 'lib/softlayer/account/shipment.rb', line 84

def get_modify_user
  request(:get_modify_user, Softlayer::User::Customer)
end

#get_objectObject



88
89
90
# File 'lib/softlayer/account/shipment.rb', line 88

def get_object
  request(:get_object, Softlayer::Account::Shipment)
end

#get_origination_addressObject



92
93
94
# File 'lib/softlayer/account/shipment.rb', line 92

def get_origination_address
  request(:get_origination_address, Softlayer::Account::Address)
end

#get_shipment_itemsObject



96
97
98
# File 'lib/softlayer/account/shipment.rb', line 96

def get_shipment_items
  request(:get_shipment_items, Array[Softlayer::Account::Shipment::Item])
end

#get_statusObject



100
101
102
# File 'lib/softlayer/account/shipment.rb', line 100

def get_status
  request(:get_status, Softlayer::Account::Shipment::Status)
end

#get_tracking_dataObject



104
105
106
# File 'lib/softlayer/account/shipment.rb', line 104

def get_tracking_data
  request(:get_tracking_data, Array[Softlayer::Account::Shipment::Tracking::Data])
end

#get_typeObject



108
109
110
# File 'lib/softlayer/account/shipment.rb', line 108

def get_type
  request(:get_type, Softlayer::Account::Shipment::Type)
end