lockstep_sdk 2022.13.29.0 → 2022.14.30.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 (115) hide show
  1. checksums.yaml +4 -4
  2. data/lib/LockstepSdk/lockstep_api.rb +287 -0
  3. data/lib/lockstep_sdk/clients/activities_client.rb +13 -15
  4. data/lib/lockstep_sdk/clients/api_keys_client.rb +10 -12
  5. data/lib/lockstep_sdk/clients/app_enrollments_client.rb +12 -14
  6. data/lib/lockstep_sdk/clients/applications_client.rb +11 -13
  7. data/lib/lockstep_sdk/clients/attachments_client.rb +13 -15
  8. data/lib/lockstep_sdk/clients/code_definitions_client.rb +8 -10
  9. data/lib/lockstep_sdk/clients/companies_client.rb +13 -15
  10. data/lib/lockstep_sdk/clients/contacts_client.rb +11 -13
  11. data/lib/lockstep_sdk/clients/credit_memo_applied_client.rb +11 -13
  12. data/lib/lockstep_sdk/clients/currencies_client.rb +8 -10
  13. data/lib/lockstep_sdk/clients/custom_field_definitions_client.rb +11 -13
  14. data/lib/lockstep_sdk/clients/custom_field_values_client.rb +11 -13
  15. data/lib/lockstep_sdk/clients/definitions_client.rb +10 -12
  16. data/lib/lockstep_sdk/clients/emails_client.rb +12 -14
  17. data/lib/lockstep_sdk/clients/financial_account_balance_history_client.rb +11 -13
  18. data/lib/lockstep_sdk/clients/financial_account_client.rb +11 -13
  19. data/lib/lockstep_sdk/clients/financial_year_settings_client.rb +11 -13
  20. data/lib/lockstep_sdk/clients/invoice_history_client.rb +8 -10
  21. data/lib/lockstep_sdk/clients/invoices_client.rb +14 -16
  22. data/lib/lockstep_sdk/clients/leads_client.rb +7 -9
  23. data/lib/lockstep_sdk/clients/notes_client.rb +10 -12
  24. data/lib/lockstep_sdk/clients/payment_applications_client.rb +11 -13
  25. data/lib/lockstep_sdk/clients/payments_client.rb +15 -17
  26. data/lib/lockstep_sdk/clients/provisioning_client.rb +9 -11
  27. data/lib/lockstep_sdk/clients/reports_client.rb +31 -17
  28. data/lib/lockstep_sdk/clients/status_client.rb +8 -10
  29. data/lib/lockstep_sdk/clients/sync_client.rb +13 -15
  30. data/lib/lockstep_sdk/clients/user_accounts_client.rb +14 -16
  31. data/lib/lockstep_sdk/clients/user_roles_client.rb +8 -10
  32. data/lib/lockstep_sdk/clients/webhooks_client.rb +13 -15
  33. data/lib/lockstep_sdk/lockstep_api.rb +9 -10
  34. data/lib/lockstep_sdk/models/activity_model.rb +2 -4
  35. data/lib/lockstep_sdk/models/activity_stream_item_model.rb +2 -4
  36. data/lib/lockstep_sdk/models/activity_xref_model.rb +2 -4
  37. data/lib/lockstep_sdk/models/aging_model.rb +2 -4
  38. data/lib/lockstep_sdk/models/api_key_model.rb +2 -4
  39. data/lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb +2 -4
  40. data/lib/lockstep_sdk/models/app_enrollment_model.rb +2 -4
  41. data/lib/lockstep_sdk/models/application_model.rb +2 -4
  42. data/lib/lockstep_sdk/models/ar_aging_header_info_model.rb +2 -4
  43. data/lib/lockstep_sdk/models/ar_header_info_model.rb +2 -4
  44. data/lib/lockstep_sdk/models/at_risk_invoice_summary_model.rb +2 -4
  45. data/lib/lockstep_sdk/models/attachment_header_info_model.rb +2 -4
  46. data/lib/lockstep_sdk/models/attachment_model.rb +2 -4
  47. data/lib/lockstep_sdk/models/batch_sync_model.rb +2 -4
  48. data/lib/lockstep_sdk/models/bulk_currency_conversion_model.rb +2 -4
  49. data/lib/lockstep_sdk/models/cashflow_report_model.rb +2 -4
  50. data/lib/lockstep_sdk/models/code_definition_model.rb +2 -4
  51. data/lib/lockstep_sdk/models/company_model.rb +2 -4
  52. data/lib/lockstep_sdk/models/company_sync_model.rb +2 -4
  53. data/lib/lockstep_sdk/models/connector_info_model.rb +2 -4
  54. data/lib/lockstep_sdk/models/contact_model.rb +2 -4
  55. data/lib/lockstep_sdk/models/contact_sync_model.rb +2 -4
  56. data/lib/lockstep_sdk/models/country_model.rb +2 -4
  57. data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +2 -4
  58. data/lib/lockstep_sdk/models/credit_memo_applied_sync_model.rb +2 -4
  59. data/lib/lockstep_sdk/models/credit_memo_invoice_model.rb +2 -4
  60. data/lib/lockstep_sdk/models/currency_model.rb +2 -4
  61. data/lib/lockstep_sdk/models/currency_rate_model.rb +2 -4
  62. data/lib/lockstep_sdk/models/custom_field_definition_model.rb +2 -4
  63. data/lib/lockstep_sdk/models/custom_field_sync_model.rb +2 -4
  64. data/lib/lockstep_sdk/models/custom_field_value_model.rb +2 -4
  65. data/lib/lockstep_sdk/models/customer_details_model.rb +2 -4
  66. data/lib/lockstep_sdk/models/customer_details_payment_model.rb +2 -4
  67. data/lib/lockstep_sdk/models/customer_summary_model.rb +2 -4
  68. data/lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb +2 -4
  69. data/lib/lockstep_sdk/models/developer_account_submit_model.rb +2 -4
  70. data/lib/lockstep_sdk/models/email_model.rb +2 -4
  71. data/lib/lockstep_sdk/models/erp_info_model.rb +2 -4
  72. data/lib/lockstep_sdk/models/erp_model.rb +2 -4
  73. data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb +2 -4
  74. data/lib/lockstep_sdk/models/financial_account_model.rb +2 -4
  75. data/lib/lockstep_sdk/models/financial_report_cell_model.rb +2 -4
  76. data/lib/lockstep_sdk/models/financial_report_model.rb +2 -4
  77. data/lib/lockstep_sdk/models/financial_report_row_model.rb +2 -4
  78. data/lib/lockstep_sdk/models/financial_year_setting_model.rb +2 -4
  79. data/lib/lockstep_sdk/models/invite_data_model.rb +2 -4
  80. data/lib/lockstep_sdk/models/invite_model.rb +2 -4
  81. data/lib/lockstep_sdk/models/invite_submit_model.rb +2 -4
  82. data/lib/lockstep_sdk/models/invoice_address_model.rb +2 -4
  83. data/lib/lockstep_sdk/models/invoice_history_model.rb +2 -4
  84. data/lib/lockstep_sdk/models/invoice_line_model.rb +2 -4
  85. data/lib/lockstep_sdk/models/invoice_line_sync_model.rb +2 -4
  86. data/lib/lockstep_sdk/models/invoice_model.rb +2 -4
  87. data/lib/lockstep_sdk/models/invoice_payment_detail_model.rb +2 -4
  88. data/lib/lockstep_sdk/models/invoice_summary_model.rb +2 -4
  89. data/lib/lockstep_sdk/models/invoice_sync_model.rb +2 -4
  90. data/lib/lockstep_sdk/models/lead_model.rb +2 -4
  91. data/lib/lockstep_sdk/models/note_model.rb +2 -4
  92. data/lib/lockstep_sdk/models/payment_applied_model.rb +2 -4
  93. data/lib/lockstep_sdk/models/payment_applied_sync_model.rb +2 -4
  94. data/lib/lockstep_sdk/models/payment_detail_header_model.rb +2 -4
  95. data/lib/lockstep_sdk/models/payment_detail_model.rb +2 -4
  96. data/lib/lockstep_sdk/models/payment_model.rb +2 -4
  97. data/lib/lockstep_sdk/models/payment_summary_model.rb +2 -4
  98. data/lib/lockstep_sdk/models/payment_sync_model.rb +2 -4
  99. data/lib/lockstep_sdk/models/provisioning_finalize_request_model.rb +2 -4
  100. data/lib/lockstep_sdk/models/provisioning_model.rb +2 -4
  101. data/lib/lockstep_sdk/models/provisioning_response_model.rb +2 -4
  102. data/lib/lockstep_sdk/models/risk_rate_model.rb +2 -4
  103. data/lib/lockstep_sdk/models/state_model.rb +2 -4
  104. data/lib/lockstep_sdk/models/status_model.rb +2 -4
  105. data/lib/lockstep_sdk/models/sync_entity_result_model.rb +2 -4
  106. data/lib/lockstep_sdk/models/sync_request_model.rb +2 -4
  107. data/lib/lockstep_sdk/models/sync_submit_model.rb +2 -4
  108. data/lib/lockstep_sdk/models/transfer_owner_model.rb +2 -4
  109. data/lib/lockstep_sdk/models/transfer_owner_submit_model.rb +2 -4
  110. data/lib/lockstep_sdk/models/uri_model.rb +2 -4
  111. data/lib/lockstep_sdk/models/user_account_model.rb +2 -4
  112. data/lib/lockstep_sdk/models/user_role_model.rb +2 -4
  113. data/lib/lockstep_sdk/models/webhook_history_table_storage_model.rb +2 -4
  114. data/lib/lockstep_sdk/models/webhook_model.rb +2 -4
  115. metadata +3 -2
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class EmailsClient
20
18
 
21
19
  ##
22
- # Initialize the EmailsClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the EmailsClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -36,7 +34,7 @@ class EmailsClient
36
34
  def retrieve_email(id:, include_param:)
37
35
  path = "/api/v1/Emails/#{id}"
38
36
  params = {:include => include_param}
39
- @lockstepsdk.request(:get, path, nil, params)
37
+ @connection.request(:get, path, nil, params)
40
38
  end
41
39
 
42
40
  ##
@@ -50,7 +48,7 @@ class EmailsClient
50
48
  # @param body [object] A list of changes to apply to this Email
51
49
  def update_email(id:, body:)
52
50
  path = "/api/v1/Emails/#{id}"
53
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
51
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
54
52
  end
55
53
 
56
54
  ##
@@ -61,7 +59,7 @@ class EmailsClient
61
59
  # @param id [uuid] The unique Lockstep Platform ID number of the Email to delete
62
60
  def delete_email(id:)
63
61
  path = "/api/v1/Emails/#{id}"
64
- @lockstepsdk.request(:delete, path, nil, nil)
62
+ @connection.request(:delete, path, nil, nil)
65
63
  end
66
64
 
67
65
  ##
@@ -73,7 +71,7 @@ class EmailsClient
73
71
  # @param nonce [uuid] The random nonce applied at time of url creation.
74
72
  def retrieve_email_logo(email_id:, nonce:)
75
73
  path = "/api/v1/Emails/#{emailId}/logo/#{nonce}"
76
- @lockstepsdk.request(:get, path, nil, nil)
74
+ @connection.request(:get, path, nil, nil)
77
75
  end
78
76
 
79
77
  ##
@@ -84,7 +82,7 @@ class EmailsClient
84
82
  # @param body [EmailModel] The array of emails to be created
85
83
  def create_emails(body:)
86
84
  path = "/api/v1/Emails"
87
- @lockstepsdk.request(:post, path, body, nil)
85
+ @connection.request(:post, path, body, nil)
88
86
  end
89
87
 
90
88
  ##
@@ -102,6 +100,6 @@ class EmailsClient
102
100
  def query_emails(filter:, include_param:, order:, page_size:, page_number:)
103
101
  path = "/api/v1/Emails/query"
104
102
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
105
- @lockstepsdk.request(:get, path, nil, params)
103
+ @connection.request(:get, path, nil, params)
106
104
  end
107
105
  end
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class FinancialAccountBalanceHistoryClient
20
18
 
21
19
  ##
22
- # Initialize the FinancialAccountBalanceHistoryClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the FinancialAccountBalanceHistoryClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -34,7 +32,7 @@ class FinancialAccountBalanceHistoryClient
34
32
  # @param id [uuid] The unique Lockstep Platform ID number of this Financial Account Balance History
35
33
  def retrieve_balance_history(id:)
36
34
  path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
37
- @lockstepsdk.request(:get, path, nil, nil)
35
+ @connection.request(:get, path, nil, nil)
38
36
  end
39
37
 
40
38
  ##
@@ -48,7 +46,7 @@ class FinancialAccountBalanceHistoryClient
48
46
  # @param body [object] A list of changes to apply to this Financial Account Balance History
49
47
  def update_balance_history(id:, body:)
50
48
  path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
51
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
49
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
52
50
  end
53
51
 
54
52
  ##
@@ -59,7 +57,7 @@ class FinancialAccountBalanceHistoryClient
59
57
  # @param id [uuid] The unique Lockstep Platform ID number of the Financial Account Balance History to disable
60
58
  def delete_balance_history(id:)
61
59
  path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
62
- @lockstepsdk.request(:delete, path, nil, nil)
60
+ @connection.request(:delete, path, nil, nil)
63
61
  end
64
62
 
65
63
  ##
@@ -70,7 +68,7 @@ class FinancialAccountBalanceHistoryClient
70
68
  # @param body [FinancialAccountBalanceHistoryModel] The Financial Account Balance Histories to create
71
69
  def create_balance_history(body:)
72
70
  path = "/api/v1/FinancialAccountBalanceHistory"
73
- @lockstepsdk.request(:post, path, body, nil)
71
+ @connection.request(:post, path, body, nil)
74
72
  end
75
73
 
76
74
  ##
@@ -87,6 +85,6 @@ class FinancialAccountBalanceHistoryClient
87
85
  def query_balance_history(filter:, order:, page_size:, page_number:)
88
86
  path = "/api/v1/FinancialAccountBalanceHistory/query"
89
87
  params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
90
- @lockstepsdk.request(:get, path, nil, params)
88
+ @connection.request(:get, path, nil, params)
91
89
  end
92
90
  end
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class FinancialAccountClient
20
18
 
21
19
  ##
22
- # Initialize the FinancialAccountClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the FinancialAccountClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -32,7 +30,7 @@ class FinancialAccountClient
32
30
  # @param body [FinancialAccountModel] Metadata about the financial account to create.
33
31
  def create_financial_account(body:)
34
32
  path = "/api/v1/FinancialAccount"
35
- @lockstepsdk.request(:post, path, body, nil)
33
+ @connection.request(:post, path, body, nil)
36
34
  end
37
35
 
38
36
  ##
@@ -41,7 +39,7 @@ class FinancialAccountClient
41
39
  # @param id [uuid] The unique Lockstep Platform ID number of this Account; NOT the customer's ERP key
42
40
  def retrieve_financial_account(id:)
43
41
  path = "/api/v1/FinancialAccount/#{id}"
44
- @lockstepsdk.request(:get, path, nil, nil)
42
+ @connection.request(:get, path, nil, nil)
45
43
  end
46
44
 
47
45
  ##
@@ -51,7 +49,7 @@ class FinancialAccountClient
51
49
  # @param body [object] A list of changes to apply to this Account
52
50
  def update_financial_account(id:, body:)
53
51
  path = "/api/v1/FinancialAccount/#{id}"
54
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
52
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
55
53
  end
56
54
 
57
55
  ##
@@ -60,7 +58,7 @@ class FinancialAccountClient
60
58
  # @param id [uuid] The unique Lockstep Platform ID number of the Financial Account to disable; NOT the customer's ERP key
61
59
  def deletes_financial_account(id:)
62
60
  path = "/api/v1/FinancialAccount/#{id}"
63
- @lockstepsdk.request(:delete, path, nil, nil)
61
+ @connection.request(:delete, path, nil, nil)
64
62
  end
65
63
 
66
64
  ##
@@ -74,6 +72,6 @@ class FinancialAccountClient
74
72
  def query_financial_accounts(filter:, include_param:, order:, page_size:, page_number:)
75
73
  path = "/api/v1/FinancialAccount/query"
76
74
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
77
- @lockstepsdk.request(:get, path, nil, params)
75
+ @connection.request(:get, path, nil, params)
78
76
  end
79
77
  end
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class FinancialYearSettingsClient
20
18
 
21
19
  ##
22
- # Initialize the FinancialYearSettingsClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the FinancialYearSettingsClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -34,7 +32,7 @@ class FinancialYearSettingsClient
34
32
  # @param id [uuid] The unique Lockstep Platform ID number of this Financial Year Setting
35
33
  def retrieve_financial_year_setting(id:)
36
34
  path = "/api/v1/FinancialYearSettings/#{id}"
37
- @lockstepsdk.request(:get, path, nil, nil)
35
+ @connection.request(:get, path, nil, nil)
38
36
  end
39
37
 
40
38
  ##
@@ -48,7 +46,7 @@ class FinancialYearSettingsClient
48
46
  # @param body [object] A list of changes to apply to this Financial Year Setting
49
47
  def update_financial_year_setting(id:, body:)
50
48
  path = "/api/v1/FinancialYearSettings/#{id}"
51
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
49
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
52
50
  end
53
51
 
54
52
  ##
@@ -59,7 +57,7 @@ class FinancialYearSettingsClient
59
57
  # @param id [uuid] The unique Lockstep Platform ID number of the Financial Year Setting to disable
60
58
  def delete_financial_year_setting(id:)
61
59
  path = "/api/v1/FinancialYearSettings/#{id}"
62
- @lockstepsdk.request(:delete, path, nil, nil)
60
+ @connection.request(:delete, path, nil, nil)
63
61
  end
64
62
 
65
63
  ##
@@ -70,7 +68,7 @@ class FinancialYearSettingsClient
70
68
  # @param body [FinancialYearSettingModel] The Financial Year Setting to create
71
69
  def create_financial_year_setting(body:)
72
70
  path = "/api/v1/FinancialYearSettings"
73
- @lockstepsdk.request(:post, path, body, nil)
71
+ @connection.request(:post, path, body, nil)
74
72
  end
75
73
 
76
74
  ##
@@ -87,6 +85,6 @@ class FinancialYearSettingsClient
87
85
  def query_financial_year_settings(filter:, order:, page_size:, page_number:)
88
86
  path = "/api/v1/FinancialYearSettings/query"
89
87
  params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
90
- @lockstepsdk.request(:get, path, nil, params)
88
+ @connection.request(:get, path, nil, params)
91
89
  end
92
90
  end
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class InvoiceHistoryClient
20
18
 
21
19
  ##
22
- # Initialize the InvoiceHistoryClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the InvoiceHistoryClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -34,7 +32,7 @@ class InvoiceHistoryClient
34
32
  # @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
35
33
  def retrieve_invoice_history(id:)
36
34
  path = "/api/v1/InvoiceHistory/#{id}"
37
- @lockstepsdk.request(:get, path, nil, nil)
35
+ @connection.request(:get, path, nil, nil)
38
36
  end
39
37
 
40
38
  ##
@@ -50,6 +48,6 @@ class InvoiceHistoryClient
50
48
  def query_invoice_history(filter:, include_param:, order:, page_size:, page_number:)
51
49
  path = "/api/v1/InvoiceHistory/query"
52
50
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
53
- @lockstepsdk.request(:get, path, nil, params)
51
+ @connection.request(:get, path, nil, params)
54
52
  end
55
53
  end
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class InvoicesClient
20
18
 
21
19
  ##
22
- # Initialize the InvoicesClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the InvoicesClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -36,7 +34,7 @@ class InvoicesClient
36
34
  def retrieve_invoice(id:, include_param:)
37
35
  path = "/api/v1/Invoices/#{id}"
38
36
  params = {:include => include_param}
39
- @lockstepsdk.request(:get, path, nil, params)
37
+ @connection.request(:get, path, nil, params)
40
38
  end
41
39
 
42
40
  ##
@@ -50,7 +48,7 @@ class InvoicesClient
50
48
  # @param body [object] A list of changes to apply to this Invoice
51
49
  def update_invoice(id:, body:)
52
50
  path = "/api/v1/Invoices/#{id}"
53
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
51
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
54
52
  end
55
53
 
56
54
  ##
@@ -59,7 +57,7 @@ class InvoicesClient
59
57
  # @param id [uuid] The unique Lockstep Platform ID number of the invoice to delete; NOT the customer's ERP key
60
58
  def delete_invoice(id:)
61
59
  path = "/api/v1/Invoices/#{id}"
62
- @lockstepsdk.request(:delete, path, nil, nil)
60
+ @connection.request(:delete, path, nil, nil)
63
61
  end
64
62
 
65
63
  ##
@@ -70,7 +68,7 @@ class InvoicesClient
70
68
  # @param body [InvoiceModel] The Invoices to create
71
69
  def create_invoices(body:)
72
70
  path = "/api/v1/Invoices"
73
- @lockstepsdk.request(:post, path, body, nil)
71
+ @connection.request(:post, path, body, nil)
74
72
  end
75
73
 
76
74
  ##
@@ -88,7 +86,7 @@ class InvoicesClient
88
86
  def query_invoices(filter:, include_param:, order:, page_size:, page_number:)
89
87
  path = "/api/v1/Invoices/query"
90
88
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
91
- @lockstepsdk.request(:get, path, nil, params)
89
+ @connection.request(:get, path, nil, params)
92
90
  end
93
91
 
94
92
  ##
@@ -101,7 +99,7 @@ class InvoicesClient
101
99
  # @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
102
100
  def retrieve_invoice_pdf(id:)
103
101
  path = "/api/v1/Invoices/#{id}/pdf"
104
- @lockstepsdk.request(:get, path, nil, nil)
102
+ @connection.request(:get, path, nil, nil)
105
103
  end
106
104
 
107
105
  ##
@@ -119,7 +117,7 @@ class InvoicesClient
119
117
  def query_invoice_summary_view(filter:, include_param:, order:, page_size:, page_number:)
120
118
  path = "/api/v1/Invoices/views/summary"
121
119
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
122
- @lockstepsdk.request(:get, path, nil, params)
120
+ @connection.request(:get, path, nil, params)
123
121
  end
124
122
 
125
123
  ##
@@ -137,6 +135,6 @@ class InvoicesClient
137
135
  def query_at_risk_view(filter:, include_param:, order:, page_size:, page_number:)
138
136
  path = "/api/v1/Invoices/views/at-risk-summary"
139
137
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
140
- @lockstepsdk.request(:get, path, nil, params)
138
+ @connection.request(:get, path, nil, params)
141
139
  end
142
140
  end
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class LeadsClient
20
18
 
21
19
  ##
22
- # Initialize the LeadsClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the LeadsClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -34,6 +32,6 @@ class LeadsClient
34
32
  # @param body [LeadModel] The Leads to create
35
33
  def create_leads(body:)
36
34
  path = "/api/v1/Leads"
37
- @lockstepsdk.request(:post, path, body, nil)
35
+ @connection.request(:post, path, body, nil)
38
36
  end
39
37
  end
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class NotesClient
20
18
 
21
19
  ##
22
- # Initialize the NotesClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the NotesClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -38,7 +36,7 @@ class NotesClient
38
36
  def retrieve_note(id:, include_param:)
39
37
  path = "/api/v1/Notes/#{id}"
40
38
  params = {:include => include_param}
41
- @lockstepsdk.request(:get, path, nil, params)
39
+ @connection.request(:get, path, nil, params)
42
40
  end
43
41
 
44
42
  ##
@@ -51,7 +49,7 @@ class NotesClient
51
49
  # @param id [uuid] Note id to be archived
52
50
  def archive_note(id:)
53
51
  path = "/api/v1/Notes/#{id}"
54
- @lockstepsdk.request(:delete, path, nil, nil)
52
+ @connection.request(:delete, path, nil, nil)
55
53
  end
56
54
 
57
55
  ##
@@ -64,7 +62,7 @@ class NotesClient
64
62
  # @param body [NoteModel] The array of notes to be created
65
63
  def create_notes(body:)
66
64
  path = "/api/v1/Notes"
67
- @lockstepsdk.request(:post, path, body, nil)
65
+ @connection.request(:post, path, body, nil)
68
66
  end
69
67
 
70
68
  ##
@@ -84,6 +82,6 @@ class NotesClient
84
82
  def query_notes(filter:, include_param:, order:, page_size:, page_number:)
85
83
  path = "/api/v1/Notes/query"
86
84
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
87
- @lockstepsdk.request(:get, path, nil, params)
85
+ @connection.request(:get, path, nil, params)
88
86
  end
89
87
  end
@@ -1,14 +1,12 @@
1
1
  #
2
- # Lockstep Software Development Kit for Ruby
2
+ # Lockstep Platform SDK for Ruby
3
3
  #
4
4
  # (c) 2021-2022 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
- # @author Ted Spence <tspence@lockstep.io>
10
- # @author Manish Narayan B S <manish.n@lockstep.io>
11
- # @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
9
+ # @author Lockstep Network <support@lockstep.io>
12
10
  # @copyright 2021-2022 Lockstep, Inc.
13
11
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
12
  #
@@ -19,10 +17,10 @@ require 'awrence'
19
17
  class PaymentApplicationsClient
20
18
 
21
19
  ##
22
- # Initialize the PaymentApplicationsClient class with a lockstepsdk instance.
23
- # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
24
- def initialize(lockstepsdk)
25
- @lockstepsdk = lockstepsdk
20
+ # Initialize the PaymentApplicationsClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
26
24
  end
27
25
 
28
26
 
@@ -36,7 +34,7 @@ class PaymentApplicationsClient
36
34
  def retrieve_payment_application(id:, include_param:)
37
35
  path = "/api/v1/PaymentApplications/#{id}"
38
36
  params = {:include => include_param}
39
- @lockstepsdk.request(:get, path, nil, params)
37
+ @connection.request(:get, path, nil, params)
40
38
  end
41
39
 
42
40
  ##
@@ -50,7 +48,7 @@ class PaymentApplicationsClient
50
48
  # @param body [object] A list of changes to apply to this Payment Application
51
49
  def update_payment_application(id:, body:)
52
50
  path = "/api/v1/PaymentApplications/#{id}"
53
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
51
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
54
52
  end
55
53
 
56
54
  ##
@@ -61,7 +59,7 @@ class PaymentApplicationsClient
61
59
  # @param id [uuid] The unique Lockstep Platform ID number of the Payment Application to delete; NOT the customer's ERP key
62
60
  def delete_payment_application(id:)
63
61
  path = "/api/v1/PaymentApplications/#{id}"
64
- @lockstepsdk.request(:delete, path, nil, nil)
62
+ @connection.request(:delete, path, nil, nil)
65
63
  end
66
64
 
67
65
  ##
@@ -72,7 +70,7 @@ class PaymentApplicationsClient
72
70
  # @param body [PaymentAppliedModel] The Payment Applications to create
73
71
  def create_payment_applications(body:)
74
72
  path = "/api/v1/PaymentApplications"
75
- @lockstepsdk.request(:post, path, body, nil)
73
+ @connection.request(:post, path, body, nil)
76
74
  end
77
75
 
78
76
  ##
@@ -90,6 +88,6 @@ class PaymentApplicationsClient
90
88
  def query_payment_applications(filter:, include_param:, order:, page_size:, page_number:)
91
89
  path = "/api/v1/PaymentApplications/query"
92
90
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
93
- @lockstepsdk.request(:get, path, nil, params)
91
+ @connection.request(:get, path, nil, params)
94
92
  end
95
93
  end