samplify_api_client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (275) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/Gemfile.lock +69 -0
  4. data/README.md +221 -0
  5. data/Rakefile +8 -0
  6. data/docs/AppError.md +10 -0
  7. data/docs/ApplicationItemData.md +11 -0
  8. data/docs/AttributeData.md +16 -0
  9. data/docs/AttributeOption.md +10 -0
  10. data/docs/Attributes.md +10 -0
  11. data/docs/AttributesApi.md +78 -0
  12. data/docs/AuthApi.md +191 -0
  13. data/docs/AuthError.md +9 -0
  14. data/docs/Author.md +10 -0
  15. data/docs/BuyProject.md +10 -0
  16. data/docs/BuyProjectItem.md +12 -0
  17. data/docs/BuyProjectResponse.md +9 -0
  18. data/docs/BuyProjectsPayload.md +7 -0
  19. data/docs/Categories.md +10 -0
  20. data/docs/CategoriesApi.md +72 -0
  21. data/docs/CategoryData.md +9 -0
  22. data/docs/CodePayload.md +11 -0
  23. data/docs/Countries.md +10 -0
  24. data/docs/CountriesApi.md +72 -0
  25. data/docs/CountryData.md +11 -0
  26. data/docs/CreateLineItem.md +10 -0
  27. data/docs/DefaultApi.md +88 -0
  28. data/docs/EndLinks.md +13 -0
  29. data/docs/ErrorType.md +9 -0
  30. data/docs/Event.md +10 -0
  31. data/docs/EventData.md +15 -0
  32. data/docs/EventListData.md +15 -0
  33. data/docs/Events.md +10 -0
  34. data/docs/EventsApi.md +287 -0
  35. data/docs/ExclusionData.md +9 -0
  36. data/docs/Feasibility.md +10 -0
  37. data/docs/FeasibilityApi.md +61 -0
  38. data/docs/FeasibilityData.md +14 -0
  39. data/docs/FeasibilityResponseData.md +9 -0
  40. data/docs/LineItemActionResponse.md +14 -0
  41. data/docs/LineItemData.md +22 -0
  42. data/docs/LineItemItemData.md +17 -0
  43. data/docs/LineItemReportData.md +25 -0
  44. data/docs/LineItemResponseData.md +27 -0
  45. data/docs/LineItems.md +10 -0
  46. data/docs/LineItemsApi.md +420 -0
  47. data/docs/Links.md +12 -0
  48. data/docs/LogoutPayload.md +10 -0
  49. data/docs/Meta.md +10 -0
  50. data/docs/Project.md +14 -0
  51. data/docs/ProjectAction.md +10 -0
  52. data/docs/ProjectActionResponse.md +13 -0
  53. data/docs/ProjectCategoryData.md +8 -0
  54. data/docs/ProjectItemData.md +14 -0
  55. data/docs/ProjectReport.md +10 -0
  56. data/docs/ProjectReportData.md +21 -0
  57. data/docs/ProjectReports.md +10 -0
  58. data/docs/ProjectResponse.md +10 -0
  59. data/docs/ProjectResponseData.md +19 -0
  60. data/docs/ProjectSurveyEndLinks.md +10 -0
  61. data/docs/ProjectSurveyEndLinksData.md +12 -0
  62. data/docs/Projects.md +10 -0
  63. data/docs/ProjectsApi.md +620 -0
  64. data/docs/QuotaCell.md +10 -0
  65. data/docs/QuotaCellFeasibility.md +9 -0
  66. data/docs/QuotaGroupData.md +9 -0
  67. data/docs/QuotaGroupFeasibility.md +8 -0
  68. data/docs/QuotaPlanData.md +9 -0
  69. data/docs/Reconcile.md +10 -0
  70. data/docs/ReconcileData.md +7 -0
  71. data/docs/RefreshTokenPayload.md +10 -0
  72. data/docs/Reprice.md +10 -0
  73. data/docs/RepriceData.md +22 -0
  74. data/docs/RepricePayload.md +20 -0
  75. data/docs/RespondentApi.md +86 -0
  76. data/docs/Status.md +9 -0
  77. data/docs/SupportedLanguage.md +10 -0
  78. data/docs/SurveyEndLinks.md +10 -0
  79. data/docs/SurveyTestId.md +10 -0
  80. data/docs/SurveyTestLink.md +9 -0
  81. data/docs/Target.md +11 -0
  82. data/docs/TargetingAttribute.md +10 -0
  83. data/docs/TokenMedia.md +11 -0
  84. data/docs/TokenPayload.md +11 -0
  85. data/docs/URLParam.md +9 -0
  86. data/docs/UpdateLineItem.md +21 -0
  87. data/docs/UpdateProjectData.md +13 -0
  88. data/docs/UpdateProjectLineItem.md +22 -0
  89. data/docs/UserInfo.md +10 -0
  90. data/docs/UserInfoResponseData.md +10 -0
  91. data/docs/UsersApi.md +68 -0
  92. data/examples/auth.rb +18 -0
  93. data/git_push.sh +55 -0
  94. data/lib/samplify_api_client/api/attributes_api.rb +111 -0
  95. data/lib/samplify_api_client/api/auth_api.rb +230 -0
  96. data/lib/samplify_api_client/api/categories_api.rb +99 -0
  97. data/lib/samplify_api_client/api/countries_api.rb +99 -0
  98. data/lib/samplify_api_client/api/default_api.rb +115 -0
  99. data/lib/samplify_api_client/api/events_api.rb +317 -0
  100. data/lib/samplify_api_client/api/feasibility_api.rb +75 -0
  101. data/lib/samplify_api_client/api/line_items_api.rb +468 -0
  102. data/lib/samplify_api_client/api/projects_api.rb +660 -0
  103. data/lib/samplify_api_client/api/respondent_api.rb +113 -0
  104. data/lib/samplify_api_client/api/users_api.rb +81 -0
  105. data/lib/samplify_api_client/api_client.rb +389 -0
  106. data/lib/samplify_api_client/api_error.rb +38 -0
  107. data/lib/samplify_api_client/configuration.rb +209 -0
  108. data/lib/samplify_api_client/models/app_error.rb +218 -0
  109. data/lib/samplify_api_client/models/application_item_data.rb +234 -0
  110. data/lib/samplify_api_client/models/attribute_data.rb +334 -0
  111. data/lib/samplify_api_client/models/attribute_option.rb +219 -0
  112. data/lib/samplify_api_client/models/attributes.rb +219 -0
  113. data/lib/samplify_api_client/models/auth_error.rb +205 -0
  114. data/lib/samplify_api_client/models/author.rb +253 -0
  115. data/lib/samplify_api_client/models/buy_project.rb +219 -0
  116. data/lib/samplify_api_client/models/buy_project_item.rb +243 -0
  117. data/lib/samplify_api_client/models/buy_project_response.rb +194 -0
  118. data/lib/samplify_api_client/models/buy_projects_payload.rb +174 -0
  119. data/lib/samplify_api_client/models/categories.rb +219 -0
  120. data/lib/samplify_api_client/models/category_data.rb +204 -0
  121. data/lib/samplify_api_client/models/code_payload.rb +229 -0
  122. data/lib/samplify_api_client/models/countries.rb +219 -0
  123. data/lib/samplify_api_client/models/country_data.rb +230 -0
  124. data/lib/samplify_api_client/models/create_line_item.rb +217 -0
  125. data/lib/samplify_api_client/models/end_links.rb +288 -0
  126. data/lib/samplify_api_client/models/error_type.rb +204 -0
  127. data/lib/samplify_api_client/models/event.rb +217 -0
  128. data/lib/samplify_api_client/models/event_data.rb +289 -0
  129. data/lib/samplify_api_client/models/event_list_data.rb +289 -0
  130. data/lib/samplify_api_client/models/events.rb +219 -0
  131. data/lib/samplify_api_client/models/exclusion_data.rb +206 -0
  132. data/lib/samplify_api_client/models/feasibility.rb +219 -0
  133. data/lib/samplify_api_client/models/feasibility_data.rb +255 -0
  134. data/lib/samplify_api_client/models/feasibility_response_data.rb +193 -0
  135. data/lib/samplify_api_client/models/line_item_action_response.rb +244 -0
  136. data/lib/samplify_api_client/models/line_item_data.rb +398 -0
  137. data/lib/samplify_api_client/models/line_item_item_data.rb +358 -0
  138. data/lib/samplify_api_client/models/line_item_report_data.rb +478 -0
  139. data/lib/samplify_api_client/models/line_item_response_data.rb +408 -0
  140. data/lib/samplify_api_client/models/line_items.rb +219 -0
  141. data/lib/samplify_api_client/models/links.rb +219 -0
  142. data/lib/samplify_api_client/models/logout_payload.rb +219 -0
  143. data/lib/samplify_api_client/models/meta.rb +203 -0
  144. data/lib/samplify_api_client/models/project.rb +273 -0
  145. data/lib/samplify_api_client/models/project_action.rb +217 -0
  146. data/lib/samplify_api_client/models/project_action_response.rb +236 -0
  147. data/lib/samplify_api_client/models/project_category_data.rb +191 -0
  148. data/lib/samplify_api_client/models/project_item_data.rb +307 -0
  149. data/lib/samplify_api_client/models/project_report.rb +217 -0
  150. data/lib/samplify_api_client/models/project_report_data.rb +414 -0
  151. data/lib/samplify_api_client/models/project_reports.rb +219 -0
  152. data/lib/samplify_api_client/models/project_response.rb +217 -0
  153. data/lib/samplify_api_client/models/project_response_data.rb +347 -0
  154. data/lib/samplify_api_client/models/project_survey_end_links.rb +217 -0
  155. data/lib/samplify_api_client/models/project_survey_end_links_data.rb +272 -0
  156. data/lib/samplify_api_client/models/projects.rb +219 -0
  157. data/lib/samplify_api_client/models/quota_cell.rb +206 -0
  158. data/lib/samplify_api_client/models/quota_cell_feasibility.rb +204 -0
  159. data/lib/samplify_api_client/models/quota_group_data.rb +201 -0
  160. data/lib/samplify_api_client/models/quota_group_feasibility.rb +185 -0
  161. data/lib/samplify_api_client/models/quota_plan_data.rb +198 -0
  162. data/lib/samplify_api_client/models/reconcile.rb +217 -0
  163. data/lib/samplify_api_client/models/reconcile_data.rb +174 -0
  164. data/lib/samplify_api_client/models/refresh_token_payload.rb +214 -0
  165. data/lib/samplify_api_client/models/reprice.rb +217 -0
  166. data/lib/samplify_api_client/models/reprice_data.rb +399 -0
  167. data/lib/samplify_api_client/models/reprice_payload.rb +369 -0
  168. data/lib/samplify_api_client/models/status.rb +206 -0
  169. data/lib/samplify_api_client/models/supported_language.rb +219 -0
  170. data/lib/samplify_api_client/models/survey_end_links.rb +216 -0
  171. data/lib/samplify_api_client/models/survey_test_id.rb +219 -0
  172. data/lib/samplify_api_client/models/survey_test_link.rb +206 -0
  173. data/lib/samplify_api_client/models/target.rb +258 -0
  174. data/lib/samplify_api_client/models/targeting_attribute.rb +216 -0
  175. data/lib/samplify_api_client/models/token_media.rb +235 -0
  176. data/lib/samplify_api_client/models/token_payload.rb +229 -0
  177. data/lib/samplify_api_client/models/update_line_item.rb +353 -0
  178. data/lib/samplify_api_client/models/update_project_data.rb +238 -0
  179. data/lib/samplify_api_client/models/update_project_line_item.rb +368 -0
  180. data/lib/samplify_api_client/models/url_param.rb +204 -0
  181. data/lib/samplify_api_client/models/user_info.rb +217 -0
  182. data/lib/samplify_api_client/models/user_info_response_data.rb +221 -0
  183. data/lib/samplify_api_client/version.rb +15 -0
  184. data/lib/samplify_api_client.rb +125 -0
  185. data/samplify_api_client.gemspec +45 -0
  186. data/spec/api/attributes_api_spec.rb +53 -0
  187. data/spec/api/auth_api_spec.rb +79 -0
  188. data/spec/api/categories_api_spec.rb +51 -0
  189. data/spec/api/countries_api_spec.rb +51 -0
  190. data/spec/api/default_api_spec.rb +55 -0
  191. data/spec/api/events_api_spec.rb +100 -0
  192. data/spec/api/feasibility_api_spec.rb +46 -0
  193. data/spec/api/line_items_api_spec.rb +128 -0
  194. data/spec/api/projects_api_spec.rb +168 -0
  195. data/spec/api/respondent_api_spec.rb +55 -0
  196. data/spec/api/users_api_spec.rb +49 -0
  197. data/spec/api_client_spec.rb +226 -0
  198. data/spec/configuration_spec.rb +42 -0
  199. data/spec/models/app_error_spec.rb +53 -0
  200. data/spec/models/application_item_data_spec.rb +59 -0
  201. data/spec/models/attribute_data_spec.rb +93 -0
  202. data/spec/models/attribute_option_spec.rb +53 -0
  203. data/spec/models/attributes_spec.rb +53 -0
  204. data/spec/models/auth_error_spec.rb +47 -0
  205. data/spec/models/author_spec.rb +57 -0
  206. data/spec/models/buy_project_item_spec.rb +65 -0
  207. data/spec/models/buy_project_response_spec.rb +47 -0
  208. data/spec/models/buy_project_spec.rb +53 -0
  209. data/spec/models/buy_projects_payload_spec.rb +35 -0
  210. data/spec/models/categories_spec.rb +53 -0
  211. data/spec/models/category_data_spec.rb +47 -0
  212. data/spec/models/code_payload_spec.rb +59 -0
  213. data/spec/models/countries_spec.rb +53 -0
  214. data/spec/models/country_data_spec.rb +59 -0
  215. data/spec/models/create_line_item_spec.rb +53 -0
  216. data/spec/models/end_links_spec.rb +75 -0
  217. data/spec/models/error_type_spec.rb +47 -0
  218. data/spec/models/event_data_spec.rb +83 -0
  219. data/spec/models/event_list_data_spec.rb +83 -0
  220. data/spec/models/event_spec.rb +53 -0
  221. data/spec/models/events_spec.rb +53 -0
  222. data/spec/models/exclusion_data_spec.rb +47 -0
  223. data/spec/models/feasibility_data_spec.rb +77 -0
  224. data/spec/models/feasibility_response_data_spec.rb +47 -0
  225. data/spec/models/feasibility_spec.rb +53 -0
  226. data/spec/models/line_item_action_response_spec.rb +77 -0
  227. data/spec/models/line_item_data_spec.rb +129 -0
  228. data/spec/models/line_item_item_data_spec.rb +99 -0
  229. data/spec/models/line_item_report_data_spec.rb +147 -0
  230. data/spec/models/line_item_response_data_spec.rb +159 -0
  231. data/spec/models/line_items_spec.rb +53 -0
  232. data/spec/models/links_spec.rb +65 -0
  233. data/spec/models/logout_payload_spec.rb +53 -0
  234. data/spec/models/meta_spec.rb +53 -0
  235. data/spec/models/project_action_response_spec.rb +71 -0
  236. data/spec/models/project_action_spec.rb +53 -0
  237. data/spec/models/project_category_data_spec.rb +41 -0
  238. data/spec/models/project_item_data_spec.rb +81 -0
  239. data/spec/models/project_report_data_spec.rb +123 -0
  240. data/spec/models/project_report_spec.rb +53 -0
  241. data/spec/models/project_reports_spec.rb +53 -0
  242. data/spec/models/project_response_data_spec.rb +107 -0
  243. data/spec/models/project_response_spec.rb +53 -0
  244. data/spec/models/project_spec.rb +77 -0
  245. data/spec/models/project_survey_end_links_data_spec.rb +69 -0
  246. data/spec/models/project_survey_end_links_spec.rb +53 -0
  247. data/spec/models/projects_spec.rb +53 -0
  248. data/spec/models/quota_cell_feasibility_spec.rb +47 -0
  249. data/spec/models/quota_cell_spec.rb +53 -0
  250. data/spec/models/quota_group_data_spec.rb +47 -0
  251. data/spec/models/quota_group_feasibility_spec.rb +41 -0
  252. data/spec/models/quota_plan_data_spec.rb +47 -0
  253. data/spec/models/reconcile_data_spec.rb +35 -0
  254. data/spec/models/reconcile_spec.rb +53 -0
  255. data/spec/models/refresh_token_payload_spec.rb +53 -0
  256. data/spec/models/reprice_data_spec.rb +125 -0
  257. data/spec/models/reprice_payload_spec.rb +113 -0
  258. data/spec/models/reprice_spec.rb +53 -0
  259. data/spec/models/status_spec.rb +47 -0
  260. data/spec/models/supported_language_spec.rb +53 -0
  261. data/spec/models/survey_end_links_spec.rb +53 -0
  262. data/spec/models/survey_test_id_spec.rb +53 -0
  263. data/spec/models/survey_test_link_spec.rb +47 -0
  264. data/spec/models/target_spec.rb +63 -0
  265. data/spec/models/targeting_attribute_spec.rb +53 -0
  266. data/spec/models/token_media_spec.rb +59 -0
  267. data/spec/models/token_payload_spec.rb +59 -0
  268. data/spec/models/update_line_item_spec.rb +123 -0
  269. data/spec/models/update_project_data_spec.rb +71 -0
  270. data/spec/models/update_project_line_item_spec.rb +129 -0
  271. data/spec/models/url_param_spec.rb +47 -0
  272. data/spec/models/user_info_response_data_spec.rb +53 -0
  273. data/spec/models/user_info_spec.rb +53 -0
  274. data/spec/spec_helper.rb +111 -0
  275. metadata +585 -0
@@ -0,0 +1,11 @@
1
+ # SamplifyAPIClient::CountryData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **country_name** | **String** | Unique country ID |
7
+ **id** | **String** | Unique country ID |
8
+ **iso_code** | **String** | ISO country code |
9
+ **supported_languages** | [**Array<SupportedLanguage>**](SupportedLanguage.md) | | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::CreateLineItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**LineItemResponseData**](LineItemResponseData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,88 @@
1
+ # SamplifyAPIClient::DefaultApi
2
+
3
+ All URIs are relative to *https://api.uat.pe.researchnow.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**swaggerswagger_json**](DefaultApi.md#swaggerswagger_json) | **GET** /swagger.json | Download public/swagger/swagger.json
8
+ [**swaggerswagger_yaml**](DefaultApi.md#swaggerswagger_yaml) | **GET** /swagger.yaml | Download public/swagger/swagger.yaml
9
+
10
+
11
+ # **swaggerswagger_json**
12
+ > File swaggerswagger_json
13
+
14
+ Download public/swagger/swagger.json
15
+
16
+ ### Example
17
+ ```ruby
18
+ # load the gem
19
+ require 'samplify_api_client'
20
+
21
+ api_instance = SamplifyAPIClient::DefaultApi.new
22
+
23
+ begin
24
+ #Download public/swagger/swagger.json
25
+ result = api_instance.swaggerswagger_json
26
+ p result
27
+ rescue SamplifyAPIClient::ApiError => e
28
+ puts "Exception when calling DefaultApi->swaggerswagger_json: #{e}"
29
+ end
30
+ ```
31
+
32
+ ### Parameters
33
+ This endpoint does not need any parameter.
34
+
35
+ ### Return type
36
+
37
+ **File**
38
+
39
+ ### Authorization
40
+
41
+ No authorization required
42
+
43
+ ### HTTP request headers
44
+
45
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
46
+ - **Accept**: application/json, application/xml, application/gob, application/x-gob
47
+
48
+
49
+
50
+ # **swaggerswagger_yaml**
51
+ > File swaggerswagger_yaml
52
+
53
+ Download public/swagger/swagger.yaml
54
+
55
+ ### Example
56
+ ```ruby
57
+ # load the gem
58
+ require 'samplify_api_client'
59
+
60
+ api_instance = SamplifyAPIClient::DefaultApi.new
61
+
62
+ begin
63
+ #Download public/swagger/swagger.yaml
64
+ result = api_instance.swaggerswagger_yaml
65
+ p result
66
+ rescue SamplifyAPIClient::ApiError => e
67
+ puts "Exception when calling DefaultApi->swaggerswagger_yaml: #{e}"
68
+ end
69
+ ```
70
+
71
+ ### Parameters
72
+ This endpoint does not need any parameter.
73
+
74
+ ### Return type
75
+
76
+ **File**
77
+
78
+ ### Authorization
79
+
80
+ No authorization required
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
85
+ - **Accept**: application/json, application/xml, application/gob, application/x-gob
86
+
87
+
88
+
data/docs/EndLinks.md ADDED
@@ -0,0 +1,13 @@
1
+ # SamplifyAPIClient::EndLinks
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **complete** | **String** | Complete link URL |
7
+ **overquota** | **String** | Over quota link URL |
8
+ **screenout** | **String** | Screen out link URL |
9
+ **security_key1** | **String** | Security Key 1 | [optional]
10
+ **security_key2** | **String** | Security Key 2 | [optional]
11
+ **security_level** | **String** | Security Level: NONE, BASIC, MEDIUM, or HIGH |
12
+
13
+
data/docs/ErrorType.md ADDED
@@ -0,0 +1,9 @@
1
+ # SamplifyAPIClient::ErrorType
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | Application-specific error code |
7
+ **message** | **String** | Human readable explanation specific to this problem |
8
+
9
+
data/docs/Event.md ADDED
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::Event
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**EventData**](EventData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
data/docs/EventData.md ADDED
@@ -0,0 +1,15 @@
1
+ # SamplifyAPIClient::EventData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **actions** | [****](.md) | Event actions | [optional]
7
+ **created_at** | **String** | Time event created at |
8
+ **event_id** | **Integer** | Unique event ID |
9
+ **event_type** | **String** | Event Type |
10
+ **ext_line_item_id** | **String** | A unique identifier for your Line Item |
11
+ **ext_project_id** | **String** | A unique identifier for your project |
12
+ **parent_event_id** | [****](.md) | Parent Event ID |
13
+ **resource** | [****](.md) | Event resource |
14
+
15
+
@@ -0,0 +1,15 @@
1
+ # SamplifyAPIClient::EventListData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **actions** | [****](.md) | Event actions | [optional]
7
+ **created_at** | **String** | Time event created at |
8
+ **event_id** | **Integer** | Unique event ID |
9
+ **event_type** | **String** | Event Type |
10
+ **ext_line_item_id** | **String** | A unique identifier for your Line Item |
11
+ **ext_project_id** | **String** | A unique identifier for your project |
12
+ **parent_event_id** | [****](.md) | Parent Event ID |
13
+ **resource** | [****](.md) | Event resource |
14
+
15
+
data/docs/Events.md ADDED
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::Events
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<EventListData>**](EventListData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
data/docs/EventsApi.md ADDED
@@ -0,0 +1,287 @@
1
+ # SamplifyAPIClient::EventsApi
2
+
3
+ All URIs are relative to *https://api.uat.pe.researchnow.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**events_accept**](EventsApi.md#events_accept) | **POST** /sample/v1/events/{eventId}/accept | accept events
8
+ [**events_get**](EventsApi.md#events_get) | **GET** /sample/v1/events/{eventId} | get events
9
+ [**events_list**](EventsApi.md#events_list) | **GET** /sample/v1/events | list events
10
+ [**events_reject**](EventsApi.md#events_reject) | **POST** /sample/v1/events/{eventId}/reject | reject events
11
+ [**events_reprice**](EventsApi.md#events_reprice) | **POST** /sample/v1/events/lineItems/reprice | reprice events
12
+
13
+
14
+ # **events_accept**
15
+ > Event events_accept(event_id)
16
+
17
+ accept events
18
+
19
+ Accept event
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'samplify_api_client'
25
+ # setup authorization
26
+ SamplifyAPIClient.configure do |config|
27
+ # Configure API key authorization: jwt
28
+ config.api_key['Authorization'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ #config.api_key_prefix['Authorization'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = SamplifyAPIClient::EventsApi.new
34
+
35
+ event_id = 56 # Integer | Event ID
36
+
37
+
38
+ begin
39
+ #accept events
40
+ result = api_instance.events_accept(event_id)
41
+ p result
42
+ rescue SamplifyAPIClient::ApiError => e
43
+ puts "Exception when calling EventsApi->events_accept: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **event_id** | **Integer**| Event ID |
52
+
53
+ ### Return type
54
+
55
+ [**Event**](Event.md)
56
+
57
+ ### Authorization
58
+
59
+ [jwt](../README.md#jwt)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
64
+ - **Accept**: application/vnd.event+json
65
+
66
+
67
+
68
+ # **events_get**
69
+ > Event events_get(event_id)
70
+
71
+ get events
72
+
73
+ Get event
74
+
75
+ ### Example
76
+ ```ruby
77
+ # load the gem
78
+ require 'samplify_api_client'
79
+ # setup authorization
80
+ SamplifyAPIClient.configure do |config|
81
+ # Configure API key authorization: jwt
82
+ config.api_key['Authorization'] = 'YOUR API KEY'
83
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
+ #config.api_key_prefix['Authorization'] = 'Bearer'
85
+ end
86
+
87
+ api_instance = SamplifyAPIClient::EventsApi.new
88
+
89
+ event_id = 56 # Integer | Event ID
90
+
91
+
92
+ begin
93
+ #get events
94
+ result = api_instance.events_get(event_id)
95
+ p result
96
+ rescue SamplifyAPIClient::ApiError => e
97
+ puts "Exception when calling EventsApi->events_get: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ Name | Type | Description | Notes
104
+ ------------- | ------------- | ------------- | -------------
105
+ **event_id** | **Integer**| Event ID |
106
+
107
+ ### Return type
108
+
109
+ [**Event**](Event.md)
110
+
111
+ ### Authorization
112
+
113
+ [jwt](../README.md#jwt)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
118
+ - **Accept**: application/vnd.event+json
119
+
120
+
121
+
122
+ # **events_list**
123
+ > Events events_list(opts)
124
+
125
+ list events
126
+
127
+ List events.
128
+
129
+ ### Example
130
+ ```ruby
131
+ # load the gem
132
+ require 'samplify_api_client'
133
+ # setup authorization
134
+ SamplifyAPIClient.configure do |config|
135
+ # Configure API key authorization: jwt
136
+ config.api_key['Authorization'] = 'YOUR API KEY'
137
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
138
+ #config.api_key_prefix['Authorization'] = 'Bearer'
139
+ end
140
+
141
+ api_instance = SamplifyAPIClient::EventsApi.new
142
+
143
+ opts = {
144
+ event_type: 'event_type_example', # String | Only return events with the given eventType
145
+ ext_line_item_id: 'ext_line_item_id_example', # String | Only return events with the given external line item id
146
+ ext_project_id: 'ext_project_id_example', # String | Only return events with the given external project id
147
+ limit: 10, # Integer | Maximum number of events to return
148
+ offset: 0, # Integer | The first zero-based offset event to return
149
+ sort: ['sort_example'] # Array<String> | Sort the events by the given key(s)
150
+ }
151
+
152
+ begin
153
+ #list events
154
+ result = api_instance.events_list(opts)
155
+ p result
156
+ rescue SamplifyAPIClient::ApiError => e
157
+ puts "Exception when calling EventsApi->events_list: #{e}"
158
+ end
159
+ ```
160
+
161
+ ### Parameters
162
+
163
+ Name | Type | Description | Notes
164
+ ------------- | ------------- | ------------- | -------------
165
+ **event_type** | **String**| Only return events with the given eventType | [optional]
166
+ **ext_line_item_id** | **String**| Only return events with the given external line item id | [optional]
167
+ **ext_project_id** | **String**| Only return events with the given external project id | [optional]
168
+ **limit** | **Integer**| Maximum number of events to return | [optional] [default to 10]
169
+ **offset** | **Integer**| The first zero-based offset event to return | [optional] [default to 0]
170
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the events by the given key(s) | [optional]
171
+
172
+ ### Return type
173
+
174
+ [**Events**](Events.md)
175
+
176
+ ### Authorization
177
+
178
+ [jwt](../README.md#jwt)
179
+
180
+ ### HTTP request headers
181
+
182
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
183
+ - **Accept**: application/vnd.events+json
184
+
185
+
186
+
187
+ # **events_reject**
188
+ > Event events_reject(event_id)
189
+
190
+ reject events
191
+
192
+ Reject event
193
+
194
+ ### Example
195
+ ```ruby
196
+ # load the gem
197
+ require 'samplify_api_client'
198
+ # setup authorization
199
+ SamplifyAPIClient.configure do |config|
200
+ # Configure API key authorization: jwt
201
+ config.api_key['Authorization'] = 'YOUR API KEY'
202
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
203
+ #config.api_key_prefix['Authorization'] = 'Bearer'
204
+ end
205
+
206
+ api_instance = SamplifyAPIClient::EventsApi.new
207
+
208
+ event_id = 56 # Integer | Event ID
209
+
210
+
211
+ begin
212
+ #reject events
213
+ result = api_instance.events_reject(event_id)
214
+ p result
215
+ rescue SamplifyAPIClient::ApiError => e
216
+ puts "Exception when calling EventsApi->events_reject: #{e}"
217
+ end
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ Name | Type | Description | Notes
223
+ ------------- | ------------- | ------------- | -------------
224
+ **event_id** | **Integer**| Event ID |
225
+
226
+ ### Return type
227
+
228
+ [**Event**](Event.md)
229
+
230
+ ### Authorization
231
+
232
+ [jwt](../README.md#jwt)
233
+
234
+ ### HTTP request headers
235
+
236
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
237
+ - **Accept**: application/vnd.event+json
238
+
239
+
240
+
241
+ # **events_reprice**
242
+ > Reprice events_reprice(payload)
243
+
244
+ reprice events
245
+
246
+ Line item repricing event.
247
+
248
+ ### Example
249
+ ```ruby
250
+ # load the gem
251
+ require 'samplify_api_client'
252
+
253
+ api_instance = SamplifyAPIClient::EventsApi.new
254
+
255
+ payload = SamplifyAPIClient::RepricePayload.new # RepricePayload |
256
+
257
+
258
+ begin
259
+ #reprice events
260
+ result = api_instance.events_reprice(payload)
261
+ p result
262
+ rescue SamplifyAPIClient::ApiError => e
263
+ puts "Exception when calling EventsApi->events_reprice: #{e}"
264
+ end
265
+ ```
266
+
267
+ ### Parameters
268
+
269
+ Name | Type | Description | Notes
270
+ ------------- | ------------- | ------------- | -------------
271
+ **payload** | [**RepricePayload**](RepricePayload.md)| |
272
+
273
+ ### Return type
274
+
275
+ [**Reprice**](Reprice.md)
276
+
277
+ ### Authorization
278
+
279
+ No authorization required
280
+
281
+ ### HTTP request headers
282
+
283
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
284
+ - **Accept**: application/vnd.reprice+json
285
+
286
+
287
+