lockstep_sdk 2022.37.24.0 → 2023.1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. checksums.yaml +4 -4
  2. data/lib/lockstep_sdk/clients/api_keys_client.rb +3 -3
  3. data/lib/lockstep_sdk/clients/app_enrollments_client.rb +5 -5
  4. data/lib/lockstep_sdk/clients/applications_client.rb +3 -3
  5. data/lib/lockstep_sdk/clients/attachments_client.rb +3 -3
  6. data/lib/lockstep_sdk/clients/code_definitions_client.rb +3 -3
  7. data/lib/lockstep_sdk/clients/companies_client.rb +40 -10
  8. data/lib/lockstep_sdk/clients/contacts_client.rb +17 -6
  9. data/lib/lockstep_sdk/clients/{credit_memo_applied_client.rb → credit_memos_applied_client.rb} +30 -30
  10. data/lib/lockstep_sdk/clients/currencies_client.rb +2 -2
  11. data/lib/lockstep_sdk/clients/custom_field_definitions_client.rb +3 -3
  12. data/lib/lockstep_sdk/clients/custom_field_values_client.rb +3 -3
  13. data/lib/lockstep_sdk/clients/definitions_client.rb +6 -6
  14. data/lib/lockstep_sdk/clients/feature_flags_client.rb +35 -0
  15. data/lib/lockstep_sdk/clients/financial_account_balance_history_client.rb +3 -3
  16. data/lib/lockstep_sdk/clients/financial_account_client.rb +3 -3
  17. data/lib/lockstep_sdk/clients/financial_year_settings_client.rb +3 -3
  18. data/lib/lockstep_sdk/clients/group_accounts_client.rb +2 -2
  19. data/lib/lockstep_sdk/clients/invoice_addresses_client.rb +91 -0
  20. data/lib/lockstep_sdk/clients/invoice_history_client.rb +3 -3
  21. data/lib/lockstep_sdk/clients/invoice_lines_client.rb +88 -0
  22. data/lib/lockstep_sdk/clients/invoices_client.rb +17 -6
  23. data/lib/lockstep_sdk/clients/leads_client.rb +2 -2
  24. data/lib/lockstep_sdk/clients/magic_links_client.rb +62 -0
  25. data/lib/lockstep_sdk/clients/notes_client.rb +3 -3
  26. data/lib/lockstep_sdk/clients/payments_applied_client.rb +93 -0
  27. data/lib/lockstep_sdk/clients/payments_client.rb +6 -6
  28. data/lib/lockstep_sdk/clients/profiles_accounting_client.rb +104 -0
  29. data/lib/lockstep_sdk/clients/profiles_accounting_contacts_client.rb +91 -0
  30. data/lib/lockstep_sdk/clients/{profiles_client.rb → profiles_companies_client.rb} +7 -7
  31. data/lib/lockstep_sdk/clients/provisioning_client.rb +2 -2
  32. data/lib/lockstep_sdk/clients/reports_client.rb +4 -4
  33. data/lib/lockstep_sdk/clients/status_client.rb +2 -2
  34. data/lib/lockstep_sdk/clients/sync_client.rb +3 -3
  35. data/lib/lockstep_sdk/clients/transactions_client.rb +54 -0
  36. data/lib/lockstep_sdk/clients/transcriptions_client.rb +91 -0
  37. data/lib/lockstep_sdk/clients/user_accounts_client.rb +13 -15
  38. data/lib/lockstep_sdk/clients/user_roles_client.rb +3 -3
  39. data/lib/lockstep_sdk/clients/webhook_rules_client.rb +3 -3
  40. data/lib/lockstep_sdk/clients/webhooks_client.rb +4 -4
  41. data/lib/lockstep_sdk/lockstep_api.rb +54 -24
  42. data/lib/lockstep_sdk/models/accounting_profile_contact_model.rb +90 -0
  43. data/lib/lockstep_sdk/models/accounting_profile_model.rb +183 -0
  44. data/lib/lockstep_sdk/models/action_result_model.rb +2 -2
  45. data/lib/lockstep_sdk/models/aging_model.rb +2 -2
  46. data/lib/lockstep_sdk/models/ap_aging_header_info_model.rb +2 -2
  47. data/lib/lockstep_sdk/models/ap_header_info_model.rb +8 -2
  48. data/lib/lockstep_sdk/models/api_key_model.rb +2 -2
  49. data/lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb +2 -2
  50. data/lib/lockstep_sdk/models/app_enrollment_model.rb +8 -2
  51. data/lib/lockstep_sdk/models/{app_enrollment_reconnect_request.rb → app_enrollment_reconnect_info.rb} +10 -4
  52. data/lib/lockstep_sdk/models/application_model.rb +2 -2
  53. data/lib/lockstep_sdk/models/ar_aging_header_info_model.rb +2 -2
  54. data/lib/lockstep_sdk/models/ar_header_info_model.rb +8 -2
  55. data/lib/lockstep_sdk/models/at_risk_invoice_summary_model.rb +26 -2
  56. data/lib/lockstep_sdk/models/attachment_header_info_model.rb +2 -2
  57. data/lib/lockstep_sdk/models/attachment_model.rb +2 -2
  58. data/lib/lockstep_sdk/models/batch_sync_model.rb +2 -2
  59. data/lib/lockstep_sdk/models/bulk_currency_conversion_model.rb +2 -2
  60. data/lib/lockstep_sdk/models/bulk_delete_request_model.rb +47 -0
  61. data/lib/lockstep_sdk/models/cashflow_report_model.rb +2 -2
  62. data/lib/lockstep_sdk/models/code_definition_model.rb +2 -2
  63. data/lib/lockstep_sdk/models/company_details_model.rb +2 -2
  64. data/lib/lockstep_sdk/models/company_details_payment_model.rb +2 -2
  65. data/lib/lockstep_sdk/models/company_model.rb +8 -8
  66. data/lib/lockstep_sdk/models/company_sync_model.rb +2 -8
  67. data/lib/lockstep_sdk/models/connector_info_model.rb +2 -2
  68. data/lib/lockstep_sdk/models/contact_model.rb +2 -2
  69. data/lib/lockstep_sdk/models/contact_sync_model.rb +2 -2
  70. data/lib/lockstep_sdk/models/country_model.rb +2 -2
  71. data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +2 -2
  72. data/lib/lockstep_sdk/models/credit_memo_applied_sync_model.rb +2 -2
  73. data/lib/lockstep_sdk/models/credit_memo_invoice_model.rb +32 -2
  74. data/lib/lockstep_sdk/models/currency_model.rb +2 -2
  75. data/lib/lockstep_sdk/models/currency_rate_model.rb +2 -2
  76. data/lib/lockstep_sdk/models/custom_field_definition_model.rb +2 -2
  77. data/lib/lockstep_sdk/models/custom_field_sync_model.rb +2 -2
  78. data/lib/lockstep_sdk/models/custom_field_value_model.rb +20 -2
  79. data/lib/lockstep_sdk/models/customer_summary_model.rb +8 -2
  80. data/lib/lockstep_sdk/models/daily_payable_outstanding_report_model.rb +2 -2
  81. data/lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb +2 -2
  82. data/lib/lockstep_sdk/models/delete_result.rb +47 -0
  83. data/lib/lockstep_sdk/models/developer_account_submit_model.rb +2 -2
  84. data/lib/lockstep_sdk/models/dpo_summary_group_total_model.rb +2 -2
  85. data/lib/lockstep_sdk/models/dpo_summary_model.rb +2 -2
  86. data/lib/lockstep_sdk/models/erp_model.rb +2 -2
  87. data/lib/lockstep_sdk/models/error_result.rb +2 -2
  88. data/lib/lockstep_sdk/models/feature_flags_request_model.rb +47 -0
  89. data/lib/lockstep_sdk/models/feature_flags_response_model.rb +47 -0
  90. data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb +2 -2
  91. data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb +2 -2
  92. data/lib/lockstep_sdk/models/financial_account_model.rb +2 -2
  93. data/lib/lockstep_sdk/models/financial_account_sync_model.rb +2 -2
  94. data/lib/lockstep_sdk/models/financial_report_cell_model.rb +2 -2
  95. data/lib/lockstep_sdk/models/financial_report_model.rb +2 -2
  96. data/lib/lockstep_sdk/models/financial_report_row_model.rb +2 -2
  97. data/lib/lockstep_sdk/models/financial_year_setting_model.rb +2 -2
  98. data/lib/lockstep_sdk/models/financial_year_setting_sync_model.rb +2 -2
  99. data/lib/lockstep_sdk/models/group_account_model.rb +8 -2
  100. data/lib/lockstep_sdk/models/invite_data_model.rb +2 -2
  101. data/lib/lockstep_sdk/models/invite_model.rb +2 -2
  102. data/lib/lockstep_sdk/models/invite_submit_model.rb +2 -2
  103. data/lib/lockstep_sdk/models/invoice_address_model.rb +2 -2
  104. data/lib/lockstep_sdk/models/invoice_history_model.rb +8 -2
  105. data/lib/lockstep_sdk/models/invoice_line_model.rb +2 -2
  106. data/lib/lockstep_sdk/models/invoice_line_sync_model.rb +2 -2
  107. data/lib/lockstep_sdk/models/invoice_model.rb +8 -2
  108. data/lib/lockstep_sdk/models/invoice_payment_detail_model.rb +32 -2
  109. data/lib/lockstep_sdk/models/invoice_summary_model.rb +44 -2
  110. data/lib/lockstep_sdk/models/invoice_summary_model_invoice_summary_totals_model_summary_fetch_result.rb +75 -0
  111. data/lib/lockstep_sdk/models/invoice_summary_totals_model.rb +53 -0
  112. data/lib/lockstep_sdk/models/invoice_sync_model.rb +8 -2
  113. data/lib/lockstep_sdk/models/lead_model.rb +3 -3
  114. data/lib/lockstep_sdk/models/magic_link_model.rb +131 -0
  115. data/lib/lockstep_sdk/models/magic_link_status_model.rb +71 -0
  116. data/lib/lockstep_sdk/models/note_model.rb +2 -2
  117. data/lib/lockstep_sdk/models/payables_coming_due_header_model.rb +2 -2
  118. data/lib/lockstep_sdk/models/payables_coming_due_model.rb +2 -2
  119. data/lib/lockstep_sdk/models/payables_coming_due_widget_model.rb +2 -2
  120. data/lib/lockstep_sdk/models/payables_summary_report_model.rb +2 -2
  121. data/lib/lockstep_sdk/models/payment_applied_model.rb +2 -2
  122. data/lib/lockstep_sdk/models/payment_applied_sync_model.rb +2 -2
  123. data/lib/lockstep_sdk/models/payment_detail_header_model.rb +10 -4
  124. data/lib/lockstep_sdk/models/payment_detail_model.rb +26 -2
  125. data/lib/lockstep_sdk/models/payment_model.rb +8 -2
  126. data/lib/lockstep_sdk/models/payment_summary_model.rb +38 -2
  127. data/lib/lockstep_sdk/models/payment_summary_model_payment_summary_totals_model_summary_fetch_result.rb +75 -0
  128. data/lib/lockstep_sdk/models/payment_summary_totals_model.rb +53 -0
  129. data/lib/lockstep_sdk/models/payment_sync_model.rb +8 -2
  130. data/lib/lockstep_sdk/models/public_company_profile_model.rb +2 -2
  131. data/lib/lockstep_sdk/models/risk_rate_model.rb +10 -4
  132. data/lib/lockstep_sdk/models/state_model.rb +2 -2
  133. data/lib/lockstep_sdk/models/status_model.rb +32 -2
  134. data/lib/lockstep_sdk/models/summary_aging_totals_model.rb +53 -0
  135. data/lib/lockstep_sdk/models/sync_entity_result_model.rb +2 -2
  136. data/lib/lockstep_sdk/models/sync_request_model.rb +14 -2
  137. data/lib/lockstep_sdk/models/sync_submit_model.rb +2 -2
  138. data/lib/lockstep_sdk/models/transaction_detail_model.rb +138 -0
  139. data/lib/lockstep_sdk/models/transaction_model.rb +144 -0
  140. data/lib/lockstep_sdk/models/transaction_model_transaction_summary_total_model_summary_fetch_result.rb +75 -0
  141. data/lib/lockstep_sdk/models/transaction_summary_total_model.rb +71 -0
  142. data/lib/lockstep_sdk/models/transcription_request_submit.rb +71 -0
  143. data/lib/lockstep_sdk/models/transcription_validation_request.rb +89 -0
  144. data/lib/lockstep_sdk/models/transcription_validation_request_item.rb +149 -0
  145. data/lib/lockstep_sdk/models/transfer_owner_model.rb +2 -2
  146. data/lib/lockstep_sdk/models/transfer_owner_submit_model.rb +2 -2
  147. data/lib/lockstep_sdk/models/uri_model.rb +2 -2
  148. data/lib/lockstep_sdk/models/user_account_model.rb +2 -2
  149. data/lib/lockstep_sdk/models/user_data_response_model.rb +53 -0
  150. data/lib/lockstep_sdk/models/user_group_model.rb +2 -2
  151. data/lib/lockstep_sdk/models/user_role_model.rb +2 -2
  152. data/lib/lockstep_sdk/models/vendor_summary_model.rb +44 -2
  153. data/lib/lockstep_sdk/models/view_box_settings_model.rb +65 -0
  154. data/lib/lockstep_sdk/models/webhook_history_table_storage_model.rb +2 -2
  155. data/lib/lockstep_sdk/models/webhook_model.rb +2 -2
  156. data/lib/lockstep_sdk/models/webhook_rule_model.rb +2 -2
  157. data/lib/lockstep_sdk/version.rb +1 -1
  158. metadata +36 -12
  159. data/lib/lockstep_sdk/clients/activities_client.rb +0 -116
  160. data/lib/lockstep_sdk/clients/emails_client.rb +0 -105
  161. data/lib/lockstep_sdk/clients/payment_applications_client.rb +0 -93
  162. data/lib/lockstep_sdk/models/activity_model.rb +0 -218
  163. data/lib/lockstep_sdk/models/activity_stream_item_model.rb +0 -101
  164. data/lib/lockstep_sdk/models/activity_xref_model.rb +0 -71
  165. data/lib/lockstep_sdk/models/email_model.rb +0 -242
@@ -0,0 +1,131 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'json'
16
+
17
+ module LockstepSdk
18
+
19
+ ##
20
+ # Represents a magic link that can be used to log in to a Lockstep application.
21
+ class MagicLinkModel
22
+
23
+ ##
24
+ # Initialize the MagicLinkModel using the provided prototype
25
+ def initialize(params = {})
26
+ @magic_link_id = params.dig(:magic_link_id)
27
+ @group_key = params.dig(:group_key)
28
+ @user_id = params.dig(:user_id)
29
+ @user_role = params.dig(:user_role)
30
+ @application_id = params.dig(:application_id)
31
+ @expires = params.dig(:expires)
32
+ @revoked = params.dig(:revoked)
33
+ @created = params.dig(:created)
34
+ @created_user_id = params.dig(:created_user_id)
35
+ @modified = params.dig(:modified)
36
+ @modified_user_id = params.dig(:modified_user_id)
37
+ @company_id = params.dig(:company_id)
38
+ @accounting_profile_id = params.dig(:accounting_profile_id)
39
+ @magic_link_url = params.dig(:magic_link_url)
40
+ @user = params.dig(:user)
41
+ end
42
+
43
+ ##
44
+ # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
45
+ attr_accessor :magic_link_id
46
+
47
+ ##
48
+ # @return [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.
49
+ attr_accessor :group_key
50
+
51
+ ##
52
+ # @return [Uuid] The unique ID of the user that this magic link is associated with.
53
+ attr_accessor :user_id
54
+
55
+ ##
56
+ # @return [Uuid] The ID of the user role for the magic link.
57
+ attr_accessor :user_role
58
+
59
+ ##
60
+ # @return [Uuid] The ID of the application for this magic link.
61
+ attr_accessor :application_id
62
+
63
+ ##
64
+ # @return [Date-time] The UTC date and time when this magic link expires.
65
+ attr_accessor :expires
66
+
67
+ ##
68
+ # @return [Date-time] The UTC date and time when this magic link was revoked.
69
+ attr_accessor :revoked
70
+
71
+ ##
72
+ # @return [Date-time] The date that the magic link was created
73
+ attr_accessor :created
74
+
75
+ ##
76
+ # @return [Uuid] The ID of the user who created the magic link
77
+ attr_accessor :created_user_id
78
+
79
+ ##
80
+ # @return [Date-time] The date that the magic link was last modified
81
+ attr_accessor :modified
82
+
83
+ ##
84
+ # @return [Uuid] The ID of the user who last modified the magic link
85
+ attr_accessor :modified_user_id
86
+
87
+ ##
88
+ # @return [Uuid] The ID of the company associated to this magic link
89
+ attr_accessor :company_id
90
+
91
+ ##
92
+ # @return [Uuid] The ID of the accounting profile associated to this magic link
93
+ attr_accessor :accounting_profile_id
94
+
95
+ ##
96
+ # @return [String] The created magic link URL. This will only be returned upon creation of the magic link. All other times, this value will be `null`.
97
+ attr_accessor :magic_link_url
98
+
99
+ ##
100
+ # @return [UserAccountModel] The user associated with this magic link. To retrieve this item, specify `User` in the "Include" parameter for your query.
101
+ attr_accessor :user
102
+
103
+ ##
104
+ # @return [object] This object as a JSON key-value structure
105
+ def as_json(options={})
106
+ {
107
+ 'magicLinkId' => @magic_link_id,
108
+ 'groupKey' => @group_key,
109
+ 'userId' => @user_id,
110
+ 'userRole' => @user_role,
111
+ 'applicationId' => @application_id,
112
+ 'expires' => @expires,
113
+ 'revoked' => @revoked,
114
+ 'created' => @created,
115
+ 'createdUserId' => @created_user_id,
116
+ 'modified' => @modified,
117
+ 'modifiedUserId' => @modified_user_id,
118
+ 'companyId' => @company_id,
119
+ 'accountingProfileId' => @accounting_profile_id,
120
+ 'magicLinkUrl' => @magic_link_url,
121
+ 'user' => @user,
122
+ }
123
+ end
124
+
125
+ ##
126
+ # @return [String] This object converted to a JSON string
127
+ def to_json(*options)
128
+ "[#{as_json(*options).to_json(*options)}]"
129
+ end
130
+ end
131
+ end
@@ -0,0 +1,71 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'json'
16
+
17
+ module LockstepSdk
18
+
19
+ ##
20
+ # Contains information about the user's magic link
21
+ class MagicLinkStatusModel
22
+
23
+ ##
24
+ # Initialize the MagicLinkStatusModel using the provided prototype
25
+ def initialize(params = {})
26
+ @magic_link_id = params.dig(:magic_link_id)
27
+ @application_id = params.dig(:application_id)
28
+ @company_id = params.dig(:company_id)
29
+ @accounting_profile_id = params.dig(:accounting_profile_id)
30
+ @expires = params.dig(:expires)
31
+ end
32
+
33
+ ##
34
+ # @return [Uuid] The id of the Magic link used to authenticate.
35
+ attr_accessor :magic_link_id
36
+
37
+ ##
38
+ # @return [Uuid] The id of the application for the Magic Link
39
+ attr_accessor :application_id
40
+
41
+ ##
42
+ # @return [Uuid] The id of the target company for the Magic Link
43
+ attr_accessor :company_id
44
+
45
+ ##
46
+ # @return [Uuid] The id of the accounting profile for the Magic Link
47
+ attr_accessor :accounting_profile_id
48
+
49
+ ##
50
+ # @return [Date-time] The UTC date and time when this magic link expires.
51
+ attr_accessor :expires
52
+
53
+ ##
54
+ # @return [object] This object as a JSON key-value structure
55
+ def as_json(options={})
56
+ {
57
+ 'magicLinkId' => @magic_link_id,
58
+ 'applicationId' => @application_id,
59
+ 'companyId' => @company_id,
60
+ 'accountingProfileId' => @accounting_profile_id,
61
+ 'expires' => @expires,
62
+ }
63
+ end
64
+
65
+ ##
66
+ # @return [String] This object converted to a JSON string
67
+ def to_json(*options)
68
+ "[#{as_json(*options).to_json(*options)}]"
69
+ end
70
+ end
71
+ end
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -24,6 +24,7 @@ module LockstepSdk
24
24
  # Initialize the PaymentDetailHeaderModel using the provided prototype
25
25
  def initialize(params = {})
26
26
  @group_key = params.dig(:group_key)
27
+ @base_currency_code = params.dig(:base_currency_code)
27
28
  @customer_count = params.dig(:customer_count)
28
29
  @amount_collected = params.dig(:amount_collected)
29
30
  @unapplied_amount = params.dig(:unapplied_amount)
@@ -35,16 +36,20 @@ module LockstepSdk
35
36
  # @return [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](https://developer.lockstep.io/docs/accounts-and-groupkeys).
36
37
  attr_accessor :group_key
37
38
 
39
+ ##
40
+ # @return [String] The base currency code of the group.
41
+ attr_accessor :base_currency_code
42
+
38
43
  ##
39
44
  # @return [Int32] The total number of Customers.
40
45
  attr_accessor :customer_count
41
46
 
42
47
  ##
43
- # @return [Double] The total amount collected.
48
+ # @return [Double] The total amount collected in the group's base currency.
44
49
  attr_accessor :amount_collected
45
50
 
46
51
  ##
47
- # @return [Double] The total unapplied amount.
52
+ # @return [Double] The total unapplied amount in the group's base currency.
48
53
  attr_accessor :unapplied_amount
49
54
 
50
55
  ##
@@ -60,6 +65,7 @@ module LockstepSdk
60
65
  def as_json(options={})
61
66
  {
62
67
  'groupKey' => @group_key,
68
+ 'baseCurrencyCode' => @base_currency_code,
63
69
  'customerCount' => @customer_count,
64
70
  'amountCollected' => @amount_collected,
65
71
  'unappliedAmount' => @unapplied_amount,
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -31,8 +31,12 @@ module LockstepSdk
31
31
  @reference_code = params.dig(:reference_code)
32
32
  @primary_contact = params.dig(:primary_contact)
33
33
  @email = params.dig(:email)
34
+ @currency_code = params.dig(:currency_code)
34
35
  @payment_amount = params.dig(:payment_amount)
35
36
  @unapplied_amount = params.dig(:unapplied_amount)
37
+ @base_currency_code = params.dig(:base_currency_code)
38
+ @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
39
+ @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
36
40
  @payment_type = params.dig(:payment_type)
37
41
  @tender_type = params.dig(:tender_type)
38
42
  @payment_date = params.dig(:payment_date)
@@ -80,6 +84,10 @@ module LockstepSdk
80
84
  # @return [String] The Email address of the Customer.
81
85
  attr_accessor :email
82
86
 
87
+ ##
88
+ # @return [String] The currency code of the payment.
89
+ attr_accessor :currency_code
90
+
83
91
  ##
84
92
  # @return [Double] Total amount of this Payment.
85
93
  attr_accessor :payment_amount
@@ -88,6 +96,18 @@ module LockstepSdk
88
96
  # @return [Double] Unapplied balance of this Payment.
89
97
  attr_accessor :unapplied_amount
90
98
 
99
+ ##
100
+ # @return [String] The base currency code of the group.
101
+ attr_accessor :base_currency_code
102
+
103
+ ##
104
+ # @return [Double] The payment amount in the group's base currency.
105
+ attr_accessor :base_currency_payment_amount
106
+
107
+ ##
108
+ # @return [Double] The payment amount in the group's base currency.
109
+ attr_accessor :base_currency_unapplied_amount
110
+
91
111
  ##
92
112
  # @return [String] The type of payment, AR Payment or AP Payment. Recognized PaymentType values are: * `AR Payment` - A payment made by a Customer to the Company * `AP Payment` - A payment made by the Company to a Vendor
93
113
  attr_accessor :payment_type
@@ -152,8 +172,12 @@ module LockstepSdk
152
172
  'referenceCode' => @reference_code,
153
173
  'primaryContact' => @primary_contact,
154
174
  'email' => @email,
175
+ 'currencyCode' => @currency_code,
155
176
  'paymentAmount' => @payment_amount,
156
177
  'unappliedAmount' => @unapplied_amount,
178
+ 'baseCurrencyCode' => @base_currency_code,
179
+ 'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
180
+ 'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
157
181
  'paymentType' => @payment_type,
158
182
  'tenderType' => @tender_type,
159
183
  'paymentDate' => @payment_date,
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -50,6 +50,7 @@ module LockstepSdk
50
50
  @app_enrollment_id = params.dig(:app_enrollment_id)
51
51
  @is_voided = params.dig(:is_voided)
52
52
  @in_dispute = params.dig(:in_dispute)
53
+ @currency_rate = params.dig(:currency_rate)
53
54
  @applications = params.dig(:applications)
54
55
  @notes = params.dig(:notes)
55
56
  @attachments = params.dig(:attachments)
@@ -141,6 +142,10 @@ module LockstepSdk
141
142
  # @return [Boolean] Is the payment in dispute?
142
143
  attr_accessor :in_dispute
143
144
 
145
+ ##
146
+ # @return [Double] The Currency Rate used to get from the account's base currency to the payment amount.
147
+ attr_accessor :currency_rate
148
+
144
149
  ##
145
150
  # @return [PaymentAppliedModel] All applications this payment is associated with. To retrieve this collection, specify `Applications` in the "Include" parameter for your query.
146
151
  attr_accessor :applications
@@ -186,6 +191,7 @@ module LockstepSdk
186
191
  'appEnrollmentId' => @app_enrollment_id,
187
192
  'isVoided' => @is_voided,
188
193
  'inDispute' => @in_dispute,
194
+ 'currencyRate' => @currency_rate,
189
195
  'applications' => @applications,
190
196
  'notes' => @notes,
191
197
  'attachments' => @attachments,
@@ -1,13 +1,13 @@
1
1
  #
2
2
  # Lockstep Platform SDK for Ruby
3
3
  #
4
- # (c) 2021-2022 Lockstep, Inc.
4
+ # (c) 2021-2023 Lockstep, Inc.
5
5
  #
6
6
  # For the full copyright and license information, please view the LICENSE
7
7
  # file that was distributed with this source code.
8
8
  #
9
9
  # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2022 Lockstep, Inc.
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
12
  #
13
13
 
@@ -30,8 +30,12 @@ module LockstepSdk
30
30
  @tender_type = params.dig(:tender_type)
31
31
  @payment_type = params.dig(:payment_type)
32
32
  @payment_date = params.dig(:payment_date)
33
+ @currency_code = params.dig(:currency_code)
33
34
  @payment_amount = params.dig(:payment_amount)
34
35
  @unapplied_amount = params.dig(:unapplied_amount)
36
+ @base_currency_code = params.dig(:base_currency_code)
37
+ @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
38
+ @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
35
39
  @is_open = params.dig(:is_open)
36
40
  @invoice_count = params.dig(:invoice_count)
37
41
  @total_payments_applied = params.dig(:total_payments_applied)
@@ -39,10 +43,12 @@ module LockstepSdk
39
43
  @invoice_id_list = params.dig(:invoice_id_list)
40
44
  @payment_company_id = params.dig(:payment_company_id)
41
45
  @payment_company_name = params.dig(:payment_company_name)
46
+ @supports_erp_pdf_retrieval = params.dig(:supports_erp_pdf_retrieval)
42
47
  @customer_ids = params.dig(:customer_ids)
43
48
  @customer_names = params.dig(:customer_names)
44
49
  @company_ids = params.dig(:company_ids)
45
50
  @company_names = params.dig(:company_names)
51
+ @modified = params.dig(:modified)
46
52
  end
47
53
 
48
54
  ##
@@ -73,6 +79,10 @@ module LockstepSdk
73
79
  # @return [Date] The date of this payment.
74
80
  attr_accessor :payment_date
75
81
 
82
+ ##
83
+ # @return [String] The currency code of the payment.
84
+ attr_accessor :currency_code
85
+
76
86
  ##
77
87
  # @return [Double] Total amount of this payment.
78
88
  attr_accessor :payment_amount
@@ -81,6 +91,18 @@ module LockstepSdk
81
91
  # @return [Double] Unapplied balance of this payment.
82
92
  attr_accessor :unapplied_amount
83
93
 
94
+ ##
95
+ # @return [String] The base currency code of the group.
96
+ attr_accessor :base_currency_code
97
+
98
+ ##
99
+ # @return [Double] The payment amount in the group's base currency.
100
+ attr_accessor :base_currency_payment_amount
101
+
102
+ ##
103
+ # @return [Double] The unapplied amount in the group's base currency.
104
+ attr_accessor :base_currency_unapplied_amount
105
+
84
106
  ##
85
107
  # @return [Boolean] True if this payment includes some unassigned amount that has not yet been applied to an invoice. If this value is true, the field `UnappliedAmount` will be nonzero.
86
108
  attr_accessor :is_open
@@ -109,6 +131,10 @@ module LockstepSdk
109
131
  # @return [String] The name of the company for this payment.
110
132
  attr_accessor :payment_company_name
111
133
 
134
+ ##
135
+ # @return [Boolean] Specific payments have support for pdf retrieval from their respective erp. When this flag is true, an additional call to Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
136
+ attr_accessor :supports_erp_pdf_retrieval
137
+
112
138
  ##
113
139
  # @return [Uuid] The ids of the customer for the associated invoices.
114
140
  attr_accessor :customer_ids
@@ -125,6 +151,10 @@ module LockstepSdk
125
151
  # @return [String] The names of the company for the associated invoices.
126
152
  attr_accessor :company_names
127
153
 
154
+ ##
155
+ # @return [Date-time] The modified date of the payment
156
+ attr_accessor :modified
157
+
128
158
  ##
129
159
  # @return [object] This object as a JSON key-value structure
130
160
  def as_json(options={})
@@ -136,8 +166,12 @@ module LockstepSdk
136
166
  'tenderType' => @tender_type,
137
167
  'paymentType' => @payment_type,
138
168
  'paymentDate' => @payment_date,
169
+ 'currencyCode' => @currency_code,
139
170
  'paymentAmount' => @payment_amount,
140
171
  'unappliedAmount' => @unapplied_amount,
172
+ 'baseCurrencyCode' => @base_currency_code,
173
+ 'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
174
+ 'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
141
175
  'isOpen' => @is_open,
142
176
  'invoiceCount' => @invoice_count,
143
177
  'totalPaymentsApplied' => @total_payments_applied,
@@ -145,10 +179,12 @@ module LockstepSdk
145
179
  'invoiceIdList' => @invoice_id_list,
146
180
  'paymentCompanyId' => @payment_company_id,
147
181
  'paymentCompanyName' => @payment_company_name,
182
+ 'supportsErpPdfRetrieval' => @supports_erp_pdf_retrieval,
148
183
  'customerIds' => @customer_ids,
149
184
  'customerNames' => @customer_names,
150
185
  'companyIds' => @company_ids,
151
186
  'companyNames' => @company_names,
187
+ 'modified' => @modified,
152
188
  }
153
189
  end
154
190
 
@@ -0,0 +1,75 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'json'
16
+
17
+ module LockstepSdk
18
+
19
+ class PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult
20
+
21
+ ##
22
+ # Initialize the PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult using the provided prototype
23
+ def initialize(params = {})
24
+ @records = params.dig(:records)
25
+ @total_count = params.dig(:total_count)
26
+ @page_size = params.dig(:page_size)
27
+ @page_number = params.dig(:page_number)
28
+ @summary = params.dig(:summary)
29
+ @aging_summary = params.dig(:aging_summary)
30
+ end
31
+
32
+ ##
33
+ # @return [PaymentSummaryModel]
34
+ attr_accessor :records
35
+
36
+ ##
37
+ # @return [Int32]
38
+ attr_accessor :total_count
39
+
40
+ ##
41
+ # @return [Int32]
42
+ attr_accessor :page_size
43
+
44
+ ##
45
+ # @return [Int32]
46
+ attr_accessor :page_number
47
+
48
+ ##
49
+ # @return [PaymentSummaryTotalsModel] The totals for a Payment Summary
50
+ attr_accessor :summary
51
+
52
+ ##
53
+ # @return [SummaryAgingTotalsModel]
54
+ attr_accessor :aging_summary
55
+
56
+ ##
57
+ # @return [object] This object as a JSON key-value structure
58
+ def as_json(options={})
59
+ {
60
+ 'records' => @records,
61
+ 'totalCount' => @total_count,
62
+ 'pageSize' => @page_size,
63
+ 'pageNumber' => @page_number,
64
+ 'summary' => @summary,
65
+ 'agingSummary' => @aging_summary,
66
+ }
67
+ end
68
+
69
+ ##
70
+ # @return [String] This object converted to a JSON string
71
+ def to_json(*options)
72
+ "[#{as_json(*options).to_json(*options)}]"
73
+ end
74
+ end
75
+ end