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,9 @@
1
+ # SamplifyAPIClient::ExclusionData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **list** | **Array<String>** | List of all the type values |
7
+ **type** | **String** | Type of exclusion inclusion |
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::Feasibility
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<FeasibilityResponseData>**](FeasibilityResponseData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,61 @@
1
+ # SamplifyAPIClient::FeasibilityApi
2
+
3
+ All URIs are relative to *https://api.uat.pe.researchnow.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**feasibility_show**](FeasibilityApi.md#feasibility_show) | **GET** /sample/v1/projects/{extProjectId}/feasibility | show feasibility
8
+
9
+
10
+ # **feasibility_show**
11
+ > Feasibility feasibility_show(ext_project_id)
12
+
13
+ show feasibility
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'samplify_api_client'
19
+ # setup authorization
20
+ SamplifyAPIClient.configure do |config|
21
+ # Configure API key authorization: jwt
22
+ config.api_key['Authorization'] = 'YOUR API KEY'
23
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
24
+ #config.api_key_prefix['Authorization'] = 'Bearer'
25
+ end
26
+
27
+ api_instance = SamplifyAPIClient::FeasibilityApi.new
28
+
29
+ ext_project_id = 'ext_project_id_example' # String |
30
+
31
+
32
+ begin
33
+ #show feasibility
34
+ result = api_instance.feasibility_show(ext_project_id)
35
+ p result
36
+ rescue SamplifyAPIClient::ApiError => e
37
+ puts "Exception when calling FeasibilityApi->feasibility_show: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **ext_project_id** | **String**| |
46
+
47
+ ### Return type
48
+
49
+ [**Feasibility**](Feasibility.md)
50
+
51
+ ### Authorization
52
+
53
+ [jwt](../README.md#jwt)
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
58
+ - **Accept**: application/vnd.feasibility+json
59
+
60
+
61
+
@@ -0,0 +1,14 @@
1
+ # SamplifyAPIClient::FeasibilityData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cost_per_interview** | **Float** | Amount Research Now SSI will be paid for each delivered complete | [optional]
7
+ **currency** | **String** | Currency associated with the costPerInterview | [optional]
8
+ **expiry** | **String** | Time stamp of the expiry of the feasibility of the lineitem. | [optional]
9
+ **feasible** | **BOOLEAN** | Can the system deliver the requiredCompletes | [optional]
10
+ **status** | **String** | Current state of feasibility for line item | [optional]
11
+ **total_count** | **Integer** | |
12
+ **value_counts** | [**Array<QuotaGroupFeasibility>**](QuotaGroupFeasibility.md) | Number of possible completes for each panelist attribute broken down for male and female |
13
+
14
+
@@ -0,0 +1,9 @@
1
+ # SamplifyAPIClient::FeasibilityResponseData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **ext_line_item_id** | **String** | A unique identifier for your Line Item | [optional]
7
+ **feasibility** | [**FeasibilityData**](FeasibilityData.md) | | [optional]
8
+
9
+
@@ -0,0 +1,14 @@
1
+ # SamplifyAPIClient::LineItemActionResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **created_at** | **String** | Timestamp of when the line item was created | [optional]
7
+ **ext_line_item_id** | **String** | Unique line item Id | [optional]
8
+ **launched_at** | **String** | Timestamp of when the line item launched on RN SSI panelists | [optional]
9
+ **state** | **String** | Unique line item Id | [optional]
10
+ **state_last_updated_at** | **String** | Timestamp of when the line item last changed its state | [optional]
11
+ **state_reason** | **String** | Reason for the current state of the line item | [optional]
12
+ **updated_at** | **String** | Timestamp of when the line item was updated | [optional]
13
+
14
+
@@ -0,0 +1,22 @@
1
+ # SamplifyAPIClient::LineItemData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **country_iso_code** | **String** | ISO country code |
7
+ **days_in_field** | **Integer** | Duration of the project in days. |
8
+ **delivery_type** | **String** | Delivery type: SLOW, BALANCED,FAST or BURST. | [optional]
9
+ **ext_line_item_id** | **String** | Unique line item Id |
10
+ **indicative_incidence** | **Float** | Expected incidence of the survey |
11
+ **language_iso_code** | **String** | ISO language code |
12
+ **length_of_interview** | **Integer** | expected duration of the survey in minutes |
13
+ **quota_plan** | [**QuotaPlanData**](QuotaPlanData.md) | | [optional]
14
+ **required_completes** | **Integer** | Number of complete required for the line item | [optional]
15
+ **survey_test_url** | **String** | Entry link for the user. | [optional]
16
+ **survey_test_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyTestURL Params of the line item. | [optional]
17
+ **survey_url** | **String** | Entry link for the user. | [optional]
18
+ **survey_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyURL Params of the line item. | [optional]
19
+ **targets** | [**Array<Target>**](Target.md) | Data of completes/starts required for the line item | [optional]
20
+ **title** | **String** | A title for the line item |
21
+
22
+
@@ -0,0 +1,17 @@
1
+ # SamplifyAPIClient::LineItemItemData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **country_iso_code** | **String** | 2 letter ISO Country Code |
7
+ **created_at** | **String** | Timestamp of when the line item was created |
8
+ **ext_line_item_id** | **String** | A unique identifier for your Line Item |
9
+ **language_iso_code** | **String** | 2 letter ISO Language Code |
10
+ **launched_at** | [****](.md) | Timestamp of when the line item launched on RN SSI panelists |
11
+ **state** | **String** | The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED |
12
+ **state_last_updated_at** | **String** | Timestamp of when the line item last changed its state |
13
+ **state_reason** | **String** | Reason for the current state of the line item |
14
+ **title** | **String** | A Line Item title |
15
+ **updated_at** | **String** | Timestamp of when the line item was updated |
16
+
17
+
@@ -0,0 +1,25 @@
1
+ # SamplifyAPIClient::LineItemReportData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **actual_median_loi** | **Integer** | Calculated median length of interview from actual panelists |
7
+ **attempts** | **Integer** | Total number of panelists that entered the project |
8
+ **completes** | **Integer** | Total number of panelists that completed the project |
9
+ **conversion** | **Float** | Ratio of completes over attempts. (ranges from 0-1) |
10
+ **country_iso_code** | **String** | ISO country code |
11
+ **currency** | **String** | Currency ISO code |
12
+ **estimated_cost** | **Float** | Total estimated cost |
13
+ **ext_line_item_id** | **String** | A unique identifier for your Line Item |
14
+ **incurred_cost** | **Float** | Total incurred cost |
15
+ **language_iso_code** | **String** | ISO language code |
16
+ **last_accepted_incidence_rate** | **Float** | Last accepted incidence rate |
17
+ **last_accepted_loi** | **Integer** | Last accepted length of interview |
18
+ **overquotas** | **Integer** | Total number of panelists that triggered an overquota for the project |
19
+ **remaining_completes** | **Integer** | Total remaining completes for the project |
20
+ **screenouts** | **Integer** | Total number of panelists that got screened out of the project |
21
+ **state** | **String** | The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED |
22
+ **state_reason** | **String** | The current state reason of the project |
23
+ **title** | **String** | LineItem title |
24
+
25
+
@@ -0,0 +1,27 @@
1
+ # SamplifyAPIClient::LineItemResponseData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **country_iso_code** | **String** | ISO country code | [optional]
7
+ **created_at** | **String** | created time. | [optional]
8
+ **days_in_field** | **Integer** | Duration of the project in days. | [optional]
9
+ **delivery_type** | **String** | Delivery type: SLOW, BALANCED, FAST or BURST. | [optional]
10
+ **end_links** | [**EndLinks**](EndLinks.md) | | [optional]
11
+ **ext_line_item_id** | **String** | Unique line item Id | [optional]
12
+ **indicative_incidence** | **Float** | Expected incidence of the survey | [optional]
13
+ **language_iso_code** | **String** | ISO language code | [optional]
14
+ **launched_at** | **String** | launched time. | [optional]
15
+ **length_of_interview** | **Integer** | expected duration of the survey in minutes | [optional]
16
+ **quota_plan** | [**QuotaPlanData**](QuotaPlanData.md) | | [optional]
17
+ **required_completes** | **Integer** | Number of complete required for the line item | [optional]
18
+ **state** | **String** | state | [optional]
19
+ **state_last_updated_at** | **String** | state last updated at. | [optional]
20
+ **state_reason** | **String** | state reason | [optional]
21
+ **survey_test_url** | **String** | Entry link for the user. | [optional]
22
+ **survey_url** | **String** | Entry link for the user. | [optional]
23
+ **targets** | [**Array<Target>**](Target.md) | Data of completes/starts required for the line item | [optional]
24
+ **title** | **String** | A title for the line item | [optional]
25
+ **updated_at** | **String** | updated time. | [optional]
26
+
27
+
data/docs/LineItems.md ADDED
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::LineItems
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<LineItemItemData>**](LineItemItemData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,420 @@
1
+ # SamplifyAPIClient::LineItemsApi
2
+
3
+ All URIs are relative to *https://api.uat.pe.researchnow.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**line_items_close**](LineItemsApi.md#line_items_close) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/close | close lineItems
8
+ [**line_items_create**](LineItemsApi.md#line_items_create) | **POST** /sample/v1/projects/{extProjectId}/lineItems | create lineItems
9
+ [**line_items_get**](LineItemsApi.md#line_items_get) | **GET** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId} | get lineItems
10
+ [**line_items_launch**](LineItemsApi.md#line_items_launch) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/launch | launch lineItems
11
+ [**line_items_list_line_items**](LineItemsApi.md#line_items_list_line_items) | **GET** /sample/v1/projects/{extProjectId}/lineItems | listLineItems lineItems
12
+ [**line_items_pause**](LineItemsApi.md#line_items_pause) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/pause | pause lineItems
13
+ [**line_items_update**](LineItemsApi.md#line_items_update) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId} | update lineItems
14
+
15
+
16
+ # **line_items_close**
17
+ > CreateLineItem line_items_close(ext_line_item_id, ext_project_id)
18
+
19
+ close lineItems
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::LineItemsApi.new
34
+
35
+ ext_line_item_id = 'ext_line_item_id_example' # String |
36
+
37
+ ext_project_id = 'ext_project_id_example' # String |
38
+
39
+
40
+ begin
41
+ #close lineItems
42
+ result = api_instance.line_items_close(ext_line_item_id, ext_project_id)
43
+ p result
44
+ rescue SamplifyAPIClient::ApiError => e
45
+ puts "Exception when calling LineItemsApi->line_items_close: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **ext_line_item_id** | **String**| |
54
+ **ext_project_id** | **String**| |
55
+
56
+ ### Return type
57
+
58
+ [**CreateLineItem**](CreateLineItem.md)
59
+
60
+ ### Authorization
61
+
62
+ [jwt](../README.md#jwt)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
67
+ - **Accept**: application/vnd.createlineitem+json
68
+
69
+
70
+
71
+ # **line_items_create**
72
+ > CreateLineItem line_items_create(ext_project_id, payload)
73
+
74
+ create lineItems
75
+
76
+ ### Example
77
+ ```ruby
78
+ # load the gem
79
+ require 'samplify_api_client'
80
+ # setup authorization
81
+ SamplifyAPIClient.configure do |config|
82
+ # Configure API key authorization: jwt
83
+ config.api_key['Authorization'] = 'YOUR API KEY'
84
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
85
+ #config.api_key_prefix['Authorization'] = 'Bearer'
86
+ end
87
+
88
+ api_instance = SamplifyAPIClient::LineItemsApi.new
89
+
90
+ ext_project_id = 'ext_project_id_example' # String |
91
+
92
+ payload = SamplifyAPIClient::LineItemData.new # LineItemData |
93
+
94
+
95
+ begin
96
+ #create lineItems
97
+ result = api_instance.line_items_create(ext_project_id, payload)
98
+ p result
99
+ rescue SamplifyAPIClient::ApiError => e
100
+ puts "Exception when calling LineItemsApi->line_items_create: #{e}"
101
+ end
102
+ ```
103
+
104
+ ### Parameters
105
+
106
+ Name | Type | Description | Notes
107
+ ------------- | ------------- | ------------- | -------------
108
+ **ext_project_id** | **String**| |
109
+ **payload** | [**LineItemData**](LineItemData.md)| |
110
+
111
+ ### Return type
112
+
113
+ [**CreateLineItem**](CreateLineItem.md)
114
+
115
+ ### Authorization
116
+
117
+ [jwt](../README.md#jwt)
118
+
119
+ ### HTTP request headers
120
+
121
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
122
+ - **Accept**: application/vnd.createlineitem+json
123
+
124
+
125
+
126
+ # **line_items_get**
127
+ > CreateLineItem line_items_get(ext_line_item_id, ext_project_id)
128
+
129
+ get lineItems
130
+
131
+ ### Example
132
+ ```ruby
133
+ # load the gem
134
+ require 'samplify_api_client'
135
+ # setup authorization
136
+ SamplifyAPIClient.configure do |config|
137
+ # Configure API key authorization: jwt
138
+ config.api_key['Authorization'] = 'YOUR API KEY'
139
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
140
+ #config.api_key_prefix['Authorization'] = 'Bearer'
141
+ end
142
+
143
+ api_instance = SamplifyAPIClient::LineItemsApi.new
144
+
145
+ ext_line_item_id = 'ext_line_item_id_example' # String |
146
+
147
+ ext_project_id = 'ext_project_id_example' # String |
148
+
149
+
150
+ begin
151
+ #get lineItems
152
+ result = api_instance.line_items_get(ext_line_item_id, ext_project_id)
153
+ p result
154
+ rescue SamplifyAPIClient::ApiError => e
155
+ puts "Exception when calling LineItemsApi->line_items_get: #{e}"
156
+ end
157
+ ```
158
+
159
+ ### Parameters
160
+
161
+ Name | Type | Description | Notes
162
+ ------------- | ------------- | ------------- | -------------
163
+ **ext_line_item_id** | **String**| |
164
+ **ext_project_id** | **String**| |
165
+
166
+ ### Return type
167
+
168
+ [**CreateLineItem**](CreateLineItem.md)
169
+
170
+ ### Authorization
171
+
172
+ [jwt](../README.md#jwt)
173
+
174
+ ### HTTP request headers
175
+
176
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
177
+ - **Accept**: application/vnd.createlineitem+json
178
+
179
+
180
+
181
+ # **line_items_launch**
182
+ > CreateLineItem line_items_launch(ext_line_item_id, ext_project_id)
183
+
184
+ launch lineItems
185
+
186
+ ### Example
187
+ ```ruby
188
+ # load the gem
189
+ require 'samplify_api_client'
190
+ # setup authorization
191
+ SamplifyAPIClient.configure do |config|
192
+ # Configure API key authorization: jwt
193
+ config.api_key['Authorization'] = 'YOUR API KEY'
194
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
195
+ #config.api_key_prefix['Authorization'] = 'Bearer'
196
+ end
197
+
198
+ api_instance = SamplifyAPIClient::LineItemsApi.new
199
+
200
+ ext_line_item_id = 'ext_line_item_id_example' # String |
201
+
202
+ ext_project_id = 'ext_project_id_example' # String |
203
+
204
+
205
+ begin
206
+ #launch lineItems
207
+ result = api_instance.line_items_launch(ext_line_item_id, ext_project_id)
208
+ p result
209
+ rescue SamplifyAPIClient::ApiError => e
210
+ puts "Exception when calling LineItemsApi->line_items_launch: #{e}"
211
+ end
212
+ ```
213
+
214
+ ### Parameters
215
+
216
+ Name | Type | Description | Notes
217
+ ------------- | ------------- | ------------- | -------------
218
+ **ext_line_item_id** | **String**| |
219
+ **ext_project_id** | **String**| |
220
+
221
+ ### Return type
222
+
223
+ [**CreateLineItem**](CreateLineItem.md)
224
+
225
+ ### Authorization
226
+
227
+ [jwt](../README.md#jwt)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
232
+ - **Accept**: application/vnd.createlineitem+json
233
+
234
+
235
+
236
+ # **line_items_list_line_items**
237
+ > LineItems line_items_list_line_items(ext_project_id, opts)
238
+
239
+ listLineItems lineItems
240
+
241
+ ### Example
242
+ ```ruby
243
+ # load the gem
244
+ require 'samplify_api_client'
245
+ # setup authorization
246
+ SamplifyAPIClient.configure do |config|
247
+ # Configure API key authorization: jwt
248
+ config.api_key['Authorization'] = 'YOUR API KEY'
249
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
250
+ #config.api_key_prefix['Authorization'] = 'Bearer'
251
+ end
252
+
253
+ api_instance = SamplifyAPIClient::LineItemsApi.new
254
+
255
+ ext_project_id = 'ext_project_id_example' # String | External Project ID
256
+
257
+ opts = {
258
+ country_iso_code: 'country_iso_code_example', # String | Only return line items with the given country ISO Code
259
+ ext_line_item_id: 'ext_line_item_id_example', # String | Only return line items with the given extLineItemId
260
+ language_iso_code: 'language_iso_code_example', # String | Only return line items with the given language ISO Code
261
+ limit: 10, # Integer | Maximum number of line items to return
262
+ offset: 0, # Integer | The first zero-based offset line item to return
263
+ sort: ['sort_example'], # Array<String> | Sort the line items by the given key(s)
264
+ state: 'state_example', # String | Only return lineitems with the given state
265
+ state_reason: 'state_reason_example', # String | Only return line items with the given state reason
266
+ title: 'title_example' # String | Only return line items with the given title
267
+ }
268
+
269
+ begin
270
+ #listLineItems lineItems
271
+ result = api_instance.line_items_list_line_items(ext_project_id, opts)
272
+ p result
273
+ rescue SamplifyAPIClient::ApiError => e
274
+ puts "Exception when calling LineItemsApi->line_items_list_line_items: #{e}"
275
+ end
276
+ ```
277
+
278
+ ### Parameters
279
+
280
+ Name | Type | Description | Notes
281
+ ------------- | ------------- | ------------- | -------------
282
+ **ext_project_id** | **String**| External Project ID |
283
+ **country_iso_code** | **String**| Only return line items with the given country ISO Code | [optional]
284
+ **ext_line_item_id** | **String**| Only return line items with the given extLineItemId | [optional]
285
+ **language_iso_code** | **String**| Only return line items with the given language ISO Code | [optional]
286
+ **limit** | **Integer**| Maximum number of line items to return | [optional] [default to 10]
287
+ **offset** | **Integer**| The first zero-based offset line item to return | [optional] [default to 0]
288
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the line items by the given key(s) | [optional]
289
+ **state** | **String**| Only return lineitems with the given state | [optional]
290
+ **state_reason** | **String**| Only return line items with the given state reason | [optional]
291
+ **title** | **String**| Only return line items with the given title | [optional]
292
+
293
+ ### Return type
294
+
295
+ [**LineItems**](LineItems.md)
296
+
297
+ ### Authorization
298
+
299
+ [jwt](../README.md#jwt)
300
+
301
+ ### HTTP request headers
302
+
303
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
304
+ - **Accept**: application/vnd.lineitems+json
305
+
306
+
307
+
308
+ # **line_items_pause**
309
+ > CreateLineItem line_items_pause(ext_line_item_id, ext_project_id)
310
+
311
+ pause lineItems
312
+
313
+ ### Example
314
+ ```ruby
315
+ # load the gem
316
+ require 'samplify_api_client'
317
+ # setup authorization
318
+ SamplifyAPIClient.configure do |config|
319
+ # Configure API key authorization: jwt
320
+ config.api_key['Authorization'] = 'YOUR API KEY'
321
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
322
+ #config.api_key_prefix['Authorization'] = 'Bearer'
323
+ end
324
+
325
+ api_instance = SamplifyAPIClient::LineItemsApi.new
326
+
327
+ ext_line_item_id = 'ext_line_item_id_example' # String |
328
+
329
+ ext_project_id = 'ext_project_id_example' # String |
330
+
331
+
332
+ begin
333
+ #pause lineItems
334
+ result = api_instance.line_items_pause(ext_line_item_id, ext_project_id)
335
+ p result
336
+ rescue SamplifyAPIClient::ApiError => e
337
+ puts "Exception when calling LineItemsApi->line_items_pause: #{e}"
338
+ end
339
+ ```
340
+
341
+ ### Parameters
342
+
343
+ Name | Type | Description | Notes
344
+ ------------- | ------------- | ------------- | -------------
345
+ **ext_line_item_id** | **String**| |
346
+ **ext_project_id** | **String**| |
347
+
348
+ ### Return type
349
+
350
+ [**CreateLineItem**](CreateLineItem.md)
351
+
352
+ ### Authorization
353
+
354
+ [jwt](../README.md#jwt)
355
+
356
+ ### HTTP request headers
357
+
358
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
359
+ - **Accept**: application/vnd.createlineitem+json
360
+
361
+
362
+
363
+ # **line_items_update**
364
+ > CreateLineItem line_items_update(ext_line_item_id, ext_project_id, payload)
365
+
366
+ update lineItems
367
+
368
+ ### Example
369
+ ```ruby
370
+ # load the gem
371
+ require 'samplify_api_client'
372
+ # setup authorization
373
+ SamplifyAPIClient.configure do |config|
374
+ # Configure API key authorization: jwt
375
+ config.api_key['Authorization'] = 'YOUR API KEY'
376
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
377
+ #config.api_key_prefix['Authorization'] = 'Bearer'
378
+ end
379
+
380
+ api_instance = SamplifyAPIClient::LineItemsApi.new
381
+
382
+ ext_line_item_id = 'ext_line_item_id_example' # String |
383
+
384
+ ext_project_id = 'ext_project_id_example' # String |
385
+
386
+ payload = SamplifyAPIClient::UpdateLineItem.new # UpdateLineItem |
387
+
388
+
389
+ begin
390
+ #update lineItems
391
+ result = api_instance.line_items_update(ext_line_item_id, ext_project_id, payload)
392
+ p result
393
+ rescue SamplifyAPIClient::ApiError => e
394
+ puts "Exception when calling LineItemsApi->line_items_update: #{e}"
395
+ end
396
+ ```
397
+
398
+ ### Parameters
399
+
400
+ Name | Type | Description | Notes
401
+ ------------- | ------------- | ------------- | -------------
402
+ **ext_line_item_id** | **String**| |
403
+ **ext_project_id** | **String**| |
404
+ **payload** | [**UpdateLineItem**](UpdateLineItem.md)| |
405
+
406
+ ### Return type
407
+
408
+ [**CreateLineItem**](CreateLineItem.md)
409
+
410
+ ### Authorization
411
+
412
+ [jwt](../README.md#jwt)
413
+
414
+ ### HTTP request headers
415
+
416
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
417
+ - **Accept**: application/vnd.createlineitem+json
418
+
419
+
420
+