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/Links.md ADDED
@@ -0,0 +1,12 @@
1
+ # SamplifyAPIClient::Links
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **first** | **String** | | [optional]
7
+ **last** | **String** | | [optional]
8
+ **_next** | **String** | | [optional]
9
+ **prev** | **String** | | [optional]
10
+ **_self** | **String** | | [optional]
11
+
12
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::LogoutPayload
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **access_token** | **String** | Access token |
7
+ **client_id** | **String** | Client ID |
8
+ **refresh_token** | **String** | Refresh token |
9
+
10
+
data/docs/Meta.md ADDED
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::Meta
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **links** | [**Links**](Links.md) | | [optional]
7
+ **page_size** | **Integer** | Page size | [optional]
8
+ **total** | **Integer** | Total records possible | [optional]
9
+
10
+
data/docs/Project.md ADDED
@@ -0,0 +1,14 @@
1
+ # SamplifyAPIClient::Project
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **category** | [**ProjectCategoryData**](ProjectCategoryData.md) | |
7
+ **devices** | **Array<String>** | List of emails to subscribe to notifications | [optional]
8
+ **exclusions** | [**ExclusionData**](ExclusionData.md) | | [optional]
9
+ **ext_project_id** | **String** | Unique external project ID |
10
+ **line_items** | [**Array<LineItemData>**](LineItemData.md) | List of line items for the project. |
11
+ **notification_emails** | **Array<String>** | List of emails to subscribe to notifications |
12
+ **title** | **String** | Project title |
13
+
14
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::ProjectAction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**ProjectActionResponse**](ProjectActionResponse.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,13 @@
1
+ # SamplifyAPIClient::ProjectActionResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **created_at** | **String** | Timestamp of when the line item was created | [optional]
7
+ **ext_project_id** | **String** | A unique identifier for your project | [optional]
8
+ **line_items** | [**Array<LineItemActionResponse>**](LineItemActionResponse.md) | line items for the project | [optional]
9
+ **state** | **String** | Current state of the Project | [optional]
10
+ **state_last_updated_at** | **String** | Timestamp of when the line item last changed its state | [optional]
11
+ **updated_at** | **String** | Timestamp of when the line item was updated | [optional]
12
+
13
+
@@ -0,0 +1,8 @@
1
+ # SamplifyAPIClient::ProjectCategoryData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **survey_topic** | **Array<String>** | List of survey topics |
7
+
8
+
@@ -0,0 +1,14 @@
1
+ # SamplifyAPIClient::ProjectItemData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **author** | [**Author**](Author.md) | | [optional]
7
+ **created_at** | **String** | Timestamp of when the project was created |
8
+ **ext_project_id** | **String** | A unique identifier for your project |
9
+ **state** | **String** | Current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED |
10
+ **state_last_updated_at** | **String** | Timestamp of when the project last changed its state |
11
+ **title** | **String** | Project title |
12
+ **updated_at** | **String** | Timestamp of when the project was updated |
13
+
14
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::ProjectReport
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**ProjectReportData**](ProjectReportData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,21 @@
1
+ # SamplifyAPIClient::ProjectReportData
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
+ **currency** | **String** | Currency ISO code |
11
+ **estimated_cost** | **Float** | Total estimated cost |
12
+ **ext_project_id** | **String** | A unique identifier for your project |
13
+ **incurred_cost** | **Float** | Total incurred cost |
14
+ **line_items** | [**Array<LineItemReportData>**](LineItemReportData.md) | | [optional]
15
+ **overquotas** | **Integer** | Total number of panelists that triggered an overquota for the project |
16
+ **remaining_completes** | **Integer** | Total remaining completes for the project |
17
+ **screenouts** | **Integer** | Total number of panelists that got screened out of the project |
18
+ **state** | **String** | The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED |
19
+ **title** | **String** | Project Title |
20
+
21
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::ProjectReports
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<ProjectReportData>**](ProjectReportData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::ProjectResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**ProjectResponseData**](ProjectResponseData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,19 @@
1
+ # SamplifyAPIClient::ProjectResponseData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **author** | [**Author**](Author.md) | | [optional]
7
+ **category** | [**ProjectCategoryData**](ProjectCategoryData.md) | |
8
+ **created_at** | **String** | Timestamp of when the project was created |
9
+ **devices** | **Array<String>** | List of emails to subscribe to notifications | [optional]
10
+ **exclusions** | [**ExclusionData**](ExclusionData.md) | |
11
+ **ext_project_id** | **String** | Unique external project ID |
12
+ **line_items** | [**Array<LineItemResponseData>**](LineItemResponseData.md) | List of line items for the project. |
13
+ **notification_emails** | **Array<String>** | List of emails to subscribe to notifications |
14
+ **state** | **String** | Current state of the project |
15
+ **state_last_updated_at** | **String** | Timestamp of when the project last changed its state |
16
+ **title** | **String** | Project title |
17
+ **updated_at** | **String** | Timestamp of when the project was updated |
18
+
19
+
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::ProjectSurveyEndLinks
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**ProjectSurveyEndLinksData**](ProjectSurveyEndLinksData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,12 @@
1
+ # SamplifyAPIClient::ProjectSurveyEndLinksData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **end_links** | [**SurveyEndLinks**](SurveyEndLinks.md) | |
7
+ **entry_link** | **String** | Entry link URL |
8
+ **security_key1** | **String** | Security Key 1 | [optional]
9
+ **security_key2** | **String** | Security Key 2 | [optional]
10
+ **security_level** | **String** | Security Level: NONE, BASIC, MEDIUM, or HIGH |
11
+
12
+
data/docs/Projects.md ADDED
@@ -0,0 +1,10 @@
1
+ # SamplifyAPIClient::Projects
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<ProjectItemData>**](ProjectItemData.md) | |
7
+ **meta** | [**Meta**](Meta.md) | |
8
+ **status** | [**Status**](Status.md) | |
9
+
10
+
@@ -0,0 +1,620 @@
1
+ # SamplifyAPIClient::ProjectsApi
2
+
3
+ All URIs are relative to *https://api.uat.pe.researchnow.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**projects_buy**](ProjectsApi.md#projects_buy) | **POST** /sample/v1/projects/{extProjectId}/buy | buy projects
8
+ [**projects_close**](ProjectsApi.md#projects_close) | **POST** /sample/v1/projects/{extProjectId}/close | close projects
9
+ [**projects_create**](ProjectsApi.md#projects_create) | **POST** /sample/v1/projects | create projects
10
+ [**projects_get**](ProjectsApi.md#projects_get) | **GET** /sample/v1/projects/{extProjectId} | get projects
11
+ [**projects_get_report**](ProjectsApi.md#projects_get_report) | **GET** /sample/v1/projects/{extProjectId}/report | getReport projects
12
+ [**projects_get_reports**](ProjectsApi.md#projects_get_reports) | **GET** /sample/v1/projects/report | getReports projects
13
+ [**projects_get_survey_end_links**](ProjectsApi.md#projects_get_survey_end_links) | **GET** /sample/v1/projects/{extProjectId}/surveys/{surveyId}/links | getSurveyEndLinks projects
14
+ [**projects_invoices**](ProjectsApi.md#projects_invoices) | **GET** /sample/v1/projects/{extProjectId}/invoices | invoices projects
15
+ [**projects_list**](ProjectsApi.md#projects_list) | **GET** /sample/v1/projects | list projects
16
+ [**projects_reconcile**](ProjectsApi.md#projects_reconcile) | **POST** /sample/v1/projects/{extProjectId}/reconcile | reconcile projects
17
+ [**projects_update**](ProjectsApi.md#projects_update) | **POST** /sample/v1/projects/{extProjectId} | update projects
18
+
19
+
20
+ # **projects_buy**
21
+ > BuyProject projects_buy(ext_project_id, payload)
22
+
23
+ buy projects
24
+
25
+ ### Example
26
+ ```ruby
27
+ # load the gem
28
+ require 'samplify_api_client'
29
+ # setup authorization
30
+ SamplifyAPIClient.configure do |config|
31
+ # Configure API key authorization: jwt
32
+ config.api_key['Authorization'] = 'YOUR API KEY'
33
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
34
+ #config.api_key_prefix['Authorization'] = 'Bearer'
35
+ end
36
+
37
+ api_instance = SamplifyAPIClient::ProjectsApi.new
38
+
39
+ ext_project_id = 'ext_project_id_example' # String |
40
+
41
+ payload = SamplifyAPIClient::BuyProjectsPayload.new # BuyProjectsPayload |
42
+
43
+
44
+ begin
45
+ #buy projects
46
+ result = api_instance.projects_buy(ext_project_id, payload)
47
+ p result
48
+ rescue SamplifyAPIClient::ApiError => e
49
+ puts "Exception when calling ProjectsApi->projects_buy: #{e}"
50
+ end
51
+ ```
52
+
53
+ ### Parameters
54
+
55
+ Name | Type | Description | Notes
56
+ ------------- | ------------- | ------------- | -------------
57
+ **ext_project_id** | **String**| |
58
+ **payload** | [**BuyProjectsPayload**](BuyProjectsPayload.md)| |
59
+
60
+ ### Return type
61
+
62
+ [**BuyProject**](BuyProject.md)
63
+
64
+ ### Authorization
65
+
66
+ [jwt](../README.md#jwt)
67
+
68
+ ### HTTP request headers
69
+
70
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
71
+ - **Accept**: application/vnd.buyproject+json
72
+
73
+
74
+
75
+ # **projects_close**
76
+ > ProjectAction projects_close(ext_project_id)
77
+
78
+ close projects
79
+
80
+ ### Example
81
+ ```ruby
82
+ # load the gem
83
+ require 'samplify_api_client'
84
+ # setup authorization
85
+ SamplifyAPIClient.configure do |config|
86
+ # Configure API key authorization: jwt
87
+ config.api_key['Authorization'] = 'YOUR API KEY'
88
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
89
+ #config.api_key_prefix['Authorization'] = 'Bearer'
90
+ end
91
+
92
+ api_instance = SamplifyAPIClient::ProjectsApi.new
93
+
94
+ ext_project_id = 'ext_project_id_example' # String |
95
+
96
+
97
+ begin
98
+ #close projects
99
+ result = api_instance.projects_close(ext_project_id)
100
+ p result
101
+ rescue SamplifyAPIClient::ApiError => e
102
+ puts "Exception when calling ProjectsApi->projects_close: #{e}"
103
+ end
104
+ ```
105
+
106
+ ### Parameters
107
+
108
+ Name | Type | Description | Notes
109
+ ------------- | ------------- | ------------- | -------------
110
+ **ext_project_id** | **String**| |
111
+
112
+ ### Return type
113
+
114
+ [**ProjectAction**](ProjectAction.md)
115
+
116
+ ### Authorization
117
+
118
+ [jwt](../README.md#jwt)
119
+
120
+ ### HTTP request headers
121
+
122
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
123
+ - **Accept**: application/vnd.project.action+json
124
+
125
+
126
+
127
+ # **projects_create**
128
+ > ProjectResponse projects_create(payload)
129
+
130
+ create projects
131
+
132
+ ### Example
133
+ ```ruby
134
+ # load the gem
135
+ require 'samplify_api_client'
136
+ # setup authorization
137
+ SamplifyAPIClient.configure do |config|
138
+ # Configure API key authorization: jwt
139
+ config.api_key['Authorization'] = 'YOUR API KEY'
140
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
141
+ #config.api_key_prefix['Authorization'] = 'Bearer'
142
+ end
143
+
144
+ api_instance = SamplifyAPIClient::ProjectsApi.new
145
+
146
+ payload = SamplifyAPIClient::Project.new # Project |
147
+
148
+
149
+ begin
150
+ #create projects
151
+ result = api_instance.projects_create(payload)
152
+ p result
153
+ rescue SamplifyAPIClient::ApiError => e
154
+ puts "Exception when calling ProjectsApi->projects_create: #{e}"
155
+ end
156
+ ```
157
+
158
+ ### Parameters
159
+
160
+ Name | Type | Description | Notes
161
+ ------------- | ------------- | ------------- | -------------
162
+ **payload** | [**Project**](Project.md)| |
163
+
164
+ ### Return type
165
+
166
+ [**ProjectResponse**](ProjectResponse.md)
167
+
168
+ ### Authorization
169
+
170
+ [jwt](../README.md#jwt)
171
+
172
+ ### HTTP request headers
173
+
174
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
175
+ - **Accept**: application/vnd.create+json
176
+
177
+
178
+
179
+ # **projects_get**
180
+ > ProjectResponse projects_get(ext_project_id)
181
+
182
+ get projects
183
+
184
+ ### Example
185
+ ```ruby
186
+ # load the gem
187
+ require 'samplify_api_client'
188
+ # setup authorization
189
+ SamplifyAPIClient.configure do |config|
190
+ # Configure API key authorization: jwt
191
+ config.api_key['Authorization'] = 'YOUR API KEY'
192
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
193
+ #config.api_key_prefix['Authorization'] = 'Bearer'
194
+ end
195
+
196
+ api_instance = SamplifyAPIClient::ProjectsApi.new
197
+
198
+ ext_project_id = 'ext_project_id_example' # String |
199
+
200
+
201
+ begin
202
+ #get projects
203
+ result = api_instance.projects_get(ext_project_id)
204
+ p result
205
+ rescue SamplifyAPIClient::ApiError => e
206
+ puts "Exception when calling ProjectsApi->projects_get: #{e}"
207
+ end
208
+ ```
209
+
210
+ ### Parameters
211
+
212
+ Name | Type | Description | Notes
213
+ ------------- | ------------- | ------------- | -------------
214
+ **ext_project_id** | **String**| |
215
+
216
+ ### Return type
217
+
218
+ [**ProjectResponse**](ProjectResponse.md)
219
+
220
+ ### Authorization
221
+
222
+ [jwt](../README.md#jwt)
223
+
224
+ ### HTTP request headers
225
+
226
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
227
+ - **Accept**: application/vnd.create+json
228
+
229
+
230
+
231
+ # **projects_get_report**
232
+ > ProjectReport projects_get_report(ext_project_id)
233
+
234
+ getReport projects
235
+
236
+ ### Example
237
+ ```ruby
238
+ # load the gem
239
+ require 'samplify_api_client'
240
+ # setup authorization
241
+ SamplifyAPIClient.configure do |config|
242
+ # Configure API key authorization: jwt
243
+ config.api_key['Authorization'] = 'YOUR API KEY'
244
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
245
+ #config.api_key_prefix['Authorization'] = 'Bearer'
246
+ end
247
+
248
+ api_instance = SamplifyAPIClient::ProjectsApi.new
249
+
250
+ ext_project_id = 'ext_project_id_example' # String |
251
+
252
+
253
+ begin
254
+ #getReport projects
255
+ result = api_instance.projects_get_report(ext_project_id)
256
+ p result
257
+ rescue SamplifyAPIClient::ApiError => e
258
+ puts "Exception when calling ProjectsApi->projects_get_report: #{e}"
259
+ end
260
+ ```
261
+
262
+ ### Parameters
263
+
264
+ Name | Type | Description | Notes
265
+ ------------- | ------------- | ------------- | -------------
266
+ **ext_project_id** | **String**| |
267
+
268
+ ### Return type
269
+
270
+ [**ProjectReport**](ProjectReport.md)
271
+
272
+ ### Authorization
273
+
274
+ [jwt](../README.md#jwt)
275
+
276
+ ### HTTP request headers
277
+
278
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
279
+ - **Accept**: application/vnd.projects.report+json
280
+
281
+
282
+
283
+ # **projects_get_reports**
284
+ > ProjectReports projects_get_reports(ext_project_id)
285
+
286
+ getReports projects
287
+
288
+ ### Example
289
+ ```ruby
290
+ # load the gem
291
+ require 'samplify_api_client'
292
+ # setup authorization
293
+ SamplifyAPIClient.configure do |config|
294
+ # Configure API key authorization: jwt
295
+ config.api_key['Authorization'] = 'YOUR API KEY'
296
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
297
+ #config.api_key_prefix['Authorization'] = 'Bearer'
298
+ end
299
+
300
+ api_instance = SamplifyAPIClient::ProjectsApi.new
301
+
302
+ ext_project_id = 'ext_project_id_example' # String | Only return project with the given external project ID
303
+
304
+
305
+ begin
306
+ #getReports projects
307
+ result = api_instance.projects_get_reports(ext_project_id)
308
+ p result
309
+ rescue SamplifyAPIClient::ApiError => e
310
+ puts "Exception when calling ProjectsApi->projects_get_reports: #{e}"
311
+ end
312
+ ```
313
+
314
+ ### Parameters
315
+
316
+ Name | Type | Description | Notes
317
+ ------------- | ------------- | ------------- | -------------
318
+ **ext_project_id** | **String**| Only return project with the given external project ID |
319
+
320
+ ### Return type
321
+
322
+ [**ProjectReports**](ProjectReports.md)
323
+
324
+ ### Authorization
325
+
326
+ [jwt](../README.md#jwt)
327
+
328
+ ### HTTP request headers
329
+
330
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
331
+ - **Accept**: application/vnd.projects.reports+json
332
+
333
+
334
+
335
+ # **projects_get_survey_end_links**
336
+ > ProjectSurveyEndLinks projects_get_survey_end_links(ext_project_id, survey_id)
337
+
338
+ getSurveyEndLinks projects
339
+
340
+ ### Example
341
+ ```ruby
342
+ # load the gem
343
+ require 'samplify_api_client'
344
+ # setup authorization
345
+ SamplifyAPIClient.configure do |config|
346
+ # Configure API key authorization: jwt
347
+ config.api_key['Authorization'] = 'YOUR API KEY'
348
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
349
+ #config.api_key_prefix['Authorization'] = 'Bearer'
350
+ end
351
+
352
+ api_instance = SamplifyAPIClient::ProjectsApi.new
353
+
354
+ ext_project_id = 'ext_project_id_example' # String |
355
+
356
+ survey_id = 'survey_id_example' # String |
357
+
358
+
359
+ begin
360
+ #getSurveyEndLinks projects
361
+ result = api_instance.projects_get_survey_end_links(ext_project_id, survey_id)
362
+ p result
363
+ rescue SamplifyAPIClient::ApiError => e
364
+ puts "Exception when calling ProjectsApi->projects_get_survey_end_links: #{e}"
365
+ end
366
+ ```
367
+
368
+ ### Parameters
369
+
370
+ Name | Type | Description | Notes
371
+ ------------- | ------------- | ------------- | -------------
372
+ **ext_project_id** | **String**| |
373
+ **survey_id** | **String**| |
374
+
375
+ ### Return type
376
+
377
+ [**ProjectSurveyEndLinks**](ProjectSurveyEndLinks.md)
378
+
379
+ ### Authorization
380
+
381
+ [jwt](../README.md#jwt)
382
+
383
+ ### HTTP request headers
384
+
385
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
386
+ - **Accept**: application/vnd.projects.survey.endlinks+json
387
+
388
+
389
+
390
+ # **projects_invoices**
391
+ > projects_invoices(ext_project_id)
392
+
393
+ invoices projects
394
+
395
+ ### Example
396
+ ```ruby
397
+ # load the gem
398
+ require 'samplify_api_client'
399
+ # setup authorization
400
+ SamplifyAPIClient.configure do |config|
401
+ # Configure API key authorization: jwt
402
+ config.api_key['Authorization'] = 'YOUR API KEY'
403
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
404
+ #config.api_key_prefix['Authorization'] = 'Bearer'
405
+ end
406
+
407
+ api_instance = SamplifyAPIClient::ProjectsApi.new
408
+
409
+ ext_project_id = 'ext_project_id_example' # String |
410
+
411
+
412
+ begin
413
+ #invoices projects
414
+ api_instance.projects_invoices(ext_project_id)
415
+ rescue SamplifyAPIClient::ApiError => e
416
+ puts "Exception when calling ProjectsApi->projects_invoices: #{e}"
417
+ end
418
+ ```
419
+
420
+ ### Parameters
421
+
422
+ Name | Type | Description | Notes
423
+ ------------- | ------------- | ------------- | -------------
424
+ **ext_project_id** | **String**| |
425
+
426
+ ### Return type
427
+
428
+ nil (empty response body)
429
+
430
+ ### Authorization
431
+
432
+ [jwt](../README.md#jwt)
433
+
434
+ ### HTTP request headers
435
+
436
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
437
+ - **Accept**: application/vnd.app.error+json, text/plain
438
+
439
+
440
+
441
+ # **projects_list**
442
+ > Projects projects_list(opts)
443
+
444
+ list projects
445
+
446
+ ### Example
447
+ ```ruby
448
+ # load the gem
449
+ require 'samplify_api_client'
450
+ # setup authorization
451
+ SamplifyAPIClient.configure do |config|
452
+ # Configure API key authorization: jwt
453
+ config.api_key['Authorization'] = 'YOUR API KEY'
454
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
455
+ #config.api_key_prefix['Authorization'] = 'Bearer'
456
+ end
457
+
458
+ api_instance = SamplifyAPIClient::ProjectsApi.new
459
+
460
+ opts = {
461
+ created_at: 'created_at_example', # String | return projects with createdAt start date
462
+ ext_project_id: 'ext_project_id_example', # String | Only return project with the given external project id
463
+ limit: 10, # Integer | Maximum number of projects to return
464
+ offset: 0, # Integer | The first zero-based offset project to return
465
+ scope: 'scope_example', # String | Only return projects within the given scope
466
+ sort: ['sort_example'], # Array<String> | Sort the projects by the given key(s)
467
+ state: 'state_example', # String | Only return projects with the given state
468
+ title: 'title_example' # String | Only return projects with the given title
469
+ }
470
+
471
+ begin
472
+ #list projects
473
+ result = api_instance.projects_list(opts)
474
+ p result
475
+ rescue SamplifyAPIClient::ApiError => e
476
+ puts "Exception when calling ProjectsApi->projects_list: #{e}"
477
+ end
478
+ ```
479
+
480
+ ### Parameters
481
+
482
+ Name | Type | Description | Notes
483
+ ------------- | ------------- | ------------- | -------------
484
+ **created_at** | **String**| return projects with createdAt start date | [optional]
485
+ **ext_project_id** | **String**| Only return project with the given external project id | [optional]
486
+ **limit** | **Integer**| Maximum number of projects to return | [optional] [default to 10]
487
+ **offset** | **Integer**| The first zero-based offset project to return | [optional] [default to 0]
488
+ **scope** | **String**| Only return projects within the given scope | [optional]
489
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the projects by the given key(s) | [optional]
490
+ **state** | **String**| Only return projects with the given state | [optional]
491
+ **title** | **String**| Only return projects with the given title | [optional]
492
+
493
+ ### Return type
494
+
495
+ [**Projects**](Projects.md)
496
+
497
+ ### Authorization
498
+
499
+ [jwt](../README.md#jwt)
500
+
501
+ ### HTTP request headers
502
+
503
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
504
+ - **Accept**: application/vnd.projects+json
505
+
506
+
507
+
508
+ # **projects_reconcile**
509
+ > Reconcile projects_reconcile(ext_project_id, file, message)
510
+
511
+ reconcile projects
512
+
513
+ ### Example
514
+ ```ruby
515
+ # load the gem
516
+ require 'samplify_api_client'
517
+ # setup authorization
518
+ SamplifyAPIClient.configure do |config|
519
+ # Configure API key authorization: jwt
520
+ config.api_key['Authorization'] = 'YOUR API KEY'
521
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
522
+ #config.api_key_prefix['Authorization'] = 'Bearer'
523
+ end
524
+
525
+ api_instance = SamplifyAPIClient::ProjectsApi.new
526
+
527
+ ext_project_id = 'ext_project_id_example' # String |
528
+
529
+ file = File.new('/path/to/file.txt') # File | File
530
+
531
+ message = 'message_example' # String | Message
532
+
533
+
534
+ begin
535
+ #reconcile projects
536
+ result = api_instance.projects_reconcile(ext_project_id, file, message)
537
+ p result
538
+ rescue SamplifyAPIClient::ApiError => e
539
+ puts "Exception when calling ProjectsApi->projects_reconcile: #{e}"
540
+ end
541
+ ```
542
+
543
+ ### Parameters
544
+
545
+ Name | Type | Description | Notes
546
+ ------------- | ------------- | ------------- | -------------
547
+ **ext_project_id** | **String**| |
548
+ **file** | **File**| File |
549
+ **message** | **String**| Message |
550
+
551
+ ### Return type
552
+
553
+ [**Reconcile**](Reconcile.md)
554
+
555
+ ### Authorization
556
+
557
+ [jwt](../README.md#jwt)
558
+
559
+ ### HTTP request headers
560
+
561
+ - **Content-Type**: multipart/form-data
562
+ - **Accept**: application/vnd.app.error+json, application/vnd.projects.reconcile+json
563
+
564
+
565
+
566
+ # **projects_update**
567
+ > ProjectResponse projects_update(ext_project_id, payload)
568
+
569
+ update projects
570
+
571
+ ### Example
572
+ ```ruby
573
+ # load the gem
574
+ require 'samplify_api_client'
575
+ # setup authorization
576
+ SamplifyAPIClient.configure do |config|
577
+ # Configure API key authorization: jwt
578
+ config.api_key['Authorization'] = 'YOUR API KEY'
579
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
580
+ #config.api_key_prefix['Authorization'] = 'Bearer'
581
+ end
582
+
583
+ api_instance = SamplifyAPIClient::ProjectsApi.new
584
+
585
+ ext_project_id = 'ext_project_id_example' # String |
586
+
587
+ payload = SamplifyAPIClient::UpdateProjectData.new # UpdateProjectData |
588
+
589
+
590
+ begin
591
+ #update projects
592
+ result = api_instance.projects_update(ext_project_id, payload)
593
+ p result
594
+ rescue SamplifyAPIClient::ApiError => e
595
+ puts "Exception when calling ProjectsApi->projects_update: #{e}"
596
+ end
597
+ ```
598
+
599
+ ### Parameters
600
+
601
+ Name | Type | Description | Notes
602
+ ------------- | ------------- | ------------- | -------------
603
+ **ext_project_id** | **String**| |
604
+ **payload** | [**UpdateProjectData**](UpdateProjectData.md)| |
605
+
606
+ ### Return type
607
+
608
+ [**ProjectResponse**](ProjectResponse.md)
609
+
610
+ ### Authorization
611
+
612
+ [jwt](../README.md#jwt)
613
+
614
+ ### HTTP request headers
615
+
616
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
617
+ - **Accept**: application/vnd.create+json
618
+
619
+
620
+