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,53 @@
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 data about the current user.
21
+ class UserDataResponseModel
22
+
23
+ ##
24
+ # Initialize the UserDataResponseModel using the provided prototype
25
+ def initialize(params = {})
26
+ @data = params.dig(:data)
27
+ @user_id = params.dig(:user_id)
28
+ end
29
+
30
+ ##
31
+ # @return [Object] Data about the user, the properties returned will depend on the requested information.
32
+ attr_accessor :data
33
+
34
+ ##
35
+ # @return [Uuid] The Lockstep Platform ID of the user
36
+ attr_accessor :user_id
37
+
38
+ ##
39
+ # @return [object] This object as a JSON key-value structure
40
+ def as_json(options={})
41
+ {
42
+ 'data' => @data,
43
+ 'userId' => @user_id,
44
+ }
45
+ end
46
+
47
+ ##
48
+ # @return [String] This object converted to a JSON string
49
+ def to_json(*options)
50
+ "[#{as_json(*options).to_json(*options)}]"
51
+ end
52
+ end
53
+ 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
 
@@ -30,17 +30,24 @@ module LockstepSdk
30
30
  @primary_contact_name = params.dig(:primary_contact_name)
31
31
  @primary_contact_id = params.dig(:primary_contact_id)
32
32
  @amount_paid_last30 = params.dig(:amount_paid_last30)
33
+ @amount_paid_past_thirty_days = params.dig(:amount_paid_past_thirty_days)
33
34
  @advance_pay_last30 = params.dig(:advance_pay_last30)
35
+ @advance_pay_past_thirty_days = params.dig(:advance_pay_past_thirty_days)
34
36
  @advance_pay_outstanding = params.dig(:advance_pay_outstanding)
35
37
  @amount_billed_last30 = params.dig(:amount_billed_last30)
38
+ @amount_billed_past_thirty_days = params.dig(:amount_billed_past_thirty_days)
36
39
  @amount_billed_outstanding_last30 = params.dig(:amount_billed_outstanding_last30)
40
+ @amount_billed_outstanding_past_thirty_days = params.dig(:amount_billed_outstanding_past_thirty_days)
37
41
  @amount_billed_outstanding = params.dig(:amount_billed_outstanding)
38
42
  @bill_count_last30 = params.dig(:bill_count_last30)
43
+ @bill_count_past_thirty_days = params.dig(:bill_count_past_thirty_days)
39
44
  @paid_bill_count_last30 = params.dig(:paid_bill_count_last30)
45
+ @paid_bill_count_past_thirty_days = params.dig(:paid_bill_count_past_thirty_days)
40
46
  @open_bill_count = params.dig(:open_bill_count)
41
47
  @paid_bill_count = params.dig(:paid_bill_count)
42
48
  @total_bill_count = params.dig(:total_bill_count)
43
49
  @dpo = params.dig(:dpo)
50
+ @modified = params.dig(:modified)
44
51
  end
45
52
 
46
53
  ##
@@ -71,10 +78,18 @@ module LockstepSdk
71
78
  # @return [Double] The amount paid to this Vendor in the last 30 days
72
79
  attr_accessor :amount_paid_last30
73
80
 
81
+ ##
82
+ # @return [Double] The amount paid to this Vendor in the last 30 days
83
+ attr_accessor :amount_paid_past_thirty_days
84
+
74
85
  ##
75
86
  # @return [Double] The outstanding advance pay balance on payments in the last 30 days
76
87
  attr_accessor :advance_pay_last30
77
88
 
89
+ ##
90
+ # @return [Double] The outstanding advance pay balance on payments in the last 30 days
91
+ attr_accessor :advance_pay_past_thirty_days
92
+
78
93
  ##
79
94
  # @return [Double] The outstanding advance pay balance with this Vendor
80
95
  attr_accessor :advance_pay_outstanding
@@ -83,10 +98,18 @@ module LockstepSdk
83
98
  # @return [Double] The amount billed from this Vendor in the last 30 days
84
99
  attr_accessor :amount_billed_last30
85
100
 
101
+ ##
102
+ # @return [Double] The amount billed from this Vendor in the last 30 days
103
+ attr_accessor :amount_billed_past_thirty_days
104
+
86
105
  ##
87
106
  # @return [Double] The outstanding balance with this Vendor for bills in the last 30 days
88
107
  attr_accessor :amount_billed_outstanding_last30
89
108
 
109
+ ##
110
+ # @return [Double] The outstanding balance with this Vendor for bills in the last 30 days
111
+ attr_accessor :amount_billed_outstanding_past_thirty_days
112
+
90
113
  ##
91
114
  # @return [Double] The outstanding balance with this Vendor
92
115
  attr_accessor :amount_billed_outstanding
@@ -95,10 +118,18 @@ module LockstepSdk
95
118
  # @return [Int32] The number of bills received from this Vendor in the last 30 days
96
119
  attr_accessor :bill_count_last30
97
120
 
121
+ ##
122
+ # @return [Int32] The number of bills received from this Vendor in the last 30 days
123
+ attr_accessor :bill_count_past_thirty_days
124
+
98
125
  ##
99
126
  # @return [Int32] The number of bills from this Vendor that were paid in full in the last 30 days
100
127
  attr_accessor :paid_bill_count_last30
101
128
 
129
+ ##
130
+ # @return [Int32] The number of bills from this Vendor that were paid in full in the last 30 days
131
+ attr_accessor :paid_bill_count_past_thirty_days
132
+
102
133
  ##
103
134
  # @return [Int32] The number of open bills with this Vendor
104
135
  attr_accessor :open_bill_count
@@ -115,6 +146,10 @@ module LockstepSdk
115
146
  # @return [Double] The days payabale outstanding.
116
147
  attr_accessor :dpo
117
148
 
149
+ ##
150
+ # @return [Date-time] The modified date of the Vendor
151
+ attr_accessor :modified
152
+
118
153
  ##
119
154
  # @return [object] This object as a JSON key-value structure
120
155
  def as_json(options={})
@@ -126,17 +161,24 @@ module LockstepSdk
126
161
  'primaryContactName' => @primary_contact_name,
127
162
  'primaryContactId' => @primary_contact_id,
128
163
  'amountPaidLast30' => @amount_paid_last30,
164
+ 'amountPaidPastThirtyDays' => @amount_paid_past_thirty_days,
129
165
  'advancePayLast30' => @advance_pay_last30,
166
+ 'advancePayPastThirtyDays' => @advance_pay_past_thirty_days,
130
167
  'advancePayOutstanding' => @advance_pay_outstanding,
131
168
  'amountBilledLast30' => @amount_billed_last30,
169
+ 'amountBilledPastThirtyDays' => @amount_billed_past_thirty_days,
132
170
  'amountBilledOutstandingLast30' => @amount_billed_outstanding_last30,
171
+ 'amountBilledOutstandingPastThirtyDays' => @amount_billed_outstanding_past_thirty_days,
133
172
  'amountBilledOutstanding' => @amount_billed_outstanding,
134
173
  'billCountLast30' => @bill_count_last30,
174
+ 'billCountPastThirtyDays' => @bill_count_past_thirty_days,
135
175
  'paidBillCountLast30' => @paid_bill_count_last30,
176
+ 'paidBillCountPastThirtyDays' => @paid_bill_count_past_thirty_days,
136
177
  'openBillCount' => @open_bill_count,
137
178
  'paidBillCount' => @paid_bill_count,
138
179
  'totalBillCount' => @total_bill_count,
139
180
  'dpo' => @dpo,
181
+ 'modified' => @modified,
140
182
  }
141
183
  end
142
184
 
@@ -0,0 +1,65 @@
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
+ # Optional meta data for image view box settings.
21
+ class ViewBoxSettingsModel
22
+
23
+ ##
24
+ # Initialize the ViewBoxSettingsModel using the provided prototype
25
+ def initialize(params = {})
26
+ @logo_view_box_min_x = params.dig(:logo_view_box_min_x)
27
+ @logo_view_box_min_y = params.dig(:logo_view_box_min_y)
28
+ @logo_view_box_width = params.dig(:logo_view_box_width)
29
+ @logo_view_box_height = params.dig(:logo_view_box_height)
30
+ end
31
+
32
+ ##
33
+ # @return [Double] ViewBox minX setting for this Company's logo.
34
+ attr_accessor :logo_view_box_min_x
35
+
36
+ ##
37
+ # @return [Double] ViewBox minY setting for this Company's logo.
38
+ attr_accessor :logo_view_box_min_y
39
+
40
+ ##
41
+ # @return [Double] ViewBox width setting for this Company's logo.
42
+ attr_accessor :logo_view_box_width
43
+
44
+ ##
45
+ # @return [Double] ViewBox height setting for this Company's logo.
46
+ attr_accessor :logo_view_box_height
47
+
48
+ ##
49
+ # @return [object] This object as a JSON key-value structure
50
+ def as_json(options={})
51
+ {
52
+ 'logoViewBoxMinX' => @logo_view_box_min_x,
53
+ 'logoViewBoxMinY' => @logo_view_box_min_y,
54
+ 'logoViewBoxWidth' => @logo_view_box_width,
55
+ 'logoViewBoxHeight' => @logo_view_box_height,
56
+ }
57
+ end
58
+
59
+ ##
60
+ # @return [String] This object converted to a JSON string
61
+ def to_json(*options)
62
+ "[#{as_json(*options).to_json(*options)}]"
63
+ end
64
+ end
65
+ 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,3 +1,3 @@
1
1
  module LockstepSdk
2
- VERSION = "2022.37.24.0"
2
+ VERSION = "2023.1.3.0"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: lockstep_sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 2022.37.24.0
4
+ version: 2023.1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Lockstep
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-09-16 00:00:00.000000000 Z
11
+ date: 2023-01-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: awrence
@@ -32,7 +32,6 @@ executables: []
32
32
  extensions: []
33
33
  extra_rdoc_files: []
34
34
  files:
35
- - lib/lockstep_sdk/clients/activities_client.rb
36
35
  - lib/lockstep_sdk/clients/api_keys_client.rb
37
36
  - lib/lockstep_sdk/clients/app_enrollments_client.rb
38
37
  - lib/lockstep_sdk/clients/applications_client.rb
@@ -40,43 +39,49 @@ files:
40
39
  - lib/lockstep_sdk/clients/code_definitions_client.rb
41
40
  - lib/lockstep_sdk/clients/companies_client.rb
42
41
  - lib/lockstep_sdk/clients/contacts_client.rb
43
- - lib/lockstep_sdk/clients/credit_memo_applied_client.rb
42
+ - lib/lockstep_sdk/clients/credit_memos_applied_client.rb
44
43
  - lib/lockstep_sdk/clients/currencies_client.rb
45
44
  - lib/lockstep_sdk/clients/custom_field_definitions_client.rb
46
45
  - lib/lockstep_sdk/clients/custom_field_values_client.rb
47
46
  - lib/lockstep_sdk/clients/definitions_client.rb
48
- - lib/lockstep_sdk/clients/emails_client.rb
47
+ - lib/lockstep_sdk/clients/feature_flags_client.rb
49
48
  - lib/lockstep_sdk/clients/financial_account_balance_history_client.rb
50
49
  - lib/lockstep_sdk/clients/financial_account_client.rb
51
50
  - lib/lockstep_sdk/clients/financial_year_settings_client.rb
52
51
  - lib/lockstep_sdk/clients/group_accounts_client.rb
52
+ - lib/lockstep_sdk/clients/invoice_addresses_client.rb
53
53
  - lib/lockstep_sdk/clients/invoice_history_client.rb
54
+ - lib/lockstep_sdk/clients/invoice_lines_client.rb
54
55
  - lib/lockstep_sdk/clients/invoices_client.rb
55
56
  - lib/lockstep_sdk/clients/leads_client.rb
57
+ - lib/lockstep_sdk/clients/magic_links_client.rb
56
58
  - lib/lockstep_sdk/clients/notes_client.rb
57
- - lib/lockstep_sdk/clients/payment_applications_client.rb
59
+ - lib/lockstep_sdk/clients/payments_applied_client.rb
58
60
  - lib/lockstep_sdk/clients/payments_client.rb
59
- - lib/lockstep_sdk/clients/profiles_client.rb
61
+ - lib/lockstep_sdk/clients/profiles_accounting_client.rb
62
+ - lib/lockstep_sdk/clients/profiles_accounting_contacts_client.rb
63
+ - lib/lockstep_sdk/clients/profiles_companies_client.rb
60
64
  - lib/lockstep_sdk/clients/provisioning_client.rb
61
65
  - lib/lockstep_sdk/clients/reports_client.rb
62
66
  - lib/lockstep_sdk/clients/status_client.rb
63
67
  - lib/lockstep_sdk/clients/sync_client.rb
68
+ - lib/lockstep_sdk/clients/transactions_client.rb
69
+ - lib/lockstep_sdk/clients/transcriptions_client.rb
64
70
  - lib/lockstep_sdk/clients/user_accounts_client.rb
65
71
  - lib/lockstep_sdk/clients/user_roles_client.rb
66
72
  - lib/lockstep_sdk/clients/webhook_rules_client.rb
67
73
  - lib/lockstep_sdk/clients/webhooks_client.rb
68
74
  - lib/lockstep_sdk/lockstep_api.rb
75
+ - lib/lockstep_sdk/models/accounting_profile_contact_model.rb
76
+ - lib/lockstep_sdk/models/accounting_profile_model.rb
69
77
  - lib/lockstep_sdk/models/action_result_model.rb
70
- - lib/lockstep_sdk/models/activity_model.rb
71
- - lib/lockstep_sdk/models/activity_stream_item_model.rb
72
- - lib/lockstep_sdk/models/activity_xref_model.rb
73
78
  - lib/lockstep_sdk/models/aging_model.rb
74
79
  - lib/lockstep_sdk/models/ap_aging_header_info_model.rb
75
80
  - lib/lockstep_sdk/models/ap_header_info_model.rb
76
81
  - lib/lockstep_sdk/models/api_key_model.rb
77
82
  - lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb
78
83
  - lib/lockstep_sdk/models/app_enrollment_model.rb
79
- - lib/lockstep_sdk/models/app_enrollment_reconnect_request.rb
84
+ - lib/lockstep_sdk/models/app_enrollment_reconnect_info.rb
80
85
  - lib/lockstep_sdk/models/application_model.rb
81
86
  - lib/lockstep_sdk/models/ar_aging_header_info_model.rb
82
87
  - lib/lockstep_sdk/models/ar_header_info_model.rb
@@ -85,6 +90,7 @@ files:
85
90
  - lib/lockstep_sdk/models/attachment_model.rb
86
91
  - lib/lockstep_sdk/models/batch_sync_model.rb
87
92
  - lib/lockstep_sdk/models/bulk_currency_conversion_model.rb
93
+ - lib/lockstep_sdk/models/bulk_delete_request_model.rb
88
94
  - lib/lockstep_sdk/models/cashflow_report_model.rb
89
95
  - lib/lockstep_sdk/models/code_definition_model.rb
90
96
  - lib/lockstep_sdk/models/company_details_model.rb
@@ -106,12 +112,14 @@ files:
106
112
  - lib/lockstep_sdk/models/customer_summary_model.rb
107
113
  - lib/lockstep_sdk/models/daily_payable_outstanding_report_model.rb
108
114
  - lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb
115
+ - lib/lockstep_sdk/models/delete_result.rb
109
116
  - lib/lockstep_sdk/models/developer_account_submit_model.rb
110
117
  - lib/lockstep_sdk/models/dpo_summary_group_total_model.rb
111
118
  - lib/lockstep_sdk/models/dpo_summary_model.rb
112
- - lib/lockstep_sdk/models/email_model.rb
113
119
  - lib/lockstep_sdk/models/erp_model.rb
114
120
  - lib/lockstep_sdk/models/error_result.rb
121
+ - lib/lockstep_sdk/models/feature_flags_request_model.rb
122
+ - lib/lockstep_sdk/models/feature_flags_response_model.rb
115
123
  - lib/lockstep_sdk/models/financial_account_balance_history_model.rb
116
124
  - lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb
117
125
  - lib/lockstep_sdk/models/financial_account_model.rb
@@ -132,8 +140,12 @@ files:
132
140
  - lib/lockstep_sdk/models/invoice_model.rb
133
141
  - lib/lockstep_sdk/models/invoice_payment_detail_model.rb
134
142
  - lib/lockstep_sdk/models/invoice_summary_model.rb
143
+ - lib/lockstep_sdk/models/invoice_summary_model_invoice_summary_totals_model_summary_fetch_result.rb
144
+ - lib/lockstep_sdk/models/invoice_summary_totals_model.rb
135
145
  - lib/lockstep_sdk/models/invoice_sync_model.rb
136
146
  - lib/lockstep_sdk/models/lead_model.rb
147
+ - lib/lockstep_sdk/models/magic_link_model.rb
148
+ - lib/lockstep_sdk/models/magic_link_status_model.rb
137
149
  - lib/lockstep_sdk/models/note_model.rb
138
150
  - lib/lockstep_sdk/models/payables_coming_due_header_model.rb
139
151
  - lib/lockstep_sdk/models/payables_coming_due_model.rb
@@ -145,21 +157,33 @@ files:
145
157
  - lib/lockstep_sdk/models/payment_detail_model.rb
146
158
  - lib/lockstep_sdk/models/payment_model.rb
147
159
  - lib/lockstep_sdk/models/payment_summary_model.rb
160
+ - lib/lockstep_sdk/models/payment_summary_model_payment_summary_totals_model_summary_fetch_result.rb
161
+ - lib/lockstep_sdk/models/payment_summary_totals_model.rb
148
162
  - lib/lockstep_sdk/models/payment_sync_model.rb
149
163
  - lib/lockstep_sdk/models/public_company_profile_model.rb
150
164
  - lib/lockstep_sdk/models/risk_rate_model.rb
151
165
  - lib/lockstep_sdk/models/state_model.rb
152
166
  - lib/lockstep_sdk/models/status_model.rb
167
+ - lib/lockstep_sdk/models/summary_aging_totals_model.rb
153
168
  - lib/lockstep_sdk/models/sync_entity_result_model.rb
154
169
  - lib/lockstep_sdk/models/sync_request_model.rb
155
170
  - lib/lockstep_sdk/models/sync_submit_model.rb
171
+ - lib/lockstep_sdk/models/transaction_detail_model.rb
172
+ - lib/lockstep_sdk/models/transaction_model.rb
173
+ - lib/lockstep_sdk/models/transaction_model_transaction_summary_total_model_summary_fetch_result.rb
174
+ - lib/lockstep_sdk/models/transaction_summary_total_model.rb
175
+ - lib/lockstep_sdk/models/transcription_request_submit.rb
176
+ - lib/lockstep_sdk/models/transcription_validation_request.rb
177
+ - lib/lockstep_sdk/models/transcription_validation_request_item.rb
156
178
  - lib/lockstep_sdk/models/transfer_owner_model.rb
157
179
  - lib/lockstep_sdk/models/transfer_owner_submit_model.rb
158
180
  - lib/lockstep_sdk/models/uri_model.rb
159
181
  - lib/lockstep_sdk/models/user_account_model.rb
182
+ - lib/lockstep_sdk/models/user_data_response_model.rb
160
183
  - lib/lockstep_sdk/models/user_group_model.rb
161
184
  - lib/lockstep_sdk/models/user_role_model.rb
162
185
  - lib/lockstep_sdk/models/vendor_summary_model.rb
186
+ - lib/lockstep_sdk/models/view_box_settings_model.rb
163
187
  - lib/lockstep_sdk/models/webhook_history_table_storage_model.rb
164
188
  - lib/lockstep_sdk/models/webhook_model.rb
165
189
  - lib/lockstep_sdk/models/webhook_rule_model.rb
@@ -1,116 +0,0 @@
1
- #
2
- # Lockstep Platform SDK for Ruby
3
- #
4
- # (c) 2021-2022 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-2022 Lockstep, Inc.
11
- # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
- #
13
-
14
-
15
- require 'awrence'
16
-
17
- class ActivitiesClient
18
-
19
- ##
20
- # Initialize the ActivitiesClient class with an API client instance.
21
- # @param connection [LockstepApi] The API client object for this connection
22
- def initialize(connection)
23
- @connection = connection
24
- end
25
-
26
-
27
- ##
28
- # Retrieves the Activity specified by this unique identifier, optionally including nested data sets.
29
- #
30
- # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
31
- #
32
- # @param id [uuid] The unique Lockstep Platform ID number of this Activity
33
- # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Company, Attachments, CustomFields, Notes, References, and UserAssignedToName
34
- def retrieve_activity(id:, include_param:)
35
- path = "/api/v1/Activities/#{id}"
36
- params = {:include => include_param}
37
- @connection.request(:get, path, nil, params)
38
- end
39
-
40
- ##
41
- # Updates an activity that matches the specified id with the requested information.
42
- #
43
- # The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
44
- #
45
- # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
46
- #
47
- # @param id [uuid] The unique Lockstep Platform ID number of the Activity to update
48
- # @param body [object] A list of changes to apply to this Activity
49
- def update_activity(id:, body:)
50
- path = "/api/v1/Activities/#{id}"
51
- @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
52
- end
53
-
54
- ##
55
- # Delete the Activity referred to by this unique identifier.
56
- #
57
- # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
58
- #
59
- # @param id [uuid] The unique Lockstep Platform ID number of the Activity to delete
60
- def delete_activity(id:)
61
- path = "/api/v1/Activities/#{id}"
62
- @connection.request(:delete, path, nil, nil)
63
- end
64
-
65
- ##
66
- # Creates one or more activities from a given model.
67
- #
68
- # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
69
- #
70
- # @param body [ActivityModel] The Activities to create
71
- def create_activities(body:)
72
- path = "/api/v1/Activities"
73
- @connection.request(:post, path, body, nil)
74
- end
75
-
76
- ##
77
- # Queries Activities for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
78
- #
79
- # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
80
- #
81
- # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
82
- #
83
- # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
84
- # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Company, Attachments, CustomFields, Notes, References, and UserAssignedToName
85
- # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
86
- # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
87
- # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
88
- def query_activities(filter:, include_param:, order:, page_size:, page_number:)
89
- path = "/api/v1/Activities/query"
90
- params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
91
- @connection.request(:get, path, nil, params)
92
- end
93
-
94
- ##
95
- # Retrieves a list of items representing the activity stream for the supplied activity id.
96
- #
97
- # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
98
- #
99
- # @param id [uuid] The unique Lockstep Platform ID number of this Activity
100
- def retrieve_activity_stream(id:)
101
- path = "/api/v1/Activities/#{id}/stream"
102
- @connection.request(:get, path, nil, nil)
103
- end
104
-
105
- ##
106
- # Forwards an activity by creating a new activity with all child references and assigning the new activity to a new user.
107
- #
108
- # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
109
- #
110
- # @param activity_id [uuid]
111
- # @param user_id [uuid]
112
- def forward_activity(activity_id:, user_id:)
113
- path = "/api/v1/Activities/#{activityId}/forward/#{userId}"
114
- @connection.request(:post, path, nil, nil)
115
- end
116
- end