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
data/docs/AuthApi.md ADDED
@@ -0,0 +1,191 @@
1
+ # SamplifyAPIClient::AuthApi
2
+
3
+ All URIs are relative to *https://api.uat.pe.researchnow.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**auth_code**](AuthApi.md#auth_code) | **POST** /auth/v1/token/code | code auth
8
+ [**auth_logout**](AuthApi.md#auth_logout) | **POST** /auth/v1/logout | logout auth
9
+ [**auth_password**](AuthApi.md#auth_password) | **POST** /auth/v1/token/password | password auth
10
+ [**auth_refresh**](AuthApi.md#auth_refresh) | **POST** /auth/v1/token/refresh | refresh auth
11
+
12
+
13
+ # **auth_code**
14
+ > TokenMedia auth_code(payload)
15
+
16
+ code auth
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'samplify_api_client'
22
+
23
+ api_instance = SamplifyAPIClient::AuthApi.new
24
+
25
+ payload = SamplifyAPIClient::CodePayload.new # CodePayload |
26
+
27
+
28
+ begin
29
+ #code auth
30
+ result = api_instance.auth_code(payload)
31
+ p result
32
+ rescue SamplifyAPIClient::ApiError => e
33
+ puts "Exception when calling AuthApi->auth_code: #{e}"
34
+ end
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ Name | Type | Description | Notes
40
+ ------------- | ------------- | ------------- | -------------
41
+ **payload** | [**CodePayload**](CodePayload.md)| |
42
+
43
+ ### Return type
44
+
45
+ [**TokenMedia**](TokenMedia.md)
46
+
47
+ ### Authorization
48
+
49
+ No authorization required
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
54
+ - **Accept**: application/vnd.auth.error+json, application/vnd.token+json
55
+
56
+
57
+
58
+ # **auth_logout**
59
+ > auth_logout(payload)
60
+
61
+ logout auth
62
+
63
+ ### Example
64
+ ```ruby
65
+ # load the gem
66
+ require 'samplify_api_client'
67
+
68
+ api_instance = SamplifyAPIClient::AuthApi.new
69
+
70
+ payload = SamplifyAPIClient::LogoutPayload.new # LogoutPayload |
71
+
72
+
73
+ begin
74
+ #logout auth
75
+ api_instance.auth_logout(payload)
76
+ rescue SamplifyAPIClient::ApiError => e
77
+ puts "Exception when calling AuthApi->auth_logout: #{e}"
78
+ end
79
+ ```
80
+
81
+ ### Parameters
82
+
83
+ Name | Type | Description | Notes
84
+ ------------- | ------------- | ------------- | -------------
85
+ **payload** | [**LogoutPayload**](LogoutPayload.md)| |
86
+
87
+ ### Return type
88
+
89
+ nil (empty response body)
90
+
91
+ ### Authorization
92
+
93
+ No authorization required
94
+
95
+ ### HTTP request headers
96
+
97
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
98
+ - **Accept**: application/vnd.auth.error+json
99
+
100
+
101
+
102
+ # **auth_password**
103
+ > TokenMedia auth_password(payload)
104
+
105
+ password auth
106
+
107
+ ### Example
108
+ ```ruby
109
+ # load the gem
110
+ require 'samplify_api_client'
111
+
112
+ api_instance = SamplifyAPIClient::AuthApi.new
113
+
114
+ payload = SamplifyAPIClient::TokenPayload.new # TokenPayload |
115
+
116
+
117
+ begin
118
+ #password auth
119
+ result = api_instance.auth_password(payload)
120
+ p result
121
+ rescue SamplifyAPIClient::ApiError => e
122
+ puts "Exception when calling AuthApi->auth_password: #{e}"
123
+ end
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+ Name | Type | Description | Notes
129
+ ------------- | ------------- | ------------- | -------------
130
+ **payload** | [**TokenPayload**](TokenPayload.md)| |
131
+
132
+ ### Return type
133
+
134
+ [**TokenMedia**](TokenMedia.md)
135
+
136
+ ### Authorization
137
+
138
+ No authorization required
139
+
140
+ ### HTTP request headers
141
+
142
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
143
+ - **Accept**: application/vnd.auth.error+json, application/vnd.token+json
144
+
145
+
146
+
147
+ # **auth_refresh**
148
+ > TokenMedia auth_refresh(payload)
149
+
150
+ refresh auth
151
+
152
+ ### Example
153
+ ```ruby
154
+ # load the gem
155
+ require 'samplify_api_client'
156
+
157
+ api_instance = SamplifyAPIClient::AuthApi.new
158
+
159
+ payload = SamplifyAPIClient::RefreshTokenPayload.new # RefreshTokenPayload |
160
+
161
+
162
+ begin
163
+ #refresh auth
164
+ result = api_instance.auth_refresh(payload)
165
+ p result
166
+ rescue SamplifyAPIClient::ApiError => e
167
+ puts "Exception when calling AuthApi->auth_refresh: #{e}"
168
+ end
169
+ ```
170
+
171
+ ### Parameters
172
+
173
+ Name | Type | Description | Notes
174
+ ------------- | ------------- | ------------- | -------------
175
+ **payload** | [**RefreshTokenPayload**](RefreshTokenPayload.md)| |
176
+
177
+ ### Return type
178
+
179
+ [**TokenMedia**](TokenMedia.md)
180
+
181
+ ### Authorization
182
+
183
+ No authorization required
184
+
185
+ ### HTTP request headers
186
+
187
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
188
+ - **Accept**: application/vnd.auth.error+json, application/vnd.token+json
189
+
190
+
191
+
data/docs/AuthError.md ADDED
@@ -0,0 +1,9 @@
1
+ # SamplifyAPIClient::AuthError
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | **String** | Error code |
7
+ **error_description** | **String** | Error description |
8
+
9
+
data/docs/Author.md ADDED
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::Author
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of author |
7
+ **type** | **String** | User type descriptor |
8
+ **username** | **String** | Username of author |
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::BuyProject
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<BuyProjectResponse>**](BuyProjectResponse.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,12 @@
1
+ # SamplifyAPIClient::BuyProjectItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **ext_line_item_id** | **String** | A unique identifier for your Line Item |
7
+ **survey_test_url** | **String** | Survey Test URL. Required for survey verification |
8
+ **survey_test_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyTestURL Params of the line item. | [optional]
9
+ **survey_url** | **String** | Survey URL to send panelist into |
10
+ **survey_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyURL Params of the line item. | [optional]
11
+
12
+
@@ -0,0 +1,9 @@
1
+ # SamplifyAPIClient::BuyProjectResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **ext_line_item_id** | **String** | A unique identifier for your Line Item | [optional]
7
+ **state** | **String** | The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED | [optional]
8
+
9
+
@@ -0,0 +1,7 @@
1
+ # SamplifyAPIClient::BuyProjectsPayload
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
7
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::Categories
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<CategoryData>**](CategoryData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,72 @@
1
+ # SamplifyAPIClient::CategoriesApi
2
+
3
+ All URIs are relative to *https://api.uat.pe.researchnow.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**categories_list**](CategoriesApi.md#categories_list) | **GET** /sample/v1/categories/surveyTopics | list categories
8
+
9
+
10
+ # **categories_list**
11
+ > Categories categories_list(opts)
12
+
13
+ list categories
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::CategoriesApi.new
28
+
29
+ opts = {
30
+ description: 'description_example', # String | Only return categories with the given description
31
+ id: 'id_example', # String | Only return categories with the given id
32
+ limit: 10, # Integer | Maximum number of categories to return
33
+ name: 'name_example', # String | Only return categories with the given name
34
+ offset: 0, # Integer | The first zero-based offset category to return
35
+ sort: ['sort_example'] # Array<String> | Sort the categories by the given key(s)
36
+ }
37
+
38
+ begin
39
+ #list categories
40
+ result = api_instance.categories_list(opts)
41
+ p result
42
+ rescue SamplifyAPIClient::ApiError => e
43
+ puts "Exception when calling CategoriesApi->categories_list: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **description** | **String**| Only return categories with the given description | [optional]
52
+ **id** | **String**| Only return categories with the given id | [optional]
53
+ **limit** | **Integer**| Maximum number of categories to return | [optional] [default to 10]
54
+ **name** | **String**| Only return categories with the given name | [optional]
55
+ **offset** | **Integer**| The first zero-based offset category to return | [optional] [default to 0]
56
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the categories by the given key(s) | [optional]
57
+
58
+ ### Return type
59
+
60
+ [**Categories**](Categories.md)
61
+
62
+ ### Authorization
63
+
64
+ [jwt](../README.md#jwt)
65
+
66
+ ### HTTP request headers
67
+
68
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
69
+ - **Accept**: application/vnd.categories+json
70
+
71
+
72
+
@@ -0,0 +1,9 @@
1
+ # SamplifyAPIClient::CategoryData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **description** | **String** | Category Description |
7
+ **topic** | **String** | Category Enum |
8
+
9
+
@@ -0,0 +1,11 @@
1
+ # SamplifyAPIClient::CodePayload
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **client_id** | **String** | Client ID |
7
+ **client_secret** | **String** | Client Secret | [optional]
8
+ **code** | **String** | Authorization Code |
9
+ **redirect_uri** | **String** | Redirect URI |
10
+
11
+
data/docs/Countries.md ADDED
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::Countries
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array&lt;CountryData&gt;**](CountryData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,72 @@
1
+ # SamplifyAPIClient::CountriesApi
2
+
3
+ All URIs are relative to *https://api.uat.pe.researchnow.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**countries_list**](CountriesApi.md#countries_list) | **GET** /sample/v1/countries | list countries
8
+
9
+
10
+ # **countries_list**
11
+ > Countries countries_list(opts)
12
+
13
+ list countries
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::CountriesApi.new
28
+
29
+ opts = {
30
+ country_name: 'country_name_example', # String | Only return countries with the given name
31
+ id: 'id_example', # String | Only return countries with the given id
32
+ iso_code: 'iso_code_example', # String | Only return countries with the given ISO code
33
+ limit: 10, # Integer | Maximum number of countries to return
34
+ offset: 0, # Integer | The first zero-based offset country to return
35
+ sort: ['sort_example'] # Array<String> | Sort the countries by the given key(s)
36
+ }
37
+
38
+ begin
39
+ #list countries
40
+ result = api_instance.countries_list(opts)
41
+ p result
42
+ rescue SamplifyAPIClient::ApiError => e
43
+ puts "Exception when calling CountriesApi->countries_list: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **country_name** | **String**| Only return countries with the given name | [optional]
52
+ **id** | **String**| Only return countries with the given id | [optional]
53
+ **iso_code** | **String**| Only return countries with the given ISO code | [optional]
54
+ **limit** | **Integer**| Maximum number of countries to return | [optional] [default to 10]
55
+ **offset** | **Integer**| The first zero-based offset country to return | [optional] [default to 0]
56
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the countries by the given key(s) | [optional]
57
+
58
+ ### Return type
59
+
60
+ [**Countries**](Countries.md)
61
+
62
+ ### Authorization
63
+
64
+ [jwt](../README.md#jwt)
65
+
66
+ ### HTTP request headers
67
+
68
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
69
+ - **Accept**: application/vnd.countries+json
70
+
71
+
72
+