Class: LockstepSdk::CustomerDetailsModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/customer_details_model.rb

Overview

Contains customer details data

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ CustomerDetailsModel

Initialize the CustomerDetailsModel using the provided prototype



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 24

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @customer_id = params.dig(:customer_id)
    @name = params.dig(:name)
    @address1 = params.dig(:address1)
    @address2 = params.dig(:address2)
    @address3 = params.dig(:address3)
    @city = params.dig(:city)
    @state = params.dig(:state)
    @postal_code = params.dig(:postal_code)
    @country = params.dig(:country)
    @phone_number = params.dig(:phone_number)
    @fax_number = params.dig(:fax_number)
    @email = params.dig(:email)
    @contact_id = params.dig(:contact_id)
    @contact_name = params.dig(:contact_name)
    @contact_email = params.dig(:contact_email)
    @outstanding_invoices = params.dig(:outstanding_invoices)
    @outstanding_amount = params.dig(:outstanding_amount)
    @amount_past_due = params.dig(:amount_past_due)
    @payments = params.dig(:payments)
end

Instance Attribute Details

#address1 ⇒ String

Returns Customer address info.

Returns:

  • (String) —

    Customer address info



54
55
56
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 54

def address1
  @address1
end

#address2 ⇒ String

Returns Customer address info.

Returns:

  • (String) —

    Customer address info



56
57
58
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 56

def address2
  @address2
end

#address3 ⇒ String

Returns Customer address info.

Returns:

  • (String) —

    Customer address info



58
59
60
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 58

def address3
  @address3
end

#amount_past_due ⇒ Double

Returns Customer total past due amount.

Returns:

  • (Double) —

    Customer total past due amount



84
85
86
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 84

def amount_past_due
  @amount_past_due
end

#city ⇒ String

Returns Customer address info.

Returns:

  • (String) —

    Customer address info



60
61
62
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 60

def city
  @city
end

#contact_email ⇒ String

Returns Customer primary contact email address.

Returns:

  • (String) —

    Customer primary contact email address



78
79
80
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 78

def contact_email
  @contact_email
end

#contact_id ⇒ Uuid

Returns Customer primary contact id.

Returns:

  • (Uuid) —

    Customer primary contact id



74
75
76
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 74

def contact_id
  @contact_id
end

#contact_name ⇒ String

Returns Customer primary contact name.

Returns:

  • (String) —

    Customer primary contact name



76
77
78
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 76

def contact_name
  @contact_name
end

#country ⇒ String

Returns Customer address country.

Returns:

  • (String) —

    Customer address country



66
67
68
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 66

def country
  @country
end

#customer_id ⇒ Uuid

Returns The unique ID of this customer.

Returns:

  • (Uuid) —

    The unique ID of this customer



50
51
52
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 50

def customer_id
  @customer_id
end

#email ⇒ String

Returns Customer AR email address.

Returns:

  • (String) —

    Customer AR email address



72
73
74
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 72

def email
  @email
end

#fax_number ⇒ String

Returns Customer fax number.

Returns:

  • (String) —

    Customer fax number



70
71
72
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 70

def fax_number
  @fax_number
end

#group_key ⇒ Uuid

Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).

Returns:

  • (Uuid) —

    The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).



48
49
50
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 48

def group_key
  @group_key
end

#name ⇒ String

Returns The unique ID of this customer.

Returns:

  • (String) —

    The unique ID of this customer



52
53
54
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 52

def name
  @name
end

#outstanding_amount ⇒ Double

Returns Customer total outstanding invoice amount.

Returns:

  • (Double) —

    Customer total outstanding invoice amount



82
83
84
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 82

def outstanding_amount
  @outstanding_amount
end

#outstanding_invoices ⇒ Int32

Returns Customer number of outstanding invoices.

Returns:

  • (Int32) —

    Customer number of outstanding invoices



80
81
82
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 80

def outstanding_invoices
  @outstanding_invoices
end

#payments ⇒ CustomerDetailsPaymentModel

Returns Customer payments collected.

Returns:



86
87
88
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 86

def payments
  @payments
end

#phone_number ⇒ String

Returns Customer phone number.

Returns:

  • (String) —

    Customer phone number



68
69
70
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 68

def phone_number
  @phone_number
end

#postal_code ⇒ String

Returns Customer address info.

Returns:

  • (String) —

    Customer address info



64
65
66
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 64

def postal_code
  @postal_code
end

#state ⇒ String

Returns Customer address info.

Returns:

  • (String) —

    Customer address info



62
63
64
 
# File 'lib/lockstep_sdk/models/customer_details_model.rb', line 62

def state
  @state
end