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 AttachmentsClient
20
18
 
21
19
  ##
22
- # Initialize the AttachmentsClient 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 AttachmentsClient 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 AttachmentsClient
38
36
  def retrieve_attachment(id:, include_param:)
39
37
  path = "/api/v1/Attachments/#{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
  ##
@@ -54,7 +52,7 @@ class AttachmentsClient
54
52
  # @param body [object] A list of changes to apply to this Attachment
55
53
  def update_attachment(id:, body:)
56
54
  path = "/api/v1/Attachments/#{id}"
57
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
55
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
58
56
  end
59
57
 
60
58
  ##
@@ -67,7 +65,7 @@ class AttachmentsClient
67
65
  # @param id [uuid] The unique ID number of the Attachment to be archived
68
66
  def archive_attachment(id:)
69
67
  path = "/api/v1/Attachments/#{id}"
70
- @lockstepsdk.request(:delete, path, nil, nil)
68
+ @connection.request(:delete, path, nil, nil)
71
69
  end
72
70
 
73
71
  ##
@@ -80,7 +78,7 @@ class AttachmentsClient
80
78
  # @param id [uuid] The unique ID number of the Attachment whose URI will be returned
81
79
  def download_attachment_url(id:)
82
80
  path = "/api/v1/Attachments/#{id}/download-url"
83
- @lockstepsdk.request(:get, path, nil, nil)
81
+ @connection.request(:get, path, nil, nil)
84
82
  end
85
83
 
86
84
  ##
@@ -93,7 +91,7 @@ class AttachmentsClient
93
91
  # @param id [uuid] The unique ID number of the Attachment whose URI will be returned
94
92
  def download_attachment_file(id:)
95
93
  path = "/api/v1/Attachments/#{id}/download-file"
96
- @lockstepsdk.request(:get, path, nil, nil)
94
+ @connection.request(:get, path, nil, nil)
97
95
  end
98
96
 
99
97
  ##
@@ -110,7 +108,7 @@ class AttachmentsClient
110
108
  def upload_attachment(table_name:, object_id:, attachment_type:, filename:)
111
109
  path = "/api/v1/Attachments"
112
110
  params = {:tableName => table_name, :objectId => object_id, :attachmentType => attachment_type}
113
- @lockstepsdk.request(:post, path, nil, params)
111
+ @connection.request(:post, path, nil, params)
114
112
  end
115
113
 
116
114
  ##
@@ -130,6 +128,6 @@ class AttachmentsClient
130
128
  def query_attachments(filter:, include_param:, order:, page_size:, page_number:)
131
129
  path = "/api/v1/Attachments/query"
132
130
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
133
- @lockstepsdk.request(:get, path, nil, params)
131
+ @connection.request(:get, path, nil, params)
134
132
  end
135
133
  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 CodeDefinitionsClient
20
18
 
21
19
  ##
22
- # Initialize the CodeDefinitionsClient 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 CodeDefinitionsClient 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 CodeDefinitionsClient
36
34
  def retrieve_codedefinition(id:, include_param:)
37
35
  path = "/api/v1/CodeDefinitions/#{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
  ##
@@ -54,6 +52,6 @@ class CodeDefinitionsClient
54
52
  def query_codedefinitions(filter:, include_param:, order:, page_size:, page_number:)
55
53
  path = "/api/v1/CodeDefinitions/query"
56
54
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
57
- @lockstepsdk.request(:get, path, nil, params)
55
+ @connection.request(:get, path, nil, params)
58
56
  end
59
57
  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 CompaniesClient
20
18
 
21
19
  ##
22
- # Initialize the CompaniesClient 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 CompaniesClient 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 CompaniesClient
38
36
  def retrieve_company(id:, include_param:)
39
37
  path = "/api/v1/Companies/#{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
  ##
@@ -54,7 +52,7 @@ class CompaniesClient
54
52
  # @param body [object] A list of changes to apply to this Company
55
53
  def update_company(id:, body:)
56
54
  path = "/api/v1/Companies/#{id}"
57
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
55
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
58
56
  end
59
57
 
60
58
  ##
@@ -67,7 +65,7 @@ class CompaniesClient
67
65
  # @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
68
66
  def disable_company(id:)
69
67
  path = "/api/v1/Companies/#{id}"
70
- @lockstepsdk.request(:delete, path, nil, nil)
68
+ @connection.request(:delete, path, nil, nil)
71
69
  end
72
70
 
73
71
  ##
@@ -80,7 +78,7 @@ class CompaniesClient
80
78
  # @param body [CompanyModel] The Companies to create
81
79
  def create_companies(body:)
82
80
  path = "/api/v1/Companies"
83
- @lockstepsdk.request(:post, path, body, nil)
81
+ @connection.request(:post, path, body, nil)
84
82
  end
85
83
 
86
84
  ##
@@ -100,7 +98,7 @@ class CompaniesClient
100
98
  def query_companies(filter:, include_param:, order:, page_size:, page_number:)
101
99
  path = "/api/v1/Companies/query"
102
100
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
103
- @lockstepsdk.request(:get, path, nil, params)
101
+ @connection.request(:get, path, nil, params)
104
102
  end
105
103
 
106
104
  ##
@@ -120,7 +118,7 @@ class CompaniesClient
120
118
  def query_customer_summary(filter:, include_param:, order:, page_size:, page_number:)
121
119
  path = "/api/v1/Companies/views/customer-summary"
122
120
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
123
- @lockstepsdk.request(:get, path, nil, params)
121
+ @connection.request(:get, path, nil, params)
124
122
  end
125
123
 
126
124
  ##
@@ -133,6 +131,6 @@ class CompaniesClient
133
131
  # @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
134
132
  def retrieve_customer_detail(id:)
135
133
  path = "/api/v1/Companies/views/customer-details/#{id}"
136
- @lockstepsdk.request(:get, path, nil, nil)
134
+ @connection.request(:get, path, nil, nil)
137
135
  end
138
136
  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 ContactsClient
20
18
 
21
19
  ##
22
- # Initialize the ContactsClient 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 ContactsClient 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 ContactsClient
36
34
  def retrieve_contact(id:, include_param:)
37
35
  path = "/api/v1/Contacts/#{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 ContactsClient
50
48
  # @param body [object] A list of changes to apply to this Contact
51
49
  def update_contact(id:, body:)
52
50
  path = "/api/v1/Contacts/#{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 ContactsClient
61
59
  # @param id [uuid] The unique Lockstep Platform ID number of the Contact to disable; NOT the customer's ERP key
62
60
  def disable_contact(id:)
63
61
  path = "/api/v1/Contacts/#{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 ContactsClient
72
70
  # @param body [ContactModel] The Contacts to create
73
71
  def create_contacts(body:)
74
72
  path = "/api/v1/Contacts"
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 ContactsClient
90
88
  def query_contacts(filter:, include_param:, order:, page_size:, page_number:)
91
89
  path = "/api/v1/Contacts/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
@@ -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 CreditMemoAppliedClient
20
18
 
21
19
  ##
22
- # Initialize the CreditMemoAppliedClient 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 CreditMemoAppliedClient 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 CreditMemoAppliedClient
36
34
  def retrieve_credit_memo_application(id:, include_param:)
37
35
  path = "/api/v1/CreditMemoApplied/#{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 CreditMemoAppliedClient
50
48
  # @param body [object] A list of changes to apply to this Credit Memo Application
51
49
  def update_credit_memo_application(id:, body:)
52
50
  path = "/api/v1/CreditMemoApplied/#{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 CreditMemoAppliedClient
61
59
  # @param id [uuid] The unique Lockstep Platform ID number of the Credit Memo Application to delete; NOT the customer's ERP key
62
60
  def delete_credit_memo_application(id:)
63
61
  path = "/api/v1/CreditMemoApplied/#{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 CreditMemoAppliedClient
72
70
  # @param body [CreditMemoAppliedModel] The Credit Memo Applications to create
73
71
  def create_credit_memo_applications(body:)
74
72
  path = "/api/v1/CreditMemoApplied"
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 CreditMemoAppliedClient
90
88
  def query_credit_memo_applications(filter:, include_param:, order:, page_size:, page_number:)
91
89
  path = "/api/v1/CreditMemoApplied/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
@@ -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 CurrenciesClient
20
18
 
21
19
  ##
22
- # Initialize the CurrenciesClient 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 CurrenciesClient 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 CurrenciesClient
38
36
  def retrieve_currency_rate(source_currency:, destination_currency:, date:, data_provider:)
39
37
  path = "/api/v1/Currencies/#{sourceCurrency}/#{destinationCurrency}"
40
38
  params = {:date => date, :dataProvider => data_provider}
41
- @lockstepsdk.request(:get, path, nil, params)
39
+ @connection.request(:get, path, nil, params)
42
40
  end
43
41
 
44
42
  ##
@@ -49,6 +47,6 @@ class CurrenciesClient
49
47
  def bulk_currency_data(destination_currency:, body:)
50
48
  path = "/api/v1/Currencies/bulk"
51
49
  params = {:destinationCurrency => destination_currency}
52
- @lockstepsdk.request(:post, path, body, params)
50
+ @connection.request(:post, path, body, params)
53
51
  end
54
52
  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 CustomFieldDefinitionsClient
20
18
 
21
19
  ##
22
- # Initialize the CustomFieldDefinitionsClient 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 CustomFieldDefinitionsClient 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 CustomFieldDefinitionsClient
38
36
  def retrieve_field_definition(id:, include_param:)
39
37
  path = "/api/v1/CustomFieldDefinitions/#{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
  ##
@@ -54,7 +52,7 @@ class CustomFieldDefinitionsClient
54
52
  # @param body [object] A list of changes to apply to this Custom Field Definition
55
53
  def update_field_definition(id:, body:)
56
54
  path = "/api/v1/CustomFieldDefinitions/#{id}"
57
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
55
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
58
56
  end
59
57
 
60
58
  ##
@@ -67,7 +65,7 @@ class CustomFieldDefinitionsClient
67
65
  # @param id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition to delete
68
66
  def delete_field_definition(id:)
69
67
  path = "/api/v1/CustomFieldDefinitions/#{id}"
70
- @lockstepsdk.request(:delete, path, nil, nil)
68
+ @connection.request(:delete, path, nil, nil)
71
69
  end
72
70
 
73
71
  ##
@@ -80,7 +78,7 @@ class CustomFieldDefinitionsClient
80
78
  # @param body [CustomFieldDefinitionModel] The Custom Field Definitions to create
81
79
  def create_field_definitions(body:)
82
80
  path = "/api/v1/CustomFieldDefinitions"
83
- @lockstepsdk.request(:post, path, body, nil)
81
+ @connection.request(:post, path, body, nil)
84
82
  end
85
83
 
86
84
  ##
@@ -100,6 +98,6 @@ class CustomFieldDefinitionsClient
100
98
  def query_field_definitions(filter:, include_param:, order:, page_size:, page_number:)
101
99
  path = "/api/v1/CustomFieldDefinitions/query"
102
100
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
103
- @lockstepsdk.request(:get, path, nil, params)
101
+ @connection.request(:get, path, nil, params)
104
102
  end
105
103
  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 CustomFieldValuesClient
20
18
 
21
19
  ##
22
- # Initialize the CustomFieldValuesClient 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 CustomFieldValuesClient 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
 
@@ -39,7 +37,7 @@ class CustomFieldValuesClient
39
37
  def retrieve_field(definition_id:, record_key:, include_param:)
40
38
  path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
41
39
  params = {:include => include_param}
42
- @lockstepsdk.request(:get, path, nil, params)
40
+ @connection.request(:get, path, nil, params)
43
41
  end
44
42
 
45
43
  ##
@@ -56,7 +54,7 @@ class CustomFieldValuesClient
56
54
  # @param body [object] A list of changes to apply to this Custom Field
57
55
  def update_field(definition_id:, record_key:, body:)
58
56
  path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
59
- @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
57
+ @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
60
58
  end
61
59
 
62
60
  ##
@@ -70,7 +68,7 @@ class CustomFieldValuesClient
70
68
  # @param record_key [uuid] The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.
71
69
  def delete_field(definition_id:, record_key:)
72
70
  path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
73
- @lockstepsdk.request(:delete, path, nil, nil)
71
+ @connection.request(:delete, path, nil, nil)
74
72
  end
75
73
 
76
74
  ##
@@ -83,7 +81,7 @@ class CustomFieldValuesClient
83
81
  # @param body [CustomFieldValueModel] The Custom Fields to create
84
82
  def create_fields(body:)
85
83
  path = "/api/v1/CustomFieldValues"
86
- @lockstepsdk.request(:post, path, body, nil)
84
+ @connection.request(:post, path, body, nil)
87
85
  end
88
86
 
89
87
  ##
@@ -103,6 +101,6 @@ class CustomFieldValuesClient
103
101
  def query_fields(filter:, include_param:, order:, page_size:, page_number:)
104
102
  path = "/api/v1/CustomFieldValues/query"
105
103
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
106
- @lockstepsdk.request(:get, path, nil, params)
104
+ @connection.request(:get, path, nil, params)
107
105
  end
108
106
  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 DefinitionsClient
20
18
 
21
19
  ##
22
- # Initialize the DefinitionsClient 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 DefinitionsClient 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
 
@@ -41,7 +39,7 @@ class DefinitionsClient
41
39
  def query_countries(filter:, include_param:, order:, page_size:, page_number:)
42
40
  path = "/api/v1/Definitions/countries"
43
41
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
44
- @lockstepsdk.request(:get, path, nil, params)
42
+ @connection.request(:get, path, nil, params)
45
43
  end
46
44
 
47
45
  ##
@@ -59,7 +57,7 @@ class DefinitionsClient
59
57
  def query_currencies(filter:, include_param:, order:, page_size:, page_number:)
60
58
  path = "/api/v1/Definitions/currencies"
61
59
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
62
- @lockstepsdk.request(:get, path, nil, params)
60
+ @connection.request(:get, path, nil, params)
63
61
  end
64
62
 
65
63
  ##
@@ -77,7 +75,7 @@ class DefinitionsClient
77
75
  def query_states(filter:, include_param:, order:, page_size:, page_number:)
78
76
  path = "/api/v1/Definitions/states"
79
77
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
80
- @lockstepsdk.request(:get, path, nil, params)
78
+ @connection.request(:get, path, nil, params)
81
79
  end
82
80
 
83
81
  ##
@@ -95,6 +93,6 @@ class DefinitionsClient
95
93
  def query_financial_systems(filter:, include_param:, order:, page_size:, page_number:)
96
94
  path = "/api/v1/Definitions/financialsystems"
97
95
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
98
- @lockstepsdk.request(:get, path, nil, params)
96
+ @connection.request(:get, path, nil, params)
99
97
  end
100
98
  end