Class: LockstepSdk::InvoiceAddressModel

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

Overview

Represents a single address for an invoice

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ InvoiceAddressModel

Initialize the InvoiceAddressModel using the provided prototype



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

def initialize(params = {})
    @invoice_address_id = params.dig(:invoice_address_id)
    @group_key = params.dig(:group_key)
    @invoice_id = params.dig(:invoice_id)
    @line1 = params.dig(:line1)
    @line2 = params.dig(:line2)
    @line3 = params.dig(:line3)
    @city = params.dig(:city)
    @region = params.dig(:region)
    @postal_code = params.dig(:postal_code)
    @country = params.dig(:country)
    @latitude = params.dig(:latitude)
    @longitude = params.dig(:longitude)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
end

Instance Attribute Details

#city ⇒ String

Returns The name of the city for this address.

Returns:

  • (String) —

    The name of the city for this address.



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

def city
  @city
end

#country ⇒ String

Returns The country for this address.

Returns:

  • (String) —

    The country for this address.



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

def country
  @country
end

#created ⇒ Date-time

Returns The date on which this address record was created.

Returns:

  • (Date-time) —

    The date on which this address record was created.



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

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID number of the user who created this address.

Returns:

  • (Uuid) —

    The ID number of the user who created this address.



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

def created_user_id
  @created_user_id
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).



46
47
48
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 46

def group_key
  @group_key
end

#invoice_address_id ⇒ Uuid

Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.

Returns:

  • (Uuid) —

    The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.



44
45
46
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 44

def invoice_address_id
  @invoice_address_id
end

#invoice_id ⇒ Uuid

Returns The ID number of the invoice this address belongs to.

Returns:

  • (Uuid) —

    The ID number of the invoice this address belongs to



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

def invoice_id
  @invoice_id
end

#latitude ⇒ Float

Returns The latitude of this address, if available.

Returns:

  • (Float) —

    The latitude of this address, if available.



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

def latitude
  @latitude
end

#line1 ⇒ String

Returns The first line of the address.

Returns:

  • (String) —

    The first line of the address.



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

def line1
  @line1
end

#line2 ⇒ String

Returns The second line of the address.

Returns:

  • (String) —

    The second line of the address.



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

def line2
  @line2
end

#line3 ⇒ String

Returns The third line of the address.

Returns:

  • (String) —

    The third line of the address.



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

def line3
  @line3
end

#longitude ⇒ Float

Returns The longitude of this address, if available.

Returns:

  • (Float) —

    The longitude of this address, if available.



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

def longitude
  @longitude
end

#modified ⇒ Date-time

Returns The date on which this address record was last modified.

Returns:

  • (Date-time) —

    The date on which this address record was last modified.



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

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID number of the user who most recently modified this address.

Returns:

  • (Uuid) —

    The ID number of the user who most recently modified this address.



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

def modified_user_id
  @modified_user_id
end

#postal_code ⇒ String

Returns The postal code for this address.

Returns:

  • (String) —

    The postal code for this address.



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

def postal_code
  @postal_code
end

#region ⇒ String

Returns The state or region part of this address.

Returns:

  • (String) —

    The state or region part of this address.



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

def region
  @region
end