sib-api-v3-sdk 8.1.0 → 9.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (196) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +82 -14
  3. data/docs/Body.md +2 -11
  4. data/docs/Body1.md +2 -11
  5. data/docs/Body10.md +11 -0
  6. data/docs/Body11.md +8 -0
  7. data/docs/Body12.md +11 -0
  8. data/docs/Body2.md +11 -0
  9. data/docs/Body3.md +9 -0
  10. data/docs/Body4.md +9 -0
  11. data/docs/Body5.md +11 -0
  12. data/docs/Body6.md +18 -0
  13. data/docs/Body7.md +17 -0
  14. data/docs/Body8.md +13 -0
  15. data/docs/Body9.md +8 -0
  16. data/docs/CompaniesApi.md +425 -0
  17. data/docs/CompaniesList.md +8 -0
  18. data/docs/Company.md +11 -0
  19. data/docs/CompanyAttributes.md +7 -0
  20. data/docs/CompanyAttributesInner.md +12 -0
  21. data/docs/ContactsApi.md +8 -2
  22. data/docs/ConversationsApi.md +542 -0
  23. data/docs/ConversationsMessage.md +17 -0
  24. data/docs/ConversationsMessageFile.md +12 -0
  25. data/docs/ConversationsMessageFileImageInfo.md +10 -0
  26. data/docs/CreateContact.md +1 -1
  27. data/docs/CreateSubAccount.md +3 -3
  28. data/docs/CreateSubAccountResponse.md +8 -0
  29. data/docs/Deal.md +11 -0
  30. data/docs/DealAttributes.md +7 -0
  31. data/docs/DealAttributesInner.md +12 -0
  32. data/docs/DealsApi.md +476 -0
  33. data/docs/DealsList.md +8 -0
  34. data/docs/EmailCampaignsApi.md +6 -5
  35. data/docs/FileData.md +3 -6
  36. data/docs/FileDownloadableLink.md +8 -0
  37. data/docs/FileList.md +7 -0
  38. data/docs/FilesApi.md +318 -0
  39. data/docs/GetCampaignStats.md +2 -0
  40. data/docs/GetScheduledEmailByBatchId.md +9 -0
  41. data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
  42. data/docs/GetScheduledEmailByMessageId.md +10 -0
  43. data/docs/GetSsoToken.md +1 -1
  44. data/docs/InboundParsingApi.md +60 -0
  45. data/docs/InlineResponse200.md +8 -0
  46. data/docs/InlineResponse201.md +8 -0
  47. data/docs/InlineResponse2011.md +8 -0
  48. data/docs/MasterAccountApi.md +6 -6
  49. data/docs/NoteId.md +8 -0
  50. data/docs/NoteList.md +7 -0
  51. data/docs/NotesApi.md +312 -0
  52. data/docs/Pipeline.md +8 -0
  53. data/docs/PipelineStage.md +9 -0
  54. data/docs/ScheduleSmtpEmail.md +10 -0
  55. data/docs/SendSmtpEmail.md +3 -1
  56. data/docs/SubAccountDetailsResponsePlanInfoCredits.md +1 -1
  57. data/docs/SubAccountsResponseSubAccounts.md +4 -4
  58. data/docs/Task.md +0 -11
  59. data/docs/TaskList.md +8 -0
  60. data/docs/TaskReminder.md +1 -1
  61. data/docs/TaskTypes.md +0 -1
  62. data/docs/TasksApi.md +376 -0
  63. data/docs/TransactionalEmailsApi.md +199 -0
  64. data/docs/UpdateContact.md +1 -1
  65. data/docs/UpdateEmailCampaign.md +1 -1
  66. data/docs/UpdateSmtpTemplate.md +1 -1
  67. data/docs/UploadImageModel.md +8 -0
  68. data/lib/sib-api-v3-sdk/api/companies_api.rb +409 -0
  69. data/lib/sib-api-v3-sdk/api/contacts_api.rb +6 -0
  70. data/lib/sib-api-v3-sdk/api/conversations_api.rb +504 -0
  71. data/lib/sib-api-v3-sdk/api/deals_api.rb +454 -0
  72. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +9 -8
  73. data/lib/sib-api-v3-sdk/api/files_api.rb +313 -0
  74. data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +53 -1
  75. data/lib/sib-api-v3-sdk/api/master_account_api.rb +9 -9
  76. data/lib/sib-api-v3-sdk/api/notes_api.rb +308 -0
  77. data/lib/sib-api-v3-sdk/api/tasks_api.rb +375 -0
  78. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +195 -0
  79. data/lib/sib-api-v3-sdk/models/body.rb +9 -114
  80. data/lib/sib-api-v3-sdk/models/body_1.rb +9 -119
  81. data/lib/sib-api-v3-sdk/models/body_10.rb +225 -0
  82. data/lib/sib-api-v3-sdk/models/body_11.rb +190 -0
  83. data/lib/sib-api-v3-sdk/models/body_12.rb +215 -0
  84. data/lib/sib-api-v3-sdk/models/body_2.rb +223 -0
  85. data/lib/sib-api-v3-sdk/models/body_3.rb +200 -0
  86. data/lib/sib-api-v3-sdk/models/body_4.rb +195 -0
  87. data/lib/sib-api-v3-sdk/models/body_5.rb +223 -0
  88. data/lib/sib-api-v3-sdk/models/body_6.rb +320 -0
  89. data/lib/sib-api-v3-sdk/models/body_7.rb +281 -0
  90. data/lib/sib-api-v3-sdk/models/body_8.rb +245 -0
  91. data/lib/sib-api-v3-sdk/models/body_9.rb +190 -0
  92. data/lib/sib-api-v3-sdk/models/companies_list.rb +188 -0
  93. data/lib/sib-api-v3-sdk/models/company.rb +220 -0
  94. data/lib/sib-api-v3-sdk/models/company_attributes.rb +176 -0
  95. data/lib/sib-api-v3-sdk/models/company_attributes_inner.rb +223 -0
  96. data/lib/sib-api-v3-sdk/models/conversations_message.rb +324 -0
  97. data/lib/sib-api-v3-sdk/models/conversations_message_file.rb +239 -0
  98. data/lib/sib-api-v3-sdk/models/conversations_message_file_image_info.rb +236 -0
  99. data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
  100. data/lib/sib-api-v3-sdk/models/create_sub_account.rb +3 -3
  101. data/lib/sib-api-v3-sdk/models/create_sub_account_response.rb +190 -0
  102. data/lib/sib-api-v3-sdk/models/deal.rb +220 -0
  103. data/lib/sib-api-v3-sdk/models/deal_attributes.rb +176 -0
  104. data/lib/sib-api-v3-sdk/models/deal_attributes_inner.rb +223 -0
  105. data/lib/sib-api-v3-sdk/models/deals_list.rb +188 -0
  106. data/lib/sib-api-v3-sdk/models/file_data.rb +22 -54
  107. data/lib/sib-api-v3-sdk/models/file_downloadable_link.rb +190 -0
  108. data/lib/sib-api-v3-sdk/models/file_list.rb +176 -0
  109. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +21 -1
  110. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id.rb +196 -0
  111. data/lib/sib-api-v3-sdk/models/{contact.rb → get_scheduled_email_by_batch_id_batches.rb} +62 -74
  112. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_message_id.rb +254 -0
  113. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +1 -1
  114. data/lib/sib-api-v3-sdk/models/inline_response_200.rb +191 -0
  115. data/lib/sib-api-v3-sdk/models/inline_response_201.rb +191 -0
  116. data/lib/sib-api-v3-sdk/models/inline_response_201_1.rb +191 -0
  117. data/lib/sib-api-v3-sdk/models/note_id.rb +186 -0
  118. data/lib/sib-api-v3-sdk/models/note_list.rb +176 -0
  119. data/lib/sib-api-v3-sdk/models/pipeline.rb +188 -0
  120. data/lib/sib-api-v3-sdk/models/pipeline_stage.rb +196 -0
  121. data/lib/sib-api-v3-sdk/models/schedule_smtp_email.rb +206 -0
  122. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +24 -4
  123. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +2 -2
  124. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +1 -1
  125. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +1 -1
  126. data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +4 -4
  127. data/lib/sib-api-v3-sdk/models/task.rb +4 -119
  128. data/lib/sib-api-v3-sdk/models/task_list.rb +188 -0
  129. data/lib/sib-api-v3-sdk/models/task_reminder.rb +1 -1
  130. data/lib/sib-api-v3-sdk/models/task_types.rb +1 -11
  131. data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
  132. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +1 -1
  133. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
  134. data/lib/sib-api-v3-sdk/models/upload_image_model.rb +190 -0
  135. data/lib/sib-api-v3-sdk/version.rb +1 -1
  136. data/lib/sib-api-v3-sdk.rb +44 -2
  137. data/spec/api/companies_api_spec.rb +119 -0
  138. data/spec/api/contacts_api_spec.rb +2 -0
  139. data/spec/api/conversations_api_spec.rb +140 -0
  140. data/spec/api/deals_api_spec.rb +129 -0
  141. data/spec/api/email_campaigns_api_spec.rb +1 -1
  142. data/spec/api/files_api_spec.rb +99 -0
  143. data/spec/api/inbound_parsing_api_spec.rb +12 -0
  144. data/spec/api/master_account_api_spec.rb +4 -4
  145. data/spec/api/notes_api_spec.rb +97 -0
  146. data/spec/api/{crm_api_spec.rb → tasks_api_spec.rb} +25 -92
  147. data/spec/api/transactional_emails_api_spec.rb +44 -0
  148. data/spec/models/body_10_spec.rb +59 -0
  149. data/spec/models/body_11_spec.rb +41 -0
  150. data/spec/models/body_12_spec.rb +59 -0
  151. data/spec/models/body_1_spec.rb +1 -55
  152. data/spec/models/body_2_spec.rb +59 -0
  153. data/spec/models/body_3_spec.rb +47 -0
  154. data/spec/models/body_4_spec.rb +47 -0
  155. data/spec/models/body_5_spec.rb +59 -0
  156. data/spec/models/body_6_spec.rb +101 -0
  157. data/spec/models/{contact_spec.rb → body_7_spec.rb} +26 -14
  158. data/spec/models/body_8_spec.rb +71 -0
  159. data/spec/models/body_9_spec.rb +41 -0
  160. data/spec/models/body_spec.rb +1 -55
  161. data/spec/models/companies_list_spec.rb +41 -0
  162. data/spec/models/company_attributes_inner_spec.rb +65 -0
  163. data/spec/models/company_attributes_spec.rb +35 -0
  164. data/spec/models/company_spec.rb +59 -0
  165. data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
  166. data/spec/models/conversations_message_file_spec.rb +65 -0
  167. data/spec/models/conversations_message_spec.rb +99 -0
  168. data/spec/models/create_sub_account_response_spec.rb +41 -0
  169. data/spec/models/deal_attributes_inner_spec.rb +65 -0
  170. data/spec/models/deal_attributes_spec.rb +35 -0
  171. data/spec/models/deal_spec.rb +59 -0
  172. data/spec/models/deals_list_spec.rb +41 -0
  173. data/spec/models/file_data_spec.rb +3 -21
  174. data/spec/models/file_downloadable_link_spec.rb +41 -0
  175. data/spec/models/file_list_spec.rb +35 -0
  176. data/spec/models/get_campaign_stats_spec.rb +12 -0
  177. data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
  178. data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
  179. data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
  180. data/spec/models/inline_response_200_spec.rb +41 -0
  181. data/spec/models/inline_response_201_1_spec.rb +41 -0
  182. data/spec/models/inline_response_201_spec.rb +41 -0
  183. data/spec/models/note_id_spec.rb +41 -0
  184. data/spec/models/note_list_spec.rb +35 -0
  185. data/spec/models/pipeline_spec.rb +41 -0
  186. data/spec/models/pipeline_stage_spec.rb +47 -0
  187. data/spec/models/schedule_smtp_email_spec.rb +53 -0
  188. data/spec/models/send_smtp_email_spec.rb +12 -0
  189. data/spec/models/task_list_spec.rb +41 -0
  190. data/spec/models/task_spec.rb +0 -66
  191. data/spec/models/task_types_spec.rb +0 -6
  192. data/spec/models/upload_image_model_spec.rb +41 -0
  193. metadata +179 -11
  194. data/docs/CRMApi.md +0 -762
  195. data/docs/Contact.md +0 -15
  196. data/lib/sib-api-v3-sdk/api/crm_api.rb +0 -716
@@ -1,716 +0,0 @@
1
- =begin
2
- #SendinBlue API
3
-
4
- #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
5
-
6
- OpenAPI spec version: 3.0.0
7
- Contact: contact@sendinblue.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.19
10
-
11
- =end
12
-
13
- require 'uri'
14
-
15
- module SibApiV3Sdk
16
- class CRMApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Set custom user_agent if explicitly passed in api
24
- # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
- def setUserAgent(user_agent)
26
- @user_agent = user_agent
27
- if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
- @api_client.default_headers['User-Agent'] = @user_agent
29
- end
30
- end
31
-
32
-
33
- # Get file details.
34
- # @param id File id to get file data.
35
- # @param [Hash] opts the optional parameters
36
- # @return [FileData]
37
- def crm_files_id_data_get(id, opts = {})
38
- data, _status_code, _headers = crm_files_id_data_get_with_http_info(id, opts)
39
- data
40
- end
41
-
42
- # Get file details
43
- # @param id File id to get file data.
44
- # @param [Hash] opts the optional parameters
45
- # @return [Array<(FileData, Fixnum, Hash)>] FileData data, response status code and response headers
46
- def crm_files_id_data_get_with_http_info(id, opts = {})
47
- if @api_client.config.debugging
48
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_files_id_data_get ...'
49
- end
50
- # verify the required parameter 'id' is set
51
- if @api_client.config.client_side_validation && id.nil?
52
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_files_id_data_get"
53
- end
54
- # resource path
55
- local_var_path = '/crm/files/{id}/data'.sub('{' + 'id' + '}', id.to_s)
56
-
57
- # query parameters
58
- query_params = {}
59
-
60
- # header parameters
61
- header_params = {}
62
- # HTTP header 'Accept' (if needed)
63
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
- # HTTP header 'Content-Type'
65
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
66
-
67
- # form parameters
68
- form_params = {}
69
-
70
- # http body (model)
71
- post_body = nil
72
- auth_names = ['api-key', 'partner-key']
73
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
74
- :header_params => header_params,
75
- :query_params => query_params,
76
- :form_params => form_params,
77
- :body => post_body,
78
- :auth_names => auth_names,
79
- :return_type => 'FileData')
80
- if @api_client.config.debugging
81
- @api_client.config.logger.debug "API called: CRMApi#crm_files_id_data_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
- end
83
- return data, status_code, headers
84
- end
85
- # Delete a file
86
- # @param id File id to delete.
87
- # @param [Hash] opts the optional parameters
88
- # @return [nil]
89
- def crm_files_id_delete(id, opts = {})
90
- crm_files_id_delete_with_http_info(id, opts)
91
- nil
92
- end
93
-
94
- # Delete a file
95
- # @param id File id to delete.
96
- # @param [Hash] opts the optional parameters
97
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
98
- def crm_files_id_delete_with_http_info(id, opts = {})
99
- if @api_client.config.debugging
100
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_files_id_delete ...'
101
- end
102
- # verify the required parameter 'id' is set
103
- if @api_client.config.client_side_validation && id.nil?
104
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_files_id_delete"
105
- end
106
- # resource path
107
- local_var_path = '/crm/files/{id}'.sub('{' + 'id' + '}', id.to_s)
108
-
109
- # query parameters
110
- query_params = {}
111
-
112
- # header parameters
113
- header_params = {}
114
- # HTTP header 'Accept' (if needed)
115
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
116
- # HTTP header 'Content-Type'
117
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
118
-
119
- # form parameters
120
- form_params = {}
121
-
122
- # http body (model)
123
- post_body = nil
124
- auth_names = ['api-key', 'partner-key']
125
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
126
- :header_params => header_params,
127
- :query_params => query_params,
128
- :form_params => form_params,
129
- :body => post_body,
130
- :auth_names => auth_names)
131
- if @api_client.config.debugging
132
- @api_client.config.logger.debug "API called: CRMApi#crm_files_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
133
- end
134
- return data, status_code, headers
135
- end
136
- # Download a file
137
- # @param id File id to download.
138
- # @param [Hash] opts the optional parameters
139
- # @return [nil]
140
- def crm_files_id_get(id, opts = {})
141
- crm_files_id_get_with_http_info(id, opts)
142
- nil
143
- end
144
-
145
- # Download a file
146
- # @param id File id to download.
147
- # @param [Hash] opts the optional parameters
148
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
149
- def crm_files_id_get_with_http_info(id, opts = {})
150
- if @api_client.config.debugging
151
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_files_id_get ...'
152
- end
153
- # verify the required parameter 'id' is set
154
- if @api_client.config.client_side_validation && id.nil?
155
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_files_id_get"
156
- end
157
- # resource path
158
- local_var_path = '/crm/files/{id}'.sub('{' + 'id' + '}', id.to_s)
159
-
160
- # query parameters
161
- query_params = {}
162
-
163
- # header parameters
164
- header_params = {}
165
- # HTTP header 'Accept' (if needed)
166
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
167
- # HTTP header 'Content-Type'
168
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
169
-
170
- # form parameters
171
- form_params = {}
172
-
173
- # http body (model)
174
- post_body = nil
175
- auth_names = ['api-key', 'partner-key']
176
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
177
- :header_params => header_params,
178
- :query_params => query_params,
179
- :form_params => form_params,
180
- :body => post_body,
181
- :auth_names => auth_names)
182
- if @api_client.config.debugging
183
- @api_client.config.logger.debug "API called: CRMApi#crm_files_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
184
- end
185
- return data, status_code, headers
186
- end
187
- # Upload a file
188
- # @param file File data to create a file.
189
- # @param [Hash] opts the optional parameters
190
- # @option opts [Array<String>] :deals_ids Deal ids linked to a file
191
- # @return [FileData]
192
- def crm_files_post(file, opts = {})
193
- data, _status_code, _headers = crm_files_post_with_http_info(file, opts)
194
- data
195
- end
196
-
197
- # Upload a file
198
- # @param file File data to create a file.
199
- # @param [Hash] opts the optional parameters
200
- # @option opts [Array<String>] :deals_ids Deal ids linked to a file
201
- # @return [Array<(FileData, Fixnum, Hash)>] FileData data, response status code and response headers
202
- def crm_files_post_with_http_info(file, opts = {})
203
- if @api_client.config.debugging
204
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_files_post ...'
205
- end
206
- # verify the required parameter 'file' is set
207
- if @api_client.config.client_side_validation && file.nil?
208
- fail ArgumentError, "Missing the required parameter 'file' when calling CRMApi.crm_files_post"
209
- end
210
- # resource path
211
- local_var_path = '/crm/files'
212
-
213
- # query parameters
214
- query_params = {}
215
-
216
- # header parameters
217
- header_params = {}
218
- # HTTP header 'Accept' (if needed)
219
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
220
- # HTTP header 'Content-Type'
221
- header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
222
-
223
- # form parameters
224
- form_params = {}
225
- form_params['file'] = file
226
- form_params['dealsIds'] = @api_client.build_collection_param(opts[:'deals_ids'], :csv) if !opts[:'deals_ids'].nil?
227
-
228
- # http body (model)
229
- post_body = nil
230
- auth_names = ['api-key', 'partner-key']
231
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
232
- :header_params => header_params,
233
- :query_params => query_params,
234
- :form_params => form_params,
235
- :body => post_body,
236
- :auth_names => auth_names,
237
- :return_type => 'FileData')
238
- if @api_client.config.debugging
239
- @api_client.config.logger.debug "API called: CRMApi#crm_files_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
240
- end
241
- return data, status_code, headers
242
- end
243
- # Delete a note
244
- # @param id Note ID to delete
245
- # @param [Hash] opts the optional parameters
246
- # @return [nil]
247
- def crm_notes_id_delete(id, opts = {})
248
- crm_notes_id_delete_with_http_info(id, opts)
249
- nil
250
- end
251
-
252
- # Delete a note
253
- # @param id Note ID to delete
254
- # @param [Hash] opts the optional parameters
255
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
256
- def crm_notes_id_delete_with_http_info(id, opts = {})
257
- if @api_client.config.debugging
258
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_notes_id_delete ...'
259
- end
260
- # verify the required parameter 'id' is set
261
- if @api_client.config.client_side_validation && id.nil?
262
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_notes_id_delete"
263
- end
264
- # resource path
265
- local_var_path = '/crm/notes/{id}'.sub('{' + 'id' + '}', id.to_s)
266
-
267
- # query parameters
268
- query_params = {}
269
-
270
- # header parameters
271
- header_params = {}
272
- # HTTP header 'Accept' (if needed)
273
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
274
- # HTTP header 'Content-Type'
275
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
276
-
277
- # form parameters
278
- form_params = {}
279
-
280
- # http body (model)
281
- post_body = nil
282
- auth_names = ['api-key', 'partner-key']
283
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
284
- :header_params => header_params,
285
- :query_params => query_params,
286
- :form_params => form_params,
287
- :body => post_body,
288
- :auth_names => auth_names)
289
- if @api_client.config.debugging
290
- @api_client.config.logger.debug "API called: CRMApi#crm_notes_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
291
- end
292
- return data, status_code, headers
293
- end
294
- # Get a note
295
- # @param id Note ID to get
296
- # @param [Hash] opts the optional parameters
297
- # @return [Note]
298
- def crm_notes_id_get(id, opts = {})
299
- data, _status_code, _headers = crm_notes_id_get_with_http_info(id, opts)
300
- data
301
- end
302
-
303
- # Get a note
304
- # @param id Note ID to get
305
- # @param [Hash] opts the optional parameters
306
- # @return [Array<(Note, Fixnum, Hash)>] Note data, response status code and response headers
307
- def crm_notes_id_get_with_http_info(id, opts = {})
308
- if @api_client.config.debugging
309
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_notes_id_get ...'
310
- end
311
- # verify the required parameter 'id' is set
312
- if @api_client.config.client_side_validation && id.nil?
313
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_notes_id_get"
314
- end
315
- # resource path
316
- local_var_path = '/crm/notes/{id}'.sub('{' + 'id' + '}', id.to_s)
317
-
318
- # query parameters
319
- query_params = {}
320
-
321
- # header parameters
322
- header_params = {}
323
- # HTTP header 'Accept' (if needed)
324
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
325
- # HTTP header 'Content-Type'
326
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
327
-
328
- # form parameters
329
- form_params = {}
330
-
331
- # http body (model)
332
- post_body = nil
333
- auth_names = ['api-key', 'partner-key']
334
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
335
- :header_params => header_params,
336
- :query_params => query_params,
337
- :form_params => form_params,
338
- :body => post_body,
339
- :auth_names => auth_names,
340
- :return_type => 'Note')
341
- if @api_client.config.debugging
342
- @api_client.config.logger.debug "API called: CRMApi#crm_notes_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
343
- end
344
- return data, status_code, headers
345
- end
346
- # Update a note
347
- # @param id Note ID to update
348
- # @param body Note data to update a note
349
- # @param [Hash] opts the optional parameters
350
- # @return [Note]
351
- def crm_notes_id_patch(id, body, opts = {})
352
- data, _status_code, _headers = crm_notes_id_patch_with_http_info(id, body, opts)
353
- data
354
- end
355
-
356
- # Update a note
357
- # @param id Note ID to update
358
- # @param body Note data to update a note
359
- # @param [Hash] opts the optional parameters
360
- # @return [Array<(Note, Fixnum, Hash)>] Note data, response status code and response headers
361
- def crm_notes_id_patch_with_http_info(id, body, opts = {})
362
- if @api_client.config.debugging
363
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_notes_id_patch ...'
364
- end
365
- # verify the required parameter 'id' is set
366
- if @api_client.config.client_side_validation && id.nil?
367
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_notes_id_patch"
368
- end
369
- # verify the required parameter 'body' is set
370
- if @api_client.config.client_side_validation && body.nil?
371
- fail ArgumentError, "Missing the required parameter 'body' when calling CRMApi.crm_notes_id_patch"
372
- end
373
- # resource path
374
- local_var_path = '/crm/notes/{id}'.sub('{' + 'id' + '}', id.to_s)
375
-
376
- # query parameters
377
- query_params = {}
378
-
379
- # header parameters
380
- header_params = {}
381
- # HTTP header 'Accept' (if needed)
382
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
383
- # HTTP header 'Content-Type'
384
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
385
-
386
- # form parameters
387
- form_params = {}
388
-
389
- # http body (model)
390
- post_body = @api_client.object_to_http_body(body)
391
- auth_names = ['api-key', 'partner-key']
392
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
393
- :header_params => header_params,
394
- :query_params => query_params,
395
- :form_params => form_params,
396
- :body => post_body,
397
- :auth_names => auth_names,
398
- :return_type => 'Note')
399
- if @api_client.config.debugging
400
- @api_client.config.logger.debug "API called: CRMApi#crm_notes_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
401
- end
402
- return data, status_code, headers
403
- end
404
- # Create a note
405
- # @param body Note data to create a note.
406
- # @param [Hash] opts the optional parameters
407
- # @return [Note]
408
- def crm_notes_post(body, opts = {})
409
- data, _status_code, _headers = crm_notes_post_with_http_info(body, opts)
410
- data
411
- end
412
-
413
- # Create a note
414
- # @param body Note data to create a note.
415
- # @param [Hash] opts the optional parameters
416
- # @return [Array<(Note, Fixnum, Hash)>] Note data, response status code and response headers
417
- def crm_notes_post_with_http_info(body, opts = {})
418
- if @api_client.config.debugging
419
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_notes_post ...'
420
- end
421
- # verify the required parameter 'body' is set
422
- if @api_client.config.client_side_validation && body.nil?
423
- fail ArgumentError, "Missing the required parameter 'body' when calling CRMApi.crm_notes_post"
424
- end
425
- # resource path
426
- local_var_path = '/crm/notes'
427
-
428
- # query parameters
429
- query_params = {}
430
-
431
- # header parameters
432
- header_params = {}
433
- # HTTP header 'Accept' (if needed)
434
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
435
- # HTTP header 'Content-Type'
436
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
437
-
438
- # form parameters
439
- form_params = {}
440
-
441
- # http body (model)
442
- post_body = @api_client.object_to_http_body(body)
443
- auth_names = ['api-key', 'partner-key']
444
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
445
- :header_params => header_params,
446
- :query_params => query_params,
447
- :form_params => form_params,
448
- :body => post_body,
449
- :auth_names => auth_names,
450
- :return_type => 'Note')
451
- if @api_client.config.debugging
452
- @api_client.config.logger.debug "API called: CRMApi#crm_notes_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
453
- end
454
- return data, status_code, headers
455
- end
456
- # Delete a task
457
- # @param id
458
- # @param [Hash] opts the optional parameters
459
- # @return [nil]
460
- def crm_tasks_id_delete(id, opts = {})
461
- crm_tasks_id_delete_with_http_info(id, opts)
462
- nil
463
- end
464
-
465
- # Delete a task
466
- # @param id
467
- # @param [Hash] opts the optional parameters
468
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
469
- def crm_tasks_id_delete_with_http_info(id, opts = {})
470
- if @api_client.config.debugging
471
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_tasks_id_delete ...'
472
- end
473
- # verify the required parameter 'id' is set
474
- if @api_client.config.client_side_validation && id.nil?
475
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_tasks_id_delete"
476
- end
477
- # resource path
478
- local_var_path = '/crm/tasks/{id}'.sub('{' + 'id' + '}', id.to_s)
479
-
480
- # query parameters
481
- query_params = {}
482
-
483
- # header parameters
484
- header_params = {}
485
- # HTTP header 'Accept' (if needed)
486
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
487
- # HTTP header 'Content-Type'
488
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
489
-
490
- # form parameters
491
- form_params = {}
492
-
493
- # http body (model)
494
- post_body = nil
495
- auth_names = ['api-key', 'partner-key']
496
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
497
- :header_params => header_params,
498
- :query_params => query_params,
499
- :form_params => form_params,
500
- :body => post_body,
501
- :auth_names => auth_names)
502
- if @api_client.config.debugging
503
- @api_client.config.logger.debug "API called: CRMApi#crm_tasks_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
504
- end
505
- return data, status_code, headers
506
- end
507
- # Get a task
508
- # @param id
509
- # @param [Hash] opts the optional parameters
510
- # @return [Task]
511
- def crm_tasks_id_get(id, opts = {})
512
- data, _status_code, _headers = crm_tasks_id_get_with_http_info(id, opts)
513
- data
514
- end
515
-
516
- # Get a task
517
- # @param id
518
- # @param [Hash] opts the optional parameters
519
- # @return [Array<(Task, Fixnum, Hash)>] Task data, response status code and response headers
520
- def crm_tasks_id_get_with_http_info(id, opts = {})
521
- if @api_client.config.debugging
522
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_tasks_id_get ...'
523
- end
524
- # verify the required parameter 'id' is set
525
- if @api_client.config.client_side_validation && id.nil?
526
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_tasks_id_get"
527
- end
528
- # resource path
529
- local_var_path = '/crm/tasks/{id}'.sub('{' + 'id' + '}', id.to_s)
530
-
531
- # query parameters
532
- query_params = {}
533
-
534
- # header parameters
535
- header_params = {}
536
- # HTTP header 'Accept' (if needed)
537
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
538
- # HTTP header 'Content-Type'
539
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
540
-
541
- # form parameters
542
- form_params = {}
543
-
544
- # http body (model)
545
- post_body = nil
546
- auth_names = ['api-key', 'partner-key']
547
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
548
- :header_params => header_params,
549
- :query_params => query_params,
550
- :form_params => form_params,
551
- :body => post_body,
552
- :auth_names => auth_names,
553
- :return_type => 'Task')
554
- if @api_client.config.debugging
555
- @api_client.config.logger.debug "API called: CRMApi#crm_tasks_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
556
- end
557
- return data, status_code, headers
558
- end
559
- # Update a task
560
- # @param id
561
- # @param body Updated task details.
562
- # @param [Hash] opts the optional parameters
563
- # @return [Task]
564
- def crm_tasks_id_patch(id, body, opts = {})
565
- data, _status_code, _headers = crm_tasks_id_patch_with_http_info(id, body, opts)
566
- data
567
- end
568
-
569
- # Update a task
570
- # @param id
571
- # @param body Updated task details.
572
- # @param [Hash] opts the optional parameters
573
- # @return [Array<(Task, Fixnum, Hash)>] Task data, response status code and response headers
574
- def crm_tasks_id_patch_with_http_info(id, body, opts = {})
575
- if @api_client.config.debugging
576
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_tasks_id_patch ...'
577
- end
578
- # verify the required parameter 'id' is set
579
- if @api_client.config.client_side_validation && id.nil?
580
- fail ArgumentError, "Missing the required parameter 'id' when calling CRMApi.crm_tasks_id_patch"
581
- end
582
- # verify the required parameter 'body' is set
583
- if @api_client.config.client_side_validation && body.nil?
584
- fail ArgumentError, "Missing the required parameter 'body' when calling CRMApi.crm_tasks_id_patch"
585
- end
586
- # resource path
587
- local_var_path = '/crm/tasks/{id}'.sub('{' + 'id' + '}', id.to_s)
588
-
589
- # query parameters
590
- query_params = {}
591
-
592
- # header parameters
593
- header_params = {}
594
- # HTTP header 'Accept' (if needed)
595
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
596
- # HTTP header 'Content-Type'
597
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
598
-
599
- # form parameters
600
- form_params = {}
601
-
602
- # http body (model)
603
- post_body = @api_client.object_to_http_body(body)
604
- auth_names = ['api-key', 'partner-key']
605
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
606
- :header_params => header_params,
607
- :query_params => query_params,
608
- :form_params => form_params,
609
- :body => post_body,
610
- :auth_names => auth_names,
611
- :return_type => 'Task')
612
- if @api_client.config.debugging
613
- @api_client.config.logger.debug "API called: CRMApi#crm_tasks_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
614
- end
615
- return data, status_code, headers
616
- end
617
- # Create a task
618
- # @param body Task name.
619
- # @param [Hash] opts the optional parameters
620
- # @return [Task]
621
- def crm_tasks_post(body, opts = {})
622
- data, _status_code, _headers = crm_tasks_post_with_http_info(body, opts)
623
- data
624
- end
625
-
626
- # Create a task
627
- # @param body Task name.
628
- # @param [Hash] opts the optional parameters
629
- # @return [Array<(Task, Fixnum, Hash)>] Task data, response status code and response headers
630
- def crm_tasks_post_with_http_info(body, opts = {})
631
- if @api_client.config.debugging
632
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_tasks_post ...'
633
- end
634
- # verify the required parameter 'body' is set
635
- if @api_client.config.client_side_validation && body.nil?
636
- fail ArgumentError, "Missing the required parameter 'body' when calling CRMApi.crm_tasks_post"
637
- end
638
- # resource path
639
- local_var_path = '/crm/tasks'
640
-
641
- # query parameters
642
- query_params = {}
643
-
644
- # header parameters
645
- header_params = {}
646
- # HTTP header 'Accept' (if needed)
647
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
648
- # HTTP header 'Content-Type'
649
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
650
-
651
- # form parameters
652
- form_params = {}
653
-
654
- # http body (model)
655
- post_body = @api_client.object_to_http_body(body)
656
- auth_names = ['api-key', 'partner-key']
657
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
658
- :header_params => header_params,
659
- :query_params => query_params,
660
- :form_params => form_params,
661
- :body => post_body,
662
- :auth_names => auth_names,
663
- :return_type => 'Task')
664
- if @api_client.config.debugging
665
- @api_client.config.logger.debug "API called: CRMApi#crm_tasks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
666
- end
667
- return data, status_code, headers
668
- end
669
- # Get all task types
670
- # @param [Hash] opts the optional parameters
671
- # @return [TaskTypes]
672
- def crm_tasktypes_get(opts = {})
673
- data, _status_code, _headers = crm_tasktypes_get_with_http_info(opts)
674
- data
675
- end
676
-
677
- # Get all task types
678
- # @param [Hash] opts the optional parameters
679
- # @return [Array<(TaskTypes, Fixnum, Hash)>] TaskTypes data, response status code and response headers
680
- def crm_tasktypes_get_with_http_info(opts = {})
681
- if @api_client.config.debugging
682
- @api_client.config.logger.debug 'Calling API: CRMApi.crm_tasktypes_get ...'
683
- end
684
- # resource path
685
- local_var_path = '/crm/tasktypes'
686
-
687
- # query parameters
688
- query_params = {}
689
-
690
- # header parameters
691
- header_params = {}
692
- # HTTP header 'Accept' (if needed)
693
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
694
- # HTTP header 'Content-Type'
695
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
696
-
697
- # form parameters
698
- form_params = {}
699
-
700
- # http body (model)
701
- post_body = nil
702
- auth_names = ['api-key', 'partner-key']
703
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
704
- :header_params => header_params,
705
- :query_params => query_params,
706
- :form_params => form_params,
707
- :body => post_body,
708
- :auth_names => auth_names,
709
- :return_type => 'TaskTypes')
710
- if @api_client.config.debugging
711
- @api_client.config.logger.debug "API called: CRMApi#crm_tasktypes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
712
- end
713
- return data, status_code, headers
714
- end
715
- end
716
- end