appnigma-sdk 0.2.1 → 1.0.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 (69) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/README.md +90 -69
  4. data/lib/appnigma/client.rb +21 -28
  5. data/lib/appnigma/constants.rb +1 -0
  6. data/lib/appnigma/crm.rb +63 -6
  7. data/lib/appnigma/errors.rb +15 -0
  8. data/lib/appnigma/generated/api/default_api.rb +523 -61
  9. data/lib/appnigma/generated/api_client.rb +1 -1
  10. data/lib/appnigma/generated/api_error.rb +1 -1
  11. data/lib/appnigma/generated/api_model_base.rb +1 -1
  12. data/lib/appnigma/generated/configuration.rb +1 -1
  13. data/lib/appnigma/generated/models/action_entry.rb +341 -0
  14. data/lib/appnigma/generated/models/connection_status.rb +1 -1
  15. data/lib/appnigma/generated/models/create_connection_link_input.rb +1 -1
  16. data/lib/appnigma/generated/models/create_connection_link_output.rb +2 -2
  17. data/lib/appnigma/generated/models/crm_company.rb +1 -1
  18. data/lib/appnigma/generated/models/crm_company_get_output.rb +1 -1
  19. data/lib/appnigma/generated/models/crm_company_list_output.rb +1 -1
  20. data/lib/appnigma/generated/models/{post_output.rb → crm_company_write_output.rb} +20 -46
  21. data/lib/appnigma/generated/models/crm_contact.rb +1 -1
  22. data/lib/appnigma/generated/models/crm_contact_get_output.rb +1 -1
  23. data/lib/appnigma/generated/models/crm_contact_list_output.rb +1 -1
  24. data/lib/appnigma/generated/models/crm_contact_write_output.rb +177 -0
  25. data/lib/appnigma/generated/models/crm_create_input.rb +256 -0
  26. data/lib/appnigma/generated/models/crm_custom_field.rb +1 -1
  27. data/lib/appnigma/generated/models/crm_deal.rb +1 -1
  28. data/lib/appnigma/generated/models/{post_input.rb → crm_deal_create_input.rb} +48 -81
  29. data/lib/appnigma/generated/models/crm_deal_get_output.rb +1 -1
  30. data/lib/appnigma/generated/models/crm_deal_list_output.rb +1 -1
  31. data/lib/appnigma/generated/models/crm_deal_write_output.rb +177 -0
  32. data/lib/appnigma/generated/models/crm_email.rb +1 -1
  33. data/lib/appnigma/generated/models/crm_get_input.rb +1 -1
  34. data/lib/appnigma/generated/models/crm_labelled.rb +1 -1
  35. data/lib/appnigma/generated/models/crm_list_input.rb +1 -1
  36. data/lib/appnigma/generated/models/crm_phone.rb +1 -1
  37. data/lib/appnigma/generated/models/{pull_input.rb → crm_update_input.rb} +66 -100
  38. data/lib/appnigma/generated/models/function_entry.rb +1 -1
  39. data/lib/appnigma/generated/models/function_owner.rb +1 -1
  40. data/lib/appnigma/generated/models/function_owner_one_of.rb +1 -1
  41. data/lib/appnigma/generated/models/function_owner_one_of1.rb +1 -1
  42. data/lib/appnigma/generated/models/get_connection_output.rb +1 -1
  43. data/lib/appnigma/generated/models/get_guide_output.rb +1 -1
  44. data/lib/appnigma/generated/models/json_value.rb +1 -1
  45. data/lib/appnigma/generated/models/{pull_output_records_inner.rb → list_actions_output.rb} +21 -47
  46. data/lib/appnigma/generated/models/list_functions_output.rb +1 -1
  47. data/lib/appnigma/generated/models/list_platforms_output.rb +179 -0
  48. data/lib/appnigma/generated/models/platform_entry.rb +269 -0
  49. data/lib/appnigma/generated/models/platform_entry_coverage_inner.rb +219 -0
  50. data/lib/appnigma/generated/models/platform_request_input.rb +1 -1
  51. data/lib/appnigma/generated/models/platform_request_input_body.rb +1 -1
  52. data/lib/appnigma/generated/models/platform_request_output.rb +1 -1
  53. data/lib/appnigma/generated/models/ran_as.rb +4 -6
  54. data/lib/appnigma/generated/models/run_action_input.rb +277 -0
  55. data/lib/appnigma/generated/models/{pull_output.rb → run_action_output.rb} +21 -34
  56. data/lib/appnigma/generated/models/run_input.rb +3 -3
  57. data/lib/appnigma/generated/models/run_output.rb +1 -1
  58. data/lib/appnigma/generated/models/sdk_error.rb +1 -1
  59. data/lib/appnigma/generated/models/sdk_error_error.rb +3 -3
  60. data/lib/appnigma/generated/models/sdk_error_error_details.rb +32 -3
  61. data/lib/appnigma/generated/models/sdk_problem.rb +1 -1
  62. data/lib/appnigma/generated/version.rb +1 -1
  63. data/lib/appnigma/generated.rb +14 -7
  64. data/lib/appnigma/names.rb +9 -0
  65. data/lib/appnigma/platforms.rb +18 -0
  66. data/lib/appnigma/retry.rb +3 -3
  67. data/lib/appnigma/version.rb +2 -2
  68. metadata +15 -7
  69. data/lib/appnigma/generated/models/post_input_record_value.rb +0 -104
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The routes a customer's product calls through an Appnigma SDK. Every answer carries a request id in X-Request-Id; quote it when you write to support.
5
5
 
6
- The version of the OpenAPI document: 2.0.0
6
+ The version of the OpenAPI document: 3.0.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.26.0
@@ -87,6 +87,210 @@ module Appnigma::Generated
87
87
  return data, status_code, headers
88
88
  end
89
89
 
90
+ # Create one of the companies in one shape
91
+ # Creates one of an end customer's companies in the same shape whichever CRM they use. One that already has the same domain is updated instead of made twice.
92
+ # @param crm_create_input [CrmCreateInput]
93
+ # @param [Hash] opts the optional parameters
94
+ # @return [CrmCompanyWriteOutput]
95
+ def create_crm_company(crm_create_input, opts = {})
96
+ data, _status_code, _headers = create_crm_company_with_http_info(crm_create_input, opts)
97
+ data
98
+ end
99
+
100
+ # Create one of the companies in one shape
101
+ # Creates one of an end customer's companies in the same shape whichever CRM they use. One that already has the same domain is updated instead of made twice.
102
+ # @param crm_create_input [CrmCreateInput]
103
+ # @param [Hash] opts the optional parameters
104
+ # @return [Array<(CrmCompanyWriteOutput, Integer, Hash)>] CrmCompanyWriteOutput data, response status code and response headers
105
+ def create_crm_company_with_http_info(crm_create_input, opts = {})
106
+ if @api_client.config.debugging
107
+ @api_client.config.logger.debug 'Calling API: DefaultApi.create_crm_company ...'
108
+ end
109
+ # verify the required parameter 'crm_create_input' is set
110
+ if @api_client.config.client_side_validation && crm_create_input.nil?
111
+ fail ArgumentError, "Missing the required parameter 'crm_create_input' when calling DefaultApi.create_crm_company"
112
+ end
113
+ # resource path
114
+ local_var_path = '/sdk/v1/crm/companies/create'
115
+
116
+ # query parameters
117
+ query_params = opts[:query_params] || {}
118
+
119
+ # header parameters
120
+ header_params = opts[:header_params] || {}
121
+ # HTTP header 'Accept' (if needed)
122
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
123
+ # HTTP header 'Content-Type'
124
+ content_type = @api_client.select_header_content_type(['application/json'])
125
+ if !content_type.nil?
126
+ header_params['Content-Type'] = content_type
127
+ end
128
+
129
+ # form parameters
130
+ form_params = opts[:form_params] || {}
131
+
132
+ # http body (model)
133
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(crm_create_input)
134
+
135
+ # return_type
136
+ return_type = opts[:debug_return_type] || 'CrmCompanyWriteOutput'
137
+
138
+ # auth_names
139
+ auth_names = opts[:debug_auth_names] || ['SdkKey']
140
+
141
+ new_options = opts.merge(
142
+ :operation => :"DefaultApi.create_crm_company",
143
+ :header_params => header_params,
144
+ :query_params => query_params,
145
+ :form_params => form_params,
146
+ :body => post_body,
147
+ :auth_names => auth_names,
148
+ :return_type => return_type
149
+ )
150
+
151
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
152
+ if @api_client.config.debugging
153
+ @api_client.config.logger.debug "API called: DefaultApi#create_crm_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
+ end
155
+ return data, status_code, headers
156
+ end
157
+
158
+ # Create one of the contacts in one shape
159
+ # Creates one of an end customer's contacts in the same shape whichever CRM they use. One that already has the same email is updated instead of made twice.
160
+ # @param crm_create_input [CrmCreateInput]
161
+ # @param [Hash] opts the optional parameters
162
+ # @return [CrmContactWriteOutput]
163
+ def create_crm_contact(crm_create_input, opts = {})
164
+ data, _status_code, _headers = create_crm_contact_with_http_info(crm_create_input, opts)
165
+ data
166
+ end
167
+
168
+ # Create one of the contacts in one shape
169
+ # Creates one of an end customer&#39;s contacts in the same shape whichever CRM they use. One that already has the same email is updated instead of made twice.
170
+ # @param crm_create_input [CrmCreateInput]
171
+ # @param [Hash] opts the optional parameters
172
+ # @return [Array<(CrmContactWriteOutput, Integer, Hash)>] CrmContactWriteOutput data, response status code and response headers
173
+ def create_crm_contact_with_http_info(crm_create_input, opts = {})
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug 'Calling API: DefaultApi.create_crm_contact ...'
176
+ end
177
+ # verify the required parameter 'crm_create_input' is set
178
+ if @api_client.config.client_side_validation && crm_create_input.nil?
179
+ fail ArgumentError, "Missing the required parameter 'crm_create_input' when calling DefaultApi.create_crm_contact"
180
+ end
181
+ # resource path
182
+ local_var_path = '/sdk/v1/crm/contacts/create'
183
+
184
+ # query parameters
185
+ query_params = opts[:query_params] || {}
186
+
187
+ # header parameters
188
+ header_params = opts[:header_params] || {}
189
+ # HTTP header 'Accept' (if needed)
190
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
191
+ # HTTP header 'Content-Type'
192
+ content_type = @api_client.select_header_content_type(['application/json'])
193
+ if !content_type.nil?
194
+ header_params['Content-Type'] = content_type
195
+ end
196
+
197
+ # form parameters
198
+ form_params = opts[:form_params] || {}
199
+
200
+ # http body (model)
201
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(crm_create_input)
202
+
203
+ # return_type
204
+ return_type = opts[:debug_return_type] || 'CrmContactWriteOutput'
205
+
206
+ # auth_names
207
+ auth_names = opts[:debug_auth_names] || ['SdkKey']
208
+
209
+ new_options = opts.merge(
210
+ :operation => :"DefaultApi.create_crm_contact",
211
+ :header_params => header_params,
212
+ :query_params => query_params,
213
+ :form_params => form_params,
214
+ :body => post_body,
215
+ :auth_names => auth_names,
216
+ :return_type => return_type
217
+ )
218
+
219
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
220
+ if @api_client.config.debugging
221
+ @api_client.config.logger.debug "API called: DefaultApi#create_crm_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
222
+ end
223
+ return data, status_code, headers
224
+ end
225
+
226
+ # Create one of the deals in one shape
227
+ # Creates a deal in the end customer's CRM, in the same shape whichever CRM they use. A deal has no field every CRM keeps unique, so it matches on a key of your own, such as your invoice id: the same matchKey updates the same deal.
228
+ # @param crm_deal_create_input [CrmDealCreateInput]
229
+ # @param [Hash] opts the optional parameters
230
+ # @return [CrmDealWriteOutput]
231
+ def create_crm_deal(crm_deal_create_input, opts = {})
232
+ data, _status_code, _headers = create_crm_deal_with_http_info(crm_deal_create_input, opts)
233
+ data
234
+ end
235
+
236
+ # Create one of the deals in one shape
237
+ # Creates a deal in the end customer&#39;s CRM, in the same shape whichever CRM they use. A deal has no field every CRM keeps unique, so it matches on a key of your own, such as your invoice id: the same matchKey updates the same deal.
238
+ # @param crm_deal_create_input [CrmDealCreateInput]
239
+ # @param [Hash] opts the optional parameters
240
+ # @return [Array<(CrmDealWriteOutput, Integer, Hash)>] CrmDealWriteOutput data, response status code and response headers
241
+ def create_crm_deal_with_http_info(crm_deal_create_input, opts = {})
242
+ if @api_client.config.debugging
243
+ @api_client.config.logger.debug 'Calling API: DefaultApi.create_crm_deal ...'
244
+ end
245
+ # verify the required parameter 'crm_deal_create_input' is set
246
+ if @api_client.config.client_side_validation && crm_deal_create_input.nil?
247
+ fail ArgumentError, "Missing the required parameter 'crm_deal_create_input' when calling DefaultApi.create_crm_deal"
248
+ end
249
+ # resource path
250
+ local_var_path = '/sdk/v1/crm/deals/create'
251
+
252
+ # query parameters
253
+ query_params = opts[:query_params] || {}
254
+
255
+ # header parameters
256
+ header_params = opts[:header_params] || {}
257
+ # HTTP header 'Accept' (if needed)
258
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
259
+ # HTTP header 'Content-Type'
260
+ content_type = @api_client.select_header_content_type(['application/json'])
261
+ if !content_type.nil?
262
+ header_params['Content-Type'] = content_type
263
+ end
264
+
265
+ # form parameters
266
+ form_params = opts[:form_params] || {}
267
+
268
+ # http body (model)
269
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(crm_deal_create_input)
270
+
271
+ # return_type
272
+ return_type = opts[:debug_return_type] || 'CrmDealWriteOutput'
273
+
274
+ # auth_names
275
+ auth_names = opts[:debug_auth_names] || ['SdkKey']
276
+
277
+ new_options = opts.merge(
278
+ :operation => :"DefaultApi.create_crm_deal",
279
+ :header_params => header_params,
280
+ :query_params => query_params,
281
+ :form_params => form_params,
282
+ :body => post_body,
283
+ :auth_names => auth_names,
284
+ :return_type => return_type
285
+ )
286
+
287
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
288
+ if @api_client.config.debugging
289
+ @api_client.config.logger.debug "API called: DefaultApi#create_crm_deal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
290
+ end
291
+ return data, status_code, headers
292
+ end
293
+
90
294
  # Read whether an end customer is connected
91
295
  # The connection of one end customer on one platform. The connection is written before the end customer lands on returnUrl, so the answer is already there. An end customer the API has never seen on that platform is a 404, not a disconnected status.
92
296
  # @param end_customer_id [String] Your own id for the end customer.
@@ -428,6 +632,71 @@ module Appnigma::Generated
428
632
  return data, status_code, headers
429
633
  end
430
634
 
635
+ # List the ready-made actions
636
+ # Every ready-made action on the platforms switched on for your company, with what each takes, answers and needs from the connection. platform narrows the list to one platform.
637
+ # @param [Hash] opts the optional parameters
638
+ # @option opts [String] :platform Narrows the list to one platform.
639
+ # @return [ListActionsOutput]
640
+ def list_actions(opts = {})
641
+ data, _status_code, _headers = list_actions_with_http_info(opts)
642
+ data
643
+ end
644
+
645
+ # List the ready-made actions
646
+ # Every ready-made action on the platforms switched on for your company, with what each takes, answers and needs from the connection. platform narrows the list to one platform.
647
+ # @param [Hash] opts the optional parameters
648
+ # @option opts [String] :platform Narrows the list to one platform.
649
+ # @return [Array<(ListActionsOutput, Integer, Hash)>] ListActionsOutput data, response status code and response headers
650
+ def list_actions_with_http_info(opts = {})
651
+ if @api_client.config.debugging
652
+ @api_client.config.logger.debug 'Calling API: DefaultApi.list_actions ...'
653
+ end
654
+ pattern = Regexp.new(/^[a-z0-9]+(?:-[a-z0-9]+)*$/)
655
+ if @api_client.config.client_side_validation && !opts[:'platform'].nil? && opts[:'platform'] !~ pattern
656
+ fail ArgumentError, "invalid value for 'opts[:\"platform\"]' when calling DefaultApi.list_actions, must conform to the pattern #{pattern}."
657
+ end
658
+
659
+ # resource path
660
+ local_var_path = '/sdk/v1/actions'
661
+
662
+ # query parameters
663
+ query_params = opts[:query_params] || {}
664
+ query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
665
+
666
+ # header parameters
667
+ header_params = opts[:header_params] || {}
668
+ # HTTP header 'Accept' (if needed)
669
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
670
+
671
+ # form parameters
672
+ form_params = opts[:form_params] || {}
673
+
674
+ # http body (model)
675
+ post_body = opts[:debug_body]
676
+
677
+ # return_type
678
+ return_type = opts[:debug_return_type] || 'ListActionsOutput'
679
+
680
+ # auth_names
681
+ auth_names = opts[:debug_auth_names] || ['SdkKey']
682
+
683
+ new_options = opts.merge(
684
+ :operation => :"DefaultApi.list_actions",
685
+ :header_params => header_params,
686
+ :query_params => query_params,
687
+ :form_params => form_params,
688
+ :body => post_body,
689
+ :auth_names => auth_names,
690
+ :return_type => return_type
691
+ )
692
+
693
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
694
+ if @api_client.config.debugging
695
+ @api_client.config.logger.debug "API called: DefaultApi#list_actions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
696
+ end
697
+ return data, status_code, headers
698
+ end
699
+
431
700
  # List companies in one shape
432
701
  # One page of an end customer's companies, in the same shape whichever CRM they use. Pass next as cursor for the following page.
433
702
  # @param crm_list_input [CrmListInput]
@@ -697,6 +966,63 @@ module Appnigma::Generated
697
966
  return data, status_code, headers
698
967
  end
699
968
 
969
+ # List the platforms switched on for you
970
+ # Every platform switched on for your company, and what we offer on it: supported (an adapter, so crm.* answers in the shared shapes for what coverage lists), experimental (no adapter: only request() and run, with no support promise), or unknown (we could not check just now; try again shortly). Takes no values; a query value is refused.
971
+ # @param [Hash] opts the optional parameters
972
+ # @return [ListPlatformsOutput]
973
+ def list_platforms(opts = {})
974
+ data, _status_code, _headers = list_platforms_with_http_info(opts)
975
+ data
976
+ end
977
+
978
+ # List the platforms switched on for you
979
+ # Every platform switched on for your company, and what we offer on it: supported (an adapter, so crm.* answers in the shared shapes for what coverage lists), experimental (no adapter: only request() and run, with no support promise), or unknown (we could not check just now; try again shortly). Takes no values; a query value is refused.
980
+ # @param [Hash] opts the optional parameters
981
+ # @return [Array<(ListPlatformsOutput, Integer, Hash)>] ListPlatformsOutput data, response status code and response headers
982
+ def list_platforms_with_http_info(opts = {})
983
+ if @api_client.config.debugging
984
+ @api_client.config.logger.debug 'Calling API: DefaultApi.list_platforms ...'
985
+ end
986
+ # resource path
987
+ local_var_path = '/sdk/v1/platforms'
988
+
989
+ # query parameters
990
+ query_params = opts[:query_params] || {}
991
+
992
+ # header parameters
993
+ header_params = opts[:header_params] || {}
994
+ # HTTP header 'Accept' (if needed)
995
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
996
+
997
+ # form parameters
998
+ form_params = opts[:form_params] || {}
999
+
1000
+ # http body (model)
1001
+ post_body = opts[:debug_body]
1002
+
1003
+ # return_type
1004
+ return_type = opts[:debug_return_type] || 'ListPlatformsOutput'
1005
+
1006
+ # auth_names
1007
+ auth_names = opts[:debug_auth_names] || ['SdkKey']
1008
+
1009
+ new_options = opts.merge(
1010
+ :operation => :"DefaultApi.list_platforms",
1011
+ :header_params => header_params,
1012
+ :query_params => query_params,
1013
+ :form_params => form_params,
1014
+ :body => post_body,
1015
+ :auth_names => auth_names,
1016
+ :return_type => return_type
1017
+ )
1018
+
1019
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1020
+ if @api_client.config.debugging
1021
+ @api_client.config.logger.debug "API called: DefaultApi#list_platforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1022
+ end
1023
+ return data, status_code, headers
1024
+ end
1025
+
700
1026
  # Call anything else on the end customer's platform
701
1027
  # Sends one call to the platform's own API with the end customer's login, and answers as the platform answered, refusals included. A GET reads; any other method may change the platform.
702
1028
  # @param platform_request_input [PlatformRequestInput]
@@ -765,31 +1091,31 @@ module Appnigma::Generated
765
1091
  return data, status_code, headers
766
1092
  end
767
1093
 
768
- # Create or update a record
769
- # Creates a record in the end customer's HubSpot, or updates the one that already matches on uniqueBy (email for a contact unless you name another property). A repeated call is safe: it is an update when the record exists.
770
- # @param post_input [PostInput]
1094
+ # Run a ready-made action
1095
+ # Runs one ready-made action, by platform and name, on the end customer's account. The input is checked against the action's input schema; an input it refuses is INVALID_INPUT with the problems named.
1096
+ # @param run_action_input [RunActionInput]
771
1097
  # @param [Hash] opts the optional parameters
772
- # @return [PostOutput]
773
- def post_record(post_input, opts = {})
774
- data, _status_code, _headers = post_record_with_http_info(post_input, opts)
1098
+ # @return [RunActionOutput]
1099
+ def run_action(run_action_input, opts = {})
1100
+ data, _status_code, _headers = run_action_with_http_info(run_action_input, opts)
775
1101
  data
776
1102
  end
777
1103
 
778
- # Create or update a record
779
- # Creates a record in the end customer&#39;s HubSpot, or updates the one that already matches on uniqueBy (email for a contact unless you name another property). A repeated call is safe: it is an update when the record exists.
780
- # @param post_input [PostInput]
1104
+ # Run a ready-made action
1105
+ # Runs one ready-made action, by platform and name, on the end customer&#39;s account. The input is checked against the action&#39;s input schema; an input it refuses is INVALID_INPUT with the problems named.
1106
+ # @param run_action_input [RunActionInput]
781
1107
  # @param [Hash] opts the optional parameters
782
- # @return [Array<(PostOutput, Integer, Hash)>] PostOutput data, response status code and response headers
783
- def post_record_with_http_info(post_input, opts = {})
1108
+ # @return [Array<(RunActionOutput, Integer, Hash)>] RunActionOutput data, response status code and response headers
1109
+ def run_action_with_http_info(run_action_input, opts = {})
784
1110
  if @api_client.config.debugging
785
- @api_client.config.logger.debug 'Calling API: DefaultApi.post_record ...'
1111
+ @api_client.config.logger.debug 'Calling API: DefaultApi.run_action ...'
786
1112
  end
787
- # verify the required parameter 'post_input' is set
788
- if @api_client.config.client_side_validation && post_input.nil?
789
- fail ArgumentError, "Missing the required parameter 'post_input' when calling DefaultApi.post_record"
1113
+ # verify the required parameter 'run_action_input' is set
1114
+ if @api_client.config.client_side_validation && run_action_input.nil?
1115
+ fail ArgumentError, "Missing the required parameter 'run_action_input' when calling DefaultApi.run_action"
790
1116
  end
791
1117
  # resource path
792
- local_var_path = '/sdk/v1/post'
1118
+ local_var_path = '/sdk/v1/actions/run'
793
1119
 
794
1120
  # query parameters
795
1121
  query_params = opts[:query_params] || {}
@@ -808,16 +1134,16 @@ module Appnigma::Generated
808
1134
  form_params = opts[:form_params] || {}
809
1135
 
810
1136
  # http body (model)
811
- post_body = opts[:debug_body] || @api_client.object_to_http_body(post_input)
1137
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(run_action_input)
812
1138
 
813
1139
  # return_type
814
- return_type = opts[:debug_return_type] || 'PostOutput'
1140
+ return_type = opts[:debug_return_type] || 'RunActionOutput'
815
1141
 
816
1142
  # auth_names
817
1143
  auth_names = opts[:debug_auth_names] || ['SdkKey']
818
1144
 
819
1145
  new_options = opts.merge(
820
- :operation => :"DefaultApi.post_record",
1146
+ :operation => :"DefaultApi.run_action",
821
1147
  :header_params => header_params,
822
1148
  :query_params => query_params,
823
1149
  :form_params => form_params,
@@ -828,36 +1154,36 @@ module Appnigma::Generated
828
1154
 
829
1155
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
830
1156
  if @api_client.config.debugging
831
- @api_client.config.logger.debug "API called: DefaultApi#post_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1157
+ @api_client.config.logger.debug "API called: DefaultApi#run_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
832
1158
  end
833
1159
  return data, status_code, headers
834
1160
  end
835
1161
 
836
- # Read records, one page at a time
837
- # One page of records from the end customer's HubSpot and a marker for the next page. next is null on the last page.
838
- # @param pull_input [PullInput]
1162
+ # Run one of your own functions
1163
+ # Runs one of your functions, by platform and name, on the end customer's account. The input is checked against the shape the function declared.
1164
+ # @param run_input [RunInput]
839
1165
  # @param [Hash] opts the optional parameters
840
- # @return [PullOutput]
841
- def pull_records(pull_input, opts = {})
842
- data, _status_code, _headers = pull_records_with_http_info(pull_input, opts)
1166
+ # @return [RunOutput]
1167
+ def run_function(run_input, opts = {})
1168
+ data, _status_code, _headers = run_function_with_http_info(run_input, opts)
843
1169
  data
844
1170
  end
845
1171
 
846
- # Read records, one page at a time
847
- # One page of records from the end customer&#39;s HubSpot and a marker for the next page. next is null on the last page.
848
- # @param pull_input [PullInput]
1172
+ # Run one of your own functions
1173
+ # Runs one of your functions, by platform and name, on the end customer&#39;s account. The input is checked against the shape the function declared.
1174
+ # @param run_input [RunInput]
849
1175
  # @param [Hash] opts the optional parameters
850
- # @return [Array<(PullOutput, Integer, Hash)>] PullOutput data, response status code and response headers
851
- def pull_records_with_http_info(pull_input, opts = {})
1176
+ # @return [Array<(RunOutput, Integer, Hash)>] RunOutput data, response status code and response headers
1177
+ def run_function_with_http_info(run_input, opts = {})
852
1178
  if @api_client.config.debugging
853
- @api_client.config.logger.debug 'Calling API: DefaultApi.pull_records ...'
1179
+ @api_client.config.logger.debug 'Calling API: DefaultApi.run_function ...'
854
1180
  end
855
- # verify the required parameter 'pull_input' is set
856
- if @api_client.config.client_side_validation && pull_input.nil?
857
- fail ArgumentError, "Missing the required parameter 'pull_input' when calling DefaultApi.pull_records"
1181
+ # verify the required parameter 'run_input' is set
1182
+ if @api_client.config.client_side_validation && run_input.nil?
1183
+ fail ArgumentError, "Missing the required parameter 'run_input' when calling DefaultApi.run_function"
858
1184
  end
859
1185
  # resource path
860
- local_var_path = '/sdk/v1/pull'
1186
+ local_var_path = '/sdk/v1/run'
861
1187
 
862
1188
  # query parameters
863
1189
  query_params = opts[:query_params] || {}
@@ -876,16 +1202,16 @@ module Appnigma::Generated
876
1202
  form_params = opts[:form_params] || {}
877
1203
 
878
1204
  # http body (model)
879
- post_body = opts[:debug_body] || @api_client.object_to_http_body(pull_input)
1205
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(run_input)
880
1206
 
881
1207
  # return_type
882
- return_type = opts[:debug_return_type] || 'PullOutput'
1208
+ return_type = opts[:debug_return_type] || 'RunOutput'
883
1209
 
884
1210
  # auth_names
885
1211
  auth_names = opts[:debug_auth_names] || ['SdkKey']
886
1212
 
887
1213
  new_options = opts.merge(
888
- :operation => :"DefaultApi.pull_records",
1214
+ :operation => :"DefaultApi.run_function",
889
1215
  :header_params => header_params,
890
1216
  :query_params => query_params,
891
1217
  :form_params => form_params,
@@ -896,36 +1222,36 @@ module Appnigma::Generated
896
1222
 
897
1223
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
898
1224
  if @api_client.config.debugging
899
- @api_client.config.logger.debug "API called: DefaultApi#pull_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1225
+ @api_client.config.logger.debug "API called: DefaultApi#run_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
900
1226
  end
901
1227
  return data, status_code, headers
902
1228
  end
903
1229
 
904
- # Run one of your own functions
905
- # Runs one of your functions, by platform and name, on the end customer's account. The input is checked against the shape the function declared. What runs is always the function's live version, and ranAs says whose it was, the end customer's own or yours, and which version. A version sent by an older SDK is ignored. A function removed from your logic is retired and answers FUNCTION_RETIRED.
906
- # @param run_input [RunInput]
1230
+ # Update one of the companies in one shape
1231
+ # Sets the fields you send on one of an end customer's companies, by its id in the CRM. A field left out is left alone; null clears it.
1232
+ # @param crm_update_input [CrmUpdateInput]
907
1233
  # @param [Hash] opts the optional parameters
908
- # @return [RunOutput]
909
- def run_function(run_input, opts = {})
910
- data, _status_code, _headers = run_function_with_http_info(run_input, opts)
1234
+ # @return [CrmCompanyWriteOutput]
1235
+ def update_crm_company(crm_update_input, opts = {})
1236
+ data, _status_code, _headers = update_crm_company_with_http_info(crm_update_input, opts)
911
1237
  data
912
1238
  end
913
1239
 
914
- # Run one of your own functions
915
- # Runs one of your functions, by platform and name, on the end customer&#39;s account. The input is checked against the shape the function declared. What runs is always the function&#39;s live version, and ranAs says whose it was, the end customer&#39;s own or yours, and which version. A version sent by an older SDK is ignored. A function removed from your logic is retired and answers FUNCTION_RETIRED.
916
- # @param run_input [RunInput]
1240
+ # Update one of the companies in one shape
1241
+ # Sets the fields you send on one of an end customer&#39;s companies, by its id in the CRM. A field left out is left alone; null clears it.
1242
+ # @param crm_update_input [CrmUpdateInput]
917
1243
  # @param [Hash] opts the optional parameters
918
- # @return [Array<(RunOutput, Integer, Hash)>] RunOutput data, response status code and response headers
919
- def run_function_with_http_info(run_input, opts = {})
1244
+ # @return [Array<(CrmCompanyWriteOutput, Integer, Hash)>] CrmCompanyWriteOutput data, response status code and response headers
1245
+ def update_crm_company_with_http_info(crm_update_input, opts = {})
920
1246
  if @api_client.config.debugging
921
- @api_client.config.logger.debug 'Calling API: DefaultApi.run_function ...'
1247
+ @api_client.config.logger.debug 'Calling API: DefaultApi.update_crm_company ...'
922
1248
  end
923
- # verify the required parameter 'run_input' is set
924
- if @api_client.config.client_side_validation && run_input.nil?
925
- fail ArgumentError, "Missing the required parameter 'run_input' when calling DefaultApi.run_function"
1249
+ # verify the required parameter 'crm_update_input' is set
1250
+ if @api_client.config.client_side_validation && crm_update_input.nil?
1251
+ fail ArgumentError, "Missing the required parameter 'crm_update_input' when calling DefaultApi.update_crm_company"
926
1252
  end
927
1253
  # resource path
928
- local_var_path = '/sdk/v1/run'
1254
+ local_var_path = '/sdk/v1/crm/companies/update'
929
1255
 
930
1256
  # query parameters
931
1257
  query_params = opts[:query_params] || {}
@@ -944,16 +1270,16 @@ module Appnigma::Generated
944
1270
  form_params = opts[:form_params] || {}
945
1271
 
946
1272
  # http body (model)
947
- post_body = opts[:debug_body] || @api_client.object_to_http_body(run_input)
1273
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(crm_update_input)
948
1274
 
949
1275
  # return_type
950
- return_type = opts[:debug_return_type] || 'RunOutput'
1276
+ return_type = opts[:debug_return_type] || 'CrmCompanyWriteOutput'
951
1277
 
952
1278
  # auth_names
953
1279
  auth_names = opts[:debug_auth_names] || ['SdkKey']
954
1280
 
955
1281
  new_options = opts.merge(
956
- :operation => :"DefaultApi.run_function",
1282
+ :operation => :"DefaultApi.update_crm_company",
957
1283
  :header_params => header_params,
958
1284
  :query_params => query_params,
959
1285
  :form_params => form_params,
@@ -964,7 +1290,143 @@ module Appnigma::Generated
964
1290
 
965
1291
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
966
1292
  if @api_client.config.debugging
967
- @api_client.config.logger.debug "API called: DefaultApi#run_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1293
+ @api_client.config.logger.debug "API called: DefaultApi#update_crm_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1294
+ end
1295
+ return data, status_code, headers
1296
+ end
1297
+
1298
+ # Update one of the contacts in one shape
1299
+ # Sets the fields you send on one of an end customer's contacts, by its id in the CRM. A field left out is left alone; null clears it.
1300
+ # @param crm_update_input [CrmUpdateInput]
1301
+ # @param [Hash] opts the optional parameters
1302
+ # @return [CrmContactWriteOutput]
1303
+ def update_crm_contact(crm_update_input, opts = {})
1304
+ data, _status_code, _headers = update_crm_contact_with_http_info(crm_update_input, opts)
1305
+ data
1306
+ end
1307
+
1308
+ # Update one of the contacts in one shape
1309
+ # Sets the fields you send on one of an end customer&#39;s contacts, by its id in the CRM. A field left out is left alone; null clears it.
1310
+ # @param crm_update_input [CrmUpdateInput]
1311
+ # @param [Hash] opts the optional parameters
1312
+ # @return [Array<(CrmContactWriteOutput, Integer, Hash)>] CrmContactWriteOutput data, response status code and response headers
1313
+ def update_crm_contact_with_http_info(crm_update_input, opts = {})
1314
+ if @api_client.config.debugging
1315
+ @api_client.config.logger.debug 'Calling API: DefaultApi.update_crm_contact ...'
1316
+ end
1317
+ # verify the required parameter 'crm_update_input' is set
1318
+ if @api_client.config.client_side_validation && crm_update_input.nil?
1319
+ fail ArgumentError, "Missing the required parameter 'crm_update_input' when calling DefaultApi.update_crm_contact"
1320
+ end
1321
+ # resource path
1322
+ local_var_path = '/sdk/v1/crm/contacts/update'
1323
+
1324
+ # query parameters
1325
+ query_params = opts[:query_params] || {}
1326
+
1327
+ # header parameters
1328
+ header_params = opts[:header_params] || {}
1329
+ # HTTP header 'Accept' (if needed)
1330
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1331
+ # HTTP header 'Content-Type'
1332
+ content_type = @api_client.select_header_content_type(['application/json'])
1333
+ if !content_type.nil?
1334
+ header_params['Content-Type'] = content_type
1335
+ end
1336
+
1337
+ # form parameters
1338
+ form_params = opts[:form_params] || {}
1339
+
1340
+ # http body (model)
1341
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(crm_update_input)
1342
+
1343
+ # return_type
1344
+ return_type = opts[:debug_return_type] || 'CrmContactWriteOutput'
1345
+
1346
+ # auth_names
1347
+ auth_names = opts[:debug_auth_names] || ['SdkKey']
1348
+
1349
+ new_options = opts.merge(
1350
+ :operation => :"DefaultApi.update_crm_contact",
1351
+ :header_params => header_params,
1352
+ :query_params => query_params,
1353
+ :form_params => form_params,
1354
+ :body => post_body,
1355
+ :auth_names => auth_names,
1356
+ :return_type => return_type
1357
+ )
1358
+
1359
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1360
+ if @api_client.config.debugging
1361
+ @api_client.config.logger.debug "API called: DefaultApi#update_crm_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1362
+ end
1363
+ return data, status_code, headers
1364
+ end
1365
+
1366
+ # Update one of the deals in one shape
1367
+ # Sets the fields you send on one of an end customer's deals, by its id in the CRM. A field left out is left alone; null clears it.
1368
+ # @param crm_update_input [CrmUpdateInput]
1369
+ # @param [Hash] opts the optional parameters
1370
+ # @return [CrmDealWriteOutput]
1371
+ def update_crm_deal(crm_update_input, opts = {})
1372
+ data, _status_code, _headers = update_crm_deal_with_http_info(crm_update_input, opts)
1373
+ data
1374
+ end
1375
+
1376
+ # Update one of the deals in one shape
1377
+ # Sets the fields you send on one of an end customer&#39;s deals, by its id in the CRM. A field left out is left alone; null clears it.
1378
+ # @param crm_update_input [CrmUpdateInput]
1379
+ # @param [Hash] opts the optional parameters
1380
+ # @return [Array<(CrmDealWriteOutput, Integer, Hash)>] CrmDealWriteOutput data, response status code and response headers
1381
+ def update_crm_deal_with_http_info(crm_update_input, opts = {})
1382
+ if @api_client.config.debugging
1383
+ @api_client.config.logger.debug 'Calling API: DefaultApi.update_crm_deal ...'
1384
+ end
1385
+ # verify the required parameter 'crm_update_input' is set
1386
+ if @api_client.config.client_side_validation && crm_update_input.nil?
1387
+ fail ArgumentError, "Missing the required parameter 'crm_update_input' when calling DefaultApi.update_crm_deal"
1388
+ end
1389
+ # resource path
1390
+ local_var_path = '/sdk/v1/crm/deals/update'
1391
+
1392
+ # query parameters
1393
+ query_params = opts[:query_params] || {}
1394
+
1395
+ # header parameters
1396
+ header_params = opts[:header_params] || {}
1397
+ # HTTP header 'Accept' (if needed)
1398
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1399
+ # HTTP header 'Content-Type'
1400
+ content_type = @api_client.select_header_content_type(['application/json'])
1401
+ if !content_type.nil?
1402
+ header_params['Content-Type'] = content_type
1403
+ end
1404
+
1405
+ # form parameters
1406
+ form_params = opts[:form_params] || {}
1407
+
1408
+ # http body (model)
1409
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(crm_update_input)
1410
+
1411
+ # return_type
1412
+ return_type = opts[:debug_return_type] || 'CrmDealWriteOutput'
1413
+
1414
+ # auth_names
1415
+ auth_names = opts[:debug_auth_names] || ['SdkKey']
1416
+
1417
+ new_options = opts.merge(
1418
+ :operation => :"DefaultApi.update_crm_deal",
1419
+ :header_params => header_params,
1420
+ :query_params => query_params,
1421
+ :form_params => form_params,
1422
+ :body => post_body,
1423
+ :auth_names => auth_names,
1424
+ :return_type => return_type
1425
+ )
1426
+
1427
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1428
+ if @api_client.config.debugging
1429
+ @api_client.config.logger.debug "API called: DefaultApi#update_crm_deal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
968
1430
  end
969
1431
  return data, status_code, headers
970
1432
  end