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



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

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.



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

def city
  @city
end

#country ⇒ String

Returns The country for this address.

Returns:

  • (String) —

    The country for this address.



85
86
87
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 85

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.



97
98
99
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 97

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.



101
102
103
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 101

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).



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

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.



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

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



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

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.



89
90
91
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 89

def latitude
  @latitude
end

#line1 ⇒ String

Returns The first line of the address.

Returns:

  • (String) —

    The first line of the address.



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

def line1
  @line1
end

#line2 ⇒ String

Returns The second line of the address.

Returns:

  • (String) —

    The second line of the address.



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

def line2
  @line2
end

#line3 ⇒ String

Returns The third line of the address.

Returns:

  • (String) —

    The third line of the address.



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

def line3
  @line3
end

#longitude ⇒ Float

Returns The longitude of this address, if available.

Returns:

  • (Float) —

    The longitude of this address, if available.



93
94
95
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 93

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.



105
106
107
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 105

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.



109
110
111
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 109

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.



81
82
83
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 81

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.



77
78
79
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 77

def region
  @region
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 113

def as_json(options={})
    {
        'invoiceAddressId' => @invoice_address_id,
        'groupKey' => @group_key,
        'invoiceId' => @invoice_id,
        'line1' => @line1,
        'line2' => @line2,
        'line3' => @line3,
        'city' => @city,
        'region' => @region,
        'postalCode' => @postal_code,
        'country' => @country,
        'latitude' => @latitude,
        'longitude' => @longitude,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



136
137
138
 
# File 'lib/lockstep_sdk/models/invoice_address_model.rb', line 136

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end