samplify_api_client 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +69 -0
- data/README.md +221 -0
- data/Rakefile +8 -0
- data/docs/AppError.md +10 -0
- data/docs/ApplicationItemData.md +11 -0
- data/docs/AttributeData.md +16 -0
- data/docs/AttributeOption.md +10 -0
- data/docs/Attributes.md +10 -0
- data/docs/AttributesApi.md +78 -0
- data/docs/AuthApi.md +191 -0
- data/docs/AuthError.md +9 -0
- data/docs/Author.md +10 -0
- data/docs/BuyProject.md +10 -0
- data/docs/BuyProjectItem.md +12 -0
- data/docs/BuyProjectResponse.md +9 -0
- data/docs/BuyProjectsPayload.md +7 -0
- data/docs/Categories.md +10 -0
- data/docs/CategoriesApi.md +72 -0
- data/docs/CategoryData.md +9 -0
- data/docs/CodePayload.md +11 -0
- data/docs/Countries.md +10 -0
- data/docs/CountriesApi.md +72 -0
- data/docs/CountryData.md +11 -0
- data/docs/CreateLineItem.md +10 -0
- data/docs/DefaultApi.md +88 -0
- data/docs/EndLinks.md +13 -0
- data/docs/ErrorType.md +9 -0
- data/docs/Event.md +10 -0
- data/docs/EventData.md +15 -0
- data/docs/EventListData.md +15 -0
- data/docs/Events.md +10 -0
- data/docs/EventsApi.md +287 -0
- data/docs/ExclusionData.md +9 -0
- data/docs/Feasibility.md +10 -0
- data/docs/FeasibilityApi.md +61 -0
- data/docs/FeasibilityData.md +14 -0
- data/docs/FeasibilityResponseData.md +9 -0
- data/docs/LineItemActionResponse.md +14 -0
- data/docs/LineItemData.md +22 -0
- data/docs/LineItemItemData.md +17 -0
- data/docs/LineItemReportData.md +25 -0
- data/docs/LineItemResponseData.md +27 -0
- data/docs/LineItems.md +10 -0
- data/docs/LineItemsApi.md +420 -0
- data/docs/Links.md +12 -0
- data/docs/LogoutPayload.md +10 -0
- data/docs/Meta.md +10 -0
- data/docs/Project.md +14 -0
- data/docs/ProjectAction.md +10 -0
- data/docs/ProjectActionResponse.md +13 -0
- data/docs/ProjectCategoryData.md +8 -0
- data/docs/ProjectItemData.md +14 -0
- data/docs/ProjectReport.md +10 -0
- data/docs/ProjectReportData.md +21 -0
- data/docs/ProjectReports.md +10 -0
- data/docs/ProjectResponse.md +10 -0
- data/docs/ProjectResponseData.md +19 -0
- data/docs/ProjectSurveyEndLinks.md +10 -0
- data/docs/ProjectSurveyEndLinksData.md +12 -0
- data/docs/Projects.md +10 -0
- data/docs/ProjectsApi.md +620 -0
- data/docs/QuotaCell.md +10 -0
- data/docs/QuotaCellFeasibility.md +9 -0
- data/docs/QuotaGroupData.md +9 -0
- data/docs/QuotaGroupFeasibility.md +8 -0
- data/docs/QuotaPlanData.md +9 -0
- data/docs/Reconcile.md +10 -0
- data/docs/ReconcileData.md +7 -0
- data/docs/RefreshTokenPayload.md +10 -0
- data/docs/Reprice.md +10 -0
- data/docs/RepriceData.md +22 -0
- data/docs/RepricePayload.md +20 -0
- data/docs/RespondentApi.md +86 -0
- data/docs/Status.md +9 -0
- data/docs/SupportedLanguage.md +10 -0
- data/docs/SurveyEndLinks.md +10 -0
- data/docs/SurveyTestId.md +10 -0
- data/docs/SurveyTestLink.md +9 -0
- data/docs/Target.md +11 -0
- data/docs/TargetingAttribute.md +10 -0
- data/docs/TokenMedia.md +11 -0
- data/docs/TokenPayload.md +11 -0
- data/docs/URLParam.md +9 -0
- data/docs/UpdateLineItem.md +21 -0
- data/docs/UpdateProjectData.md +13 -0
- data/docs/UpdateProjectLineItem.md +22 -0
- data/docs/UserInfo.md +10 -0
- data/docs/UserInfoResponseData.md +10 -0
- data/docs/UsersApi.md +68 -0
- data/examples/auth.rb +18 -0
- data/git_push.sh +55 -0
- data/lib/samplify_api_client/api/attributes_api.rb +111 -0
- data/lib/samplify_api_client/api/auth_api.rb +230 -0
- data/lib/samplify_api_client/api/categories_api.rb +99 -0
- data/lib/samplify_api_client/api/countries_api.rb +99 -0
- data/lib/samplify_api_client/api/default_api.rb +115 -0
- data/lib/samplify_api_client/api/events_api.rb +317 -0
- data/lib/samplify_api_client/api/feasibility_api.rb +75 -0
- data/lib/samplify_api_client/api/line_items_api.rb +468 -0
- data/lib/samplify_api_client/api/projects_api.rb +660 -0
- data/lib/samplify_api_client/api/respondent_api.rb +113 -0
- data/lib/samplify_api_client/api/users_api.rb +81 -0
- data/lib/samplify_api_client/api_client.rb +389 -0
- data/lib/samplify_api_client/api_error.rb +38 -0
- data/lib/samplify_api_client/configuration.rb +209 -0
- data/lib/samplify_api_client/models/app_error.rb +218 -0
- data/lib/samplify_api_client/models/application_item_data.rb +234 -0
- data/lib/samplify_api_client/models/attribute_data.rb +334 -0
- data/lib/samplify_api_client/models/attribute_option.rb +219 -0
- data/lib/samplify_api_client/models/attributes.rb +219 -0
- data/lib/samplify_api_client/models/auth_error.rb +205 -0
- data/lib/samplify_api_client/models/author.rb +253 -0
- data/lib/samplify_api_client/models/buy_project.rb +219 -0
- data/lib/samplify_api_client/models/buy_project_item.rb +243 -0
- data/lib/samplify_api_client/models/buy_project_response.rb +194 -0
- data/lib/samplify_api_client/models/buy_projects_payload.rb +174 -0
- data/lib/samplify_api_client/models/categories.rb +219 -0
- data/lib/samplify_api_client/models/category_data.rb +204 -0
- data/lib/samplify_api_client/models/code_payload.rb +229 -0
- data/lib/samplify_api_client/models/countries.rb +219 -0
- data/lib/samplify_api_client/models/country_data.rb +230 -0
- data/lib/samplify_api_client/models/create_line_item.rb +217 -0
- data/lib/samplify_api_client/models/end_links.rb +288 -0
- data/lib/samplify_api_client/models/error_type.rb +204 -0
- data/lib/samplify_api_client/models/event.rb +217 -0
- data/lib/samplify_api_client/models/event_data.rb +289 -0
- data/lib/samplify_api_client/models/event_list_data.rb +289 -0
- data/lib/samplify_api_client/models/events.rb +219 -0
- data/lib/samplify_api_client/models/exclusion_data.rb +206 -0
- data/lib/samplify_api_client/models/feasibility.rb +219 -0
- data/lib/samplify_api_client/models/feasibility_data.rb +255 -0
- data/lib/samplify_api_client/models/feasibility_response_data.rb +193 -0
- data/lib/samplify_api_client/models/line_item_action_response.rb +244 -0
- data/lib/samplify_api_client/models/line_item_data.rb +398 -0
- data/lib/samplify_api_client/models/line_item_item_data.rb +358 -0
- data/lib/samplify_api_client/models/line_item_report_data.rb +478 -0
- data/lib/samplify_api_client/models/line_item_response_data.rb +408 -0
- data/lib/samplify_api_client/models/line_items.rb +219 -0
- data/lib/samplify_api_client/models/links.rb +219 -0
- data/lib/samplify_api_client/models/logout_payload.rb +219 -0
- data/lib/samplify_api_client/models/meta.rb +203 -0
- data/lib/samplify_api_client/models/project.rb +273 -0
- data/lib/samplify_api_client/models/project_action.rb +217 -0
- data/lib/samplify_api_client/models/project_action_response.rb +236 -0
- data/lib/samplify_api_client/models/project_category_data.rb +191 -0
- data/lib/samplify_api_client/models/project_item_data.rb +307 -0
- data/lib/samplify_api_client/models/project_report.rb +217 -0
- data/lib/samplify_api_client/models/project_report_data.rb +414 -0
- data/lib/samplify_api_client/models/project_reports.rb +219 -0
- data/lib/samplify_api_client/models/project_response.rb +217 -0
- data/lib/samplify_api_client/models/project_response_data.rb +347 -0
- data/lib/samplify_api_client/models/project_survey_end_links.rb +217 -0
- data/lib/samplify_api_client/models/project_survey_end_links_data.rb +272 -0
- data/lib/samplify_api_client/models/projects.rb +219 -0
- data/lib/samplify_api_client/models/quota_cell.rb +206 -0
- data/lib/samplify_api_client/models/quota_cell_feasibility.rb +204 -0
- data/lib/samplify_api_client/models/quota_group_data.rb +201 -0
- data/lib/samplify_api_client/models/quota_group_feasibility.rb +185 -0
- data/lib/samplify_api_client/models/quota_plan_data.rb +198 -0
- data/lib/samplify_api_client/models/reconcile.rb +217 -0
- data/lib/samplify_api_client/models/reconcile_data.rb +174 -0
- data/lib/samplify_api_client/models/refresh_token_payload.rb +214 -0
- data/lib/samplify_api_client/models/reprice.rb +217 -0
- data/lib/samplify_api_client/models/reprice_data.rb +399 -0
- data/lib/samplify_api_client/models/reprice_payload.rb +369 -0
- data/lib/samplify_api_client/models/status.rb +206 -0
- data/lib/samplify_api_client/models/supported_language.rb +219 -0
- data/lib/samplify_api_client/models/survey_end_links.rb +216 -0
- data/lib/samplify_api_client/models/survey_test_id.rb +219 -0
- data/lib/samplify_api_client/models/survey_test_link.rb +206 -0
- data/lib/samplify_api_client/models/target.rb +258 -0
- data/lib/samplify_api_client/models/targeting_attribute.rb +216 -0
- data/lib/samplify_api_client/models/token_media.rb +235 -0
- data/lib/samplify_api_client/models/token_payload.rb +229 -0
- data/lib/samplify_api_client/models/update_line_item.rb +353 -0
- data/lib/samplify_api_client/models/update_project_data.rb +238 -0
- data/lib/samplify_api_client/models/update_project_line_item.rb +368 -0
- data/lib/samplify_api_client/models/url_param.rb +204 -0
- data/lib/samplify_api_client/models/user_info.rb +217 -0
- data/lib/samplify_api_client/models/user_info_response_data.rb +221 -0
- data/lib/samplify_api_client/version.rb +15 -0
- data/lib/samplify_api_client.rb +125 -0
- data/samplify_api_client.gemspec +45 -0
- data/spec/api/attributes_api_spec.rb +53 -0
- data/spec/api/auth_api_spec.rb +79 -0
- data/spec/api/categories_api_spec.rb +51 -0
- data/spec/api/countries_api_spec.rb +51 -0
- data/spec/api/default_api_spec.rb +55 -0
- data/spec/api/events_api_spec.rb +100 -0
- data/spec/api/feasibility_api_spec.rb +46 -0
- data/spec/api/line_items_api_spec.rb +128 -0
- data/spec/api/projects_api_spec.rb +168 -0
- data/spec/api/respondent_api_spec.rb +55 -0
- data/spec/api/users_api_spec.rb +49 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/app_error_spec.rb +53 -0
- data/spec/models/application_item_data_spec.rb +59 -0
- data/spec/models/attribute_data_spec.rb +93 -0
- data/spec/models/attribute_option_spec.rb +53 -0
- data/spec/models/attributes_spec.rb +53 -0
- data/spec/models/auth_error_spec.rb +47 -0
- data/spec/models/author_spec.rb +57 -0
- data/spec/models/buy_project_item_spec.rb +65 -0
- data/spec/models/buy_project_response_spec.rb +47 -0
- data/spec/models/buy_project_spec.rb +53 -0
- data/spec/models/buy_projects_payload_spec.rb +35 -0
- data/spec/models/categories_spec.rb +53 -0
- data/spec/models/category_data_spec.rb +47 -0
- data/spec/models/code_payload_spec.rb +59 -0
- data/spec/models/countries_spec.rb +53 -0
- data/spec/models/country_data_spec.rb +59 -0
- data/spec/models/create_line_item_spec.rb +53 -0
- data/spec/models/end_links_spec.rb +75 -0
- data/spec/models/error_type_spec.rb +47 -0
- data/spec/models/event_data_spec.rb +83 -0
- data/spec/models/event_list_data_spec.rb +83 -0
- data/spec/models/event_spec.rb +53 -0
- data/spec/models/events_spec.rb +53 -0
- data/spec/models/exclusion_data_spec.rb +47 -0
- data/spec/models/feasibility_data_spec.rb +77 -0
- data/spec/models/feasibility_response_data_spec.rb +47 -0
- data/spec/models/feasibility_spec.rb +53 -0
- data/spec/models/line_item_action_response_spec.rb +77 -0
- data/spec/models/line_item_data_spec.rb +129 -0
- data/spec/models/line_item_item_data_spec.rb +99 -0
- data/spec/models/line_item_report_data_spec.rb +147 -0
- data/spec/models/line_item_response_data_spec.rb +159 -0
- data/spec/models/line_items_spec.rb +53 -0
- data/spec/models/links_spec.rb +65 -0
- data/spec/models/logout_payload_spec.rb +53 -0
- data/spec/models/meta_spec.rb +53 -0
- data/spec/models/project_action_response_spec.rb +71 -0
- data/spec/models/project_action_spec.rb +53 -0
- data/spec/models/project_category_data_spec.rb +41 -0
- data/spec/models/project_item_data_spec.rb +81 -0
- data/spec/models/project_report_data_spec.rb +123 -0
- data/spec/models/project_report_spec.rb +53 -0
- data/spec/models/project_reports_spec.rb +53 -0
- data/spec/models/project_response_data_spec.rb +107 -0
- data/spec/models/project_response_spec.rb +53 -0
- data/spec/models/project_spec.rb +77 -0
- data/spec/models/project_survey_end_links_data_spec.rb +69 -0
- data/spec/models/project_survey_end_links_spec.rb +53 -0
- data/spec/models/projects_spec.rb +53 -0
- data/spec/models/quota_cell_feasibility_spec.rb +47 -0
- data/spec/models/quota_cell_spec.rb +53 -0
- data/spec/models/quota_group_data_spec.rb +47 -0
- data/spec/models/quota_group_feasibility_spec.rb +41 -0
- data/spec/models/quota_plan_data_spec.rb +47 -0
- data/spec/models/reconcile_data_spec.rb +35 -0
- data/spec/models/reconcile_spec.rb +53 -0
- data/spec/models/refresh_token_payload_spec.rb +53 -0
- data/spec/models/reprice_data_spec.rb +125 -0
- data/spec/models/reprice_payload_spec.rb +113 -0
- data/spec/models/reprice_spec.rb +53 -0
- data/spec/models/status_spec.rb +47 -0
- data/spec/models/supported_language_spec.rb +53 -0
- data/spec/models/survey_end_links_spec.rb +53 -0
- data/spec/models/survey_test_id_spec.rb +53 -0
- data/spec/models/survey_test_link_spec.rb +47 -0
- data/spec/models/target_spec.rb +63 -0
- data/spec/models/targeting_attribute_spec.rb +53 -0
- data/spec/models/token_media_spec.rb +59 -0
- data/spec/models/token_payload_spec.rb +59 -0
- data/spec/models/update_line_item_spec.rb +123 -0
- data/spec/models/update_project_data_spec.rb +71 -0
- data/spec/models/update_project_line_item_spec.rb +129 -0
- data/spec/models/url_param_spec.rb +47 -0
- data/spec/models/user_info_response_data_spec.rb +53 -0
- data/spec/models/user_info_spec.rb +53 -0
- data/spec/spec_helper.rb +111 -0
- metadata +585 -0
data/docs/QuotaCell.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::QuotaCell
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**count** | **Integer** | number of the total completes for this cell | [optional]
|
7
|
+
**perc** | **Float** | percentage of the total completes for this cell | [optional]
|
8
|
+
**quota_nodes** | [**Array<TargetingAttribute>**](TargetingAttribute.md) | nodes in the cell. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SamplifyAPIClient::QuotaCellFeasibility
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**feasibility_count** | **Integer** | |
|
7
|
+
**quota_nodes** | [**Array<TargetingAttribute>**](TargetingAttribute.md) | |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SamplifyAPIClient::QuotaGroupData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | name or desciption of the quota group. | [optional]
|
7
|
+
**quota_cells** | [**Array<QuotaCell>**](QuotaCell.md) | List of quotas |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SamplifyAPIClient::QuotaPlanData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**filters** | [**Array<TargetingAttribute>**](TargetingAttribute.md) | Filters are attributes which all panelists should have before qualifying for a survey | [optional]
|
7
|
+
**quota_groups** | [**Array<QuotaGroupData>**](QuotaGroupData.md) | Quota groups define the allocated targeting attributes for panelists within this line item | [optional]
|
8
|
+
|
9
|
+
|
data/docs/Reconcile.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::Reconcile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data** | [**ReconcileData**](ReconcileData.md) | |
|
7
|
+
**meta** | [**Meta**](Meta.md) | |
|
8
|
+
**status** | [**Status**](Status.md) | |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::RefreshTokenPayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**client_id** | **String** | Client ID |
|
7
|
+
**client_secret** | **String** | Client Secret | [optional]
|
8
|
+
**refresh_token** | **String** | Refresh token |
|
9
|
+
|
10
|
+
|
data/docs/Reprice.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::Reprice
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data** | [**RepriceData**](RepriceData.md) | |
|
7
|
+
**meta** | [**Meta**](Meta.md) | |
|
8
|
+
**status** | [**Status**](Status.md) | |
|
9
|
+
|
10
|
+
|
data/docs/RepriceData.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# SamplifyAPIClient::RepriceData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**ir** | **Float** | Incident Rate |
|
7
|
+
**loi** | **Float** | Length of Interview |
|
8
|
+
**approval_id** | **String** | Approval ID |
|
9
|
+
**calculated_max_price** | **Float** | Calculated Maximum Price |
|
10
|
+
**completes** | **Integer** | Completes |
|
11
|
+
**event_id** | **Integer** | Event ID |
|
12
|
+
**id** | **Integer** | ID |
|
13
|
+
**new_estimated_cost** | **Float** | New Estimated Cost |
|
14
|
+
**original_cpi** | **Float** | Original Cost Per Incident |
|
15
|
+
**original_estimated_cost** | **Float** | Original Estimated Cost |
|
16
|
+
**project_id** | **Integer** | Project ID |
|
17
|
+
**quota_group_id** | **Integer** | Quota Group ID |
|
18
|
+
**reason** | **String** | Reason for event: UNKNOWN, LOI_CHANGE, IR_CHANGE |
|
19
|
+
**request_new_price** | **Float** | Request New Price |
|
20
|
+
**required_completes** | **Integer** | Required Completes |
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SamplifyAPIClient::RepricePayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**ir** | **Float** | Incident Rate |
|
7
|
+
**loi** | **Integer** | Length of Interview |
|
8
|
+
**approval_id** | **String** | Approval ID |
|
9
|
+
**calculated_max_price** | **Float** | Calculated Maximum Price |
|
10
|
+
**completes** | **Integer** | Completes |
|
11
|
+
**new_estimated_cost** | **Float** | New Estimated Cost |
|
12
|
+
**original_cpi** | **Float** | Original Cost Per Incident |
|
13
|
+
**original_estimated_cost** | **Float** | Original Estimated Cost |
|
14
|
+
**project_id** | **Integer** | Project ID |
|
15
|
+
**quota_group_id** | **Integer** | Quota Group ID |
|
16
|
+
**reason** | **String** | Reason for event: UNKNOWN, LOI_CHANGE, IR_CHANGE |
|
17
|
+
**request_new_price** | **Float** | Request New Price |
|
18
|
+
**required_completes** | **Integer** | Required Completes |
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,86 @@
|
|
1
|
+
# SamplifyAPIClient::RespondentApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.uat.pe.researchnow.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**respondent_entry**](RespondentApi.md#respondent_entry) | **GET** /respondent/entry | entry respondent
|
8
|
+
[**respondent_exit**](RespondentApi.md#respondent_exit) | **GET** /respondent/exit | exit respondent
|
9
|
+
|
10
|
+
|
11
|
+
# **respondent_entry**
|
12
|
+
> respondent_entry
|
13
|
+
|
14
|
+
entry respondent
|
15
|
+
|
16
|
+
### Example
|
17
|
+
```ruby
|
18
|
+
# load the gem
|
19
|
+
require 'samplify_api_client'
|
20
|
+
|
21
|
+
api_instance = SamplifyAPIClient::RespondentApi.new
|
22
|
+
|
23
|
+
begin
|
24
|
+
#entry respondent
|
25
|
+
api_instance.respondent_entry
|
26
|
+
rescue SamplifyAPIClient::ApiError => e
|
27
|
+
puts "Exception when calling RespondentApi->respondent_entry: #{e}"
|
28
|
+
end
|
29
|
+
```
|
30
|
+
|
31
|
+
### Parameters
|
32
|
+
This endpoint does not need any parameter.
|
33
|
+
|
34
|
+
### Return type
|
35
|
+
|
36
|
+
nil (empty response body)
|
37
|
+
|
38
|
+
### Authorization
|
39
|
+
|
40
|
+
No authorization required
|
41
|
+
|
42
|
+
### HTTP request headers
|
43
|
+
|
44
|
+
- **Content-Type**: application/json, application/xml, application/gob, application/x-gob
|
45
|
+
- **Accept**: text/html, text/plain
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
# **respondent_exit**
|
50
|
+
> respondent_exit
|
51
|
+
|
52
|
+
exit respondent
|
53
|
+
|
54
|
+
### Example
|
55
|
+
```ruby
|
56
|
+
# load the gem
|
57
|
+
require 'samplify_api_client'
|
58
|
+
|
59
|
+
api_instance = SamplifyAPIClient::RespondentApi.new
|
60
|
+
|
61
|
+
begin
|
62
|
+
#exit respondent
|
63
|
+
api_instance.respondent_exit
|
64
|
+
rescue SamplifyAPIClient::ApiError => e
|
65
|
+
puts "Exception when calling RespondentApi->respondent_exit: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
This endpoint does not need any parameter.
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
nil (empty response body)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
No authorization required
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: application/json, application/xml, application/gob, application/x-gob
|
83
|
+
- **Accept**: text/html, text/plain
|
84
|
+
|
85
|
+
|
86
|
+
|
data/docs/Status.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# SamplifyAPIClient::Status
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**errors** | [**Array<ErrorType>**](ErrorType.md) | Populated if there are multiple errors |
|
7
|
+
**message** | **String** | Human readable explanation specific to this problem |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::SupportedLanguage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Unique language ID |
|
7
|
+
**iso_code** | **String** | ISO language code |
|
8
|
+
**language_name** | **String** | Language name |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::SurveyEndLinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**complete** | [**SurveyTestLink**](SurveyTestLink.md) | |
|
7
|
+
**overquota** | [**SurveyTestLink**](SurveyTestLink.md) | |
|
8
|
+
**screenout** | [**SurveyTestLink**](SurveyTestLink.md) | |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::SurveyTestId
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**pid** | **Integer** | pid value |
|
7
|
+
**test_successful** | **BOOLEAN** | Test successful indicator |
|
8
|
+
**tested_at** | **String** | Timestamp of test |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SamplifyAPIClient::SurveyTestLink
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**link** | **String** | URL |
|
7
|
+
**tested_ids** | [**Array<SurveyTestId>**](SurveyTestId.md) | List of tested Ids |
|
8
|
+
|
9
|
+
|
data/docs/Target.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# SamplifyAPIClient::Target
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**count** | **Integer** | requiredCompletes for COMPLETE target type. |
|
7
|
+
**daily_limit** | **Integer** | target value for dailyLimit | [optional]
|
8
|
+
**soft_launch** | **Integer** | target value for softLaunch | [optional]
|
9
|
+
**type** | **String** | target type can be starts/completes. |
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::TargetingAttribute
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**attribute_id** | **String** | Id of the attribute |
|
7
|
+
**operator** | **String** | option to exclude or include the options for the particular feature id | [optional]
|
8
|
+
**options** | **Array<String>** | Options for the attribute |
|
9
|
+
|
10
|
+
|
data/docs/TokenMedia.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# SamplifyAPIClient::TokenMedia
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**access_token** | **String** | Access token |
|
7
|
+
**expires_in** | **Integer** | Access token expires in seconds |
|
8
|
+
**refresh_expires_in** | **Integer** | Refresh token expires in seconds |
|
9
|
+
**refresh_token** | **String** | Refresh token |
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SamplifyAPIClient::TokenPayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**client_id** | **String** | Client ID |
|
7
|
+
**client_secret** | **String** | Client Secret | [optional]
|
8
|
+
**password** | **String** | User password |
|
9
|
+
**username** | **String** | User username |
|
10
|
+
|
11
|
+
|
data/docs/URLParam.md
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# SamplifyAPIClient::UpdateLineItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**country_iso_code** | **String** | ISO country code | [optional]
|
7
|
+
**days_in_field** | **Integer** | Duration of the project in days. | [optional]
|
8
|
+
**delivery_type** | **String** | Delivery type: SLOW, BALANCED, FAST, or BURST. | [optional]
|
9
|
+
**indicative_incidence** | **Float** | Expected incidence of the survey | [optional]
|
10
|
+
**language_iso_code** | **String** | ISO language code | [optional]
|
11
|
+
**length_of_interview** | **Integer** | expected duration of the survey in minutes | [optional]
|
12
|
+
**quota_plan** | [**QuotaPlanData**](QuotaPlanData.md) | | [optional]
|
13
|
+
**required_completes** | **Integer** | Number of complete required for the line item | [optional]
|
14
|
+
**survey_test_url** | **String** | Entry link for the user. | [optional]
|
15
|
+
**survey_test_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyTestURL Params of the line item. | [optional]
|
16
|
+
**survey_url** | **String** | Entry link for the user. | [optional]
|
17
|
+
**survey_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyURL Params of the line item. | [optional]
|
18
|
+
**targets** | [**Array<Target>**](Target.md) | Data of completes/starts required for the line item | [optional]
|
19
|
+
**title** | **String** | A title for the line item | [optional]
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SamplifyAPIClient::UpdateProjectData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**category** | [**ProjectCategoryData**](ProjectCategoryData.md) | | [optional]
|
7
|
+
**devices** | **Array<String>** | List of emails to subscribe to notifications | [optional]
|
8
|
+
**exclusions** | [**ExclusionData**](ExclusionData.md) | | [optional]
|
9
|
+
**line_items** | [**Array<UpdateProjectLineItem>**](UpdateProjectLineItem.md) | List of line items for the project. | [optional]
|
10
|
+
**notification_emails** | **Array<String>** | List of emails to subscribe to notifications | [optional]
|
11
|
+
**title** | **String** | Project title | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# SamplifyAPIClient::UpdateProjectLineItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**country_iso_code** | **String** | ISO country code | [optional]
|
7
|
+
**days_in_field** | **Integer** | Duration of the project in days. | [optional]
|
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 | [optional]
|
11
|
+
**language_iso_code** | **String** | ISO language code | [optional]
|
12
|
+
**length_of_interview** | **Integer** | expected duration of the survey in minutes | [optional]
|
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 | [optional]
|
21
|
+
|
22
|
+
|
data/docs/UserInfo.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::UserInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data** | [**UserInfoResponseData**](UserInfoResponseData.md) | |
|
7
|
+
**meta** | [**Meta**](Meta.md) | |
|
8
|
+
**status** | [**Status**](Status.md) | |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::UserInfoResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**applications** | [**Array<ApplicationItemData>**](ApplicationItemData.md) | List of applications for the user. |
|
7
|
+
**company_id** | **Integer** | Unique company ID |
|
8
|
+
**company_name** | **String** | Comopany name |
|
9
|
+
|
10
|
+
|
data/docs/UsersApi.md
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
# SamplifyAPIClient::UsersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.uat.pe.researchnow.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**users_get_user_info**](UsersApi.md#users_get_user_info) | **GET** /sample/v1/users/info | getUserInfo users
|
8
|
+
|
9
|
+
|
10
|
+
# **users_get_user_info**
|
11
|
+
> UserInfo users_get_user_info(opts)
|
12
|
+
|
13
|
+
getUserInfo users
|
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::UsersApi.new
|
28
|
+
|
29
|
+
opts = {
|
30
|
+
app_id: 56, # Integer | Only return apps with the given id
|
31
|
+
current: true, # BOOLEAN | Only return current app for the user id
|
32
|
+
default: true, # BOOLEAN | Only return default app for the user id
|
33
|
+
name: 'name_example' # String | Only return apps with the given name
|
34
|
+
}
|
35
|
+
|
36
|
+
begin
|
37
|
+
#getUserInfo users
|
38
|
+
result = api_instance.users_get_user_info(opts)
|
39
|
+
p result
|
40
|
+
rescue SamplifyAPIClient::ApiError => e
|
41
|
+
puts "Exception when calling UsersApi->users_get_user_info: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**app_id** | **Integer**| Only return apps with the given id | [optional]
|
50
|
+
**current** | **BOOLEAN**| Only return current app for the user id | [optional]
|
51
|
+
**default** | **BOOLEAN**| Only return default app for the user id | [optional]
|
52
|
+
**name** | **String**| Only return apps with the given name | [optional]
|
53
|
+
|
54
|
+
### Return type
|
55
|
+
|
56
|
+
[**UserInfo**](UserInfo.md)
|
57
|
+
|
58
|
+
### Authorization
|
59
|
+
|
60
|
+
[jwt](../README.md#jwt)
|
61
|
+
|
62
|
+
### HTTP request headers
|
63
|
+
|
64
|
+
- **Content-Type**: application/json, application/xml, application/gob, application/x-gob
|
65
|
+
- **Accept**: application/vnd.userinfo+json
|
66
|
+
|
67
|
+
|
68
|
+
|